Configuration API Reference

The following section gives an overview of all parts of the configuration API. Each configuration part consists of a JSON object with a set of properties.

ActionName

String alias for an action.

AnalyzerReportName

String alias for internal references to an analyzer report.

Application

The application name and version.

Properties: version

version

The version of this particular application. This version number is NOT related to core Maconomy versions.

Type	Required	Default Value
string	true	n/a

BindingType

No description available

BooleanValue

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

BooleanValue_1

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

Chart

No description available

CollapsibleOptions

Configuration of a collapsible layout part.

Properties: expanded

expanded

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

Type	Required	Default Value
BooleanValue_1	true	n/a

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.

Color_1

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.

ColumnChooser

No description available

Configuration API

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

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

Type	Required	Default Value
string	true	n/a

application

The application name and version.

Type	Required	Default Value
Application	true	n/a

platform

General configuration that spans the entire application

Type	Required	Default Value
IPlatformConfiguration	true	n/a

shell

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

Type	Required	Default Value
IShellConfiguration	true	n/a

workspace

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

Type	Required	Default Value
IWorkspaceConfiguration	true	n/a

ContainerName

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

ContainerSpecificationType

No description available

Containers

Represents a hierarchy of container configurations

DateTimeField

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

EmployeeLookup

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

Properties: restriction, limit

restriction

An optional restriction to be applied when searching for employees. For example: "not Blocked".

Type	Required	Default Value
Expression	false	n/a

limit

The maximum number of employees that will be loaded for the employee search.

Type	Required	Default Value
number	false	n/a

Expression

String alias for an expression.

Expression_1

String alias for an expression.

FamilyType

No description available

FieldName

String alias for field source/model names.

FieldName_1

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.

Formatting

Configure formatting rules for data types.

Properties: amount, autotimestamp, boolean, date, enum, integer, real, string, time, timeduration, pp:color, pp:datetime, pp:double, pp:float, pp:guid, pp:integer, pp:string

amount

No description available

Type	Required	Default Value
IAmountFormatting	false	n/a

autotimestamp

No description available

Type	Required	Default Value
IAutoTimestampFormatting	false	n/a

boolean

No description available

Type	Required	Default Value
IBooleanFormatting	false	n/a

date

No description available

Type	Required	Default Value
IDateFormatting	false	n/a

enum

No description available

Type	Required	Default Value
IEnumFormatting	false	n/a

integer

No description available

Type	Required	Default Value
IIntegerFormatting	false	n/a

real

No description available

Type	Required	Default Value
IRealFormatting	false	n/a

string

No description available

Type	Required	Default Value
IStringFormatting	false	n/a

time

No description available

Type	Required	Default Value
ITimeFormatting	false	n/a

timeduration

No description available

Type	Required	Default Value
ITimeDurationFormatting	false	n/a

pp:color

No description available

Type	Required	Default Value
IPeoplePlannerColorFormatting	false	n/a

pp:datetime

No description available

Type	Required	Default Value
IPeoplePlannerDateTimeFormatting	false	n/a

pp:double

No description available

Type	Required	Default Value
IPeoplePlannerDoubleFormatting	false	n/a

pp:float

No description available

Type	Required	Default Value
IPeoplePlannerFloatFormatting	false	n/a

pp:guid

No description available

Type	Required	Default Value
IPeoplePlannerGuidFormatting	false	n/a

pp:integer

No description available

Type	Required	Default Value
IPeoplePlannerIntegerFormatting	false	n/a

pp:string

No description available

Type	Required	Default Value
IPeoplePlannerStringFormatting	false	n/a

Grid

No description available

IActionGroup

No description available

Properties: actions, title, visible

actions

No description available

Type	Required	Default Value
array [IWizardInvocationAction, IContainerAction, string]	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

IActionsRow

Represents a row containing actions.

IActivityElement

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

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

user

No description available

Type	Required	Default Value
FieldName	true	n/a

date

No description available

Type	Required	Default Value
FieldName	true	n/a

color

No description available

Type	Required	Default Value
Color_1	true	n/a

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

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	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

IAddressElement

The address element.

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

lines

An array of the lines contained within the address.

Type	Required	Default Value
array [IAddressFieldLine, IAddressReferenceLine, IAddressReferenceWithFieldsLine, IAddressZipCityLine, IAddressLinkLine, string]	true	n/a

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

IAddressFieldLine

The address field lines.

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

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

source

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

Type	Required	Default Value
FieldName	true	n/a

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.

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

IAddressLinkLine

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

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

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

icon

No description available

Type	Required	Default Value
string	false	n/a

authentication

No description available

Type	Required	Default Value
IURLAuthenticationMethod	false	n/a

url

No description available

Type	Required	Default Value
URLElement_1	false	n/a

workspace

No description available

Type	Required	Default Value
WorkspaceLinkType	false	n/a

mail

No description available

Type	Required	Default Value
MailElement	false	n/a

query

No description available

Type	Required	Default Value
array [IQueryElement]	false	n/a

template

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

alt

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

Type	Required	Default Value
LocalizableText_1	false	n/a

IAddressReferenceLine

The address reference lines.

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

description

No description available

Type	Required	Default Value
IInputBlock, string	false	n/a

key

No description available

Type	Required	Default Value
IInputBlock, string	false	n/a

foreignKey

No description available

Type	Required	Default Value
string	true	n/a

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.

Type	Required	Default Value
FieldSearchType	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

IAddressReferenceWithFieldsLine

The address reference lines.

Properties: description, key, visible, open, mandatory

description

No description available

Type	Required	Default Value
IInputBlock, string	true	n/a

key

No description available

Type	Required	Default Value
IInputBlock, string	true	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

IAddressZipCityLine

The address zip-city lines.

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

zip

No description available

Type	Required	Default Value
IInputBlock, string	true	n/a

city

No description available

Type	Required	Default Value
IInputBlock, string	true	n/a

zipFirst

No description available

Type	Required	Default Value
boolean	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

IAlert

Configuration of the alert component.

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

template

The template text for the alert component.

