Skip to main content
Version: 5.2.0.1

Settings

Initial Setup and Configuration​

The Orchestra runtime requires a set of configuration parameters to optimize and adjust its behavior. The essential parameters needed for the system startup are defined in the file Orchestra/WEB-INF/classes/config/environment_settings.xml.

This file configures the Orchestra environment used to initialize the basic system.

Additionally, all other parameters are stored in the Orchestra runtime database, allowing for modifications via the Orchestra Monitor.

info
  • If a parameter exists in both the environment_settings.xml and the database, the environment_settings.xml will take precedence. This is beneficial when invalid settings in the database might prevent the system from starting. Parameters defined in environment_settings.xml have priority, ensuring the system can still start.
  • An additional file, environment_settings_template.xml, exists in the config folder. This file outlines all parameters that can be stored and modified in the database. Upon startup, Orchestra processes this file; any parameters absent from the database are inserted with the default values specified in environment_settings_template.xml. Existing values in the database will override those in environment_settings_template.xml.

Customer API​

To access attributes within a scenario, you can utilize the following functions from the Customer API:

String soffico.customerapi.config.getParameterValue( "unique attributename", "<default value>")​

This function returns the current value of the specified attribute. The attribute name is comprised of the group name followed by the attribute name.

For example, to access the attribute ManufacturerName within the group AssetAdministrationShell, use the following method call:

soffico.customerapi.config.getParameterValue("AssetAdministrationShell.ManufacturerName", "Not available")

Map<String,String> soffico.customerapi.config.getParameterGroup( "group name " )​

This function retrieves all attribute values currently associated with a specified group.

For example, to obtain all attributes within the group AssetAdministrationShell, use the following method call:

soffico.customerapi.config.getParameterGroup("AssetAdministrationShell")