UserParameter

Field Type Description

name

String

Name of user parameter

label

String

Label for user parameter

format

String

Validation string for parameter value

Note:

Format options:

  • For STRING parameters, the format is a regular expression.
  • For DATE parameters, the format is Java Simple Date format.

mandatory

Boolean

Indicates if user parameter is mandatory

type

UserParameterType

Type of user parameter

Note:

Possible values:

  • OUTPUTGENERATOR_LIST
  • OUTPUTGENERATOR_CHOICE
  • OUTPUTGENERATOR_STRING
  • OUTPUTGENERATOR_DATE
  • OUTPUTGENERATOR_INTEGER
  • OUTPUTGENERATOR_INDEX_LIST
  • OUTPUTGENERATOR_INDEX_CHOICE

tooltip

String

Tooltip for user parameter

values

UserParameterValue[ ]

List of values for user parameter