Skip to main content

Version: 24.10

Reference

Models

Breakpoints

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

NameTypeDescriptionRequired
valuesobjectYes

ColorPalette

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

NameTypeDescriptionRequired
dividerstringColor for divider elementsNo
mainChannelstringMain channel value for color mixing operationsNo
outlinedActiveBgstringActive state background color for outlined variantNo
outlinedBorderstringBorder color for outlined variantNo
outlinedColorstringText color for outlined variantNo
outlinedHoverBgstringHover background color for outlined variantNo
outlinedHoverBorderstringHover border color for outlined variantNo
softActiveBgstringActive state background color for soft variantNo
softBgstringBackground color for soft variantNo
softColorstringText color for soft variantNo
softHoverBgstringHover background color for soft variantNo
solidActiveBgstringActive state background color for solid variantNo
solidBgstringBackground color for solid variantNo
solidHoverBgstringHover background color for solid variantNo

ComponentOverrides

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

NameTypeDescriptionRequired
rootobjectBase styles for the componentNo
solidobjectStyles for solid variantNo

ConfigCurrentSpace

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

NameTypeDescriptionRequired
actionsCurrentSpaceActionsList of all available actions for the current space. Possible actions include: Claim, Release, Assign, Unassign, Decision, ViewForm, Recover, Withdraw, Receipt.No
attachmentsCurrentSpaceAttachmentsConfigConfiguration for filtering attachments. Defaults to null.No
customCardsCurrentSpaceCustomCardsList of custom cards to be displayed in the Custom Cards section. Defaults to an empty array [].No
greetingsCurrentSpaceGreetingsA custom message to be displayed on top of the to do list. Defaults to null.No
hideTasksCurrentSpaceHideTasksConfiguration for hiding specific steps and tasks from the timeline.No
iconCurrentSpaceIconIcon to represent the current space. Defaults to static//icon.png.Yes
invokeCurrentSpaceInvokeConfiguration for invoking a fluent function within the space. Defaults to null.No
keynumberInternal unique identifier for the space. Defaults to null.No
keyInfoCurrentSpaceKeyInfoList of key properties to be displayed in the Key Info section. Defaults to an empty array [].No
labelGlobalLabelLabel to be used for the current space.Yes
notesSectionbooleanConfiguration for removing the notes sectionNo
permissionsGlobalPermissionsPermissions 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
rulesGlobalRulesRules to control the visibility of the attachments upload button.No
stepsCurrentSpaceStepsConfiguration for the timeline or steps to be displayed. Defaults to an empty array [].No

ConfigEditor

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

NameTypeDescriptionRequired
globalConfigGlobalGlobal configuration settings.Yes
messagesConfigMessagesOptional configuration for messages.No
settingsConfigSettingsOptional settings configuration.No
spaces[ ConfigCurrentSpace ]Array of space-specific configurations.Yes
versionVersion information for the configuration. Can be of any type.No

ConfigGlobal

Global configuration settings that apply across the entire application.

NameTypeDescriptionRequired
faviconstringPath to the favicon used across the application. Defaults to static//favicon.png.No
hideStepsGlobalHideStepsList of steps to hide globally from the timeline. Defaults to an empty array [].No
logostringPath to the logo used across the application. Defaults to static/logo.png.No
mappingsGlobalMappingsGlobal mappings configuration. Defaults to null.Yes
themeConfigThemeGlobal 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.

NameTypeDescriptionRequired
ConfigMessagesobjectConfiguration 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.

NameTypeDescriptionRequired
ConfigSettingsConfiguration object for application settings.

ConfigTheme

NameTypeDescriptionRequired
ConfigTheme

CurrentSpaceAction

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

Default: null

NameTypeDescriptionRequired
appearancestringDisplays actions as buttons side by side instead of nested in a dropdown menu Possible values: 'button'No
dataIndexGlobalDataIndexSets dataIndex of ActionNo
labelGlobalLabelSets type of ActionYes
permissionsGlobalPermissionsSets the persmissions for the ActionNo

CurrentSpaceActionCustom

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

Default: null

NameTypeDescriptionRequired
appearancestringDisplays actions as buttons side by side instead of nested in a dropdown menu Possible values: 'button'No
dataIndexGlobalDataIndexSets dataIndex of ActionNo
labelGlobalLabelSets type of ActionYes
permissionsGlobalPermissionsSets the persmissions for the ActionNo
propertiesCurrentSpaceActionCustomPropertiesSets the persmissions for the ActionYes

CurrentSpaceActionCustomProperties

List of custom actions

NameTypeDescriptionRequired
CurrentSpaceActionCustomPropertiesarrayList of custom actions

CurrentSpaceActionCustomProperty

Custom Action Property

