BaSyx / Documentation / Components / AAS Server
|Overview | Interface | Implementation | Component|
AAS Server Component
The AAS server component provides an empty AAS server that can be used to host several AAS and Submodels. For its API usage see Aggregator API. Additionally, there's a video illustrating the configuration and usage in 5 minutes: YouTube.
For a complete deployment of the AAS infrastructure, additionally to this server a registry is needed. For this registry, the Registry Component can be used.
For illustration on how to create an AAS on the server provided by the component and how to retrieve it see the snippet in the repository.
The AAS Server image is made available via Docker Hub and can be pulled by:
docker pull eclipsebasyx/aas-server:0.1.0-PREVIEW
Alternatively, the command described in Startup section will download the image.
To easily start the AAS server component, you can use the following command:
docker run --name=aas -p 8081:4001 eclipsebasyx/aas-server:0.1.0-PREVIEW
Now the endpoint for accessing the server with its AAS is
And the container can be stopped, started and removed using its name (see --name):
docker stop aas docker start aas docker rm aas
For the AAS server component, three options can be configured: The AAS source file, the backend and the registry url. By default, an empty InMemory server is started. The backend can be changed with the option
Currently, the other valid option for the backend is MongoDB that persists the whole AAS together with its submodels in a MongoDB. Additionally, it is possible to give an input file for the server using an absolute file path:
This loads the file myAAS.aasx into the server as soon as it is started. For input files, the .xml file ending is supported as well:
Finally, when loading a default AAS, it can be registered in an external registry by specifying the registry url. The registry path depends on the deployment location. Thus, when starting a local docker registry for testing purposes, it needs to be in the same docker network as the AAS to be reachable. So for a non-docker deployment, the registry address could be:
Whereas it could be different for a deployment with docker containers:
See also the official Docker documentation for more information on that topic.
By default, this configuration file is assumed to be located at "/usr/share/config/aas.properties" within the container. Thus, another configuration file can be set by mounting a local configuration file into the container during startup. As an example, a local folder containing the configuration files can be mounted using:
docker run --name=aas -p 8081:4001 -v C:/tmp:/usr/share/config eclipsebasyx/aas-server:0.1.0-PREVIEW
In this example, the aas.properties file is located in C:/tmp/. Similarly, the AAS source file also needs to be mounted into the docker container.
Uses a MongoDB backend that can be configured using the .properties files in src/main/resources of the components. Similar to the SQL backend, for the MongoDB backend, another configuration file can be specified.
Stores the Registry entries in RAM. !!Please be aware that this is not persistent and therefore only for testing! After component restart, all entries are lost. Use this only for testing!!
Within the project, the component can be found in the Java repository at Java. In this project, the executable can take the parameter BASYX_AAS to configure the path of the aas configuration file. For example, you can specify the path of the aas configuration file via
java -jar -DBASYX_AAS="C:/tmp/aas.properties" aas.jar
As with the other components, the server's context can be customized using the context configuration.