UserParameter

Field Type Description

name

String

Name of the user parameter.

label

String

Label for the user parameter.

format

String

Validation string for the parameter value.

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

mandatory

Boolean

Indicates if the user parameter is mandatory.

type

UserParameterType

Type of the user parameter. The possible values are:

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

tooltip

String

Tooltip for the user parameter.

values

UserParameterValue[]

List of values for the user parameter.