NameTypeDescriptionRequired
actionsCurrentSpaceActionCustomCustom card actionsNo
dataIndexGlobalDataIndexSets dataIndex of ActionNo
encodingGlobalEncodingSets the encoding. We currently support the following encoding: base64No
iconGlobalIconSets the IconNo
labelGlobalLabelSets type of ActionYes
paramsGlobalParamsSets the params of the fluent functionNo
permissionsGlobalPermissionsSets the permissions for the viewNo
rulesGlobalRulesSets the visibility rules for the custom actionNo
serviceNameGlobalServiceNameSets the name of the fluent functionNo
typeGlobalLinkTypeSets attributes for the linkYes
versionNumberGlobalInvokeVersionNumberSets the version number of the fluent functionNo

CurrentSpaceActionSingleInvoke

NameTypeDescriptionRequired
appearancestringDisplays actions as buttons side by side instead of nested in a dropdown menu Possible values: 'button'No
dataIndexGlobalDataIndexSets dataIndex of ActionNo
labelGlobalLabelSets type of ActionYes
onErrorCurrentSpaceInvokeNo
onSuccessCurrentSpaceInvokeNo
permissionsGlobalPermissionsSets the persmissions for the ActionNo

CurrentSpaceActions

List of available actions.

NameTypeDescriptionRequired
AbandonCurrentSpaceActionWhen clicked it triggers the abandone process.No
AddNotesCurrentSpaceActionWhen clicked it shows the Add Notes modal.No
AssignCurrentSpaceActionSingleInvokeWhen 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
ClaimCurrentSpaceActionSingleInvokeWhen clicked it assigns the current Txn to the current user.No
CustomCurrentSpaceActionCustomAllows configured custom actions to be displayed in a dropdown.No
DecisionCurrentSpaceActionWhen clicked it opens up a modal with the current Txn formUrl + &pageId=decision.No
PurgeCurrentSpaceActionWhen clicked it triggers the purge process.No
ReassignCurrentSpaceActionSingleInvokeWhen 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
ReceiptCurrentSpaceActionShows 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
RecoverCurrentSpaceActionSingleInvokeWhen clicked the abandoned txn will be re-opened.No
ReleaseCurrentSpaceActionSingleInvokeWhen clicked it unassigns the current Txn. This actions will be available only if the current user is the assignee.No
ResumeCurrentSpaceActionWhen clicked it resumes the job.No
ShareCurrentSpaceActionWhen clicked it shows the share popup.No
TransactionPurgeCurrentSpaceActionWhen clicked it triggers the txn purge process.No
UnassignCurrentSpaceActionSingleInvokeWhen clicked it unassigns the current Txn. The difference with Release is that Unassign is available to all users.No
ViewFormCurrentSpaceActionWhen clicked it opens up a modal with the current Txn formUrl + &pageId=view.No
ViewXMLCurrentSpaceActionWhen clicked it display the txn's XML.No
WithdrawCurrentSpaceActionSingleInvokeWhen clicked saved txn will be abandoned.No

CurrentSpaceAttachments

NameTypeDescriptionRequired
duplicatesCurrentSpaceAttachmentsDuplicatesSet duplicates to show or hide.No
filterCurrentSpaceAttachmentsFilterSet filter for the attachmentsNo
hideUploadButtonCurrentSpaceAttachmentsHideUploadButtonHides the Document Upload ButtonNo
rulesGlobalRulesRules that show/hide the attachments upload buttonNo
uploadWithoutClaimCurrentSpaceAttachmentsUploadWithoutClaimSets the persmissions for the Action.No

CurrentSpaceAttachmentsConfig

NameTypeDescriptionRequired
CurrentSpaceAttachmentsConfig

CurrentSpaceAttachmentsDuplicates

Remove duplicates.

NameTypeDescriptionRequired
CurrentSpaceAttachmentsDuplicatesbooleanRemove duplicates.

CurrentSpaceAttachmentsFilter

Filter applied to attachments

NameTypeDescriptionRequired
actionstringAction for the filter. Possible values: include, excludeYes
regexstringRegex 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 includedYes

CurrentSpaceAttachmentsHideUploadButton

Hides the Document Upload Button

NameTypeDescriptionRequired
CurrentSpaceAttachmentsHideUploadButtonbooleanHides the Document Upload Button

CurrentSpaceAttachmentsUploadWithoutClaim

Sets the permissions for the Action.

NameTypeDescriptionRequired
CurrentSpaceAttachmentsUploadWithoutClaimbooleanSets the permissions for the Action.

CurrentSpaceCustomCardContainerProperty

