Reference

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, Share	No
attachments	CurrentSpaceAttachments	Sets the filters for the Attachments. Default: null	No
bulkActions	CurrentSpaceBulkActions	Configuration for bulk actions. Default: null	No
currentBulkAction	CurrentSpaceCurrentBulkAction	Bulk Action to apply in the Txn Table section. Default: [0]	No
currentBulkUser	CurrentSpaceCurrentBulkUser	Bulk User to apply in the Txn Table section. 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	No
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
key	number	Internal unique space id Default: null	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	No
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
properties	[ ConfigCurrentSpace ]	Set the Subspaces for the current space Default: null	No
rules	GlobalRules	Rules that show/hide the attachments upload button	No
search	CurrentSpaceSearch	List of searchable mapping properties. Default: []	No
source	string	Sets the source for the current space Possible values: Job Default: null	No
steps	CurrentSpaceSteps	Configuration for timeline. Default: []	No
views	CurrentSpaceViews	List of views to be rendered in the Txn Table section. Default: []	No

ConfigEditor

Space Config.

Default: null

Name	Type	Description	Required
global	ConfigGlobal		Yes
messages	ConfigMessages		No
settings	ConfigSettings		No
spaces	[ ConfigCurrentSpace ]		Yes
version			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
jobLabel	GlobalLabel	Sets the label to be used for the job header	No
logo	string	Logo config to be used globally. Default: static/logo.png	No
mappings	GlobalMappings	Mappings config to be used globally. Default: null	No
modalPopoutDisabled	boolean	Hide modal popout button. Set to 'true' to hide. Default: false	No
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
txnLabel	GlobalLabel	Sets the label to be used for the txn header	No

ConfigMessages

The Messages COnfig

Name	Type	Description	Required
ConfigMessages	object	The Messages COnfig

ConfigSettings

The Settings config

Name	Type	Description	Required
ConfigSettings		The Settings config

CurrentSpaceAction

Actions config to display in the Txn Table and Actions section.

Default: null

Name	Type	Description	Required
dataIndex	GlobalDataIndex	Sets dataIndex of Action	No
label	GlobalLabel	Sets type of Action	Yes
permissions	GlobalPermissions	Sets the persmissions for the Action	No

CurrentSpaceActionCustom

Custom Actions config to display in the Txn Table and Actions section.

Default: null

Name	Type	Description	Required
dataIndex	GlobalDataIndex	Sets dataIndex of Action	No
label	GlobalLabel	Sets type of Action	Yes
permissions	GlobalPermissions	Sets the persmissions for the Action	No
properties	CurrentSpaceActionCustomProperties	Sets the persmissions for the Action	Yes

CurrentSpaceActionCustomProperties

List of custom actions

Name	Type	Description	Required
CurrentSpaceActionCustomProperties	array	List of custom actions

CurrentSpaceActionCustomProperty

Custom Action Property

Name	Type	Description	Required
actions	CurrentSpaceActionCustom	Custom card actions	No
dataIndex	GlobalDataIndex	Sets dataIndex of Action	No
encoding	GlobalEncoding	Sets the encoding. We currently support the following encoding: base64	No
label	GlobalLabel	Sets type of Action	Yes
params	GlobalParams	Sets the params of the fluent function	No
permissions	GlobalPermissions	Sets the permissions for the view	No
rules	GlobalRules	Sets the visibility rules for the custom action	No
serviceName	GlobalServiceName	Sets the name of the fluent function	No
type	GlobalLinkType	Sets attributes for the link	Yes
versionNumber	GlobalInvokeVersionNumber	Sets the version number of the fluent function	No

CurrentSpaceActionOptions

Object of form attributes

Name	Type	Description	Required
label	string		Yes
value	string		Yes

CurrentSpaceActionSingleInvoke

