ApplicationConfiguration
The core application configuration is split into four main areas: authentication, platform, shell, and workspace. The entire configuration has an API version used to guarantee compatibliity and enforce upgrades. Finally, the configuration includes a dictionary of the static terms embedded in the web client. These terms are localized before the client receives the configuration from the REST API.
Properties: api, application, platform, shell, workspace
required
apiThe version of the configuration format that this representation conforms to. Versions follow the SemVer standard.
Type: string
required
applicationThe application version.
Type: ApplicationConfigurationType
required
platformGeneral configuration that spans the entire application
Type: PlatformConfiguration
required
shellThe application shell covers the menu, documentation, notifications and auxiliary features such as settings, change password and about information.
Type: ShellConfiguration
required
workspaceConfiguration of general properties that span all workspaces as well as configuration of individual workspaces in terms of data bindings and layouts.
Type: WorkspaceConfiguration
ActionArgumentsType
Arguments for an action.
This is a map from the argument name to either an expression or template text providing the value of the argument.
Any of the following
- Anonymous Object Type
template | TemplateText |
- Anonymous Object Type
expression | Expression |
ActionName
String alias for an action.
ActionOrGroup
No description available
Any of the following
ActionSeparatorType
A separator line for the list of actions.
ActionTableColumnType
No description available
Properties: action
required
actionNo description available
Type: TableActionColumnType
ActionType
No description available
Any of the following
ActivityFormElementType
No description available
Properties: activity
required
activityNo description available
Type: IActivityElement
AddressFieldLineType
No description available
Any of the following
- Anonymous Object Type
field | IAddressFieldLine |
AddressFormElementType
No description available
Properties: address
required
addressNo description available
Type: IAddressElement
AddressLineType
Represents the type of lines that can be inserted in addresses.
Any of the following
AddressLinkLineType
No description available
Properties: link
required
linkNo description available
Type: IAddressLinkLine
AddressReferenceLineType
No description available
Properties: reference
required
referenceNo description available
Type: Any of the following
AddressZipCityLineType
No description available
Properties: zipCity
required
zipCityNo description available
Type: IAddressZipCityLine
AmountFormElementType
No description available
Properties: amount
required
amountNo description available
Type: IAmountElement
AmountTableColumnType
No description available
Properties: amount
required
amountNo description available
Type: ITableAmountColumn
AnalyzerReportName
String alias for internal references to an analyzer report.
AnyStyle
No description available
Properties: verticalAlign, fontWeight, textAlign, backgroundColor, color, extends, condition
verticalAlign
No description available
Type: VerticalAlignType
fontWeight
No description available
Type: string
textAlign
No description available
Type: TextAlignType
backgroundColor
Either a standard Web color or a reference to a named color
Type: Any of the following
color
Either a standard Web color or a reference to a named color
Type: Any of the following
extends
No description available
Type: StyleName
condition
No description available
Type: Expression
AppearanceType
Specifies the appearance of an element.
normal
- The element is displayed with a label/title and a field value.maximized
- The element is displayed with a field value only.minimized
- The element is displayed with a label/title only.
ApplicationConfigurationType
No description available
Properties: version
required
versionThe version of this particular application. This version number is NOT related to core Maconomy versions.
Type: string
AssistantHelp
The help view for the workspace assistant. The help view can be a template or a document.
Any of the following
AssistantHelpDocument
The name of the help document to be displayed.
The document must be defined in the "HelpDocumentArchive" container.
AssistantHelpTemplate
No description available
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
templateThe markdown attribute should be use in displaying help containing Markdown tags to the user. The template can contain placeholders that will be replaced with the actual values.
Type: TemplateText
AssistantName
String alias for a workspace assistant name.
AssistantSelectorType
No description available
Any of the following
- AssistantName
- Anonymous Object Type
condition | Expression |
ref | AssistantName |
- Anonymous Object Type
condition | Expression |
pane | PaneName |
expanded | BooleanValue |
layout | IAssistantLayout |
conversation | IAssistantConversation |
document | IAssistantDocument |
help | AssistantHelp |
BadgeStatusType
Represents the additional badge status types. The type indicates badge color that will be used, e.g. 'info' is typically a blue color and 'danger' as red color.
BinaryOperatorType
No description available
BindingType
No description available
Any of the following
BooleanGroupElementType
No description available
Properties: booleanGroup
required
booleanGroupNo description available
Type: IBooleanGroupElement
BooleanValue
Boolean value that will in time be converted to a full expression
Any of the following
- boolean
true
false
CalendarSettings
No description available
Properties: firstDayOfWeek
required
firstDayOfWeekControls the first day of the week.
Type: Any of the following
- string
- FirstDayOfWeek
Chart
No description available
Any of the following
- Anonymous Object Type
height | number |
legend | Any of the following
|
palette | PaletteName |
yAxis | Any of the following |
xAxis | Any of the following |
type | line |
series | Array<IChartSeries> |
- Anonymous Object Type
height | number |
legend | Any of the following
|
palette | PaletteName |
yAxis | Any of the following |
xAxis | Any of the following |
type | bar |
series | Array<IBarChartSeries> |
stacking | string |
- Anonymous Object Type
height | number |
legend | Any of the following
|
palette | PaletteName |
yAxis | Any of the following |
xAxis | Any of the following |
type | column |
series | Array<IBarChartSeries> |
stacking | string |
- Anonymous Object Type
height | number |
legend | Any of the following
|
palette | PaletteName |
yAxis | Any of the following |
xAxis | Any of the following |
type | area |
series | Array<IChartSeries> |
stacking | string |
- Anonymous Object Type
height | number |
legend | Any of the following
|
palette | PaletteName |
type | pie |
series | Array<IChartSeries> |
- Anonymous Object Type
height | number |
legend | Any of the following
|
palette | PaletteName |
yAxis | Any of the following |
xAxis | Any of the following |
type | bar-with-negative-series |
series | Array<IChartSeries> |
- Anonymous Object Type
height | number |
legend | Any of the following
|
palette | PaletteName |
type | pyramid |
series | Array<IChartSeries> |
- Anonymous Object Type
height | number | ||||
legend | Any of the following
| ||||
palette | PaletteName | ||||
type | funnel | ||||
series | Array<IChartSeries> | ||||
neck | Anonymous Object Type
|
- Anonymous Object Type
height | number | ||||||
palette | PaletteName | ||||||
yAxis | Any of the following | ||||||
type | solidgauge | ||||||
series | Array<IChartSeries> | ||||||
regions | Array<Anonymous Object Type
| ||||||
range | Anonymous Object Type
| ||||||
unit | string | ||||||
size | Any of the following
|
ChartData
Represents a list of values to be used as a data series, titles or categories.
The list of values can be specified directly - by providing an array containing a complete list of values, or indirectly - by providing an expression that will be evaluted for each record in a pane.
Any of the following
Array<DataPoint>
CollapsibleOptions
Configuration of a collapsible layout part.
Properties: expanded
required
expandedDetermines whether the default state of a collapsible layout part if collapsed or expanded. If false, the layout part is collapsed when rendered initially.
Default Value: true
Type: BooleanValue
Color
A color is eiher a reference to a palette item, e.g., "palette1.item2", or a standard web color such as a hex triplet, an RGB value or a named HTML color.
Any of the following
- QualifiedPaletteItemName
- string
ColorRegistry
No description available
Map from string
to string
ColumnChooser
No description available
Any of the following
ColumnName
A name of a column in an Analyzer report.
ColumnType
No description available
Any of the following
ContainerActionWithoutWizard
No description available
Properties: arguments, visible, title, confirmation, source
arguments
The arguments to be passed to the action.
Type: ActionArgumentsType
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
confirmation
Specifies whether a confirmation dialog should be shown before running this action.
If set to true
, then a confirmation dialog with a standard message will be shown. If set to a string, then a confirmation dialog with the given text (e.g. "Are you sure?") will be shown. If not specified or set to false
, then no confirmation dialog will be shown.
Type: boolean,string
required
sourceThe name of the action to be shown.
Type: ActionName
ContainerActionWithWizard
No description available
Properties: wizard, visible, title, confirmation, source
required
wizardA wizard that will be shown when this action is clicked.
Type: IWizardInvocation
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
confirmation
Specifies whether a confirmation dialog should be shown before running this action.
If set to true
, then a confirmation dialog with a standard message will be shown. If set to a string, then a confirmation dialog with the given text (e.g. "Are you sure?") will be shown. If not specified or set to false
, then no confirmation dialog will be shown.
Type: boolean,string
required
sourceThe name of the action to be shown.
Type: ActionName
ContainerName
The name of a backend container accessible through the REST API.
ContainerParameterType
No description available
Any of the following
Containers
Represents a hierarchy of container configurations
Any of the following
ContainerSpecificationType
No description available
Any of the following
- IContainerSpecification
- IDocumentPaneSpecification
- IAnalyzerPaneSpecification
- IInMemoryCardPaneSpecification
ConversationFieldReference
No description available
ConversationTypes
No description available
Map from string
to IConversationType
DataPoint
Represents a single data value.
The value can be specified either as an expression or a template string. Expressions will be evaluated using the currently selected record in any referenced pane.
Any of the following
DataProvider
Represents a list of values constructed by iterating over records in a pane.
The value can be specified either as an expression or a template string. Expressions will be evaluated for each record in the given pane (specified using the pane
attribute). If no pane is specified, then the pane that is currently in scope for this chart will be used.
Note that, apart form the iterated pane, any other pane in the workspace, excluding descendant panes of the iterated pane, may be referenced in the expression. In such a case, values from the currently selected record in that pane will be used.
Any of the following
- Anonymous Object Type
pane | PaneName |
value | Expression |
- Anonymous Object Type
pane | PaneName |
template | TemplateText |
DateTimeField
A string with the name of a "datetime" field, or an object where the "date" and "time" field names are specified separately.
Any of the following
DefaultWorkspaceCandidate
No description available
Any of the following
DialFormElementType
No description available
Properties: dial
required
dialNo description available
Type: IDialElement
DocumentationType
No description available
Any of the following
EnterTransitionActionType
No description available
Any of the following
ExitTransitionActionType
No description available
Any of the following
- ICreateAction
- IUpdateAction
- IDeleteAction
- ISaveAction
- IApplicationAction
- INavigateAction
- IRevertAction
- IAssignAction
Expression
String alias for an expression.
ExtendedRowType
No description available
Any of the following
FieldFormElementType
No description available
Any of the following
- Anonymous Object Type
field | IFieldElement |
FieldName
String alias for field source/model names.
FieldSearchType
Configuration of the search capabilities available for a field.
The following values may be specified:
true
, indicating that the searching should be enabled for this field using the standard search layout,- a search layout name, indicating that searching should be enabled, and the named search layout should be applied,
- an object with a detailed configuration for this search,
false
, indicating that the field should not be searchable.
Any of the following
FieldTableColumnType
No description available
Any of the following
- Anonymous Object Type
field | ITableFieldColumn |
FileSizeTableColumnType
No description available
Properties: fileSize
required
fileSizeNo description available
Type: ITableFileSizeColumn
FilterAsTableFieldConfiguration
No description available
Any of the following
FirstDayOfWeek
No description available
required
dayControls the first day of the week.
Type: string
required
fixedWhen the first day of week is fixed, users are not allowed to change the value via My Settings.
Default Value: false
Type: BooleanValue
ForeignKeyConfiguration
No description available
Properties: controls
controls
Specifies that the values selected through this foreign-key "control" the values which may be selected via the listed foreign-keys.
If the value selected through this foreign-key changes or is cleared, then the fields associated with the listed foreign-keys will be cleared. On the other hand, if any of the values selected through the listed foreign-keys are cleared, then the value selected through this foreign-key will be kept.
For example, consider two foreign-keys:
- the controlling foreign-key "List", which lets the user select an option list,
- the controlled foreign-key "Value", which lets the user select a value from that option list. If the selection for "List" is cleared or changed, then all the fields associated with "Value" will be cleared. On the other hand, if the selection in "Value" is cleared, then the value selected in "List" will be kept.
Type: Array<ForeignKeyName>
ForeignKeyName
String alias for foreign keys.
FormElementType
Represents the type of element that can be inserted in forms.
Any of the following
- ActivityFormElementType
- AddressFormElementType
- DialFormElementType
- FieldFormElementType
- IntervalFormElementType
- PairFormElementType
- LinkFormElementType
- ReferenceFormElementType
- StatusFormElementType
- TextFormElementType
- UnitFieldFormElementType
- AmountFormElementType
- PercentFormElementType
- ZipCityFormElementType
- BooleanGroupElementType
- RadioFormElementType
GlobalCurrencyDisplayType
No description available
Any of the following
GlobalTypeSpecificFormat
No description available
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: IGlobalAmountFormat
autotimestamp
No description available
Type: IAutoTimestampFormat
boolean
No description available
Type: IBooleanFormat
date
No description available
Type: IDateFormat
enum
No description available
Type: IEnumFormat
integer
No description available
Type: IIntegerFormat
real
No description available
Type: IRealFormat
string
No description available
Type: IStringFormat
time
No description available
Type: ITimeFormat
timeduration
No description available
Type: ITimeDurationFormat
pp:color
No description available
Type: IPeoplePlannerColorFormat
pp:datetime
No description available
Type: IPeoplePlannerDateTimeFormat
pp:double
No description available
Type: IPeoplePlannerDoubleFormat
pp:float
No description available
Type: IPeoplePlannerFloatFormat
pp:guid
No description available
Type: IPeoplePlannerGuidFormat
pp:integer
No description available
Type: IPeoplePlannerIntegerFormat
pp:string
No description available
Type: IPeoplePlannerStringFormat
Grid
No description available
Any of the following
- IGrid
- Array<GridLineOrSection>
GridAmountCellType
No description available
Properties: amount
required
amountNo description available
Type: IGridAmountCell
GridCell
Represents the type of cell that can be inserted in grids.
Any of the following
- GridFieldCellType
- GridLinkCellType
- GridTextCellType
- GridUnitFieldCellType
- GridAmountCellType
- GridPercentCellType
- GridEmptyCellType
GridEmptyCellType
No description available
Any of the following
{ }
- Anonymous Object Type
empty | IGridEmptyCell |
GridFieldCellType
No description available
Any of the following
- FieldName
- Anonymous Object Type
field | IGridFieldCell |
GridHeaderLine
No description available
Any of the following
GridLine
No description available
Any of the following
GridLineOrSection
No description available
Any of the following
GridLinkCellType
No description available
Properties: link
required
linkNo description available
Type: IGridLinkCell
GridPercentCellType
No description available
Properties: percent
required
percentNo description available
Type: IGridPercentCell
GridSectionLine
No description available
Any of the following
GridTextCellType
No description available
Properties: text
required
textNo description available
Type: IGridTextCell
GridUnitFieldCellType
No description available
Properties: unitField
required
unitFieldNo description available
Type: IGridUnitFieldCell
IActionAttachmentConfiguration
No description available
Properties: required, allowMultipleAttachments
required
requiredThis flag specifies if file attachments are required for this action.
Type: boolean
allowMultipleAttachments
This flag specifies if multiple attachments are valid for this action. Note that the action will be executed once for every attachment.
For example, this flag could be set to true
for the action AttachDocument
in the ExpenseSheets
container, as calling this action multiple times with new files will simply attach more files to the same expense sheet.
On the other hand, this flag should be false
for the action ImportDocument
in the table part of DocumentArchives
, as running that action more than once will replace the document previously attached to the line.
Default Value: false
Type: boolean
IActionConfiguration
No description available
Properties: attachments, parameters
attachments
Specifies whether attachments (i.e. file uploads) should be available for this action.
Type: IActionAttachmentConfiguration
parameters
Specifies fields which act as parameters to this action. The values of these fields will be transmitted as singleton parameters when the action is executed.
Only fields from the card pane can be specified. The listed field names must be mapped to singleton identifiers in the card pane's singletonIdentifiers
attribute.
This property is only relevant for CWSv1.
Type: Array<FieldName>
IActionGroup
No description available
Properties: visible, title, actions
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
actionsNo description available
Type: Array<ActionType>
IActionsRow
Represents a row containing actions.
Properties: pane, title, actions, workspaceActions
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
actions
The actions to be shown in this action row.
Type: Array<ActionOrGroup>
workspaceActions
Show workspace actions (such as edit, save, revert) in this actions row.
Type: boolean
IActivityElement
The activity element represents user and date values with an associated color.
Properties: appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, user, date, color
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
userNo description available
Type: FieldName
required
dateNo description available
Type: FieldName
required
colorNo description available
Type: Color
IAddressElement
The address element.
Properties: appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, lines
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
linesAn array of the lines contained within the address.
Type: Array<AddressLineType>
IAddressFieldLine
The address field lines.
Properties: appearance, title, titleValue, titleSource, label, mandatory, open, autoSubmit, source, search, widget, shadowTitle
appearance
An optional property which determines how an address line is displayed.
Default Value: maximized
Type: AppearanceType
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
IAddressLinkLine
The address link element represents a link that can navigate to a specified URL.
Properties: alt, label, template, icon, authentication, url, workspace, mail, query, mandatory, open, visible
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
template
No description available
Type: LocalizableText
icon
No description available
Type: string
authentication
No description available
Type: IURLAuthenticationMethod
url
No description available
Type: URLElement
workspace
No description available
Type: WorkspaceLinkType
No description available
Type: MailElement
query
No description available
Type: Array<IQueryElement>
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
IAddressReferenceLine
The address reference lines.
Properties: mandatory, open, visible, description, key, foreignKey, search
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
description
No description available
Type: Any of the following
key
No description available
Type: Any of the following
required
foreignKeyNo description available
Type: string
search
The configuration of the search capabilities available for this foreign-key.
If this property is not specified, then searching will be enabled for this foreign-key (provided that this foreign-key supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
IAddressReferenceWithFieldsLine
The address reference lines.
Properties: mandatory, open, visible, description, key
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
descriptionNo description available
Type: Any of the following
required
keyNo description available
Type: Any of the following
IAddressZipCityLine
The address zip-city lines.
Properties: mandatory, open, visible, zip, city, zipFirst
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
zipNo description available
Type: Any of the following
required
cityNo description available
Type: Any of the following
zipFirst
No description available
Type: boolean
IAdvancedSearchLayout
The advanced search part of a search layout.
Properties: title, restriction, columns, columnChooser
title
A title for the advanced search pane.
Type: LocalizableText
restriction
A base restriction to be applied to limit the search results in addition to any restrictions defined elsewhere.
Type: Expression
required
columnsThe columns to be shown in the list of search results.
Type: Array<TableColumnType>
columnChooser
The column chooser for this search layout.
Type: ColumnChooser
IAlert
Configuration of the alert component.
Properties: pane, template, visible, title, icon, color
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
templateThe template text for the alert component.
Type: TemplateText
visible
An optional visibility expression for the alert component.
Type: Expression
title
An optional title for the alert component.
Type: LocalizableText
icon
An optional icon for the alert component.
Type: IconName
required
colorColor for the alert component.
Type: Color
IAlertRow
Represents a row containing an alert component.
Properties: island, style, label, collapsible, pane, title, alert
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
alertAn alert component.
Type: IAlert
IAmountElement
The currency element represents a field element with a currency describing the data of the field.
Properties: style, format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, currency, appearance, rendering, title, titleValue, titleSource, visible
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
textAlign | TextAlignType |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
textAlign | TextAlignType |
color | Any of the following |
* <a href="#ifirstmatchselector<(&&)>">IFirstMatchSelector<(&&)></a>
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
required
currencyNo description available
Type: FieldName
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
IAmountFormat
No description available
Properties: short, currencyDisplay
short
True if short formatting should be applied, or specify a precise number of characters.
Type: Any of the following
- boolean
- Anonymous Object Type
precision | number |
currencyDisplay
An optional property describing how to display the currency. It can either be displayed as a symbol, e.g., '$', as a code, e.g., 'USD', or not shown at all.
Default Value: 'symbol' which will display the currency symbols.
Type: LocalCurrencyDisplayType
IAnalyzerConfiguration
The analyzer configuration
Properties: reportRunsDropDown, reportsMenu, finishedReportsFooter, inlineInfoDialog, deprecatedReports
required
reportRunsDropDownNo description available
Type: IReportRunsDropDownConfiguration
required
reportsMenuNo description available
Type: IReportsMenuConfiguration
required
finishedReportsFooterNo description available
Type: IFinishedReportsFooterConfiguration
required
inlineInfoDialogNo description available
Type: IInlineInfoDialogConfiguration
required
deprecatedReportsNo description available
Type: IDeprecatedReportsConfiguration
IAnalyzerItem
No description available
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
analyzerThe name of the analyzer report.
Type: AnalyzerReportName
IAnalyzerPaneProjection
No description available
Properties: defaultLevelName, fields
defaultLevelName
The default report level to be used for a report column if no level name is explicitly specified for that column.
Type: LevelName
required
fieldsA mapping between field names in a container-based pane and columns in an Analyzer report.
This mapping defines which columns will be exposed as fields in the container-based pane for this report.
Type: IProjectedFields
IAnalyzerPaneSource
The definition of an Analyzer report to be executed.
Properties: template, columnTree, rowRestrictions, limit, cache
required
templateThe Analyzer report template underlying this report.
Type: string
required
columnTreeThe columns to be selected from the report template.
Type: ReportLevelType
rowRestrictions
The restrictions to be applied to the data.
Restrictions in this list are combined using a logical conjunction (i.e. a logical "and").
Type: Array<IReportRowRestriction>
limit
The maximum number of data rows to load.
If not specified, then all rows in the report are loaded.
Type: number
cache
Options related to caching of Analyzer reports.
Type: Anonymous Object Type
maxAge | number |
IAnalyzerPaneSpecification
A configuration of an Analyzer pane.
Properties: type, name, bindings, source, projection, orderBy
required
typeNo description available
Type: analyzer
required
nameNo description available
Type: PaneName
bindings
No description available
Type: Array<IBindingSpecification>
source
The definition of the Analyzer report.
In case of a "with"-bound set of panes, the source
attribute may be specified only on the topmost Analyzer pane.
Type: IAnalyzerPaneSource
required
projectionA mapping of fields from the Analyzer report into a container-based pane.
Type: IAnalyzerPaneProjection
orderBy
Defines the default sorting order for this pane.
Type: Array<IOrderBy>
IApplicationAction
Executes an application action.
Properties: action
required
actionAn action name qualified with a pane name. For example: EmployeeCard.Submit
Type: Any of the following
IApplicationActionDefinition
No description available
required
sourceAn action name qualified with a pane name. For example: EmployeeCard.Submit
Type: ActionName
arguments
The arguments to be passed to the action.
Type: ActionArgumentsType
IAssignAction
Assigns a value to a field.
Properties: assign
required
assignNo description available
Type: Anonymous Object Type
field | FieldName |
value | Expression |
IAssignTrigger
A trigger that assigns a value to a field.
Properties: assign
required
assignNo description available
Type: Anonymous Object Type
field | FieldName |
value | Expression |
IAssistant
No description available
Properties: pane, expanded, layout, conversation, document, help
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
expanded
Determines whether the default state of the assistant is collapsed or expanded. If true, the assistant is expanded when rendered initially.
Default Value: false
Type: BooleanValue
layout
An optional layout view for the workspace assistant.
Type: IAssistantLayout
conversation
An optional conversation view for the workspace assistant.
Type: IAssistantConversation
document
An optional document view for the workspace assistant.
Type: IAssistantDocument
help
An optional documentation view for the workspace assistant.
Type: AssistantHelp
IAssistantConversation
No description available
Properties: pane, title, relationName, conversationType, objectInstanceKey
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
relationNameThe internal name of the database relation to which the conversation is attached.
For example: "JobHeader"
.
Type: string
required
conversationTypeThe conversation type.
For example: "Job"
.
Type: string
required
objectInstanceKeyThe instance key of the object associated with the conversation.
For example: "JobsFilter.InstanceKey"
.
Type: Expression
IAssistantDocument
No description available
Properties: pane
required
paneThe pane used to resolve unqualified references in this scope.
Type: PaneName
IAssistantLayout
No description available
Properties: pane, title, actions, record, rows
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
titleAn mandatory, localizable title.
Type: LocalizableText
actions
The actions to be shown in this workspace assistant.
Type: Array with any of the following
* <a href="#actiontype">ActionType</a>
* <a href="#iactiongroup">IActionGroup</a>
record
The record heading area should communicate the overall data entity of the workspace assistant. This should contain the primary identifier of the currently shown data entity.
Type: IRecordHeading
required
rowsThe main body of a workspace assistant consists of an array of layout rows.
Type: Array<RowType>
IAssistantRegistry
A registry of assistants defined for a workspace.
Map from string
to IAssistant
IAssistantRow
An assistant within this workspace or tab.
Properties: assistant
required
assistantNo description available
Type: Any of the following
IAutoTimestampFormat
No description available
{ }
IAvailableFormats
No description available
Map from string
to IFormat
IAxis
No description available
Properties: type, title, categories, opposite, visible
type
No description available
Type: string
title
No description available
Type: TemplateText
categories
No description available
Type: ChartData
opposite
No description available
Type: boolean
visible
No description available
Type: boolean
IBadge
Graphical decoration of a layout group.
source
A pane field used as the data source for this badge.
Type: FieldName
status
An optional status element for the sub heading of the workspace or a status type. If the status is not specified then the default badge status will be set to 'info'.
Type: Any of the following
IBarChartSeries
No description available
Properties: title, type, data, xAxis, yAxis, stack
title
No description available
Type: TemplateText
type
No description available
Type: string
required
dataNo description available
Type: IChartSeriesData
xAxis
No description available
Type: number
yAxis
No description available
Type: number
stack
No description available
Type: string
IBinaryRestriction
A restriction using any of the binary operators.
required
operatorNo description available
Type: BinaryOperatorType
required
valueNo description available
Type: Expression
IBindingSpecification
No description available
Properties: binding, container
required
bindingNo description available
Type: BindingType
required
containerNo description available
Type: ContainerSpecificationType
IBooleanFormat
No description available
{ }
IBooleanGroupElement
No description available
Properties: appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, booleanFields
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
booleanFieldsNo description available
Type: Array with any of the following
* <a href="#fieldname">FieldName</a>
* <a href="#ibooleangroupfieldelement">IBooleanGroupFieldElement</a>
IBooleanGroupFieldElement
No description available
Properties: title, titleValue, titleSource, label, mandatory, open, autoSubmit, source, search, widget, shadowTitle
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
ICalendarColumn
Represents a Calendar column. A Calendar column contains vital data point of interests.
Properties: island, label, visible, span, offset, pane, title, calendar
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
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: number
offset
Column offset.
Type: number
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
calendarNo description available
Type: ICalendarElement
ICalendarElement
No description available
Properties: height, format, mandatory, open, visible, pane, type, source, status, legend, period, workingdays, highlightSelectedDate, navigationPeriod, showSelectionPeriod
height
An optional height. If unspecified, no height will be set for the part.
Type: number
format
Assign formatting based upon the data value
Type: ValueFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
type
discriminant
Type: calendar
required
sourceNo description available
Type: FieldName
required
statusNo description available
Type: IStatusBlock
legend
No description available
Type: IStatusIndication
required
periodNo description available
Type: Anonymous Object Type
title | LocalizableText |
start | FieldName |
end | FieldName |
workingdays
No description available
Type: FieldName
highlightSelectedDate
No description available
Type: boolean
navigationPeriod
No description available
Type: ICalendarNavigationPeriod
showSelectionPeriod
No description available
Type: boolean
ICalendarNavigation
No description available
Properties: pane, type, source, status, legend, period, workingdays, highlightSelectedDate, navigationPeriod, showSelectionPeriod
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
type
discriminant
Type: calendar
required
sourceNo description available
Type: FieldName
required
statusNo description available
Type: IStatusBlock
legend
No description available
Type: IStatusIndication
required
periodNo description available
Type: Anonymous Object Type
title | LocalizableText |
start | FieldName |
end | FieldName |
workingdays
No description available
Type: FieldName
highlightSelectedDate
No description available
Type: boolean
navigationPeriod
No description available
Type: ICalendarNavigationPeriod
showSelectionPeriod
No description available
Type: boolean
ICalendarNavigationPeriod
daily - we navigate on a day by day basis (default) period - we use the periodStart and periodEnd fields
ICancelTransition
No description available
Properties: title, visible, actions
title
The title of the dedicated cancel button.
Default Value: Cancel
Type: string
visible
Specifies if a dedicated cancel button should be shown. If false
, then the wizard can still be cancelled by pressing Escape or clicking on the "x" icon in the corner of the wizard window.
Type: boolean
actions
A list of actions to perform upon activating this transition.
Type: Array<ExitTransitionActionType>
ICardPaneConfiguration
No description available
Properties: minimalFields, dataChangedCheck, cacheInitResponse, actions, foreignKeys, stateParameters, navigationParameters, refreshAfterActions
minimalFields
Specifies the minimal set of fields that should be loaded for this pane.
Type: Array<FieldName>
dataChangedCheck
Specifies settings for a client-side data-changed check on this pane.
The data-changed check on the client side is performed when a container instance needs to be reestablished.
Type: Anonymous Object Type
excludedFields | Array<FieldName> |
cacheInitResponse
Specifies whether caching of init responses is allowed for this pane.
If set to true
, then init responses will be cached; when set to false
, they will not be cached. If not specified, the default behavior is to cache init responses.
Type: boolean
actions
Additional configuration for actions in this pane.
Any application action, such as "SubmitExpenseSheet", "ApproveAbsenceEntry", etc., may be configured here. It is also possible to configure the following standard actions:
- "create" - for saving new records,
- "update" - for saving existing records.
Type: IActionConfiguration
foreignKeys
Additional configuration for foreign-keys.
Type: ForeignKeyConfiguration
stateParameters
Specifies state parameter fields for this container.
State parameters are fields in the card part of a container that are not persisted on the server side, but are important to the internal state of the container and need to be set to their previous values when a container instance is restored.
Type: Array<FieldName>
navigationParameters
Specifies navigation parameter fields for this container.
Navigation parameters are fields in the card part of a container that control the internal navigation state of the container. In particular, they control the resource which will be the target of actions performed on this container.
Fields defined as navigation parameters cannot be changed together with any other fields in the workspace.
Type: Array<FieldName>
refreshAfterActions
Specifies actions which require the container to be re-read after they are executed.
Some container card actions can have side effects causing the card record to vanish. This behavior might not be reported correctly through the REST API. Listing such actions using this property lets the client handle them correctly.
For example, the action printinvoice
could be listed for the invoiceediting
container.
Type: Array<string>
IChartColumn
No description available
Properties: info, island, visible, span, offset, pane, title, chart
info
Configuration for the info-bubble tooltip for the row
Type: Any of the following
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
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: number
offset
Column offset.
Type: number
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
chartNo description available
Type: Chart
IChartSeries
No description available
Properties: title, type, data, xAxis, yAxis
title
No description available
Type: TemplateText
type
No description available
Type: string
required
dataNo description available
Type: IChartSeriesData
xAxis
No description available
Type: number
yAxis
No description available
Type: number
IChartSeriesData
No description available
x
No description available
Type: ChartData
required
yNo description available
Type: ChartData
title
No description available
Type: ChartData
IColumnChooser
Properties for the columnChooser widget
Properties: condition, columns
condition
No description available
Type: Expression
required
columnsA list of columns available in the column chooser
Type: Array<TableColumnType>
IColumnChooserWithAll
Properties for the columnChooser widget
Properties: condition, columns
condition
No description available
Type: Expression
required
columnsA list of columns available in the column chooser
Type: Any of the following
Array<TableColumnType>
all
IConditionalClause<ImageType>
No description available
Any of the following
- Anonymous Object Type
url | URLElement |
query | Array<IQueryElement> |
condition | Expression |
- Anonymous Object Type
template | TemplateText |
condition | Expression |
- Anonymous Object Type
icon | IconName |
condition | Expression |
IConditionalClause<NonConditionalRow>
No description available
Any of the following
- Anonymous Object Type
info | Any of the following |
island | boolean |
format | TypeSpecificFormat |
mandatory | Expression |
open | Expression |
rendering | IRendering |
style | Any of the following
|
label | string |
collapsible | Any of the following |
pane | PaneName |
title | LocalizableText |
elements | Array<FormElementType> |
condition | Expression |
- Anonymous Object Type
info | Any of the following |
island | boolean |
format | TypeSpecificFormat |
mandatory | Expression |
open | Expression |
rendering | IRendering |
style | Any of the following
|
label | string |
splitter | Any of the following |
collapsible | Any of the following |
pane | PaneName |
title | LocalizableText |
columns | Array<ColumnType> |
condition | Expression |
- Anonymous Object Type
format | TypeSpecificFormat |
island | boolean |
style | Any of the following
|
label | string |
collapsible | Any of the following |
pane | PaneName |
title | LocalizableText |
table | ITable |
condition | Expression |
- Anonymous Object Type
island | boolean |
style | Any of the following
|
label | string |
collapsible | Any of the following |
pane | PaneName |
noTabsTitle | LocalizableText |
tabs | Array<ITab> |
condition | Expression |
- Anonymous Object Type
format | TypeSpecificFormat |
island | boolean |
mandatory | Expression |
open | Expression |
rendering | IRendering |
style | Any of the following
|
label | string |
collapsible | Any of the following |
pane | PaneName |
title | LocalizableText |
grid | Grid |
condition | Expression |
- Anonymous Object Type
island | boolean |
style | Any of the following
|
label | string |
collapsible | Any of the following |
pane | PaneName |
title | LocalizableText |
document | IDocument |
condition | Expression |
- Anonymous Object Type
island | boolean | ||||||||||||
style | Any of the following
| ||||||||||||
label | string | ||||||||||||
collapsible | Any of the following | ||||||||||||
pane | PaneName | ||||||||||||
title | LocalizableText | ||||||||||||
conversation | Anonymous Object Type
| ||||||||||||
condition | Expression |
- Anonymous Object Type
island | boolean |
style | Any of the following
|
label | string |
collapsible | Any of the following |
pane | PaneName |
title | LocalizableText |
embed | IEmbed |
condition | Expression |
- Anonymous Object Type
island | boolean |
style | Any of the following
|
label | string |
collapsible | Any of the following |
pane | PaneName |
title | LocalizableText |
scheduler | IScheduler |
condition | Expression |
- Anonymous Object Type
island | boolean |
style | Any of the following
|
label | string |
collapsible | Any of the following |
pane | PaneName |
title | LocalizableText |
alert | IAlert |
condition | Expression |
IConditionalClauses<ImageType>
Conditional clauses *
Any of the following
IConditionalClauses<NonConditionalRow>
Conditional clauses *
Any of the following
IConditionalColumnChooser
No description available
Properties: if
required
ifNo description available
Type: Array<IColumnChooserWithAll>
IConditionalRow
Represents a layout row which can be shown conditionally.
Properties: style, label, pane, if
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
ifA list of layout rows with conditions.
The first layout row whose condition evaluates to true
, otherwise the first with no condition specified, will be shown. If no matching row is found, then nothing is shown.
Type: IConditionalClauses<NonConditionalRow>
IconName
String alias for an icon name.
IContainer
An search container associated with a search layout.
required
nameThe name of the search container.
Type: ContainerName
required
familyThe family where the container is defined.
Type: string
IContainerConfiguration
Specifies additional configuration options for a container.
Properties: filter, card, table, filterAsTable
filter
Configuration for the filter pane.
Type: IPaneConfiguration
card
Configuration for the card pane.
Type: ICardPaneConfiguration
table
Configuration for the table pane.
Type: ITablePaneConfiguration
filterAsTable
Configuration for the filter-as-table pane.
Type: IFilterAsTablePaneConfiguration
IContainerLeaf
No description available
Map from string
to IContainerConfiguration
IContainerNode
No description available
Properties: containers
required
containersNo description available
Type: Array<Containers>
IContainerSearchLayouts
No description available
Properties: container, searchLayouts
required
containerA search container associated with a search layout.
In the expanded notation, both a container name and a family needs to be specified, whereas, in the short form, the family is assumed to be maconomy
.
Type: Any of the following
required
searchLayoutsNamed search layouts for the specified search container.
These search layouts are only used if, for example, a field in a workspace layout refers to them directly. Otherwise, the standard search layout will be used.
Type: INamedSearchLayouts
IContainerSpecification
No description available
Properties: source, type, name, parameters, restriction, bindings, triggers, orderBy, select, paging, sharedRecord
required
sourceNo description available
Type: ContainerName
required
typeNo description available
Type: IContainerSpecificationPaneType
required
nameNo description available
Type: PaneName
parameters
No description available
Type: ContainerParameterType
restriction
No description available
Type: Expression
bindings
No description available
Type: Array<IBindingSpecification>
triggers
No description available
Type: ITriggers
orderBy
Defines the default sorting order for this pane.
Type: Array<IOrderBy>
select
Specifies extra fields that should be loaded for this pane, in addition to any fields referenced in the layout.
Type: Any of the following
paging
Controls the number of records loaded into this pane.
Type: IPagingConfiguration
sharedRecord
Enables record sharing for this pane.
When this property is set to some string (the sharing key), then the record selected in this pane will be shared with other panes that use the same key. If you switch between workspaces where panes use the same sharing key, the same record as was selected in one workspace will be automatically selected in others.
Note that this property only takes effect for panes of type "search-filter". All panes using the same sharing key must be defined on the same container - it is not allowed to share records between panes using different containers.
Type: string
IContainerSpecificationPaneType
No description available
IConversationColumn
Represents a conversation column.
Properties: island, style, label, visible, collapsible, span, offset, pane, title, conversation
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
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: number
offset
Column offset.
Type: number
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
conversationA conversation component.
Type: Anonymous Object Type
height | number |
pane | PaneName |
title | LocalizableText |
relationName | string |
conversationType | string |
objectInstanceKey | Expression |
IConversationConfiguration
Configuration of the conversation functionality.
Properties: enabled, refreshInterval, employeeLookup, conversationTypes
required
enabledDetermines if the conversation functionality is enabled.
For example: "true"
.
Type: Expression
required
refreshIntervalThe refresh interval in seconds.
The list of unread messages in the message center component is automatically refreshed once per this time interval.
For example: 60
indicates that the refresh happens every minute.
Type: number
employeeLookup
Configuration properties related to looking up employees for mentioning in messages.
Type: Anonymous Object Type
restriction | Expression |
limit | number |
required
conversationTypesA mapping between conversation types and workspaces supporting these conversations.
This mapping is used by the message center to open a workspace associated with a conversation, and to navigate to a record to which the conversation is attached.
Type: ConversationTypes
IConversationRow
Represents a row containing a conversation component.
Properties: island, style, label, collapsible, pane, title, conversation
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
conversationA conversation component.
Type: Anonymous Object Type
height | number |
pane | PaneName |
title | LocalizableText |
relationName | string |
conversationType | string |
objectInstanceKey | Expression |
IConversationType
No description available
Properties: workspace, parameters
required
workspaceThe name of the target workspace for the conversation type.
Type: WorkspaceName
parameters
A map of url parameters for the workspace linking to primary keys of the object attached to the conversation.
Type: ConversationFieldReference
ICreateAction
Saves a new record in the specified pane.
Properties: create
required
createNo description available
Type: PaneName
IDataBindings
No description available
Properties: container
required
containerNo description available
Type: ContainerSpecificationType
IDataExportConfiguration
No description available
Properties: limit
limit
The maximum number of supported lines to export
Default Value: 10000
Type: number
IDateFormat
No description available
{ }
IDateTimeSources
No description available
Properties: dateSource, timeSource
required
dateSourceNo description available
Type: FieldName
required
timeSourceNo description available
Type: FieldName
IDefaultWorkspaceCandidate
No description available
Properties: workspace, condition
required
workspacereferences a workspace in the menu
Type: WorkspaceName
condition
Condition that determines if this workspace can be used as a default or startup workspace.
Default Value: true
Type: Expression
IDeleteAction
Deletes the current record in the specified pane.
Properties: delete
required
deleteNo description available
Type: PaneName
IDeprecatedReportConfiguration
Configuration for a deprecated report
Properties: deprecatedReportTemplateId, newReportTemplateId, newReportMenuPath
required
deprecatedReportTemplateIdNo description available
Type: string
required
newReportTemplateIdNo description available
Type: string
required
newReportMenuPathNo description available
Type: Array<IReportMenuPathElement>
IDeprecatedReportsConfiguration
Configuration for deprecated reports
Properties: deprecatedReports
required
deprecatedReportsNo description available
Type: Array<IDeprecatedReportConfiguration>
IDialElement
Dial elements (or dial charts) are used render a single value, optionally against a backdrop of predefined zones.
Properties: format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, appearance, rendering, title, titleValue, titleSource, visible, start, end, regions
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
startNo description available
Type: number
required
endNo description available
Type: number
required
regionsNo description available
Type: Array<IDialRegion>
IDialRegion
Representation of a single region on a dial chart.
required
startNo description available
Type: number
required
endNo description available
Type: number
required
colorNo description available
Type: string
IDocument
Configuration of the document viewer
Properties: style, pane, height, title
style
No description available
Type: Any of the following
{ }
Array with any of the following
required
paneThe pane used to resolve unqualified references in this scope.
Type: PaneName
height
An optional height. If unspecified, no height will be set for the part.
Type: number
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
IDocumentationConfiguration
No description available
required
titleNo description available
Type: TemplateText
items
No description available
Type: Array<DocumentationType>
IDocumentationItem
No description available
Properties: visible, title, url, icon
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
titleNo description available
Type: TemplateText
required
urlNo description available
Type: TemplateText
icon
No description available
Type: IconName
IDocumentationSection
No description available
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
itemsNo description available
Type: Array<IDocumentationItem>
IDocumentBinding
A binding for a document pane.
Properties: type, documentArchiveNumber, documentName
required
typeNo description available
Type: document
required
documentArchiveNumberAn expression providing the document archive number of the document to be shown.
Type: Expression
required
documentNameAn expression providing the name of the document to be shown.
Type: Expression
IDocumentPaneSpecification
A specification of a document pane.
required
typeNo description available
Type: document
required
nameNo description available
Type: PaneName
IDocumentRow
Represents a row containing a data viewer.
Properties: island, style, label, collapsible, pane, title, document
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
documentA document viewer.
Type: IDocument
IElementColumn
Represents a layout column which contain elements.
Properties: info, island, format, mandatory, open, rendering, style, label, visible, collapsible, span, offset, pane, title, elements
info
Configuration for the info-bubble tooltip for the row
Type: Any of the following
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
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: number
offset
Column offset.
Type: number
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
elementsAn array of the elements contained in this scope
Type: Array<FormElementType>
IElementRow
Represents a row that contains a single element column.
Properties: info, island, format, mandatory, open, rendering, style, label, collapsible, pane, title, elements
info
Configuration for the info-bubble tooltip for the row
Type: Any of the following
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
elementsAn array of the elements contained in this scope
Type: Array<FormElementType>
IEmbed
Configuration of the embedded iframe component.
Properties: height, pane, title, authentication, url, query, externalLink, refresh, permissions
height
An optional height. If unspecified, no height will be set for the part.
Type: number
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
authentication
An optional authentication method for single sign-in to an external component.
Type: IURLAuthenticationMethod
required
urlThe URL hosting the external component.
Type: URLElement
query
An optional set of query parameters to qualify the URL.
Type: Array<IQueryElement>
externalLink
An optional link to display the url in an external browser window or tab. If this property is not specified, then it defaults to true
.
Type: boolean
refresh
An optional property which allow the refresh of the iframe to be triggered by data bindings or field changes. If this property is not specified, or is empty, refresh functionality is not enabled.
Type: IRefreshTrigger
permissions
An optional OK list which implements sandbox security on an iFrame. If not specified, no security restrictions are implemented. If it is empty it means ALL security restrictions for the iFrame are implemented. Adding attributes to the permissions OK list will allow certain permissions
Type: Array<iFramePermissions>
IEmbeddedRow
Represents a row containing an external 3rd-party component embedded as an iframe.
Properties: island, style, label, collapsible, pane, title, embed
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
embedA document viewer.
Type: IEmbed
IEnumDefinition
No description available
Properties: title, nullable, values
required
titleThe title of this enumeration type.
Type: LocalizableText
nullable
Specifies whether this enumeration type should contain a "nil" value.
Default Value: false
Type: boolean
required
valuesA list of values in this enumeration type.
Type: Array<IEnumValue>
IEnumerationConfiguration
No description available
Properties: limit
limit
The maximum number of Maconomy popups that should be loaded from the backend.
Default Value: :
100000``
Type: number
IEnumFormat
No description available
{ }
IEnumName
A reference to an enum type.
required
nameThe name of the enum.
Type: string
required
familyThe family where the enum is defined.
Type: string
IEnums
A list of client-side enumeration type definitions.
Map from string
to IEnumDefinition
IEnumValue
No description available
required
titleThe title of this enumeration value.
Type: LocalizableText
required
valueThe identifier of this enumeration value.
Type: string
IEventColor
No description available
Properties: source
required
sourceThe source to get color from. Should be a field of the type 'pp:color'.
Type: FieldName
IExitTransition
An exit transition defines a route a user can take to move to another state in a wizard.
This transition is shown as a button in the user-interface.
Properties: title, enabled, visible, actions, target
required
titleThe title of the button.
Type: LocalizableText
enabled
A condition specifying when this transition is enabled. The button corresponding to this transition will be shown as disabled if the expression evaluates to false. If omitted, the transition will be enabled.
Type: Expression
visible
A condition specifying when this transition is visible. The button corresponding to this transition will be hidden if the expression evaluates to false. If omitted, the transition will be visible.
Type: Expression
actions
A list of actions to perform upon activating this transition.
Type: Array<ExitTransitionActionType>
target
The name of the state that will be activated when this transition is taken. If this property is omitted, then taking this transition will terminate the wizard.
Type: StateName
IExpressionContainerParameter
Maps a field in a container to an expression.
The expression can refer to fields in any pane in the workspace, except for the pane on which this expression is defined and its descendants.
Properties: expression
required
expressionNo description available
Type: Expression
IFieldAndForeignKeySelection
No description available
Properties: fields, foreignKeys
fields
No description available
Type: Array<FieldName>
foreignKeys
No description available
Type: Array<string>
IFieldElement
Field elements are used for data entry.
Properties: style, format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, appearance, rendering, title, titleValue, titleSource, visible
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
textAlign | TextAlignType |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
textAlign | TextAlignType |
color | Any of the following |
* <a href="#ifirstmatchselector<(&&)>">IFirstMatchSelector<(&&)></a>
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
IFieldReference
No description available
Properties: field, foreignField, supplement
required
fieldThe name of the field in this pane.
Type: FieldName
required
foreignFieldThe name of the corresponding field in the foreign pane.
Type: FieldName
supplement
Indicates whether this field is a supplement field.
Default Value: false
Type: boolean
IFieldSearchConfiguration
No description available
Properties: layout, autocomplete
layout
The named search layout to use. If not specified, the standard search layout will be used.
This property can be a string with the name of the search layout, or an object providing the search layout name and parameters for the layout.
Type: Any of the following
autocomplete
Determines whether autocompletion should be enabled or disabled for this field.
If this property is set to false
(or to an expression that evaluates to false
), then values typed into the field will not be automatically completed when they match a unique search result.
This property can be set to a boolean value, or to an expression that evaluates to a boolean value.
Default Value: true
Type: Any of the following
- boolean
- Expression
IFilterAsTablePaneConfiguration
No description available
Properties: actions, foreignKeys, fields
actions
Additional configuration for actions in this pane.
Any application action, such as "SubmitExpenseSheet", "ApproveAbsenceEntry", etc., may be configured here. It is also possible to configure the following standard actions:
- "create" - for saving new records,
- "update" - for saving existing records.
Type: IActionConfiguration
foreignKeys
Additional configuration for foreign-keys.
Type: ForeignKeyConfiguration
fields
Configuration of additional fields for the filter-as-table pane.
By default, filter-as-table includes only fields that have the same name and type in the filter pane as in the card pane. However, additional fields can be configured:
- If a field from the filter pane exists has a corresponding field in the card pane, but with a different name, then a mapping between the names can be defined. 2) If a field is available in the filter pane only, then such a field can be shown as a read-only field in the filter-as-table pane.
This property maps field names from the filter pane (which are also the names used in the filter-as-table pane) to a configuration of each field.
Type: FilterAsTableFieldConfiguration
IFilterNavigation
No description available
Properties: pane, type, shadowTitle, query, selection
required
paneThe pane used to resolve unqualified references in this scope.
Type: PaneName
required
typediscriminant
Type: filter
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
required
queryA list of field names or elements to search in when a value is typed into the search filter.
Type: Anonymous Object Type
select | Array<SearchResultType> |
where | Array<FieldName> |
selection
No description available
Type: IFilterSelection
IFilterOnlyFilterAsTableField
Defines a filter field that has no corresponding card field.
Properties: immutable
required
immutableSpecifies whether the field can change due to an update or action performed in the card.
If a filter-only field is known not to be affected by any changes that a user can do in the card, then this property should be set to true
. In such a case there is no need for the filter-as-table pane to re-read the field from the filter after a card operation, as the field is known to not hange.
Setting this property to false
will cause the filter-as-table pane to read the updated value of the field from the filter pane after every card operation. This requires an extra REST API request.
Type: boolean
IFilterSelection
No description available
default
The name of the restriction that should be selected by default. If not specified, the first restriction in the list will be used.
Type: string
options
No description available
Type: ISearchRestriction
IFinishedReportsFooterConfiguration
No description available
Properties: noOfRowsPrPages, defaultNoOfRowsPrPages, noOfPagesPrPageGroup
required
noOfRowsPrPagesNumber of rows per page selections, e.g. [10, 25, 50]
Type: Array<number>
required
defaultNoOfRowsPrPagesDefault number of rows per page
Type: number
required
noOfPagesPrPageGroupNumber of pages in a page group
Type: number
IFirstMatchSelector<(&&&&&)>
A style selector containing an array of styles. When evaluated, it returns the first style that either has no condition or a predicate which evaluates to true.
Properties: firstMatch
required {#ifirstmatchselector<(&&&&&)>-firstmatch}
firstMatchNo description available
Type: Array<Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
IFirstMatchSelector<(&)>
A style selector containing an array of styles. When evaluated, it returns the first style that either has no condition or a predicate which evaluates to true.
Properties: firstMatch
required {#ifirstmatchselector<(&)>-firstmatch}
firstMatchNo description available
Type: Array<Anonymous Object Type
condition | Expression |
color | Any of the following |
IFirstMatchSelector<(&&)>
A style selector containing an array of styles. When evaluated, it returns the first style that either has no condition or a predicate which evaluates to true.
Properties: firstMatch
required {#ifirstmatchselector<(&&)>-firstmatch}
firstMatchNo description available
Type: Array<Anonymous Object Type
extends | StyleName |
condition | Expression |
color | Any of the following |
IFirstMatchSelector<(&&)>
A style selector containing an array of styles. When evaluated, it returns the first style that either has no condition or a predicate which evaluates to true.
Properties: firstMatch
required {#ifirstmatchselector<(&&)>-firstmatch}
firstMatchNo description available
Type: Array<Anonymous Object Type
condition | Expression |
textAlign | TextAlignType |
color | Any of the following |
IFirstMatchSelector<(&&)>
A style selector containing an array of styles. When evaluated, it returns the first style that either has no condition or a predicate which evaluates to true.
Properties: firstMatch
required {#ifirstmatchselector<(&&)>-firstmatch}
firstMatchNo description available
Type: Array<Anonymous Object Type
condition | Expression |
fontWeight | string |
color | Any of the following |
IFirstMatchSelector<(&&&)>
A style selector containing an array of styles. When evaluated, it returns the first style that either has no condition or a predicate which evaluates to true.
Properties: firstMatch
required {#ifirstmatchselector<(&&&)>-firstmatch}
firstMatchNo description available
Type: Array<Anonymous Object Type
extends | StyleName |
condition | Expression |
color | Any of the following |
backgroundColor | Any of the following |
IFirstMatchSelector<any>
A style selector containing an array of styles. When evaluated, it returns the first style that either has no condition or a predicate which evaluates to true.
Properties: firstMatch
required {#ifirstmatchselector<any>-firstmatch}
firstMatchNo description available
Type: Array<Anonymous Object Type
condition | Expression |
IForeignKeyBinding
No description available
Properties: foreignKey, reversed, followChild
required
foreignKeyNo description available
Type: string
reversed
No description available
Type: boolean
followChild
No description available
Type: boolean
IForeignKeyContainer
A container.
required
nameThe name of the container.
Type: ContainerName
required
familyThe family where the container is defined.
Type: string
IForeignKeySearchViaFilter
A foreign-key search that will use a filter of the named container to obtain the list of values.
Properties: type, container, restriction
required
typeNo description available
Type: filter
required
containerThe container whose filter pane will be used to provide the search results.
If no family is specified, the maconomy
family is used by default.
Type: Any of the following
restriction
An optional restriction to apply to the search.
Type: Expression
IForeignKeySearchViaForeignKey
A foreign-key search that will use a foreign-key defined in the filter pane of the named container to obtain the list of values.
Properties: type, foreignKey, container, restriction
required
typeNo description available
Type: foreign-key
required
foreignKeyThe foreign-key to use when performing the search.
Type: ForeignKeyName
required
containerThe container where the foreign-key is defined in the filter pane.
If no family is specified, the maconomy
family is used by default.
Type: Any of the following
restriction
An optional restriction to apply to the search.
Type: Expression
IFormat
No description available
Properties: date, symbol, time
required
dateNo description available
Type: Anonymous Object Type
short | string |
symbol
No description available
Type: Anonymous Object Type
decimal | string |
group | string |
required
timeNo description available
Type: Anonymous Object Type
short | string |
IFormats
No description available
Properties: preferred, fixed, available
preferred
The preferred format for the end-user.
Type: string
fixed
No description available
Type: boolean
available
No description available
Type: IAvailableFormats
iFramePermissions
Represents all the attributes which can be included in an OK list of allowed iFrame functionality. Further information can be found here: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox
IGlobalAmountFormat
No description available
Properties: short, currencyDisplay
short
True if short formatting should be applied, or specify a precise number of characters.
Type: Any of the following
- boolean
- Anonymous Object Type
precision | number |
currencyDisplay
An optional property describing how to display the currency. It can either be displayed as a symbol, e.g., '$', as a code, e.g., 'USD', or not shown at all.
Default Value: 'symbol' which will display the currency symbols.
Type: GlobalCurrencyDisplayType
IGlobalDefinitions
Definitions are used to share common referable concepts and items across different workspaces and areas of the client.
Properties: infoBubbles, sizes, styles, colors, tables, searchLayouts, enums, palettes
required
infoBubblesInfo-bubbles that can be used across all workspaces.
Type: ReusableInfoBubbleRegistry
required
sizesMapping between symbolic names to pixel width.
Type: Anonymous Object Type
xs | number |
sm | number |
md | number |
lg | number |
xl | number |
custom | number |
required
stylesReusable style definitions that can be applied across all workspaces.
Type: StyleRegistry
required
colorsReusable colors used across different workspaces
Type: ColorRegistry
required
tablesGlobal configuration for tables *
Type: ITableProperties
required
searchLayoutsLayouts used for performing different kinds of searches across all workspaces.
Type: IGlobalSearchLayouts
required
enumsClient-side enumeration types.
Type: IEnums
required
palettesPalettes containing a list of colors
Type: IPalettes
IGlobalPagingConfiguration
Represents the global paging configuration.
Properties: serverSidePaging, pageSizes, defaultPageSize, virtualScrollingEnabled
required
serverSidePagingConfiguration of the server-side table paging functionality.
Type: IServerSideTablePagingConfiguration
required
pageSizesThe page sizes for use in pageable tables. The page sizes should be in the interval between 1 and 100.
Type: Array<number>
defaultPageSize
The optional default page size to use in tables. Should be set to one of the values from the pageSizes array.
Default Value: The minimum page size from the pageSizes array.
Type: number
required
virtualScrollingEnabledEnable Virtual scrolling.
Type: boolean
IGlobalSearchLayouts
Represents a hierarchy of search layout configurations.
Search layouts are defined per search container where a search will be performed. For example, the field JobNumber
on a time sheet line is associated with the search container Find_JobHeader
from the maconomy
family. Therefore, for searches started from this field, the search layouts for the Find_JobHeader
container will be used.
Properties: containers
required
containersNo description available
Type: Array with any of the following
* <a href="#iglobalsearchlayouts">IGlobalSearchLayouts</a>
* Anonymous Object Type<br>
standard | IStandardSearchLayout |
container | Any of the following |
searchLayouts | INamedSearchLayouts |
IGrid
No description available
Properties: format, columns, lines, maxWidth
format
Assign formatting by data type
Type: TypeSpecificFormat
columns
The columns array allows logical grouping and assignment of shared properties across columns.
Type: Array<IGridColumn>
required
linesThe lines in a grid represent the grid's rows including headers, footers and sections.
Type: Array<GridLineOrSection>
maxWidth
Should the grid grab all horizontal space?
Default Value: false
Type: boolean
IGridAmountCell
The unit cell represents a field cell with a unit describing the data of the field.
Properties: format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, rendering, rowspan, colspan, visible, style, level, size, currency
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
rowspan
The row span determine how many visual rows a given scope encompasses.
Default Value: 1
Type: number
colspan
The column span determine how many visual columns a given scope encompasses.
Default Value: 1
Type: number
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
style
No description available
Type: Any of the following
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
* <a href="#ifirstmatchselector<(&&&&&)>">IFirstMatchSelector<(&&&&&)></a>
level
No description available
Type: undefined
size
No description available
Type: undefined
currency
the currency property is in principle mandatory but made optional in 2.6.1and 2.6.2 due to backward compatibility
Type: FieldName
IGridColumn
No description available
Properties: format, colspan, visible
format
Assign formatting by data type
Type: TypeSpecificFormat
colspan
The column span determine how many visual columns a given scope encompasses.
Default Value: 1
Type: number
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
IGridEmptyCell
An empty cell will show nothing
Properties: rowspan, colspan, visible, style, level, size
rowspan
The row span determine how many visual rows a given scope encompasses.
Default Value: 1
Type: number
colspan
The column span determine how many visual columns a given scope encompasses.
Default Value: 1
Type: number
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
style
No description available
Type: Any of the following
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
* <a href="#ifirstmatchselector<(&&&&&)>">IFirstMatchSelector<(&&&&&)></a>
level
No description available
Type: undefined
size
No description available
Type: undefined
IGridFieldCell
Field cell are used for data entry.
Properties: format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, rendering, rowspan, colspan, visible, style, level, size
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
rowspan
The row span determine how many visual rows a given scope encompasses.
Default Value: 1
Type: number
colspan
The column span determine how many visual columns a given scope encompasses.
Default Value: 1
Type: number
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
style
No description available
Type: Any of the following
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
* <a href="#ifirstmatchselector<(&&&&&)>">IFirstMatchSelector<(&&&&&)></a>
level
No description available
Type: undefined
size
No description available
Type: undefined
IGridHeaderLine
No description available
Properties: format, mandatory, open, style, visible, pane, cells, lineType
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
style
No description available
Type: Any of the following
{ }
Array with any of the following
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
cellsAn array of cells constituting the line. The number of cells and their colspans should match the other lines in the grid.
Type: Array<GridCell>
required
lineTypeA grid line can either be a header line, normal line or a total line.
Type: header
IGridHeaderLineShorthand
Shorthand to create a header line consisting only of text cells.
Properties: format, visible, pane, columnTitles
format
Assign formatting by data type
Type: TypeSpecificFormat
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
columnTitlesNo description available
Type: Array<LocalizableText>
IGridLinkCell
The link cell represents a link that can navigate to a specified URL.
Properties: alt, label, template, icon, authentication, url, workspace, mail, query, rowspan, colspan, visible, style, level, size
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
template
No description available
Type: LocalizableText
icon
No description available
Type: string
authentication
No description available
Type: IURLAuthenticationMethod
url
No description available
Type: URLElement
workspace
No description available
Type: WorkspaceLinkType
No description available
Type: MailElement
query
No description available
Type: Array<IQueryElement>
rowspan
The row span determine how many visual rows a given scope encompasses.
Default Value: 1
Type: number
colspan
The column span determine how many visual columns a given scope encompasses.
Default Value: 1
Type: number
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
style
No description available
Type: Any of the following
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
* <a href="#ifirstmatchselector<(&&&&&)>">IFirstMatchSelector<(&&&&&)></a>
level
No description available
Type: undefined
size
No description available
Type: undefined
IGridNormalLine
No description available
Properties: title, titleValue, titleSource, format, mandatory, open, style, visible, pane, cells, lineType
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
style
No description available
Type: Any of the following
{ }
Array with any of the following
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
cellsAn array of cells constituting the line. The number of cells and their colspans should match the other lines in the grid.
Type: Array<GridCell>
lineType
A grid line can either be a header line, normal line or a total line.
Default Value: normal
Type: normal
IGridPercentCell
The unit cell represents a field cell with a unit title of '%''.
Properties: format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, rendering, rowspan, colspan, visible, style, level, size
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
rowspan
The row span determine how many visual rows a given scope encompasses.
Default Value: 1
Type: number
colspan
The column span determine how many visual columns a given scope encompasses.
Default Value: 1
Type: number
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
style
No description available
Type: Any of the following
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
* <a href="#ifirstmatchselector<(&&&&&)>">IFirstMatchSelector<(&&&&&)></a>
level
No description available
Type: undefined
size
No description available
Type: undefined
IGridRow
Represents a row containing a grid structure.
Properties: format, island, mandatory, open, rendering, style, label, collapsible, pane, title, grid
format
Assign formatting by data type
Type: TypeSpecificFormat
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
gridA grid.
Type: Grid
IGridSection
A grid section represents a sublevel of the main grid.
Properties: format, mandatory, open, style, title, visible, pane, lines
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
style
No description available
Type: Any of the following
{ }
Array with any of the following
required
titleAn mandatory, localizable title.
Type: LocalizableText
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
linesThe lines of a section cn be either normal or total lines
Type: Array<GridSectionLine>
IGridTextCell
Cell type for displaying texts
Properties: title, titleValue, titleSource, rowspan, colspan, visible, style, level, size, template
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
rowspan
The row span determine how many visual rows a given scope encompasses.
Default Value: 1
Type: number
colspan
The column span determine how many visual columns a given scope encompasses.
Default Value: 1
Type: number
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
style
No description available
Type: Any of the following
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
* <a href="#ifirstmatchselector<(&&&&&)>">IFirstMatchSelector<(&&&&&)></a>
level
No description available
Type: undefined
size
No description available
Type: undefined
template
No description available
Type: LocalizableText
IGridTotalLine
No description available
Properties: title, titleValue, titleSource, format, mandatory, open, style, visible, pane, cells, lineType
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
style
No description available
Type: Any of the following
{ }
Array with any of the following
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
cellsAn array of cells constituting the line. The number of cells and their colspans should match the other lines in the grid.
Type: Array<GridCell>
required
lineTypeA grid line can either be a header line, normal line or a total line.
Type: total
IGridUnitFieldCell
The unit cell represents a field cell with a unit describing the data of the field.
Properties: format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, unit, rendering, rowspan, colspan, visible, style, level, size
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
required
unitNo description available
Type: IUnitBlock
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
rowspan
The row span determine how many visual rows a given scope encompasses.
Default Value: 1
Type: number
colspan
The column span determine how many visual columns a given scope encompasses.
Default Value: 1
Type: number
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
style
No description available
Type: Any of the following
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
verticalAlign | VerticalAlignType |
backgroundColor | Any of the following |
color | Any of the following |
fontWeight | string |
textAlign | TextAlignType |
condition | Expression |
* <a href="#ifirstmatchselector<(&&&&&)>">IFirstMatchSelector<(&&&&&)></a>
level
No description available
Type: undefined
size
No description available
Type: undefined
IHeading
Configuration of the header area of a workspace. The header is used to communicate the title of the workspace, provide access to the primary navigation facility, and optionally allow the user to create instances of the workspace's main data type.
Properties: pane, title, navigation, createAction
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
navigation
Optional navigation facility to navigate between different instances of the main data entity in this workspace.
Type: NavigationType
createAction
If specified, a creation action will be added to the workspace for adding a new record.
Type: IHeadingCreateAction
IHeadingCreateAction
No description available
Properties: visible, title, pane, wizardWorkspace
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
paneThe pane used to resolve unqualified references in this scope.
Type: PaneName
wizardWorkspace
A wizard that will be shown when this action is clicked.
Type: IWizardWorkspace
IInfoBubbleDefinition
A definition of an inline info-bubble.
Properties: label, pane, width, position, title, subTitle, rows
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
width
You can optionally specify the width of the Info-bubble:
xs: 200 px sm: 300 px md: 400 px lg: 400 px xl: 400 px
The default behavior is:
1 column is rendered xs 2 columns is rendered sm >2 columns is rendered md
Type: WidthType
position
An optional position of the info bubble. Right is default.
Type: IInfoBubblePosition
title
The title or heading of the info bubble
Type: IInfoBubbleTitleType
subTitle
The sub heading of the info bubble
Type: IInfoBubbleTitleType
required
rowsThe rows or content of the info bubble
Type: Array<RowType>
IInfoBubblePosition
No description available
IInfoBubbleReference
A reference to a reusable info-bubble.
Properties: ref, parameters
required
refNo description available
Type: InfoBubbleName
required
parametersNo description available
Type: Any of the following
IInfoBubbleTitle
No description available
source
An optional, text coming from the title of another field.
Type: FieldName
value
An optional, text coming from value of a field.
Type: FieldName
IInfoBubbleTitleType
No description available
Any of the following
IInitAction
Creates a new record (without saving it) in the specified pane.
Properties: init
required
initNo description available
Type: PaneName
IInlineInfoDialogConfiguration
No description available
Properties: autocloseMillis
required
autocloseMillisNo description available
Type: number
IInMemoryCardPaneDefinition
No description available
Properties: title, fields, foreignKeys
required
titleThe title of the pane.
Type: string
required
fieldsThe fields defined in this pane.
Type: InMemoryFieldDefinitionMapType
foreignKeys
No description available
Type: InMemoryForeignKeyDefinitionMapType
IInMemoryCardPaneSpecification
A configuration of an in-memory card pane.
Properties: type, name, bindings, source
required
typeNo description available
Type: client-card
required
nameNo description available
Type: PaneName
bindings
No description available
Type: Array<IBindingSpecification>
required
sourceThe definition of the client-side card pane.
Type: IInMemoryCardPaneDefinition
IInMemoryForeignKeyDefinition
A definition of a foreign-key.
Properties: title, fieldReferences, search
required
titleThe title of this foreign-key.
Type: LocalizableText
required
fieldReferencesThe mapping between fields in this pane and in the foreign pane.
Type: Array<IFieldReference>
search
The definition of a search for looking up values that can be assigned to the fields in this pane.
Type: InMemoryForeignKeySearchType
IInputBlock
Read-write block for performing data entry.
Properties: mandatory, open, autoSubmit, label, source, search, widget, shadowTitle
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
IIntegerFormat
No description available
Properties: short, zeroSuppression
short
True if short formatting should be applied, or specify a precise number of characters.
Type: Any of the following
- boolean
- Anonymous Object Type
precision | number |
zeroSuppression
True if zero values should be suppressed.
Type: boolean
IIntervalElement
The interval element represents a range. It consists of a title block and a from/to pair with a separator in between.
Properties: appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, from, to
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
fromNo description available
Type: Any of the following
required
toNo description available
Type: Any of the following
IKpiAmountField
No description available
required
sourceNo description available
Type: FieldName
required
currencyNo description available
Type: FieldName
IKpiColumn
Represents a KPI column. A KPI column contains vital data point of interests.
Properties: info, island, format, label, visible, span, offset, pane, title, kpi
info
Configuration for the info-bubble tooltip for the row
Type: Any of the following
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
format
Assign formatting by data type
Type: TypeSpecificFormat
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
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: number
offset
Column offset.
Type: number
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
kpiNo description available
Type: IKpiElement
IKpiElement
No description available
Properties: style, height, format, mandatory, open, visible, value
style
No description available
Type: Any of the following
- Anonymous Object Type
extends | StyleName |
condition | Expression |
color | Any of the following |
backgroundColor | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
extends | StyleName |
condition | Expression |
color | Any of the following |
backgroundColor | Any of the following |
* <a href="#ifirstmatchselector<(&&&)>">IFirstMatchSelector<(&&&)></a>
height
An optional height. If unspecified, no height will be set for the part.
Type: number
format
Assign formatting based upon the data value
Type: ValueFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
valueNo description available
Type: KpiValueType
IKpiPercentField
No description available
Properties: percent
required
percentNo description available
Type: FieldName
IKpiText
No description available
Properties: text
required
textNo description available
Type: LocalizableText
IKpiUnitField
No description available
required
sourceNo description available
Type: FieldName
required
unitNo description available
Type: IUnitBlock
ILayoutColumn
Represents a layout column which lays out its contents vertically.
Properties: info, island, format, mandatory, open, rendering, style, label, visible, collapsible, span, offset, pane, title, rows
info
Configuration for the info-bubble tooltip for the row
Type: Any of the following
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
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: number
offset
Column offset.
Type: number
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
rowsAn array of layout rows.
Type: Array<ExtendedRowType>
ILayoutNameAndParameters
No description available
Properties: name
required
nameThe name of the search layout.
Type: LayoutName
ILayoutRow
Represents a layout row which lays out its contents horizontally.
Properties: info, island, format, mandatory, open, rendering, style, label, splitter, collapsible, pane, title, columns
info
Configuration for the info-bubble tooltip for the row
Type: Any of the following
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
splitter
A splitter can appear dynamically by specifying an expression. Alternatively, if a splitter is always appearing, a configuration can be given to determine its appearance and behavior.
Default Value: false
Type: Any of the following
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
columnsAn array of layout columns.
Type: Array<ColumnType>
ILayoutSettings
No description available
Properties: grabHorizontalSpace, openInListMode
required
grabHorizontalSpaceWhen enabled, all workspaces will have narrow margins and grab the horizontal space available.
Type: BooleanValue
required
openInListModeControls whether all workspaces which have a filter-based navigation should open in "list view" mode by default.
Type: BooleanValue
ILegendOptions
The legend configurations for the chart
Properties: reversed, showInLegend, layout, align, verticalAlign, itemMarginTop, itemMarginBottom, x, y
reversed
Whether to reverse the order of the legend items compared to the order of the series or points as defined in the configuration object. Defaults to false
Type: boolean
showInLegend
Used to show or hide chart legend
Type: boolean
layout
The layout of the legend items. Can be one of horizontal or vertical or proximate. Defaults to horizontal
Type: string
align
The horizontal alignment of the legend box within the chart area. Valid values are left, center and right. Defaults to center.
Type: string
verticalAlign
The vertical alignment of the legend box. Can be one of top, middle or bottom. Defaults to bottom.
Type: string
itemMarginTop
The pixel top margin for each legend item. Defaults to 0.
Type: number
itemMarginBottom
The pixel bottom margin for each legend item. Defaults to 0.
Type: number
x
The x offset of the legend relative to its horizontal alignment align within chart.spacingLeft and chart.spacingRight. Negative x moves it to the left, positive x moves it to the right. Defaults to 0
Type: number
y
The vertical offset of the legend relative to it's vertical alignment verticalAlign within chart.spacingTop and chart.spacingBottom. Negative y moves it up, positive y moves it down. Defaults to 0.
Type: number
ILinkBinding
A variant of the "link" binding with additional configurable properties.
Properties: defaultPaneContent, type
defaultPaneContent
Controls the initial content of the pane that is the target of the binding.
This property can be set to one of the following values:
any-record
- the pane will be populated with a record selected by the backend;empty
- the pane will contain no records.
If this property is not specified, then the default state is any-record
.
Type: string
required
typeNo description available
Type: link
ILinkElement
The link element represents a link that can navigate to a specified URL.
Properties: alt, label, template, icon, authentication, url, workspace, mail, query, appearance, rendering, title, titleValue, titleSource, mandatory, open, visible
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
template
No description available
Type: LocalizableText
icon
No description available
Type: string
authentication
No description available
Type: IURLAuthenticationMethod
url
No description available
Type: URLElement
workspace
No description available
Type: WorkspaceLinkType
No description available
Type: MailElement
query
No description available
Type: Array<IQueryElement>
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
ILinkItem
A representation of a single menu item which opens an external URL.
Properties: title, visible, url
required
titleAn mandatory, localizable title.
Type: LocalizableText
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
urlLink to an external URL that should be opened.
Type: string
IListView
Represents a layout for a list view.
Properties: style, pane, columns, actions, columnChooser
style
No description available
Type: Any of the following
{ }
Array with any of the following
required
paneThe pane used to resolve unqualified references in this scope.
Type: PaneName
required
columnsNo description available
Type: Array<TableColumnType>
actions
No description available
Type: Array<TableActionType>
columnChooser
No description available
Type: ColumnChooser
ILocalDefinitions
Definitions that are used to share common referable items within a single workspace.
Properties: infoBubbles, searchLayouts, enums
infoBubbles
Info-bubbles that can be used multiple times across the same workspace.
Type: ReusableInfoBubbleRegistry
searchLayouts
Layouts used for performing different kinds of searches in this workspace.
Type: ILocalSearchLayouts
enums
Client-side enumeration types.
Type: IEnums
ILocalSearchLayouts
Represents a list of search layout configurations for local use in a workspace.
Properties: containers
required
containersNo description available
Type: Array<IContainerSearchLayouts>
ILongRunningOperations
The configuration of the long-running operations functionality.
Properties: enabled, patience, expiry
required
enabledSpecifies whether the long-running operations functionality is enabled in the web client.
If this functionality is disabled, then:
- all requests will be executed synchronously, and
- no progress information will be read from the server.
This property can have one of the following values:
- a boolean:
true
orfalse
, which will unconditionally enable or disable this functionality for all users. - an expression string which can be used to restrict this functionality to selected users, e.g. based on their role.
Type: Any of the following
- boolean
- Expression
required
patienceSpecifies the number of seconds that a request may run before switching to asynchronous execution.
If a request takes longer than the specified number of seconds, then the server will switch the execution of this request into asynchronous mode.
If this value is set to zero, then all requests will be executed asynchronously.
Type: number
expiry
Specifies the number of seconds that information about an asynchronous request is kept on the server.
If this property is not specified, a default value will be applied by the server.
Type: number
Image
Conditional clauses *
Any of the following
IMailValue
No description available
Properties: value
required
valueNo description available
Type: Expression
IMappedFilterAsTableField
Defines a mapping between a filter field and a card field for a filter-as-table pane.
Properties: mapsTo
required
mapsToSpecifies the name of the field in the card pane.
Type: FieldName
IMenu
The menu provides access to the workspaces that are available to the logged-in user. A menu consists of workspaces ordered in groups. Different users may see different sets of menu groups and items depending on the user's privileges and context.
Properties: restoreLastWorkspace, defaultWorkspace, groups
restoreLastWorkspace
Restore the last used workspace on login.
Default Value: false
Type: boolean
defaultWorkspace
A prioritized list of candidate default or startup workspaces. On startup, this list is evaluated and the first candidate where the condition is satisfied is chosen as default for the logged-in user.
Default Value: ``
Type: Array<DefaultWorkspaceCandidate>
required
groupsThe set of menu groups available in the menu.
Type: Array<IMenuGroup>
IMenuGroup
A group of workspaces arranged under a common title
Properties: title, visible, items, icon, expanded
required
titleAn mandatory, localizable title.
Type: LocalizableText
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
items
The workspaces or links contained in this menu group.
Type: Array<IMenuItem>
icon
An optional icon for the menu group.
Type: string
expanded
Determines whether a menu group is expanded or collapsed on login.
Default Value: true
Type: BooleanValue
IMenuItem
No description available
Any of the following
IMountBinding
A variant of the "mount" binding with additional configurable properties.
Properties: defaultPaneContent, type, enableReverseChannel
defaultPaneContent
Controls the initial content of the pane that is the target of the binding.
This property can be set to one of the following values:
any-record
- the pane will be populated with a record selected by the backend;empty
- the pane will contain no records.
If this property is not specified, then the default state is any-record
.
Type: string
required
typeNo description available
Type: mount
enableReverseChannel
Controls whether the reverse channel to the upstream pane is enabled.
Setting this property to true
allows messages to pass instructing the parent pane (if there is one) to refresh when the bound pane performs a server action.
If this property is not specified, then the reverse channel is not enabled.
Type: boolean
INamedPalette
No description available
Map from string
to PaletteItem
INamedSearchLayout
A named search layout.
Properties: restriction, selection, orderBy, searchFields, searchAsYouType, advancedSearch
restriction
A base restriction to be applied to limit the search results.
Type: Expression
selection
Defines predefined search restrictions which the user can choose from.
The selected search restriction is applied in addition to any restrictions defined elsewhere.
Note that for a search-as-you-type search, the restriction selected as default will always be applied.
Type: IFilterSelection
orderBy
Defines the default sorting order of the search results.
Type: Array<IOrderBy>
searchFields
A list of fields on which the free-text search will be performed. Defaults to the fields referenced in the search-as-you-type layout.
Type: Array<FieldName>
searchAsYouType
Defines properties for the search-as-you-type search.
If this property is not specified, then the configuration from the standard layout will be used.
Type: ISearchAsYouTypeLayout
advancedSearch
Defines properties for the advanced search.
If this property is not specified, then the configuration from the standard layout will be used.
Type: IAdvancedSearchLayout
INamedSearchLayouts
No description available
Map from string
to INamedSearchLayout
INavigateAction
Navigates within a given pane by selecting the first filter record matching the given restriction.
Properties: navigate
required
navigateNo description available
Type: INavigateActionDefinition
INavigateActionDefinition
No description available
Properties: pane, restriction
required
paneThe pane used to resolve unqualified references in this scope.
Type: PaneName
required
restrictionNo description available
Type: Expression
InfoBubbleName
String alias for an info bubble.
InMemoryFieldDefinitionMapType
No description available
Map from string
to InMemoryFieldDefinitionType
InMemoryFieldDefinitionType
No description available
Any of the following
- Anonymous Object Type
title | string |
type | string |
autoSubmit | boolean |
mandatory | boolean |
open | boolean |
defaultValue | Expression |
multiLine | boolean |
maxLength | number |
- Anonymous Object Type
title | string |
type | string |
autoSubmit | boolean |
mandatory | boolean |
open | boolean |
defaultValue | Expression |
maxValue | number |
minValue | number |
- Anonymous Object Type
title | string |
type | enum |
autoSubmit | boolean |
mandatory | boolean |
open | boolean |
defaultValue | Expression |
enumType | Any of the following
|
InMemoryForeignKeyDefinitionMapType
No description available
Map from string
to IInMemoryForeignKeyDefinition
InMemoryForeignKeySearchType
No description available
Any of the following
INotificationConfiguration
Represents the configuration of notification reload and recalculation intervals.
Properties: recalculation, types
required
recalculationThe recalculation settings determine when the first recalculation of the end-user's notifications occur and what the interval between subsequent recalculations is. All values are specified in minutes.
Type: Anonymous Object Type
initialDelay | number |
interval | number |
quarantinePeriod | number |
required
typesSupported notification types as specified in the MNSL files.
Type: NotificationTypes
INotificationType
No description available
Properties: workspace, parameters
required
workspaceThe name of the workspace
Type: WorkspaceName
parameters
A map of url parameters for the workspace linking to the Focus key in question.
Type: ReferencePoint
IntervalFormElementType
No description available
Properties: interval
required
intervalNo description available
Type: IIntervalElement
IOpenInListMode
An object which controls whether a workspace should open in "list view" mode by default.
Properties: openInListMode
required
openInListModeControls whether this workspace should open in "list view" mode by default.
This setting overrides the global setting for all workspaces.
Type: BooleanValue
IOrderBy
A field used for sorting records in a pane.
required
sourceNo description available
Type: FieldName
order
The sorting order for this field.
If not specified, then the default order is ascending
.
Type: string
IOrderedPalette
No description available
Array<PaletteItem>
IOtherField
No description available
Properties: title, type, autoSubmit, mandatory, open, defaultValue
title
The title of this field.
If not set, then the name of the field will be used as the title.
Type: string
required
typeThe data type of this field.
Type: string
autoSubmit
Specifies whether this field is an auto-submit field.
Default Value: false
Type: boolean
mandatory
Specifies whether this field is an auto-submit field.
Default Value: false
Type: boolean
open
Specifies whether this field is open for editing.
Default Value: true
Type: boolean
defaultValue
TODO
Type: Expression
IPageLayout
Represents the layout for a page in a wizard.
Properties: title, pane, open, rows, link
title
The title of this page. Can be overridden by the title of the workflow state.
Type: LocalizableText
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
required
rowsThe main body of a page layout consists of an array of layout rows.
Type: Array<RowType>
link
Specifies a optional link on the page. The user can click to navigate to the item in context.
Type: ILinkElement
IPageLayouts
No description available
Map from string
to IPageLayout
IPagingConfiguration
No description available
Properties: initialSize
initialSize
Specifies the number of records that will be initially loaded into this pane.
Type: number
IPairElement
The pair element represents a pair. It consists of a title block and a pair of two fields.
Properties: appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, first, second, ratio
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
firstNo description available
Type: Any of the following
required
secondNo description available
Type: Any of the following
ratio
No description available
Type: string
IPaletteItem
Represents an entry in a palette. An entry can have various color properties. The foreground color is the primary one and will be used if this palette item is referred in an unqualified way.
Properties: background, foreground, badge
background
The background color.
Type: Color
foreground
The foreground color.
Type: Color
badge
The color of the badge.
Type: Color
IPalettes
The web client exposes a number of global palettes. A palette can either by ordered or named depending on how it is going to be accessed in the concrete layouts. It is possible to expose a named palette as an ordered one, but it is discouraged to exposed an ordered palette as a named one (using indices).
Map from string
to Palette
IPaneConfiguration
No description available
Properties: actions, foreignKeys
actions
Additional configuration for actions in this pane.
Any application action, such as "SubmitExpenseSheet", "ApproveAbsenceEntry", etc., may be configured here. It is also possible to configure the following standard actions:
- "create" - for saving new records,
- "update" - for saving existing records.
Type: IActionConfiguration
foreignKeys
Additional configuration for foreign-keys.
Type: ForeignKeyConfiguration
IPeoplePlannerColorFormat
No description available
{ }
IPeoplePlannerDateTimeFormat
No description available
{ }
IPeoplePlannerDoubleFormat
No description available
{ }
IPeoplePlannerFloatFormat
No description available
{ }
IPeoplePlannerGuidFormat
No description available
{ }
IPeoplePlannerIntegerFormat
No description available
{ }
IPeoplePlannerStringFormat
No description available
{ }
IPercentElement
The percent element represents a field element with a hardcoded percent unit.
Properties: style, format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, appearance, rendering, title, titleValue, titleSource, visible
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
textAlign | TextAlignType |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
textAlign | TextAlignType |
color | Any of the following |
* <a href="#ifirstmatchselector<(&&)>">IFirstMatchSelector<(&&)></a>
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
IProjectedFields
No description available
Any of the following
IQueryElement
No description available
Any of the following
- QueryValueType
- Array<QueryValueType>
IRadioElement
The radio element represents a set of radio elements.
Properties: format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, appearance, rendering, title, titleValue, titleSource, visible
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
IRealFormat
No description available
Properties: decimalPlaces, short, zeroSuppression
decimalPlaces
An optional property which determines the number of decimal places to display. End users can override property in My Settings window
Default Value: '2' which will display two decimal places.
Type: ZeroThroughTen
short
True if short formatting should be applied, or specify a precise number of characters.
Type: Any of the following
- boolean
- Anonymous Object Type
precision | number |
zeroSuppression
True if zero values should be suppressed.
Type: boolean
IRecordHeading
No description available
Properties: pane, title, subTitle, status, image, revision
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional title for the sub heading of the workspace.
Type: TitleType
subTitle
An optional sub-title for the sub heading of the workspace.
Type: TitleType
status
An optional status element for the sub heading of the workspace.
Type: IStatusElement
image
An optional image element for the sub heading of the workspace.
Type: Image
revision
An optional record revision element for the sub heading of the workspace.
Type: Any of the following
Standard
- IRecordRevisionSummary
IRecordRevision
Record Revision is used to store the user, date info for created/updated elements.
required
userNo description available
Type: FieldName
required
dateNo description available
Type: FieldName
IRecordRevisionSummary
Record Revision Summary consist of revision information.
Properties: created, updated, version
required
createdContains creation information.
Type: IRecordRevision
required
updatedContains update information.
Type: IRecordRevision
required
versionContains the version information.
Type: FieldName
IReferenceElement
The reference element represents a foreign key. It consists of a title block and a description/key pair.
The source of the reference element can be specified in the following ways: 1. Using the foreignKey
attribute. In this case, the fields for the description/key pair are determined automatically from the foreign-key. 2. Using the key
and description
attributes. This approach should be used if no foreign-key is available for the required fields. 3. Using the foreignKey
attribute together with the key
and/or description
attributes. This method should be used if the fields determined automatically from the foreign-key are not correct in this context.
Any of the following
- IReferenceElementWithForeignKey
- Anonymous Object Type
autoSubmit | boolean |
info | Any of the following |
appearance | AppearanceType |
rendering | IRendering |
title | LocalizableText |
titleValue | FieldName |
titleSource | FieldName |
label | string |
mandatory | Expression |
open | Expression |
visible | Expression |
description | Any of the following |
key | Any of the following |
IReferenceElementWithForeignKey
No description available
Properties: autoSubmit, info, appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, description, key, foreignKey, search
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
description
No description available
Type: Any of the following
key
No description available
Type: Any of the following
required
foreignKeyNo description available
Type: ForeignKeyName
search
The configuration of the search capabilities available for this foreign-key.
If separate fields are specified for the description or key parts, then they might override the search configuration specified here.
Type: FieldSearchType
IRefreshTrigger
No description available
panes
Any data change on the specified optional panes, or their related panes, will trigger a refresh
Type: Array<PaneName>
fields
Any data change on the specified optional fields will trigger a refresh
Type: Array<FieldName>
IRendering
Represents the two different ways of rendering a layout (or part of a layout).
IReportColumnReference
No description available
Properties: columnName, levelName, title
required
columnNameThe name of a column in an Analyzer report.
Type: ColumnName
levelName
The name of a report level (as defined in the source section of the report) for the referenced column.
If not specified, then the default level will be used.
Type: LevelName
title
An optional title for the column.
If specified, this title overrides the column title defined with the Analyzer report.
Type: string
IReportLeafLevel
No description available
Properties: levelName, columns
required
levelNameThe name of this report level.
Type: string
required
columnsA list of columns to be included in the report.
Type: Array<string>
IReportMenuPathElement
Report menu path element
Properties: title
required
titleNo description available
Type: string
IReportRowRestriction
No description available
Properties: columnName, restrictions
required
columnNameThe name of a column in an Analyzer report to which the restrictions will be applied.
Type: ColumnName
required
restrictionsA list of restrictions to be applied to the specified column.
The restrictions in the list will be combined using a logical disjunction (i.e. a logical "or").
Type: Array<RestrictionType>
IReportRunsDropDownConfiguration
No description available
Properties: initialRefreshReportRunsSeconds, refreshReportRunsSeconds, firstUpdateReportRunsSeconds, secondUpdateReportRunsSeconds
required
initialRefreshReportRunsSecondsThe waiting time before the first refresh of the report runs drop down menu is done
Type: number
required
refreshReportRunsSecondsThe waiting time between refreshes of the report runs drop down menu after the first refresh of the report runs drop menu
Type: number
required
firstUpdateReportRunsSecondsIndicates 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: number
required
secondUpdateReportRunsSecondsIndicates 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: number
IReportsMenuConfiguration
No description available
Properties: refreshReportsMenuSeconds
required
refreshReportsMenuSecondsThe waiting time between refreshes of the reports menu drop down
Type: number
IReportSubtotalLevel
No description available
Properties: levelName, subtotal, columns, childLevel
required
levelNameThe name of this report level.
Type: string
required
subtotalThe name of the column to subtotal on.
Type: string
columns
A list of key columns to be included on the same level, but without subtotals.
Type: Array<string>
required
childLevelNo description available
Type: ReportLevelType
IReusableInfoBubbleDefinition
A definition of a reusable info bubble.
Properties: label, pane, width, position, title, subTitle, rows, parameters
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
width
You can optionally specify the width of the Info-bubble:
xs: 200 px sm: 300 px md: 400 px lg: 400 px xl: 400 px
The default behavior is:
1 column is rendered xs 2 columns is rendered sm >2 columns is rendered md
Type: WidthType
position
An optional position of the info bubble. Right is default.
Type: IInfoBubblePosition
title
The title or heading of the info bubble
Type: IInfoBubbleTitleType
subTitle
The sub heading of the info bubble
Type: IInfoBubbleTitleType
required
rowsThe rows or content of the info bubble
Type: Array<RowType>
required
parametersNo description available
Type: IReusableInfoBubbleParameters
IReusableInfoBubbleParameters
Defines the parameters for the reusable info bubble.
Properties: fields, foreignKeys
required
fieldsNo description available
Type: Array<FieldName>
foreignKeys
No description available
Type: Array<ForeignKeyName>
IRevertAction
Reverts changes in the specified pane.
Properties: revert
required
revertNo description available
Type: PaneName
ISaveAction
Saves any dirty records in the the specified panes.
Properties: save
required
saveNo description available
Type: Any of the following
IScheduler
Configuration of the scheduler.
Properties: pane, title, defaultView, period, view, slot, settingsWizard, createWizard, events
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
The text to show in the title of the scheduler.
Type: TemplateText
defaultView
The default view for the scheduler.
Type: SchedulerViewType
period
Fields to update with the period shown in the scheduler.
If this property is set, then the scheduler will update these fields with the currently selected date range. Note that the scheduler does not read the value that is stored in these fields.
Type: Anonymous Object Type
start | FieldName |
end | FieldName |
view
A field to update with view shown in the scheduler.
If this property is set, then the scheduler will update this field with the currently selected view. Note that the scheduler does not read the value that is stored in this field.
Type: Anonymous Object Type
source | FieldName |
mask | ISchedulerViewMask |
slot
No description available
Type: SchedulerSlotDivision
settingsWizard
A wizard for editing the settings of the scheduler.
If this property is defined, a link will appear in the scheduler's toolbar for invoking this wizard.
Type: IWizardInvocationWithOptionalPane
createWizard
A wizard for creating a new event in the scheduler.
If this property is defined, then double-clicking on an empty slot in the scheduler will invoke this wizard.
Type: IWizardInvocationWithOptionalPane
required
eventsConfigures the events list in the scheduler.
Type: ISchedulerEventConfiguration
ISchedulerEventConfiguration
No description available
Properties: pane, title, allDayTitle, color, actions, start, end, elements
required
paneThe pane that contains the list of events to be shown in the scheduler.
Each record in the specified pane will be shown as a separate event.
Type: PaneName
title
The text to show in the title of the event.
Type: TemplateText
allDayTitle
The text to show in the all day title of the event.
Type: TemplateText
color
A color can be set on an event. The color will be used for coloring the left border of the event.
Type: IEventColor
required
actionsA list of actions to be shown in the actions menu of an event.
The first visible action in this list is the default action. It will be invoked when the user double-clicks the event.
Type: Array<TableActionType>
required
startA field which contains the starting date and time of the event.
Type: DateTimeField
required
endA field which contains the ending date and time of the event.
Type: DateTimeField
required
elementsThe layout for the event.
Type: Array with any of the following
* <a href="#fieldformelementtype">FieldFormElementType</a>
* <a href="#referenceformelementtype">ReferenceFormElementType</a>
* <a href="#unitfieldformelementtype">UnitFieldFormElementType</a>
* <a href="#amountformelementtype">AmountFormElementType</a>
* <a href="#percentformelementtype">PercentFormElementType</a>
ISchedulerRow
Represents a row containing a scheduler component.
Properties: island, style, label, collapsible, pane, title, scheduler
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
schedulerA scheduler
Type: IScheduler
ISchedulerViewMask
A mask for matching field values against one of the view types supported by the scheduler.
The field value is specified as an Expression Language expression.
Map from string
to SchedulerViewType
IScopeRow
Represents one or more rows as a single container. Scopes can have titles which will make them render in the user interface as a collapsible section.
Properties: collapsible, title, scope
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
scopeNo description available
Type: Array<RowType>
ISearchAsYouTypeLayout
The search-as-you-type part of a search layout.
Properties: restriction, elements, image
restriction
A base restriction to be applied to limit the search results in addition to any restrictions defined elsewhere.
Type: Expression
required
elementsThe search result layout.
Type: Array<SearchResultType>
image
The image for each record in the search result.
Type: Image
ISearchRestriction
No description available
Properties: visible, title, label, restriction
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
restriction
An optional expression for this search restriction.
Type: Expression
IServerSideTablePagingBufferConfiguration
No description available
Properties: size, minimumSize
required
sizeThe number of extra records to load before and after the currently selected page.
Type: PagingBufferSizeType
required
minimumSizeThe number of extra records before and after the currently selected page, which, if present, will not trigger the addition of the buffer.
Type: PagingBufferSizeType
IServerSideTablePagingConfiguration
No description available
required
enabledThis flag enables server-side table paging for all supported tables.
Type: boolean
required
bufferSpecifies the number of extra records loaded in addition to the ones on the current page.
Type: Any of the following
ISettings
Settings represents formats, language, and other end-user configurable properties.
Properties: formats, minutesThreshold, menuSearch, menu, images, layout, formatting, userInactivityInterval, draggableFieldValues, multiSort, showFieldBorders, calendar
formats
The formats configuration determines the data formatting as well as whether this can be changed by the end-user.
Type: IFormats
minutesThreshold
The minute threshold determines when a time entry is interpreted as minutes or as hours. Default is '10' which means that an entry of '10' will be interpreted as 10 minutes, and an entry of '11' will be interpreted as 11 hours.
Default Value: 10
Type: number
menuSearch
The menuSearch configuration determines if the search component is enabled in the menu
Default Value: false
Type: boolean
menu
Configuration options for the menu
Type: Anonymous Object Type
search | BooleanValue |
expanded | BooleanValue |
showRecentPlaces | BooleanValue |
required
imagesThe images configuration determines if the images are enabled
Type: BooleanValue
required
layoutGlobal settings for controlling the layout of workspaces.
Type: ILayoutSettings
required
formattingConfigure formatting rules for data types.
Type: GlobalTypeSpecificFormat
userInactivityInterval
The user inactivity interval in minutes.
The client will perform certain automatic operations, such as periodically refreshing conversations or notifications, only when the user is active. If the inactivity timeout exceeds the number of minutes specified in this property, then such automatic refresh will be paused.
Default Value: 10
Type: number
draggableFieldValues
This setting controls whether field values are draggable by mouse in the user interface.
Default Value: false
Type: BooleanValue
multiSort
This setting enables multiple column sorting in the user interface.
Default Value: false
Type: BooleanValue
showFieldBorders
This setting enables field borders to be displayed in the user interface.
Default Value: false
Type: BooleanValue
calendar
This setting controls the first day of the week used in calendars. When not used the first day of the week will be derived form the region used.
Please note: The calendar used to select a Time Sheet will always start on a Monday, regardless of this setting.
Type: CalendarSettings
ISidePanel
The selection criteria panel definition. Selection criteria panels can exist within either a workspace or a tab. If you specify this on a workspace you cannot specify it on a tab and vice versa. Each tab can hold only one such panel.
Properties: info, island, format, mandatory, open, rendering, style, label, visible, collapsible, span, offset, pane, title, elements, showChips
info
Configuration for the info-bubble tooltip for the row
Type: Any of the following
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
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: number
offset
Column offset.
Type: number
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
titleThe tab title is a localizable text that is shown in both a collapsed and expanded state. Click on the title to expand or collapse the side panel.
Type: LocalizableText
required
elementsAn array of the elements contained in this scope
Type: Array<FormElementType>
showChips
The chips show a summary of the currently active selection. Removing a chip will remove that part of the selection criteria.
Type: boolean
ISidePanelRow
A selection criteria panel within this workspace or tab.
Properties: selectionCriteria
required
selectionCriteriaNo description available
Type: ISidePanel
IStandardSearchLayout
A standard search layout.
Properties: restriction, selection, orderBy, searchFields, searchAsYouType, advancedSearch
restriction
A base restriction to be applied to limit the search results.
Type: Expression
selection
Defines predefined search restrictions which the user can choose from.
The selected search restriction is applied in addition to any restrictions defined elsewhere.
Note that for a search-as-you-type search, the restriction selected as default will always be applied.
Type: IFilterSelection
orderBy
Defines the default sorting order of the search results.
Type: Array<IOrderBy>
searchFields
A list of fields on which the free-text search will be performed. Defaults to the fields referenced in the search-as-you-type layout.
Type: Array<FieldName>
required
searchAsYouTypeDefines properties for the search-as-you-type search.
Type: ISearchAsYouTypeLayout
required
advancedSearchDefines properties for the advanced search.
Type: IAdvancedSearchLayout
IStatusBlock
No description available
Properties: label, source, mask
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this status block.
Type: FieldName
required
maskA mask map a given internal status value to a title and css. In time sheets, you can for instance map the status character '1' to the title 'Due' and the color red.
Type: IStatusIndication
IStatusElement
Status elements are used in forms for rendering status information about a record.
Properties: label, source, mask, appearance, rendering, title, titleValue, titleSource, mandatory, open, visible, color
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this status block.
Type: FieldName
required
maskA mask map a given internal status value to a title and css. In time sheets, you can for instance map the status character '1' to the title 'Due' and the color red.
Type: IStatusIndication
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
color
A color indicating the status of the element.
Type: Color
IStatusIndication
No description available
Properties: title, info, color
required
titleAn mandatory, localizable title.
Type: LocalizableText
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
color
A color indicating the status of the mask.
Type: Color
IStringFormat
No description available
{ }
IStyledStatusIndication
No description available
Properties: style, title, info, color
style
No description available
Type: Any of the following
- Anonymous Object Type
color | Any of the following |
backgroundColor | Any of the following |
- StyleName
- Array<Anonymous Object Type
color | Any of the following |
backgroundColor | Any of the following |
required
titleAn mandatory, localizable title.
Type: LocalizableText
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
color
A color indicating the status of the mask.
Type: QualifiedPaletteItemName
ISumLineDefinition
No description available
Properties: format, style, pane, columns
format
Assign formatting by data type
Type: TypeSpecificFormat
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
fontWeight | string |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
fontWeight | string |
color | Any of the following |
* <a href="#ifirstmatchselector<(&&)>">IFirstMatchSelector<(&&)></a>
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
columnsNo description available
Type: Array<SumLineColumn>
ISumLineField
No description available
Properties: format, style, source
format
Assign formatting based upon the data value
Type: ValueFormat
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
fontWeight | string |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
fontWeight | string |
color | Any of the following |
* <a href="#ifirstmatchselector<(&&)>">IFirstMatchSelector<(&&)></a>
required
sourceNo description available
Type: FieldName
ISumLineFieldColumn
No description available
required
refA reference to a column in the table body
Type: FieldName
required
fieldNo description available
Type: ISumLineField
ISumLineText
No description available
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
fontWeight | string |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
fontWeight | string |
color | Any of the following |
* <a href="#ifirstmatchselector<(&&)>">IFirstMatchSelector<(&&)></a>
required
titleAn mandatory, localizable title.
Type: LocalizableText
ISumLineTextColumn
No description available
required
refA reference to a column in the table body
Type: FieldName
required
textNo description available
Type: ISumLineText
ITab
Represents a single tab in a tab group. A tab always has a title and can optionally provide a badge to highlight it.
Properties: visible, info, island, format, mandatory, open, rendering, style, label, collapsible, span, offset, pane, title, rows, badge, sticky, actions, assistant
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
info
Configuration for the info-bubble tooltip for the row
Type: Any of the following
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
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: number
offset
Column offset.
Type: number
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
required
titleThe tab title is a localizable text that is shown regardless of whether the tab contents are shown.
Type: LocalizableText
required
rowsAn array of layout rows.
Type: Array<ExtendedRowType>
badge
The badge is an optional decoration which is used to highlight aggregated information from a tab column.
Type: IBadge
sticky
A tab can be "sticky" meaning that it remains visible for a while even though its visibility condition evaluates to false. This only holds for the currently active tab and only as long as no other server request has been made. The purpose of this attribute is to allow a tab to remain visible for a short while even though all work on it has been completed.
Default Value: false
Type: boolean
actions
The actions to be shown in this tab.
Type: Array with any of the following
* <a href="#actiontype">ActionType</a>
* <a href="#iactiongroup">IActionGroup</a>
assistant
An optional panel within this tab. Will hold UI for the assistant of this tab.
Type: IAssistant
ITable
No description available
Properties: format, mandatory, open, style, identifier, pane, title, height, pageable, columns, footer, actions, assistant, columnChooser, switches
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
color | Any of the following |
* <a href="#ifirstmatchselector<(&)>">IFirstMatchSelector<(&)></a>
identifier
An optional identifier used for disambiguation of user settings
Type: string
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
height
The optional height of the table in pixel. number | 'minimal' 'minimal': will make the table a small as possible to a maximum of 3 rows shown before a scrollbar appears.
Type: TableHeightType
pageable
Optionally enables paging in the table. Only supported on regular table and not on 'tree tables'
Default Value: true
Type: boolean
required
columnsNo description available
Type: Array<TableColumnType>
footer
No description available
Type: ITableFooter
actions
No description available
Type: Array<TableActionType>
assistant
No description available
Type: ITableAssistant
columnChooser
No description available
Type: ColumnChooser
switches
One or more boolean fields that control the content of the table.
Type: TableSwitchType
ITableAmountColumn
No description available
Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, format, validators, info, autoSubmit, source, search, widget, shadowTitle, currency
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
color | Any of the following |
* <a href="#ifirstmatchselector<(&)>">IFirstMatchSelector<(&)></a>
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
width
No description available
Type: WidthType
suppress
A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.
Type: Expression
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
required
currencyNo description available
Type: FieldName
ITableAssistant
No description available
Properties: info, island, format, mandatory, open, rendering, style, label, visible, collapsible, span, offset, pane, title, rows, height
info
Configuration for the info-bubble tooltip for the row
Type: Any of the following
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
format
Assign formatting by data type
Type: TypeSpecificFormat
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
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: number
offset
Column offset.
Type: number
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
rowsAn array of layout rows.
Type: Array<ExtendedRowType>
height
The height of the assistant. Content that exceeds this height will invoke a vertical scroll bar for the assistant.
Type: number
ITableFieldColumn
Represents the type of element that can be inserted in tables.
Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, format, validators, info, autoSubmit, source, search, widget, shadowTitle
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
color | Any of the following |
* <a href="#ifirstmatchselector<(&)>">IFirstMatchSelector<(&)></a>
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
width
No description available
Type: WidthType
suppress
A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.
Type: Expression
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
ITableFileSizeColumn
No description available
Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, format, validators, info, autoSubmit, source, search, widget, shadowTitle
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
color | Any of the following |
* <a href="#ifirstmatchselector<(&)>">IFirstMatchSelector<(&)></a>
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
width
No description available
Type: WidthType
suppress
A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.
Type: Expression
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
ITableFooter
No description available
Properties: format, pane, expanded, sumLines
format
Assign formatting by data type
Type: TypeSpecificFormat
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
expanded
Is the table footer expanded by default.
Default Value: false
Type: BooleanValue
required
sumLinesNo description available
Type: Array<ISumLineDefinition>
ITableLinkColumn
No description available
Properties: exportable, style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, template, icon, authentication, url, workspace, mail, query
exportable
No description available
Default Value: false
Type: boolean
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
color | Any of the following |
* <a href="#ifirstmatchselector<(&)>">IFirstMatchSelector<(&)></a>
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
width
No description available
Type: WidthType
suppress
A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.
Type: Expression
template
No description available
Type: LocalizableText
icon
No description available
Type: string
authentication
No description available
Type: IURLAuthenticationMethod
url
No description available
Type: URLElement
workspace
No description available
Type: WorkspaceLinkType
No description available
Type: MailElement
query
No description available
Type: Array<IQueryElement>
ITablePaneConfiguration
No description available
Properties: minimalFields, dataChangedCheck, cacheInitResponse, actions, foreignKeys, inheritFollowingSiblingsOnOutdent
minimalFields
Specifies the minimal set of fields that should be loaded for this pane.
Type: Array<FieldName>
dataChangedCheck
Specifies settings for a client-side data-changed check on this pane.
The data-changed check on the client side is performed when a container instance needs to be reestablished.
Type: Anonymous Object Type
excludedFields | Array<FieldName> |
cacheInitResponse
Specifies whether caching of init responses is allowed for this pane.
If set to true
, then init responses will be cached; when set to false
, they will not be cached. If not specified, the default behavior is to cache init responses.
Type: boolean
actions
Additional configuration for actions in this pane.
Any application action, such as "SubmitExpenseSheet", "ApproveAbsenceEntry", etc., may be configured here. It is also possible to configure the following standard actions:
- "create" - for saving new records,
- "update" - for saving existing records.
Type: IActionConfiguration
foreignKeys
Additional configuration for foreign-keys.
Type: ForeignKeyConfiguration
inheritFollowingSiblingsOnOutdent
Specifies how the table pane of this container reacts when records are outdented in a tree structure.
When a line is outdented in a tree table, the client immediately shows the line in its new position without waiting for a response from the backend. In order to do that, the client makes an assumption on how the outdent operation is going to be carried out in the table pane on the backend. However, container implementations can realize this in different ways, which can sometimes result in a temporary incorrect positioning of the lines.
This property acts as a hint to the client on how the backend is going to position and outdented line.
Setting this property to false
, or not specifying in at all, assumes that lines will be outdented as follows: it is moved to the same level as its parent, to a position immediately after the parent.
On the other hand, setting this property to true
will make the client assume the following behavior for an outdented line: it is moved to the same level as its parent, to a position immediately after the parent; moreover, any following lines that were siblings of the outdented line will become children of the outdented line.
Type: boolean
ITablePercentColumn
No description available
Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, format, validators, info, autoSubmit, source, search, widget, shadowTitle
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
color | Any of the following |
* <a href="#ifirstmatchselector<(&)>">IFirstMatchSelector<(&)></a>
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
width
No description available
Type: WidthType
suppress
A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.
Type: Expression
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
ITableProperties
Common table properties.
Properties: columnChooser
required
columnChooserBased on the expression you define if a column chooser should be visible on all tables.
Type: Expression
ITableRow
Represents a row containing a table/grid structure.
Properties: format, island, style, label, collapsible, pane, title, table
format
Assign formatting by data type
Type: TypeSpecificFormat
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
tableA grid of table columns and with header, body, and footer.
Type: ITable
ITableStatusColumn
No description available
Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, source, mask
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
color | Any of the following |
* <a href="#ifirstmatchselector<(&)>">IFirstMatchSelector<(&)></a>
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
width
No description available
Type: WidthType
suppress
A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.
Type: Expression
required
sourceThe underlying pane field that provides data for this status block.
Type: FieldName
required
maskA mask map a given internal status value to a title and css. In time sheets, you can for instance map the status character '1' to the title 'Due' and the color red.
Type: IStyledStatusIndication
ITableSwitch
No description available
Properties: visible, title, titleValue, titleSource, label, source
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceNo description available
Type: FieldName
ITableTextColumn
No description available
Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, info, template
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
color | Any of the following |
* <a href="#ifirstmatchselector<(&)>">IFirstMatchSelector<(&)></a>
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
width
No description available
Type: WidthType
suppress
A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.
Type: Expression
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
template
No description available
Type: LocalizableText
ITableUnitFieldColumn
No description available
Properties: style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, format, validators, info, autoSubmit, source, search, widget, shadowTitle, unit
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
color | Any of the following |
* <a href="#ifirstmatchselector<(&)>">IFirstMatchSelector<(&)></a>
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
width
No description available
Type: WidthType
suppress
A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.
Type: Expression
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
required
unitNo description available
Type: IUnitBlock
ITabsRow
Represents a group of tabs. Tabs are used to group layout columns such that only one column is shown at a time.
Properties: island, style, label, collapsible, pane, noTabsTitle, tabs
island
Provides a hint to the layout on whether this row or column should be shown as an island.
If this property is not specified, then it will be determined automatically.
Type: boolean
style
No description available
Type: Any of the following
{ }
Array with any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
collapsible
The collapsible property determines if this layout part can be collapsed. If set to true or with a configuration of the default state then the layout part will be rendered with a handle to allow collapse and expand behavior.
Default Value: false
Type: Any of the following
pane
The pane used to resolve unqualified references in this scope. If unspecified, the parent scope is inherited.
Type: PaneName
noTabsTitle
An optional text shown when the array of tabs is empty.
Type: LocalizableText
required
tabsAn array of tabs, each with a title, an optional badge, and contents.
Type: Array<ITab>
ITextElement
The text element consists of a template block.
Properties: style, info, label, template, appearance, rendering, title, titleValue, titleSource, mandatory, open, visible
style
No description available
Type: Any of the following
- Anonymous Object Type
extends | StyleName |
condition | Expression |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
extends | StyleName |
condition | Expression |
color | Any of the following |
* <a href="#ifirstmatchselector<(&&)>">IFirstMatchSelector<(&&)></a>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
template
No description available
Type: LocalizableText
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
ITimeDurationFormat
No description available
Properties: zeroSuppression, type
zeroSuppression
True if zero values should be suppressed.
Type: boolean
type
No description available
Type: real
ITimeFormat
No description available
Properties: useDropdownList, step
required
useDropdownListIndicates if the time-picker should use a dropdown list or the time-selector wheel. You specify <code>true</code> to use the dropdown-list or <code>false</code> to use the time-selector wheel.
You can also specify a number to indicate at which number of steps the time-picker should change behavior. Default is 96, calculate as (24 / 1) * (60 / 15).
Type: boolean,number
required
stepDefines the steps to use for the dropdown list or the time-selector wheel.
Type: Anonymous Object Type
hour | number |
minute | number |
ITriggers
Defines triggers that will be executed at specific pane events.
Properties: init
init
Specifies triggers to be executed when a new record is created in a pane.
Type: Array<TriggerType>
ITypeAheadConfiguration
No description available
Properties: enabled, maximumQueueLength
enabled
This flag enables type-ahead for all workspaces.
Default Value: true
Type: boolean
maximumQueueLength
The maximum number of operations that can be scheduled for execution.
Default Value: :
5``
Type: number
IUnaryRestriction
A restriction using any of the unary operators.
Properties: operator
required
operatorNo description available
Type: UnaryOperatorType
IUnitBlock
No description available
Properties: title, label, source, position
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
source
No description available
Type: FieldName
position
No description available
Type: UnitPositionType
IUnitFieldElement
The unit element represents a field element with a unit describing the data of the field.
Properties: style, format, validators, info, mandatory, open, autoSubmit, label, source, search, widget, shadowTitle, unit, appearance, rendering, title, titleValue, titleSource, visible
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
textAlign | TextAlignType |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
textAlign | TextAlignType |
color | Any of the following |
* <a href="#ifirstmatchselector<(&&)>">IFirstMatchSelector<(&&)></a>
format
Assign formatting based upon the data value
Type: ValueFormat
validators
No description available
Type: Array<IValidator>
info
A definition of an inline info-bubble or a reference to a reusable info-bubble.
Type: Any of the following
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
autoSubmit
Specifies that changes to this field should be automatically saved.
Type: boolean
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
required
sourceThe underlying pane field that provides data for this input block.
Type: FieldName
search
The configuration of the search capabilities available for this field.
If this property is not specified, then searching will be enabled for this field (provided that this field supports searching), and the standard search layout will be selected.
Default Value: true
Type: FieldSearchType
widget
The default widget representing an input can optionally be overriden here.
Type: WidgetType
shadowTitle
The shadow title might be shown in the input field if the field does not contain a value
Type: TemplateText
required
unitNo description available
Type: IUnitBlock
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
IUpdateAction
Saves changes to an existing record in the specified pane.
Properties: update
required
updateNo description available
Type: PaneName
IURLAuthenticationMethod
No description available
IUrlContainerParameter
Maps a field in a container to a URL parameter.
Properties: urlParameter
required
urlParameterNo description available
Type: string
IURLValue
No description available
Properties: value
required
valueNo description available
Type: Expression
IUsageTrackingConfiguration
No description available
Properties: enabled, endUserOptIn, trackingId, gainsight
required
enabledThis flag enables usage tracking for the entire installation.
Type: boolean
required
endUserOptInThis 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: boolean
trackingId
Google Analytics tracker ID can be provided here for custom tracking of usage.
Type: string
gainsight
This flag enables Gainsight PX usage tracking for the entire installation.
Default Value: false
Type: boolean
IValidator
A single element/column validator
Properties: title, type, icon, condition
required
titleAn mandatory, localizable title.
Type: LocalizableText
type
No description available
Type: string
icon
No description available
Type: string
condition
No description available
Type: Expression
IWizardInvocation
Specifies parameters for invoking a wizard.
Properties: pane, wizardWorkspace, arguments
required
paneThe host pane for the wizard. This pane can be accessed in the wizard workspace under the name "Host".
Type: PaneName
required
wizardWorkspaceNo description available
Type: IWizardWorkspace
arguments
The arguments to be passed to the wizard.
Type: ActionArgumentsType
IWizardInvocationAction
A wizard which is not invoked on a specific action.
Properties: wizard, visible, title, confirmation
required
wizardA wizard that will be shown when this action is clicked.
Type: IWizardInvocation
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
confirmation
Specifies whether a confirmation dialog should be shown before running this action.
If set to true
, then a confirmation dialog with a standard message will be shown. If set to a string, then a confirmation dialog with the given text (e.g. "Are you sure?") will be shown. If not specified or set to false
, then no confirmation dialog will be shown.
Type: boolean,string
IWizardInvocationWithOptionalPane
No description available
Properties: wizardWorkspace, pane
required
wizardWorkspaceNo description available
Type: IWizardWorkspace
pane
The host pane for the wizard. This pane can be accessed in the wizard workspace under the name "Host".
Type: PaneName
IWizardSize
No description available
width
The width of the wizard window. If not specified the medium size will be applied.
Type: string
required
heightThe height of the wizard window. If not specified the height will fit the content.
Type: max
IWizardWorkflow
No description available
Map from string
to IWorkflowState
IWizardWorkspace
Configuration of an individual wizard workspace.
A wizard workspace is similar to a regular workspace in that it has a name, a title and it exposes data though panes set up in the data-bindings part. However, as opposed to a regular workspace, this workspace leads the user through a number of steps (set up in the workflow part) and can display a different layout for each step (these are configured in the page-layouts part).
Properties: title, name, size, definitions, dataBindings, workflow, pageLayouts, sideEffects, cancel
required
titleAn mandatory, localizable title.
Type: LocalizableText
required
nameThe internal, unique, non-localizable name of the wizard workspace.
Type: WorkspaceName
size
The size of the wizard window. If not specified the medium size will be applied.
Type: WizardSize
definitions
Definitions of items that can be reused many times within this workspace.
Type: ILocalDefinitions
dataBindings
Configuration of the panes that compose this workspace and how these panes are bound together.
Type: Array<IBindingSpecification>
required
workflowConfiguration of the states in the wizard.
Type: IWizardWorkflow
required
pageLayoutsDefinition of the layouts for the pages in the wizard.
Type: IPageLayouts
sideEffects
Specifies if the wizard makes changes that affect the host workspace.
If not specified, then a wizard is assumed to have side effects (i.e. the default value is true
).
This field can be set to false
if a wizard is known to not make any changes to the data which is shown in the host workspace. Setting this field to false
has the following consequences:
- the host workspace will not be refreshed when the wizard is closed,
- the wizard can be invoked even if the host workspace has unsaved changes.
Type: boolean
cancel
Specifies the behavior for cancelling the wizard. This setting provides a default value that can be overriden in each workflow state.
Type: ICancelTransition
IWorkflowState
A single state (or step) within the wizard workflow.
Properties: title, pageLayout, transitions
title
The title of this state. If not specified, the title from the page layout or the wizard title will be used.
Type: string
required
pageLayoutThe page to show when this state is active.
Type: PageName
transitions
No description available
Type: Anonymous Object Type
enter | Array<EnterTransitionActionType> |
exit | Array<IExitTransition> |
cancel | ICancelTransition |
IWorkspaceItem
A representation of a single menu item which opens a workspace.
Properties: visible, workspace
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
workspaceReference to the internal name of a workspace.
Type: WorkspaceName
IWorkspaceLayout
Represents the layout for the entire workspace area.
Properties: heading, rendering, list, record, rows, actionBar, assistants
heading
The heading area should communicate the overall purpose of this workspace and facilitate navigation between instances of the main data entity. Often a 'create' action will also be available for the main data entity. If the heading is not specified, a default showing the workspace title will be used.
Type: IHeading
rendering
The default rendering of a workspace is 'presentation'. If a rendering is specified for the entire layout using this property then the rendering will be fixed to that mode. This is primarily used to force a layout to always be render in editable mode.
Type: IRendering
list
Controls whether the workspace should show a "list view", and optionally defines a layout for the list view.
This property can contain one of the three possible values: 1. A list view layout. 2. The value true
indicating that a list view layout should be autogenerated. 3. The value false
indicating that no list view should be shown in this workspace.
Additionally, as part of options (1) and (2) above, it is possible to control whether the workspace should open in list view mode by default. This is achieved through a boolean property openInListMode
which can be specified in two ways: 1. As part of the list view layout. 2. As part of an object, e.g. { "openInListMode": true }
, instead of the value true
.
If openInListMode
is not specified, then it will be derived from the global settings for all workspaces.
If this property is not specified, then it defaults to true
.
Default Value: true
Type: ListViewType
record
The record heading area should communicate the overall data entity of the workspace. This should contain the primary identifier of the currently shown data entity.
Type: IRecordHeading
required
rowsThe main body of a workspace layout consists of an array of layout rows.
Type: Array<ExtendedRowType>
actionBar
The actions to be shown in this action row.
Type: IActionsRow
assistants
Assistants that can be used multiple times across the same workspace.
Type: IAssistantRegistry
IZipCityElement
No description available
Properties: appearance, rendering, title, titleValue, titleSource, label, mandatory, open, visible, zip, city, zipFirst
appearance
An optional property which determines which parts of an element are displayed
Default Value: normal
Type: AppearanceType
rendering
Specifies the rendering state for this part of the layout.
If not specified, then the rendering state inherited from the parent will be used.
Type: IRendering
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
required
zipNo description available
Type: Any of the following
required
cityNo description available
Type: Any of the following
zipFirst
No description available
Type: boolean
KpiValueType
No description available
Any of the following
LanguageConfiguration
No description available
required
preferredA locale string or an object with language and region properties. The locale should consist of a language code and a region code separated by an underscore, e.g., 'en_US'.
Default Value: en_US
Type: Locale
required
fixedTrue if the language is fixed and cannot be changed by the end-user. This removes the language selector from the both login screen and settings dialog.
Type: boolean
LayoutName
String alias for a layout name.
LevelName
A name of a report level in an Analyzer report.
LimitedInfoBubble
No description available
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
textThe text or texts to be displayed in the info-bubble
Type: Any of the following
- TemplateText
- Array<TemplateText>
link
An optional link to be displayed in the info-bubble
Type: Anonymous Object Type
template | LocalizableText |
url | URLElement |
query | Array<IQueryElement> |
icon | string |
workspace | WorkspaceLinkType |
LinkFormElementType
No description available
Properties: link
required
linkNo description available
Type: ILinkElement
LinkTableColumnType
No description available
Properties: link
required
linkNo description available
Type: ITableLinkColumn
LinkTargetType
No description available
ListViewType
A type for defining a "list view" for a workspace. It specifies whether a workspace should have a list view, defines the layout for the list view, and whether the workspace should open in list view mode by default.
The following values can be specified for this type: 1. A list view layout. 2. A list view layout with the openInListMode
property. 3. The value true
indicating that a list view layout should be autogenerated. 4. An object with the openInListMode
property, indicating that a list view layout should be autogenerated and overriding the global value of openInListMode
. 5. The value false
indicating that no list view should be shown in this workspace.
The openInListMode
property mentioned above holds a boolean value indicating whether the workspace should open in list view mode by default. If not specified, then it will be derived from the global setting for all workspaces.
Any of the following
- Anonymous Object Type
openInListMode | BooleanValue |
style | Any of the following
|
pane | PaneName |
columns | Array<TableColumnType> |
actions | Array<TableActionType> |
columnChooser | ColumnChooser |
- IListView
- IOpenInListMode
- boolean
LocalCurrencyDisplayType
No description available
Locale
A locale string or an object with language and region properties. The locale should consist of a language code and a region code separated by an underscore, e.g., 'en_US'.
Any of the following
- string
- Anonymous Object Type
language | string |
region | string |
LocalizableText
String alias for localizable, end-user visible, static titles.
MailElement
No description available
Any of the following
NavigationType
No description available
Any of the following
NonConditionalRow
No description available
Any of the following
- IElementRow
- ILayoutRow
- ITableRow
- ITabsRow
- IGridRow
- IDocumentRow
- IConversationRow
- IEmbeddedRow
- ISchedulerRow
- IAlertRow
NotificationTypes
No description available
Map from string
to INotificationType
PageName
String alias for internal references to wizard pages.
PagingBufferSizeType
Specifes the paging buffer in terms of a number of records or a number of pages.
Any of the following
- Anonymous Object Type
records | number |
- Anonymous Object Type
pages | number |
PairFormElementType
No description available
Properties: pair
required
pairNo description available
Type: IPairElement
Palette
No description available
Any of the following
PaletteItem
No description available
Any of the following
PaletteName
The name of an entire palette
PaneName
String alias for pane names.
PercentFormElementType
No description available
Properties: percent
required
percentNo description available
Type: IPercentElement
PercentTableColumnType
No description available
Properties: percent
required
percentNo description available
Type: ITablePercentColumn
PlatformConfiguration
The Platform represents all the supporting features of the web client. This includes language setup, supplemental definitions for containers exposed by the REST API etc. In other words, all the parts that are not directly contained in the Shell or the Workspace area.
Properties: usageTracking, containers, typeAhead, longRunning, paging, language, enums, dataExport
required
usageTrackingNo description available
Type: IUsageTrackingConfiguration
required
containersAdditional configuration for containers on a Maconomy installation.
Type: Containers
typeAhead
Configuration of the type-ahead functionality.
Type: ITypeAheadConfiguration
required
longRunningConfiguration of the long-running operations functionality.
Type: ILongRunningOperations
required
pagingConfiguration of the paging functionality.
Type: IGlobalPagingConfiguration
required
languageThe language configuration determines default language and whether the end-user can change language.
Type: LanguageConfiguration
enums
Configuration of enumerations.
Type: IEnumerationConfiguration
dataExport
Configuration of export
Type: IDataExportConfiguration
QualifiedPaletteItemName
A reference to a palette item, e.g., "palette1.item2"
QueryValueExpression
No description available
Properties: value
required
valueNo description available
Type: Expression
QueryValueType
No description available
Any of the following
RadioFormElementType
No description available
Properties: radio
required
radioNo description available
Type: IRadioElement
ReferenceFormElementType
No description available
Properties: reference
required
referenceNo description available
Type: IReferenceElement
ReferencePoint
No description available
ReportLevelType
No description available
Any of the following
RestrictionType
No description available
Any of the following
ReusableInfoBubbleRegistry
No description available
Map from string
to IReusableInfoBubbleDefinition
RowType
No description available
Any of the following
SchedulerSlotDivision
No description available
One of: 15
, 30
, 60
SchedulerViewType
No description available
SearchResultAmountField
Represents a search result field that includes an amount with a specified currency.
Properties: appearance, title, titleValue, titleSource, source, currency
appearance
An optional property which determines which parts of a field element are displayed
Default Value: 'normal' for field specification types of 'amount', 'time', 'timeduration', 'boolean', 'date', 'integer', 'real'.
Default Value: 'maximized' for all other field specification types.
Type: AppearanceType
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
required
sourceThe underlying pane field that provides data for this search.
Type: FieldName
required
currencyThe currency associated with the amount field.
Type: FieldName
SearchResultAmountFieldType
No description available
Properties: amount
required
amountNo description available
Type: SearchResultAmountField
SearchResultField
Represents a search result field.
Properties: appearance, title, titleValue, titleSource, source
appearance
An optional property which determines which parts of a field element are displayed
Default Value: 'normal' for field specification types of 'amount', 'time', 'timeduration', 'boolean', 'date', 'integer', 'real'.
Default Value: 'maximized' for all other field specification types.
Type: AppearanceType
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
required
sourceThe underlying pane field that provides data for this search.
Type: FieldName
SearchResultFieldType
No description available
Any of the following
- Anonymous Object Type
field | SearchResultField |
SearchResultPercentField
Represents a search result field with a hardcoded percent unit.
Properties: appearance, title, titleValue, titleSource, source
appearance
An optional property which determines which parts of a field element are displayed
Default Value: 'normal' for field specification types of 'amount', 'time', 'timeduration', 'boolean', 'date', 'integer', 'real'.
Default Value: 'maximized' for all other field specification types.
Type: AppearanceType
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
required
sourceThe underlying pane field that provides data for this search.
Type: FieldName
SearchResultPercentFieldType
No description available
Properties: percent
required
percentNo description available
Type: SearchResultPercentField
SearchResultReference
The search result reference represents a foreign key used for search results. It consists of a title block and a description/key pair.
The source of the reference can be specified in the following ways: 1. Using the foreignKey
attribute. In this case, the fields for the description/key pair are determined automatically from the foreign-key. 2. Using the key
and description
attributes. This approach should be used if no foreign-key is available for the required fields. 3. Using the foreignKey
attribute together with the key
and/or description
attributes. This method should be used if the fields determined automatically from the foreign-key are not correct in this context.
Any of the following
SearchResultReferenceType
No description available
Properties: reference
required
referenceNo description available
Type: SearchResultReference
SearchResultReferenceWithFields
Represents a search result reference if no foreign key is available.
Properties: appearance, title, titleValue, titleSource, description, key
appearance
An optional property which determines which parts of a field element are displayed
Default Value: 'normal' for field specification types of 'amount', 'time', 'timeduration', 'boolean', 'date', 'integer', 'real'.
Default Value: 'maximized' for all other field specification types.
Type: AppearanceType
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
required
descriptionThe description field of the search result.
Type: FieldName
required
keyThe key field of the search result.
Type: FieldName
SearchResultReferenceWithForeignKey
Represents a search result reference that includes a foreign key.
Properties: appearance, title, titleValue, titleSource, description, key, foreignKey
appearance
An optional property which determines which parts of a field element are displayed
Default Value: 'normal' for field specification types of 'amount', 'time', 'timeduration', 'boolean', 'date', 'integer', 'real'.
Default Value: 'maximized' for all other field specification types.
Type: AppearanceType
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
description
An optional description field for the search result.
Type: FieldName
key
An optional key field for the search result.
Type: FieldName
required
foreignKeyThe foreign key associated with the search result.
Type: ForeignKeyName
SearchResultType
Represents the type of field that can be inserted into a search result.
Any of the following
- SearchResultFieldType
- SearchResultReferenceType
- SearchResultUnitFieldType
- SearchResultAmountFieldType
- SearchResultPercentFieldType
SearchResultUnitField
Represents a search result field that includes a unit describing the data of the field.
Properties: appearance, title, titleValue, titleSource, source, unit
appearance
An optional property which determines which parts of a field element are displayed
Default Value: 'normal' for field specification types of 'amount', 'time', 'timeduration', 'boolean', 'date', 'integer', 'real'.
Default Value: 'maximized' for all other field specification types.
Type: AppearanceType
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
required
sourceThe underlying pane field that provides data for this search.
Type: FieldName
required
unitThe unit block associated with the search result field.
Contains the source field name and the position of the unit block.
Type: IUnitBlock
SearchResultUnitFieldType
No description available
Properties: unitField
required
unitFieldNo description available
Type: SearchResultUnitField
ShellConfiguration
The application shell represents the frame around the workspace area. It facilitates configuration of key components such as the menu, documentation links, notifications overview, conversations, report runs as well as auxiliary features like settings, change password and about information.
Properties: menu, documentationUrl, documentation, settings, notifications, conversations, analyzer, avatar
required
menuNo description available
Type: IMenu
documentationUrl
No description available
Type: string
documentation
An optional property for displaying useful links, such as hosted help, as a dropdown
Type: IDocumentationConfiguration
required
settingsNo description available
Type: ISettings
required
notificationsNo description available
Type: INotificationConfiguration
required
conversationsNo description available
Type: IConversationConfiguration
required
analyzerNo description available
Type: IAnalyzerConfiguration
avatar
An optional avatar that will be shown in the top right corner of the navigation bar.
Type: Image
SolidGaugeSize
Preset size values of the solid gauge chart
One of: 100
, 150
, 190
SplitterOptions
A configuration determining the appearance and behavior of a splitter.
Properties: resizable, collapsible
resizable
Controls whether the splitter can resize the layout components that it splits.
Default Value: true
Type: BooleanValue
collapsible
Controls whether the splitter can collapse and thereby hide the last of the layout components that it splits.
Default Value: false
Type: BooleanValue
StateName
No description available
StatusFormElementType
No description available
Properties: status
required
statusNo description available
Type: IStatusElement
StatusTableColumnType
No description available
Properties: status
required
statusNo description available
Type: ITableStatusColumn
StyleName
**************** New Style API *****************
StyleRegistry
No description available
Map from string
to AnyStyle
SumLineColumn
No description available
Any of the following
TableActionColumnType
No description available
Properties: exportable, style, title, titleValue, titleSource, label, alt, mandatory, open, visible, width, suppress, template, icon
exportable
No description available
Default Value: false
Type: boolean
style
No description available
Type: Any of the following
- Anonymous Object Type
condition | Expression |
color | Any of the following |
Array with any of the following
- Anonymous Object Type
- Anonymous Object Type
condition | Expression |
color | Any of the following |
* <a href="#ifirstmatchselector<(&)>">IFirstMatchSelector<(&)></a>
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
titleValue
An optional title derived from the value of a field.
Type: FieldName
titleSource
An optional title derived from the specification title of another field.
Type: FieldName
label
A Name or Identifier to give this component. This may be used when the HTML is generated, when hyperlinks are generated as well as other processes such automated testing. Please use a value that is completely unique and one which will not require changing at a later date. Doing so may break existing older functionality which relies on the original value you use. Values must not begin with 'dm-' since ths is reserved for internal use.
Type: string
alt
An optional, alternative localizable title. If unspecified, a title will be provided.
Type: LocalizableText
mandatory
A predicate determining whether fields in this part of the layout part are shown as mandatory.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
open
A predicate determining whether fields in this part of the layout part are shown as open.
If not specified, then the predicate inherited from the parent will be used.
Type: Expression
visible
A visibility predicate determining whether this layout part is shown.
Default Value: true
Type: Expression
width
No description available
Type: WidthType
suppress
A condition specifying when this table cell should be suppressed. If not specified, the table cell will be shown.
Type: Expression
template
No description available
Type: LocalizableText
icon
No description available
Type: string
TableActionType
Represents the elements in the list of table actions.
Any of the following
TableColumnType
No description available
Any of the following
- FieldTableColumnType
- LinkTableColumnType
- ActionTableColumnType
- TextTableColumnType
- UnitFieldTableColumnType
- AmountTableColumnType
- PercentTableColumnType
- FileSizeTableColumnType
- StatusTableColumnType
TableHeightType
No description available
Any of the following
- number
minimal
TableSwitchType
No description available
Any of the following
Array with any of the following
TemplateExpression
No description available
Properties: template
required
templateNo description available
Type: TemplateText
TemplateText
String alias for localizable, end-user visible titles that may contain expression placeholders.
TertiaryRestrictionType
A restriction using any of the tertiary operators.
Properties: operator, start, end
required
operatorNo description available
Type: between
required
startNo description available
Type: Expression
required
endNo description available
Type: Expression
TextAlignType
No description available
TextFormElementType
No description available
Properties: text
required
textNo description available
Type: ITextElement
TextTableColumnType
No description available
Properties: text
required
textNo description available
Type: ITableTextColumn
TitleArrayItemType
String alias for field source/model names.
TitleArrayType
No description available
Array<TitleArrayItemType>
TitleElementType
No description available
Any of the following
- FieldFormElementType
- IntervalFormElementType
- ReferenceFormElementType
- UnitFieldFormElementType
- AmountFormElementType
TitleType
No description available
Any of the following
TriggerType
A trigger that assigns a value to a field.
Properties: assign
required
assignNo description available
Type: Anonymous Object Type
field | FieldName |
value | Expression |
TypeSpecificFormat
No description available
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: IAmountFormat
autotimestamp
No description available
Type: IAutoTimestampFormat
boolean
No description available
Type: IBooleanFormat
date
No description available
Type: IDateFormat
enum
No description available
Type: IEnumFormat
integer
No description available
Type: IIntegerFormat
real
No description available
Type: IRealFormat
string
No description available
Type: IStringFormat
time
No description available
Type: ITimeFormat
timeduration
No description available
Type: ITimeDurationFormat
pp:color
No description available
Type: IPeoplePlannerColorFormat
pp:datetime
No description available
Type: IPeoplePlannerDateTimeFormat
pp:double
No description available
Type: IPeoplePlannerDoubleFormat
pp:float
No description available
Type: IPeoplePlannerFloatFormat
pp:guid
No description available
Type: IPeoplePlannerGuidFormat
pp:integer
No description available
Type: IPeoplePlannerIntegerFormat
pp:string
No description available
Type: IPeoplePlannerStringFormat
UnaryOperatorType
No description available
UnitFieldFormElementType
No description available
Properties: unitField
required
unitFieldNo description available
Type: IUnitFieldElement
UnitFieldTableColumnType
No description available
Properties: unitField
required
unitFieldNo description available
Type: ITableUnitFieldColumn
UnitPositionType
No description available
URLElement
No description available
Any of the following
ValueExpression
No description available
Properties: value
required
valueNo description available
Type: Expression
ValueFormat
No description available
Any of the following
- IAmountFormat
- IAutoTimestampFormat
- IBooleanFormat
- IDateFormat
- IEnumFormat
- IIntegerFormat
- IRealFormat
- IStringFormat
- ITimeFormat
- ITimeDurationFormat
- IPeoplePlannerColorFormat
- IPeoplePlannerDateTimeFormat
- IPeoplePlannerDoubleFormat
- IPeoplePlannerFloatFormat
- IPeoplePlannerGuidFormat
- IPeoplePlannerIntegerFormat
- IPeoplePlannerStringFormat
VerticalAlignType
No description available
WidgetType
No description available
WidthType
No description available
WizardSize
No description available
Any of the following
- string
- IWizardSize
Workspace
Configuration of an individual workspace. A workspace is defined by a unique name and a recognizable title. The data exposed by the workspace is set up in the data-bindings part, and the appearance of that data is defined by its layout.
Properties: title, name, proxyFor, state, definitions, dataBindings, layout
title
An optional, localizable title. If unspecified, a default title will be provided.
Type: LocalizableText
required
nameThe internal, unique, non-localizable name of the workspace.
Type: WorkspaceName
proxyFor
A workspace can act as a proxy for another workspace. If for instance the "MaconomyLongText_DailyTimeSheets" workspace specifies that it is a proxy for the "DailyTimeSheets" workspace then all links to "DailyTimeSheets" will be redirected to "MaconomyLongText_DailyTimeSheets".
Type: WorkspaceName
state
Optional marker to indicate if the workspace is in beta or test.
Type: WorkspaceState
definitions
Definitions of items that can be reused many times within this workspace.
Type: ILocalDefinitions
required
dataBindingsConfiguration of the panes that compose this workspace and how these panes are bound together.
Type: IDataBindings
required
layoutConfiguration of the layout of data and actions associated with this workspace.
Type: IWorkspaceLayout
WorkspaceConfiguration
Workspaces host the core logic of the web client. They represent workflows against particular parts of the Maconomy system and data. A workspace is consists of two main parts: data bindings and a layout.
Properties: workspaces, definitions
required
workspacesAn ordered collection of workspaces
Type: Array<WorkspaceConfigurationItem>
required
definitionsGlobal definitions contain pre-defined colors and other referrable items that span all workspaces. These definitions are used both for convenience and as a way of ensuring a uniform look and feel across all workspaces.
Type: IGlobalDefinitions
WorkspaceConfigurationItem
No description available
Any of the following
WorkspaceGroup
A workspace group contains an ordered collection of workspaces.
Properties: workspaces
required
workspacesAn ordered collection of workspaces
Type: Array<WorkspaceConfigurationItem>
WorkspaceLinkType
No description available
Any of the following
- WorkspaceName
- Anonymous Object Type
name | WorkspaceName |
target | LinkTargetType |
WorkspaceName
String alias for internal references to workspaces.
WorkspaceState
The state of a workspace can be used to indicate how production-ready it is.
ZeroThroughTen
No description available
One of: 0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
ZipCityFormElementType
No description available
Properties: zipCity
required
zipCityNo description available
Type: IZipCityElement