Type	Required	Default Value
TemplateText	true	n/a

visible

An optional visibility expression for the alert component.

Type	Required	Default Value
Expression	false	n/a

title

An optional title for the alert component.

Type	Required	Default Value
LocalizableText_1	false	n/a

icon

An optional icon for the alert component.

Type	Required	Default Value
IconName_1	false	n/a

color

Color for the alert component.

Type	Required	Default Value
Color_1	true	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

IAlertRow

Represents a row containing an alert component.

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

alert

An alert component.

Type	Required	Default Value
IAlert	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

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.

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
boolean	false	n/a

IAmountElement

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

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

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

currency

No description available

Type	Required	Default Value
FieldName	true	n/a

source

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

Type	Required	Default Value
FieldName	true	n/a

search

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

validators

No description available

Type	Required	Default Value
array [IValidator]	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&ITextAlign&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&ITextAlign&IConditionalStyle>], string	false	n/a

IAmountFormatting

No description available

IAnalyzerItem

No description available

Properties: analyzer, visible

analyzer

The name of the analyzer report.

Type	Required	Default Value
AnalyzerReportName	true	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

IAppearance

No description available

IAutoTimestampFormatting

No description available

IAvailableFormats

No description available

IBadge

Graphical decoration of a layout group.

IBindingSpecification

No description available

Properties: binding, container

binding

No description available

Type	Required	Default Value
BindingType	true	n/a

container

No description available

Type	Required	Default Value
ContainerSpecificationType	true	n/a

IBooleanFormatting

No description available

ICancelTransition

No description available

IChartColumn

No description available

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

chart

No description available

Type	Required	Default Value
Chart	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

span

A columns be optionally be set to span a number of columns. Each column spans 1 column as default. When setting a span of 1 - 2 - 1 then the middle column will span 50% of the available space leaving 25% to the two other columns. 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	Required	Default Value
number	false	n/a

offset

Column offset.

Type	Required	Default Value
number	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
boolean	false	n/a

IConditionalClauses

Conditional clauses *

IConditionalRow

Represents a layout row which can be shown conditionally.

Properties: if, pane, label, style

if

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	Required	Default Value
IConditionalClauses	true	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

IContainer

An search container associated with a search layout.

Properties: name, family

name

The name of the search container.

Type	Required	Default Value
ContainerName	true	n/a

family

The family where the container is defined.

Type	Required	Default Value
FamilyType	true	n/a

IContainerAction

Represents a single action.

Properties: source, wizard, confirmation, title, visible

source

The name of the action to be shown.

Type	Required	Default Value
ActionName	true	n/a

wizard

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

Type	Required	Default Value
IWizardInvocation_1	false	n/a

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	Required	Default Value
unknown	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

IConversation

The conversation component shows a conversation attached to a particular Maconomy object (such as a job or a vendor invoice). A conversation is identified by a relation name (e.g. JobHeader), a conversation type (e.g. Job) and an instance key of the record in the specified relation (e.g. a key for a particular job).

Properties: relationName, conversationType, objectInstanceKey, title, pane, height

relationName

The internal name of the database relation to which the conversation is attached. For example: "JobHeader".

Type	Required	Default Value
string	true	n/a

conversationType

The conversation type. For example: "Job".

Type	Required	Default Value
string	true	n/a

objectInstanceKey

The instance key of the object associated with the conversation. For example: "JobsFilter.InstanceKey".

Type	Required	Default Value
Expression_1	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

height

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

Type	Required	Default Value
number	false	n/a

IConversationColumn

Represents a conversation column.

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

conversation

A conversation component.

Type	Required	Default Value
IConversation	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

span

Type	Required	Default Value
number	false	n/a

offset

Column offset.

Type	Required	Default Value
number	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
boolean	false	n/a

IConversationConfiguration

Configuration of the conversation functionality.

Properties: enabled, refreshInterval, employeeLookup, conversationTypes

enabled

Determines if the conversation functionality is enabled. For example: "true".

Type	Required	Default Value
Expression_1	true	n/a

refreshInterval

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	Required	Default Value
number	true	n/a

employeeLookup

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

Type	Required	Default Value
EmployeeLookup	false	n/a

conversationTypes

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	Required	Default Value
type-conversationtypes	true	n/a

IConversationRow

Represents a row containing a conversation component.

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

conversation

A conversation component.

Type	Required	Default Value
IConversation	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
boolean	false	n/a

IDataBindings

No description available

Properties: container

container

No description available

Type	Required	Default Value
ContainerSpecificationType	true	n/a

IDataExportConfiguration

No description available

IDateFormatting

No description available

IDefaultWorkspaceCandidate

No description available

Properties: workspace, condition

workspace

references a workspace in the menu

Type	Required	Default Value
WorkspaceName	true	n/a

condition

Condition that determines if this workspace can be used as a default or startup workspace.

Type	Required	Default Value
Expression	false	n/a

IDialElement

Dial elements (or dial charts) are used render a single value, optionally against a backdrop of predefined zones.

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

start

No description available

Type	Required	Default Value
number	true	n/a

end

No description available

Type	Required	Default Value
number	true	n/a

regions

No description available

Type	Required	Default Value
array [IDialRegion]	true	n/a

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

source

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

Type	Required	Default Value
FieldName	true	n/a

search

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

validators

No description available

Type	Required	Default Value
array [IValidator]	false	n/a

IDialRegion

Representation of a single region on a dial chart.

Properties: start, end, color

start

No description available

Type	Required	Default Value
number	true	n/a

end

No description available

Type	Required	Default Value
number	true	n/a

color

No description available

Type	Required	Default Value
string	true	n/a

IDocument

Configuration of the document viewer

Properties: title, height, pane, style

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

height

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

Type	Required	Default Value
number	false	n/a

pane

The pane used to resolve unqualified references in this scope.

Type	Required	Default Value
PaneName	true	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

IDocumentRow

Represents a row containing a data viewer.

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

document

A document viewer.

Type	Required	Default Value
IDocument	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
boolean	false	n/a

IElementColumn

Represents a layout column which contain elements.

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

elements

