Customer Requirements Specification
Project: AAS-Management
Customer: Rentschler & Holder Rotebühlplatz 41 70178 Stuttgart
Supplier: Team 2 (Paul Brenner, Jonas Alexander Graubner, Mohaddeseh Tibashi, Selvana Dwi Ayunda, Luka Dominik Pavic) Rotebühlplatz 41 70178 Stuttgart
Version 1.0
| Version | Date | Author | Comment |
|---|---|---|---|
| 0.1 | 11.10.2022 | Luka Dominik Pavic | Created |
| 0.2 | 14.10.2022 | Luka Dominik Pavic | Added Goal, Product Environment and Product Usage |
| 0.3 | 15.10.2022 | Luka Dominik Pavic | Added Product Data and other Product Characteristics |
| 0.4 | 16.10.2022 | Luka Dominik Pavic | Added Use Cases |
| 0.5 | 21.10.2022 | Luka Dominik Pavic | Added Targetgroup and corrected Use Cases |
| 0.6 | 28.10.2022 | Luka Dominik Pavic | Corrected Features, Product Data |
| 0.7 | 8.11.2022 | Luka Dominik Pavic | Changed Targetgroup into User group, Corrected User group |
| 0.8 | 06.05.2023 | Luka Dominik Pavic | Deleted Business Case, corrected Use Cases and edited features |
| 0.9 | 11.05.2023 | Luka Dominik Pavic | Corrected Product Data |
| 1.0 | 18.05.2023 | Luka Dominik Pavic | Added Reference |
- 1 Goal
- 2 Product Environment
- 3 Product Usage
- 4 Features
- 5 Product Data
- 6 Other Product Characteristics
- 7 User group
- 8 References
The goal of this project is to develop a web application that acts as a management system for the "Asset Administration Shell" (AAS). This specific web application shall have an identity and access management as well as a user administration with persistent data storage in MongoDB. The user administration enables a role distribution of the users in the user groups "Admin", "Advanced" and "Basic", whereby the role distribution is carried out manually via the Admin. Each role is equipped with different access rights and read permissions ("Advanced" gets full read access to all AAS and their submodels and "Basic" gets read access only to the basic submodels to all AAS), with the admin also having functions for managing AAS content and user management. This uses the specification of the concept as a REST API in openapi [1].
The AAS is a concept of the Industry 4.0 platform for the standardized implementation of "Industry 4.0 components", consisting of the digital twin in the form of the AAS and the associated physical object (the asset). This makes it possible in industry to provide digital twins that can be shared and combined across manufacturers and accessed via standardized interfaces.
This section reflects on different business processes and use cases which shall be covered by the web application.
Figure 1: Use Case Overview Diagram
| Nr. / ID | <AASM-UC.01> |
|---|---|
| Title | Log-In |
| Use Cases Objective | User wants to log into account. |
Figure 2a: <AASM-UC.01> User logs in
Figure 2b: <AASM-UC.01> User assignment to corresponding role
| Nr. / ID | <AASM-UC.02> |
|---|---|
| Title | Log-Out |
| Use Cases Objective | User wants to log out of his account. |
Figure 3: <AASM-UC.02> User logs out
| Nr. / ID | <AASM-UC.03> |
|---|---|
| Title | Managing own Account |
| Use Cases Objective | The user wants to use the self-services for e-mail and password change to modify these components of the account. |
Figure 4: <AASM-UC.03> User changes password or email address
| Nr. / ID | <AASM-UC.04> |
|---|---|
| Title | Administrate AAS content |
| Use Cases Objective | The user wants to add or delete the AAS content. |
Figure 5: <AASM-UC.04> User administrates AAS content
| Nr. / ID | <AASM-UC.05> |
|---|---|
| Title | Administrate accounts |
| Use Cases Objective | The user wants to add or delete accounts. The user also wants to divide the accounts into user groups (Basic, Advanced and Admin). |
Figure 6: <AASM-UC.05> User administrates accounts
| Nr. / ID | <AASM-UC.06> |
|---|---|
| Title | Find asset |
| Use Cases Objective | The user searches for an asset to find it in the GUI or receives a notification that the asset is not present. |
Figure 7: <AASM-UC.06> User searches asset
| Nr. / ID | <AASM-UC.07> |
|---|---|
| Title | Display asset |
| Use Cases Objective | The user finds the asset and clicks on it for display purposes and further details. |
Figure 8: <AASM-UC.07> User wants to display asset
The following functionalities shall be met by the web application.
The GUI has a home page where the user can browse the package explorer with AAS content and log in to an account. When the user logs in, he gets access to a customized package explorer with an extension of more functions and dynamically customized content depending on the user's user group.
The web application shall have centralized management of identities and access permissions, with role-based access rights. The web application shall have functions for authentication and authorization of users and a self-service for users such as email and password change.
The user (more precisely the user with the role of Admin) has the possibility to upload and delete AAS content. The content to be uploaded is in .aasx file format.
The user should be able to effectively find desired AAS content using search functions. The user should be able to effectively find the desired content of the AAS using search functions.
The software shall support the V3 Rest-API spezified in https://v3.admin-shell-io.com/swagger/index.html standard for communication between the client and database system.
The software should check whether an error has occurred. If an error occurs, the user should receive an easily readable and understandable error message.
The following lists the data structures of the web application.
The web application should enable persistent data storage with MongoDB as the database management system used.
This section describes the already known non-functional requirements for the product.
Usability is to be ensured by a simple layout and by a human-centered interface. It should be clear and easy to use so that the user can achieve the objectives efficiently and satisfactorily.
Reliability is to be ensured by a responsive GUI with high error tolerance and a database with accurate and consistent data.
The software should orientate on the recommended page load time by Google (2 seconds). Yet this time can vary, based on the internet connection and file size (e.g. images), therefore a loading time shorter than 7 seconds fulfils the requirements.
The software is published with a MIT License on GitHub.
AAS Management is a web application and therefore only requires an Internet connection and an installed web browser on the computer work.
The user group shall not depend on gender, marital status or age. The only dependencies are in the profession, here the user should be in contact with Industry 4.0, accordingly his place of residence is at best in an industrial state. Another dependency is the education with a school degree and the interest in technical topics.
[1] https://app.swaggerhub.com/apis/Plattform_i40/Entire-API-Collection/V1.0RC02#/
| Document author | Luka Dominik Pavic |
|---|---|
| Created on | 11.10.2022 |
| Duale Hochschule Baden-Württemberg |