Name	Type	Description	Required
dataIndex	GlobalDataIndex	Sets dataIndex of Action	No
label	GlobalLabel	Sets type of Action	Yes
onError	CurrentSpaceInvoke		No
onSuccess	CurrentSpaceInvoke		No
permissions	GlobalPermissions	Sets the persmissions for the Action	No

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	CurrentSpaceActionSingleInvoke	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	CurrentSpaceActionSingleInvoke	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	CurrentSpaceActionSingleInvoke	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	CurrentSpaceActionSingleInvoke	When clicked the abandoned txn will be re-opened.	No
Release	CurrentSpaceActionSingleInvoke	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
Share	CurrentSpaceAction	When clicked it shows the share popup.	No
TransactionPurge	CurrentSpaceAction	When clicked it triggers the txn purge process.	No
Unassign	CurrentSpaceActionSingleInvoke	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	CurrentSpaceActionSingleInvoke	When clicked saved txn will be abandoned.	No

CurrentSpaceAttachments

Name	Type	Description	Required
duplicates	CurrentSpaceAttachmentsDuplicates	Set duplicates to show or hide.	No
filter	CurrentSpaceAttachmentsFilter	Set filter for the attachments	No
hideUploadButton	CurrentSpaceAttachmentsHideUploadButton	Hides the Document Upload Button	No
rules	GlobalRules	Rules that show/hide the attachments upload button	No
uploadWithoutClaim	CurrentSpaceAttachmentsUploadWithoutClaim	Sets the persmissions for the Action.	No

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

CurrentSpaceAttachmentsHideUploadButton

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.

CurrentSpaceBulkActions

The current space bulk actions

Default: null

Name	Type	Description	Required
enabled	GlobalEnabled	Sets enabled/disabled state	No
label	GlobalLabel	Sets type of Action	Yes
permissions	GlobalPermissions	Sets the persmissions for the Action	No

CurrentSpaceCreateForm

Show/Hide a global create form action

Name	Type	Description	Required
label	GlobalLabel	Sets the label	Yes
options	[ CurrentSpaceActionOptions ]	List of the forms to select from	Yes

CurrentSpaceCurrentBulkAction

Bulk Action to apply in the Txn Table section.

Default: null

Name	Type	Description	Required
CurrentSpaceCurrentBulkAction	string	Bulk Action to apply in the Txn Table section. Default: null

CurrentSpaceCurrentBulkUser

Bulk User to apply in the Txn Table section.

Default: null

Name	Type	Description	Required
CurrentSpaceCurrentBulkUser	string	Bulk User to apply in the Txn Table section. Default: null

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

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	No
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
statusColors	CurrentSpaceStatusColors	Status color config to be used in the Column card section Default: null	No
type		Sets property type. Possible values: date, text, number	No

CurrentSpaceCustomCardForm

Name	Type	Description	Required
actions	CurrentSpaceActionCustom	Custom card actions	No
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	Yes
name	string	Name of the API to send data to on form submission	Yes
permissions	GlobalPermissions	Sets the permissions for the custom card	No
properties	[ CurrentSpaceCustomCardContainerProperty ]	Mappings for the Custom Card	Yes
readOnly	GlobalReadOnly	Make it read only	No
rules	GlobalRules	visibility rules fields config	No
type	string	Sets the custom card type. Possible value: form	Yes

CurrentSpaceCustomCardIframe

Name	Type	Description	Required
actions	CurrentSpaceActionCustom	Custom card actions	No
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	[ CurrentSpaceCustomCardContainerProperty ]	Mappings for the Custom Card	Yes
rules	GlobalRules	visibility rules fields config	No
type	string	Sets the custom card type. Possible value: iframe	Yes

CurrentSpaceCustomCardList

Name	Type	Description	Required
actions	CurrentSpaceActionCustom	Custom card actions	No
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	[ CurrentSpaceCustomCardContainerProperty ]	Mappings for the Custom Card	Yes
rules	GlobalRules	visibility rules fields config	No
type		Sets the custom card type. Possible value: list	Yes

CurrentSpaceCustomCardListExtended

