Models
ConfigCurrentSpace
Config to be used within a Space.
| Name | Type | Description | Required |
|---|
| actions | CurrentSpaceActions | List of all available actions. Possible values: Claim, Release, Assign, Unassign, Decision, ViewForm, Recover, Withdraw, Receipt | No |
| attachments | CurrentSpaceAttachments | Sets the filters for the Attachments. Default: null | No |
| customCards | CurrentSpaceCustomCards | List of custom cards to be rendered in the Custom Cards section. Default: [] | No |
| hideTasks | CurrentSpaceHideTasks | Shows a list of steps and an array of tasks as children of those steps to be hidden from the timeline | No |
| icon | CurrentSpaceIcon | Sets the icon to be used for the space Default: static//icon.png | Yes |
| invoke | CurrentSpaceInvoke | Configuration to invoke fluent function. Default: null | No |
| jobKeyInfo | CurrentSpaceKeyInfo | List of properties to be rendered in the Job Key Info section. Default: [] | No |
| keyInfo | CurrentSpaceKeyInfo | List of properties to be rendered in the Key Info section. Default: [] | No |
| label | GlobalLabel | Sets the label to be used for the space | Yes |
| permissions | GlobalPermissions | Sets the permissions for the Space | No |
| rules | GlobalRules | Rules that show/hide the attachments upload button | No |
| steps | CurrentSpaceSteps | Configuration for timeline. Default: [] | No |
ConfigGlobal
Config to be used globally.
| Name | Type | Description | Required |
|---|
| favicon | string | Favicon config to be used globally. Default: static//favicon.png | No |
| hideSteps | GlobalHideSteps | List of steps to hide in the Timeline section. Default: [] | No |
| logo | string | Logo config to be used globally. Default: static/logo.png | No |
| mappings | GlobalMappings | Mappings config to be used globally. Default: null | Yes |
| scope | GlobalScope | Scope config to be used with txn and currentTxn query. Default: Form | No |
| theme | Theme | Theme config to be used globally. Default: null | No |
CurrentSpaceAction
Actions config to display in the Txn Table and Actions section.
Default: null
CurrentSpaceActionCustom
Custom Actions config to display in the Txn Table and Actions section.
Default: null
CurrentSpaceActionCustomProperties
List of custom actions
| Name | Type | Description | Required |
|---|
| CurrentSpaceActionCustomProperties | array | List of custom actions | |
CurrentSpaceActionCustomProperty
Custom Action Property
CurrentSpaceActions
List of available actions.
| Name | Type | Description | Required |
|---|
| Abandon | CurrentSpaceAction | When clicked it triggers the abandone process. | No |
| AddNotes | CurrentSpaceAction | When clicked it shows the Add Notes modal. | No |
| Assign | CurrentSpaceAction | When clicked it opens up a dropdown of usernames to pick from. Once a user is selected, the current Txn gets assigned to that user. | No |
| Claim | CurrentSpaceAction | When clicked it assigns the current Txn to the current user. | No |
| Custom | CurrentSpaceActionCustom | Allows configured custom actions to be displayed in a dropdown. | No |
| Decision | CurrentSpaceAction | When clicked it opens up a modal with the current Txn formUrl + &pageId=decision. | No |
| Purge | CurrentSpaceAction | When clicked it triggers the purge process. | No |
| Reassign | CurrentSpaceAction | When clicked it opens up a dropdown of usernames to pick from. Once a user is selected, the current Txn gets re-assigned to that user. | No |
| Receipt | CurrentSpaceAction | Shows the receipt. When clicked it opens up a modal with the current Txn formReceipt. If there is more than one receipt attached to the Txn, the modal will show a dropdown list to view each one. | No |
| Recover | CurrentSpaceAction | When clicked the abandoned txn will be re-opened. | No |
| Release | CurrentSpaceAction | When clicked it unassigns the current Txn. This actions will be available only if the current user is the assignee. | No |
| Resume | CurrentSpaceAction | When clicked it resumes the job. | No |
| TransactionPurge | CurrentSpaceAction | When clicked it triggers the txn purge process. | No |
| Unassign | CurrentSpaceAction | When clicked it unassigns the current Txn. The difference with Release is that Unassign is available to all users. | No |
| ViewForm | CurrentSpaceAction | When clicked it opens up a modal with the current Txn formUrl + &pageId=view. | No |
| ViewXML | CurrentSpaceAction | When clicked it display the txn's XML. | No |
| Withdraw | CurrentSpaceAction | When clicked saved txn will be abandoned. | No |
CurrentSpaceAttachments
CurrentSpaceAttachmentsDuplicates
Remove duplicates.
| Name | Type | Description | Required |
|---|
| CurrentSpaceAttachmentsDuplicates | boolean | Remove duplicates. | |
CurrentSpaceAttachmentsFilter
Filter applied to attachments
| Name | Type | Description | Required |
|---|
| action | string | Action for the filter. Possible values: include, exclude | Yes |
| regex | string | Regex to match for the filter. If action is set to excludes, any items that match will be excluded. If action is set to includes and items that match will be included | Yes |
Hides the Document Upload Button
| Name | Type | Description | Required |
|---|
| CurrentSpaceAttachmentsHideUploadButton | boolean | Hides the Document Upload Button | |
CurrentSpaceAttachmentsUploadWithoutClaim
Sets the permissions for the Action.
| Name | Type | Description | Required |
|---|
| CurrentSpaceAttachmentsUploadWithoutClaim | boolean | Sets the permissions for the Action. | |
CurrentSpaceCustomCardContainerProperty
| Name | Type | Description | Required |
|---|
| columnWrap | GlobalColumnWrap | Sets the column content to not wrap. Possible Values: false | No |
| dataIndex | GlobalDataIndex | Sets the path of the Txn property to be displayed. Default: null | No |
| format | GlobalFormat | Sets a format for the data Possible values: relative, duration | No |
| fullWidth | GlobalFullWidth | Sets property display to full width Possible values: true | No |
| label | GlobalLabel | Sets the label to be used | Yes |
| link | GlobalLink | Sets attributes for the link | No |
| name | GlobalName | Sets a name for the data Possible values: string | No |
| parse | GlobalParse | Sets a parse for the data. Possible values: null | No |
| properties | [ CurrentSpaceCustomCardProperty ] | Properties for Custom Cards | No |
| span | GlobalSpan | Sets the grid config. | No |
| type | GlobalType | Sets property type. Possible values: date, text, number | No |
CurrentSpaceCustomCardList
CurrentSpaceCustomCardListExtended
CurrentSpaceCustomCardListStacked
CurrentSpaceCustomCardProperty
| Name | Type | Description | Required |
|---|
| columnWrap | GlobalColumnWrap | Sets the column content to not wrap. Possible Values: false | No |
| dataIndex | GlobalDataIndex | Sets the path of the Txn property to be displayed. Default: null | No |
| format | GlobalFormat | Sets a format for the data Possible values: relative, duration | No |
| fullWidth | GlobalFullWidth | Sets property display to full width Possible values: true | No |
| label | GlobalLabel | Sets the label to be used | Yes |
| link | GlobalLink | Sets attributes for the link | No |
| name | GlobalName | Sets a name for the data Possible values: string | No |
| parse | GlobalParse | Sets a parse for the data. Possible values: null | No |
| span | GlobalSpan | Sets the grid config. | No |
| type | GlobalType | Sets property type. Possible values: date, text, number | No |
CurrentSpaceCustomCardTable
CurrentSpaceCustomCardTableExtended
CurrentSpaceCustomCardTabs
Sets the customCard tabs properties
CurrentSpaceCustomCardTabsLabel
Sets the label to be used for the custom card tab
| Name | Type | Description | Required |
|---|
| CurrentSpaceCustomCardTabsLabel | string | Sets the label to be used for the custom card tab | |
CurrentSpaceCustomCardTabsProperties
| Name | Type | Description | Required |
|---|
| CurrentSpaceCustomCardTabsProperties | | | |
CurrentSpaceCustomCardTabsPropertiesArray
| Name | Type | Description | Required |
|---|
| CurrentSpaceCustomCardTabsPropertiesArray | array | | |
CurrentSpaceCustomCards
Array of Custom Cards
| Name | Type | Description | Required |
|---|
| CurrentSpaceCustomCards | array | Array of Custom Cards | |
CurrentSpaceHideTasks
Shows a list of steps and an array of tasks as children of those steps to be hidden from the timeline
| Name | Type | Description | Required |
|---|
| CurrentSpaceHideTasks | object | Shows a list of steps and an array of tasks as children of those steps to be hidden from the timeline | |
CurrentSpaceIcon
Sets the icon to be used for the space
| Name | Type | Description | Required |
|---|
| CurrentSpaceIcon | string | Sets the icon to be used for the space | |
CurrentSpaceInvoke
CurrentSpaceKeyInfo
List of items displaying in the Key Info panel
| Name | Type | Description | Required |
|---|
| CurrentSpaceKeyInfo | array | List of items displaying in the Key Info panel | |
CurrentSpaceProperty
Defines a mapping for use in the view.
| Name | Type | Description | Required |
|---|
| columnWrap | GlobalColumnWrap | Sets the column content to not wrap. Possible Values: false | No |
| dataIndex | GlobalDataIndex | Sets the path of the Txn property to be displayed. Default: null | Yes |
| filter | GlobalFilter | Sets the filter strategy for this mapping. Possible values: input, select, multiselect, picker | No |
| format | GlobalFormat | Sets a format for the data Possible values: relative, duration | No |
| hideFromTable | boolean | Hide fields from table (but can still filter on them) | No |
| icon | CurrentSpaceIcon | Sets the icon to be used | No |
| label | GlobalLabel | Sets the label to be used | Yes |
| parse | GlobalParse | Sets a parse for the data. Possible values: null | No |
| sorter | GlobalSorter | Sets the mapping to be sortable via the column header | No |
| tooltip | GlobalTooltip | Sets the tooltip options | No |
| type | GlobalType | Sets property type. Possible values: date, text, number | Yes |
CurrentSpaceStatusColors
Status color config to be used in the ExtendedList card section
| Name | Type | Description | Required |
|---|
| Black | [ string ] | | No |
| Blue | [ string ] | | No |
| Green | [ string ] | | No |
| LightGreen | [ string ] | | No |
| Orange | [ string ] | | No |
| Red | [ string ] | | No |
CurrentSpaceSteps
List of steps to show in timeline
Type: CurrentSpaceStepsProperties[]
| Name | Type | Description | Required |
|---|
| CurrentSpaceSteps | array | List of steps to show in timeline Type: CurrentSpaceStepsProperties[] | |
CurrentSpaceStepsProperties
| Name | Type | Description | Required |
|---|
| label | string | | Yes |
| value | | | Yes |
GlobalCheckStatus
Sets check status
| Name | Type | Description | Required |
|---|
| dataIndex | GlobalDataIndex | Sets the path of the Txn property to be displayed. | Yes |
GlobalColumnWrap
Sets the column content to not wrap.
Possible values: true/false
| Name | Type | Description | Required |
|---|
| GlobalColumnWrap | boolean | Sets the column content to not wrap. Possible values: true/false | |
GlobalCustomCardType
Sets type for the Custom Card
Possible values: list, listStacked, listExtended, table, tableExtended
| Name | Type | Description | Required |
|---|
| GlobalCustomCardType | string | Sets type for the Custom Card Possible values: list, listStacked, listExtended, table, tableExtended | |
GlobalDataIndex
Sets the path of the Txn property to be displayed.
| Name | Type | Description | Required |
|---|
| GlobalDataIndex | | Sets the path of the Txn property to be displayed. | |
GlobalDataSource
Used to define a deep data source (It needs to be a JSON value).
| Name | Type | Description | Required |
|---|
| GlobalDataSource | | Used to define a deep data source (It needs to be a JSON value). | |
GlobalDisabled
The global disabled state
| Name | Type | Description | Required |
|---|
| GlobalDisabled | boolean | The global disabled state | |
Sets display format
| Name | Type | Description | Required |
|---|
| GlobalDisplayFormat | string | Sets display format | |
GlobalEncoding
Sets the encoding. We currently support the following encoding: base64
| Name | Type | Description | Required |
|---|
| GlobalEncoding | string | Sets the encoding. We currently support the following encoding: base64 | |
GlobalFilter
Sets the filter strategy for this mapping.
Possible values: input, select, multiselect, picker
| Name | Type | Description | Required |
|---|
| GlobalFilter | | Sets the filter strategy for this mapping. Possible values: input, select, multiselect, picker | |
| Name | Type | Description | Required |
|---|
| type | string | Sets the global filter type to input. Possible values: input | Yes |
GlobalFilterOptionsPicker
| Name | Type | Description | Required |
|---|
| options | object | Set the default date range for the date picker. Possible values: minDate, maxDate | No |
| type | string | Set the global filter type to be a date picker. Possible values: datepicker,daterangepicker | Yes |
GlobalFilterOptionsSelect
| Name | Type | Description | Required |
|---|
| options | [ string ] | Sets the options for the select dropdown | No |
| type | string | Sets the global filter type Possible values: select, multiselect | Yes |
Sets a format for the data.
Possible values: relative, duration
| Name | Type | Description | Required |
|---|
| GlobalFormat | string | Sets a format for the data. Possible values: relative, duration | |
GlobalFullWidth
Sets property display to full width.
Possible values: true/false
| Name | Type | Description | Required |
|---|
| GlobalFullWidth | boolean | Sets property display to full width. Possible values: true/false | |
GlobalHideEmpty
Hide empty fields config
| Name | Type | Description | Required |
|---|
| GlobalHideEmpty | boolean | Hide empty fields config | |
GlobalHideSteps
List of steps to hide in the Timeline section.
Default: []
| Name | Type | Description | Required |
|---|
| GlobalHideSteps | array | List of steps to hide in the Timeline section. Default: [] | |
GlobalIcon
Sets the icon to be used
| Name | Type | Description | Required |
|---|
| GlobalIcon | string | Sets the icon to be used | |
The global input
| Name | Type | Description | Required |
|---|
| checked | boolean | | No |
| label | string | | Yes |
| value | boolean,string | | No |
GlobalInvokeVersionNumber
| Name | Type | Description | Required |
|---|
| GlobalInvokeVersionNumber | | | |
GlobalInvokeVersionNumberDataIndex
GlobalLabel
Sets the label to be used
| Name | Type | Description | Required |
|---|
| GlobalLabel | string | Sets the label to be used | |
GlobalLink
| Name | Type | Description | Required |
|---|
| dataIndex | GlobalDataIndex | Sets the path of the Txn property to be displayed. | Yes |
| encoding | GlobalEncoding | Sets the encoding. We currently support the following encoding: base64 | No |
| icon | string | Icon to override if type is "invoke" | No |
| params | GlobalParams | Sets the params of the fluent function | No |
| rules | GlobalRules | visibility rules fields config | No |
| serviceName | GlobalServiceName | Sets the name of the fluent function | No |
| type | GlobalLinkType | Sets link type. Possible values: pdf, html, text, xml, invoke, json, url, file, auto | Yes |
| versionNumber | GlobalInvokeVersionNumber | Sets the version number of the fluent function | No |
GlobalLinkType
Sets link type.
Possible values: pdf, html, text, xml, invoke, json, url, file, auto
| Name | Type | Description | Required |
|---|
| GlobalLinkType | string | Sets link type. Possible values: pdf, html, text, xml, invoke, json, url, file, auto | |
GlobalMapping
| Name | Type | Description | Required |
|---|
| columnWrap | GlobalColumnWrap | Sets the column content to not wrap. Possible Values: true/false | No |
| dataIndex | GlobalDataIndex | Sets the path of the Txn property to be displayed | No |
| dataSource | GlobalDataSource | Used to define a deep data source (It needs to be a JSON value) | No |
| disabled | GlobalDisabled | Sets the path of the Txn property to be displayed | No |
| displayFormat | GlobalDisplayFormat | Sets the display Format | No |
| filter | GlobalFilter | Sets the filter strategy for this mapping. Possible values: input, select, multiselect, picker | No |
| format | GlobalFormat | Sets a format for the data. Possible values: relative, duration | No |
| hideEmpty | GlobalHideEmpty | Hide empty fields config | No |
| hideFromTable | boolean | Hide fields from table (but can still filter on them) | No |
| icon | GlobalIcon | Sets the icon | No |
| input | GlobalInput | Sets the input config. | No |
| label | GlobalLabel | Sets the label | Yes |
| link | GlobalLink | Sets attributes for the link | No |
| maxLength | GlobalMaxLength | Sets the max length of the property to be displayed | No |
| name | GlobalName | Sets a name for the data. Possible values: null | No |
| newRow | GlobalNewRow | Sets a new row | No |
| parse | GlobalParse | Sets a parse for the data. Possible values: null | No |
| permissions | GlobalPermissions | Sets the permissions for the view | No |
| properties | GlobalMappingProperties | List of Mapping Objects or Mapping keys Default: null | No |
| rules | GlobalRules | visibility rules fields config | No |
| sections | [ CurrentSpaceCustomCardTabsProperties ] | Status color config to be used in the ExtendedList card section Default: null | No |
| sorter | GlobalSorter | Sets the mapping to be sortable via the column header | No |
| span | GlobalSpan | Sets the grid config. | No |
| statusColors | CurrentSpaceStatusColors | Status color config to be used in the ExtendedList card section Default: null | No |
| tooltip | GlobalTooltip | Sets the tooltip options | No |
| type | | Sets type for the property Possible values: text, date, number, alert, time, list, listExtended, listStacked, table, tableExtended | Yes |
| validation | GlobalValidation | Sets the validation | No |
| warning | GlobalWarning | Sets warning timeframe for the SLA | No |
GlobalMappingProperties
| Name | Type | Description | Required |
|---|
| GlobalMappingProperties | array | | |
GlobalMappingProperty
| Name | Type | Description | Required |
|---|
| columnWrap | GlobalColumnWrap | Sets the column content to not wrap. Possible Values: true/false | No |
| dataIndex | GlobalDataIndex | Sets the path of the Txn property to be displayed | No |
| disabled | GlobalDisabled | Sets the property as disabled | No |
| displayFormat | GlobalDisplayFormat | Sets the display Format | No |
| filter | GlobalFilter | Sets the filter strategy for this mapping. Possible values: input, select, multiselect, picker | No |
| format | GlobalFormat | Sets a format for the data. Possible values: relative, duration | No |
| fullWidth | GlobalFullWidth | Sets property display to full width Possible values: true | No |
| hideEmpty | GlobalHideEmpty | Hide empty fields config | No |
| icon | GlobalIcon | Sets the icon | No |
| input | GlobalInput | Sets the input config. | No |
| label | GlobalLabel | Sets the label | Yes |
| link | GlobalLink | Sets attributes for the link | No |
| maxLength | GlobalMaxLength | Sets the max length of the property to be displayed | No |
| name | GlobalName | Sets name to the custom card. Default: null | No |
| newRow | GlobalNewRow | Sets a new row | No |
| parse | GlobalParse | Sets a parse for the data. Possible values: null | No |
| properties | GlobalMappingProperties | List of Mapping Objects or Mapping keys Default: null | No |
| rules | GlobalRules | visibility rules fields config | No |
| sorter | GlobalSorter | Sets the mapping to be sortable via the column header | No |
| span | GlobalSpan | Sets the grid config. | No |
| tooltip | GlobalTooltip | Sets the tooltip options | No |
| type | | Sets type for the property Possible values: text, date, number, alert, time, list, listExtended, listStacked, table, tableExtended | No |
| validation | GlobalValidation | Sets the validation | No |
| warning | GlobalWarning | Sets warning timeframe for the SLA | No |
GlobalMappings
Mappings config to be used globally.
Default: null
| Name | Type | Description | Required |
|---|
| GlobalMappings | object | Mappings config to be used globally. Default: null | |
GlobalMaxLength
The global maxLength state
| Name | Type | Description | Required |
|---|
| GlobalMaxLength | number | The global maxLength state | |
GlobalName
The global name state
| Name | Type | Description | Required |
|---|
| GlobalName | string | The global name state | |
GlobalNewRow
Sets new row
| Name | Type | Description | Required |
|---|
| GlobalNewRow | boolean | Sets new row | |
GlobalParams
The global params state
| Name | Type | Description | Required |
|---|
| GlobalParams | | The global params state | |
GlobalParse
Sets a parse for the data.
| Name | Type | Description | Required |
|---|
| GlobalParse | string | Sets a parse for the data. | |
GlobalPermissions
Sets permissions for spaces or actions.
| Name | Type | Description | Required |
|---|
| operator | GlobalPermissionsOperator | Sets permission operator. Possible values: and, or | No |
| type | GlobalPermissionsType | Sets permission type. Possible values: group, role | Yes |
| value | [ string ] | Sets values depending on the permission | Yes |
GlobalPermissionsOperator
| Name | Type | Description | Required |
|---|
| GlobalPermissionsOperator | string | | |
GlobalPermissionsType
| Name | Type | Description | Required |
|---|
| GlobalPermissionsType | string | | |
GlobalRules
The global rules config.
| Name | Type | Description | Required |
|---|
| GlobalRules | | The global rules config. | |
GlobalRulesItem
The global rules item
| Name | Type | Description | Required |
|---|
| dataIndex | | | Yes |
| value | | | Yes |
GlobalScope
Scope config to be used with txn and currentTxn query.
| Name | Type | Description | Required |
|---|
| GlobalScope | string | Scope config to be used with txn and currentTxn query. | |
GlobalServiceName
Sets the name of the fluent function
| Name | Type | Description | Required |
|---|
| GlobalServiceName | string | Sets the name of the fluent function | |
GlobalSorter
Sets the sorter to be used
| Name | Type | Description | Required |
|---|
| GlobalSorter | boolean | Sets the sorter to be used | |
GlobalSpan
Sets grid configuration
| Name | Type | Description | Required |
|---|
| GlobalSpan | | Sets grid configuration | |
GlobalTabType
| Name | Type | Description | Required |
|---|
| GlobalTabType | string | | |
Set global tooltip options
| Name | Type | Description | Required |
|---|
| dataIndex | string | | No |
GlobalType
Sets property type.
Possible values: date, text, number, alert
| Name | Type | Description | Required |
|---|
| GlobalType | string | Sets property type. Possible values: date, text, number, alert | |
GlobalValidation
The global validation
| Name | Type | Description | Required |
|---|
| GlobalValidation | | The global validation | |
GlobalVersionNumber
Sets the version number of the fluent function
| Name | Type | Description | Required |
|---|
| GlobalVersionNumber | string | Sets the version number of the fluent function | |
GlobalWarning
Sets warning timeframe for the SLA.
| Name | Type | Description | Required |
|---|
| GlobalWarning | string | Sets warning timeframe for the SLA. | |
Theme
ThemeColorProperty
Global theme property
| Name | Type | Description | Required |
|---|
| dark | string | Global theme color variation. Use a hex color code | No |
| darkest | string | Global theme color variation. Use a hex color code | No |
| light | string | Global theme color variation. Use a hex color code | No |
| lightest | string | Global theme color variation. Use a hex color code | No |
| primary | string | Global theme color variation. Use a hex color code | No |
ThemePrimaryColorProperty
| Name | Type | Description | Required |
|---|
| main | string | Global theme color variation. Use a hex color code | No |
ThemeSecondaryColorProperty
| Name | Type | Description | Required |
|---|
| light | string | Global theme color variation. Use a hex color code | No |
| main | string | Global theme color variation. Use a hex color code | No |