Models
ConfigCurrentSpace
Config to be used within a Space.
Name | Type | Description | Required |
---|
attachments | CurrentSpaceAttachments | Sets the filters for the Attachments. Default: null | No |
currentView | CurrentSpaceCurrentView | View to display in the Txn Table section. Default: [0] | No |
customCards | CurrentSpaceCustomCards | List of custom cards to be rendered in the Custom Cards section. Default: [] | No |
emptyMessage | string | Message to be displayed when Txn Query returns empty. Default: null | No |
globalActions | CurrentSpaceGlobalActions | Config for the global actions. Default: null | No |
globalFilters | CurrentSpaceGlobalFilters | Config for the global filters. Default: null | 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 |
jobActions | CurrentSpaceJobActions | List of available job actions. Possible values: Receipt, ViewNotes | 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 |
loadQuery | boolean | Flag to define if Txn Query should be triggered on load. Default: null | No |
pageSize | CurrentSpacePageSize | Page size to be used in the Txn Query. Default: 10 | No |
permissions | GlobalPermissions | Sets the permissions for the Space | No |
search | CurrentSpaceSearch | List of searchable mapping properties. Default: [] | No |
txnActions | CurrentSpaceTxnActions | List of available txn actions. Possible values: Claim, Release, Assign, Unassign, Decision, ViewForm, Recover, Withdraw | No |
views | CurrentSpaceViews | List of views to be rendered in the Txn Table section. Default: [] | Yes |
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 |
locale | GlobalLocale | Locale config to be used globally. Default: null | 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 |
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
CurrentSpaceAttachments
CurrentSpaceAttachmentsDuplicates
Name | Type | Description | Required |
---|
CurrentSpaceAttachmentsDuplicates | boolean | | |
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 |
CurrentSpaceAttachmentsUploadWithoutClaim
Sets the permissions for the Action.
Name | Type | Description | Required |
---|
CurrentSpaceAttachmentsUploadWithoutClaim | boolean | Sets the permissions for the Action. | |
Show/Hide a global create form action
CurrentSpaceCurrentView
View to display in the Txn Table section.
Default: [0]
Name | Type | Description | Required |
---|
CurrentSpaceCurrentView | string | View to display in the Txn Table section. Default: [0] | |
CurrentSpaceCustomCardContainerProperty
CurrentSpaceCustomCardList
Name | Type | Description | Required |
---|
dataSource | GlobalDataSource | Used to define a deep data source (It needs to be a JSON value). | No |
hideEmpty | GlobalHideEmpty | Hide empty fields config | No |
label | GlobalLabel | Sets label for the Custom Card | No |
permissions | GlobalPermissions | Sets the permissions for the custom card | No |
properties | | Mappings for the Custom Card | Yes |
rules | GlobalRules | visibility rules fields config | No |
type | string | Sets the custom card type. Possible value: list | Yes |
CurrentSpaceCustomCardListExtended
Name | Type | Description | Required |
---|
dataSource | GlobalDataSource | Used to define a deep data source (It needs to be a JSON value). | No |
hideEmpty | GlobalHideEmpty | Hide empty fields config | No |
label | GlobalLabel | Sets label for the Custom Card | No |
permissions | GlobalPermissions | Sets the permissions for the custom card | No |
properties | | Mappings for the Custom Card | Yes |
rules | GlobalRules | visibility rules fields config | No |
statusColors | CurrentSpaceStatusColors | Status color config to be used in the ExtendedList card section. Default: null | Yes |
type | string | Sets the custom card type, Possible value: listExtended | Yes |
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 | Yes |
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 | Yes |
CurrentSpaceCustomCardTable
CurrentSpaceCustomCardTableExtended
Name | Type | Description | Required |
---|
dataSource | GlobalDataSource | Used to define a deep data source (It needs to be a JSON value). | Yes |
hideEmpty | GlobalHideEmpty | Hide empty fields config | No |
label | GlobalLabel | Sets label for the Custom Card | Yes |
permissions | GlobalPermissions | Sets the permissions for the custom card | No |
rules | GlobalRules | visibility rules fields config | No |
sections | CurrentSpaceSections | Sub-sections for the Custom Card | Yes |
type | string | Sets the custom card type. Possible value: tableExtended | Yes |
CurrentSpaceCustomCards
List of Custom Cards
Name | Type | Description | Required |
---|
CurrentSpaceCustomCards | array | List of Custom Cards | |
CurrentSpaceDateCreated
Show/Hide a global filter for Date Created
Name | Type | Description | Required |
---|
label | GlobalLabel | Sets a label for the filter. Default: null | Yes |
value | [ string ] | Sets a date range for the filter. Default: null | Yes |
CurrentSpaceFilterBy
Sets the filters to apply to the view.
Default: null
Name | Type | Description | Required |
---|
CurrentSpaceFilterBy | object | Sets the filters to apply to the view. Default: null | |
Used to show/hide the Create Forms button that allows Workspaces users to create new forms using Maestro forms
Name | Type | Description | Required |
---|
label | GlobalLabel | Sets the label for the filter | Yes |
options | CurrentSpaceFormOptions | List of the product types to select from | No |
value | string | Sets the defaut option for the filter | Yes |
List of products
Name | Type | Description | Required |
---|
CurrentSpaceFormOptions | array | List of products | |
CurrentSpaceGlobalActions
Global actions config
Default: null
CurrentSpaceGlobalFilters
Global filters config
Default: null
CurrentSpaceGroupName
Show/Hide a global filter for Group Names
CurrentSpaceGroupNameValue
Sets the default option for the filter
Default: null
Name | Type | Description | Required |
---|
CurrentSpaceGroupNameValue | string | Sets the default option for the filter Default: null | |
CurrentSpaceGroupOptions
List of groups
Name | Type | Description | Required |
---|
CurrentSpaceGroupOptions | array | List of groups | |
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 | |
CurrentSpaceJobActions
Name | Type | Description | Required |
---|
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 |
ViewNotes | CurrentSpaceAction | Shows the all notes for the job in a modal. | No |
ViewXML | CurrentSpaceAction | When clicked it display the txn's XML. | No |
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 | |
CurrentSpacePageSize
The current rows per page
Name | Type | Description | Required |
---|
CurrentSpacePageSize | number | The current rows per page | |
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 |
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 |
type | GlobalType | Sets property type. Possible values: date, text, number | Yes |
CurrentSpaceSearch
List of search mappings
Name | Type | Description | Required |
---|
CurrentSpaceSearch | array | List of search mappings | |
CurrentSpaceSections
Name | Type | Description | Required |
---|
CurrentSpaceSections | array | | |
CurrentSpaceSortBy
The mapping key to sort by
Default: null
Name | Type | Description | Required |
---|
CurrentSpaceSortBy | string | The mapping key to sort by Default: null | |
CurrentSpaceSortOrder
Direction of the sort.
Possible values: asc, desc
.
Default: asc
Name | Type | Description | Required |
---|
CurrentSpaceSortOrder | string | Direction of the sort. Possible values: asc, desc . Default: asc | |
CurrentSpaceSpaceName
Show/Hide a global filter for Space Names
CurrentSpaceSpaceNameValue
Sets the default option for the filter
Default: null
Name | Type | Description | Required |
---|
CurrentSpaceSpaceNameValue | string | Sets the default option for the filter Default: null | |
CurrentSpaceSpaceOptions
List of spaces
Name | Type | Description | Required |
---|
CurrentSpaceSpaceOptions | array | List of spaces | |
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 |
CurrentSpaceTxnActions
List of available actions.
Name | Type | Description | Required |
---|
Abandon | CurrentSpaceAction | When clicked it triggers the abandone process. | 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 |
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 |
Withdraw | CurrentSpaceAction | When clicked saved txn will be abandoned. | No |
CurrentSpaceView
Defines a group of table configurations that will be displayed on the List Screen. Views are pre-configured groups of properties, they specifies which criterias are included on the Txn query (sort and filters).
CurrentSpaceViewProperties
List of Mapping Objects or Mapping keys.
Default: null
Name | Type | Description | Required |
---|
CurrentSpaceViewProperties | array | List of Mapping Objects or Mapping keys. Default: null | |
CurrentSpaceViews
List of views
Name | Type | Description | Required |
---|
CurrentSpaceViews | array | List of views | |
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 | string | 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 |
---|
GlobalInput | | The global input | |
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 |
type | GlobalLinkType | Sets link type. Possible values: pdf, html, text, xml, json, url, file | Yes |
GlobalLinkType
Sets link type.
Possible values: pdf, html, text, xml, json, url, file, auto
Name | Type | Description | Required |
---|
GlobalLinkType | string | Sets link type. Possible values: pdf, html, text, xml, json, url, file, auto | |
GlobalLocale
Sets the locale to be used
Name | Type | Description | Required |
---|
GlobalLocale | string | Sets the locale to be used | |
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 |
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 | CurrentSpaceSections | 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 |
type | | Sets type for the property Possible values: text, date, number, alert, time, list, listExtended, 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 |
hideEmpty | GlobalHideEmpty | Hide empty fields config | 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 |
type | | Sets type for the property Possible values: text, date, number, alert, time, list, listExtended, 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 | |
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 |
---|
type | GlobalPermissionsType | Sets permission type. Possible values: group, role | Yes |
value | [ string ] | Sets values depending on the permission | Yes |
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 |
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 | |
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 | |
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 |