NameTypeDescriptionRequired
columnWrapGlobalColumnWrapSets the column content to not wrap. Possible Values: falseNo
dataIndexGlobalDataIndexSets the path of the Txn property to be displayed. Default: nullNo
encodingGlobalEncodingSets the encoding. We currently support the following encoding: base64No
formatGlobalFormatSets a format for the data Possible values: relative, durationNo
fullWidthGlobalFullWidthSets property display to full width Possible values: trueNo
highlightGlobalHighlightSets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';No
labelGlobalLabelSets the label to be usedNo
linkGlobalLinkSets attributes for the linkNo
nameGlobalNameSets a name for the data Possible values: stringNo
parseGlobalParseSets a parse for the data. Possible values: nullNo
properties[ CurrentSpaceCustomCardProperty ]Properties for Custom CardsNo
spanGlobalSpanSets the grid config.No
statusColorsCurrentSpaceStatusColorsStatus color config to be used in the Column card section Default: nullNo
typeSets property type. Possible values: date, text, numberNo

CurrentSpaceCustomCardForm

NameTypeDescriptionRequired
actionsCurrentSpaceActionCustomCustom card actionsNo
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).No
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardYes
namestringName of the API to send data to on form submissionYes
permissionsGlobalPermissionsSets the permissions for the custom cardNo
properties[ CurrentSpaceCustomCardContainerProperty ]Mappings for the Custom CardYes
readOnlyGlobalReadOnlyMake it read onlyNo
rulesGlobalRulesvisibility rules fields configNo
typestringSets the custom card type. Possible value: formYes

CurrentSpaceCustomCardIframe

NameTypeDescriptionRequired
actionsCurrentSpaceActionCustomCustom card actionsNo
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).No
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardNo
permissionsGlobalPermissionsSets the permissions for the custom cardNo
properties[ CurrentSpaceCustomCardContainerProperty ]Mappings for the Custom CardYes
rulesGlobalRulesvisibility rules fields configNo
typestringSets the custom card type. Possible value: iframeYes

CurrentSpaceCustomCardList

NameTypeDescriptionRequired
actionsCurrentSpaceActionCustomCustom card actionsNo
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).No
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardNo
permissionsGlobalPermissionsSets the permissions for the custom cardNo
properties[ CurrentSpaceCustomCardContainerProperty ]Mappings for the Custom CardYes
rulesGlobalRulesvisibility rules fields configNo
typeSets the custom card type. Possible value: listYes

CurrentSpaceCustomCardListExtended

NameTypeDescriptionRequired
actionsCurrentSpaceActionCustomCustom card actionsNo
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).No
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardNo
permissionsGlobalPermissionsSets the permissions for the custom cardNo
properties[ CurrentSpaceCustomCardContainerProperty ]Mappings for the Custom CardYes
rulesGlobalRulesvisibility rules fields configNo
sections[ CurrentSpaceCustomCardTabsProperties ]Sub-sections for the Custom CardNo
statusColorsCurrentSpaceStatusColorsStatus color config to be used in the ExtendedList card section. Default: nullNo
typestringSets the custom card type, Possible value: listExtendedYes

CurrentSpaceCustomCardListStacked

NameTypeDescriptionRequired
actionsCurrentSpaceActionCustomCustom card actionsNo
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).No
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardNo
permissionsGlobalPermissionsSets the permissions for the custom cardNo
properties[ CurrentSpaceCustomCardContainerProperty ]Mappings for the Custom CardYes
rulesGlobalRulesvisibility rules fields configNo
typestringSets the custom card type. Possible value: listStackedYes

CurrentSpaceCustomCardProperty

NameTypeDescriptionRequired
columnWrapGlobalColumnWrapSets the column content to not wrap. Possible Values: falseNo
dataIndexGlobalDataIndexSets the path of the Txn property to be displayed. Default: nullNo
encodingGlobalEncodingSets the encoding. We currently support the following encoding: base64No
formatGlobalFormatSets a format for the data Possible values: relative, durationNo
fullWidthGlobalFullWidthSets property display to full width Possible values: trueNo
highlightGlobalHighlightSets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';No
labelGlobalLabelSets the label to be usedNo
linkGlobalLinkSets attributes for the linkNo
nameGlobalNameSets a name for the data Possible values: stringNo
parseGlobalParseSets a parse for the data. Possible values: nullNo
spanGlobalSpanSets the grid config.No
statusColorsCurrentSpaceStatusColorsStatus color config to be used in the Column card section Default: nullNo
typeSets property type. Possible values: date, text, numberNo

CurrentSpaceCustomCardTable

NameTypeDescriptionRequired
actionsCurrentSpaceActionCustomCustom card actionsNo
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).Yes
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardYes
permissionsGlobalPermissionsSets the permissions for the custom cardNo
properties[ CurrentSpaceCustomCardContainerProperty ]Mappings for the Custom CardYes
readOnlyGlobalReadOnlyMake it read onlyNo
rulesGlobalRulesvisibility rules fields configNo
typestringSets the custom card type. Possible value: tableYes

