parameter - APEXlang Reference

`parameter`

Parent: activity

Applies whentype = WEB_SOURCE

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`reference`	Yes		data type=`reference`; lov=`COMPONENT`; references=`parameter`

Property Groups:

parameter

Property	Type	Required	Default Value	Details
`ignoreOutput`	`boolean`	Yes	`true`	data type=`boolean` Applies when`name supports IN_OUT_PARAMETERname supports OUT_PARAMETER`

parameter {
  ignoreOutput: false
}

value

Property	Type	Required	Default Value	Details
`type`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `staticValue` `restSourceDefault` `item` `sqlQuery` `expression` `functionBody` `collectionClob` `preference` `null` Applies when`name supports IN_PARAMETERname supports IN_OUT_PARAMETERname supports IN_OUT_PARAMETER and ignoreOutput = falsename supports OUT_PARAMETER and ignoreOutput = false`
`staticValue`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`name supports IN_PARAMETER and type = staticValue and name does not support BOOLEAN_PARAMETERname supports IN_OUT_PARAMETER and type = staticValue and name does not support BOOLEAN_PARAMETERname supports IN_OUT_PARAMETER and ignoreOutput = false and type = staticValue and name does not support BOOLEAN_PARAMETERname supports OUT_PARAMETER and ignoreOutput = false and type = staticValue and name does not support BOOLEAN_PARAMETER`
`staticValue`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `true` `false` Applies when`name supports IN_PARAMETER and type = staticValue and name supports BOOLEAN_PARAMETERname supports IN_OUT_PARAMETER and type = staticValue and name supports BOOLEAN_PARAMETERname supports IN_OUT_PARAMETER and ignoreOutput = false and type = staticValue and name supports BOOLEAN_PARAMETERname supports OUT_PARAMETER and ignoreOutput = false and type = staticValue and name supports BOOLEAN_PARAMETER`
`sqlQuery`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`name supports IN_PARAMETER and type = sqlQueryname supports IN_OUT_PARAMETER and type = sqlQueryname supports IN_OUT_PARAMETER and ignoreOutput = false and type = sqlQueryname supports OUT_PARAMETER and ignoreOutput = false and type = sqlQuery`
`item`	`string`	Yes		data type=`string`; maxLen=255; textCase=`UPPER` Applies when`name supports IN_PARAMETER and type = itemname supports IN_OUT_PARAMETER and type = itemname supports IN_OUT_PARAMETER and ignoreOutput = false and type = itemname supports OUT_PARAMETER and ignoreOutput = false and type = item`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `sql` `plsql` `javaScript-mle` Applies when`name supports IN_PARAMETER and type = expressionname supports IN_OUT_PARAMETER and type = expressionname supports IN_OUT_PARAMETER and ignoreOutput = false and type = expressionname supports OUT_PARAMETER and ignoreOutput = false and type = expression`
`sqlExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`name supports IN_PARAMETER and type = expression and language = sqlname supports IN_OUT_PARAMETER and type = expression and language = sqlname supports IN_OUT_PARAMETER and ignoreOutput = false and type = expression and language = sqlname supports OUT_PARAMETER and ignoreOutput = false and type = expression and language = sql`
`plsqlExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`name supports IN_PARAMETER and type = expression and language = plsqlname supports IN_OUT_PARAMETER and type = expression and language = plsqlname supports IN_OUT_PARAMETER and ignoreOutput = false and type = expression and language = plsqlname supports OUT_PARAMETER and ignoreOutput = false and type = expression and language = plsql`
`javaScriptExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`name supports IN_PARAMETER and type = expression and language = javaScript-mlename supports IN_OUT_PARAMETER and type = expression and language = javaScript-mlename supports IN_OUT_PARAMETER and ignoreOutput = false and type = expression and language = javaScript-mlename supports OUT_PARAMETER and ignoreOutput = false and type = expression and language = javaScript-mle`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `plsql` `javaScript-mle` Applies when`name supports IN_PARAMETER and type = functionBodyname supports IN_OUT_PARAMETER and type = functionBodyname supports IN_OUT_PARAMETER and ignoreOutput = false and type = functionBodyname supports OUT_PARAMETER and ignoreOutput = false and type = functionBody`
`plsqlFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`name supports IN_PARAMETER and type = functionBody and language = plsqlname supports IN_OUT_PARAMETER and type = functionBody and language = plsqlname supports IN_OUT_PARAMETER and ignoreOutput = false and type = functionBody and language = plsqlname supports OUT_PARAMETER and ignoreOutput = false and type = functionBody and language = plsql`
`javaScriptFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`name supports IN_PARAMETER and type = functionBody and language = javaScript-mlename supports IN_OUT_PARAMETER and type = functionBody and language = javaScript-mlename supports IN_OUT_PARAMETER and ignoreOutput = false and type = functionBody and language = javaScript-mlename supports OUT_PARAMETER and ignoreOutput = false and type = functionBody and language = javaScript-mle`
`preference`	`string`	Yes		data type=`string`; maxLen=255; textCase=`UPPER` Applies when`name supports IN_PARAMETER and type = preferencename supports IN_OUT_PARAMETER and type = preferencename supports IN_OUT_PARAMETER and ignoreOutput = false and type = preferencename supports OUT_PARAMETER and ignoreOutput = false and type = preference`
`name`	`string`	Yes		data type=`string`; maxLen=255; textCase=`UPPER` Applies when`name supports IN_PARAMETER and type = collectionClobname supports IN_OUT_PARAMETER and type = collectionClobname supports IN_OUT_PARAMETER and ignoreOutput = false and type = collectionClobname supports OUT_PARAMETER and ignoreOutput = false and type = collectionClob`
`formatMask`	`string`	No		data type=`string`; maxLen=255 Applies when`name supports NUMBER_PARAMETER and name supports IN_PARAMETER and type in (staticValue)name supports NUMBER_PARAMETER and name supports IN_PARAMETER and type in (item)name supports NUMBER_PARAMETER and name supports IN_PARAMETER and type in (preference)name supports NUMBER_PARAMETER and name supports IN_OUT_PARAMETER and type in (staticValue)name supports NUMBER_PARAMETER and name supports IN_OUT_PARAMETER and type in (item)name supports NUMBER_PARAMETER and name supports IN_OUT_PARAMETER and type in (preference)name supports NUMBER_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (staticValue)name supports NUMBER_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (item)name supports NUMBER_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (preference)name supports NUMBER_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (staticValue)name supports NUMBER_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (item)name supports NUMBER_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (preference)name supports DATE_PARAMETER and name supports IN_PARAMETER and type in (staticValue)name supports DATE_PARAMETER and name supports IN_PARAMETER and type in (item)name supports DATE_PARAMETER and name supports IN_PARAMETER and type in (preference)name supports DATE_PARAMETER and name supports IN_OUT_PARAMETER and type in (staticValue)name supports DATE_PARAMETER and name supports IN_OUT_PARAMETER and type in (item)name supports DATE_PARAMETER and name supports IN_OUT_PARAMETER and type in (preference)name supports DATE_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (staticValue)name supports DATE_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (item)name supports DATE_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (preference)name supports DATE_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (staticValue)name supports DATE_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (item)name supports DATE_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (preference)name supports TIMESTAMP_PARAMETER and name supports IN_PARAMETER and type in (staticValue)name supports TIMESTAMP_PARAMETER and name supports IN_PARAMETER and type in (item)name supports TIMESTAMP_PARAMETER and name supports IN_PARAMETER and type in (preference)name supports TIMESTAMP_PARAMETER and name supports IN_OUT_PARAMETER and type in (staticValue)name supports TIMESTAMP_PARAMETER and name supports IN_OUT_PARAMETER and type in (item)name supports TIMESTAMP_PARAMETER and name supports IN_OUT_PARAMETER and type in (preference)name supports TIMESTAMP_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (staticValue)name supports TIMESTAMP_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (item)name supports TIMESTAMP_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (preference)name supports TIMESTAMP_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (staticValue)name supports TIMESTAMP_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (item)name supports TIMESTAMP_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (preference)name supports TIMESTAMP_TZ_PARAMETER and name supports IN_PARAMETER and type in (staticValue)name supports TIMESTAMP_TZ_PARAMETER and name supports IN_PARAMETER and type in (item)name supports TIMESTAMP_TZ_PARAMETER and name supports IN_PARAMETER and type in (preference)name supports TIMESTAMP_TZ_PARAMETER and name supports IN_OUT_PARAMETER and type in (staticValue)name supports TIMESTAMP_TZ_PARAMETER and name supports IN_OUT_PARAMETER and type in (item)name supports TIMESTAMP_TZ_PARAMETER and name supports IN_OUT_PARAMETER and type in (preference)name supports TIMESTAMP_TZ_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (staticValue)name supports TIMESTAMP_TZ_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (item)name supports TIMESTAMP_TZ_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (preference)name supports TIMESTAMP_TZ_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (staticValue)name supports TIMESTAMP_TZ_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (item)name supports TIMESTAMP_TZ_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (preference)` Format mask to convert the Static, Item or Preference value to the data type of the REST Source Parameter.
`trueValue`	`string`	No		data type=`string`; maxLen=10 Applies when`name supports BOOLEAN_PARAMETER and name supports IN_PARAMETER and type in (item)name supports BOOLEAN_PARAMETER and name supports IN_PARAMETER and type in (preference)name supports BOOLEAN_PARAMETER and name supports IN_OUT_PARAMETER and type in (item)name supports BOOLEAN_PARAMETER and name supports IN_OUT_PARAMETER and type in (preference)name supports BOOLEAN_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (item)name supports BOOLEAN_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (preference)name supports BOOLEAN_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (item)name supports BOOLEAN_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (preference)`
`falseValue`	`string`	No		data type=`string`; maxLen=10 Applies when`name supports BOOLEAN_PARAMETER and name supports IN_PARAMETER and type in (item)name supports BOOLEAN_PARAMETER and name supports IN_PARAMETER and type in (preference)name supports BOOLEAN_PARAMETER and name supports IN_OUT_PARAMETER and type in (item)name supports BOOLEAN_PARAMETER and name supports IN_OUT_PARAMETER and type in (preference)name supports BOOLEAN_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (item)name supports BOOLEAN_PARAMETER and name supports IN_OUT_PARAMETER and ignoreOutput = false and type in (preference)name supports BOOLEAN_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (item)name supports BOOLEAN_PARAMETER and name supports OUT_PARAMETER and ignoreOutput = false and type in (preference)`

value {
  type: staticValue
  staticValue: ```
    value
  ```
  sqlQuery: ```sql
    value
  ```
  item: value
  language: sql
  sqlExpression: ```sql
    value
  ```
  plsqlExpression: ```plsql
    value
  ```
  javaScriptExpression: ```javascript-mle
    value
  ```
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  preference: value
  name: value
  formatMask: value
  trueValue: value
  falseValue: value
}

APEXlang Example

parameter sample (
    name: @component
    parameter {
        ignoreOutput: false
    }
    value {
        type: staticValue
        staticValue: ```
          value
        ```
        sqlQuery: ```sql
          value
        ```
        item: value
        language: sql
        sqlExpression: ```sql
          value
        ```
        plsqlExpression: ```plsql
          value
        ```
        javaScriptExpression: ```javascript-mle
          value
        ```
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        preference: value
        name: value
        formatMask: value
        trueValue: value
        falseValue: value
    }
)