Name	Type	Description	Required
actions	CurrentSpaceActionCustom	Custom card actions	No
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	[ CurrentSpaceCustomCardContainerProperty ]	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	No
type	string	Sets the custom card type, Possible value: listExtended	Yes

CurrentSpaceCustomCardListStacked

Name	Type	Description	Required
actions	CurrentSpaceActionCustom	Custom card actions	No
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	[ CurrentSpaceCustomCardContainerProperty ]	Mappings for the Custom Card	Yes
rules	GlobalRules	visibility rules fields config	No
type	string	Sets the custom card type. Possible value: listStacked	Yes

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	No
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
statusColors	CurrentSpaceStatusColors	Status color config to be used in the Column card section Default: null	No
type		Sets property type. Possible values: date, text, number	No

CurrentSpaceCustomCardTable

Name	Type	Description	Required
actions	CurrentSpaceActionCustom	Custom card actions	No
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
properties	[ CurrentSpaceCustomCardContainerProperty ]	Mappings for the Custom Card	Yes
readOnly	GlobalReadOnly	Make it read only	No
rules	GlobalRules	visibility rules fields config	No
type	string	Sets the custom card type. Possible value: table	Yes

CurrentSpaceCustomCardTableExtended

Name	Type	Description	Required
actions	CurrentSpaceActionCustom	Custom card actions	No
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	Yes
permissions	GlobalPermissions	Sets the permissions for the custom card	No
properties	[ CurrentSpaceCustomCardContainerProperty ]	Mappings for the Custom Card	Yes
rules	GlobalRules	visibility rules fields config	No
sections	[ CurrentSpaceCustomCardTabsProperties ]	Sub-sections for the Custom Card	No
type	string	Sets the custom card type. Possible value: tableExtended	Yes

CurrentSpaceCustomCardTabs

Sets the customCard tabs properties

Name	Type	Description	Required
checkStatus	GlobalCheckStatus		No
hideEmpty	GlobalHideEmpty		No
key	string		No
label	CurrentSpaceCustomCardTabsLabel		Yes
properties			Yes
rules	GlobalRules		No
tabType	GlobalTabType		No

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

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

CurrentSpaceFormName

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		Sets the defaut option for the filter	Yes

CurrentSpaceFormOptions

Object of form attributes

Name	Type	Description	Required
label	string		Yes
value	[ string ]		Yes

CurrentSpaceGlobalActions

Global actions config

Default: null

Name	Type	Description	Required
CreateForm	CurrentSpaceCreateForm	Show/hide Create Form button.	Yes

CurrentSpaceGlobalFilters

Global filters config

Default: null

Name	Type	Description	Required
DateCreated	CurrentSpaceDateCreated	Show/Hide a global filter for Date Created	No
FormName	CurrentSpaceFormName	Used to show/hide the Create Forms button that allows Workspaces users to create new forms using Maestro forms	No
GroupName	CurrentSpaceGroupName	Show/Hide a global filter for Group Names	No
SpaceName	CurrentSpaceSpaceName	Show/Hide a global filter for Spaces	No

CurrentSpaceGroupName

Show/Hide a global filter for Spaces

Name	Type	Description	Required
label	GlobalLabel	Sets a label for the filter Default: null	Yes
options	[ CurrentSpaceGroupOptions ]	List of groups to select from Default: []	Yes
value		Sets the default option for the filter Default: null	Yes

CurrentSpaceGroupOptions

Object of form attributes

Name	Type	Description	Required
label	string		Yes
value	[ string ]		Yes

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

Name	Type	Description	Required
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	Yes
versionNumber	GlobalInvokeVersionNumber	Sets the version number of the fluent function	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
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
permissions	GlobalPermissions	Sets the permissions for the CurrentSpace element	No
rules	GlobalRules	Sets the visibility rules for the CurrentSpace element	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

CurrentSpaceReadOnly

Defines the readOnly mode for the table component.

Default: false

Name	Type	Description	Required
CurrentSpaceReadOnly	boolean	Defines the readOnly mode for the table component. Default: false

CurrentSpaceSearch

