param

Creates a parameter descriptor, which defines the parameter. Declaration of a param descriptor must be located within a <params> block. Constraints for the param may be included as an attribute (for range constraints), or as child tags (for choice constraints).

Syntax

<param oid="oid" attributes/>

 

<param oid="oid" attributes>

<constraint/>

<constraint/>

. . .

<config/>

<config/>

. . .

</param>

Attributes

Attribute

Values

Restrictions

Description

oid

String

Required, except for subparams

The OID of the parameter (can be used to override an existing parameter).

suboid

String

Required for subparams

If the param declaration is a sub-param within a struct, the OID is specified in the suboid attribute.

access

0

 

Parameter is read-only in DashBoard

1

Parameter is read-write in DashBoard

name

String

 

Parameter Name

widget

Positive integer

Must be a valid widget hint

Defines the default widget hint for the param.

maxlength

Positive integer

Applies only to String/String Array parameters

The maximum length of any String element in the parameter.

precision

Positive integer

 

This field defines the number of digits following the decimal point displayed for printed numbers. It applies mainly to floating point numbers.

type

INT16

 

Param is 16-bit signed integer.

INT16_ARRAY

 

Param is an array of 16-bit signed integer.

INT32

 

Param is 32-bit signed integer.

INT32_ARRAY

 

Param is an array of 32-bit signed integer.

STRING

 

Param is a string.

STRING_ARRAY

 

Param is an array of strings.

FLOAT32

 

Param is a 32-bit (IEEE single) float.

FLOAT32_ARRAY

 

Param is an array of 32-bit (IEEE single) float.

STRUCT

 

Param is a struct.

STRUCT_ARRAY

 

Param is an array of struct.

BINARY_VALUE

 

Param is of unknown type.

constraint

cvalue

 

See constraint tag for more details.

constrainttype

ctype

 

See constraint tag for more details.

stateless

false

 

Parameters are saved to backing source

true

Parameters are not saved

value

varies

Value type must be compatible with the specified type.

Specifies the initial value of the param. Arrays may be initialized by separating values with ";".

config

varies

 

Provides additional widget configuration parameters. See config tag for details.

Default values shown in bold.

Example

<param access="1" maxlength="0" name="Message" oid="Message" type="STRING" value="Reverse this message" widget="3"/>