CurrentSpaceCustomCardTableExtended

NameTypeDescriptionRequired
actionsCurrentSpaceActionCustomCustom card actionsNo
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).No
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardYes
permissionsGlobalPermissionsSets the permissions for the custom cardNo
properties[ CurrentSpaceCustomCardContainerProperty ]Mappings for the Custom CardYes
rulesGlobalRulesvisibility rules fields configNo
sections[ CurrentSpaceCustomCardTabsProperties ]Sub-sections for the Custom CardNo
typestringSets the custom card type. Possible value: tableExtendedYes

CurrentSpaceCustomCardTabs

Sets the customCard tabs properties

NameTypeDescriptionRequired
checkStatusGlobalCheckStatusNo
hideEmptyGlobalHideEmptyNo
keystringNo
labelCurrentSpaceCustomCardTabsLabelYes
propertiesYes
rulesGlobalRulesNo
tabTypeGlobalTabTypeNo

CurrentSpaceCustomCardTabsLabel

Sets the label to be used for the custom card tab

NameTypeDescriptionRequired
CurrentSpaceCustomCardTabsLabelstringSets the label to be used for the custom card tab

CurrentSpaceCustomCardTabsProperties

NameTypeDescriptionRequired
CurrentSpaceCustomCardTabsProperties

CurrentSpaceCustomCardTabsPropertiesArray

NameTypeDescriptionRequired
CurrentSpaceCustomCardTabsPropertiesArrayarray

CurrentSpaceCustomCards

Array of Custom Cards

NameTypeDescriptionRequired
CurrentSpaceCustomCardsarrayArray of Custom Cards

CurrentSpaceGreetings

Sets the search bar properties

NameTypeDescriptionRequired
descriptionstringNo
labelCurrentSpaceSearchLabelNo

CurrentSpaceHideTasks

Shows a list of steps and an array of tasks as children of those steps to be hidden from the timeline

NameTypeDescriptionRequired
CurrentSpaceHideTasksobjectShows 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

NameTypeDescriptionRequired
CurrentSpaceIconstringSets the icon to be used for the space

CurrentSpaceInvoke

NameTypeDescriptionRequired
paramsGlobalParamsSets the params of the fluent functionNo
rulesGlobalRulesvisibility rules fields configNo
serviceNameGlobalServiceNameSets the name of the fluent functionYes
versionNumberGlobalInvokeVersionNumberSets the version number of the fluent functionNo

CurrentSpaceKeyInfo

List of items displaying in the Key Info panel

NameTypeDescriptionRequired
CurrentSpaceKeyInfoarrayList of items displaying in the Key Info panel

CurrentSpaceProperty

Defines a mapping for use in the view.

NameTypeDescriptionRequired
columnWrapGlobalColumnWrapSets the column content to not wrap. Possible Values: falseNo
dataIndexGlobalDataIndexSets the path of the Txn property to be displayed. Default: nullYes
filterGlobalFilterSets the filter strategy for this mapping. Possible values: input, select, multiselect, pickerNo
formatGlobalFormatSets a format for the data Possible values: relative, durationNo
hideFromTablebooleanHide fields from table (but can still filter on them)No
highlightGlobalHighlightSets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';No
iconCurrentSpaceIconSets the icon to be usedNo
labelGlobalLabelSets the label to be usedYes
parseGlobalParseSets a parse for the data. Possible values: nullNo
permissionsGlobalPermissionsSets the permissions for the CurrentSpace elementNo
rulesGlobalRulesSets the visibility rules for the CurrentSpace elementNo
sorterGlobalSorterSets the mapping to be sortable via the column headerNo
tooltipGlobalTooltipSets the tooltip optionsNo
typeGlobalTypeSets property type. Possible values: date, text, numberYes

CurrentSpaceSearchLabel

Sets the label to be used for the space

NameTypeDescriptionRequired
CurrentSpaceSearchLabelstringSets the label to be used for the space

CurrentSpaceStatusColors

Status color config to be used in mappings.

NameTypeDescriptionRequired
Black[ ]No
Blue[ ]No
Green[ ]No
LightGreen[ ]No
Orange[ ]No
Red[ ]No

CurrentSpaceSteps

List of steps to show in timeline

Type: CurrentSpaceStepsProperties[]

NameTypeDescriptionRequired
CurrentSpaceStepsarrayList of steps to show in timeline Type: CurrentSpaceStepsProperties[]

CurrentSpaceStepsProperties

NameTypeDescriptionRequired
labelstringYes
rulesGlobalRulesNo
valueYes

CustomCss

Basic CSS typing. Preferable to any.

NameTypeDescriptionRequired
CustomCssobjectBasic 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.

