symbol

Symbol

Allgemeine Informationen

Schema

JSON-Schema

{
    "configDescription": "DESC_SYMBOL",
    "properties": {
        "ACCESS": {
            "allOf": [
                {
                    "$ref": "tchmi:server#/definitions/accessEnum"
                },
                {
                    "configDescription": "DESC_ACCESS"
                }
            ]
        },
        "CUSTOMERDATA": {
            "type": "string"
        },
        "DOMAIN": {
            "description": "Domain of the symbol",
            "optionMethod": {
                "symbol": "ListDomains"
            },
            "type": "string"
        },
        "DYNAMIC": {
            "default": true,
            "description": "Only dynamic symbols can be removed.",
            "type": "boolean"
        },
        "HIDDEN": {
            "default": false,
            "description": "Hide this symbol in the symbol browser.",
            "type": "boolean"
        },
        "MAPPING": {
            "description": "This is how the given domain will access the symbol.",
            "type": "string"
        },
        "OPTIONS": {
            "additionalProperties": {},
            "type": "object"
        },
        "SCHEMA": {
            "allOf": [
                {
                    "$ref": "tchmi:server#/definitions/schemaRef"
                },
                {
                    "description": "Json schema describing the output parameters of the symbol."
                }
            ]
        },
        "SUBSYMBOL_MAPPING": {
            "description": "This sub-path is not forwarded to the extension. The server automatically browses into the result of the mapped symbol.",
            "type": "string"
        },
        "USEMAPPING": {
            "default": true,
            "description": "If true the mapping will be used, otherwise the symbol will be evaluated in the server.",
            "type": "boolean"
        }
    },
    "required": [
        "DOMAIN",
        "MAPPING",
        "ACCESS"
    ],
    "type": "object"
}