An array of the elements contained in this scope

Type	Required	Default Value
array [IFieldElement, IIntervalElement, IReferenceElement, IUnitFieldElement, IAmountElement, IActivityElement, IAddressElement, IDialElement, IPairElement, ILinkElement, IStatusElement, ITextElement, IPercentElement, IZipCityElement, string]	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

span

Type	Required	Default Value
number	false	n/a

offset

Column offset.

Type	Required	Default Value
number	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
IRendering	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

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	Required	Default Value
boolean	false	n/a

IElementRow

Represents a row that contains a single element column.

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

elements

An array of the elements contained in this scope

Type	Required	Default Value
array [IFieldElement, IIntervalElement, IReferenceElement, IUnitFieldElement, IAmountElement, IActivityElement, IAddressElement, IDialElement, IPairElement, ILinkElement, IStatusElement, ITextElement, IPercentElement, IZipCityElement, string]	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
IRendering	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

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	Required	Default Value
boolean	false	n/a

IEmbed

Configuration of the embedded iframe component.

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

authentication

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

Type	Required	Default Value
IURLAuthenticationMethod	false	n/a

url

The URL hosting the external component.

Type	Required	Default Value
URLElement	true	n/a

query

An optional set of query parameters to qualify the URL.

Type	Required	Default Value
array [IQueryElement]	false	n/a

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	Required	Default Value
boolean	false	n/a

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	Required	Default Value
IRefreshTrigger	false	n/a

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	Required	Default Value
array [string]	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

IEmbeddedRow

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

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

embed

A document viewer.

Type	Required	Default Value
IEmbed	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
boolean	false	n/a

IEnumFormatting

No description available

IEnumerationConfiguration

No description available

IEnums_1

A list of client-side enumeration type definitions.

IEventColor

No description available

IFieldElement

Field elements are used for data entry.

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

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

source

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

Type	Required	Default Value
FieldName	true	n/a

search

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

validators

No description available

Type	Required	Default Value
array [IValidator]	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&ITextAlign&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&ITextAlign&IConditionalStyle>], string	false	n/a

IFieldFormatting

Type	Required	Default Value
string	false	n/a

fixed

No description available

Type	Required	Default Value
boolean	false	n/a

available

No description available

Type	Required	Default Value
IAvailableFormats	true	n/a

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

Info-bubbles that can be used across all workspaces.

Type	Required	Default Value
type-reusableinfobubbleregistry	true	n/a

sizes

Mapping between symbolic names to pixel width.

Type	Required	Default Value
Sizes	true	n/a

styles

Reusable style definitions that can be applied across all workspaces.

Type	Required	Default Value
type-styleregistry	true	n/a

colors

Reusable colors used across different workspaces

Type	Required	Default Value
type-colorregistry	true	n/a

tables

Global configuration for tables *

Type	Required	Default Value
ITableProperties	true	n/a

searchLayouts

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

Type	Required	Default Value
IGlobalSearchLayouts	true	n/a

enums

Client-side enumeration types.

Type	Required	Default Value
IEnums_1	true	n/a

palettes

Palettes containing a list of colors

Type	Required	Default Value
IPalettes	true	n/a

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

No description available

Type	Required	Default Value
array [IGlobalSearchLayouts, IContainer, string]	true	n/a

IGridRow

Represents a row containing a grid structure.

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

grid

A grid.

Type	Required	Default Value
Grid	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
IRendering	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

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	Required	Default Value
boolean	false	n/a

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.

IInfoBubbleDefinition

A definition of an inline info-bubble.

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

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	Required	Default Value
WidthType	false	n/a

position

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

Type	Required	Default Value
IInfoBubblePosition	false	n/a

title

The title or heading of the info bubble

Type	Required	Default Value
IInfoBubbleTitleType	false	n/a

subTitle

The sub heading of the info bubble

Type	Required	Default Value
IInfoBubbleTitleType	false	n/a

rows

The rows or content of the info bubble

Type	Required	Default Value
array [IElementRow, ILayoutRow, ITableRow, ITabsRow, IGridRow, IDocumentRow, IConversationRow, IEmbeddedRow, ISchedulerRow, IAlertRow, IConditionalRow]	true	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

IInfoBubblePosition

No description available

IInfoBubbleReference

A reference to a reusable info-bubble.

Properties: ref, parameters

ref

No description available

Type	Required	Default Value
InfoBubbleName	true	n/a

parameters

No description available

Type	Required	Default Value
unknown	true	n/a

IInfoBubbleTitleType

No description available

IInputBlock

Read-write block for performing data entry.

Properties: source, search, widget, shadowTitle, label, autoSubmit, open, mandatory

source

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

Type	Required	Default Value
FieldName	true	n/a

search

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

IIntegerFormatting

No description available

IIntervalElement

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

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

from

No description available

Type	Required	Default Value
IInputBlock, string	true	n/a

to

No description available

Type	Required	Default Value
IInputBlock, string	true	n/a

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

IKpiColumn

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

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

kpi

No description available

Type	Required	Default Value
IKpiElement	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

span

Type	Required	Default Value
number	false	n/a

offset

Column offset.

Type	Required	Default Value
number	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

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	Required	Default Value
boolean	false	n/a

IKpiElement

No description available

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

value

No description available

Type	Required	Default Value
KpiValueType	true	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

format

No description available

Type	Required	Default Value
IFieldFormatting	false	n/a

height

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

Type	Required	Default Value
number	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IBackgroundColor&IColor&IConditionalStyle&IExtendedStyle>, array [string, IFirstMatchSelector<IBackgroundColor&IColor&IConditionalStyle&IExtendedStyle>], string	false	n/a

ILanguageConfiguration

No description available

Properties: preferred, fixed

preferred

The preferred locale, e.g., 'da_DK'

Type	Required	Default Value
string	true	n/a

fixed

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	Required	Default Value
boolean	true	n/a

ILayoutColumn

Represents a layout column which lays out its contents vertically.

Properties: rows, title, pane, span, offset, collapsible, visible, label, style, rendering, open, mandatory, island

rows