NameTypeDescriptionRequired
breakpointsBreakpointsResponsive breakpoint configurationsNo
colorSchemesobjectColor scheme configurations for light and dark modesNo
componentsobjectComponent-specific customizationsNo
cssVarPrefixstringPrefix for CSS custom propertiesNo
focusobjectFocus state configurationsNo
fontFamilyobjectFont family configurationsNo
fontSizeobjectFont size configurationsNo
fontWeightobjectFont weight configurationsNo
lineHeightobjectLine height configurationsNo
radiusobjectBorder radius configurationsNo
shadowobjectShadow configurationsNo
typographyobjectTypography variantsNo

DEfaultValue

Sets default value

NameTypeDescriptionRequired
DEfaultValueSets default value

GlobalCheckStatus

Sets check status

NameTypeDescriptionRequired
dataIndexGlobalDataIndexSets the path of the Txn property to be displayed.Yes

GlobalColumnWrap

Sets the column content to not wrap.

Possible values: true/false

NameTypeDescriptionRequired
GlobalColumnWrapbooleanSets the column content to not wrap. Possible values: true/false

GlobalCustomCardType

Sets type for the Custom Card

Possible values: list, listStacked, listExtended, table, tableExtended

NameTypeDescriptionRequired
GlobalCustomCardTypestringSets type for the Custom Card Possible values: list, listStacked, listExtended, table, tableExtended

GlobalDataIndex

Sets the path of the Txn property to be displayed.

NameTypeDescriptionRequired
GlobalDataIndexSets the path of the Txn property to be displayed.

GlobalDataSource

Used to define a deep data source (It needs to be a JSON value).

NameTypeDescriptionRequired
GlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).

GlobalDisabled

The global disabled state

NameTypeDescriptionRequired
GlobalDisabledbooleanThe global disabled state

GlobalDisplayFormat

Sets display format

NameTypeDescriptionRequired
GlobalDisplayFormatstringSets display format

GlobalEncoding

Sets the encoding. We currently support the following encoding: base64

NameTypeDescriptionRequired
GlobalEncodingstringSets the encoding. We currently support the following encoding: base64

GlobalFilter

Sets the filter strategy for this mapping.

Possible values: input, select, multiselect, picker

NameTypeDescriptionRequired
GlobalFilterSets the filter strategy for this mapping. Possible values: input, select, multiselect, picker

GlobalFilterOptionsInput

NameTypeDescriptionRequired
typestringSets the global filter type to input. Possible values: inputYes

GlobalFilterOptionsPicker

NameTypeDescriptionRequired
optionsobjectSet the default date range for the date picker. Possible values: minDate, maxDateNo
typestringSet the global filter type to be a date picker. Possible values: datepicker,daterangepickerYes

GlobalFilterOptionsSelect

NameTypeDescriptionRequired
options[ string ]Sets the options for the select dropdownNo
typestringSets the global filter type Possible values: select, multiselectYes

GlobalFormat

Sets a format for the data.

Possible values: relative, duration, datetime, percent

NameTypeDescriptionRequired
GlobalFormatstringSets a format for the data. Possible values: relative, duration, datetime, percent

GlobalFullWidth

Sets property display to full width.

Possible values: true/false

NameTypeDescriptionRequired
GlobalFullWidthbooleanSets property display to full width. Possible values: true/false

GlobalHideEmpty

Hide empty fields config

NameTypeDescriptionRequired
GlobalHideEmptybooleanHide empty fields config

GlobalHideSteps

List of steps to hide in the Timeline section.

Default: []

NameTypeDescriptionRequired
GlobalHideStepsarrayList 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';

NameTypeDescriptionRequired
GlobalHighlightSets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';

GlobalIcon

Sets the icon to be used

NameTypeDescriptionRequired
GlobalIconstringSets the icon to be used

GlobalIframeType

NameTypeDescriptionRequired
GlobalIframeTypestring

GlobalInput

The global input

NameTypeDescriptionRequired
labelstringNo
properties[ GlobalInputProperties ]No
typeYes
valuestringNo

GlobalInputProperties

NameTypeDescriptionRequired
checkedbooleanNo
labelstringYes
valueboolean,stringNo

GlobalInvokeVersionNumber

NameTypeDescriptionRequired
GlobalInvokeVersionNumber

GlobalInvokeVersionNumberDataIndex

NameTypeDescriptionRequired
dataIndexGlobalDataIndexYes

GlobalLabel

Sets the label to be used

NameTypeDescriptionRequired
GlobalLabelstringSets the label to be used
NameTypeDescriptionRequired
dataIndexGlobalDataIndexSets the path of the Txn property to be displayed.Yes
encodingGlobalEncodingSets the encoding. We currently support the following encoding: base64No
iconstringIcon to override if type is "invoke"No
paramsGlobalParamsSets the params of the fluent functionNo
rulesGlobalRulesvisibility rules fields configNo
serviceNameGlobalServiceNameSets the name of the fluent functionNo
typeGlobalLinkTypeSets link type. Possible values: pdf, html, text, xml, invoke, json, url, file, autoYes
versionNumberGlobalInvokeVersionNumberSets the version number of the fluent functionNo

