Reference

Models

Breakpoints

Defines breakpoint values for responsive design. Values represent the minimum width at which each breakpoint starts.

Name	Type	Description	Required
values	object		Yes

ColorPalette

Defines color properties for different component states and variations. Supports both direct color values and CSS custom properties.

Name	Type	Description	Required
divider	string	Color for divider elements	No
mainChannel	string	Main channel value for color mixing operations	No
outlinedActiveBg	string	Active state background color for outlined variant	No
outlinedBorder	string	Border color for outlined variant	No
outlinedColor	string	Text color for outlined variant	No
outlinedHoverBg	string	Hover background color for outlined variant	No
outlinedHoverBorder	string	Hover border color for outlined variant	No
softActiveBg	string	Active state background color for soft variant	No
softBg	string	Background color for soft variant	No
softColor	string	Text color for soft variant	No
softHoverBg	string	Hover background color for soft variant	No
solidActiveBg	string	Active state background color for solid variant	No
solidBg	string	Background color for solid variant	No
solidHoverBg	string	Hover background color for solid variant	No

ComponentOverrides

Defines the structure for component style overrides. Supports nested selectors and pseudo-classes.

Name	Type	Description	Required
root	object	Base styles for the component	No
solid	object	Styles for solid variant	No

ConfigCurrentSpace

Configuration for an individual space, defining its display and behavior.

Name	Type	Description	Required
actions	CurrentSpaceActions	List of all available actions for the current space. Possible actions include: Claim, Release, Assign, Unassign, Decision, ViewForm, Recover, Withdraw, Receipt.	No
attachments	CurrentSpaceAttachmentsConfig	Configuration for filtering attachments. Defaults to null.	No
customCards	CurrentSpaceCustomCards	List of custom cards to be displayed in the Custom Cards section. Defaults to an empty array [].	No
greetings	CurrentSpaceGreetings	A custom message to be displayed on top of the to do list. Defaults to null.	No
hideTasks	CurrentSpaceHideTasks	Configuration for hiding specific steps and tasks from the timeline.	No
icon	CurrentSpaceIcon	Icon to represent the current space. Defaults to static//icon.png.	Yes
invoke	CurrentSpaceInvoke	Configuration for invoking a fluent function within the space. Defaults to null.	No
key	number	Internal unique identifier for the space. Defaults to null.	No
keyInfo	CurrentSpaceKeyInfo	List of key properties to be displayed in the Key Info section. Defaults to an empty array [].	No
label	GlobalLabel	Label to be used for the current space.	Yes
notesSection	boolean	Configuration for removing the notes section	No
permissions	GlobalPermissions	Permissions configuration that defines access levels for the current space.	No
properties	[ ConfigCurrentSpace ]	List of subspaces or nested spaces within the current space configuration. Defaults to null.	No
rules	GlobalRules	Rules to control the visibility of the attachments upload button.	No
steps	CurrentSpaceSteps	Configuration for the timeline or steps to be displayed. Defaults to an empty array [].	No

ConfigEditor

Full editor configuration, combining global and space-specific settings.

Name	Type	Description	Required
global	ConfigGlobal	Global configuration settings.	Yes
messages	ConfigMessages	Optional configuration for messages.	No
settings	ConfigSettings	Optional settings configuration.	No
spaces	[ ConfigCurrentSpace ]	Array of space-specific configurations.	Yes
version		Version information for the configuration. Can be of any type.	No

ConfigGlobal

Global configuration settings that apply across the entire application.

Name	Type	Description	Required
favicon	string	Path to the favicon used across the application. Defaults to static//favicon.png.	No
hideSteps	GlobalHideSteps	List of steps to hide globally from the timeline. Defaults to an empty array [].	No
logo	string	Path to the logo used across the application. Defaults to static/logo.png.	No
mappings	GlobalMappings	Global mappings configuration. Defaults to null.	Yes
theme	ConfigTheme	Global theme configuration for the application's appearance. Defaults to null.	No