An array of layout rows.

Type	Required	Default Value
array [IElementRow, ILayoutRow, ITableRow, ITabsRow, IGridRow, IDocumentRow, IConversationRow, IEmbeddedRow, ISchedulerRow, IAlertRow, IConditionalRow]	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

span

Type	Required	Default Value
number	false	n/a

offset

Column offset.

Type	Required	Default Value
number	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
IRendering	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

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	Required	Default Value
boolean	false	n/a

ILayoutRow

Represents a layout row which lays out its contents horizontally.

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

columns

An array of layout columns.

Type	Required	Default Value
array [ILayoutColumn, IChartColumn, IKpiColumn, IConversationColumn, IElementColumn]	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

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.

Type	Required	Default Value
SplitterOptions, unknown	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
IRendering	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

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	Required	Default Value
boolean	false	n/a

ILayoutSettings

No description available

Properties: grabHorizontalSpace

grabHorizontalSpace

When enabled the workspace will have narrow margins and grab the horizontal space available.

Type	Required	Default Value
boolean	true	n/a

ILinkElement

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

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

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

icon

No description available

Type	Required	Default Value
string	false	n/a

authentication

No description available

Type	Required	Default Value
IURLAuthenticationMethod	false	n/a

url

No description available

Type	Required	Default Value
URLElement_1	false	n/a

workspace

No description available

Type	Required	Default Value
WorkspaceLinkType	false	n/a

mail

No description available

Type	Required	Default Value
MailElement	false	n/a

query

No description available

Type	Required	Default Value
array [IQueryElement]	false	n/a

template

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

alt

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

Type	Required	Default Value
LocalizableText_1	false	n/a

ILinkItem

A representation of a single menu item which opens an external URL.

Properties: url, visible, title

url

Link to an external URL that should be opened.

Type	Required	Default Value
string	true	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

title

An mandatory, localizable title.

Type	Required	Default Value
LocalizableText	true	n/a

IListView

Represents a layout for a list view.

Properties: columns, actions, columnChooser, pane, style

columns

No description available

Type	Required	Default Value
array [ITableFieldColumn, ITableLinkColumn, TableActionColumnType, ITableTextColumn, ITableUnitFieldColumn, ITableAmountColumn, ITablePercentColumn, ITableFileSizeColumn, ITableStatusColumn, string]	true	n/a

actions

No description available

Type	Required	Default Value
array [IWizardInvocationAction, IContainerAction, string]	false	n/a

columnChooser

No description available

Type	Required	Default Value
ColumnChooser	false	n/a

pane

The pane used to resolve unqualified references in this scope.

Type	Required	Default Value
PaneName	true	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

ILocalDefinitions

Definitions that are used to share common referable items within a single workspace.

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.

Type	Required	Default Value
boolean	false	n/a

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.

Type	Required	Default Value
array [IDefaultWorkspaceCandidate, string]	false	n/a

groups

The set of menu groups available in the menu.

Type	Required	Default Value
array [IMenuGroup]	true	n/a

IMenuGroup

A group of workspaces arranged under a common title

Properties: items, icon, expanded, visible, title

items

The workspaces or links contained in this menu group.

Type	Required	Default Value
array [IMenuGroup, IWorkspaceItem, ILinkItem, IAnalyzerItem, string]	false	n/a

icon

An optional icon for the menu group.

Type	Required	Default Value
string	false	n/a

expanded

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

Type	Required	Default Value
BooleanValue	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

title

An mandatory, localizable title.

Type	Required	Default Value
LocalizableText	true	n/a

INotificationConfiguration

Represents the configuration of notification reload and recalculation intervals.

Properties: recalculation, types

recalculation

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	Required	Default Value
Recalculation	true	n/a

types

Supported notification types as specified in the MNSL files.

Type	Required	Default Value
type-notificationtypes	true	n/a

IPageLayouts

No description available

IPairElement

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

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

first

No description available

Type	Required	Default Value
IInputBlock, string	true	n/a

second

No description available

Type	Required	Default Value
IInputBlock, string	true	n/a

ratio

No description available

Type	Required	Default Value
string	false	n/a

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

IPercentElement

The percent element represents a field element with a hardcoded percent unit.

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

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

source

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

Type	Required	Default Value
FieldName	true	n/a

search

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

validators

No description available

Type	Required	Default Value
array [IValidator]	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&ITextAlign&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&ITextAlign&IConditionalStyle>], string	false	n/a

IPlatformConfiguration

No description available

Properties: usageTracking, containers, typeAhead, language, enums, dataExport, maconomyContainerWebServiceVersion

usageTracking

No description available

Type	Required	Default Value
IUsageTrackingConfiguration	true	n/a

containers

Additional configuration for containers on a Maconomy installation.

Type	Required	Default Value
Containers	true	n/a

typeAhead

Configuration of the type-ahead functionality.

Type	Required	Default Value
ITypeAheadConfiguration	false	n/a

language

The language configuration determines default language and whether the end-user can change language.

Type	Required	Default Value
ILanguageConfiguration	true	n/a

enums

Configuration of enumerations.

Type	Required	Default Value
IEnumerationConfiguration	false	n/a

dataExport

Configuration of export

Type	Required	Default Value
IDataExportConfiguration	false	n/a

maconomyContainerWebServiceVersion

The version number of the Maconomy Container Web Service REST API to use. If not specified, then version two will be used.

Type	Required	Default Value
number	false	n/a

IReportRunsDropDownConfiguration

No description available

Properties: initialRefreshReportRunsSeconds, refreshReportRunsSeconds, firstUpdateReportRunsSeconds, secondUpdateReportRunsSeconds

initialRefreshReportRunsSeconds

The waiting time before the first refresh of the report runs drop down menu is done

Type	Required	Default Value
number	true	n/a

refreshReportRunsSeconds

The waiting time between refreshes of the report runs drop down menu after the first refresh of the report runs drop menu

Type	Required	Default Value
number	true	n/a

firstUpdateReportRunsSeconds

Indicates the wait time before the first report run update after the report run has been started (this allows the report runs to capture the RUNNING report run state)