GlobalLinkType

Sets link type.

Possible values: pdf, html, text, xml, json, invoke, url, download, img, auto

NameTypeDescriptionRequired
GlobalLinkTypestringSets link type. Possible values: pdf, html, text, xml, json, invoke, url, download, img, auto

GlobalMapping

NameTypeDescriptionRequired
actionsCurrentSpaceActionCustomCustom card actionsNo
columnWrapGlobalColumnWrapSets the column content to not wrap. Possible Values: true/falseNo
dataIndexGlobalDataIndexSets the path of the Txn property to be displayedNo
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value)No
disabledGlobalDisabledSets the path of the Txn property to be displayedNo
displayFormatGlobalDisplayFormatSets the display FormatNo
filterGlobalFilterSets the filter strategy for this mapping. Possible values: input, select, multiselect, pickerNo
formatGlobalFormatSets a format for the data. Possible values: relative, duration, datetime, percentNo
hideEmptyGlobalHideEmptyHide empty fields configNo
hideFromTablebooleanHide fields from table (but can still filter on them)No
highlightGlobalHighlightSets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';No
iconGlobalIconSets the iconNo
inputGlobalInputSets the input config.No
labelGlobalLabelSets the labelNo
linkGlobalLinkSets attributes for the linkNo
maxLengthGlobalMaxLengthSets the max length of the property to be displayedNo
nameGlobalNameSets a name for the data. Possible values: nullNo
newRowGlobalNewRowSets a new rowNo
parseGlobalParseSets a parse for the data. Possible values: nullNo
permissionsGlobalPermissionsSets the permissions for the viewNo
propertiesGlobalMappingPropertiesList of Mapping Objects or Mapping keys Default: nullNo
readOnlyGlobalReadOnlyMake it read onlyNo
rulesGlobalRulesvisibility rules fields configNo
sections[ CurrentSpaceCustomCardTabsProperties ]Status color config to be used in the ExtendedList card section Default: nullNo
slaGlobalSlaALternative config for the SLANo
sorterGlobalSorterSets the mapping to be sortable via the column headerNo
spanGlobalSpanSets the grid config.No
statusColorsCurrentSpaceStatusColorsStatus color config to be used in the ExtendedList card section Default: nullNo
tooltipGlobalTooltipSets the tooltip optionsNo
typeSets type for the property Possible values: text, date, number, alert, time, list, listExtended, listStacked, table, tableExtendedYes
validationGlobalValidationSets the validationNo
warningGlobalWarningProvides a value to be displayed as text for type: 'alert'No

GlobalMappingProperties

NameTypeDescriptionRequired
GlobalMappingPropertiesarray

GlobalMappingProperty

NameTypeDescriptionRequired
columnWrapGlobalColumnWrapSets the column content to not wrap. Possible Values: true/falseNo
dataIndexGlobalDataIndexSets the path of the Txn property to be displayedNo
defaultValueDEfaultValueSets default value to be displayedNo
disabledGlobalDisabledSets the property as disabledNo
displayFormatGlobalDisplayFormatSets the display FormatNo
encodingGlobalEncodingSets the encoding. We currently support the following encoding: base64No
filterGlobalFilterSets the filter strategy for this mapping. Possible values: input, select, multiselect, pickerNo
formatGlobalFormatSets a format for the data. Possible values: relative, duration, datetime, percentNo
fullWidthGlobalFullWidthSets property display to full width Possible values: trueNo
hideEmptyGlobalHideEmptyHide empty fields configNo
highlightGlobalHighlightSets sets a highlight on the mapping value. Can be either colors or bold Possible Values: StatusColors, 'bold';No
iconGlobalIconSets the iconNo
inputGlobalInputSets the input config.No
labelGlobalLabelSets the labelNo
linkGlobalLinkSets attributes for the linkNo
maxLengthGlobalMaxLengthSets the max length of the property to be displayedNo
nameGlobalNameSets name to the custom card. Default: nullNo
newRowGlobalNewRowSets a new rowNo
parseGlobalParseSets a parse for the data. Possible values: nullNo
propertiesGlobalMappingPropertiesList of Mapping Objects or Mapping keys Default: nullNo
readOnlyGlobalReadOnlyMake it read onlyNo
rulesGlobalRulesvisibility rules fields configNo
slaGlobalSlaALternative config for the SLANo
sorterGlobalSorterSets the mapping to be sortable via the column headerNo
spanGlobalSpanSets the grid config.No
statusColorsCurrentSpaceStatusColorsStatus color config to be used in the ExtendedList card section Default: nullNo
tooltipGlobalTooltipSets the tooltip optionsNo
typeSets type for the property Possible values: text, date, number, alert, time, list, listExtended, listStacked, table, tableExtended, iframeNo
validationGlobalValidationSets the validationNo
valueMapGlobalValueMapSets value maps 3No
warningGlobalWarningProvides a value to be displayed as text for type: 'alert'No

