[Back to Parameters]

Group

A container for multiple component parameters which will be arranged sequentially. The 'prompt' text will be used as the title of the group box.

Specification

key	type	required	default value	description
style	enum: Plain, Collapsible, Checkable	no	Plain	Collapsible will allow the group to expand/collapse. Checkable implies collapsible but adds a checkbox to enable/disable the group. If checkable, a boolean value (string "YES" or "NO") is stored indicating whether the group is checked or not (all child parameters will be disabled, regardless of their "visibility" dynamic properties).
collapse	boolean	no	varies based on checkable/non-checkable group	If true, the dialog will open with the group collapsed initially. Default behavior for non-checkable groups is to start collapsed. Default behavior for checkable groups to start collapsed if unchecked and expanded if checked. This setting overrides the default open/close behavior.
expand	object	no	n/a	Logic to control expanding and collapsing the group. Default specified by "collapse". Ignored if "style" is Plain.
gridColumns	integer	no	1	The number of columns into which to arrange the group's parameters.
radioParameter	boolean	no	false	If true: • Each parameter in the group will be shown with a radio button next to it, with all parameters disabled except the selected one. • Neither the group's header prompt nor its border will be displayed. • The group will store the name of parameter corresponding to the currently selected radio parameter, unless that parameter's definition in the 'parameter' array includes an entry with the key 'radioValue' mapping it to a value, in which case that value will be stored instead.
parameters	array\	yes	n/a	A list of objects defining the parameters to be shown in this group. If the group is checked or disabled, all parameters within the group will also be disabled.

deprecated

key	type	required	default value	description
predefinedSet	enum: 'readerOptions', 'writerOptions', 'xmlFlattenOptions', 'authenticationOptions'	conditional	n/a	If this is specified, parameterSets is optional, and 'predefinedSetSettings' will be required, except in the case of 'xmlFlattenOptions'.
predefinedSetSettings	dictionary	conditional	n/a	Settings when predefinedSet is specified.
delimiter	char	no	n/a	Specifies the delimiter for Multi Parameters that have been migrated to groups. When set, the values of parameters within the group will be returned as a delimited string. Cannot be specified when group is a type with it's own value (Checkable/Radio). This value must be a single ASCII character.

predefinedSetSettings

'readerOptions' or 'writerOptions'

key	type	required	default value	description
connectionInfoOnly	boolean	no	false
disableCoordSys	boolean	no	false
supportPublishedParams	boolean	no	false
hideGroupBox	boolean	no	false
hideSpatialSettings	boolean	no	false
multipleDatasets	boolean	no	false
supportAttributes	boolean	no	false
useSessionDefaults	boolean	no	true
supportFormats	array\	no	[]
parametersToHide	array\	no	[]

'authenticationOptions'

key	type	required	description
groupTitle	string	no	The title to use on the group box that will contain the authentication settings.

Dynamic Properties

expand

Type: boolean

• true: the group parameter will be expanded, unless its parent "group" is collapsed or parent parameter ("group", "table", or "multi") is in a collapsed "group"
• false: the group parameter will be collapsed
• non-boolean or undefined: use default for "group"

This property only applies to "group" parameters. For all other parameter types, this property will be ignored.

expand Example:

"expand": {
  "if": [{
    "$equals": {
      "parameter": "EXPANSION_CHECKBOX",
      "value": "YES"
    },
    "then": true
  },
  {
    "$equals": {
      "parameter": "EXPANSION_CHECKBOX",
      "value": "NO"
    },
    "then": false
  }],
  "default": false
}

Example

{
  "name": "REQUEST",
  "type": "group",
  "prompt": "Request",
  "parameters": [
    {
      "name": "OPERATION_TYPE",
      "type": "dropdown"
      "prompt": "Google Drive Action"
      "valueType": "string"
    },
    {
      "name": "GOOGLEDRIVE_NAMED_CONNECTION",
      "type": "dropdown"
      "choiceSettings": {
         "choiceSet": "webConnections"
         "webConnectionSettings": {
            "services": "Google Drive"
         }
      }
      "prompt": "Google Drive Account:"
      "valueType": "stringEncoded"
    }
  ],
  "style": "Collapsible",
  "expand": {
    "if": [
      {
        "$equals": {
          "parameter": "USE_GOOGLEDRIVE",
          "value": "YES"
        },
        "then": true
      }
    ],
    "default": false
  }
}