Type	Required	Default Value
number	true	n/a

secondUpdateReportRunsSeconds

Indicates the wait time after the report report run has CANCELLED, FAILED or FINISHED (this allows the report runs to capture the report run state after it being CANCELLED, FAILED or FINISHED)

Type	Required	Default Value
number	true	n/a

IReportsMenuConfiguration

No description available

Properties: refreshReportsMenuSeconds

refreshReportsMenuSeconds

The waiting time between refreshes of the reports menu drop down

Type	Required	Default Value
number	true	n/a

IScheduler

Configuration of the scheduler.

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

title

The text to show in the title of the scheduler.

Type	Required	Default Value
TemplateText_1	false	n/a

defaultView

The default view for the scheduler.

Type	Required	Default Value
SchedulerViewType	false	n/a

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	Required	Default Value
Period	false	n/a

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	Required	Default Value
View	false	n/a

slot

No description available

Type	Required	Default Value
SchedulerSlotDivision	false	n/a

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	Required	Default Value
IWizardInvocationWithOptionalPane	false	n/a

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	Required	Default Value
IWizardInvocationWithOptionalPane	false	n/a

events

Configures the events list in the scheduler.

Type	Required	Default Value
ISchedulerEventConfiguration	true	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

ISchedulerEventConfiguration

No description available

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

pane

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	Required	Default Value
PaneName	true	n/a

title

The text to show in the title of the event.

Type	Required	Default Value
TemplateText_1	false	n/a

color

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

Type	Required	Default Value
IEventColor	false	n/a

actions

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	Required	Default Value
array [IWizardInvocationAction, IContainerAction, string]	true	n/a

start

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

Type	Required	Default Value
DateTimeField	true	n/a

end

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

Type	Required	Default Value
DateTimeField	true	n/a

elements

The layout for the event.

Type	Required	Default Value
array [IFieldElement, IReferenceElement, IUnitFieldElement, IAmountElement, IPercentElement, string]	true	n/a

ISchedulerRow

Represents a row containing a scheduler component.

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

scheduler

A scheduler

Type	Required	Default Value
IScheduler	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
boolean	false	n/a

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.

ISettings

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

Properties: formats, minutesThreshold, menuSearch, images, layout, formatting, userInactivityInterval

formats

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

Type	Required	Default Value
IFormats	true	n/a

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.

Type	Required	Default Value
number	false	n/a

menuSearch

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

Type	Required	Default Value
boolean	true	n/a

images

The images configuration determines if the images are enabled

Type	Required	Default Value
boolean	true	n/a

layout

The layout configuration determines the margin of the workspace.

Type	Required	Default Value
ILayoutSettings	true	n/a

formatting

Configure formatting rules for data types.

Type	Required	Default Value
Formatting	true	n/a

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.

Type	Required	Default Value
number	false	n/a

IShellConfiguration

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

Properties: menu, documentationUrl, settings, notifications, conversations, reportrunsdropdown, reportsmenu, avatar

No description available

Type	Required	Default Value
IMenu	true	n/a

documentationUrl

The URL used for hosted help. Can be a simple string with variables such as <version>.

Type	Required	Default Value
string	true	n/a

settings

No description available

Type	Required	Default Value
ISettings	true	n/a

notifications

No description available

Type	Required	Default Value
INotificationConfiguration	true	n/a

conversations

No description available

Type	Required	Default Value
IConversationConfiguration	true	n/a

reportrunsdropdown

No description available

Type	Required	Default Value
IReportRunsDropDownConfiguration	true	n/a

reportsmenu

No description available

Type	Required	Default Value
IReportsMenuConfiguration	true	n/a

avatar

An optional avatar that will be shown in the top right corner of the navigation bar.

Type	Required	Default Value
Image	false	n/a

ISidePanel

The side panel definition. Side panels can only exist within a tab, and each tab can hold only one side panel.

IStatusElement

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

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

color

A color indicating the status of the element.

Type	Required	Default Value
Color	false	n/a

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

source

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

Type	Required	Default Value
FieldName	true	n/a

mask

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	Required	Default Value
unknown	true	n/a

IStringFormatting

No description available

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: title, badge, sticky, actions, sidePanel, rows, pane, span, offset, collapsible, visible, label, style, rendering, open, mandatory, island

title

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

Type	Required	Default Value
LocalizableText	true	n/a

badge

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

Type	Required	Default Value
IBadge	false	n/a

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.

Type	Required	Default Value
boolean	false	n/a

actions

The actions to be shown in this tab.

Type	Required	Default Value
array [IWizardInvocationAction, IContainerAction, IActionGroup, string]	false	n/a

sidePanel

An optional panel within this tab. Usually used to hold the UI for selection criteria

Type	Required	Default Value
ISidePanel	false	n/a

rows

An array of layout rows.

Type	Required	Default Value
array [IElementRow, ILayoutRow, ITableRow, ITabsRow, IGridRow, IDocumentRow, IConversationRow, IEmbeddedRow, ISchedulerRow, IAlertRow, IConditionalRow]	true	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

span

Type	Required	Default Value
number	false	n/a

offset

Column offset.

Type	Required	Default Value
number	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
IRendering	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

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	Required	Default Value
boolean	false	n/a

ITable

No description available

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

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	Required	Default Value
TableHeightType	false	n/a

pageable

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

Type	Required	Default Value
boolean	false	n/a

columns

No description available

Type	Required	Default Value
array [ITableFieldColumn, ITableLinkColumn, TableActionColumnType, ITableTextColumn, ITableUnitFieldColumn, ITableAmountColumn, ITablePercentColumn, ITableFileSizeColumn, ITableStatusColumn, string]	true	n/a

No description available

Type	Required	Default Value
ITableFooter	false	n/a

actions

No description available

Type	Required	Default Value
array [IWizardInvocationAction, IContainerAction, string]	false	n/a

assistant

No description available

Type	Required	Default Value
ITableAssistant	false	n/a

columnChooser

No description available

Type	Required	Default Value
ColumnChooser	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

identifier

