Configuration API | Deltek Maconomy

ApplicationConfiguration

The core application configuration is split into four main areas: authentication, platform, shell, and workspace. The entire configuration has an API version used to guarantee compatibliity and enforce upgrades. Finally, the configuration includes a dictionary of the static terms embedded in the web client. These terms are localized before the client receives the configuration from the REST API.

Properties: api, application, platform, shell, workspace

api required

The version of the configuration format that this representation conforms to. Versions follow the SemVer standard.

Type: string

application required

The application version.

Type: ApplicationConfigurationType

platform required

General configuration that spans the entire application

Type: PlatformConfiguration

shell required

The application shell covers the menu, documentation, notifications and auxiliary features such as settings, change password and about information.

Type: ShellConfiguration

workspace required

Configuration of general properties that span all workspaces as well as configuration of individual workspaces in terms of data bindings and layouts.

Type: WorkspaceConfiguration

ActionArgumentsType

Arguments for an action.

This is a map from the argument name to either an expression or template text providing the value of the argument.

Any of the following

Anonymous Object Type

template

TemplateText

Anonymous Object Type

expression

Expression

ActionName

String alias for an action.

ActionOrGroup

No description available

Any of the following

ActionType
IActionGroup

ActionSeparatorType

A separator line for the list of actions.

ActionTableColumnType

No description available

Properties: action

action required

No description available

Type: TableActionColumnType

ActionType

No description available

Any of the following

IWizardInvocationAction
ContainerActionWithWizard
ContainerActionWithoutWizard
ActionName

ActivityFormElementType

No description available

Properties: activity

activity required

No description available

Type: IActivityElement

AddressFieldLineType

No description available

Any of the following

Anonymous Object Type

field

IAddressFieldLine

FieldName

AddressFormElementType

No description available

Properties: address

address required

No description available

Type: IAddressElement

AddressLineType

Represents the type of lines that can be inserted in addresses.

Any of the following

AddressFieldLineType
AddressReferenceLineType
AddressZipCityLineType
AddressLinkLineType

AddressLinkLineType

No description available

Properties: link

link required

No description available

Type: IAddressLinkLine

AddressReferenceLineType

No description available

Properties: reference

reference required

No description available

Type: Any of the following

IAddressReferenceLine
IAddressReferenceWithFieldsLine

AnalyzerReportName

String alias for internal references to an analyzer report.

AnyStyle

No description available

Properties: verticalAlign, fontWeight, textAlign, backgroundColor, color, extends, condition

verticalAlign

No description available

Type: VerticalAlignType

fontWeight

No description available

Type: string

textAlign

No description available

Type: TextAlignType

backgroundColor

Either a standard Web color or a reference to a named color

Type: Any of the following

Color
QualifiedPaletteItemName

color

Either a standard Web color or a reference to a named color

Type: Any of the following

Color
QualifiedPaletteItemName

AssistantHelpTemplate
AssistantHelpDocument

AssistantHelpDocument

The name of the help document to be displayed.

The document must be defined in the "HelpDocumentArchive" container.

AssistantHelpTemplate

No description available

Properties: pane, template

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

template required

The markdown attribute should be use in displaying help containing Markdown tags to the user. The template can contain placeholders that will be replaced with the actual values.

Type: TemplateText

AssistantName

String alias for a workspace assistant name.

AssistantSelectorType

No description available

Any of the following

AssistantName
Anonymous Object Type

condition	Expression
ref	AssistantName

Anonymous Object Type

condition	Expression
pane	PaneName
expanded	BooleanValue
size	AssistantSize
layout	IAssistantLayout
conversation	IAssistantConversation
document	IAssistantDocument
help	AssistantHelp

AssistantSize

No description available

BadgeStatusType

Represents the additional badge status types. The type indicates badge color that will be used, e.g. 'info' is typically a blue color and 'danger' as red color.

BinaryOperatorType

No description available

BindingType

No description available

Any of the following

mount
with
link
IForeignKeyBinding
IMountBinding
ILinkBinding
IDocumentBinding

BooleanGroupElementType

No description available

Properties: booleanGroup

booleanGroup required

No description available

Type: IBooleanGroupElement

BooleanValue

Boolean value that will in time be converted to a full expression

Any of the following

boolean
true
false

CalendarSettings

No description available

Properties: firstDayOfWeek

firstDayOfWeek required

Controls the first day of the week.

Type: Any of the following

string
FirstDayOfWeek

Chart

No description available

Any of the following

Anonymous Object Type

height	number
legend	Any of the following ILegendOptions boolean
palette	PaletteName
yAxis	Any of the following IAxis Array<IAxis>
xAxis	Any of the following IAxis Array<IAxis>
type	`line`
series	Array<IChartSeries>

Anonymous Object Type

height	number
legend	Any of the following ILegendOptions boolean
palette	PaletteName
yAxis	Any of the following IAxis Array<IAxis>
xAxis	Any of the following IAxis Array<IAxis>
type	`bar`
series	Array<IBarChartSeries>
stacking	string

Anonymous Object Type

height	number
legend	Any of the following ILegendOptions boolean
palette	PaletteName
yAxis	Any of the following IAxis Array<IAxis>
xAxis	Any of the following IAxis Array<IAxis>
type	`column`
series	Array<IBarChartSeries>
stacking	string

Anonymous Object Type

height	number
legend	Any of the following ILegendOptions boolean
palette	PaletteName
yAxis	Any of the following IAxis Array<IAxis>
xAxis	Any of the following IAxis Array<IAxis>
type	`area`
series	Array<IChartSeries>
stacking	string

Anonymous Object Type

height	number
legend	Any of the following ILegendOptions boolean
palette	PaletteName
type	`pie`
series	Array<IChartSeries>

Anonymous Object Type

height	number
legend	Any of the following ILegendOptions boolean
palette	PaletteName
yAxis	Any of the following IAxis Array<IAxis>
xAxis	Any of the following IAxis Array<IAxis>
type	`bar-with-negative-series`
series	Array<IChartSeries>

Anonymous Object Type

height	number
legend	Any of the following ILegendOptions boolean
palette	PaletteName
type	`pyramid`
series	Array<IChartSeries>

Anonymous Object Type

height number

legend

Any of the following

ILegendOptions
boolean

palette PaletteName

type funnel

series Array<IChartSeries>

neck

Anonymous Object Type

width	number
height	number

Anonymous Object Type

height number

palette PaletteName

yAxis

Any of the following

IAxis
Array<IAxis>

type solidgauge

series Array<IChartSeries>

regions

Array<Anonymous Object Type

start	number
end	number
color	string

range

Anonymous Object Type

min	number
max	number

unit string

size

Any of the following

sm
md
lg
SolidGaugeSize

ChartData

Represents a list of values to be used as a data series, titles or categories.

The list of values can be specified directly - by providing an array containing a complete list of values, or indirectly - by providing an expression that will be evaluted for each record in a pane.

Any of the following

Array<DataPoint>
DataProvider

CollapsibleOptions

Configuration of a collapsible layout part.

Properties: expanded

expanded required

Determines whether the default state of a collapsible layout part if collapsed or expanded. If false, the layout part is collapsed when rendered initially.

Default Value: true

Type: BooleanValue

Color

A color is eiher a reference to a palette item, e.g., "palette1.item2", or a standard web color such as a hex triplet, an RGB value or a named HTML color.

Any of the following

QualifiedPaletteItemName
string

ColorRegistry

No description available

Map from string to string

ColumnChooser

No description available

Any of the following

Expression
Array<TableColumnType>
IColumnChooser
IConditionalColumnChooser

ColumnName

A name of a column in an Analyzer report.

ColumnType

No description available

Any of the following

ILayoutColumn
IConversationColumn
IElementColumn
IKpiColumn
IChartColumn
ICalendarColumn

ContainerActionWithoutWizard

No description available

Properties: arguments, visible, title, confirmation, source

arguments

The arguments to be passed to the action.

Type: ActionArgumentsType

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

confirmation

Specifies whether a confirmation dialog should be shown before running this action.

If set to true, then a confirmation dialog with a standard message will be shown. If set to a string, then a confirmation dialog with the given text (e.g. "Are you sure?") will be shown. If not specified or set to false, then no confirmation dialog will be shown.

Type: boolean,string

source required

The name of the action to be shown.

Type: ActionName

ContainerActionWithWizard

No description available

Properties: wizard, visible, title, confirmation, source

wizard required

A wizard that will be shown when this action is clicked.

Type: IWizardInvocation

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

confirmation

Specifies whether a confirmation dialog should be shown before running this action.

Type: boolean,string

source required

The name of the action to be shown.

Type: ActionName

ContainerName

The name of a backend container accessible through the REST API.

ContainerParameterType

No description available

Any of the following

IUrlContainerParameter
IExpressionContainerParameter

Containers

Represents a hierarchy of container configurations

Any of the following

IContainerNode
IContainerLeaf

ContainerSpecificationType

No description available

Any of the following

IContainerSpecification
IDocumentPaneSpecification
IAnalyzerPaneSpecification
IInMemoryCardPaneSpecification

ConversationFieldReference

No description available

ConversationTypes

No description available

Map from string to IConversationType

DataPoint

Represents a single data value.

The value can be specified either as an expression or a template string. Expressions will be evaluated using the currently selected record in any referenced pane.

Any of the following

Expression
ValueExpression
TemplateExpression

DataProvider

Represents a list of values constructed by iterating over records in a pane.

The value can be specified either as an expression or a template string. Expressions will be evaluated for each record in the given pane (specified using the pane attribute). If no pane is specified, then the pane that is currently in scope for this chart will be used.

Note that, apart form the iterated pane, any other pane in the workspace, excluding descendant panes of the iterated pane, may be referenced in the expression. In such a case, values from the currently selected record in that pane will be used.

Any of the following

Anonymous Object Type

pane	PaneName
value	Expression

Anonymous Object Type

pane	PaneName
template	TemplateText

DateTimeField

A string with the name of a "datetime" field, or an object where the "date" and "time" field names are specified separately.

Any of the following

FieldName
IDateTimeSources

DecimalSeparator

Possible decimal separator characters.

DefaultWorkspaceCandidate

No description available

Any of the following

IDefaultWorkspaceCandidate
WorkspaceName

DialFormElementType

No description available

Properties: dial

dial required

No description available

Type: IDialElement

DocumentationType

No description available

Any of the following

IDocumentationItem
IDocumentationSection

EnterTransitionActionType

No description available

Any of the following

IInitAction
INavigateAction
IAssignAction

ExitTransitionActionType

No description available

Any of the following

ICreateAction
IUpdateAction
IDeleteAction
ISaveAction
IApplicationAction
INavigateAction
IRevertAction
IAssignAction

Expression

String alias for an expression.

ExtendedRowType

No description available

Any of the following

RowType
IScopeRow
ISidePanelRow
IAssistantRow

FieldFormElementType

No description available

Any of the following

Anonymous Object Type

field

IFieldElement

FieldName

FieldName

String alias for field source/model names.

FieldSearchType

Configuration of the search capabilities available for a field.

The following values may be specified:

true, indicating that the searching should be enabled for this field using the standard search layout,
a search layout name, indicating that searching should be enabled, and the named search layout should be applied,
an object with a detailed configuration for this search,
false, indicating that the field should not be searchable.

Any of the following

boolean
LayoutName
IFieldSearchConfiguration

FieldTableColumnType

No description available

Any of the following

Anonymous Object Type

field

ITableFieldColumn

FieldName

FileSizeTableColumnType

No description available

Properties: fileSize

fileSize required

No description available

Type: ITableFileSizeColumn

FilterAsTableFieldConfiguration

No description available

Any of the following

IMappedFilterAsTableField
IFilterOnlyFilterAsTableField

FirstDayOfWeek

No description available

Properties: day, fixed

day required

Controls the first day of the week.

Type: string

fixed required

When the first day of week is fixed, users are not allowed to change the value via My Settings.

Default Value: false

Type: BooleanValue

ForeignKeyConfiguration

No description available

Properties: controls

controls

Specifies that the values selected through this foreign-key "control" the values which may be selected via the listed foreign-keys.

If the value selected through this foreign-key changes or is cleared, then the fields associated with the listed foreign-keys will be cleared. On the other hand, if any of the values selected through the listed foreign-keys are cleared, then the value selected through this foreign-key will be kept.

For example, consider two foreign-keys:

the controlling foreign-key "List", which lets the user select an option list,
the controlled foreign-key "Value", which lets the user select a value from that option list. If the selection for "List" is cleared or changed, then all the fields associated with "Value" will be cleared. On the other hand, if the selection in "Value" is cleared, then the value selected in "List" will be kept.

Type: Array<ForeignKeyName>

ForeignKeyName

String alias for foreign keys.

FormElementType

Represents the type of element that can be inserted in forms.

Any of the following

ActivityFormElementType
AddressFormElementType
DialFormElementType
FieldFormElementType
IntervalFormElementType
PairFormElementType
LinkFormElementType
ReferenceFormElementType
StatusFormElementType
TextFormElementType
UnitFieldFormElementType
AmountFormElementType
PercentFormElementType
ZipCityFormElementType
BooleanGroupElementType
RadioFormElementType

GlobalCurrencyDisplayType

No description available

Any of the following

LocalCurrencyDisplayType
none

Grid

No description available

Any of the following

IGrid
Array<GridLineOrSection>

GridAmountCellType

No description available

Properties: amount

amount required

No description available

Type: IGridAmountCell

GridCell

Represents the type of cell that can be inserted in grids.

Any of the following

GridFieldCellType
GridLinkCellType
GridTextCellType
GridUnitFieldCellType
GridAmountCellType
GridPercentCellType
GridEmptyCellType

GridEmptyCellType

No description available

Any of the following

{ }
Anonymous Object Type

empty

IGridEmptyCell

GridFieldCellType

No description available

Any of the following

FieldName
Anonymous Object Type

