AAS Environment

AAS Environment#

Docker Pulls GitHub Metamodel API

The AAS Environment aggregates the AAS Repository, Submodel Repository and ConceptDescription Repository into a single component.

Note

Additionally, the AAS Environment supports the following endpoint defined in DotAAS Part 2 V3 - Serialization Interface:

  • GenerateSerializationByIds - For more information about this endpoint please refer to Swagger API

Features#

All Features of the AAS Repository, Submodel Repository and ConceptDescription Repository are also available in the AAS Environment.

Default Features#

These features are always enabled:

Optional Features#

These features can be activated in the configuration files as required

Configuration#

Note

If you are using the AAS Environment, all configuration for the aggregated repositories is done in the AAS Environment configuration.

The AAS Environment Component supports the preconfiguration of AAS Packages (XML, JSON, AASX).

Server Configuration#

This section configures the server port and application name for the AAS Environment.

server.port=8081
spring.application.name=AAS Environment

Backend Configuration Default#

Configure the backend storage. By default, it uses InMemory. Optionally, you can configure MongoDB.

InMemory Default#

basyx.backend = InMemory

MongoDB Default#

basyx.backend = MongoDB
spring.data.mongodb.host=mongo
spring.data.mongodb.host=127.0.0.1
spring.data.mongodb.port=27017
spring.data.mongodb.database=aasenvironment
spring.data.mongodb.authentication-database=admin
spring.data.mongodb.username=mongoAdmin
spring.data.mongodb.password=mongoPassword

The collections where AASs, Submodels, and Concept Descriptions are saved can be individually configured using the following parameters:

basyx.aasrepository.mongodb.collectionName=aas-repo
basyx.submodelrepository.mongodb.collectionName=submodel-repo
basyx.cdrepository.mongodb.collectionName=cd-repo

The above values are also the default values.

CORS Configuration Default Default#

Configure CORS settings to specify allowed origins and methods.

Warning

To use the component with the BaSyx Web GUI this configuration is required.

To do this, you need to add the URL of the Web GUI to the allowed origins.

basyx.cors.allowed-origins=http://localhost:3000, http://localhost:4000
basyx.cors.allowed-methods=GET,POST,PATCH,DELETE,PUT,OPTIONS,HEAD

Authorization Configuration Default Default#

Enable and configure authorization features, such as Role-Based Access Control (RBAC) and JWT Bearer Token Provider.

basyx.feature.authorization.enabled = true
basyx.feature.authorization.type = rbac
basyx.feature.authorization.jwtBearerTokenProvider = keycloak
basyx.feature.authorization.rbac.file = classpath:rbac_rules.json
spring.security.oauth2.resourceserver.jwt.issuer-uri= http://localhost:9096/realms/BaSyx

Registry Integration Default Default#

For configration, see and utilize the Submodel Repository Configuration and the AAS Repository Configuration

Operation Delegation Default Default#

For configration, see and utilize the Submodel Repository Configuration and the AAS Repository Configuration.

MQTT Configuration Default Default#

For configration, see and utilize the Submodel Repository Configuration and the AAS Repository Configuration

File Upload Configuration Default Default#

Set the maximum file size and request size for file uploads. The default values are 1 MB for file size and 10 MB for request size.

spring.servlet.multipart.max-file-size=128KB
spring.servlet.multipart.max-request-size=128KB

Configure Favicon#

Note

A favicon is a small 16×16 or 32×32 pixel icon, symbol or logo used by web browsers to identify a website in a recognizable way

To configure the favicon, mount your favicon to the static directory of the component using Docker:

docker run --name=aas-env -p:8081:8081 -v C:/path/to/favicon.ico:/application/static/favicon.ico eclipsebasyx/aas-environment:2.0.0-SNAPSHOT

or

aas-env:
    image: eclipsebasyx/aas-environment:2.0.0-SNAPSHOT
    container_name: aas-env
    volumes:
      - ./aas:/application/aas
      - ./basyx/aas-env.properties:/application/application.properties
	  - ./basyx/static/favicon.ico:/application/static/favicon.ico
    ports:
      - '8081:8081'

Docker#

Eclipse BaSyx provides the AAS Environment as off-the-shelf component via DockerHub. The following command pulls the image and creates a container for the AAS Environment:

docker run --name=aas-env -p:8081:8081 -v C:/path/to/application.properties:/application/application.properties eclipsebasyx/aas-environment:2.0.0-SNAPSHOT

Warning

When running this component inside Docker, do not modify the internal port configuration.
Changing the port setting may prevent the service from being accessible from outside the container.

Virtual Machine#

Eclipse BaSyx provides the AAS Environment as a virtual machine image for Oracle VirtualBox and VMware Workstation Player.

The image can be found here. How to use it is described here.

Swagger UI#

In the Swagger UI, you can find the API documentation for the AAS Environment.

You can also execute all the API calls directly from the Swagger UI.

The Aggregated API endpoint documentation is available at:

http://{host}:{port}/v3/api-docs

The Aggregated Swagger UI for the endpoints is available at:

http://{host}:{port}/swagger-ui/index.html