ConfigMessages

Configuration object for managing various message types. Each entry is a key-value pair where the key represents the message type and the value is a MessagesItem object.

Name	Type	Description	Required
ConfigMessages	object	Configuration object for managing various message types. Each entry is a key-value pair where the key represents the message type and the value is a MessagesItem object.

ConfigSettings

Configuration object for application settings.

Name	Type	Description	Required
ConfigSettings		Configuration object for application settings.

ConfigTheme

Name	Type	Description	Required
ConfigTheme

CurrentSpaceAction

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

Default: null

Name	Type	Description	Required
appearance	string	Displays actions as buttons side by side instead of nested in a dropdown menu Possible values: 'button'	No
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
appearance	string	Displays actions as buttons side by side instead of nested in a dropdown menu Possible values: 'button'	No
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 permissions 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
icon	GlobalIcon	Sets the Icon	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

CurrentSpaceActionDecision

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

Default: null

Name	Type	Description	Required
appearance	string	Displays actions as buttons side by side instead of nested in a dropdown menu Possible values: 'button'	No
dataIndex	GlobalDataIndex	Sets dataIndex of Action	No
label	GlobalLabel	Sets type of Action	Yes
permissions	GlobalPermissions	Sets the persmissions for the Action	No
quickActions	CurrentSpaceQuickActions	Configuration for the quick actions within the Decision. An array because different steps on a form can have different options and rules Defaults: 'null`	No

CurrentSpaceActionSingleInvoke

Name	Type	Description	Required
appearance	string	Displays actions as buttons side by side instead of nested in a dropdown menu Possible values: 'button'	No
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 side sheet.	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	CurrentSpaceActionDecision	When clicked it opens up a side sheet 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 side sheet with the current Txn formReceipt. If there is more than one receipt attached to the Txn, the side sheet 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 side sheet 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

CurrentSpaceAttachmentsConfig

Name	Type	Description	Required
CurrentSpaceAttachmentsConfig

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.

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
encoding	GlobalEncoding	Sets the encoding. We currently support the following encoding: base64	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
highlight	GlobalHighlight	Sets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';	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
nodeColor	string	Sets the node color	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	boolean	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	boolean	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	boolean	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	boolean	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
sections	[ CurrentSpaceCustomCardTabsProperties ]	Sub-sections for the Custom Card	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	boolean	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
encoding	GlobalEncoding	Sets the encoding. We currently support the following encoding: base64	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
highlight	GlobalHighlight	Sets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';	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
nodeColor	string	Sets the node color	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).	No
hideEmpty	boolean	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	boolean	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	boolean	Hide empty fields config	No
key	string	Key identifier.	No
label	CurrentSpaceCustomCardTabsLabel	Sets the label to be used for the custom card tab	Yes
properties			Yes
rules	GlobalRules	visibility rules fields config	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

CurrentSpaceCustomCardTree

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	boolean	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	[ ExtendedTreeSvgProps ]	Mappings for the Custom Card	No
rules	GlobalRules	visibility rules fields config	No
type	string	Sets the custom card type. Possible value: list	Yes

CurrentSpaceCustomCards

Array of Custom Cards

Name	Type	Description	Required
CurrentSpaceCustomCards	array	Array of Custom Cards

CurrentSpaceGreetings

Sets the search bar properties

Name	Type	Description	Required
description	string		No
label	CurrentSpaceSearchLabel		No

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

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
highlight	GlobalHighlight	Sets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';	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

CurrentSpaceQuickAction

Name	Type	Description	Required
options	[ CurrentSpaceQuickDecisionValue ]		Yes
rules	GlobalRules	visibility rules fields config	No

CurrentSpaceQuickActions

Name	Type	Description	Required
CurrentSpaceQuickActions	array

CurrentSpaceQuickDecisionValue

Name	Type	Description	Required
form	[ CurrentSpaceStepsProperties ]		No
label	string		Yes
rules	GlobalRules	visibility rules fields config	No
value			Yes

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

