Configurator

Require: IP-Symcon >= 5.0

Describes the appearance and functionality of a configurator.

This item is not supported by the Legacy Console. If a module with this element is opened in the legacy console, an error message appears.

General Parameters

If the parameters columns, sort or values are to be changed via UpdateFormField, the new values must be coded as JSON.

Parameters for Columns

Parameters for sort

Parameters for values

Parameter for Create

There are various options for defining the instances to be created and their initial configuration.

Variant 1: Configuration of a Single Instance

In the first variant, a single instance and its configuration is defined. In this case create is an object that contains information about the ModuleID used and the initial configuration:

Parameters for configuration

Parameters for status variables

If an instance is created, it is created with the ModuleID and configuration specified by the configuration. As is usual with the creation of an instance, the new instance is linked to a valid physical parent instance, if possible. The physical parent instance of the configurator is preferably used here.

Variant 2: Configuration of a Chain

Alternatively, a chain of configurations can be used. This defines the entire physical chain for the newly created instance, usually the device, splitter and I/O. In this variant, data.create represents a list, the elements of which define the instances of the physical chain as in variant 1. The list begins with the device to be created and then continues with the next parent instance.

When creating a chain, existing parent instances are preferably reused, provided that these and their parent instances meet the requirements of the chain. However, the device itself will always be newly created.

Variant 3: Several possible Configurations

Finally, several configurations can be made available for selection. Here create is configured as an object with key/value pairs, whereby each value corresponds to a configuration as described in variant 1 or variant 2. If an instance is to be created in this representation, the user is given a selection of the designations. The instance is created with the settings of the selected item. The keys "moduleID" and "configuration" cannot be used here.

Colors in the Configuration List

What the individual colors mean in messages and in the configurator can be read under the color codes for messages and configurators. The element presents this information as follows:

Use the Configurator Form Field in the Device Search

The console offers Instances that can be created centrally via the Device Search. This is done by regularly calling GetConfigurationForm for Instances of the type Configurator and Discovery and evaluating the parameter values for configurator fields. Only configurator and discovery instances that contain at least one configurator field are displayed in the Device Search. In this, values can also be empty. If the own instance is to be seen in the Device Search, the following conditions must therefore be met:

• The instance must be of the type Configurator or Discovery
• The search for devices must be started automatically when executing GetConfigurationForm. If the search takes longer, values should be left empty in an initial return, but after the search has been completed, the devices that can be created must be included in the return of GetConfigurationForm
• The search should not be restarted when GetConfigurationForm is called repeatedly if it is currently running
• An example implementation can be found here: SymconTest

Selected Line as a Variable in on-Actions

The use of the values of the configurator in scripts is analogous to Lists. All values are available there, including expanded, instanceID and create. However, the configurator does not save any values in a property.

Example

// Basic example
    {
        "type": "Configurator",
        "name": "Configuration",
        "caption": "Configuration",
        "delete": true,
        "values": [
            {
                "id": 1,
                "name": "Category",
                "address": ""
            },{
                "parent": 1,
                "name": "Calculation module - minimum",
                "address": "2",
                "create": {
                    "moduleID": "{A7B0B43B-BEB0-4452-B55E-CD8A9A56B052}",
                    "configuration": {
                        "Calculation": 2,
                        "Variables": "[]"
                    }
                }
            },{
                "parent": 1,
                "name": "Computing module in the living room",
                "address": "2",
                "create": {
                    "moduleID": "{A7B0B43B-BEB0-4452-B55E-CD8A9A56B052}",
                    "configuration": {
                        "Calculation": 2,
                        "Variables": "[]"
                    },
                    "location": [
                        "Ground floor",
                        "Living room"
                    ]
                }
            },{
                "parent": 1,
                "instanceID": 53398,
                "name": "Incorrect instance",
                "address": "4"
            },{
                "parent": 1,
                "name": "Calculation module - selection",
                "address": "2",
                "create": {
                    "Maximum": {
                        "moduleID": "{A7B0B43B-BEB0-4452-B55E-CD8A9A56B052}",
                        "configuration": {
                            "Calculation": 3,
                            "Variables": "[]"
                        }
                    },
                    "Average": {
                        "moduleID": "{A7B0B43B-BEB0-4452-B55E-CD8A9A56B052}",
                        "configuration": {
                            "Calculation": 4,
                            "Variables": "[]"
                        }
                    }
                }
            }, {
                "parent": 1,
                "name": "OZW772 IP-Interface",
                "address": "00:A0:03:FD:14:BB",
                "create": [
                    {
                        "moduleID": "{33765ABB-CFA5-40AA-89C0-A7CEA89CFE7A}",
                        "configuration": {}
                    },
                    {
                        "moduleID": "{1C902193-B044-43B8-9433-419F09C641B8}",
                        "configuration": {
                            "GatewayMode":1
                        }
                    },
                    {
                        "moduleID": "{82347F20-F541-41E1-AC5B-A636FD3AE2D8}",
                        "configuration": {
                            "Host":"172.17.31.95",
                            "Port":3671,
                            "Open":true
                        }
                    }
                ]
            }
        ]
    }

    // Example with renaming of status variables
    {
        "type": "Configurator",
        "values": [{
            "name": "Calculation module (renamed status variables)",
            "address": "Address",
            "create": {
                "moduleID": "{A7B0B43B-BEB0-4452-B55E-CD8A9A56B052}",
                "configuration": {},
                "statusVariables": {
                    "Minimum": {
                        "name": "Alternative name for minimum"
                    },
                    "Maximum": {
                        "name": "Alternative name for maximum"
                    }
                }
            }
        }]
    }