Group¶

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

Key	Type	Default	Description	UPM/TD
`style`	enum: `Plain`, `Collapsible`, `Checkable`, `Borderless`	`Plain`	`Collapsible`: allows the group to expand/collapse. `Checkable`: Same as `Collapsible` plus a checkbox to enable/disable the group, and has a boolean value of "YES" or "NO". When unchecked, all child parameters will be disabled regardless of their `visibility` dynamic properties. `Borderless`: Same as `Plain` but with no visible border provided.	¹
`collapse`	bool	`true`²	If `true`, the group is collapsed when the dialog is first opened. This setting overrides the default open/close behavior.
`expand`	obj		Dynamic property for expanding and collapsing the group. Default specified by `collapse`. Ignored if `style` is `Plain` or `Borderless`.
`gridColumns`	int	`1`	The number of columns to layout the contents of `parameters` in.
`radioParameter`	bool	`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 have a value, set to the name of the currently selected radio parameter.³
`parameters`	arr(obj)	`[]`	A list of objects defining the parameters to be shown in this group. When the group is disabled, all parameters within the group will also be disabled.

Deprecated¶

Key	Type	Required	Description
`predefinedSet`	enum: `readerOptions`⁴, `writerOptions`⁵, `xmlFlattenOptions`⁶, `authenticationOptions`⁷		Specialized predefined groups of parameters.
`predefinedSetSettings`	object	/⁸	Additional settings when `predefinedSet` is specified.
`delimiter`⁹	char¹⁰		When specified, the group will have a value of name/value pairs of the parameters within the group, delimited by the given character.¹¹
`defaultParameter`	obj		Dynamic property to determine which parameter is treated as the default when group is defined within a table column. The default parameter will be shown in the table cell along with a "..." button to access the entire group. If no default is defined, only a button will be displayed in the table cell¹².

predefinedSetSettings¶

`readerOptions` or `writerOptions`¶

Key	Type	Default
`connectionInfoOnly`	bool	`false`
`disableCoordSys`	bool	`false`
`supportPublishedParams`	bool	`false`
`hideGroupBox`	bool	`false`
`hideSpatialSettings`	bool	`false`
`multipleDatasets`	bool	`false`
`supportAttributes`	bool	`false`
`useSessionDefaults`	bool	`true`
`supportFormats`	arr(str)	`[]`
`parametersToHide`	arr(str)	`[]`

`authenticationOptions`¶

Key	Type	Required	Default	Description
`groupTitle`	str			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
  }
}

Borderless option not available. ↩
Default behavior for checkable groups is to start collapsed if unchecked and expanded if checked. ↩
The group value can be customized using the choices field by definining choice objects that have display values matching each parameter name in the group, with the value field containing the desired value when the corrisponding parameter is selected. ↩
Used to migrate READERPROMPT GuiType. ↩
Used to migrate WRITERPROMPT GuiType. ↩
Used to migrate XML_FLATTEN_OPTIONS GuiType. ↩
Used to migrate AUTHENTICATOR GuiType. ↩
Required when predefinedSet is readerOptions, writerOptions, or authenticationOptions. ↩
Used by multiparameters that have been migrated to groups. ↩
Must be a single ASCII character. ↩
Cannot be specified when group already has a value (style is Collapsible or Checkable, or radioParameter is true). ↩
When the group contains only one visible parameter, that parameter will be shown directly in the table cell without a button. ↩