Template-based Configuration - Schema based - Manual - Industrial Edge - Industrial Edge - Industrial Edge - Documentation of Industrial Edge APIs - CLI tools - Industrial Edge - References - APIs

Industrial Edge Platform Operation - APIs & References

Product
Industrial Edge
Edition
12/2024
Language
en-US (original)

Schema based configurations give the user the option to provide configurations in a wizard, supporting complex types to create JSON based configurations.

You can add them with the following command:

$ iectl publisher standalone-app app-config add \
    --appname "my cool app" \
    --configname "schema_based_config1" \
    --configdescription "displayed to the end-user during deployment" \
    --hostpath "./cfg-data/" \
    --subpath "schema" \
    --secure \                                                              # Enabling the secure flag only stores the configuration encrypted on the Industrial Edge Management, but not on the Industrial Edge Device
    --templatename "schema_based_config_template1" \                        # displayed to the end-user during deployment
    --templatedescription "displayed to the end-user during deployment" \
    --jsonschema \
    --filepath /path/to/configuration/schema.json                           # filepath: File containing the JSON Schema

Info

The Application Configuration Service creates using the JSON Schema specified in the provided file (and potentially user input) a new JSON file. This file is then stored using the same filename as provided under filepath. For the example above the resulting configuration file path inside the container would be /cfg-data/schema/schema.json (assuming default mount path "./cfg-data/:/cfg-data/").