Sets the search bar properties

Name	Type	Description	Required
CurrentSpaceSearch		Sets the search bar properties

CurrentSpaceSearchLabel

Sets the label to be used for the space

Name	Type	Description	Required
CurrentSpaceSearchLabel	string	Sets the label to be used for the space

CurrentSpaceSearchObj

Sets the search bar properties

Name	Type	Description	Required
label	CurrentSpaceSearchLabel		Yes
properties	CurrentSpaceSearchProperties		Yes

CurrentSpaceSearchProperties

Sets the icon to be used for the space

Name	Type	Description	Required
CurrentSpaceSearchProperties	array	Sets the icon to be used for the space

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

Name	Type	Description	Required
label	GlobalLabel	Sets a label for the filter Default: null	Yes
options	CurrentSpaceSpaceOptions	List of spaces to select from Default: []	No
value	CurrentSpaceSpaceNameValue	Sets the default option for the filter Default: null	Yes

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

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

CurrentSpaceView

Name	Type	Description	Required
expandedInfo	CurrentSpaceViewExpandedInfo	Sets the expanded info / custom card types to show in the listing table	No
filterBy	CurrentSpaceFilterBy	Sets the filters to apply to the view Default: null	No
label	GlobalLabel	Text used as value and name of the view. Default: null	Yes
permissions	GlobalPermissions	Sets the permissions for the view	No
properties	CurrentSpaceViewProperties	List of Mapping Objects or Mapping keys. Default: null	Yes
readOnly	CurrentSpaceReadOnly	Sets the the table's item to readOnly mode	No
sortBy	CurrentSpaceSortBy	The mapping key to sort by Default: null	No
sortOrder	CurrentSpaceSortOrder	Direction of the sort. Possible values: asc, desc. Default: asc	No

CurrentSpaceViewExpandedInfo

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).

Name	Type	Description	Required
CurrentSpaceViewExpandedInfo		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

CustomCss

Basic CSS typing. Preferable to any.

Name	Type	Description	Required
CustomCss	object	Basic CSS typing. Preferable to any.

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

GlobalDisplayFormat

Sets display format

Name	Type	Description	Required
GlobalDisplayFormat	string	Sets display format

GlobalEnabled

Sets enabled/disabled state

Name	Type	Description	Required
GlobalEnabled	boolean	Sets enabled/disabled state

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

GlobalFilterOptionsInput

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

GlobalFormat

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

GlobalIframeType

Name	Type	Description	Required
GlobalIframeType	string

GlobalInput

The global input

Name	Type	Description	Required
label	string		No
properties	[ GlobalInputProperties ]		No
type			Yes
value	string		No

GlobalInputProperties

Name	Type	Description	Required
checked	boolean		No
label	string		Yes
value	boolean,string		No

GlobalInvokeVersionNumber

Name	Type	Description	Required
GlobalInvokeVersionNumber

GlobalInvokeVersionNumberDataIndex

Name	Type	Description	Required
dataIndex	GlobalDataIndex		Yes

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, json, invoke, url, download, img, auto

Name	Type	Description	Required
GlobalLinkType	string	Sets link type. Possible values: pdf, html, text, xml, json, invoke, url, download, img, auto

GlobalMapping

Name	Type	Description	Required
actions	CurrentSpaceActionCustom	Custom card actions	No
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	No
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
readOnly	GlobalReadOnly	Make it read only	No
rules	GlobalRules	visibility rules fields config	No
sections	[ CurrentSpaceCustomCardTabsProperties ]	Status color config to be used in the ExtendedList card section Default: null	No
sla	GlobalSla	ALternative config for the SLA	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	No
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
readOnly	GlobalReadOnly	Make it read only	No
rules	GlobalRules	visibility rules fields config	No
sla	GlobalSla	ALternative config for the SLA	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, iframe	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

GlobalReadOnly

Make it read only

Name	Type	Description	Required
GlobalReadOnly	boolean	Make it read only

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

GlobalSla