GlobalMappings

Mappings config to be used globally.

Default: null

NameTypeDescriptionRequired
GlobalMappingsobjectMappings config to be used globally. Default: null

GlobalMaxLength

The global maxLength state

NameTypeDescriptionRequired
GlobalMaxLengthnumberThe global maxLength state

GlobalName

The global name state

NameTypeDescriptionRequired
GlobalNamestringThe global name state

GlobalNewRow

Sets new row

NameTypeDescriptionRequired
GlobalNewRowbooleanSets new row

GlobalParams

The global params state

NameTypeDescriptionRequired
GlobalParamsThe global params state

GlobalParse

Sets a parse for the data.

NameTypeDescriptionRequired
GlobalParsestringSets a parse for the data.

GlobalPermissions

Sets permissions for spaces or actions.

NameTypeDescriptionRequired
operatorGlobalPermissionsOperatorSets permission operator. Possible values: and, orNo
typeGlobalPermissionsTypeSets permission type. Possible values: group, roleYes
value[ string ]Sets values depending on the permissionYes

GlobalPermissionsOperator

NameTypeDescriptionRequired
GlobalPermissionsOperatorstring

GlobalPermissionsType

NameTypeDescriptionRequired
GlobalPermissionsTypestring

GlobalReadOnly

Make it read only

NameTypeDescriptionRequired
GlobalReadOnlybooleanMake it read only

GlobalRules

The global rules config.

NameTypeDescriptionRequired
GlobalRulesThe global rules config.

GlobalRulesItem

The global rules item

NameTypeDescriptionRequired
dataIndexYes
valueYes

GlobalServiceName

Sets the name of the fluent function

NameTypeDescriptionRequired
GlobalServiceNamestringSets the name of the fluent function

GlobalSla

Sets default sla config with GlobalSlaProperties or color as a string

NameTypeDescriptionRequired
GlobalSlaobjectSets default sla config with GlobalSlaProperties or color as a string

GlobalSlaProperties

NameTypeDescriptionRequired
colorstringYes
iconstringNo

GlobalSorter

Sets the sorter to be used

NameTypeDescriptionRequired
GlobalSorterbooleanSets the sorter to be used

GlobalSpan

Sets grid configuration

NameTypeDescriptionRequired
GlobalSpanSets grid configuration

GlobalTabType

NameTypeDescriptionRequired
GlobalTabTypestring

GlobalTooltip

Set global tooltip options

NameTypeDescriptionRequired
dataIndexstringNo

GlobalType

Sets property type.

Possible values: date, text, number, alert, checkbox

NameTypeDescriptionRequired
GlobalTypestringSets property type. Possible values: date, text, number, alert, checkbox

GlobalValidation

The global validation

NameTypeDescriptionRequired
GlobalValidationThe 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' }

NameTypeDescriptionRequired
GlobalValueMapobjectA 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

NameTypeDescriptionRequired
GlobalVersionNumberstringSets the version number of the fluent function

GlobalWarning

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

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

MessagesItem

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

NameTypeDescriptionRequired
MessagesItemobjectRepresents 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.

NameTypeDescriptionRequired
backgroundobjectBackground colors for different surface levelsNo
commonobjectCommon colors used throughout the applicationNo
dangerColorPaletteColor palette for error and danger statesNo
infoColorPaletteColor palette for informational elementsNo
neutralColorPaletteNeutral color palette for non-emphasized elementsNo
primaryColorPalettePrimary color paletteNo
successobjectColor palette for success states, including channel value for opacityNo
textobjectText color variationsNo
warningobjectColor palette for warning states, including channel value for opacityNo

Setting

NameTypeDescriptionRequired
_persistSets the persisted State to be usedNo
clientCodeSettingClientCodeClient code to be used globally. Default: nullNo
configPathSettingConfigPathSets the Idle Time to be usedNo
configServiceSettingConfigServiceConfig Service setting to be used globally. Default: nullNo
formCodeSettingFormCodeSets the Idle Time to be usedNo
formVersionSets the form version to be usedNo
idleTimeSettingIdleTimeSets the Idle Time to be usedNo
idleTimeWarningSettingIdleTimeSets the Idle Warning Time to be usedNo
localeSettingLocaleLocale setting to be used globally. Default: nullNo
messagesUnreadMarksDaysAgonumberNumber of days to keep notifications unread marks in local storage Default: 14No
nameSettingNameTheme setting to be used globally. Default: nullNo
redirectLogoutUrlstringRedirect URL after user logs out Default: undefinedNo
themeSettingThemeTheme setting to be used globally. Default: nullNo
timeCreatedSets the time created to be usedNo
transactInsightsSettingTransactInsightsTransact Insights setting to be used globally. Default: falseNo
unbluSets the unblu config to be usedNo