An optional identifier used for disambiguation of user settings

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&IConditionalStyle>], string	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

ITableAmountColumn

No description available

Properties: currency, source, search, widget, shadowTitle, label, autoSubmit, open, mandatory, info, validators, width, suppress, visible, alt, titleValue, titleSource, title, style

currency

No description available

Type	Required	Default Value
FieldName	true	n/a

source

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

Type	Required	Default Value
FieldName	true	n/a

search

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

validators

No description available

Type	Required	Default Value
array [IValidator]	false	n/a

width

No description available

Type	Required	Default Value
WidthType	false	n/a

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type	Required	Default Value
Expression	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

alt

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

Type	Required	Default Value
LocalizableText_1	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&IConditionalStyle>], string	false	n/a

ITableAssistant

No description available

ITableFieldColumn

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

Properties: source, search, widget, shadowTitle, label, autoSubmit, open, mandatory, info, validators, width, suppress, visible, alt, titleValue, titleSource, title, style

source

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

Type	Required	Default Value
FieldName	true	n/a

search

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

validators

No description available

Type	Required	Default Value
array [IValidator]	false	n/a

width

No description available

Type	Required	Default Value
WidthType	false	n/a

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type	Required	Default Value
Expression	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

alt

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

Type	Required	Default Value
LocalizableText_1	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&IConditionalStyle>], string	false	n/a

ITableFileSizeColumn

No description available

Properties: source, search, widget, shadowTitle, label, autoSubmit, open, mandatory, info, validators, width, suppress, visible, alt, titleValue, titleSource, title, style

source

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

Type	Required	Default Value
FieldName	true	n/a

search

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

validators

No description available

Type	Required	Default Value
array [IValidator]	false	n/a

width

No description available

Type	Required	Default Value
WidthType	false	n/a

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type	Required	Default Value
Expression	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

alt

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

Type	Required	Default Value
LocalizableText_1	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&IConditionalStyle>], string	false	n/a

ITableFooter

No description available

ITableLinkColumn

No description available

Properties: icon, authentication, url, workspace, mail, query, template, label, alt, width, suppress, visible, open, mandatory, titleValue, titleSource, title, style, exportable

icon

No description available

Type	Required	Default Value
string	false	n/a

authentication

No description available

Type	Required	Default Value
IURLAuthenticationMethod	false	n/a

url

No description available

Type	Required	Default Value
URLElement_1	false	n/a

workspace

No description available

Type	Required	Default Value
WorkspaceLinkType	false	n/a

mail

No description available

Type	Required	Default Value
MailElement	false	n/a

query

No description available

Type	Required	Default Value
array [IQueryElement]	false	n/a

template

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

alt

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

Type	Required	Default Value
LocalizableText_1	false	n/a

width

No description available

Type	Required	Default Value
WidthType	false	n/a

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type	Required	Default Value
Expression	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&IConditionalStyle>], string	false	n/a

exportable

No description available

Type	Required	Default Value
boolean	false	n/a

ITablePercentColumn

No description available

Properties: source, search, widget, shadowTitle, label, autoSubmit, open, mandatory, info, validators, width, suppress, visible, alt, titleValue, titleSource, title, style

source

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

Type	Required	Default Value
FieldName	true	n/a

search

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

validators

No description available

Type	Required	Default Value
array [IValidator]	false	n/a

width

No description available

Type	Required	Default Value
WidthType	false	n/a

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type	Required	Default Value
Expression	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

alt

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

Type	Required	Default Value
LocalizableText_1	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&IConditionalStyle>], string	false	n/a

ITableProperties

Common table properties.

Properties: columnChooser

columnChooser

Based on the expression you define if a column chooser should be visible on all tables.

Type	Required	Default Value
Expression_1	true	n/a

ITableRow

Represents a row containing a table/grid structure.

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

table

A grid of table columns and with header, body, and footer.

Type	Required	Default Value
ITable	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
boolean	false	n/a

ITableStatusColumn

No description available

Properties: source, mask, label, width, suppress, visible, open, mandatory, alt, titleValue, titleSource, title, style

source

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

Type	Required	Default Value
FieldName	true	n/a

mask

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	Required	Default Value
unknown	true	n/a

label

Type	Required	Default Value
string	false	n/a

width

No description available

Type	Required	Default Value
WidthType	false	n/a

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type	Required	Default Value
Expression	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

alt

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

Type	Required	Default Value
LocalizableText_1	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&IConditionalStyle>], string	false	n/a

ITableTextColumn

No description available

Properties: template, label, info, width, suppress, visible, open, mandatory, alt, titleValue, titleSource, title, style

template

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

width

No description available

Type	Required	Default Value
WidthType	false	n/a

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type	Required	Default Value
Expression	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

alt

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

Type	Required	Default Value
LocalizableText_1	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&IConditionalStyle>], string	false	n/a

ITableUnitFieldColumn

No description available

Properties: unit, source, search, widget, shadowTitle, label, autoSubmit, open, mandatory, info, validators, width, suppress, visible, alt, titleValue, titleSource, title, style

unit

No description available

Type	Required	Default Value
IUnitBlock	true	n/a

source

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

Type	Required	Default Value
FieldName	true	n/a

search

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

label

Type	Required	Default Value
string	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

validators

No description available

Type	Required	Default Value
array [IValidator]	false	n/a

width

No description available

Type	Required	Default Value
WidthType	false	n/a

suppress

A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.

Type	Required	Default Value
Expression	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

alt

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

Type	Required	Default Value
LocalizableText_1	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&IConditionalStyle>], string	false	n/a

ITabsRow

Represents a group of tabs. Tabs are used to group layout columns such that only one column is shown at a time.

Properties: noTabsTitle, tabs, pane, collapsible, label, style, island

noTabsTitle

An optional text shown when the array of tabs is empty.

Type	Required	Default Value
LocalizableText_1	false	n/a

tabs

An array of tabs, each with a title, an optional badge, and contents.

Type	Required	Default Value
array [ITab]	true	n/a

pane

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

Type	Required	Default Value
PaneName_1	false	n/a