Sets default sla config

Name	Type	Description	Required
GlobalSla	object	Sets default sla config

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

GlobalTooltip

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.

Setting

Name	Type	Description	Required
_persist		Sets the persisted State to be used	No
clientCode	SettingClientCode	Client code to be used globally. Default: null	Yes
configPath	SettingConfigPath	Sets the Idle Time to be used	No
configService	SettingConfigService	Config Service setting to be used globally. Default: null	No
formCode	SettingFormCode	Sets the Idle Time to be used	No
formVersion		Sets the form version to be used	No
idleTime	SettingIdleTime	Sets the Idle Time to be used	No
idleTimeWarning	SettingIdleTime	Sets the Idle Warning Time to be used	No
locale	SettingLocale	Locale setting to be used globally. Default: null	No
name	SettingName	Theme setting to be used globally. Default: null	No
redirectLogoutUrl	string	Redirect URL after user logs out Default: undefined	No
theme	SettingTheme	Theme setting to be used globally. Default: null	No
timeCreated		Sets the time created to be used	No
transactInsights	SettingTransactInsights	Transact Insights setting to be used globally. Default: false	No
unblu		Sets the unblu config to be used	No

SettingClientCode

Client code to be used globally.

Default: null

Name	Type	Description	Required
SettingClientCode	string	Client code to be used globally. Default: null

SettingConfigPath

Config path to be used globally.

Default: null

Name	Type	Description	Required
SettingConfigPath	string	Config path to be used globally. Default: null

SettingConfigService

Config Service setting to be used globally.

Default: null

Name	Type	Description	Required
themeName	string	Theme Name setting to be used in config service. Default: null	No
versionNumber	string	Versionto be used in config service. Default: null	No

SettingFormCode

Form code to be used globally.

Default: null

Name	Type	Description	Required
SettingFormCode	string	Form code to be used globally. Default: null

SettingIdleTime

Sets the Idle Time to be used

Name	Type	Description	Required
SettingIdleTime	number	Sets the Idle Time to be used

SettingLocale

Sets the locale to be used

Name	Type	Description	Required
SettingLocale	string	Sets the locale to be used

SettingName

Sets the App Name to be used

Name	Type	Description	Required
SettingName	string	Sets the App Name to be used

SettingTheme

Sets the theme to be used

Name	Type	Description	Required
SettingTheme		Sets the theme to be used

SettingTransactInsights

Transact Insights setting to be used globally.

Default: false

Name	Type	Description	Required
SettingTransactInsights	boolean	Transact Insights setting to be used globally. Default: false

SnackBar

Styles for the snack bars (currently provided by Notistack)

Name	Type	Description	Required
default	CustomCss	Styles for default snack pop-up, i.e no snack type specified. Default is black background.	No
error	CustomCss	Styles for error snack pop-up. Default is red background.	No
info	CustomCss	Styles for info snack pop-up. Default is light blue background.	No
success	CustomCss	Styles for success snack pop-up. Default is green background.	No
warning	CustomCss	Styles for warning snack pop-up. Default is orange background.	No

Theme

Name	Type	Description	Required
black	string	Global theme color	No
blue	ThemeSecondaryColorProperty	Global theme color. Possible values: main, light	No
brand	string	Global theme brand.	No
green	ThemeSecondaryColorProperty	Global theme color. Possible values: main, light	No
grey	ThemeColorProperty	Global theme color. Possible values: light, lightest, primary, dark, darkest	No
logo	string	Global theme logo.	No
orange	string	Global theme color	No
primary	ThemePrimaryColorProperty	Global theme primary color. Possible values: main	No
red	ThemeSecondaryColorProperty	Global theme color. Possible values: main, light	No
snack	SnackBar	Styles for snacks. Possible values are the snack types info, success, warning, error default, each of which is an object of styles. If no entry defined for a type, then you will see the defaults for that type.	No
text	ThemeSecondaryColorProperty	Global theme color. Possible values: main, light	No
white	string	Global theme color	No

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