field

IGridFieldCell

GridHeaderLine

No description available

Any of the following

IGridHeaderLine
IGridHeaderLineShorthand

GridLine

No description available

Any of the following

GridHeaderLine
GridSectionLine

GridLineOrSection

No description available

Any of the following

GridLine
IGridSection

GridLinkCellType

No description available

Properties: link

link required

No description available

Type: IGridLinkCell

GridPercentCellType

No description available

Properties: percent

percent required

No description available

Type: IGridPercentCell

GridSectionLine

No description available

Any of the following

IGridNormalLine
IGridTotalLine

GridTextCellType

No description available

Properties: text

text required

No description available

Type: IGridTextCell

GridUnitFieldCellType

No description available

Properties: unitField

unitField required

No description available

Type: IGridUnitFieldCell

GroupSeparator

Possible digit grouping separator characters.

IActionAttachmentConfiguration

No description available

Properties: required, allowMultipleAttachments

required required

This flag specifies if file attachments are required for this action.

Type: boolean

allowMultipleAttachments

This flag specifies if multiple attachments are valid for this action. Note that the action will be executed once for every attachment.

For example, this flag could be set to true for the action AttachDocument in the ExpenseSheets container, as calling this action multiple times with new files will simply attach more files to the same expense sheet.

On the other hand, this flag should be false for the action ImportDocument in the table part of DocumentArchives, as running that action more than once will replace the document previously attached to the line.

Default Value: false

Type: boolean

IActionConfiguration

No description available

Properties: attachments, parameters

attachments

Specifies whether attachments (i.e. file uploads) should be available for this action.

Type: IActionAttachmentConfiguration

parameters

Specifies fields which act as parameters to this action. The values of these fields will be transmitted as singleton parameters when the action is executed.

Only fields from the card pane can be specified. The listed field names must be mapped to singleton identifiers in the card pane's singletonIdentifiers attribute.

This property is only relevant for CWSv1.

Type: Array<FieldName>

IActionGroup

No description available

Properties: visible, title, actions

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

actions required

No description available

Type: Array<ActionType>

IActionsRow

Represents a row containing actions.

Properties: pane, title, actions, workspaceActions

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

actions

The actions to be shown in this action row.

Type: Array<ActionOrGroup>

workspaceActions

Show workspace actions (such as edit, save, revert) in this actions row.

Type: boolean

IActivityElement

The activity element represents user and date values with an associated color.

Properties: appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, user, date, color

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.

Type: string

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

lines required

An array of the lines contained within the address.

Type: Array<AddressLineType>

IAddressFieldLine

The address field lines.

Properties: appearance, title, titleValue, titleSource, label, mandatory, open, autoSubmit, source, search, widget, shadowTitle

appearance

An optional property which determines how an address line is displayed.

Default Value: maximized

Type: AppearanceType

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

IAddressLinkLine

The address link element represents a link that can navigate to a specified URL.

Properties: alt, label, template, icon, authentication, url, workspace, mail, query, mandatory, open, visible

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

IAddressReferenceLine

The address reference lines.

Properties: mandatory, open, visible, description, key, foreignKey, search

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

description

No description available

Type: Any of the following

FieldName
IInputBlock

key

No description available

Type: Any of the following

FieldName
IInputBlock

foreignKey required

No description available

Type: string

search

The configuration of the search capabilities available for this foreign-key.

If this property is not specified, then searching will be enabled for this foreign-key (provided that this foreign-key supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

IAddressReferenceWithFieldsLine

The address reference lines.

Properties: mandatory, open, visible, description, key

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

description required

No description available

Type: Any of the following

FieldName
IInputBlock

key required

No description available

Type: Any of the following

FieldName
IInputBlock

IAddressZipCityLine

The address zip-city lines.

Properties: mandatory, open, visible, zip, city, zipFirst

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

zip required

No description available

Type: Any of the following

FieldName
IInputBlock

city required

No description available

Type: Any of the following

FieldName
IInputBlock

zipFirst

No description available

Type: boolean

IAdvancedSearchLayout

The advanced search part of a search layout.

Properties: title, restriction, columns, columnChooser

title

A title for the advanced search pane.

Type: LocalizableText

restriction

A base restriction to be applied to limit the search results in addition to any restrictions defined elsewhere.

Type: Expression

columns required

The columns to be shown in the list of search results.

Type: Array<TableColumnType>

columnChooser

The column chooser for this search layout.

Type: ColumnChooser

IAlert

Configuration of the alert component.

Properties: pane, template, visible, title, icon, color

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

template required

The template text for the alert component.

Type: TemplateText

visible

An optional visibility expression for the alert component.

Type: Expression

title

An optional title for the alert component.

Type: LocalizableText

icon

An optional icon for the alert component.

Type: IconName

color required

Color for the alert component.

Type: Color

IAlertRow

Represents a row containing an alert component.

Properties: island, style, label, collapsible, pane, title, alert

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

collapsible

The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

alert required

An alert component.

Type: IAlert

IAmountElement

The currency element represents a field element with a currency describing the data of the field.

Properties: style, format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, currency, appearance, rendering, title, titleValue, titleSource, visible

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
textAlign	TextAlignType
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
textAlign	TextAlignType
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;)&gt;</a>

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

label

Type: string

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

currency required

No description available

Type: FieldName

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

IAmountFormat

No description available

Properties: short, currencyDisplay

short

True if short formatting should be applied, or specify a precise number of characters.

Type: Any of the following

boolean
Anonymous Object Type

precision

number

currencyDisplay

An optional property describing how to display the currency. It can either be displayed as a symbol, e.g., '$', as a code, e.g., 'USD', or not shown at all.

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

analyzer required

The name of the analyzer report.

Type: AnalyzerReportName

IAnalyzerPaneProjection

No description available

Properties: defaultLevelName, fields

defaultLevelName

The default report level to be used for a report column if no level name is explicitly specified for that column.

Type: LevelName

fields required

A mapping between field names in a container-based pane and columns in an Analyzer report.

This mapping defines which columns will be exposed as fields in the container-based pane for this report.

Type: IProjectedFields

IAnalyzerPaneSource

The definition of an Analyzer report to be executed.

Properties: template, columnTree, rowRestrictions, limit, cache

template required

The Analyzer report template underlying this report.

Type: string

columnTree required

The columns to be selected from the report template.

Type: ReportLevelType

rowRestrictions

The restrictions to be applied to the data.

Restrictions in this list are combined using a logical conjunction (i.e. a logical "and").

Type: Array<IReportRowRestriction>

limit

The maximum number of data rows to load.

If not specified, then all rows in the report are loaded.

Type: number

cache

Options related to caching of Analyzer reports.

Type: Anonymous Object Type

projection required

A mapping of fields from the Analyzer report into a container-based pane.

Type: IAnalyzerPaneProjection

orderBy

Defines the default sorting order for this pane.

Type: Array<IOrderBy>

IApplicationAction

Executes an application action.

Properties: action

action required

An action name qualified with a pane name. For example: EmployeeCard.Submit

Type: Any of the following

ActionName
IApplicationActionDefinition

IApplicationActionDefinition

No description available

Properties: source, arguments

source required

An action name qualified with a pane name. For example: EmployeeCard.Submit

Type: ActionName

arguments

Type: PaneName

expanded

Determines whether the default state of the assistant is collapsed or expanded. If true, the assistant is expanded when rendered initially.

Default Value: false

Type: BooleanValue

size

The size of the assistant. The size determines the width of the assistant.

sm - approx. 20% of the workspace area width md - approx. 40% of the workspace area width lg - approx. 60% of the workspace area width

Default Value: md

Type: AssistantSize

layout

An optional layout view for the workspace assistant.

Type: IAssistantLayout

conversation

An optional conversation view for the workspace assistant.

Type: IAssistantConversation

document

An optional document view for the workspace assistant.

Type: IAssistantDocument

help

An optional documentation view for the workspace assistant.

Type: AssistantHelp

IAssistantConversation

No description available

Properties: pane, title, relationName, conversationType, objectInstanceKey

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

relationName required

The internal name of the database relation to which the conversation is attached.

For example: "JobHeader".

Type: string

conversationType required

The conversation type.

For example: "Job".

Type: string

objectInstanceKey required

The instance key of the object associated with the conversation.

For example: "JobsFilter.InstanceKey".

Type: Expression

IAssistantDocument

No description available

Properties: pane

pane required

The pane used to resolve unqualified references in this scope.

Type: PaneName

IAssistantLayout

No description available

Properties: pane, title, actions, record, rows

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title required

An mandatory, localizable title.

Type: LocalizableText

actions

The actions to be shown in this workspace assistant.

Type: Array with any of the following

* <a href="#actiontype">ActionType</a>
* <a href="#iactiongroup">IActionGroup</a>

record

The record heading area should communicate the overall data entity of the workspace assistant. This should contain the primary identifier of the currently shown data entity.

Type: IRecordHeading

rows required

The main body of a workspace assistant consists of an array of layout rows.

Type: Array<RowType>

IAssistantRegistry

A registry of assistants defined for a workspace.

Map from string to IAssistant

IAssistantRow

An assistant within this workspace or tab.

Properties: assistant

assistant required

No description available

Type: Any of the following

AssistantSelectorType
Array<AssistantSelectorType>

IStatusElement
BadgeStatusType

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

booleanFields required

No description available

Type: Array with any of the following

* <a href="#fieldname">FieldName</a>
* <a href="#ibooleangroupfieldelement">IBooleanGroupFieldElement</a>

IBooleanGroupFieldElement

No description available

Properties: title, titleValue, titleSource, label, mandatory, open, autoSubmit, source, search, widget, shadowTitle

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

ICalendarColumn

Represents a Calendar column. A Calendar column contains vital data point of interests.

Properties: island, label, visible, span, offset, pane, title, calendar

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

label

Type: string

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

span

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

No description available

Type: Anonymous Object Type

title	LocalizableText
start	FieldName
end	FieldName

period required

No description available

Type: Anonymous Object Type

title	LocalizableText
start	FieldName
end	FieldName

workingdays

No description available

Type: FieldName

highlightSelectedDate

No description available

Type: boolean

navigationPeriod

No description available

Type: ICalendarNavigationPeriod

showSelectionPeriod

No description available

Type: boolean

ICalendarNavigationPeriod

daily - we navigate on a day by day basis (default) period - we use the periodStart and periodEnd fields

ICancelTransition

No description available

Properties: title, visible, actions

title

The title of the dedicated cancel button.

Default Value: Cancel

Type: string

visible

Specifies if a dedicated cancel button should be shown. If false, then the wizard can still be cancelled by pressing Escape or clicking on the "x" icon in the corner of the wizard window.

Type: boolean

actions

A list of actions to perform upon activating this transition.

Type: Array<ExitTransitionActionType>

ICardPaneConfiguration

No description available

Properties: minimalFields, dataChangedCheck, cacheInitResponse, actions, foreignKeys, stateParameters, navigationParameters, refreshAfterActions

minimalFields

Specifies the minimal set of fields that should be loaded for this pane.

Type: Array<FieldName>

dataChangedCheck

Specifies settings for a client-side data-changed check on this pane.

The data-changed check on the client side is performed when a container instance needs to be reestablished.

Type: Anonymous Object Type

excludedFields

Array<FieldName>

cacheInitResponse

Specifies whether caching of init responses is allowed for this pane.

If set to true, then init responses will be cached; when set to false, they will not be cached. If not specified, the default behavior is to cache init responses.

Type: boolean

actions

Additional configuration for actions in this pane.

Any application action, such as "SubmitExpenseSheet", "ApproveAbsenceEntry", etc., may be configured here. It is also possible to configure the following standard actions:

"create" - for saving new records,
"update" - for saving existing records.

Type: IActionConfiguration

foreignKeys

Additional configuration for foreign-keys.

Type: ForeignKeyConfiguration

stateParameters

Specifies state parameter fields for this container.

State parameters are fields in the card part of a container that are not persisted on the server side, but are important to the internal state of the container and need to be set to their previous values when a container instance is restored.

Type: Array<FieldName>

navigationParameters

Specifies navigation parameter fields for this container.

Navigation parameters are fields in the card part of a container that control the internal navigation state of the container. In particular, they control the resource which will be the target of actions performed on this container.

Fields defined as navigation parameters cannot be changed together with any other fields in the workspace.

Type: Array<FieldName>

refreshAfterActions

Specifies actions which require the container to be re-read after they are executed.

Some container card actions can have side effects causing the card record to vanish. This behavior might not be reported correctly through the REST API. Listing such actions using this property lets the client handle them correctly.

For example, the action printinvoice could be listed for the invoiceediting container.

Type: Array<string>

IChartColumn

No description available

Properties: info, island, visible, span, offset, pane, title, chart

info

Configuration for the info-bubble tooltip for the row

Type: Any of the following

TemplateText
LimitedInfoBubble

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

visible

condition

No description available

Type: Expression

columns required

A list of columns available in the column chooser

Type: Any of the following

Array<TableColumnType>
all

IConditionalClause<ImageType>

No description available

Any of the following

Anonymous Object Type

url	URLElement
query	Array<IQueryElement>
condition	Expression

Anonymous Object Type

template	TemplateText
condition	Expression

Anonymous Object Type

icon	IconName
condition	Expression

IConditionalClause<NonConditionalRow>

No description available

Any of the following

Anonymous Object Type

info	Any of the following TemplateText LimitedInfoBubble
island	boolean
format	TypeSpecificFormat
mandatory	Expression
open	Expression
rendering	IRendering
style	Any of the following `{ }` StyleName IFirstMatchSelector<any> Array with any of the following `{ }` IFirstMatchSelector<any>
label	string
collapsible	Any of the following BooleanValue CollapsibleOptions
pane	PaneName
title	LocalizableText
elements	Array<FormElementType>
condition	Expression

Anonymous Object Type

