Parameter Data

Each parameter must contain the following data:

Data

Use

Description

Name

Mandatory

Name of the parameter.

Label

Optional

List of values used as descriptions of the parameter. Each value must contain the following data:

  • Culture: culture of the text (for example, “en-US”)
  • Text: label

DefaultValue

Optional

String representing the type of source for the parameter value.

The acceptable values are:

  • REFER_CMD_DEF
  • RUNTIME
  • PROVIDED
  • DEFAULT_PROVIDED
  • IMPLICIT_CNS

NOTES:

If not specified, the REFER_CMD_DEF PROVIDED value is taken by default.

If RUNTIME is specified, the AffectedProperty data must be set.

If PROVIDED or DEFAULT_PROVIDED is specified, the Value data must be set.

In all cases where the specified value is different from PROVIDED or DEFAULT_PROVIDED, the Value data is ignored.

Value

Optional

The value of the parameter.

NOTE: The value must be expressed according to the CultureInfo.InvariantCulture.

Control

Optional

String representing the type of user control to be used in the user interface.

Possible settings are:

  • NUMERIC
  • DROPDOWN
  • STRING
  • DATETIME
  • PASSWORD

NOTE: If not specified, the STRING value is taken by default.

AffectedProperty

Optional

Name of the affected property.

NOTES:

  • If the affected property is part of a structure or a reference, the complete name must be specified (<name of structure>.<name of property> - for example: “Struct_Value.Int_Value”).
  • If the affected property is an element of a set, the name must be composed by the set name and the property index (<set name>[<index>] – for example: “SetChar_Value[1]”). Note that the index starts with “1”.
  • The affected property must be compatible with the type of the parameter specified in the command definition.
  • If a command has more than one parameter, the affected property can be specified on one of the parameters only.

FilterProperty

Optional

Name of the filter property.

NOTE: The type of the property indicated must be ARRAYUINT (dynamic array of unsigned integers).

Application

Optional

String representing the type of application.

Possible settings are:

  • PROPERTY
  • INDEX

NOTE: If not specified, the PROPERTY value is taken by default.