Updated 2. Software Architecture Specification (markdown)

Cyber-Luke 2022-04-23 16:27:17 +02:00
parent 5448982a5f
commit 6b346721f3

@ -93,7 +93,7 @@ The problem with programmes that have been developed many times and then by diff
#### 2.3.1.4 Security<a name="S8"/> #### 2.3.1.4 Security<a name="S8"/>
It must be ensured that it is recognisable where and from whom the programme originated. It will not be possible to access the Internet with the programme, so confidentiality is automatic. But it should be downloaded from an official source, the releases can be found [here](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/tags). It must be ensured that it is recognisable where and from whom the programme originated. It will not be possible to access the Internet with the programme, so confidentiality is automatic. But it should be downloaded from an official source, the releases can be found [here](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/releases).
#### 2.3.1.5 Availability<a name="S9"/> #### 2.3.1.5 Availability<a name="S9"/>
@ -101,7 +101,7 @@ The programme and its code will be available on GitHub on a public repository. T
#### 2.3.1.5 Interoperability<a name="S10"/> #### 2.3.1.5 Interoperability<a name="S10"/>
This is important because it must be ensured that users are not firmly bound to this standard or programme. After all, the main users will come from the industry and therefore place a lot of value on a uniform standard. More information can be found in the "Technical Concept". This is important because it must be ensured that users are not firmly bound to this standard or programme. After all, the main users will come from the industry and therefore place a lot of value on a uniform standard. More information can be found in the [Technical Concept](#TC).
### 2.3.2 Non-Runtime quality attributes<a name="S11"/> ### 2.3.2 Non-Runtime quality attributes<a name="S11"/>
@ -117,7 +117,7 @@ Attention is paid to transferability to later projects, through the involvement
#### 2.3.1.1 Testability<a name="S14"/> #### 2.3.1.1 Testability<a name="S14"/>
This is probably the second most important point after usability, care must be taken to ensure that the code is testable. On the one hand directly in the code, but also testing the binary is important. For this purpose, various test cases are described and worked through on the "Systemtestplan" page. Also check the "Systemtesreport" to learn more about the test results. The AML Component Checker should be validating all created AML files. Thereby, to keep quality high, errors that cause undesirable behavior or even fatal errors must be eliminated. This is probably the second most important point after usability, care must be taken to ensure that the code is testable. On the one hand directly in the code, but also testing the binary is important. For this purpose, various test cases are described and worked through on the [Systemtestplan](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/wiki/4.-Systemtestplan) page. Also check the [Systemtestreport](https://github.com/H4CK3R-01/TINF20C_ModellingWizard_Devices/wiki/5.-Systemtestreport) to learn more about the test results. The AML Component Checker should be validating all created AML files. Thereby, to keep quality high, errors that cause undesirable behavior or even fatal errors must be eliminated.
# 3. Quality Concept <a name="QC"/> # 3. Quality Concept <a name="QC"/>
@ -235,16 +235,18 @@ By using the publicly available "AMLX" package standard, the system becomes pers
## 7.4 Communication with other IT-Systems <a name="TC4"/> ## 7.4 Communication with other IT-Systems <a name="TC4"/>
The plug-in already had the problem that it was dependent on external programmes. Thus, "IODD" and "GSD" programme types had to be converted in order to be able to use them. The goal will now be to implement these programmes or converters directly in the standalone application. The advantage of this is that the user does not have to install external dependencies that may also cause errors. This means that, in the best case, there would only be interaction with the file system. This model can also be seen in the "Architectural Model". The plug-in already had the problem that it was dependent on external programmes. Thus, "IODD" and "GSD" programme types had to be converted in order to be able to use them. The goal will now be to implement these programmes or converters directly in the standalone application. The advantage of this is that the user does not have to install external dependencies that may also cause errors. This means that, in the best case, there would only be interaction with the file system. This model can also be seen in the [Architectural Model](#AC1).
## 7.5 Deployment <a name="TC5"/> ## 7.5 Deployment <a name="TC5"/>
To make changes to the application, "Visual Studio 2019" must first be installed. In "Visual Studio 2019", the file "Application.sln" from the "Application" folder must then be opened. To make changes to the application, [Visual Studio 2019](https://my.visualstudio.com/Downloads?q=visual%20studio%202019&wt.mc_id=o~msft~vscom~older-downloads) must first be installed. In "Visual Studio 2019", the file "Application.sln" from the "Application" folder must then be opened.
The application and the plug-in (ModellingWizard) are then visible in the Solution view. The application and the plug-in (ModellingWizard) are then visible in the Solution view.
In order to be able to compile the application, the "AML.Engine" package in version 1.5.8 may have to be installed via the "NuGet" package manager. In order to be able to compile the application, the "AML.Engine" package in version 1.5.8 may have to be installed via the "NuGet" package manager.
[How NuGet works](https://docs.microsoft.com/de-de/nuget/quickstart/install-and-use-a-package-in-visual-studio)
## 7.6 Data validation <a name="TC6"/> ## 7.6 Data validation <a name="TC6"/>
All data checks are running in the background, invisible for the user. The controller is checking for missing information and incorrect entries, that must be specified as mandatory information. All data checks are running in the background, invisible for the user. The controller is checking for missing information and incorrect entries, that must be specified as mandatory information.