info	Any of the following TemplateText LimitedInfoBubble
island	boolean
format	TypeSpecificFormat
mandatory	Expression
open	Expression
rendering	IRendering
style	Any of the following `{ }` StyleName IFirstMatchSelector<any> Array with any of the following `{ }` IFirstMatchSelector<any>
label	string
splitter	Any of the following BooleanValue SplitterOptions
collapsible	Any of the following BooleanValue CollapsibleOptions
pane	PaneName
title	LocalizableText
columns	Array<ColumnType>
condition	Expression

Anonymous Object Type

format	TypeSpecificFormat
island	boolean
style	Any of the following `{ }` StyleName IFirstMatchSelector<any> Array with any of the following `{ }` IFirstMatchSelector<any>
label	string
collapsible	Any of the following BooleanValue CollapsibleOptions
pane	PaneName
title	LocalizableText
table	ITable
condition	Expression

Anonymous Object Type

island	boolean
style	Any of the following `{ }` StyleName IFirstMatchSelector<any> Array with any of the following `{ }` IFirstMatchSelector<any>
label	string
collapsible	Any of the following BooleanValue CollapsibleOptions
pane	PaneName
noTabsTitle	LocalizableText
tabs	Array<ITab>
condition	Expression

Anonymous Object Type

format	TypeSpecificFormat
island	boolean
mandatory	Expression
open	Expression
rendering	IRendering
style	Any of the following `{ }` StyleName IFirstMatchSelector<any> Array with any of the following `{ }` IFirstMatchSelector<any>
label	string
collapsible	Any of the following BooleanValue CollapsibleOptions
pane	PaneName
title	LocalizableText
grid	Grid
condition	Expression

Anonymous Object Type

island	boolean
style	Any of the following `{ }` StyleName IFirstMatchSelector<any> Array with any of the following `{ }` IFirstMatchSelector<any>
label	string
collapsible	Any of the following BooleanValue CollapsibleOptions
pane	PaneName
title	LocalizableText
document	IDocument
condition	Expression

Anonymous Object Type

island boolean

style

Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label string

collapsible

Any of the following

BooleanValue
CollapsibleOptions

pane PaneName

title LocalizableText

conversation

Anonymous Object Type

height	number
pane	PaneName
title	LocalizableText
relationName	string
conversationType	string
objectInstanceKey	Expression

condition Expression

Anonymous Object Type

island	boolean
style	Any of the following `{ }` StyleName IFirstMatchSelector<any> Array with any of the following `{ }` IFirstMatchSelector<any>
label	string
collapsible	Any of the following BooleanValue CollapsibleOptions
pane	PaneName
title	LocalizableText
embed	IEmbed
condition	Expression

Anonymous Object Type

island	boolean
style	Any of the following `{ }` StyleName IFirstMatchSelector<any> Array with any of the following `{ }` IFirstMatchSelector<any>
label	string
collapsible	Any of the following BooleanValue CollapsibleOptions
pane	PaneName
title	LocalizableText
scheduler	IScheduler
condition	Expression

Anonymous Object Type

island	boolean
style	Any of the following `{ }` StyleName IFirstMatchSelector<any> Array with any of the following `{ }` IFirstMatchSelector<any>
label	string
collapsible	Any of the following BooleanValue CollapsibleOptions
pane	PaneName
title	LocalizableText
alert	IAlert
condition	Expression

IConditionalClauses<ImageType>

Conditional clauses *

Any of the following

Array<IConditionalClause<ImageType>>
IConditionalClause<ImageType>

IConditionalClauses<NonConditionalRow>

Conditional clauses *

Any of the following

Array<IConditionalClause<NonConditionalRow>>
IConditionalClause<NonConditionalRow>

IConditionalColumnChooser

A list of layout rows with conditions.

The first layout row whose condition evaluates to true, otherwise the first with no condition specified, will be shown. If no matching row is found, then nothing is shown.

Type: IConditionalClauses<NonConditionalRow>

No description available

Properties: container, searchLayouts

container required

A search container associated with a search layout.

In the expanded notation, both a container name and a family needs to be specified, whereas, in the short form, the family is assumed to be maconomy.

Type: Any of the following

IContainer
ContainerName

searchLayouts required

Named search layouts for the specified search container.

Specifies extra fields that should be loaded for this pane, in addition to any fields referenced in the layout.

Type: Any of the following

Array<FieldName>
IFieldAndForeignKeySelection

paging

Controls the number of records loaded into this pane.

Type: IPagingConfiguration

sharedRecord

Enables record sharing for this pane.

When this property is set to some string (the sharing key), then the record selected in this pane will be shared with other panes that use the same key. If you switch between workspaces where panes use the same sharing key, the same record as was selected in one workspace will be automatically selected in others.

Note that this property only takes effect for panes of type "search-filter". All panes using the same sharing key must be defined on the same container - it is not allowed to share records between panes using different containers.

Type: string

IContainerSpecificationPaneType

No description available

IConversationColumn

Represents a conversation column.

Properties: island, style, label, visible, collapsible, span, offset, pane, title, conversation

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

span

Please note: Spans of 1 is default and not necessary to write. The total span cannot exceed 12 columns. The total span should be a factor of 12, e.g. 1,2,3,4,6,12

Type: number

offset

Column offset.

Type: number

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

conversation required

A conversation component.

Type: Anonymous Object Type

height	number
pane	PaneName
title	LocalizableText
relationName	string
conversationType	string
objectInstanceKey	Expression

IConversationConfiguration

Configuration of the conversation functionality.

Properties: enabled, refreshInterval, employeeLookup, conversationTypes

enabled required

Determines if the conversation functionality is enabled.

For example: "true".

Type: Expression

refreshInterval required

The refresh interval in seconds.

The list of unread messages in the message center component is automatically refreshed once per this time interval.

For example: 60 indicates that the refresh happens every minute.

Type: number

employeeLookup

Configuration properties related to looking up employees for mentioning in messages.

Type: Anonymous Object Type

restriction	Expression
limit	number

conversationTypes required

A mapping between conversation types and workspaces supporting these conversations.

This mapping is used by the message center to open a workspace associated with a conversation, and to navigate to a record to which the conversation is attached.

Type: ConversationTypes

IConversationRow

Represents a row containing a conversation component.

Properties: island, style, label, collapsible, pane, title, conversation

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

conversation required

A conversation component.

Type: Anonymous Object Type

height	number
pane	PaneName
title	LocalizableText
relationName	string
conversationType	string
objectInstanceKey	Expression

limit

The maximum number of supported lines to export

IInfoBubbleDefinition
IInfoBubbleReference

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

label

Type: string

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

visible

A visibility predicate determining whether this layout part is shown.

Type: Expression

title required

No description available

Type: TemplateText

url required

No description available

Type: TemplateText

icon

No description available

Type: IconName

IDocumentationSection

No description available

Properties: visible, items

visible

IDocumentRow

Represents a row containing a data viewer.

Properties: island, style, label, collapsible, pane, title, document

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

document required

A document viewer.

Type: IDocument

IElementColumn

Represents a layout column which contain elements.

Properties: info, island, format, mandatory, open, rendering, style, label, visible, collapsible, span, offset, pane, title, elements

info

Configuration for the info-bubble tooltip for the row

Type: Any of the following

TemplateText
LimitedInfoBubble

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

format

Assign formatting by data type

Type: TypeSpecificFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

span

Please note: Spans of 1 is default and not necessary to write. The total span cannot exceed 12 columns. The total span should be a factor of 12, e.g. 1,2,3,4,6,12

Type: number

offset

Column offset.

Type: number

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

elements required

An array of the elements contained in this scope

Type: Array<FormElementType>

IElementRow

Represents a row that contains a single element column.

Properties: info, island, format, mandatory, open, rendering, style, label, collapsible, pane, title, elements

info

Configuration for the info-bubble tooltip for the row

Type: Any of the following

TemplateText
LimitedInfoBubble

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

format

Assign formatting by data type

Type: TypeSpecificFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

elements required

An array of the elements contained in this scope

Type: Array<FormElementType>

IEmbed

Configuration of the embedded iframe component.

Properties: height, pane, title, authentication, url, query, externalLink, refresh, permissions

height

An optional height. If unspecified, no height will be set for the part.

Type: number

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

authentication

An optional authentication method for single sign-in to an external component.

Type: IURLAuthenticationMethod

url required

The URL hosting the external component.

Type: URLElement

query

An optional set of query parameters to qualify the URL.

Type: Array<IQueryElement>

externalLink

An optional link to display the url in an external browser window or tab. If this property is not specified, then it defaults to true.

Type: boolean

refresh

An optional property which allow the refresh of the iframe to be triggered by data bindings or field changes. If this property is not specified, or is empty, refresh functionality is not enabled.

Type: IRefreshTrigger

permissions

An optional OK list which implements sandbox security on an iFrame. If not specified, no security restrictions are implemented. If it is empty it means ALL security restrictions for the iFrame are implemented. Adding attributes to the permissions OK list will allow certain permissions

Type: Array<iFramePermissions>

IEmbeddedRow

Represents a row containing an external 3rd-party component embedded as an iframe.

Properties: island, style, label, collapsible, pane, title, embed

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

The name of the enum.

Type: string

family required

The family where the enum is defined.

Type: string

IEnums

A list of client-side enumeration type definitions.

Map from string to IEnumDefinition

IEnumValue

No description available

Properties: title, value

title required

The title of this enumeration value.

Type: LocalizableText

value required

The identifier of this enumeration value.

Type: string

IEventColor

No description available

Properties: source

source required

The source to get color from. Should be a field of the type 'pp:color'.

Type: FieldName

IExitTransition

An exit transition defines a route a user can take to move to another state in a wizard.

This transition is shown as a button in the user-interface.

Properties: title, enabled, visible, actions, target

title required

The title of the button.

Type: LocalizableText

enabled

A condition specifying when this transition is enabled. The button corresponding to this transition will be shown as disabled if the expression evaluates to false. If omitted, the transition will be enabled.

Type: Expression

visible

A condition specifying when this transition is visible. The button corresponding to this transition will be hidden if the expression evaluates to false. If omitted, the transition will be visible.

Type: Expression

actions

A list of actions to perform upon activating this transition.

Type: Array<ExitTransitionActionType>

target

The name of the state that will be activated when this transition is taken. If this property is omitted, then taking this transition will terminate the wizard.

Type: StateName

IExpressionContainerParameter

Maps a field in a container to an expression.

The expression can refer to fields in any pane in the workspace, except for the pane on which this expression is defined and its descendants.

Type: Any of the following

Anonymous Object Type

condition	Expression
textAlign	TextAlignType
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
textAlign	TextAlignType
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;)&gt;</a>

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

label

Type: string

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

LayoutName
ILayoutNameAndParameters

autocomplete

Determines whether autocompletion should be enabled or disabled for this field.

If this property is set to false (or to an expression that evaluates to false), then values typed into the field will not be automatically completed when they match a unique search result.

This property can be set to a boolean value, or to an expression that evaluates to a boolean value.

Default Value: true

Type: Any of the following

boolean
Expression

IFilterAsTablePaneConfiguration

No description available

Properties: actions, foreignKeys, fields

actions

Additional configuration for actions in this pane.

Any application action, such as "SubmitExpenseSheet", "ApproveAbsenceEntry", etc., may be configured here. It is also possible to configure the following standard actions:

"create" - for saving new records,
"update" - for saving existing records.

Type: IActionConfiguration

foreignKeys

Additional configuration for foreign-keys.

Type: ForeignKeyConfiguration

fields

Configuration of additional fields for the filter-as-table pane.

By default, filter-as-table includes only fields that have the same name and type in the filter pane as in the card pane. However, additional fields can be configured:

If a field from the filter pane exists has a corresponding field in the card pane, but with a different name, then a mapping between the names can be defined. 2) If a field is available in the filter pane only, then such a field can be shown as a read-only field in the filter-as-table pane.

This property maps field names from the filter pane (which are also the names used in the filter-as-table pane) to a configuration of each field.

Type: FilterAsTableFieldConfiguration

IFilterNavigation

No description available

Properties: pane, type, shadowTitle, query, selection

pane required

The pane used to resolve unqualified references in this scope.

Type: PaneName

type required

discriminant

Type: filter

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

query required

A list of field names or elements to search in when a value is typed into the search filter.

Type: Anonymous Object Type

select	Array<SearchResultType>
where	Array<FieldName>

selection

No description available

Type: IFilterSelection

IFilterOnlyFilterAsTableField

Defines a filter field that has no corresponding card field.

Properties: immutable

immutable required

Type: Array<Anonymous Object Type

The container whose filter pane will be used to provide the search results.

If no family is specified, the maconomy family is used by default.

Type: Any of the following

ContainerName
IForeignKeyContainer

restriction

An optional restriction to apply to the search.

Type: Expression

IForeignKeySearchViaForeignKey

A foreign-key search that will use a foreign-key defined in the filter pane of the named container to obtain the list of values.

Properties: type, foreignKey, container, restriction

type required

No description available

Type: foreign-key

foreignKey required

The foreign-key to use when performing the search.

Type: ForeignKeyName

container required

The container where the foreign-key is defined in the filter pane.

If no family is specified, the maconomy family is used by default.

Type: Any of the following

ContainerName
IForeignKeyContainer

restriction

An optional restriction to apply to the search.

Type: Expression

IFormat

No description available

Properties: date, symbol, time

date required

No description available

Type: Anonymous Object Type

short

string

symbol

No description available

Type: Anonymous Object Type

decimal	string
group	string

time required

No description available

Type: Anonymous Object Type

short

string

IFormats

No description available

Properties: preferred, fixed, available

preferred

The preferred format for the end-user.

Type: string

fixed

No description available

Type: boolean

available

No description available

Type: IAvailableFormats

iFramePermissions

Represents all the attributes which can be included in an OK list of allowed iFrame functionality. Further information can be found here: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox

IGlobalAmountFormat

No description available

Properties: short, currencyDisplay

short

True if short formatting should be applied, or specify a precise number of characters.

Type: Any of the following

boolean
Anonymous Object Type

precision

number

currencyDisplay

An optional property describing how to display the currency. It can either be displayed as a symbol, e.g., '$', as a code, e.g., 'USD', or not shown at all.

Default Value: 'symbol' which will display the currency symbols.

Type: GlobalCurrencyDisplayType

IGlobalDefinitions

Definitions are used to share common referable concepts and items across different workspaces and areas of the client.

Properties: infoBubbles, sizes, styles, colors, tables, searchLayouts, enums, palettes

infoBubbles required

Info-bubbles that can be used across all workspaces.

Type: ReusableInfoBubbleRegistry

sizes required

Mapping between symbolic names to pixel width.

Type: Anonymous Object Type

xs	number
sm	number
md	number
lg	number
xl	number
custom	number

styles required

Reusable style definitions that can be applied across all workspaces.

Type: StyleRegistry

colors required

Reusable colors used across different workspaces

Type: ColorRegistry

tables required

Global configuration for tables *

Type: ITableProperties

searchLayouts required

Layouts used for performing different kinds of searches across all workspaces.

Type: IGlobalSearchLayouts

enums required

Client-side enumeration types.

Type: IEnums

palettes required

Palettes containing a list of colors

Type: IPalettes

IGlobalPagingConfiguration

Defines the global paging configuration interface for tables, allowing customization of paging behavior, including page sizes, default page size, server-side paging setup, and virtual scrolling.

Properties: serverSidePaging, pageSizes, defaultPageSize, virtualScrollingEnabled

serverSidePaging required

Configuration of the server-side table paging functionality.

Type: IServerSideTablePagingConfiguration

pageSizes required

The page sizes for use in pageable tables. The page sizes should be in the interval between 1 and 100.

Type: Array<number>

defaultPageSize

The optional default page size to use in tables. Should be set to one of the values from the pageSizes array.

Default Value: The minimum page size from the pageSizes array.

Type: number

virtualScrollingEnabled required

Enable Virtual scrolling. If you disable this, the pager will be used for all tables. This can be overwritten on an individual table by the pageable property.

Type: boolean

IGlobalSearchLayouts

Represents a hierarchy of search layout configurations.

Search layouts are defined per search container where a search will be performed. For example, the field JobNumber on a time sheet line is associated with the search container Find_JobHeader from the maconomy family. Therefore, for searches started from this field, the search layouts for the Find_JobHeader container will be used.

Properties: containers

containers required

No description available

Type: Array with any of the following

* <a href="#iglobalsearchlayouts">IGlobalSearchLayouts</a>
* Anonymous Object Type<br>

standard	IStandardSearchLayout
container	Any of the following IContainer ContainerName
searchLayouts	INamedSearchLayouts

IGrid

No description available

Properties: format, columns, lines, maxWidth

format

Assign formatting by data type

Type: TypeSpecificFormat

columns

The columns array allows logical grouping and assignment of shared properties across columns.

Type: Array<IGridColumn>

lines required

The lines in a grid represent the grid's rows including headers, footers and sections.

Type: Array<GridLineOrSection>

maxWidth

Should the grid grab all horizontal space?

Default Value: false

Type: boolean

IGridAmountCell

The unit cell represents a field cell with a unit describing the data of the field.

Properties: format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, rendering, rowspan, colspan, visible, style, level, size, currency

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

label

Type: string

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

rowspan

The row span determine how many visual rows a given scope encompasses.

Default Value: 1

Type: number

colspan

The column span determine how many visual columns a given scope encompasses.

Default Value: 1

Type: number

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

style

No description available

Type: Any of the following

Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

StyleName
IFirstMatchSelector<(&&&&&)>
Array with any of the following
- Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

* <a href="#ifirstmatchselector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;</a>

Type: number

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

IGridEmptyCell

An empty cell will show nothing

Properties: rowspan, colspan, visible, style, level, size

rowspan

The row span determine how many visual rows a given scope encompasses.

Default Value: 1

Type: number

colspan

The column span determine how many visual columns a given scope encompasses.

Default Value: 1

Type: number

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

style

No description available

Type: Any of the following

Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

StyleName
IFirstMatchSelector<(&&&&&)>
Array with any of the following
- Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

* <a href="#ifirstmatchselector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;</a>

IInfoBubbleDefinition
IInfoBubbleReference

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

label

Type: string

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

rowspan

The row span determine how many visual rows a given scope encompasses.

Default Value: 1

Type: number

colspan

The column span determine how many visual columns a given scope encompasses.

Default Value: 1

Type: number

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

style

No description available

Type: Any of the following

Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

StyleName
IFirstMatchSelector<(&&&&&)>
Array with any of the following
- Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

* <a href="#ifirstmatchselector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;</a>

level

No description available

Type: undefined

size

No description available

Type: undefined

IGridHeaderLine

No description available

Properties: format, mandatory, open, style, visible, pane, cells, lineType

format

Assign formatting by data type

Type: TypeSpecificFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

cells required

An array of cells constituting the line. The number of cells and their colspans should match the other lines in the grid.

Type: Array<GridCell>

lineType required

A grid line can either be a header line, normal line or a total line.

Type: header

IGridHeaderLineShorthand

Shorthand to create a header line consisting only of text cells.

Properties: format, visible, pane, columnTitles

format

Assign formatting by data type

Type: TypeSpecificFormat

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

columnTitles required

No description available

Type: Array<LocalizableText>

IGridLinkCell

The link cell represents a link that can navigate to a specified URL.

Properties: alt, label, template, icon, authentication, url, workspace, mail, query, rowspan, colspan, visible, style, level, size

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

The row span determine how many visual rows a given scope encompasses.

Default Value: 1

Type: number

colspan

The column span determine how many visual columns a given scope encompasses.

Default Value: 1

Type: number

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

style

No description available

Type: Any of the following

Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

StyleName
IFirstMatchSelector<(&&&&&)>
Array with any of the following
- Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

* <a href="#ifirstmatchselector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;</a>

level

No description available

Type: undefined

size

No description available

Type: undefined

IGridNormalLine

No description available

Properties: title, titleValue, titleSource, format, mandatory, open, style, visible, pane, cells, lineType

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

format

Assign formatting by data type

Type: TypeSpecificFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

cells required

An array of cells constituting the line. The number of cells and their colspans should match the other lines in the grid.

Type: Array<GridCell>

lineType

A grid line can either be a header line, normal line or a total line.

Default Value: normal

Type: normal

IGridPercentCell

The unit cell represents a field cell with a unit title of '%''.

Properties: format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, rendering, rowspan, colspan, visible, style, level, size

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

label

Type: string

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

rowspan

The row span determine how many visual rows a given scope encompasses.

Default Value: 1

Type: number

colspan

The column span determine how many visual columns a given scope encompasses.

Default Value: 1

Type: number

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

style

No description available

Type: Any of the following

Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

StyleName
IFirstMatchSelector<(&&&&&)>
Array with any of the following
- Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

* <a href="#ifirstmatchselector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;</a>

level

No description available

Type: undefined

size

No description available

Type: undefined

IGridRow

Represents a row containing a grid structure.

Properties: format, island, mandatory, open, rendering, style, label, collapsible, pane, title, grid

format

Assign formatting by data type

Type: TypeSpecificFormat

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

grid required

A grid.

Type: Grid

IGridSection

A grid section represents a sublevel of the main grid.

Properties: format, mandatory, open, style, title, visible, pane, lines

format

Assign formatting by data type

Type: TypeSpecificFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

title required

An mandatory, localizable title.

Type: LocalizableText

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

lines required

The lines of a section cn be either normal or total lines

Type: Array<GridSectionLine>

IGridTextCell

Cell type for displaying texts

Properties: title, titleValue, titleSource, rowspan, colspan, visible, style, level, size, template

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

rowspan

The row span determine how many visual rows a given scope encompasses.

Default Value: 1

Type: number

colspan

The column span determine how many visual columns a given scope encompasses.

Default Value: 1

Type: number

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

style

No description available

Type: Any of the following

Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

StyleName
IFirstMatchSelector<(&&&&&)>
Array with any of the following
- Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

* <a href="#ifirstmatchselector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;</a>

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

cells required

An array of cells constituting the line. The number of cells and their colspans should match the other lines in the grid.

Type: Array<GridCell>

lineType required

A grid line can either be a header line, normal line or a total line.

Type: total

IGridUnitFieldCell

The unit cell represents a field cell with a unit describing the data of the field.

Properties: format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, unit, rendering, rowspan, colspan, visible, style, level, size

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

label

Type: string

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

unit required

No description available

Type: IUnitBlock

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

rowspan

The row span determine how many visual rows a given scope encompasses.

Default Value: 1

Type: number

colspan

The column span determine how many visual columns a given scope encompasses.

Default Value: 1

Type: number

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

style

No description available

Type: Any of the following

Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

StyleName
IFirstMatchSelector<(&&&&&)>
Array with any of the following
- Anonymous Object Type

verticalAlign	VerticalAlignType
backgroundColor	Any of the following Color QualifiedPaletteItemName
color	Any of the following Color QualifiedPaletteItemName
fontWeight	string
textAlign	TextAlignType
condition	Expression

* <a href="#ifirstmatchselector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;&amp;&amp;&amp;)&gt;</a>

level

No description available

Type: undefined

size

No description available

Type: undefined

IHeading

Configuration of the header area of a workspace. The header is used to communicate the title of the workspace, provide access to the primary navigation facility, and optionally allow the user to create instances of the workspace's main data type.

Properties: pane, title, navigation, createAction

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

Optional navigation facility to navigate between different instances of the main data entity in this workspace.

Type: NavigationType

createAction

If specified, a creation action will be added to the workspace for adding a new record.

Type: IHeadingCreateAction

IHeadingCreateAction

No description available

Properties: visible, title, pane, wizardWorkspace

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

pane required

The pane used to resolve unqualified references in this scope.

Type: PaneName

wizardWorkspace

A wizard that will be shown when this action is clicked.

Type: IWizardWorkspace

IInfoBubbleDefinition

A definition of an inline info-bubble.

Properties: label, pane, width, position, title, subTitle, rows

label

Type: string

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

width

You can optionally specify the width of the Info-bubble:

xs: 200 px sm: 300 px md: 400 px lg: 400 px xl: 400 px

The default behavior is:

1 column is rendered xs 2 columns is rendered sm >2 columns is rendered md

Type: WidthType

position

An optional position of the info bubble. Right is default.

Type: IInfoBubblePosition

title

The title or heading of the info bubble

Type: IInfoBubbleTitleType

subTitle

The sub heading of the info bubble

Type: IInfoBubbleTitleType

rows required

The rows or content of the info bubble

Type: Array<RowType>

IInfoBubblePosition

No description available

IInfoBubbleReference

A reference to a reusable info-bubble.

Properties: ref, parameters

ref required

No description available

Type: InfoBubbleName

parameters required

No description available

Type: Any of the following

FieldName
PaneName

IInfoBubbleTitle

No description available

Properties: source, value

source

An optional, text coming from the title of another field.

Type: FieldName

value

An optional, text coming from value of a field.

Type: FieldName

IInfoBubbleTitleType

No description available

Any of the following

LocalizableText
IInfoBubbleTitle

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

label

Type: string

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

IIntegerFormat

No description available

Properties: short, zeroSuppression

short

True if short formatting should be applied, or specify a precise number of characters.

Type: Any of the following

boolean
Anonymous Object Type

precision

number

zeroSuppression

True if zero values should be suppressed.

Type: boolean

IIntervalElement

The interval element represents a range. It consists of a title block and a from/to pair with a separator in between.

Properties: appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, from, to

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

from required

No description available

Type: Any of the following

FieldName
IInputBlock

to required

No description available

Type: Any of the following

FieldName
IInputBlock

IKpiAmountField

No description available

Properties: source, currency

source required

No description available

Type: FieldName

currency required

No description available

Type: FieldName

IKpiColumn

Represents a KPI column. A KPI column contains vital data point of interests.

Properties: info, island, format, label, visible, span, offset, pane, title, kpi

info

Configuration for the info-bubble tooltip for the row

Type: Any of the following

TemplateText
LimitedInfoBubble

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

format

Assign formatting by data type

Type: TypeSpecificFormat

label

Type: string

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

span

Please note: Spans of 1 is default and not necessary to write. The total span cannot exceed 12 columns. The total span should be a factor of 12, e.g. 1,2,3,4,6,12

Type: number

offset

Column offset.

Type: number

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

kpi required

No description available

Type: IKpiElement

IKpiElement

No description available

Properties: style, height, format, mandatory, open, visible, value

style

No description available

Type: Any of the following

Anonymous Object Type

extends	StyleName
condition	Expression
color	Any of the following Color QualifiedPaletteItemName
backgroundColor	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&&&)>
Array with any of the following
- Anonymous Object Type

extends	StyleName
condition	Expression
color	Any of the following Color QualifiedPaletteItemName
backgroundColor	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;&amp;)&gt;</a>

height

An optional height. If unspecified, no height will be set for the part.

Type: number

format

Assign formatting based upon the data value

Type: ValueFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Configuration for the info-bubble tooltip for the row

Type: Any of the following

TemplateText
LimitedInfoBubble

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

format

Assign formatting by data type

Type: TypeSpecificFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

span

Please note: Spans of 1 is default and not necessary to write. The total span cannot exceed 12 columns. The total span should be a factor of 12, e.g. 1,2,3,4,6,12

Type: number

offset

Column offset.

Type: number

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

rows required

An array of layout rows.

Type: Array<ExtendedRowType>

ILayoutNameAndParameters

No description available

Properties: name

name required

The name of the search layout.

Type: LayoutName

ILayoutRow

Represents a layout row which lays out its contents horizontally.