CurrentSpaceStatusColors

Status color config to be used in mappings.

Name	Type	Description	Required
Black	[ ]		No
Blue	[ ]		No
Green	[ ]		No
LightGreen	[ ]		No
Orange	[ ]		No
Red	[ ]		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
rules	GlobalRules	visibility rules fields config	No
value			Yes

CustomCss

Basic CSS typing. Preferable to any.

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

CustomTheme

Main theme configuration interface that brings together all theme aspects. This interface defines the complete structure of a custom theme.

Name	Type	Description	Required
breakpoints	Breakpoints	Responsive breakpoint configurations	No
colorSchemes	object	Color scheme configurations for light and dark modes	No
components	object	Component-specific customizations	No
cssVarPrefix	string	Prefix for CSS custom properties	No
focus	object	Focus state configurations	No
fontFamily	object	Font family configurations	No
fontSize	object	Font size configurations	No
fontWeight	object	Font weight configurations	No
lineHeight	object	Line height configurations	No
radius	object	Border radius configurations	No
shadow	object	Shadow configurations	No
typography	object	Typography variants	No

DEfaultValue

Sets default value

Name	Type	Description	Required
DEfaultValue		Sets default value

ExtendedTreeSvgProps

Base tree configuration properties (shared across both strategies).

Name	Type	Description	Required
customNodeHeight	number	Optional. Pixel height of custom node. Default = 100	No
customNodeWidth	number	Optional. Pixel width of custom node. Default = 140	No
dataIndex	string	Optional: data index for each node.	No
enableZoom	boolean	Optional: enable experimental zoom functionality. Note: the component will not be responsive if the zoom is enabled.	No
extrapolateHierarchyKey	string	Optional: We can extra a hierarchy from the data that isn't the one defined by the primary and parent keys, but which can be calculated from that.	No
label	string	Optional: title for tree component.	No
layout	Layout	Optional. How the tree is orientated. Options are 'top-to-bottom' (the default)	'right-to-left'
mainTextKey	string	Optional: Key for the first level text.	No
mainTextLabel	string	Optional: label for main text	No
mode	TreeMode	Optional. 'tree' (default)	'dendogram'
nodeColor	string	Optional. Background colour of the node. Defaults to theme.palette.primary.dark.	No
nodeSize	number	Optional. Size of each node in tree. A number (of pixels). Has no effect when using a custom * * node component, (which we are!).	No
parentKey	string	If there is a direct relationship in between the source data records, the primaryKey will be matched against the parentKey. Required if parentKeyMapping not supplied.	No
parentKeyMapping	[ ParentChildMapping ]	If there is no direct relationship in between the source data records, the parentKeyMapping can be used to associate the parentKey to another key. Best used for small data sets that change infrequently. Required if parentKey not supplied	No
primaryKey	string	Required: Unique identifier for each node.	Yes
secondaryTextKey	string	Optional: Key for the secondary text.	No
secondaryTextLabel	string	Optional: label for secondaryText	No
titleKey	string	Optional: Key for the title text.	No
titleLabel	string	Optional: label for title	No
tooltipDataKey	string	Optional: Key for the tooltip text.	No
tooltipLabel	string	Optional: label for tooltip	No
width	number	Optional. Unless enableZoom is set, the tree control is responsive, and will fill the width of its container element. This prop lets you override that. no longer responsive, and must have fixed, pixel width set. Default: 800 if enableZoom is set, otherwise unset.	No

GlobalAvatar

Set global avatar options

Name	Type	Description	Required
GlobalAvatar		Set global avatar options

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

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, datetime, percent

Name	Type	Description	Required
GlobalFormat	string	Sets a format for the data. Possible values: relative, duration, datetime, percent

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

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: []

GlobalHighlight

Sets sets a highlight on the mapping value. Can be either colors or bold

Possible Values: StatusColors, 'bold';