collapsible

Type	Required	Default Value
CollapsibleOptions, unknown	false	n/a

label

Type	Required	Default Value
string	false	n/a

style

No description available

Type	Required	Default Value
unknown	false	n/a

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	Required	Default Value
boolean	false	n/a

ITextElement

The text element consists of a template block.

Properties: appearance, visible, open, mandatory, label, titleValue, titleSource, title, rendering, template, info, style

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

template

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&IConditionalStyle&IExtendedStyle>, array [string, IFirstMatchSelector<IColor&IConditionalStyle&IExtendedStyle>], string	false	n/a

ITimeDurationFormatting

No description available

ITimeFormatting

No description available

ITypeAheadConfiguration

No description available

IURLAuthenticationMethod

No description available

IUnitBlock

No description available

Properties: source, position, label, title

source

No description available

Type	Required	Default Value
FieldName_1	false	n/a

position

No description available

Type	Required	Default Value
UnitPositionType	false	n/a

label

Type	Required	Default Value
string	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

IUnitFieldElement

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

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

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

unit

No description available

Type	Required	Default Value
IUnitBlock	true	n/a

source

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

Type	Required	Default Value
FieldName	true	n/a

search

Type	Required	Default Value
FieldSearchType	false	n/a

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

Type	Required	Default Value
WidgetType	false	n/a

shadowTitle

No description available

Type	Required	Default Value
LocalizableText_1	false	n/a

autoSubmit

Specifies that changes to this field should be automatically saved.

Type	Required	Default Value
boolean	false	n/a

info

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

Type	Required	Default Value
IInfoBubbleReference, IInfoBubbleDefinition	false	n/a

validators

No description available

Type	Required	Default Value
array [IValidator]	false	n/a

style

No description available

Type	Required	Default Value
string, IFirstMatchSelector<IColor&ITextAlign&IConditionalStyle>, array [string, IFirstMatchSelector<IColor&ITextAlign&IConditionalStyle>], string	false	n/a

IUsageTrackingConfiguration

No description available

Properties: enabled, endUserOptIn, trackingId

enabled

This flag enables usage tracking for the entire installation.

Type	Required	Default Value
boolean	true	n/a

endUserOptIn

This flag enables end-user opt-in notification about usage tracking. When the end-user opts-in, the notification is not shown for a year unless cookies are cleared.

Type	Required	Default Value
boolean	true	n/a

trackingId

Google Analytics tracker ID can be provided here for custom tracking of usage.

Type	Required	Default Value
string	false	n/a

IValidator

A single element/column validator

Properties: type, icon, condition, title

type

No description available

Type	Required	Default Value
string	false	n/a

icon

No description available

Type	Required	Default Value
string	false	n/a

condition

No description available

Type	Required	Default Value
Expression	false	n/a

title

An mandatory, localizable title.

Type	Required	Default Value
LocalizableText	true	n/a

IWizardInvocation

Specifies parameters for invoking a wizard.

Properties: wizardWorkspace, pane

wizardWorkspace

No description available

Type	Required	Default Value
IWizardWorkspace	true	n/a

pane

The host pane for the wizard. This pane can be accessed in the wizard workspace under the name "Host".

Type	Required	Default Value
PaneName	true	n/a

IWizardInvocationAction

A wizard which is not invoked on a specific action.

Properties: wizard, confirmation, title, visible

wizard

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

Type	Required	Default Value
IWizardInvocation	true	n/a

confirmation

Type	Required	Default Value
unknown	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

IWizardInvocationWithOptionalPane

No description available

IWizardInvocation_1

Specifies parameters for invoking a wizard.

IWizardWorkflow

No description available

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: name, size, definitions, dataBindings, workflow, pageLayouts, sideEffects, cancel, title

name

The internal, unique, non-localizable name of the wizard workspace.

Type	Required	Default Value
WorkspaceName	true	n/a

size

The size of the wizard window. If not specified the medium size will be applied.

Type	Required	Default Value
WizardSize	false	n/a

definitions

Definitions of items that can be reused many times within this workspace.

Type	Required	Default Value
ILocalDefinitions	false	n/a

dataBindings

Configuration of the panes that compose this workspace and how these panes are bound together.

Type	Required	Default Value
array [IBindingSpecification]	false	n/a

workflow

Configuration of the states in the wizard.

Type	Required	Default Value
IWizardWorkflow	true	n/a

pageLayouts

Definition of the layouts for the pages in the wizard.

Type	Required	Default Value
IPageLayouts	true	n/a

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	Required	Default Value
boolean	false	n/a

cancel

Specifies the behavior for cancelling the wizard. This setting provides a default value that can be overriden in each workflow state.

Type	Required	Default Value
ICancelTransition	false	n/a

title

An mandatory, localizable title.

Type	Required	Default Value
LocalizableText	true	n/a

IWorkspace

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: name, proxyFor, state, definitions, dataBindings, layout, title

name

The internal, unique, non-localizable name of the workspace.

Type	Required	Default Value
WorkspaceName	true	n/a

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	Required	Default Value
WorkspaceName_1	false	n/a

state

Optional marker to indicate if the workspace is in beta or test.

Type	Required	Default Value
WorkspaceState	false	n/a

definitions

Definitions of items that can be reused many times within this workspace.

Type	Required	Default Value
ILocalDefinitions	false	n/a

dataBindings

Configuration of the panes that compose this workspace and how these panes are bound together.

Type	Required	Default Value
IDataBindings	true	n/a

layout

Configuration of the layout of data and actions associated with this workspace.

Type	Required	Default Value
IWorkspaceLayout	true	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

IWorkspaceConfiguration

Representation of both general configuration spanning all workspaces as well as the setup of data bindings and layout for individual workspaces. A workspace will, however, not appear until it is referred from the menu.

Properties: definitions, workspaces

definitions

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	Required	Default Value
IGlobalDefinitions	true	n/a

workspaces

The collection of all workspaces available to the client.

Type	Required	Default Value
array [IWorkspaceGroup, IWorkspace]	true	n/a

IWorkspaceGroup

No description available