Properties: info, island, format, mandatory, open, rendering, style, label, splitter, collapsible, pane, title, columns

info

Configuration for the info-bubble tooltip for the row

Type: Any of the following

TemplateText
LimitedInfoBubble

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

format

Assign formatting by data type

Type: TypeSpecificFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

splitter

A splitter can appear dynamically by specifying an expression. Alternatively, if a splitter is always appearing, a configuration can be given to determine its appearance and behavior.

Default Value: false

Type: Any of the following

BooleanValue
SplitterOptions

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

columns required

An array of layout columns.

Type: Array<ColumnType>

ILayoutSettings

No description available

Properties: grabHorizontalSpace, openInListMode, nativePdfViewer

grabHorizontalSpace required

When enabled, all workspaces will have narrow margins and grab the horizontal space available.

Type: BooleanValue

openInListMode required

Controls whether all workspaces which have a filter-based navigation should open in "list view" mode by default.

Type: BooleanValue

nativePdfViewer

Controls whether the native PDF viewer should be used for viewing PDFs. If a browser does not support the native PDF viewer (e.g. mobile devices), the default viewer will be used.

The link element represents a link that can navigate to a specified URL.

Properties: alt, label, template, icon, authentication, url, workspace, mail, query, appearance, rendering, title, titleValue, titleSource, mandatory, open, visible

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

all requests will be executed synchronously, and
no progress information will be read from the server.

This property can have one of the following values:

a boolean: true or false, which will unconditionally enable or disable this functionality for all users.
an expression string which can be used to restrict this functionality to selected users, e.g. based on their role.

Type: Any of the following

boolean
Expression

patience required

Specifies the number of seconds that a request may run before switching to asynchronous execution.

If a request takes longer than the specified number of seconds, then the server will switch the execution of this request into asynchronous mode.

If this value is set to zero, then all requests will be executed asynchronously.

Type: number

expiry

Specifies the number of seconds that information about an asynchronous request is kept on the server.

If this property is not specified, a default value will be applied by the server.

Type: number

Image

Conditional clauses *

Any of the following

Array<IConditionalClause<ImageType>>
IConditionalClause<ImageType>

IMailValue

No description available

Properties: value

value required

No description available

Type: Expression

IMappedFilterAsTableField

Defines a mapping between a filter field and a card field for a filter-as-table pane.

Properties: mapsTo

mapsTo required

Specifies the name of the field in the card pane.

Type: FieldName

IMenu

The menu provides access to the workspaces that are available to the logged-in user. A menu consists of workspaces ordered in groups. Different users may see different sets of menu groups and items depending on the user's privileges and context.

Properties: restoreLastWorkspace, defaultWorkspace, groups

restoreLastWorkspace

Restore the last used workspace on login.

Default Value: false

Type: boolean

defaultWorkspace

A prioritized list of candidate default or startup workspaces. On startup, this list is evaluated and the first candidate where the condition is satisfied is chosen as default for the logged-in user.

Default Value: ``

Type: Array<DefaultWorkspaceCandidate>

groups required

The set of menu groups available in the menu.

Type: Array<IMenuGroup>

IMenuGroup

A group of workspaces arranged under a common title

Properties: title, visible, items, icon, expanded

title required

An mandatory, localizable title.

Type: LocalizableText

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

items

The workspaces or links contained in this menu group.

Type: Array<IMenuItem>

icon

An optional icon for the menu group.

Type: string

expanded

Determines whether a menu group is expanded or collapsed on login.

Default Value: true

Type: BooleanValue

IMenuItem

No description available

Any of the following

WorkspaceName
IWorkspaceItem
ILinkItem
IMenuGroup
IAnalyzerItem

IMountBinding

A variant of the "mount" binding with additional configurable properties.

Properties: defaultPaneContent, type, enableReverseChannel

defaultPaneContent

Controls the initial content of the pane that is the target of the binding.

This property can be set to one of the following values:

any-record - the pane will be populated with a record selected by the backend;
empty - the pane will contain no records.

If this property is not specified, then the default state is any-record.

Type: string

type required

No description available

Type: mount

enableReverseChannel

No description available

Type: Expression

InfoBubbleName

String alias for an info bubble.

InMemoryFieldDefinitionMapType

No description available

Map from string to InMemoryFieldDefinitionType

InMemoryFieldDefinitionType

No description available

Any of the following

Anonymous Object Type

title	string
type	`string`
autoSubmit	boolean
mandatory	boolean
open	boolean
defaultValue	Expression
multiLine	boolean
maxLength	number

Anonymous Object Type

title	string
type	string
autoSubmit	boolean
mandatory	boolean
open	boolean
defaultValue	Expression
maxValue	number
minValue	number

Anonymous Object Type

title	string
type	`enum`
autoSubmit	boolean
mandatory	boolean
open	boolean
defaultValue	Expression
enumType	Any of the following string IEnumName

IOtherField

InMemoryForeignKeyDefinitionMapType

No description available

Map from string to IInMemoryForeignKeyDefinition

InMemoryForeignKeySearchType

No description available

Any of the following

IForeignKeySearchViaFilter
IForeignKeySearchViaForeignKey

INotificationConfiguration

Represents the configuration of notification reload and recalculation intervals.

Properties: recalculation, types

recalculation required

The recalculation settings determine when the first recalculation of the end-user's notifications occur and what the interval between subsequent recalculations is. All values are specified in minutes.

Type: Anonymous Object Type

initialDelay	number
interval	number
quarantinePeriod	number

types required

Supported notification types as specified in the MNSL files.

Type: NotificationTypes

INotificationType

No description available

Properties: workspace, parameters

workspace required

The name of the workspace

Type: WorkspaceName

parameters

A map of url parameters for the workspace linking to the Focus key in question.

Type: ReferencePoint

The title of this field.

If not set, then the name of the field will be used as the title.

Type: string

type required

The data type of this field.

Type: string

autoSubmit

Specifies whether this field is an auto-submit field.

Default Value: false

Type: boolean

mandatory

Specifies whether this field is an auto-submit field.

Default Value: false

Type: boolean

open

Specifies whether this field is open for editing.

Default Value: true

Type: boolean

defaultValue

TODO

Type: Expression

IPageLayout

Represents the layout for a page in a wizard.

Properties: title, pane, open, rows, link

title

The title of this page. Can be overridden by the title of the workflow state.

Type: LocalizableText

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

rows required

The main body of a page layout consists of an array of layout rows.

Type: Array<RowType>

link

Specifies a optional link on the page. The user can click to navigate to the item in context.

Type: ILinkElement

IPageLayouts

No description available

Map from string to IPageLayout

IPagingConfiguration

No description available

Properties: initialSize

initialSize

Specifies the number of records that will be initially loaded into this pane.

Type: number

IPairElement

The pair element represents a pair. It consists of a title block and a pair of two fields.

Properties: appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, first, second, ratio

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

first required

No description available

Type: Any of the following

FieldName
IInputBlock

second required

No description available

Type: Any of the following

FieldName
IInputBlock

ratio

No description available

Type: string

IPaletteItem

Represents an entry in a palette. An entry can have various color properties. The foreground color is the primary one and will be used if this palette item is referred in an unqualified way.

Properties: background, foreground, badge

background

The background color.

Type: Color

foreground

The foreground color.

Type: Color

badge

The color of the badge.

Type: Color

IPalettes

The web client exposes a number of global palettes. A palette can either by ordered or named depending on how it is going to be accessed in the concrete layouts. It is possible to expose a named palette as an ordered one, but it is discouraged to exposed an ordered palette as a named one (using indices).

Map from string to Palette

IPaneConfiguration

No description available

Properties: actions, foreignKeys

actions

Additional configuration for actions in this pane.

Any application action, such as "SubmitExpenseSheet", "ApproveAbsenceEntry", etc., may be configured here. It is also possible to configure the following standard actions:

"create" - for saving new records,
"update" - for saving existing records.

Type: Any of the following

Anonymous Object Type

condition	Expression
textAlign	TextAlignType
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
textAlign	TextAlignType
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;)&gt;</a>

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

label

Type: string

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

IProjectedFields

No description available

Any of the following

IReportColumnReference
ColumnName

IQueryElement

No description available

Any of the following

QueryValueType
Array<QueryValueType>

IRadioElement

The radio element represents a set of radio elements.

Properties: format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, appearance, rendering, title, titleValue, titleSource, visible

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

label

Type: string

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

IRealFormat

No description available

Properties: decimalPlaces, short, zeroSuppression

decimalPlaces

An optional property which determines the number of decimal places to display. End users can override property in My Settings window

Default Value: '2' which will display two decimal places.

Type: ZeroThroughTen

short

True if short formatting should be applied, or specify a precise number of characters.

Type: Any of the following

boolean
Anonymous Object Type

precision

number

zeroSuppression

True if zero values should be suppressed.

Type: boolean

IRecordHeading

No description available

Properties: pane, title, subTitle, status, image, revision

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional title for the sub heading of the workspace.

Type: TitleType

subTitle

An optional sub-title for the sub heading of the workspace.

Type: TitleType

status

An optional status element for the sub heading of the workspace.

Type: IStatusElement

image

An optional image element for the sub heading of the workspace.

Type: Image

revision

An optional record revision element for the sub heading of the workspace.

Type: Any of the following

Standard
IRecordRevisionSummary

IRecordRevision

Record Revision is used to store the user, date info for created/updated elements.

Properties: user, date

user required

No description available

Type: FieldName

date required

No description available

Type: FieldName

IRecordRevisionSummary

Record Revision Summary consist of revision information.

Properties: created, updated, version

created required

Contains creation information.

Type: IRecordRevision

updated required

Contains update information.

Type: IRecordRevision

version required

Contains the version information.

Type: FieldName

IReferenceElement

The reference element represents a foreign key. It consists of a title block and a description/key pair.

The source of the reference element can be specified in the following ways: 1. Using the foreignKey attribute. In this case, the fields for the description/key pair are determined automatically from the foreign-key. 2. Using the key and description attributes. This approach should be used if no foreign-key is available for the required fields. 3. Using the foreignKey attribute together with the key and/or description attributes. This method should be used if the fields determined automatically from the foreign-key are not correct in this context.

Any of the following

IReferenceElementWithForeignKey
Anonymous Object Type

autoSubmit	boolean
info	Any of the following IInfoBubbleDefinition IInfoBubbleReference
appearance	AppearanceType
rendering	IRendering
title	LocalizableText
titleValue	FieldName
titleSource	FieldName
label	string
mandatory	Expression
open	Expression
visible	Expression
description	Any of the following FieldName IInputBlock
key	Any of the following FieldName IInputBlock

IReferenceElementWithForeignKey

No description available

Properties: autoSubmit, info, appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, description, key, foreignKey, search

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

description

No description available

Type: Any of the following

FieldName
IInputBlock

key

No description available

Type: Any of the following

FieldName
IInputBlock

foreignKey required

No description available

Type: ForeignKeyName

search

The configuration of the search capabilities available for this foreign-key.

If separate fields are specified for the description or key parts, then they might override the search configuration specified here.

Type: FieldSearchType

IRefreshTrigger

No description available

Properties: panes, fields

panes

Any data change on the specified optional panes, or their related panes, will trigger a refresh

Type: Array<PaneName>

fields

Any data change on the specified optional fields will trigger a refresh

Type: Array<FieldName>

IRendering

Represents the two different ways of rendering a layout (or part of a layout).

IReportColumnReference

No description available

Properties: columnName, levelName, title

columnName required

The name of a column in an Analyzer report.

Type: ColumnName

levelName

The name of a report level (as defined in the source section of the report) for the referenced column.

If not specified, then the default level will be used.

Type: LevelName

title

Type: ReportLevelType

IReusableInfoBubbleDefinition

A definition of a reusable info bubble.

Properties: label, pane, width, position, title, subTitle, rows, parameters

label

Type: Any of the following

PaneName
Array<PaneName>

IScheduler

Configuration of the scheduler.

Properties: pane, title, defaultView, period, view, slot, settingsWizard, createWizard, events

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

The text to show in the title of the scheduler.

Type: TemplateText

defaultView

The default view for the scheduler.

Type: SchedulerViewType

period

Fields to update with the period shown in the scheduler.

If this property is set, then the scheduler will update these fields with the currently selected date range. Note that the scheduler does not read the value that is stored in these fields.

Type: Anonymous Object Type

start	FieldName
end	FieldName

view

A field to update with view shown in the scheduler.

If this property is set, then the scheduler will update this field with the currently selected view. Note that the scheduler does not read the value that is stored in this field.

Type: Anonymous Object Type

source	FieldName
mask	ISchedulerViewMask

slot

No description available

Type: SchedulerSlotDivision

settingsWizard

A wizard for editing the settings of the scheduler.

If this property is defined, a link will appear in the scheduler's toolbar for invoking this wizard.

Type: IWizardInvocationWithOptionalPane

createWizard

A wizard for creating a new event in the scheduler.

If this property is defined, then double-clicking on an empty slot in the scheduler will invoke this wizard.

Type: IWizardInvocationWithOptionalPane

events required

Configures the events list in the scheduler.

Type: ISchedulerEventConfiguration

ISchedulerEventConfiguration

No description available

Properties: pane, title, allDayTitle, color, actions, start, end, elements

pane required

The pane that contains the list of events to be shown in the scheduler.

Each record in the specified pane will be shown as a separate event.

Type: PaneName

title

The text to show in the title of the event.

Type: TemplateText

allDayTitle

The text to show in the all day title of the event.

Type: TemplateText

color

A color can be set on an event. The color will be used for coloring the left border of the event.

Type: IEventColor

actions required

A list of actions to be shown in the actions menu of an event.

The first visible action in this list is the default action. It will be invoked when the user double-clicks the event.

Type: Array<TableActionType>

start required

A field which contains the starting date and time of the event.

Type: DateTimeField

end required

A field which contains the ending date and time of the event.

Type: DateTimeField

