parameter - APEXlang Reference

`parameter`

Parent: workflow

Direct Properties:

Property	Type	Required	Default Value	Details
`staticId`	`string`	Yes		data type=`string`; maxLen=255; textCase=`UPPER`

Property Groups:

label

Property	Type	Required	Default Value	Details
`label`	`string`	Yes		data type=`string`; maxLen=4000 An end-user friendly name of the workflow parameter.

label {
  label: value
}

parameter

Property	Type	Required	Default Value	Details
`dataType`	`enum`	Yes	`varchar2`	data type=`string`; maxLen=128; lov=`STATIC` Valid values: `varchar2` `timestamp` `timestampWithLocalTimeZone` `timestampWithTimeZone` `number` `boolean` `clob`
`direction`	`enum`	Yes	`in`	data type=`string`; lov=`STATIC` Valid values: `in` `out` `inOut` The direction of the parameter as defined within the Workflow.

parameter {
  dataType: varchar2
  direction: in
}

validation

Property	Type	Required	Default Value	Details
`required`	`boolean`	Yes	`false`	data type=`boolean` Applies when`direction in (in)direction in (inOut)`

validation {
  required: false
}

default

Property	Type	Required	Default Value	Details
`value`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`direction in (in)direction in (inOut)` Default value of this parameter.

default {
  value: ```
    value
  ```
}

displayFormatMasks

Property	Type	Required	Details
`sessionStateFormatMask`	`string`	No	data type=`string`; maxLen=255 Applies when`dataType in (number)dataType in (timestamp)dataType in (timestampWithTimeZone)dataType in (timestampWithLocalTimeZone)`
`trueValue`	`string`	No	data type=`string`; maxLen=10 Applies when`dataType = boolean`
`falseValue`	`string`	No	data type=`string`; maxLen=10 Applies when`dataType = boolean`

displayFormatMasks {
  sessionStateFormatMask: value
  trueValue: value
  falseValue: value
}

comments

Property	Type	Required	Default Value	Details
`comments`	`multiline string`	No		data type=`multiline string`; maxLen=4000

comments {
  comments: ```
    value
  ```
}

APEXlang Example

parameter sample (
    staticId: value
    label {
        label: value
    }
    parameter {
        dataType: varchar2
        direction: in
    }
    validation {
        required: false
    }
    default {
        value: ```
          value
        ```
    }
    displayFormatMasks {
        sessionStateFormatMask: value
        trueValue: value
        falseValue: value
    }
    comments {
        comments: ```
          value
        ```
    }
)