Name	Type	Description	Required
GlobalHighlight		Sets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';

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
contentType	string	contentType of the attachment. May be required if type is "preview"	No
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, preview Type preview will open the attachment as a preview in the sis

Name	Type	Description	Required
GlobalLinkType	string	Sets link type. Possible values: pdf, html, text, xml, json, invoke, url, download, img, auto, preview Type preview will open the attachment as a preview in the sis

GlobalMapping

Name	Type	Description	Required
actions	CurrentSpaceActionCustom	Custom card actions	No
avatar	GlobalAvatar	Set avatar boolean	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, datetime, percent	No
hideEmpty	boolean	Hide empty fields config	No
hideFromTable	boolean	Hide fields from table (but can still filter on them)	No
highlight	GlobalHighlight	Sets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';	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	Provides a value to be displayed as text for type: 'alert'	No

GlobalMappingProperties

Name	Type	Description	Required
GlobalMappingProperties	array

GlobalMappingProperty

Name	Type	Description	Required
avatar	GlobalAvatar	Sets a translate key for reference in the translation	No
columnWrap	GlobalColumnWrap	Sets the column content to not wrap. Possible Values: true/false	No
customNodeHeight	number	Optional. Pixel height of custom node. Default = 100	No
customNodeWidth	number	Optional. Pixel width of custom node. Default = 140	No
dataIndex	GlobalDataIndex	Sets the path of the Txn property to be displayed	No
defaultValue	DEfaultValue	Sets default value to be displayed	No
disabled	GlobalDisabled	Sets the property as disabled	No
displayFormat	GlobalDisplayFormat	Sets the display Format	No
enableZoom	boolean	Optional: enable experimental zoom functionality. Note: the component will not be responsive if the zoom is enabled.	No
encoding	GlobalEncoding	Sets the encoding. We currently support the following encoding: base64	No
extrapolateHierarchyKey	string	Optional: We can extra a hierarchy from the data that isn't the one defined by the primary and parent keys, but which can be calculated from that.	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, datetime, percent	No
fullWidth	GlobalFullWidth	Sets property display to full width Possible values: true	No
hideEmpty	boolean	Hide empty fields config	No
highlight	GlobalHighlight	Sets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';	No
icon	GlobalIcon	Sets the icon	No
input	GlobalInput	Sets the input config.	No
label	GlobalLabel	Sets the label	No
layout		Optional. How the tree is orientated. Options are 'top-to-bottom' (the default)	'right-to-left'
link	GlobalLink	Sets attributes for the link	No
mainTextKey	string	Optional: Key for the first level text.	No
mainTextLabel	string	Optional: label for main text	No
maxLength	GlobalMaxLength	Sets the max length of the property to be displayed	No
mode		Optional. 'tree' (default)	'dendogram'
name	GlobalName	Sets name to the custom card. Default: null	No
newRow	GlobalNewRow	Sets a new row	No
nodeColor	string	Optional. Background colour of the node. Defaults to theme.palette.primary.dark.	No
nodeSize	number	Optional. Size of each node in tree. A number (of pixels). Has no effect when using a custom node component, (which we are!).	No
parentKey	string	If there is a direct relationship in between the source data records, the primaryKey will be matched against the parentKey. Required if parentKeyMapping not supplied.	No
parentKeyMapping	[ ]	If there is no direct relationship in between the source data records, the parentKeyMapping can be used to associate the parentKey to another key. Best used for small data sets that change infrequently. Required if parentKey not supplied	No
parse	GlobalParse	Sets a parse for the data. Possible values: null	No
primaryKey	string	Required: Unique identifier for each node.	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
secondaryTextKey	string	Optional: Key for the secondary text.	No
secondaryTextLabel	string	Optional: label for secondaryText	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
titleKey	string	Optional: Key for the title text.	No
titleLabel	string	Optional: label for title	No
tooltip	GlobalTooltip	Sets the tooltip options	No
tooltipDataKey	string	Optional: Key for the tooltip text.	No
tooltipLabel	string	Optional: label for tooltip	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
valueMap	GlobalValueMap	Sets value maps 3	No
warning	GlobalWarning	Provides a value to be displayed as text for type: 'alert'	No
width	number	Optional. Unless enableZoom is set, the tree control is responsive, and will fill the width of its container element. This prop lets you override that. no longer responsive, and must have fixed, pixel width set. Default: 800 if enableZoom is set, otherwise unset.	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

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 with GlobalSlaProperties or color as a string