elements required

The layout for the event.

Type: Array with any of the following

* <a href="#fieldformelementtype">FieldFormElementType</a>
* <a href="#referenceformelementtype">ReferenceFormElementType</a>
* <a href="#unitfieldformelementtype">UnitFieldFormElementType</a>
* <a href="#amountformelementtype">AmountFormElementType</a>
* <a href="#percentformelementtype">PercentFormElementType</a>

ISchedulerRow

Represents a row containing a scheduler component.

Properties: island, style, label, collapsible, pane, title, scheduler

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

scheduler required

A scheduler

Type: IScheduler

ISchedulerViewMask

A mask for matching field values against one of the view types supported by the scheduler.

The field value is specified as an Expression Language expression.

Map from string to SchedulerViewType

IScopeRow

Represents one or more rows as a single container. Scopes can have titles which will make them render in the user interface as a collapsible section.

Properties: collapsible, title, scope

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

scope required

No description available

Type: Array<RowType>

ISearchAsYouTypeLayout

The search-as-you-type part of a search layout.

Properties: restriction, elements, image

restriction

A base restriction to be applied to limit the search results in addition to any restrictions defined elsewhere.

Type: Expression

elements required

The search result layout.

Type: Array<SearchResultType>

image

The image for each record in the search result.

Type: Image

ISearchRestriction

No description available

Properties: visible, title, label, restriction

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

label

Type: string

restriction

An optional expression for this search restriction.

Type: Expression

IServerSideTablePagingBufferConfiguration

No description available

Properties: size, minimumSize

size required

The number of extra records to load before and after the currently selected page.

Type: PagingBufferSizeType

minimumSize required

The number of extra records before and after the currently selected page, which, if present, will not trigger the addition of the buffer.

Type: PagingBufferSizeType

IServerSideTablePagingConfiguration

No description available

Properties: enabled, buffer

enabled required

This flag enables server-side table paging for all supported tables.

Type: boolean

buffer required

Specifies the number of extra records loaded in addition to the ones on the current page.

Type: Any of the following

IServerSideTablePagingBufferConfiguration
boolean

ISettings

Settings represents formats, language, and other end-user configurable properties.

Properties: formats, minutesThreshold, menuSearch, menu, images, layout, formatting, userInactivityInterval, draggableFieldValues, multiSort, showFieldBorders, calendar, search

formats

The formats configuration determines the data formatting as well as whether this can be changed by the end-user.

Type: IFormats

minutesThreshold

The minute threshold determines when a time entry is interpreted as minutes or as hours. Default is '10' which means that an entry of '10' will be interpreted as 10 minutes, and an entry of '11' will be interpreted as 11 hours.

Default Value: 10

Type: number

menuSearch

The menuSearch configuration determines if the search component is enabled in the menu

Default Value: false

Type: boolean

Configuration options for the menu

Type: Anonymous Object Type

search	BooleanValue
expanded	BooleanValue
showRecentPlaces	BooleanValue

images required

The images configuration determines if the images are enabled

Type: BooleanValue

layout required

Global settings for controlling the layout of workspaces.

Type: ILayoutSettings

formatting required

Configure formatting rules for data types.

Type: GlobalTypeSpecificFormat

userInactivityInterval

The user inactivity interval in minutes.

The client will perform certain automatic operations, such as periodically refreshing conversations or notifications, only when the user is active. If the inactivity timeout exceeds the number of minutes specified in this property, then such automatic refresh will be paused.

Default Value: 10

Type: number

draggableFieldValues

This setting controls whether field values are draggable by mouse in the user interface.

Default Value: false

Type: BooleanValue

multiSort

This setting enables multiple column sorting in the user interface.

Default Value: false

Type: BooleanValue

showFieldBorders

This setting enables field borders to be displayed in the user interface.

Default Value: false

Type: BooleanValue

calendar

This setting controls the first day of the week used in calendars. When not used the first day of the week will be derived form the region used.

Please note: The calendar used to select a Time Sheet will always start on a Monday, regardless of this setting.

Type: CalendarSettings

search

This optional setting controls details about how search functionality works. Notice that casing of searches cannot be controlled in this configuration. It is a function of the database setup.

Type: SearchOptions

ISidePanel

The selection criteria panel definition. Selection criteria panels can exist within either a workspace or a tab. If you specify this on a workspace you cannot specify it on a tab and vice versa. Each tab can hold only one such panel.

Properties: info, island, format, mandatory, open, rendering, style, label, visible, collapsible, span, offset, pane, title, elements, showChips

info

Configuration for the info-bubble tooltip for the row

Type: Any of the following

TemplateText
LimitedInfoBubble

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

format

Assign formatting by data type

Type: TypeSpecificFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

span

Please note: Spans of 1 is default and not necessary to write. The total span cannot exceed 12 columns. The total span should be a factor of 12, e.g. 1,2,3,4,6,12

Type: number

offset

Column offset.

Type: number

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title required

The tab title is a localizable text that is shown in both a collapsed and expanded state. Click on the title to expand or collapse the side panel.

Type: LocalizableText

elements required

An array of the elements contained in this scope

Type: Array<FormElementType>

showChips

The chips show a summary of the currently active selection. Removing a chip will remove that part of the selection criteria.

Type: boolean

ISidePanelRow

A selection criteria panel within this workspace or tab.

Properties: selectionCriteria

selectionCriteria required

No description available

Type: ISidePanel

IStandardSearchLayout

A standard search layout.

Properties: restriction, selection, orderBy, searchFields, searchAsYouType, advancedSearch

restriction

A base restriction to be applied to limit the search results.

Type: Expression

selection

Defines predefined search restrictions which the user can choose from.

The selected search restriction is applied in addition to any restrictions defined elsewhere.

Note that for a search-as-you-type search, the restriction selected as default will always be applied.

Type: IFilterSelection

orderBy

Defines the default sorting order of the search results.

Type: Array<IOrderBy>

searchFields

A list of fields on which the free-text search will be performed. Defaults to the fields referenced in the search-as-you-type layout.

Type: Array<FieldName>

searchAsYouType required

Defines properties for the search-as-you-type search.

Type: ISearchAsYouTypeLayout

advancedSearch required

Defines properties for the advanced search.

Type: IAdvancedSearchLayout

IStatusBlock

No description available

Properties: label, source, mask

label

Type: string

source required

The underlying pane field that provides data for this status block.

Type: FieldName

mask required

A mask map a given internal status value to a title and css. In time sheets, you can for instance map the status character '1' to the title 'Due' and the color red.

Type: IStatusIndication

IStatusElement

Status elements are used in forms for rendering status information about a record.

Properties: label, source, mask, appearance, rendering, title, titleValue, titleSource, mandatory, open, visible, color

label

Type: string

source required

The underlying pane field that provides data for this status block.

Type: FieldName

mask required

A mask map a given internal status value to a title and css. In time sheets, you can for instance map the status character '1' to the title 'Due' and the color red.

Type: IStatusIndication

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

color

A color indicating the status of the element.

Type: Color

IStatusIndication

No description available

Properties: title, info, color

title required

An mandatory, localizable title.

Type: LocalizableText

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

color

A color indicating the status of the mask.

Type: Color

IStringFormat

No description available

{ }

IStyledStatusIndication

No description available

Properties: style, title, info, color

style

No description available

Type: Any of the following

Anonymous Object Type

color	Any of the following Color QualifiedPaletteItemName
backgroundColor	Any of the following Color QualifiedPaletteItemName

StyleName
Array<Anonymous Object Type

color	Any of the following Color QualifiedPaletteItemName
backgroundColor	Any of the following Color QualifiedPaletteItemName

title required

An mandatory, localizable title.

Type: LocalizableText

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

color

A color indicating the status of the mask.

Type: QualifiedPaletteItemName

ISumLineDefinition

No description available

Properties: format, style, pane, columns

format

Assign formatting by data type

Type: TypeSpecificFormat

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
fontWeight	string
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
fontWeight	string
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;)&gt;</a>

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

columns required

No description available

Type: Array<SumLineColumn>

ISumLineField

No description available

Properties: format, style, source

format

Assign formatting based upon the data value

Type: ValueFormat

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
fontWeight	string
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
fontWeight	string
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;)&gt;</a>

Anonymous Object Type

condition	Expression
fontWeight	string
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
fontWeight	string
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;)&gt;</a>

title required

An mandatory, localizable title.

Type: LocalizableText

ISumLineTextColumn

No description available

Properties: ref, text

ref required

A reference to a column in the table body

Type: FieldName

text required

No description available

Type: ISumLineText

ITab

Represents a single tab in a tab group. A tab always has a title and can optionally provide a badge to highlight it.

Properties: visible, info, island, format, mandatory, open, rendering, style, label, collapsible, span, offset, pane, title, rows, badge, sticky, actions, assistant

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

info

Configuration for the info-bubble tooltip for the row

Type: Any of the following

TemplateText
LimitedInfoBubble

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

format

Assign formatting by data type

Type: TypeSpecificFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

span

Please note: Spans of 1 is default and not necessary to write. The total span cannot exceed 12 columns. The total span should be a factor of 12, e.g. 1,2,3,4,6,12

Type: number

offset

Column offset.

Type: number

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title required

The tab title is a localizable text that is shown regardless of whether the tab contents are shown.

Type: LocalizableText

rows required

An array of layout rows.

Type: Array<ExtendedRowType>

badge

The badge is an optional decoration which is used to highlight aggregated information from a tab column.

Type: IBadge

sticky

A tab can be "sticky" meaning that it remains visible for a while even though its visibility condition evaluates to false. This only holds for the currently active tab and only as long as no other server request has been made. The purpose of this attribute is to allow a tab to remain visible for a short while even though all work on it has been completed.

Default Value: false

Type: boolean

actions

The actions to be shown in this tab.

Type: Array with any of the following

* <a href="#actiontype">ActionType</a>
* <a href="#iactiongroup">IActionGroup</a>

assistant

An optional panel within this tab. Will hold UI for the assistant of this tab.

Type: IAssistant

ITable

No description available

Properties: format, mandatory, open, style, identifier, pane, title, height, pageable, columns, footer, actions, assistant, columnChooser, switches

format

Assign formatting by data type

Type: TypeSpecificFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;)&gt;">IFirstMatchSelector&lt;(&amp;)&gt;</a>

identifier

An optional identifier used for disambiguation of user settings

Type: string

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

height

The optional height of the table in pixel. number | 'minimal' 'minimal': will make the table a small as possible to a maximum of 3 rows shown before a scrollbar appears.

Type: TableHeightType

pageable

Optionally enables paging in the table. Only supported on regular table and not on 'tree tables'

Default Value: true

Type: boolean

columns required

No description available

Type: Array<TableColumnType>

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;)&gt;">IFirstMatchSelector&lt;(&amp;)&gt;</a>

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

width

No description available

Type: WidthType

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type: Expression

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

currency required

No description available

Type: FieldName

ITableAssistant

No description available

Properties: info, island, format, mandatory, open, rendering, style, label, visible, collapsible, span, offset, pane, title, rows, height

info

Configuration for the info-bubble tooltip for the row

Type: Any of the following

TemplateText
LimitedInfoBubble

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

format

Assign formatting by data type

Type: TypeSpecificFormat

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

span

Please note: Spans of 1 is default and not necessary to write. The total span cannot exceed 12 columns. The total span should be a factor of 12, e.g. 1,2,3,4,6,12

Type: number

offset

Column offset.

Type: number

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

rows required

An array of layout rows.

Type: Array<ExtendedRowType>

height

The height of the assistant. Content that exceeds this height will invoke a vertical scroll bar for the assistant.

Type: number

ITableFieldColumn

Represents the type of element that can be inserted in tables.

Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, format, validators, info, autoSubmit, source, search, widget, shadowTitle

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;)&gt;">IFirstMatchSelector&lt;(&amp;)&gt;</a>

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

width

No description available

Type: WidthType

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type: Expression

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

ITableFileSizeColumn

No description available

Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, format, validators, info, autoSubmit, source, search, widget, shadowTitle

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;)&gt;">IFirstMatchSelector&lt;(&amp;)&gt;</a>

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

width

No description available

Type: WidthType

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type: Expression

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

ITableFooter

No description available

Properties: format, pane, expanded, sumLines

format

Assign formatting by data type

Type: TypeSpecificFormat

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

expanded

Is the table footer expanded by default.

Default Value: false

Type: BooleanValue

sumLines required

No description available

Type: Array<ISumLineDefinition>

ITableLinkColumn

No description available

Properties: exportable, style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, template, icon, authentication, url, workspace, mail, query

exportable

No description available

Default Value: false

Type: boolean

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;)&gt;">IFirstMatchSelector&lt;(&amp;)&gt;</a>

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Specifies whether caching of init responses is allowed for this pane.

If set to true, then init responses will be cached; when set to false, they will not be cached. If not specified, the default behavior is to cache init responses.

Type: boolean

actions

Additional configuration for actions in this pane.

Any application action, such as "SubmitExpenseSheet", "ApproveAbsenceEntry", etc., may be configured here. It is also possible to configure the following standard actions:

"create" - for saving new records,
"update" - for saving existing records.

Type: IActionConfiguration

foreignKeys

Additional configuration for foreign-keys.

Type: ForeignKeyConfiguration

inheritFollowingSiblingsOnOutdent

Specifies how the table pane of this container reacts when records are outdented in a tree structure.

When a line is outdented in a tree table, the client immediately shows the line in its new position without waiting for a response from the backend. In order to do that, the client makes an assumption on how the outdent operation is going to be carried out in the table pane on the backend. However, container implementations can realize this in different ways, which can sometimes result in a temporary incorrect positioning of the lines.

This property acts as a hint to the client on how the backend is going to position and outdented line.

Setting this property to false, or not specifying in at all, assumes that lines will be outdented as follows: it is moved to the same level as its parent, to a position immediately after the parent.

On the other hand, setting this property to true will make the client assume the following behavior for an outdented line: it is moved to the same level as its parent, to a position immediately after the parent; moreover, any following lines that were siblings of the outdented line will become children of the outdented line.

Type: boolean

ITablePercentColumn

No description available

Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, format, validators, info, autoSubmit, source, search, widget, shadowTitle

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;)&gt;">IFirstMatchSelector&lt;(&amp;)&gt;</a>

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

width

No description available

Type: WidthType

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type: Expression

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

ITableProperties

Common table properties.

Properties: columnChooser

columnChooser required

Based on the expression you define if a column chooser should be visible on all tables.

Type: Expression

ITableRow

Represents a row containing a table/grid structure.

Properties: format, island, style, label, collapsible, pane, title, table

format

Assign formatting by data type

Type: TypeSpecificFormat

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

table required

A grid of table columns and with header, body, and footer.

Type: ITable

ITableStatusColumn

No description available

Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, source, mask

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;)&gt;">IFirstMatchSelector&lt;(&amp;)&gt;</a>

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

width

No description available

Type: WidthType

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type: Expression

source required

The underlying pane field that provides data for this status block.

Type: FieldName

mask required

A mask map a given internal status value to a title and css. In time sheets, you can for instance map the status character '1' to the title 'Due' and the color red.

Type: IStyledStatusIndication

ITableSwitch

No description available

Properties: visible, title, titleValue, titleSource, label, source

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

source required

No description available

Type: FieldName

ITableTextColumn

No description available

Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, info, template

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;)&gt;">IFirstMatchSelector&lt;(&amp;)&gt;</a>

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

width

No description available

Type: WidthType

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type: Expression

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

template

No description available

Type: LocalizableText

ITableUnitFieldColumn

No description available

Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, format, validators, info, autoSubmit, source, search, widget, shadowTitle, unit

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;)&gt;">IFirstMatchSelector&lt;(&amp;)&gt;</a>

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

width

No description available

Type: WidthType

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type: Expression

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

unit required

No description available

Type: IUnitBlock

ITabsRow

Represents a group of tabs. Tabs are used to group layout columns such that only one column is shown at a time.

Properties: island, style, label, collapsible, pane, noTabsTitle, tabs

island

Provides a hint to the layout on whether this row or column should be shown as an island.

If this property is not specified, then it will be determined automatically.

Type: boolean

style

No description available

Type: Any of the following

{ }
StyleName
IFirstMatchSelector<any>
Array with any of the following
- { }
- IFirstMatchSelector<any>

label

Type: string

collapsible

Default Value: false

Type: Any of the following

BooleanValue
CollapsibleOptions

pane

The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.

Type: PaneName

noTabsTitle

An optional text shown when the array of tabs is empty.

Type: LocalizableText

tabs required

An array of tabs, each with a title, an optional badge, and contents.

Type: Array<ITab>

ITextElement

The text element consists of a template block.

Properties: style, info, label, template, appearance, rendering, title, titleValue, titleSource, mandatory, open, visible

style

No description available

Type: Any of the following

Anonymous Object Type

extends	StyleName
condition	Expression
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&&)>
Array with any of the following
- Anonymous Object Type

extends	StyleName
condition	Expression
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;)&gt;</a>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

label

Type: string

template

No description available

Type: LocalizableText

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

step required

Defines the steps to use for the dropdown list or the time-selector wheel.

Type: Anonymous Object Type

hour	number
minute	number

ITriggers

Defines triggers that will be executed at specific pane events.

Properties: init

init

Specifies triggers to be executed when a new record is created in a pane.

Type: Array<TriggerType>

ITypeAheadConfiguration

No description available

Properties: enabled, maximumQueueLength

enabled

This flag enables type-ahead for all workspaces.

Default Value: true

Type: boolean

maximumQueueLength

The maximum number of operations that can be scheduled for execution.

Default Value: : 5``

Type: number

IUnaryRestriction

A restriction using any of the unary operators.

Properties: operator

operator required

No description available

Type: UnaryOperatorType

IUnitBlock

No description available

Properties: title, label, source, position

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

label

Type: string

source

No description available

Type: FieldName

position

No description available

Type: UnitPositionType

IUnitFieldElement

The unit element represents a field element with a unit describing the data of the field.

Properties: style, format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, unit, appearance, rendering, title, titleValue, titleSource, visible

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
textAlign	TextAlignType
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
textAlign	TextAlignType
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;&amp;)&gt;">IFirstMatchSelector&lt;(&amp;&amp;)&gt;</a>

format

Assign formatting based upon the data value

Type: ValueFormat

validators

No description available

Type: Array<IValidator>

info

A definition of an inline info-bubble or a reference to a reusable info-bubble.

Type: Any of the following

IInfoBubbleDefinition
IInfoBubbleReference

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

autoSubmit

Specifies that changes to this field should be automatically saved.

Type: boolean

label

Type: string

source required

The underlying pane field that provides data for this input block.

Type: FieldName

search

The configuration of the search capabilities available for this field.

If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.

Default Value: true

Type: FieldSearchType

The default widget representing an input can optionally be overriden here.

Type: WidgetType

shadowTitle

The shadow title might be shown in the input field if the field does not contain a value

Type: TemplateText

unit required

No description available

Type: IUnitBlock

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

IUpdateAction

Saves changes to an existing record in the specified pane.

Properties: update

update required

No description available

Type: PaneName

Google Analytics tracker ID can be provided here for custom tracking of usage.

Type: string

gainsight

visible

IWizardWorkflow

No description available

Map from string to IWorkflowState

IWizardWorkspace

Configuration of an individual wizard workspace.

A wizard workspace is similar to a regular workspace in that it has a name, a title and it exposes data though panes set up in the data-bindings part. However, as opposed to a regular workspace, this workspace leads the user through a number of steps (set up in the workflow part) and can display a different layout for each step (these are configured in the page-layouts part).

Properties: title, name, size, definitions, dataBindings, workflow, pageLayouts, sideEffects, cancel

title required

An mandatory, localizable title.

Type: LocalizableText

name required

The internal, unique, non-localizable name of the wizard workspace.

Type: WorkspaceName

size

The size of the wizard window. If not specified the medium size will be applied.

Type: WizardSize

definitions

Definitions of items that can be reused many times within this workspace.

Type: ILocalDefinitions

dataBindings

Configuration of the panes that compose this workspace and how these panes are bound together.

Type: Array<IBindingSpecification>

workflow required

Configuration of the states in the wizard.

Type: IWizardWorkflow

pageLayouts required

Definition of the layouts for the pages in the wizard.

Type: IPageLayouts

sideEffects

Specifies if the wizard makes changes that affect the host workspace.

If not specified, then a wizard is assumed to have side effects (i.e. the default value is true).

This field can be set to false if a wizard is known to not make any changes to the data which is shown in the host workspace. Setting this field to false has the following consequences:

the host workspace will not be refreshed when the wizard is closed,
the wizard can be invoked even if the host workspace has unsaved changes.

Type: boolean

cancel

Specifies the behavior for cancelling the wizard. This setting provides a default value that can be overriden in each workflow state.

Type: ICancelTransition

IWorkflowState

A single state (or step) within the wizard workflow.

Properties: title, pageLayout, transitions

title

The title of this state. If not specified, the title from the page layout or the wizard title will be used.

Type: string

pageLayout required

The page to show when this state is active.

Type: PageName

transitions

No description available

Type: Anonymous Object Type

enter	Array<EnterTransitionActionType>
exit	Array<IExitTransition>
cancel	ICancelTransition

IWorkspaceItem

A representation of a single menu item which opens a workspace.

Properties: visible, workspace

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

workspace required

Reference to the internal name of a workspace.

Type: WorkspaceName

IWorkspaceLayout

Represents the layout for the entire workspace area.

Properties: heading, rendering, list, record, rows, actionBar, assistants

heading

The heading area should communicate the overall purpose of this workspace and facilitate navigation between instances of the main data entity. Often a 'create' action will also be available for the main data entity. If the heading is not specified, a default showing the workspace title will be used.

Type: IHeading

rendering

The default rendering of a workspace is 'presentation'. If a rendering is specified for the entire layout using this property then the rendering will be fixed to that mode. This is primarily used to force a layout to always be render in editable mode.

Type: IRendering

list

Controls whether the workspace should show a "list view", and optionally defines a layout for the list view.

This property can contain one of the three possible values: 1. A list view layout. 2. The value true indicating that a list view layout should be autogenerated. 3. The value false indicating that no list view should be shown in this workspace.

Additionally, as part of options (1) and (2) above, it is possible to control whether the workspace should open in list view mode by default. This is achieved through a boolean property openInListMode which can be specified in two ways: 1. As part of the list view layout. 2. As part of an object, e.g. { "openInListMode": true }, instead of the value true.

If openInListMode is not specified, then it will be derived from the global settings for all workspaces.

If this property is not specified, then it defaults to true.

Default Value: true

Type: ListViewType

record

The record heading area should communicate the overall data entity of the workspace. This should contain the primary identifier of the currently shown data entity.

Type: IRecordHeading

rows required

The main body of a workspace layout consists of an array of layout rows.

Type: Array<ExtendedRowType>

actionBar

The actions to be shown in this action row.

Type: IActionsRow

assistants

Assistants that can be used multiple times across the same workspace.

Type: IAssistantRegistry

IZipCityElement

No description available

Properties: appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, zip, city, zipFirst

appearance

An optional property which determines which parts of an element are displayed

Default Value: normal

Type: AppearanceType

rendering

Specifies the rendering state for this part of the layout.

If not specified, then the rendering state inherited from the parent will be used.

Type: IRendering

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

Default Value: true

Type: Expression

zip required

No description available

Type: Any of the following

FieldName
IInputBlock

city required

No description available

Type: Any of the following

FieldName
IInputBlock

zipFirst

No description available

Type: boolean

KpiValueType

No description available

Any of the following

FieldName
IKpiText
IKpiUnitField
IKpiAmountField
IKpiPercentField

LanguageConfiguration

Configuration for language and locale-specific formatting preferences.

Properties: preferred, fixed, localeFormats

preferred required

A locale string or an object with language and region properties. The locale should consist of a language code and a region code separated by an underscore, e.g., 'en_US'.

Default Value: en_US

Type: Locale

fixed required

True if the language is fixed and cannot be changed by the end-user. This removes the language selector from the both login screen and settings dialog.

Type: boolean

localeFormats

A map of locale codes (e.g., 'en_US', 'da_DK', 'nb_NO') to their formatting information.

You can configure preferred date, time, and number formats for specific locales to prioritize specific formats over the default formats derived from a region's browser settings. When configured, these preferred formats will appear at the top of the available formats list in the My Settings dialog for the corresponding locale, making them more discoverable for end-users.

In the following example, preferred formats are configured for the Norwegian locale (nb_NO), prioritizing the period (.) as the grouping separator over the default space ( ), while maintaining the comma (,) as the decimal separator:

Type: LocaleFormattingInfo

LayoutName

String alias for a layout name.

LevelName

A name of a report level in an Analyzer report.

LimitedInfoBubble

No description available

Properties: title, text, link

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

text required

The text or texts to be displayed in the info-bubble

Type: Any of the following

TemplateText
Array<TemplateText>

link

An optional link to be displayed in the info-bubble

Type: Anonymous Object Type

template	LocalizableText
url	URLElement
query	Array<IQueryElement>
icon	string
workspace	WorkspaceLinkType

LinkFormElementType

No description available

Properties: link

link required

No description available

Type: ILinkElement

LinkTableColumnType

No description available

Properties: link

link required

No description available

Type: ITableLinkColumn

LinkTargetType

No description available

ListViewType

A type for defining a "list view" for a workspace. It specifies whether a workspace should have a list view, defines the layout for the list view, and whether the workspace should open in list view mode by default.

The following values can be specified for this type: 1. A list view layout. 2. A list view layout with the openInListMode property. 3. The value true indicating that a list view layout should be autogenerated. 4. An object with the openInListMode property, indicating that a list view layout should be autogenerated and overriding the global value of openInListMode. 5. The value false indicating that no list view should be shown in this workspace.

The openInListMode property mentioned above holds a boolean value indicating whether the workspace should open in list view mode by default. If not specified, then it will be derived from the global setting for all workspaces.

Any of the following

Anonymous Object Type

openInListMode	BooleanValue
style	Any of the following `{ }` StyleName IFirstMatchSelector<any> Array with any of the following `{ }` IFirstMatchSelector<any>
pane	PaneName
columns	Array<TableColumnType>
actions	Array<TableActionType>
columnChooser	ColumnChooser

IListView
IOpenInListMode
boolean

LocalCurrencyDisplayType

No description available

Locale

A locale string or an object with language and region properties. The locale should consist of a language code and a region code separated by an underscore, e.g., 'en_US'.

Any of the following

string
Anonymous Object Type

language	string
region	string

LocaleFormattingInfo

Formatting information for a specific locale, including date, time, and number formats.

Properties: shortDate, shortTime, decimal, group

shortDate required

The short date format pattern

Type: ShortDateFormat

shortTime required

The short time format pattern

Type: ShortTimeFormat

decimal required

The decimal separator character

Type: DecimalSeparator

group required

The digit grouping separator character

Type: GroupSeparator

LocalizableText

String alias for localizable, end-user visible, static titles.

MailElement

No description available

Any of the following

TemplateText
IMailValue

NavigationType

No description available

Any of the following

ICalendarNavigation
IFilterNavigation

NonConditionalRow

No description available

Any of the following

IElementRow
ILayoutRow
ITableRow
ITabsRow
IGridRow
IDocumentRow
IConversationRow
IEmbeddedRow
ISchedulerRow
IAlertRow

NotificationTypes

No description available

Map from string to INotificationType

PageName

String alias for internal references to wizard pages.

PagingBufferSizeType

Specifes the paging buffer in terms of a number of records or a number of pages.

