GmsInt Configuration

GmsInt Type Configuration Data

Data

Use

Description

GmsType

Mandatory

GMSINT

Attributes

Attributes

Object containing the attributes of the property. For details, see Table GmsInt Attributes, below. The empty object (“Attributes”: { }) resets the attributes data.

 

GmsInt Attributes

Data

Use

Description

Valid

Optional

Validity flag. If false, the display data is set but considered invalid.

Properties

Optional

Object containing the valid range values. For details, see Table GmsInt Properties, below. If the object is empty (“Properties”: { }), the range values are reset, and the range is Int32.MinValue ÷ Int32.MaxValue or -128 ÷ 127 according to the PvssType.

UnitText

Optional

Object containing the engineering unit data. For details, see Table Engineering Unit, below. If the object is empty (“UnitText”: { }), the engineering unit is reset.

 

GmsInt Properties

Data

Use

Description

Min

Optional

Min value.

Max

Optional

Max value.

Since the GmsInt can be based either on PvssInt or PvssChar, the values Min and Max must respect the following limits:

  • In case of PvssInt: -2147483648 ÷ 2147483647
  • In case of PvssChar: -128 ÷ 127

Engineering Unit

Data

Use

Description

TextGroup

Optional

Unit Text Group containing the specified engineering unit.

NOTE: If the TextGroup string or Unit string are empty (it is enough that only one of them is empty), the engineering unit is ignored.

Unit

Optional

String representing the engineering unit.

This string must be written according to Desigo CC default language (en-US).

NOTE: If the TextGroup string or Unit string are empty (it is enough that only one of them is empty), the engineering unit is ignored.

Example

{

    "Name": "Int_Value",

    "PvssType": { "PvssType": "INT" },

    "VL": true,

    "AL": true,

    "Persist": true,

    "GroupId": "CONFIG",

    "Description": [ { "Culture": "en-US", "Text": "Integer Value" } ],

    "Display": {

        "Valid": true,

        "Icon": {

            "Library": "Global_Base_HQ_1",

            "Name": "Op_DP_Generic_None_001.png"

        }

    },

    "GmsType": {

        "GmsType": "GMSINT",

        "Attributes”: {

            "Valid": true,

            "UnitText": {

                "Unit": "°C",

                "TextGroup": "TxG_EngineeringUnits"

            },

            "Properties”: {

                "Min": -40,

                "Max": 70

            }

        }

    }

}

 

The following image shows the corresponding fields in the Models & Functions tab: