JSON schemes¶

The template based configuration must consist of a "uischema" and a "dataschema", both specified by JSON forms. You can find more information regarding JSON forms and examples here.

NOTICE

IE App Configuration Service (IE ACS)
You find more information regarding the IE ACS in the "Industrial Edge Management - Operation" manual in the "IE App Configuration Service" section.

Data schema¶

The data schema describes the underlying data and is based on JSON schema. Currently, a subset of JsonSchema7 and a subset of JsonSchema4 is supported. You find more information regarding JSON schemes here.

UI schema¶

The UI schema is defined by JSON forms and is a regular JSON object. The UI schema defines the visual representation of the specified data schema and specifies the different control elements, the arrangement and rules. You can find more information regarding the UI schema here.

Structure of the configuration file¶

After the schema creation is complete, you must store both the schemas in a single *.json configuration file with the following structure:

schemes

This configuration file will be used as input for the configuration that you want to add to the app.

The following figure shows an example of a *.json configuration file containing a UI schema and a data schema:

config file example

Adding schemes¶

After defining the schema, you must add the schema to the app as a *.json based templated app configuration. To do so, you must enable the "JSON Schema" check box during the creation of the app configuration. Only templated configurations with enabled "JSON Schema" check box are compatible with the IE ACS.

Rendering set¶

The schemas are rendered via the so-called Angular Material UI Renderer Set. You can find information on which features this set supports here.

Limitations on rendering set¶

The used rendering set cannot render a date control because it signals wrong validation status. Instead, text rendering with date format checking is used.