Any of the following

Anonymous Object Type

records

number

Anonymous Object Type

pages

number

PairFormElementType

No description available

Properties: pair

pair required

No description available

Type: IPairElement

Palette

No description available

Any of the following

IOrderedPalette
INamedPalette

PaletteItem

No description available

Any of the following

Color
IPaletteItem

PaletteName

The name of an entire palette

Configuration of enumerations.

Type: IEnumerationConfiguration

dataExport

Configuration of export

Type: IDataExportConfiguration

QualifiedPaletteItemName

A reference to a palette item, e.g., "palette1.item2"

QueryValueExpression

No description available

Properties: value

value required

No description available

Type: Expression

QueryValueType

No description available

Any of the following

TemplateText
QueryValueExpression

RadioFormElementType

No description available

Properties: radio

radio required

No description available

Type: IRadioElement

ReferenceFormElementType

No description available

Properties: reference

reference required

No description available

Type: IReferenceElement

ReferencePoint

No description available

ReportLevelType

No description available

Any of the following

IReportLeafLevel
IReportSubtotalLevel

RestrictionType

No description available

Any of the following

IUnaryRestriction
IBinaryRestriction
TertiaryRestrictionType

ReusableInfoBubbleRegistry

No description available

Map from string to IReusableInfoBubbleDefinition

RowType

No description available

Any of the following

NonConditionalRow
IConditionalRow

SchedulerSlotDivision

No description available

One of: 15, 30, 60

SchedulerViewType

No description available

SearchOptions

Options used to configure searches across the workspaces.

Properties: textMatching

textMatching

The text matching property determines how search terms are matched against the values of a string field.

Default Value: startsWith

Type: TextMatchingStrategy

SearchResultAmountField

Represents a search result field that includes an amount with a specified currency.

Properties: appearance, title, titleValue, titleSource, source, currency

appearance

Properties: appearance, title, titleValue, titleSource, source

appearance

An optional property which determines which parts of a field element are displayed

Default Value: 'normal' for field specification types of 'amount', 'time', 'timeduration', 'boolean', 'date', 'integer', 'real'.

Default Value: 'maximized' for all other field specification types.

SearchResultField

FieldName

SearchResultPercentField

Represents a search result field with a hardcoded percent unit.

Properties: appearance, title, titleValue, titleSource, source

appearance

An optional property which determines which parts of a field element are displayed

Default Value: 'normal' for field specification types of 'amount', 'time', 'timeduration', 'boolean', 'date', 'integer', 'real'.

Default Value: 'maximized' for all other field specification types.

Type: AppearanceType

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

source required

The underlying pane field that provides data for this search.

Type: FieldName

SearchResultPercentFieldType

No description available

Properties: percent

percent required

No description available

Type: SearchResultPercentField

SearchResultReference

The search result reference represents a foreign key used for search results. It consists of a title block and a description/key pair.

The source of the reference can be specified in the following ways: 1. Using the foreignKey attribute. In this case, the fields for the description/key pair are determined automatically from the foreign-key. 2. Using the key and description attributes. This approach should be used if no foreign-key is available for the required fields. 3. Using the foreignKey attribute together with the key and/or description attributes. This method should be used if the fields determined automatically from the foreign-key are not correct in this context.

Any of the following

SearchResultReferenceWithForeignKey
SearchResultReferenceWithFields

SearchResultReferenceType

No description available

Properties: reference

reference required

No description available

Type: SearchResultReference

SearchResultReferenceWithFields

Represents a search result reference if no foreign key is available.

Properties: appearance, title, titleValue, titleSource, description, key

appearance

An optional property which determines which parts of a field element are displayed

Default Value: 'normal' for field specification types of 'amount', 'time', 'timeduration', 'boolean', 'date', 'integer', 'real'.

Type: ForeignKeyName

SearchResultType

Represents the type of field that can be inserted into a search result.

Any of the following

SearchResultFieldType
SearchResultReferenceType
SearchResultUnitFieldType
SearchResultAmountFieldType
SearchResultPercentFieldType

SearchResultUnitField

Represents a search result field that includes a unit describing the data of the field.

Properties: appearance, title, titleValue, titleSource, source, unit

appearance

An optional property which determines which parts of a field element are displayed

Default Value: 'normal' for field specification types of 'amount', 'time', 'timeduration', 'boolean', 'date', 'integer', 'real'.

SearchResultUnitFieldType

No description available

Properties: unitField

unitField required

No description available

Type: SearchResultUnitField

ShellConfiguration

The application shell represents the frame around the workspace area. It facilitates configuration of key components such as the menu, documentation links, notifications overview, conversations, report runs as well as auxiliary features like settings, change password and about information.

Properties: menu, documentationUrl, documentation, settings, notifications, conversations, analyzer, avatar

Possible short-date format patterns.

ShortTimeFormat

Possible short-time format patterns.

SolidGaugeSize

Preset size values of the solid gauge chart

One of: 100, 150, 190

SplitterOptions

A configuration determining the appearance and behavior of a splitter.

Properties: resizable, collapsible

resizable

Controls whether the splitter can resize the layout components that it splits.

Default Value: true

Type: BooleanValue

collapsible

Controls whether the splitter can collapse and thereby hide the last of the layout components that it splits.

Default Value: false

Type: BooleanValue

StateName

No description available

StatusFormElementType

No description available

Properties: status

status required

No description available

Type: IStatusElement

StatusTableColumnType

No description available

Properties: status

status required

No description available

Type: ITableStatusColumn

StyleName

**************** New Style API *****************

StyleRegistry

No description available

Map from string to AnyStyle

SumLineColumn

No description available

Any of the following

ISumLineFieldColumn
ISumLineTextColumn

TableActionColumnType

No description available

Properties: exportable, style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, template, icon

exportable

No description available

Default Value: false

Type: boolean

style

No description available

Type: Any of the following

Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

StyleName
IFirstMatchSelector<(&)>
Array with any of the following
- Anonymous Object Type

condition	Expression
color	Any of the following Color QualifiedPaletteItemName

* <a href="#ifirstmatchselector&lt;(&amp;)&gt;">IFirstMatchSelector&lt;(&amp;)&gt;</a>

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

titleValue

An optional title derived from the value of a field.

Type: FieldName

titleSource

An optional title derived from the specification title of another field.

Type: FieldName

label

Type: string

alt

An optional, alternative localizable title. If unspecified, a title will be provided.

Type: LocalizableText

mandatory

A predicate determining whether fields in this part of the layout part are shown as mandatory.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

open

A predicate determining whether fields in this part of the layout part are shown as open.

If not specified, then the predicate inherited from the parent will be used.

Type: Expression

visible

A visibility predicate determining whether this layout part is shown.

TableColumnType

No description available

Any of the following

FieldTableColumnType
LinkTableColumnType
ActionTableColumnType
TextTableColumnType
UnitFieldTableColumnType
AmountTableColumnType
PercentTableColumnType
FileSizeTableColumnType
StatusTableColumnType

TableHeightType

No description available

Any of the following

number
minimal

TableSwitchType

No description available

Any of the following

FieldName
ITableSwitch
Array with any of the following
- FieldName
- ITableSwitch

TemplateExpression

No description available

Properties: template

template required

No description available

Type: TemplateText

TemplateText

String alias for localizable, end-user visible titles that may contain expression placeholders.

TertiaryRestrictionType

A restriction using any of the tertiary operators.

Properties: operator, start, end

TitleType

No description available

Any of the following

LocalizableText
TitleElementType
TitleArrayType

TriggerType

A trigger that assigns a value to a field.

Properties: assign

assign required

No description available

Type: Anonymous Object Type

field	FieldName
value	Expression

UnaryOperatorType

No description available

UnitFieldFormElementType

No description available

Properties: unitField

unitField required

No description available

Type: IUnitFieldElement

UnitFieldTableColumnType

No description available

Properties: unitField

unitField required

No description available

Type: ITableUnitFieldColumn

UnitPositionType

No description available

URLElement

No description available

Any of the following

TemplateText
IURLValue

ValueExpression

No description available

Properties: value

value required

No description available

Type: Expression

ValueFormat

No description available

Any of the following

IAmountFormat
IAutoTimestampFormat
IBooleanFormat
IDateFormat
IEnumFormat
IIntegerFormat
IRealFormat
IStringFormat
ITimeFormat
ITimeDurationFormat
IPeoplePlannerColorFormat
IPeoplePlannerDateTimeFormat
IPeoplePlannerDoubleFormat
IPeoplePlannerFloatFormat
IPeoplePlannerGuidFormat
IPeoplePlannerIntegerFormat
IPeoplePlannerStringFormat

VerticalAlignType

No description available

WidgetType

No description available

WidthType

No description available

WizardSize

No description available

Any of the following

string
IWizardSize

Workspace

Configuration of an individual workspace. A workspace is defined by a unique name and a recognizable title. The data exposed by the workspace is set up in the data-bindings part, and the appearance of that data is defined by its layout.

Properties: title, name, proxyFor, state, definitions, dataBindings, layout

title

An optional, localizable title. If unspecified, a default title will be provided.

Type: LocalizableText

name required

The internal, unique, non-localizable name of the workspace.

Type: WorkspaceName

proxyFor

A workspace can act as a proxy for another workspace. If for instance the "MaconomyLongText_DailyTimeSheets" workspace specifies that it is a proxy for the "DailyTimeSheets" workspace then all links to "DailyTimeSheets" will be redirected to "MaconomyLongText_DailyTimeSheets".

Type: WorkspaceName

state

Optional marker to indicate if the workspace is in beta or test.

Type: WorkspaceState

definitions

Definitions of items that can be reused many times within this workspace.

Type: ILocalDefinitions

dataBindings required

Configuration of the panes that compose this workspace and how these panes are bound together.

Type: IDataBindings

layout required

Configuration of the layout of data and actions associated with this workspace.

Type: IWorkspaceLayout

WorkspaceConfiguration

Workspaces host the core logic of the web client. They represent workflows against particular parts of the Maconomy system and data. A workspace is consists of two main parts: data bindings and a layout.

Properties: workspaces, definitions

workspaces required

An ordered collection of workspaces

Type: Array<WorkspaceConfigurationItem>

definitions required

Global definitions contain pre-defined colors and other referrable items that span all workspaces. These definitions are used both for convenience and as a way of ensuring a uniform look and feel across all workspaces.

Type: IGlobalDefinitions

WorkspaceConfigurationItem

No description available

Any of the following

Workspace
WorkspaceGroup

WorkspaceGroup

A workspace group contains an ordered collection of workspaces.

Properties: workspaces

workspaces required

An ordered collection of workspaces

Type: Array<WorkspaceConfigurationItem>

WorkspaceLinkType

No description available

Any of the following

WorkspaceName
Anonymous Object Type

name	WorkspaceName
target	LinkTargetType

WorkspaceName

String alias for internal references to workspaces.

WorkspaceState

The state of a workspace can be used to indicate how production-ready it is.

ZeroThroughTen

No description available

One of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

ZipCityFormElementType

No description available

Properties: zipCity

zipCity required

No description available

Type: IZipCityElement

# ApplicationConfiguration

# api required

# application required

# platform required

# shell required

# workspace required

# ActionArgumentsType

# ActionName

# ActionOrGroup

# ActionSeparatorType

# ActionTableColumnType

# action required

# ActionType

# ActivityFormElementType

# activity required

# AddressFieldLineType

# AddressFormElementType

# address required

# AddressLineType

# AddressLinkLineType

# link required

# AddressReferenceLineType

# reference required

# AddressZipCityLineType

# zipCity required

# AmountFormElementType

# amount required

# AmountTableColumnType

# amount required

# AnalyzerReportName

# AnyStyle

# verticalAlign

# fontWeight

# textAlign

# backgroundColor

# color

# extends

# condition

# AppearanceType

# ApplicationConfigurationType

# version required

# AssistantHelp

# AssistantHelpDocument

# AssistantHelpTemplate

# pane

# template required

# AssistantName

# AssistantSelectorType

# AssistantSize

# BadgeStatusType

# BinaryOperatorType

# BindingType

# BooleanGroupElementType

# booleanGroup required

# BooleanValue

# CalendarSettings

# firstDayOfWeek required

# Chart

# ChartData

# CollapsibleOptions

# expanded required

# Color

# ColorRegistry

# ColumnChooser

# ColumnName

# ColumnType

# ContainerActionWithoutWizard

# arguments

# visible

# title

# confirmation

# source required

# ContainerActionWithWizard

# wizard required

# visible

# title

# confirmation

# source required

# ContainerName

# ContainerParameterType

ApplicationConfiguration

api required

application required

platform required

shell required

workspace required

ActionArgumentsType

ActionName

ActionOrGroup

ActionSeparatorType

ActionTableColumnType

action required

ActionType

ActivityFormElementType

activity required

AddressFieldLineType

AddressFormElementType

address required

AddressLineType

AddressLinkLineType

link required

AddressReferenceLineType

reference required

AddressZipCityLineType

zipCity required

AmountFormElementType

amount required

AmountTableColumnType

amount required

AnalyzerReportName

AnyStyle

verticalAlign

fontWeight

textAlign

backgroundColor

color

extends

condition

AppearanceType

ApplicationConfigurationType

version required

AssistantHelp

AssistantHelpDocument

AssistantHelpTemplate

pane

template required

AssistantName

AssistantSelectorType

AssistantSize

BadgeStatusType

BinaryOperatorType

BindingType

BooleanGroupElementType

booleanGroup required

BooleanValue

CalendarSettings

firstDayOfWeek required

Chart

ChartData

CollapsibleOptions

expanded required

Color

ColorRegistry

ColumnChooser

ColumnName

ColumnType

ContainerActionWithoutWizard

arguments

visible

title

confirmation

source required

ContainerActionWithWizard

wizard required

visible

title

confirmation

source required

ContainerName

ContainerParameterType