Properties: workspaces

workspaces

The collection of all workspaces available to the client.

Type	Required	Default Value
array [IWorkspaceGroup, IWorkspace]	true	n/a

IWorkspaceItem

A representation of a single menu item which opens a workspace.

Properties: workspace, visible

workspace

Reference to the internal name of a workspace.

Type	Required	Default Value
WorkspaceName	true	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

IWorkspaceLayout

Represents the layout for the entire workspace area.

Properties: heading, rendering, list, record, rows, actionBar

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	Required	Default Value
IHeading	false	n/a

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	Required	Default Value
IRendering	false	n/a

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. If this property is not specified, then it defaults to true.

Type	Required	Default Value
IListView, boolean	false	n/a

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	Required	Default Value
IRecordHeading	false	n/a

rows

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

Type	Required	Default Value
array [IElementRow, ILayoutRow, ITableRow, ITabsRow, IGridRow, IDocumentRow, IConversationRow, IEmbeddedRow, ISchedulerRow, IAlertRow, IConditionalRow]	true	n/a

actionBar

The actions to be shown in this action row.

Type	Required	Default Value
IActionsRow	false	n/a

IZipCityElement

No description available

Properties: zip, city, zipFirst, appearance, visible, open, mandatory, label, titleValue, titleSource, title, rendering

zip

No description available

Type	Required	Default Value
IInputBlock, string	true	n/a

city

No description available

Type	Required	Default Value
IInputBlock, string	true	n/a

zipFirst

No description available

Type	Required	Default Value
boolean	false	n/a

appearance

No description available

Type	Required	Default Value
IAppearance	false	n/a

visible

A visibility predicate determining whether this layout part is shown.

Type	Required	Default Value
Expression	false	n/a

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	Required	Default Value
Expression	false	n/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	Required	Default Value
Expression	false	n/a

label

Type	Required	Default Value
string	false	n/a

titleValue

An optional title derived from the value of a field.

Type	Required	Default Value
FieldName_1	false	n/a

titleSource

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

Type	Required	Default Value
FieldName_1	false	n/a

title

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

Type	Required	Default Value
LocalizableText_1	false	n/a

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	Required	Default Value
IRendering	false	n/a

Period

Properties: start, end

start

No description available

Type	Required	Default Value
FieldName	true	n/a

end

No description available

Type	Required	Default Value
FieldName	true	n/a

Recalculation

Properties: initialDelay, interval, quarantinePeriod

initialDelay

The initial delay in minutes between the time the user logs in and when the first recalculation of notifications is requested. The reason for not requesting recalculation immediately is that the server should be set up to recalculate every night such that the notifications are already up to date on login.

Type	Required	Default Value
number	true	n/a

interval

The interval in minutes between each request for recalculation of the user's notifications. Care should be taken when setting this interval as recalculation of notifications can be a very performance intensive process. If the interval is set to a low value then overall system performance may degrade significantly.

Type	Required	Default Value
number	true	n/a

quarantinePeriod

The quarantine period property defines the minimum quarantine period between repeated client requests for recalculation of notifications.

Type	Required	Default Value
number	true	n/a

SchedulerSlotDivision

No description available

SchedulerViewType

No description available

Sizes

Mapping between symbolic names to pixel width.

Properties: xs, sm, md, lg, xl, custom

xs

No description available

Type	Required	Default Value
number	true	n/a

sm

No description available

Type	Required	Default Value
number	true	n/a

md

No description available

Type	Required	Default Value
number	true	n/a

lg

No description available

Type	Required	Default Value
number	true	n/a

xl

No description available

Type	Required	Default Value
number	true	n/a

custom

No description available

Type	Required	Default Value
unknown	true	n/a

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.

Type	Required	Default Value
BooleanValue	false	n/a

collapsible

Controls whether the splitter can collapse and thereby hide the last of the layout components that it splits.

Type	Required	Default Value
BooleanValue	false	n/a

source

No description available

Type	Required	Default Value
FieldName	true	n/a

mask

No description available

Type	Required	Default Value
ISchedulerViewMask	true	n/a

# AnalyzerReportName

# Application

# version

# BindingType

# BooleanValue

# BooleanValue_1

# Chart

# CollapsibleOptions

# expanded

# Color

# Color_1

# ColumnChooser

# Configuration API

# api

# application

# platform

# shell

# workspace

# ContainerName

# ContainerSpecificationType

# Containers

# DateTimeField

# EmployeeLookup

# restriction

# limit

# Expression

# Expression_1

# FamilyType

# FieldName

# FieldName_1

# FieldSearchType

# Formatting

# amount

# autotimestamp

# boolean

# date

# enum

# integer

# real

# string

# time

# timeduration

# pp:color

# pp:datetime

# pp:double

# pp:float

# pp:guid

# pp:integer

# pp:string

# Grid

# IActionGroup

# actions

# title

# visible

# IActionsRow

# IActivityElement

# user

# date

# color

# appearance

# visible

# open

# mandatory

# label

# titleValue

# titleSource

# title

# rendering

# IAddressElement

# lines

# appearance

# visible

# open

# mandatory

# label

# titleValue

# titleSource

# title

Configuration API Reference

ActionName

AnalyzerReportName

Application

version

BindingType

BooleanValue

BooleanValue_1

Chart

CollapsibleOptions

expanded

Color

Color_1

ColumnChooser

Configuration API

api

application

platform

shell

workspace

ContainerName

ContainerSpecificationType

Containers

DateTimeField

EmployeeLookup

restriction

limit

Expression

Expression_1

FamilyType

FieldName

FieldName_1

FieldSearchType

Formatting

amount

autotimestamp

boolean

date

enum

integer

real

string

time

timeduration

pp:color

pp:datetime

pp:double

pp:float

pp:guid

pp:integer

pp:string

Grid

IActionGroup

actions

title

visible

IActionsRow

IActivityElement

user

date

color

appearance

visible

open

mandatory

label

titleValue

titleSource

title

rendering

IAddressElement

lines

appearance

visible

open

mandatory

label

titleValue

titleSource

title