User Manual

Table of Contents

Changelog

Version	Date	Author	Comment
0.1	17.04.2023	Paul Brenner	Created User Manual
0.2	28.04.2023	Jonas Graubner	Add installation description
0.3	11.05.2023	Selvana Ayunda	GUI description
0.4	13.05.2023	Paul Brenner	Add error description

---

1 Introduction

1.1 Overview

1.2 Glossary

• AASX - file format to store an asset. *.aasx. Can be unzipped for access to content.
• AAS - Asset Administration Shell
• [AASX server] - server, that can store AAS assets and has a standardized API specified in the GitHub repository (v3 HTTP/REST | Asset Administration Shell Repository)

2 Installation

2.1 Software Requirements

Server-Requirements:

• running MongoDB Server version 4.4.x LTS

• Apache Webserver with javascript enabled

• Windows 10/11 server or current/latest Ubuntu/Debian Linux Server with ASP.NET Core Runtime 6.0.x

Frontend User Requirements:

• a state-of-the-art browser, e.g. Firefox or Edge

2.2 Installation Process

Installation of the AASX-Server

The binaries are available in the Executable Folder in the AasxServerBlazor.zip. These are portable dotnet assemblies. Or you can build them yourself with the dotnet 6.0.x SDK and the provided Build Script SOURCE/Server/aasx-server/src/BuildForRelease.ps1. The AASX Server relies on .Net Core 6.0.x.

Running for Demonstration

We include example AASX and various extra files (e.g., certificates) in the AasxServerBlazor.zip so that you can readily start the server for demonstration purposes. The scripts startForDemo.sh and startForDemo.bat will start the server with these pre-packaged files.

Disclaimer this Version is just testet to run with the given Options in the startForDemo Files, with the exeption of you modifying the mongoDB connection string.

Running on Windows

Change to the directory where you extracted the release bundle.

Open startForDemo.bat in a text editor of your choice. Modify here the Server to your need according to the Options below. Mostlikely you just have to modify the mongoDB Connection string. Save the file.

Start startForDemo.bat or invoke the executable with the same name as the server variant. For example:

AasxServerWindows.exe --rest --data-path /path/to/aasxs --mongo mongodb://127.0.0.1:27017/

You can see testwise the AAS on the server with: http://localhost:5001/. The Server may take a few Minutes to startup.

Running on Linux

Change to the directory where you extracted the release bundle.

Open startForDemo.sh in a text editor of your choice. Modify here the Server to your need according to the Options below. Mostlikely you just have to modify the mongoDB Connection string. Save the file.

Start startForDemo.sh or use dotnet to execute the DLL with the same name as the server variant. For example:

dotnet AasxServerBlazor.dll --rest --data-path ./aasxs --mongo mongodb://127.0.0.1:27017/ $OPTIONSAASXSERVER

Options

To obtain help on individual flags and options, supply the argument --help:

AasxServerWindows.exe --help or AasxServerCore.exe --help

AasxServerCore:
  serve AASX packages over different interfaces

Usage:
  AasxServerCore [options]

Options:
  -h, --host <host>                      Host which the server listens on [default: localhost]
  -p, --port <port>                      Port which the server listens on [default: 51310]
  --https                                If set, opens SSL connections. Make sure you bind a certificate to the port before.

  --data-path <data-path>                Path to where the AASXs reside
  --mongo <mongo>                            Connection String to your mongoDB installation
  --rest                                 If set, starts the REST server
  --opc                                  If set, starts the OPC server
  --mqtt                                 If set, starts a MQTT publisher
  --debug-wait                           If set, waits for Debugger to attach
  --opc-client-rate <opc-client-rate>    If set, starts an OPC client and refreshes on the given period (in milliseconds)
  --connect <connect>                    If set, connects to AAS connect server. Given as a comma-separated-values (server, node name, period in milliseconds) or as a flag (in which case it connects to a default server).
  --proxy-file <proxy-file>              If set, parses the proxy information from the given proxy file
  --no-security                          If set, no authentication is required
  --edit                                 If set, allows edits in the user interface
  --name <name>                          Name of the server
  --version                              Show version information
  -?, -h, --help                         Show help and usage information

Deployment of the Frontend

Deployment via Source file

Make sure you have Node.js installed on your local machine. Navigate to SOURCE/frontend and run the following commands:

npm install

npm start

You may wanna modify the standard AASX Server Url herefore navigate to ./src/utils/constanst.js and change the second line to var url="YOUR_SERVER_URL";

With the command

npm build

You can afterwards create your own static files

Deployment via static files

In the Executable Folder under frontend you find the frontend pre build as static files. Just copy these to your Webserver.

3 Graphical User Interface

3.1 Home Page

1. If you click on Asset:

• 1: Show the current server, you can change url-server
• 2: Login
• 3: Message to remember you if you want more infos in Asset deteils, you have to login.
• 4: Asset deteils contents infos Asset and they are clickable
• 5: Asset
• 6: Search function to search certain asset
• 7: always lead you to home page

3.2 Login Dialog

enter your access data to access more infos

3.3 More Infos in Asset Deteils:

infos are clickable

3.4 Admin-Dashboard:

go to Admin-Dashboard

• 1. Search function
• 2. Members
• 3. Membersrole
• 4. action to manage your member
• 5. button to create new member

3.5 Add Asset Page

• 1. Upload your aas file
• 2. Give valid id
• 3. to submit your asset on server

3.6 Delete Asset

as admin you can delete asset

4 Error messages

Possible error messages

The function "errorHandling.js" provides the possible error messages:

• preDefinedErrors[100] = "User rights insufficient to load all data. Please login to see all Data.";
• preDefinedErrors[150] = "Unknown Internal Server Error."
• preDefinedErrors[151] = "Internal Server Error. File already exists."
• preDefinedErrors[152] = "Internal Server Error. Requested File not found."
• preDefinedErrors[153] = "Internal Server Error. Filepath has wrong format please check AASX file."
• preDefinedErrors[500] = "AASX Server not available, please check your Server address."

preDefinedErrors[100] = "User rights insufficient to load all data. Please login to see all Data."

There may be files which have no content that is accessible for this user role (e.g. the Security Submodel). This results in this error message and can be fixed by using the corresponding role.

preDefinedErrors[150] = "Unknown Internal Server Error."

preDefinedErrors[151] = "Internal Server Error. File already exists."

This error occurs when the user tries to upload a file with an already existing AAS-ID. This error can be fixed by replacing the AAS-ID.

preDefinedErrors[152] = "Internal Server Error. Requested File not found."

This error can occur if

• file was deleted from the Server by another instance after loading the frontend
• when opening a submodel a referenced document is not available in the submodel path

preDefinedErrors[153] = "Internal Server Error. Filepath has wrong format please check AASX file."

preDefinedErrors[500] = "AASX Server not available, please check your Server address."

Error occurs if the selected AASX Server is not available. This can be a temporary or a permanent problem.