Models
ConfigCurrentSpace
Configuration for an individual Space, defining its display, functionality, and behavior within the application.
Name | Type | Description | Required |
---|
actions | CurrentSpaceActions | A list of actions available for the space. Possible actions: Claim , Release , Assign , Unassign , Decision , ViewForm , Recover , Withdraw , Receipt , Share . | No |
attachments | CurrentSpaceAttachmentsConfig | Configuration for filtering attachments within the space. Defaults to null . | No |
bulkActions | CurrentSpaceBulkActions | Configuration for bulk actions that can be performed in the space. Defaults to null . | No |
currentBulkAction | CurrentSpaceCurrentBulkAction | The bulk action to apply in the Txn Table section. Defaults to [0] . | No |
currentBulkUser | CurrentSpaceCurrentBulkUser | The bulk user action to apply in the Txn Table section. Defaults to null . | No |
currentView | CurrentSpaceCurrentView | The current view that will be displayed in the Txn Table section. Defaults to [0] . | No |
customCards | CurrentSpaceCustomCards | A list of custom cards to be rendered in the Custom Cards section of the space. Defaults to an empty array [] . | No |
emptyMessage | string | A custom message to be displayed when a Txn query returns no results. Defaults to null . | No |
globalActions | CurrentSpaceGlobalActions | Configuration for global actions within the space. Defaults to null . | No |
globalFilters | CurrentSpaceGlobalFilters | Configuration for global filters applicable in the space. Defaults to null . | No |
hideTasks | CurrentSpaceHideTasks | List of steps and their associated tasks to be hidden from the timeline. | No |
icon | CurrentSpaceIcon | Icon to represent the space. Defaults to static//icon.png if not specified. | No |
invoke | CurrentSpaceInvoke | Configuration for invoking a fluent function within the space. Defaults to null . | No |
jobKeyInfo | CurrentSpaceKeyInfo | A list of key properties for the Job Key Info section of the space. Defaults to an empty array [] . | No |
key | number | Internal unique identifier for the space. Defaults to null . | No |
keyInfo | CurrentSpaceKeyInfo | A list of key properties to be displayed in the Key Info section of the space. Defaults to an empty array [] . | No |
label | GlobalLabel | The label that will be displayed for the current space. | No |
loadQuery | boolean | Whether the Txn Query should be triggered automatically when the space is loaded. Defaults to null . | No |
notesSection | CurrentSpaceNotesSection | Hides the Notes Section | No |
pageSize | CurrentSpacePageSize | The number of items per page in the Txn Query. Defaults to 10 . | No |
permissions | GlobalPermissions | Permissions object that controls access levels for the space. | No |
properties | [ ConfigCurrentSpace ] | Subspaces or nested configurations for the current space. Defaults to null . | No |
rules | GlobalRules | Rules that determine whether the attachments upload button should be shown or hidden. | No |
search | CurrentSpaceSearch | A list of properties that are searchable within the space. Defaults to an empty array [] . | No |
source | string | Sets the source for the current space Possible values: Job Default: null | No |
steps | CurrentSpaceSteps | Configuration for the steps or timeline view within the space. Defaults to an empty array [] . | No |
views | CurrentSpaceViews | A list of views to be displayed in the transaction (Txn) table section. Defaults to an empty array [] . | No |
ConfigEditor
Full configuration object for both global and space-specific settings.
Name | Type | Description | Required |
---|
global | ConfigGlobal | Global configuration settings. | Yes |
messages | ConfigMessages | Optional configuration for custom messages. | No |
spaces | [ ConfigCurrentSpace ] | Array of space-specific configurations. | Yes |
version | | Version information for the configuration. | No |
ConfigGlobal
Global configuration settings that apply across the entire application.
Name | Type | Description | Required |
---|
favicon | string | Path to the favicon to be used globally. Defaults to static//favicon.png . | No |
hideSteps | GlobalHideSteps | List of steps to be hidden from the timeline globally. Defaults to an empty array [] . | No |
logo | string | Path to the logo to be used globally. Defaults to static/logo.png . | No |
mappings | GlobalMappings | Mappings configuration for global use. Defaults to null . | No |
mobileLogo | string | Path to the logo to be used globally. Defaults to static/logo_mobile.png . | No |
modalPopoutDisabled | boolean | Disables the side sheet popout button if set to true . Defaults to false . | No |
theme | Theme | Theme configuration for global appearance settings. Defaults to null . | No |
ConfigMessages
Configuration for custom messages.
Name | Type | Description | Required |
---|
ConfigMessages | object | Configuration for custom messages. | |
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
CurrentSpaceActionCustomProperties
List of custom actions
Name | Type | Description | Required |
---|
CurrentSpaceActionCustomProperties | array | List of custom actions | |
CurrentSpaceActionCustomProperty
Custom Action Property
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 |
CurrentSpaceActionOptions
Object of form attributes
Name | Type | Description | Required |
---|
label | string | | Yes |
value | string | | Yes |
CurrentSpaceActionSingleInvoke
CurrentSpaceActions
List of available actions.
CurrentSpaceAttachments
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 |
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
Show/Hide a global create form action
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 |
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 |
CurrentSpaceCustomCardIframe
CurrentSpaceCustomCardList
CurrentSpaceCustomCardListExtended
CurrentSpaceCustomCardListStacked
CurrentSpaceCustomCardProperty
Name | Type | Description | Required |
---|
columnWrap | GlobalColumnWrap | Sets the column content to not wrap. Possible Values: false | No |
dataIndex | GlobalDataIndex | Sets the path of the Txn property to be displayed. Default: null | No |
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
CurrentSpaceCustomCardTableExtended
CurrentSpaceCustomCardTabs
Sets the customCard tabs properties
CurrentSpaceCustomCardTabsLabel
Sets the label to be used for the custom card tab
Name | Type | Description | Required |
---|
CurrentSpaceCustomCardTabsLabel | string | Sets the label to be used for the custom card tab | |
CurrentSpaceCustomCardTabsProperties
Name | Type | Description | Required |
---|
CurrentSpaceCustomCardTabsProperties | | | |
CurrentSpaceCustomCardTabsPropertiesArray
Name | Type | Description | Required |
---|
CurrentSpaceCustomCardTabsPropertiesArray | array | | |
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 | |
CurrentSpaceDateCreated
Show/Hide a global filter for Date Created
Name | Type | Description | Required |
---|
label | GlobalLabel | Sets a label for the filter. Default: null | Yes |
value | [ string ] | Sets a date range for the filter. Default: null | Yes |
CurrentSpaceFilterBy
Sets the filters to apply to the view.
Default: null
Name | Type | Description | Required |
---|
CurrentSpaceFilterBy | object | Sets the filters to apply to the view. Default: null | |
Used to show/hide the Create Forms button that allows Workspaces users to create new forms using Maestro forms
Name | Type | Description | Required |
---|
label | GlobalLabel | Sets the label for the filter | Yes |
options | [ CurrentSpaceFormOptions ] | List of the forms to select from. | No |
value | | Sets the defaut option for the filter | Yes |
Object of form attributes
Name | Type | Description | Required |
---|
label | string | | Yes |
value | [ string ] | | Yes |
CurrentSpaceGlobalActions
Global actions config
Default: null
CurrentSpaceGlobalFilters
Global filters config
Default: null
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
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 | |
CurrentSpaceNotesSection
Hides the Notes Section
Name | Type | Description | Required |
---|
CurrentSpaceNotesSection | boolean | Hides the Notes Section | |
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 |
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
CurrentSpaceQuickActions
Name | Type | Description | Required |
---|
CurrentSpaceQuickActions | array | | |
CurrentSpaceQuickDecisionValue
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
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
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 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 |
CurrentSpaceView
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). | |
CurrentSpaceViewGrid
The current space grid card config
Default: null
CurrentSpaceViewGridItemsLength
Defines the length of card items. Defaults to 5 5
.
Name | Type | Description | Required |
---|
CurrentSpaceViewGridItemsLength | number | Defines the length of card items. Defaults to 5 5 . | |
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 . | |
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 | |
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 | |
Name | Type | Description | Required |
---|
type | string | Sets the global filter type to input . Possible values: input | Yes |
GlobalFilterOptionsPicker
Name | Type | Description | Required |
---|
options | object | Set the default date range for the date picker. Possible values: minDate, maxDate | No |
type | string | Set the global filter type to be a date picker. Possible values: datepicker ,daterangepicker | Yes |
GlobalFilterOptionsSelect
Name | Type | Description | Required |
---|
options | [ string ] | Sets the options for the select dropdown | No |
type | string | Sets the global filter type Possible values: select, multiselect | Yes |
Sets a format for the data.
Possible values: relative, duration, 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 | | |
The global input
Name | Type | Description | Required |
---|
checked | boolean | | No |
label | string | | Yes |
value | boolean,string | | No |
GlobalInvokeVersionNumber
Name | Type | Description | Required |
---|
GlobalInvokeVersionNumber | | | |
GlobalInvokeVersionNumberDataIndex
GlobalLabel
Sets the label to be used
Name | Type | Description | Required |
---|
GlobalLabel | string | Sets the label to be used | |
GlobalLink
Name | Type | Description | Required |
---|
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 | | |
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 | | |
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 |
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 | | |