SettingAssistantChatGPT

ChatGPT options.

Default: null

NameTypeDescriptionRequired
apiKeystringapiKey to be used by ChatGPT. Default: nullNo
modelstringmodel be used by ChatGPT. Default: nullNo

SettingClientCode

Client code to be used globally.

Default: null

NameTypeDescriptionRequired
SettingClientCodestringClient code to be used globally. Default: null

SettingConfigPath

Config path to be used globally.

Default: null

NameTypeDescriptionRequired
SettingConfigPathstringConfig path to be used globally. Default: null

SettingConfigService

Config Service setting to be used globally.

Default: null

NameTypeDescriptionRequired
assistantSettingConfigServiceAssistantLLM assistant config. Default: nullNo
themeNamestringTheme Name setting to be used in config service. Default: nullNo
versionNumberstringVersionto be used in config service. Default: nullNo

SettingConfigServiceAssistant

ChatGPT options.

Default: null

NameTypeDescriptionRequired
chatGPTSettingAssistantChatGPTChatGPT options. Default: nullNo

SettingFormCode

Form code to be used globally.

Default: null

NameTypeDescriptionRequired
SettingFormCodestringForm code to be used globally. Default: null

SettingIdleTime

Sets the Idle Time to be used

NameTypeDescriptionRequired
SettingIdleTimenumberSets the Idle Time to be used

SettingLocale

Sets the locale to be used

NameTypeDescriptionRequired
SettingLocalestringSets the locale to be used

SettingName

Sets the App Name to be used

NameTypeDescriptionRequired
SettingNamestringSets the App Name to be used

SettingTheme

Sets the theme to be used

NameTypeDescriptionRequired
SettingThemeSets the theme to be used

SettingTransactInsights

Transact Insights setting to be used globally.

Default: false

NameTypeDescriptionRequired
SettingTransactInsightsbooleanTransact Insights setting to be used globally. Default: false

SnackBar

Styles for the snack bars (currently provided by Notistack)

NameTypeDescriptionRequired
defaultCustomCssStyles for default snack pop-up, i.e no snack type specified. Default is black background.No
errorCustomCssStyles for error snack pop-up. Default is red background.No
infoCustomCssStyles for info snack pop-up. Default is light blue background.No
successCustomCssStyles for success snack pop-up. Default is green background.No
warningCustomCssStyles for warning snack pop-up. Default is orange background.No

Theme

NameTypeDescriptionRequired
blackstringGlobal theme colorNo
blueThemeSecondaryColorPropertyGlobal theme color. Possible values: main, lightNo
brandstringGlobal theme brand.No
greenThemeSecondaryColorPropertyGlobal theme color. Possible values: main, lightNo
greyThemeColorPropertyGlobal theme color. Possible values: light, lightest, primary, dark, darkestNo
logostringGlobal theme logo.No
orangestringGlobal theme colorNo
primaryThemePrimaryColorPropertyGlobal theme primary color. Possible values: mainNo
redThemeSecondaryColorPropertyGlobal theme color. Possible values: main, lightNo
snackSnackBarStyles 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
textThemeSecondaryColorPropertyGlobal theme color. Possible values: main, lightNo
whitestringGlobal theme colorNo

ThemeColorProperty

Global theme property

NameTypeDescriptionRequired
darkstringGlobal theme color variation. Use a hex color codeNo
darkeststringGlobal theme color variation. Use a hex color codeNo
lightstringGlobal theme color variation. Use a hex color codeNo
lighteststringGlobal theme color variation. Use a hex color codeNo
primarystringGlobal theme color variation. Use a hex color codeNo

ThemePrimaryColorProperty

NameTypeDescriptionRequired
mainstringGlobal theme color variation. Use a hex color codeNo

ThemeSecondaryColorProperty

NameTypeDescriptionRequired
lightstringGlobal theme color variation. Use a hex color codeNo
mainstringGlobal theme color variation. Use a hex color codeNo

Typography

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

NameTypeDescriptionRequired
colorstringColor of the text element (supports CSS color values and CSS variables)No
fontFamilystringFont family for the text elementNo
fontSizestringFont size of the text elementNo
fontWeightnumber,stringFont weight of the text element (can be a number like 400 or string like 'bold')No
letterSpacingstringLetter spacing for the text elementNo
lineHeightnumberLine height of the text elementNo
textTransformstringText transformation (e.g., 'uppercase', 'lowercase', 'capitalize')No
In this topic