Name	Type	Description	Required
GlobalSla	object	Sets default sla config with GlobalSlaProperties or color as a string

GlobalSlaProperties

Name	Type	Description	Required
color	string		Yes
icon	string		No

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, checkbox

Name	Type	Description	Required
GlobalType	string	Sets property type. Possible values: date, text, number, alert, checkbox

GlobalValidation

The global validation

Name	Type	Description	Required
GlobalValidation		The global validation

GlobalValueMap

A key-value map for transforming raw data into user-friendly labels in UI components.

Used in configuration files to define how data values should be displayed (e.g., in tables, lists, or forms).

Example:

valueMap: { 200: 'Success', 404: 'Address Not Found', 500: 'Server Error' }

Name	Type	Description	Required
GlobalValueMap	object	A key-value map for transforming raw data into user-friendly labels in UI components. Used in configuration files to define how data values should be displayed (e.g., in tables, lists, or forms). Example: valueMap: { 200: 'Success', 404: 'Address Not Found', 500: 'Server Error' }

GlobalVersionNumber

Sets the version number of the fluent function

Name	Type	Description	Required
GlobalVersionNumber	string	Sets the version number of the fluent function

GlobalWarning

Provides a value to be displayed as text for type: 'alert'.

Name	Type	Description	Required
GlobalWarning	string	Provides a value to be displayed as text for type: 'alert'.

Layout

Name	Type	Description	Required
Layout	string

MessagesItem

Represents a single message item in the configuration. Each key corresponds to a message type or identifier.

Name	Type	Description	Required
MessagesItem	object	Represents a single message item in the configuration. Each key corresponds to a message type or identifier.

Palette

Defines the complete color palette structure including all color variations and specialized color settings for different UI elements.

Name	Type	Description	Required
background	object	Background colors for different surface levels	No
common	object	Common colors used throughout the application	No
danger	ColorPalette	Color palette for error and danger states	No
info	ColorPalette	Color palette for informational elements	No
neutral	ColorPalette	Neutral color palette for non-emphasized elements	No
primary	ColorPalette	Primary color palette	No
success	object	Color palette for success states, including channel value for opacity	No
text	object	Text color variations	No
warning	object	Color palette for warning states, including channel value for opacity	No

ParentChildMapping

Name	Type	Description	Required
childKey	number,string	Required: ID of the child node.	Yes
nodeColor	string		No
parentKey	number,string	Required: ID of the parent node.	Yes

Setting

Name	Type	Description	Required
_persist		Sets the persisted State to be used	No
clientCode	SettingClientCode	Client code to be used globally. Default: null	No
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
messagesUnreadMarksDaysAgo	number	Number of days to keep notifications unread marks in local storage Default: 14	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

TreeMode

Name	Type	Description	Required
TreeMode	string

Typography

Defines typography settings for different text elements. These settings can be applied to headers, body text, and other text components.

Name	Type	Description	Required
color	string	Color of the text element (supports CSS color values and CSS variables)	No
fontFamily	string	Font family for the text element	No
fontSize	string	Font size of the text element	No
fontWeight	number,string	Font weight of the text element (can be a number like 400 or string like 'bold')	No
letterSpacing	string	Letter spacing for the text element	No
lineHeight	number	Line height of the text element	No
textTransform	string	Text transformation (e.g., 'uppercase', 'lowercase', 'capitalize')	No