Skip to content

Client Control Properties List

Properties are used to change the behavior and the look and feel of the control. Below are a list of properties used by the IFS Cloud Web client controls.

activestage

Displays the state of the stages in Process Viewer.

Type: String

Valid Values: Valid string value or string variable.

Default Values: None

Used in: Process Viewer

Example

activestage = "${SelectedStage}";  

advancedview

Free text field/LOV

Displays an expanded view of the List of Values.

Type: List Reference.

Valid Values: List Reference.

Default Values: None

Used in: Free Text, List of Values

Example

advancedview LineProgramLovList;  

allday

Determines if the calendar item spans the entire day. If the given expression evaluates true the time aspect of the calendar items will be ignored and the event will fill up the whole day/days of the given dates

Type: Boolean or expression returning a boolean value

Valid Values: * Boolean: [true] | [false] * Expression: A valid expression returning a boolean value.

Default Values: false

Used in: Calendar

Example

//Boolean   
allday = [false];   
//Expression   
allday = [Employee = "Damon"];  

alldaylabel

The alldaylabel property is used to add a custom label to the allday slot of the view. Different allday labels can be defined for each view.

Type: String

Valid Values: Valid string value or string variable.

Default Values: None

Used in: Calendar

Example

//Adding an allday label for WorkWeek view  
view WorkWeek { alldaylabel = "Whole day"; }  

autorestart

Specifies if the assistant should automatically restart once it is finished.

Type: Boolean or an expression returning a boolean

Values: * Boolean: [true] | [false] * Expression: A valid flag condition (Refer example)

Default Values: None

Used in: Assistant

Example

//Boolean  
autorestart = [true];  
//Expression  
autorestart = [Attribute != null];  

availableitemslabel

Title of the available items list box in Item picker.

Type: String

Values: Valid string value or string variable.

Default Values: None

Used in: Item Picker

Example

availableitemslabel = "Available Languages";  

basedate

Opens a date picker control at a specific position based on another date value.

Type: DataItemReference

Values: Any data item that is of type DATE.

Default Values: None

Used in: Field

Example

basedate = ValidFrom;  

boxcolor

Used to add color to the boxes of the box-matrix. Attributes which maintains colors could be provided to this property. The respective color would be used to set the border top color of each box. The colors could be maintained in the attribute using a color picker.

Type: DataItemReference

Values: Attribute Name

Default Values: None

Used in: Box-matrix

Example

boxcolor ColorCategory;  

boximage

Displays image data of type text, longtext, binary provided the entity connected to the box-matrix contains an image attribute. The image will be shown in the matrix inline with each item. A circle would be drawn for each item. In cases where an image is not present a color would be assigned. If the need is to set custom colors, the emphasis property could be provided within the boximage block.

Type: String

Values: Attribute Name

Default Values: None

Used in: Box-matrix

Example

//Assign an image   
boximage EmployeeImage;    
//Assign colors   
boximage {   
   emphasis Complementary2 = [SomeField = true] }   
//Assign image and color   
boximage EmployeeImage {   
   emphasis Complementary2 = [SomeField = 100]; }`  

boxtitle

The title for each box in the box-matrix.

Type: DataItemReference

Values: Attribute name.

Default Values: None

Used in: Box-matrix

Example

boxtitle CareerAdvancementLevel;  

boxvalue

The value that is going to be displayed for each item in the box-matrix.

Type: DataItemReference

Values: Attribute Name.

Default Values: None

Used in: Box-matrix

Example

boxvalue FirstName;  

card

Description: The card property is used to set a reference of a card, to a another control such as a node of a Tree-Diagram or Calendar. When this property is set, you can click on the relevant icon or link to view detailed information.

Type: CardReference

Values: Name of the card.

Default Values: None

Used in: Calendar, Tree-Diagram

Example

card AbsenceCard;  

centerlabel

Description: Centerlabel is used to show the sum of all the values in funnel chart value field.

Type: Boolean

Values: true | false.

Default Values: false

Used in: Funnel Chart, Pie Chart

Example

centerlabel = [true];  

collapsed

Description: Determines if the applicable control is collapsed or expanded when displayed to the user.

Type: Boolean

Values: true | false.

Default Values: false

Used in: Bar Chart, Funnel Chart, Line Chart, List, Pie Chart, Timeline, Tree-Diagram

Example

collapsed = [true];  

columnexclude

Description: Determines if a column is excluded or not. Note! This property only applies to fields defined inside List.

Type: Boolean

Values: true | false.

Default Values: false

Used in: All types of fields inside lists

Example

columnexclude = true;  

columnvisible

Description: Determine if the column is visible or not. Note: This property only applies to fields defined inside Lists.

Type: Boolean

Values: true | false

Default Values: true

Used in: All types of fields inside lists

Example

columnvisible = false;  

compactmode

Description: This attribute is used to switch between the two display modes which are available within the item picker. In the compact mode, it will only show the selected items list but when you click on that list, a dialog box which contains the full control will be opened.

Type: Boolean

Values: true | false

Default Values: false

Used in: Item Picker

Example

compactmode = [true];  

completed

Description: Specifies the percentage of completion of the state.

Type: Percentage

Values: 0-100%

Default Values: 0%

Used in: State Indicator

Example

completed = 50%`;  

connections

Description: Defines child nodes of the current node in the Tree control. If this attribute is not defined, the current node will be a leaf node.

Type: Object

Values: Child node references and data sources

Default Values: None

Used in: Tree

Example

connections{  
    node ActivityObjectMaterialNode(ActvityMaterialObjectArray);  
    node ActivityObjectInstallationNode(ActvityExecutionObjectArray);  
    node ActivityObjectTaskNode(ActvityTaskObjectArray);  
    node ActivityObjectNode(ActivityObjectArray);  
}  

copyoncruddefault

Description: Specifies the key mapping to copy values from the parent to the list record when creating a new record in the list.

copyoncruddefault(<parent key attributes>) to(<list key attributes>);`  

Type: Keymapping

Values: Valid attributes

Default Values: None

Used in: List

Example

copyoncruddefault(UseCorrectionRows, parent.computed.RowGroupIdValue) to(Correction, RowGroupId);  

count

Description: Shows the count of records in each box of the box-matrix.
User could click on it and go to the �ListView� of the list control which would have a filter applied inline to that box.

Type: Boolean

Values: true | false

Default Values: false

Used in: Box-matrix

Example

count = [true];  

crosshairs

Description: Determines the visibility of the cross hairs on a chart.

Type: Boolean

Values: true | false

Default Values: true

Used in: Bar Chart, Line Chart

Example

crosshairs = [false];  

customdaterange

Description: This property is used add a custom date range to calendar control. Once this is added user can edit the change the date range of the calendar. This property is only supported in TimelineMonth view.

Type: Boolean

Values: true | false

Default Values: false

Used in: Calendar

Example

view TimelineMonth {  
   customdaterange = [true]; }  

date

Description: Defines which attribute should be used to order the timeline.

Type: Date, Timestamp, Time

Values: Attribute of type Date or Time.

Default Values: None

Used in: Timeline

Example

date = BirthDate;  

defaults

DescriptionUsed to define the function reference that is used to fetch the default values to the search context
TypeFunctionReference
ValuesFunctionReference
Used inSearch Context
Exampledefaults = GetPageSearchContextDefaults();

defaultsearchfields

DescriptionUsed to specify the search fields to be shown up front in the search panel
TypeDataItemReference
ValuesComma separated DataItemReferences
DefaultNone
Exampledefaultsearchfields = Country, Points;

page

DescriptionTell the framework which fields are most suitable to show up front in the search panel
TypeDataItemReference
ValuesComma separated DataItemReference
Exampledefaultsearchfields = Country, Points;

defaulttoprevious

DescriptionDetermines if the value in the field should be saved in the user profile.
TypeBoolean
Values
Constants
Default
Used inField
Example

Free text field/LOV

| Description |Specifies whether to save the value from the LOV in the user profile or not.| | Type |Boolean or Expression returning a boolean value| | Values |Boolean - true | false defaulttoprevious = [true]; defaulttoprevious = [];| |||

Radio button

DescriptionSpecifies whether to save the value from the radio buttons (radio group) in the user profile or not.
TypeBoolean or Expression returning a boolean value
ValuesBoolean - true
Defaulttrue
ExampleBoolean
defaulttoprevious = [true];

description

Free text field/LOV

Description
Type
Values
Default
Example

details

List

DescriptionThe details property is used to set the reference for a Detail page. When this property is set there will be a button appearing on the list called Details which can be used to navigate to the details of selected record(s).
The detail page can be located within the client file, a different different client file, or it could be an external webpage.
TypePage Reference
Values<PageName>(arguments) - The arguments are the primary and foreign keys needed to query the record.

<PageName>(url + odata filter) - The external URL can be a different webpage or a details page in a different client file.
DefaultNone
ExamplePage with argument -

details = ActivityDetails("ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]");
details = "page/ActivityClient/ActivityDetailsPage?$filter=ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]";
DescriptionThe details property is used to set the reference for a Detail page. When this property is set there will be a button appearing on the list called Details which can be used to navigate to the details of selected record(s).
The detail page can be located within the client file, a different different client file, or it could be an external webpage.
TypePage Reference
Values<PageName>(arguments) - The arguments are the primary and foreign keys needed to query the record.

<PageName>(url + odata filter) - The external URL can be a different webpage or a details page in a different client file.
DefaultNone
Used inList
ExamplePage with argument -

details = ActivityDetails("ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]");
details = "page/ActivityClient/ActivityDetailsPage?$filter=ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]";

Bar chart

DescriptionThe details property is used to set the reference for a Detail page. When this property is set, by clicking on a bar chart slice will navigate to the details of corresponding bar chart area.
The detail page can be located within the client file, a different different client file, or it could be an external webpage.
TypePage Reference
Values<PageName>(arguments) - The arguments are the primary and foreign keys needed to query the record.

<PageName>(url + odata filter) - The external URL can be a different webpage or a details page in a different client file.
DefaultNone
ExamplePage with argument -

details = ActivityDetails("ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]");
details = "page/ActivityClient/ActivityDetailsPage?$filter=ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]";

Free text field/LOV

DescriptionThe details property is used to set the reference for a Detail page. When this property is set there will be a button appearing on the LOV called Details which can be used to navigate to the details of selected record(s).
TypePage Reference
ValuesPageName (arguments) - the arguments are the primary and foreign keys needed to query the record.
DefaultNone
Exampledetails = DemoDetailPage(FirstKeyAttribute, SecondKeyAttribute);

Funnel chart

DescriptionThe details property is used to set the reference for a Detail page. When this property is set, by clicking on a funnel chart slice will navigate to the details of corresponding funnel chart area.
The detail page can be located within the client file, a different different client file, or it could be an external webpage.
TypePage Reference
Values<PageName>(arguments) - The arguments are the primary and foreign keys needed to query the record.

<PageName>(url + odata filter) - The external URL can be a different webpage or a details page in a different client file.
DefaultNone
ExamplePage with argument -

details = ActivityDetails("ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]");
details = "page/ActivityClient/ActivityDetailsPage?$filter=ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]";

Line chart

DescriptionThe details property is used to set the reference for a Detail page. When this property is set, by clicking on a line chart slice will navigate to the details of corresponding line chart area.
The detail page can be located within the client file, a different different client file, or it could be an external webpage.
TypePage Reference
Values<PageName>(arguments) - The arguments are the primary and foreign keys needed to query the record.

<PageName>(url + odata filter) - The external URL can be a different webpage or a details page in a different client file.
DefaultNone
ExamplePage with argument -

details = ActivityDetails("ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]");
details = "page/ActivityClient/ActivityDetailsPage?$filter=ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]";

Timeline

DescriptionThe details property is used to set the reference for a Detail page. When this property is set there will be a button appearing on the timeline called Details which can be used to navigate to the details of selected record(s).
The detail page can be located within the client file, a different different client file, or it could be an external webpage.
TypePage Reference
Values<PageName>(arguments) - The arguments are the primary and foreign keys needed to query the record.

<PageName>(url + odata filter) - The external URL can be a different webpage or a details page in a different client file.
DefaultNone
ExamplePage with argument -

details = ActivityDetails("ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]");
details = "page/ActivityClient/ActivityDetailsPage?$filter=ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]";

Tree diagram

DescriptionThe details property is used to set the reference for a Detail page. When this property is set there will be an icon appearing on the node which can be used to navigate to the details of clicked node/record.
The detail page can be located within the client file, a different different client file, or it could be an external webpage.
TypePage Reference
Values<PageName>(arguments) - The arguments are the primary and foreign keys needed to query the record.

<PageName>(url + odata filter) - The external URL can be a different webpage or a details page in a different client file.
DefaultNone
LookTree Diagram Control - Details Icon
ExamplePage with argument -

details = BusinessUnit("BusinessUnitId eq $[BusinessUnitId] and BusinessUnitType eq $[BusinessUnitType]");
details = "page/BusinessUnitClient/BusinessUnitDiagramPage?$filter=BusinessUnitId eq $[BusinessUnitId] and BusinessUnitType eq $[BusinessUnitType]";

Pie Chart

details

DescriptionThe details property is used to set the reference for a Detail page. When this property is set, by clicking on a pie chart slice will navigate to the details of corresponding pie chart area.
The detail page can be located within the client file, a different different client file, or it could be an external webpage.
TypePage Reference
Values<PageName>(arguments) - The arguments are the primary and foreign keys needed to query the record.

<PageName>(url + odata filter) - The external URL can be a different webpage or a details page in a different client file.
DefaultNone
ExamplePage with argument -

details = ActivityDetails("ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]");
details = "page/ActivityClient/ActivityDetailsPage?$filter=ActivityNo eq $[SrcActivityNo] and ActivityType eq $[SrcActivityType]";

defaultemphasis

DescriptionSpecifies the default color that should be displayed when the color picker is rendered for a new record. The value must be a color picker color constant.
TypeBoolean
Valuestrue
ConstantsColorpicker0 - Colorpicker18
DefaultColorpicker0 = [true]
Used inColor Picker
Exampledefaultemphasis Colorpicker4 = [true];

defaultfilter

DescriptionDetermines the default filtering condition that should be applied to the data source of the list.
TypeExpression - Query Condition (see example below)
ValuesQuery Condition
DefaultNone
Used inList
Exampledefaultfilter = [Company = �10�];

page | | | |----------------|:---------------| | Description | Default client side filter | | Type | Expression returning a boolean value | | Example | defaultfilter = [Objstate = "Released"]; | |||

description

Assistant Steps

DescriptionA block of text displayed under the step indicator typically describing the specific step.
TypeString
ValuesString or variable containing a string
Exampledescription = "This is the description for step ${Attribute}";

Box-matrix

DescriptionCan be used to display a title on the top left corner of the box-matrix. The number of loaded records and total number of records can be accessible through special keywords listed below ( Note: These are case sensitive):
${totalCount} - Number of total records
TypeString
ValuesString
Default${shownCount} of ${totalCount} Records
ExampleDescription with text only - description = "This is a title";
Description with a keywords - description = "Displaying ${shownCount} of ${totalCount} employee";

display

DescriptionDetermines if a (child) list that is bound to another (parent) list using the bind keyword should be displayed as a stand alone component or nested within the parent list.

Nesting lists is supported where the parent list is placed directly on the page or placed in a tab. Other combinations, like nesting lists in assistants, in arrange context or nesting a child list that lies within a tab into a parent list is not supported.
TypeConstant
ValuesNested - The child list will be displayed as an inline list. In this mode each record can be expanded to view the child list.
Standalone - The child list will be displayed as a separate component on the page. In this mode both the parent and child list can be viewed together.
DefaultStandalone
Exampledisplay = Nested;

displayvalue

DescriptionSet an attribute that belongs to the entity of the entityset which you�re using to import items from.
The items displayed in the lists of the item picker are the values of this attribute. This is a mandatory property.
TypeString
DefaultString
Used inItem Picker,
Exampledisplayvalue = Company;

dynamic

Assistant Step

DescriptionAllows the developer to call a function that will dynamically generate an assistant step.
Exampledynamic DynamicStepFunction(Param1, Param2);

editable

DescriptionDetermines if the control can be edited or not during runtime.
TypeBoolean
Valuestrue - Control is editable
false - Control is read-only
Defaulttrue
Used inAddress Field, Color Picker, Date Range Field, Date Time Picker, Item Picker, Signature

Currency/Measure

DescriptionEvaluates as a boolean expression to determine if the currency/measure client control is editable or not.
TypeBoolean or Expression returning a boolean value
ValuesBoolean - true
Defaulttrue
ExampleBoolean
Expression
See "Example code - Editable property" below.
currency EntryFee(CurrencyCode) {  
    unitlookup IsoCurrencyEntitySet(CurrencyCode);  
    unitselector IsoCurrencySelector;   
    editable = [PaidAmount > 1000];  
}  

Example code - Editable property

Free text field/LOV

DescriptionEvaluates as a boolean expression to determine if the LOV is editable or not.
TypeBoolean or Expression returning a boolean value
ValuesBoolean - true
Defaulttrue
ExampleBoolean
Expression
editable = [];

Radio button

DescriptionEvaluates as a boolean expression to determine if the radio buttons (radio group) is editable or not.
TypeBoolean or Expression returning a boolean value
ValuesBoolean - true
Defaulttrue
ExampleBoolean
editable = [true];

editmode

DescriptionDetermines how a list can be edited by the user.
TypeConstant
ValuesSingleCellEdit - Changes are saved when you edit a cell and move the cursor away from it. You can only change one cell at a time.
SingleRowEdit - Changes are saved when you move the focus away from the row.
MultiRowEdit - When this mode is enabled, the list will be displayed as read-only with an Edit button in the list's toolbar. Clicking the Edit button will let you edit multiple rows and manually save the changes using the Save button in the toolbar. This is also the default behavior for a list.
DefaultMultiRowEdit
Used inList
ExampleeditMode = SingleCellEdit;

page

DescriptionSpecifies edit mode for the page. This property should be used only if you have a specific requirement just to disable edit button or inline edit.
TypeConstant
ValuesDefault - The field can be edited either by clicking the Edit button or directly on the field, using the inline edit
Inline - Field becomes editable via inline edit
MultiField - Field becomes editable after clicking Edit button
Exampleeditmode = MultiField;

emphasis

DescriptionSpecifies the color of the applicable control. The emphasis of a control is always set against a [IFS Cloud Web Color][].
TypeExpression returning a boolean value
ValuesExpression - Flag Condition (see example below)
Constants[Contextual color constant][], [Data Validity]
DefaultIf a value is not set for emphasis, True values are denote by the color blue and false values are denoted by the color grey.
Used inBadge, Boolean
ExampleExample 1 - emphasis Complementary1 = [SomeBooleanField = true];
Example 2 - emphasis Alert = [SomeBooleanField = false];

Bar chart

DescriptionSpecifies the color of bars in bar chart. The emphasis of a control is always set against a [IFS Cloud Web Color][].
TypeExpression returning a boolean value
ValuesExpression - Flag Condition (see example below)
Constants[Contextual color constant][], [Data Validity]
DefaultIf a value is not set for emphasis, True values are denote by the color blue and false values are denoted by the color grey.
Used inBadge, Boolean
ExampleExample 1 - emphasis Complementary1 = [SomeBooleanField = true];
Example 2 - emphasis Alert = [SomeBooleanField = false];

Box-matrix

DescriptionSpecifies the color of the circle. The value must be against a contextual color constant.
TypeBoolean or Expression returning a boolean value
ValuesBoolean - true
ConstantsContextual color constant
DefaultIf a value is not set for emphasis, True values are denote by the color blue and false values are denoted by the color grey.
ExampleBoolean
Expression
emphasis Complementary5 = [Country = "Sweden"];

Badge

DescriptionSpecifies the color of the badge. The value must be a complementary constant (i.e., ComplementaryN).
TypeBoolean or Expression returning a boolean value
ValuesBoolean - true
ConstantsComplementary1 - Pink
Complementary3 - Blue
Complementary5 - X
Complementary7 - X
Complementary9 - X
DefaultComplementary1 = [true];
ExampleBoolean
Expression
emphasis Complementary5 = [Country = "Sweden"];

Calendar

DescriptionThe emphasis property is used to set colors for calendar events based on the resource values and attribute values. The value must be against a [contextual color constant][].
TypeBoolean or Expression
ValuesBoolean - true
DefaultNone
ExampleBoolean
Expression

Command

DescriptionSpecifies the color of the boolean control when it is displayed as a badge. The value must be against a contextual color constant.
Note: This property is only applicable to badges.
TypeExpression returning a boolean value
ValuesExpression - Flag Condition (see example below)
ConstantsContextual color constant
DefaultIf a value is not set for emphasis, True values are denote by the color blue and false values are denoted by the color grey.
ExampleBoolean
Expression
emphasis StateOpen = [Objstate = "Opened"];

Line chart

DescriptionSpecifies the color of lines in line chart. The emphasis of a control is always set against a [IFS Cloud Web Color][].
TypeExpression returning a boolean value
ValuesExpression - Flag Condition (see example below)
Constants[Contextual color constant][], [Data Validity]
DefaultIf a value is not set for emphasis, True values are denote by the color blue and false values are denoted by the color grey.
Used inBadge, Boolean
ExampleExample 1 - emphasis Complementary1 = [SomeBooleanField = true];
Example 2 - emphasis Alert = [SomeBooleanField = false];

Markdown text

DescriptionSpecifies the color of the markdown text. The value must be a complementary constant (i.e., ComplementaryN).
TypeBoolean or Expression returning a boolean value
ValuesBoolean - true
ConstantsComplementary values
DefaultComplementary1 = [true];
ExampleBoolean
Expression
emphasis Complementary5 = [Country = "Sweden"];

Progress field

There are 30 standard colors for the most used states in the application. States are grouped by their meaning, and each group has a color.

NOTE! This keeps consistency in the application, and avoids getting different colors for the same state (for example in pages).

For the latest standard color settings, refer to the Icon Library for IFS arena:

https://lkppde.corpnet.ifsworld.com:58080/main/ifsapplications/web/iconlibrary

(``, must be replaced with the appropriate environment)

DescriptionSpecifies the color of the progress field. The value must be a complementary constant (i.e., ComplementaryN).
TypeBoolean or Expression returning a boolean value
ValuesBoolean - truefalse
Expression - Flag Condition (see example below)
ConstantsComplementary1 - Pink
Complementary3 - Light green
Complementary5 - Dark blue
Complementary7 - X
Complementary9 - X
Complementary11 - X
DefaultComplementary1 = [true];
ExampleBoolean
Expression
emphasis StateOpen = [Objstate = "Opened"];

State indicator

There are 30 standard colors for the most used states in the application. States are grouped by their meaning, and each group has a color.

NOTE! This keeps consistency in the application, and avoids getting different colors for the same state (for example in pages).

For the latest standard color settings, refer to the Icon Library for IFS arena:

https://lkppde.corpnet.ifsworld.com:58080/main/ifsapplications/web/iconlibrary

(``, must be replaced with the appropriate environment)

DescriptionSpecifies if the item or action is enabled or not.
TypeBoolean or Expression returning a boolean value
ValuesBoolean - truefalse
Expression - Flag Condition (see example below)
ConstantsEmphasis name - Standard color
StatePreliminary - Dark Blue
StateOpen - Dark Blue
StatePlanned - Light Blue
StateActive - Yellow
StatePrepared - Yellow
StatePosted - Yellow
StateDefined - Yellow
StateTransferred - Yellow
StateReleased - Green
StateCompleted - Green
StateBlocked - Pink
StateStopped - Pink
StateClosed - Dark Grey
StateCancelled - Light Gray
Defaulttrue
ExampleBoolean
Expression
emphasis StateOpen = [Objstate = "Opened"];

Timeline

DescriptionSpecifies the color of the applicable control. The emphasis of a control is always set against an IFS Cloud Web Color.
TypeExpression returning a boolean value
ValuesExpression - Flag Condition (see example below)
Constants[Contextual color constant][], [Data Validity]
DefaultIf a value is not set for emphasis, True values are denote by the color blue and false values are denoted by the color grey.
ExampleExample 1 - emphasis Complementary1 = [SomeBooleanField = true];
Example 2 - emphasis Alert = [SomeBooleanField = false];

Tree diagram

DescriptionSpecifies the color of the node based on a condition. The value must be against a [contextual color constant][]. A stripe color would be set to the left of the node.
TypeExpression returning a boolean value
ValuesExpression - Flag Condition (see example below)
Constants[Contextual color constant][]
DefaultIf a value is not set for emphasis, there wouldn't be any color stripe
ExampleExample 1 - emphasis Complementary1 = [SomeField = true];
Example 2 - emphasis Alert = [SomeField = 100];

enabled

Assistant - Steps

DescriptionDetermines if the step is enabled or not. When disabled, the step will still be visible in the step indicator and grayed out. The user will not be able to access it.
TypeBoolean or an expression returning a boolean
ValuesBoolean: [true]
Default[true]
ExampleBoolean: enabled = [true];
Expression: enabled = [Attribute != Value];

Contact widget

DescriptionSpecifies if the item or action is enabled or not.
TypeBoolean or Expression returning a boolean value.
ValuesBoolean - true
Defaulttrue
ExampleBoolean
Expression
enabled = [CustomerId = 'ALAIN']

Command

DescriptionSpecifies if the command is enabled or disabled. In most cases, a disabled command also means it is hidden.
TypeBoolean or Expression returning a boolean value.
ValuesBoolean - true
Defaulttrue
ExampleBoolean
Expression
Note! An expression can be set based on the record. When the property mode is set to SelectedRecords, then the expression evaluates to true, if each record in the selection evaluates to true.

enableordering

DescriptionThis property is used to enable the ordering buttons.
TypeBoolean
Valuestrue
Defaultfalse
Used inItem Picker
Exampleenableordering = [true];

end

Calendar

DescriptionIndicates the end time of the calendar items.
TypeDataItemReference
ValuesDATE/TIMESTAMP type attribute
DefaultNone
Exampleend = AbsenceEnd;

enddate

Calendar

DescriptionThe property is used to set the view state property viewenddate on the filter that retrieves the calendar data. If this property is not defined the filter uses the start property. This property uses DATE type attributes instead of TIMESTAMP attributes since the time part is not needed.
TypeDataItemReference
ValuesDATE type attribute
DefaultNone
Exampleenddate = AbsenceEndDate;

enumerationtrue

DescriptionAttribute as a toggle button in the client. Note: Enumerationtrue identifier value will be saved as the true value of the toggle button in edit mode.
Type
Values
Constants
Default
Used inField
Example

execute/bulkexecute

Command

DescriptionSpecifies the actual script for the command.
TypeCommand script?
ValuesExecute - operates on one record.
The difference is in the context for the command and what instructions you can use.
Context of the command in bulkexecute is not a record, instead it is an object which only contains the attributes Count and Selection.
CommandsExecute command instructions:
Bulkexecute additional command instructions:
before/after?
bulkcallbulknavigate
DefaultNone.
ExampleNavigate to other page with execute property:


<br>execute {navigate "page/AdministerEmpTrainings/EmployeeTrainingPlan?$filter=CompanyId eq<br>

falselabel

DescriptionThe custom text that should be shown when the boolean value is false.
TypeString
ValuesString
Default"No"
Used inBoolean
Examplefalselabel = "Negative";

fetchsize

Calendar

DescriptionDetermines the number of records that should be loaded in the calendar.
TypeNumber
ValuesInteger
Default500
Examplefetchsize = 1000;

fieldhint

DescriptionSets a UI hint for the client so that the device can interpret the field in a correct way.
Type
ValuesText
Constants
Default
Used inField
Example

field

Timeline

DescriptionDefines what attribute value that should be shown in the entry body.
TypeAttribute
ValuesAny attribute defined on the entity
Examplefield = Description;

fieldranking

DescriptionDetermines which rows should be displayed based on the screen size. By giving fields a ranking you can make sure that the most relevant fields are always displayed to the user regardless of the screen size. Note: User profile settings take priority over field ranking. The screen size and user specified column visibility is saved in the user profile. So when the user loads the list again the columns shown will be based on the user profile setting for that specific screen size and not the field ranking.
TypeDataItemReference
ValuesComma separated DataItemReferences.
DefaultNone
Used inList
Examplefieldranking ConnectionType, StepNo, StartDate, CalendarActivityType, MainRepresentativeName;

Card

DescriptionUsed to set extra importance to one attribute, this typically means that any field using this attribute is emphasized in some way.
TypeAttribute
ValuesName of an attribute
ExampleEmphasizes all fields using the attribute. Name
fieldranking Name;

filter

DescriptionDetermines the filtering condition that should be applied to the items displayed in the lists. For the filter conditions, values from the current record of the page, company context, and search context can be used.
TypeExpression - Query Condition
ValuesQuery Condition
DefaultNone
Used inItem Picker
Examplefilter = [KeyValue = SourceCompany];

List example 2

DescriptionDetermines the filtering condition that should be applied to the records displayed in the list. For the filter conditions, values from the current record of the page, company context, and search context can be used.
TypeExpression - Query Condition (see example below)
ValuesQuery Condition
DefaultNone
ExampleCurrent record of a page - filter = [LineCompany = Company];

Where values of LineCompany attribute in the list is equal to the global company of the page
Where values of LineCompany attribute in the list is equal to the Company attribute of the search context of the page

Pie chart

DescriptionDetermines the filtering condition that should be applied to the records displayed in the list. For the filter conditions, values from the current record of the page, company context, and search context can be used.
TypeExpression - Query Condition (see example below)
ValuesQuery Condition
DefaultNone
ExampleCurrent record of a page - filter = [LineCompany = Company];

Where values of LineCompany attribute in the list is equal to the global company of the page
Where values of LineCompany attribute in the list is equal to the Company attribute of the search context of the page

Bar chart

DescriptionDetermines the filtering condition that should be applied to the records displayed in the list. For the filter conditions, values from the current record of the page, company context, and search context can be used.
TypeExpression - Query Condition (see example below)
ValuesQuery Condition
DefaultNone
ExampleCurrent record of a page - filter = [LineCompany = Company];

Where values of LineCompany attribute in the list is equal to the global company of the page
Where values of LineCompany attribute in the list is equal to the Company attribute of the search context of the page

Calendar

DescriptionThe filter property in resource section is used to enable/disable the filtering possibility of calendar items/data based on different values of the respective resource. This property should be defined for each resource section which needs the filtering functionality. You can define only two resource types with filter enabled.
TypeBoolean
Valuestrue
Defaultfalse
Exampleresource Approved { filter = [true]; }

Funnel chart

DescriptionDetermines the filtering condition that should be applied to the records displayed in the list. For the filter conditions, values from the current record of the page, company context, and search context can be used.
TypeExpression - Query Condition (see example below)
ValuesQuery Condition
DefaultNone
ExampleCurrent record of a page - filter = [LineCompany = Company];

Where values of LineCompany attribute in the list is equal to the global company of the page
Where values of LineCompany attribute in the list is equal to the Company attribute of the search context of the page

Line chart

DescriptionDetermines the filtering condition that should be applied to the records displayed in the list. For the filter conditions, values from the current record of the page, company context, and search context can be used.
TypeExpression - Query Condition (see example below)
ValuesQuery Condition
DefaultNone
ExampleCurrent record of a page - filter = [LineCompany = Company];

Where values of LineCompany attribute in the list is equal to the global company of the page
Where values of LineCompany attribute in the list is equal to the Company attribute of the search context of the page

filterlabel

DescriptionThe label to be shown in the filter and search panel in cases where similar labels are used.
TypeString
ValuesString
DefaultNone
Used inAddress Field, Date Range Field, Field
Examplefilterlabel = "Delivery Address";

Free text field/LOV

DescriptionThis label shows as the title in filter and search panel in cases where other labels are used, excluding any trailing ':' character.
For example, when the property filterlabel is used, it overrides the regular property label.
TypeString
ValuesString or variable containing a string
DefaultNone.
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a LOV for ${parent.attribute}";

format

DescriptionDetermines if the control displays the seconds if the data type is Time.
TypeConstant
Valueslongtime
DefaultNone
Used inDate Time Picker
Exampleformat = longtime;

Free text field/LOV

DescriptionSpecifies the display format of a field value.
Type
ValuesValid values are uppercase, lowercase and percentage.
DefaultNone.
Exampleformat = uppercase;

Computed field

DescriptionSpecifies the format in which the computed field presents the field value.
TypeField enumeration
ValuesValid values are:
decimal, ifscurrency, longtime, lowercase, percentage, and uppercase.
Defaultdecimal
Exampleformat = percentage;

Currency/Measure

DescriptionSpecifies the format in which the computed field presents the field value.
TypeField enumeration
ValuesValid values are:
decimal, ifscurrency, longtime, lowercase, percentage, and uppercase.
Defaultdecimal
Exampleformat = percentage;

freeinput

Free text field/LOV

DescriptionSpecifies if a normal text field with a list of suggested values is enabled or not.
TypeBoolean or expression returning a boolean value.
Valuestrue - freetext field is enabled
Boolean - true (enabled)
Defaultfalse
ExampleBoolean
Expression

groupby

Calendar

DescriptionThis property is used to re-group the calendar groupings defined using grouping property.
TypeVariable
Valuescontains an attribute
DefaultNone
Examplegroupby Company;

grouping

Calendar

DescriptionThis property is used to group calendar items/data.
TypeVariable
Valuescontains an attribute
DefaultNone
Examplegrouping Employee;

Timeline

DescriptionDefines the title of each entry in the timeline.
TypeString
ValuesString or variable containing a string
Exampleheader = Name;

height

DescriptionDetermines the default height for a multiline field. Note: This property is not applicable for multiline fields inside lists. In a list the complete text will be visible in a multiline field dialog. In groups, if the size of the control is not defined as fullWidth then it will work as in the list.
For all other instances the text that will be displayed will differ based on the height.
TypeConstant
Valuessmall
Defaultauto
Used inMultiline Field
Exampleheight = small;

hidekey

Free text field/LOV

DescriptionEvaluates as a boolean expression to determine if the key is hidden or not.
TypeBoolean or expression returning a boolean value.
ValuesBoolean - true
Defaultfalse
Examplehidekey = [true];

icon

DescriptionSpecifies the icon to be used on a control. The name of the icon must correspond to a real filename in the client framework icon folder. The folder can be found at https://<application server>:<port>/main/ifsapplications/web/iconlibrary
TypeString (name of icon)
ValuesRefer to the Icon Library for valid icon names:
DefaultNone
Used inBadge
Exampleicon = "star";

Badge

The available variations of the badge presence are listed in the Icon Library.

DescriptionSpecifies the icon of the badge.
TypeString (name of icon)
ValuesRefer to the Icon Library for valid icon names:
DefaultNone.
Exampleicon = "star";

Command

The available variations of the command presence are listed in the Icon Library.

DescriptionSpecifies the icon of the command.
TypeString (name of icon)
ValuesRefer to the Icon Library for valid icon names:
DefaultNone.
Exampleicon = "star-solid";

iconset

Tree (tree node only)

DescriptionSets icons and emphasis values to the tree structure nodes
TypeObject
ValuesSet of icon values
DefaultNone
Exampleiconset {
    expression = [HierarchyId = "*"];
  icon "business-structure" {
  }
  icon "business-structure-alt";
}

Tree diagram

DescriptionSpecifies set of icons for the nodes based on a condition. A color could be set on each of the icons based on a condition through emphasis. The used icons should be available in the icon library.
TypeString
ValuesName of the icon
DefaultNone
LookTree Diagram Control - Node
Exampleicon "alert" { expression = [BusinessUnitId = 4]; } - Sets alert as the icon for node with BusinessUnitId = 4

emphasis Complementary9 = [BusinessUnitId = 0]; - Sets background color of icon in node with BusinessUnitId = 0 to Complementary9

idlabel

Free text field/LOV

Description
Type
Values
Default
Example

initialfocus

DescriptionInforms the application on the field that should be focused when entering create mode. Can be used in fields of groups and lists
Type
Values
Constants
Default
Example
Used in Field

initialview

DescriptionDetermines the view of the list when opened for the first time. The view of the list is stored in the users profile.
TypeConstant
ValuesListView - Displays the rows in the list in the standard way
CardView - Displays the rows as cards. To use the CardView you need to add a card to the list.
TileView - Display Rows as Tiles. All the Columns will be displayed as default
AvatarView - Displays the rows as avatars if the list is configured to use a box-matrix
DefaultListView
Used inList
Exampleinitialview = BoxMatrixView;

Box-matrix

DescriptionThis applies only if there is a boximage specified. If specified there are going to be two views. They are the ListView and AvatarView. The value against this property is saved in the user profile. The value in the user profile will always override the code defined value.
TypeString
ValuesListView
DefaultListView
Exampleinitialview = AvatarView;

keeponrestart

Assistant

DescriptionSpecifies which fields to be persisted during subsequent restarts of the assistant.
TypeAttribute list
ValuesList of valid Attributes
DefaultNone
Examplekeeponrestart(Attribute1, Attribute2);

key

Contact widget

DescriptionSpecifies the column where the person's ID can be extracted to fetch person information (optional).
TypeAttribute
ValuesThe column that contains the user ID.
DefaultNone
Examplekey = Authorizer;

label

DescriptionUsed as the title of the control. It is also possible to set the title through a variable. For example, if the control is a child element, attributes from the parent element can be added to the label as a variable.
TypeString
ValuesString or variable containing a string
DefaultNone
Used inAddress Field, Date Range Field, Date Time Picker, Item Picker, List, Multiline Field, Pie Chart, Process Viewer, Section/Group, Search Context, Signature, Tab
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a list for ${parent.attribute}";

Assistant

DescriptionUsed as the title of the assistant.
TypeString
ValuesString or variable containing a string
ExampleLabel with a string: label = "This is a label";
Label using string interpolation: label = "This is a label for ${Attribute}";

Assistant Steps

DescriptionUsed as the title of the step.
TypeString
ValuesString or variable containing a string
ExampleLabel with a string - label = "This is a label";
Label using string interpolation - label = "This is a label for ${Attribute}";

Bar chart

DescriptionUsed as the title of the bar chart. It is also possible to set the title through a variable. For example, if the bar chart is a child element, attributes from the entity which the parent element is based on can be added to the label as a variable and it will assign the relevant value from the parent record at runtime.
TypeString
ValuesString or variable containing a string
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a bar chart for ${parent.attribute}";

Calendar

DescriptionThe label property is used to control the displayed calendar label in the collapsible calendar group.
TypeString
ValuesString
Examplelabel = "This is a title";

Card

DescriptionUsed as the title of the card.
TypeString
ValuesString or variable containing a string.
ExampleLabel with a string:
label = "This is a title";
Label with an attribute interpolation:
label = "This is a card for ${<attribute>}";

Command

DescriptionSpecifies the text that shows on the command.
TypeString
ValuesAny given string or variable containing a string.
DefaultName of the command.
ExampleLabel with a string:
Label with a variable:
label = "Share in ${parent.attribute}";

Computed field

DescriptionUsed as the title of the computed field. It is also possible to set the title through a variable.
If no label is provided, then the label get the same value as the name of the computed field.
TypeString
ValuesString or variable containing a string
ExampleLabel with a string:

label = "This is a computed field for ${parent.attribute}";

Currency/Measure

DescriptionUsed as the title of the currency/measure client control. It is also possible to set the title through a variable.
If no label is provided, then the label get the same value as the name of the currency/measure client control.
TypeString
ValuesString or variable containing a string.
ExampleLabel with a string:

label = "This is a currency/measure client control for ${parent.attribute}";

Dialog

DescriptionUsed as the title of the dialog. It is also possible to set the title through a variable.
For example, if the list is a child element, then attributes from the entity which the parent element is based on, can be added to the label as a variable, and it assigns the relevant value from the parent record at runtime.
TypeString
ValuesString or variable containing a string
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a list for ${parent.attribute}";

page

DescriptionLabel to be used as the page title
TypeString
ValuesString or variable containing a string
ExampleLabel with text only - label = "My page title";
Label with a variable - label = "Page title for ${name}";

Free text field/LOV

DescriptionUsed as the title of the LOV. It is also possible to set the title through a variable. For example, if the LOV is a child element, attributes from the entity which the parent element is based on can be added to the label as a variable and it will assign the relevant value from the parent record at runtime.
TypeString
ValuesString or variable containing a string
DefaultNone.
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a LOV for ${parent.attribute}";

Funnel chart

DescriptionUsed as the title of the funnel chart. It is also possible to set the title through a variable. For example, if the funnel chart is a child element, attributes from the [entity][] which the parent element is based on can be added to the label as a variable and it will assign the relevant value from the parent record at runtime.
TypeString
ValuesString or variable containing a string
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a funnel chart for ${parent.attribute}";

Line chart

DescriptionUsed as the title of the line chart. It is also possible to set the title through a variable. For example, if the line chart is a child element, attributes from the [entity][] which the parent element is based on can be added to the label as a variable and it will assign the relevant value from the parent record at runtime.
TypeString
ValuesString or variable containing a string
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a line chart for ${parent.attribute}";

Progress field

DescriptionUsed as the title of the progress field. It is also possible to set the title through a variable.
For example, if the progress field is a child element, attributes from the entity, which the parent element is based on, can be added to the label as a variable. The attribute then assigns the relevant value from the parent record at runtime.
TypeString
ValuesString or variable containing a string
DefaultNone.
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a progress field for ${parent.attribute}";

Radio button

DescriptionSpecifies the text that shows on the radio buttons (radio group).
TypeString
ValuesAny given string or variable containing a string.
DefaultName of the command.
ExampleLabel with a string:
Label with a variable:
label = "${parent.attribute} Group";

Rating control

DescriptionSpecifies the title of the assistant.
TypeString
ValuesString or variable containing a string
ExampleLabel with a string: label = "This is a label";
Label using string interpolation: label = "This is a label for ${Attribute}";

Sheet

DescriptionUsed as the title of the sheet.
TypeString
ValuesString or variable containing a string
ExampleLabel with a string:
label = "This is a title";
Label with an attribute interpolation
label = "This is a sheet for ${<attribute>}";

Timeline

DescriptionUsed as the title of the control. It is also possible to set the title through a variable. For example, if the control is a child element, attributes from the parent element can be added to the label as a variable.
TypeString
ValuesString or variable containing a string
DefaultControl name in Pascal Case
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a list for ${parent.attribute}";

Tree

DescriptionSpecifies the title of the tree control. This is visible only when there are no records available in the main record selector.
TypeString
ValuesTitle of the tree control
DefaultNone
Examplelabel = "Project Tree";

Tree (tree node only)

DescriptionDefines the label of the tree node. This can be interpolated using the record of the node
TypeString
ValuesThe label of the tree node
DefaultNone
Examplelabel = "Sub Project - ${SubProjectId}"

Tree diagram

DescriptionUsed as the title or tooltip text for the tree diagram, nodes, clickable icons
TypeString
ValuesString
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a list for ${attribute}";

legends

Timeline

See example in How to use section.

Description
Type
Values
Default
Example

lovswitch

Field

DescriptionConditional set of references
...

Syntax:

lovswitch { ( LookupSwitchReference )+ } | | Type | | | Values | | | Constants | | | Default | | | Example | | |||

maxlength

DescriptionDetermines the maximum field length.
TypeNumber
Values
Constants
Default
Example

maxrating

Rating control

DescriptionSpecifies the maximum value of the rating scale.
TypeAttribute or Integer
ValuesAny attribute or a value between 1 - 10.
DefaultNone
ExampleInteger
Attribute
maxrating = MyMaxRatingAttribute;

mode

Command

DescriptionSpecifies the mode the command operates in.
TypeConstant
ValuesSingleRecord � the command operates on only one record. If more than one record is selected, the command is disabled.
- If execute is used, then the command runs once for each record.
Global � the command operates on one record, but not on the component where it is defined.
If no binding is used, the command binds to the default record on the page (or assistant).
Note! A type must be defined for the command, and it must be the same type as the component it binds to.
DefaultNone.
Examplemode = SelectedRecords;

multiline

Field

DescriptionThis control is used to enter multiple lines of text and can be used in lists and groups. The complete content of a multiline field will be displayed in a either dialog or the field itself accessible by clicking the downward arrow in the bottom right hand corner.
Type
Values
Constants
Default
Example

multiselect

DescriptionDetermines how users can select the rows in the list, that is single row or multiple rows.
TypeBoolean
Valuestrue
Defaulttrue
Used inList
Examplemultiselect = [false];

Tree

DescriptionDefines a set of contexts which are used to change the navigation of tree nodes conditionally, and set the visibility of tree nodes. The contexts are available as a drop down on top of the tree control.
TypeObject
ValuesThe set of navigational contexts
DefaultNone
Examplenavicontexts {
     label = "Material";
  context Installation {
  }
    label = "Task";
  context All {
  }
}

Tree (tree node only)

DescriptionDefines the navigation setup of the node
TypeObject
ValuesPage Reference with parameters such as filter, searchcontext and context. There can be multiple page references where the page is selected using navigational context and values of the record
DefaultNone
Examplenavigate {
    filter(SubProjectId, SubProjectId);
}

node

Tree

DescriptionDefines a node of the tree control (except the root node)
TypeTree Node
ValuesThe definition of any node of the tree control except the root node. An entity type needs to be defined for this node.
DefaultNone
Examplenode SubProjectNode for TstSubProject {
}

oncopy

Tree (tree node only)

DescriptionDefines a set of commands which are executed when the current node is being copied into another node
TypeObject
ValuesA set of Tree Node references with command references
DefaultNone
Exampleoncopy {
}

onmove

Tree (tree node only)

DescriptionDefines a set of commands which are executed when the current node is being moved into another node
TypeObject
ValuesA set of Tree Node references with command references
DefaultNone
Exampleonmove {
}

optional

Assistant - Steps

DescriptionDetermines if the step is optional or not. If true, a command to mark the step as skipped will appear.
TypeBoolean or an expression returning a boolean
ValuesBoolean: [true]
Default[false]
ExampleBoolean - optional = [true];
Expression - optional = [Attribute != Value];

orderby

DescriptionDetermines the default order the records should be displayed in the list. Note: The default order by defined in the client metadata may be overridden if there is an order by set in the URL when navigating to pages.
TypeDataItemReference
ValuesComma separated DataItemReferences. You can optionally set the sort order using the keywords asc and desc.
DefaultDataItemReference asc
Used inList
ExampleOrder rows without sorting -

orderby = ActivityType, MainRepresentativeId desc;

Item Picker

DescriptionList of fields that will get a default ordering
TypeDataItemReference
ValuesComma separated DataItemReferences. You can optionally set the sort order using the keywords asc and desc.
DefaultNone
Exampleorderby = Description asc;

Tree (tree node only)

DescriptionDefines the attribute which is used to sort the current node set. This attribute should be in the record of the node
TypeAttribute Reference and sort type (ascending or descending) - <Attribute> <acs/desc>
ValuesAttributeReference asc/desc
DefaultThe attribute reference doesn't have a default value. But the default value of the sort type is asc
Exampleorderby = SubProjectId desc

orientation

Calendar

DescriptionThis property is used to set the orientation when grouping is defined in calendar.
ValuesHorizontal - groups will display Horizontally
Vertical- groups will display Vertically
DefaultVertical
Exampleorientation = Horizontal;

pinnedsearchfields

DescriptionForce some fields to always show in the search panel. These fields cannot be removed from the panel
TypeDataItemReference
ValuesComma separated DataItemReferences
DefaultNone
Examplepinnedsearchfields = Name;

page

DescriptionForce fields to always show in the search panel
TypeDataItemReference
ValuesComma separated DataItemReference
Examplepinnedsearchfields = Points, Name;

preselect

DescriptionDetermines if the first row should be selected by default if multiselect is enabled for a list. By default no rows are selected when multiselect is enabled.
TypeBoolean
Valuestrue
Defaultfalse
Used inList
Examplepreselect = [true]

preserveprecision

Currency/Measure

DescriptionThis property is available for currency and measure fields with decimal or ifscurrency formats.
With preserveprecision it is possible to enter and store a value with a number of decimals. But when the value is displayed only the number of decimals defined by the format options are displayed. All decimals are visible again when the value is edited.
TypeBoolean or Expression returning a boolean value.
ValuesBoolean - true
Defaultfalse
ExampleSee "Example code - Preserveprecision property" below.
field DecimalPrecision {  
   format = decimal;  
   preserveprecision = [true];  
}  

currency EntryFee(CurrencyCode) {  
   uniteditable = [false];  
   format = ifscurrency;  
   preserveprecision = [true];   
}  

Example code - Preserveprecision property

preview

Free text field/LOV

Description
Type
Values
Default
Example

Timeline

Description
Type
Values
Default
Example

ranking

Calendar

DescriptionThe ranking property can uses in two instances:
2. Within grouping to order the groups based on ranking values.
TypeDataItemReference
ValuesDataItemReference that returns a numeric values
DefaultNone
ExampleUsage in resource section - resource EmployeeName { ranking EmployeeRank; }
Usage in grouping section - grouping Employee { ranking Rank; }

regexp

Field

DescriptionRegular expression that the field content must match.

Syntax:

regexp = ;

field FlightNo {  
        regexp = "[A-Z]{2}[0-9]+";  
     } |  

| Type | | | Values | | | Constants | | | Default | | | Example | | |||

required

DescriptionDetermines if a value is required or not in a control.
TypeBoolean
Valuestrue - Value is required
false - Value is not required
Defaultfalse
Used inAddress Field, Date Range Field

Currency/Measure

DescriptionEvaluates as a boolean expression to determine if the currency/measure client control is required or not.
TypeBoolean or Expression returning a boolean value
ValuesBoolean - true
Defaultfalse
ExampleBoolean
required = [true];

Free text field/LOV

DescriptionEvaluates as a boolean expression to determine if the LOV is required or not.
TypeBoolean or Expression returning a boolean value
ValuesBoolean - true
Defaultfalse
ExampleBoolean
Expression
required= [];

Radio button

DescriptionEvaluates as a boolean expression to determine if the radio group is required or not.
TypeBoolean or Expression returning a boolean value
ValuesBoolean - true
Defaultfalse
ExampleBoolean
required = [true];

requiredsearchfields

DescriptionSet fields as mandatory search criterias
TypeDataItemReference
ValuesComma separated DataItemReferences
DefaultNone
Examplerequiredsearchfields = Active;

page

DescriptionSet fields as mandatory search criterias, so that a search cannot be performed unless there are condition values given for the specified fields
TypeDataItemReference
ValuesComma separated DataItemReference
Examplerequiredsearchfields = Name, Country;

resource

Calendar

DescriptionThe resource property is used to define resources in the calendar control. You can use emphasis keyword to add colors to resources based on the attribute value. You can define two resource types in a calendar.
TypeDataItemReference
ValuesAttribute
DefaultNone
Exampleresource Approved;

rootnode

Tree

DescriptionDefines the root node of the tree control
TypeTree Node
ValuesThe definition of the root node. The entity type of this node is similar to the entity type of the main selector
DefaultNone
Examplerootnode ProjectNode {
}

savemode

DescriptionDetermines the save mode for the data within the control.
TypeConstant
ValuesDefault - Individual rows are saved separately. This is the default behavior.
Buffer - All changes are buffered and saved at the same time in a bulk save operation. Note: All changes are committed or rejected as a whole.
Unbound - Save is not performed when running a command on an edited record. This lets the user perform commands on a dirty record. Only applicable for single record edits. Note: To use the unbound option the editmode property of the list must be set to SingleCellEdit or SingleRowEdit.
DefaultDefault
Used inList
ExamplesaveMode = Unbound;

Assistant

DescriptionSpecifies the saving behavior of the assistant.
TypeEnumeration
ValuesOnFinish - Data will be saved when necessary, such as before running a command or if there are child records on a step.
OnLostFocus - Data will be saved when the focus of a field is lost
DefaultOnFinish
Examplesavemode = OnLostFocus;

Free text field/LOV

Description
Type
Values
Default
Example

searchable

DescriptionDetermines if the control can be searched.
TypeBoolean
Valuestrue - Control can be searched
false - Control cannot be searched
Defaulttrue
Used inAddress Field, Date Range Field

Currency/Measure

DescriptionDetermines if the control can be searched.
TypeBoolean
Valuestrue - Control can be searched
false - Control cannot be searched
Defaulttrue

searchcontext

Tree

DescriptionReference to the tree filter (tree search context)
TypeSearch Context Reference
ValuesSearch Context Reference with default method (if available)
DefaultNone
Examplesearchcontext TreeSearchFilter {
}

selecteditemslabel

DescriptionTitle of the selected items list box in Item picker.
TypeString
DefaultNone
Used inItem Picker
Exampleselecteditemslabel = "Selected Languages";

selector

Tree

DescriptionReference to the main selector of the tree control
TypeSelector Reference
Values<selector name>. This selector needs to refer to the entity of the tree control
DefaultNone
Exampleselector = ProjectSelector

showlabel

DescriptionDetermines if the label of the address field should be displayed.
TypeBoolean
Valuestrue - Label is displayed
false - Label is not displayed
Defaulttrue
Used inAddress Field

Currency/Measure

DescriptionSpecifies the visibility of the label.
TypeBoolean or expression returning a boolean value
Valuestrue - Label is visible
Boolean - true (visible)
Defaulttrue
ExampleBoolean
Expression
showlabel = [TeamType != null];

Free text field/LOV

DescriptionSpecifies the visibility of the rating label.
TypeBoolean or expression returning a boolean value
Valuestrue - Rating label is visible
Boolean - true (visible)
Defaulttrue
ExampleBoolean
Expression
showlabel = [TeamType != null];

Radio button

DescriptionSpecifies the visibility of the rating label.
TypeBoolean or expression returning a boolean value
Valuestrue - Rating label is visible
Boolean - true (visible)
Defaulttrue
ExampleBoolean
Expression
showlabel = [TeamType != null];

Rating control

DescriptionSpecifies the visibility of the rating label.
TypeBoolean or expression returning a boolean value
Valuestrue - Rating label is visible
Boolean - true (visible)
Defaulttrue
ExampleBoolean
Expression
showlabel = [TeamType != null];

showonlydate

DescriptionThis property should only be used in fields with data type Timestamp. Syntax:

showonlydate = [ FlagCondition ] ;

field SampleField {  
        showonlydate = [true];  
     }|  

| Type | | | Values | | | Constants | | | Default | | | Example | | |||

skipattribute

Assistant - Steps

DescriptionAn attribute that retains the skip state for the step.
TypeAttribute
Exampleskipattribute = Attribute1

slotsize

Calendar

DescriptionDetermines the way calendar time slots need to be displayed.
TypeConstant
ValuesHour - time slots will be displayed in hours
Day- time slots will be displayed in days
DefaultHour
Exampleslotsize = Day;

size

DescriptionDetermines the size of the field and its applicable variants.
TypeConstant
ValuesSmall - This is half of the normal or medium field size.



DefaultMedium
Used inAddress Field, Badge, Date Range Field, Date Time Picker, Field, Signature
Examplesize = Small

Currency/Measure

DescriptionSpecifies the layout size for the currency/measure client control.
TypeField enumeration
ValuesSmall, Medium, Large or FullWidth.
DefaultMedium
Examplesize = FullWidth;

Radio button

DescriptionSpecifies the layout size for the radio buttons (radio group).
TypeField enumeration
ValuesSmall, Medium, or Large.
DefaultMedium
Examplesize = Large;

Rating control

DescriptionSpecifies the layout size for the rating control.
TypeField enumeration
ValuesSmall, Medium, Large or FullWidth.
DefaultMedium
Examplesize = FullWidth;

sortable

Field

DescriptionA boolean value to determine if the item is manually sortable or not.

Syntax:

sortable = ( true | false ) ;

Note: Sortable flag is default set to true ie the item is by default manually sortable | | Type | | | Values | | | Constants | | | Default | | | Example | | |||

source

Contact widget

DescriptionSpecifies the source of the contact widget.
TypeKeyword
ValuesValid values are:
- Supplier
- User
image, name, phone number, mobile number, and email.
If there is no image available, then the contact widget shows the first two characters of the name in a colored circle.
DefaultIf multiple conditions are true, then the first condition is selected.
If all of the conditions are false, then Person is selected as the default type.
Examplesource = Person/Supplier/Customer;
Customer =[RefTypeDb = "CUSTOMER"];
Supplier = [RefTypeDb = "SUPPLIER"];

start

Calendar

DescriptionIndicates the start time of the calendar items.
TypeDataItemReference
ValuesDATE/TIMESTAMP type attribute
DefaultNone
Examplestart = AbsenceStart;

startdate

Calendar

DescriptionThe property is used to set the view state property viewstartdate on the filter that retrieves the calendar data. If this property is not defined the filter will used the start property. This property uses DATE type attributes instead of TIMESTAMP attributes since the time part is not needed.
TypeDataItemReference
ValuesDATE type attribute
DefaultNone
Examplestartdate = AbsenceStartDate;

startupmode

page

DescriptionStartup behavior of the page
TypeConstant
Valuessearch - TODO: Add parameter value description
Examplestartupmode = search

staticlabel

Assistant

DescriptionDetermined the label to be used in an assistant breadcrumb when it is not declared in navigator entries.
TypeString
ValuesString or variable containing a string
ExampleLabel with a string: staticlabel = "This is a label";
Label using string interpolation: staticlabel = "This is a label for ${Attribute}";

page

DescriptionLabel to be used in the breadcrumb navigation when the page is not declared as a navigator entry.
TypeString
Examplestaticlabel = "My breadcrumb label";

style

DescriptionSpecifies the style of the control.
TypeString
ValuesTextOnly - Shows the control with text only
IconOnly - Shows the control with an icon only
DefaultNone.
Used inBadge
Examplestyle = TextOnly;

Badge

DescriptionSpecifies the style of the badge.
TypeString
ValuesTextOnly - Shows a badge with text only
IconOnly - Shows a badge with an icon only
DefaultNone.
Examplestyle = TextOnly;

Command

DescriptionSpecifies the style of the command.
TypeString
ValuesTextOnly - Shows a command with text only
IconOnly - Shows a command with an icon only
DefaultNone.
Examplestyle = TextOnly;

summary

DescriptionDisplays a summary row at the bottom of the list for selected numerical columns. The summary values are calculated directly from the database and not from the values visible in the list. Note: The summary row will not be displayed if all the summary fields are hidden by the user.
TypeDataItemReference
ValuesComma separated DataItemReferences
DefaultNone
Used inList
Examplesummary = SaleUnitCount, PartCount, GrossTotal, NetTotal;

summaryfield

Card

DescriptionAn attribute to use as a summaryfield. The summaryfield positions this attribute at a place in the card where it is extra emphasized (as of this writing that is top right of the card, and right aligned)
TypeAttribute
ValuesName of an attribute
Examplesummaryfield ListPrice;

text

Markdown text

DescriptionText content for the markdown text
TypeString
ValuesText Content
DefaultNone
ExampleLabel with text only:
label = "This is a title";

tile

List

DescriptionTile view will be enabled for the particular List and tile view option will be available in view modes
TypeString
Valuesname of the particular list
DefaultNone
Used inList
Exampletile OrderDetailsList;

timemarker

Calendar

DescriptionThis property is used to draw the current time marker in each calendar view. This property has to be defined for each view.
TypeBoolean
Valuestrue
Defaulttrue
ExampleAdding a time marker for WorkWeek view - view WorkWeek { timemarker = [false]; }

total

Progress field

DescriptionSpecifies the total length of the progress field given in the total attribute. Other values given in the value blocks are mapped to it.
TypeVariable
ValuesTotal variable contains an attribute.
DefaultNone
ExampleRefer to Progress field control, section How to use - Setting the appropriate properties for the progress field, to define a total variable for the progress field with an attribute.

truelabel

DescriptionThe custom text that should be shown when the boolean value is true.
TypeString
ValuesString
Default"Yes"
Used inBoolean
Exampletruelabel = "Positive";

type

Computed field

DescriptionSpecifies the type in which the computed field presents the field value.
TypeField enumeration
ValuesValid values are:
If the property type is set to anything else than Text, then the property value can only have one expression, and any other text is ignored.
DefaultText
Exampletype = Number;

Field

DescriptionField datatype. Some types also implies that maxlength or pattern also is set.

Syntax:

type = ( DatatypeDefinition | TypeName [ ( TypeQualifier ) ] ) ;

field RunwayLength {  
        type = Number;  
     }  

Valid datatypes are: Text, Number, Boolean, Enumeration, LongText, ...

Note: Default type is Text with unlimited number of characters, unless maxlength is specified.. | | Type | | | Values | | | Constants | | | Default | | | Example | | |||

uniteditable

Currency/Measure

DescriptionSets the unit to only be editable during creation of a record. When not editable it is only possible to change the value on the field, but not in the currency/measure unit.
TypeBoolean or expression returning a boolean value
Valuestrue - Unit is editable
Boolean - true (visible)
Defaulttrue
ExampleBoolean
Expression
uniteditable = [isNew];

unitexportlabel

Currency/Measure

DescriptionLabel for the column header name of the unit column when it gets downloaded to excel (exported file).
TypeString
ValuesString or variable containing a string.
DefaultNull
ExampleLabel with a string:

unitexportlabel = "This is my Measure Unit for ${parent.attribute}";

unitlookup

Currency/Measure

DescriptionProperty unitlookup is a syntax used to populate units from an entityset.
Type
Valuesunitlookup <LookupEntitySet>(<LookupEntityKey>)
NOTE! It is not necessary to define the property unitlookup when the unit is read-only.
DefaultNone.
Exampleunitlookup IsoCurrencyEntitySet(CurrencyCode);
A measure field works the same as the currency, but the base entity is instead called IsoUnit.

unitrequired

Currency/Measure

DescriptionThis evaluates as a boolean expression to determine if the item is required or not. To block empty unit, the required property needs to be set on the attribute in the projection. (does not have any visual effect).
Note! Required flag is default set to [true]
TypeBoolean or expression returning a boolean value.
Valuestrue - Unit is required
Boolean - true (required)
Defaulttrue;
ExampleBoolean
Expression
required = [PlannedDate != null];

unitselector

DescriptionSpecifies the selector which hold the unit values fetched from the unit lookup (required when the unit is editable).
TypeBoolean or expression returning a boolean value.
ValuesIf false, both the value and the unit are read-only. This can also be set in the projection on the value attribute.
Defaulttrue
ExampleBoolean
Expression
editable = [expression];

unitvisible

DescriptionSpecifies if the unit is visible or hidden.
TypeBoolean or expression returning a boolean value.
Valuestrue - Unit is visible
The unit is always hidden if the value is null.
Expression - Flag Condition (see example)
Defaulttrue
ExampleBoolean
Expression
To make several currency values visible:
unitvisible = [MultipleCurrencies]; (Hide currency unless the multiple currencies are used.)

valid

Assistant - Steps

DescriptionDetermines if the data entered in the step is valid or not.
TypeBoolean or an expression returning a boolean
ValuesBoolean: [true]
Default[true]
ExampleBoolean: valid = [true];
Expression: valid = [Attribute != Value];

validate

Free text field/LOV

DescriptionSpecifies the focusout command for the LOV.
Type
Values
DefaultNone.
ExampleSee "Example code - Validate property" below.
validate command UpdateCounter;
lov MySpecialValue {  
      validate command {  
         execute {  
   call GetCounterValue(MySpecialValue) into CounterValue;  
         }  
      }  
   }  

Example code - Validate property

Radio button

DescriptionSpecifies the focusout command for the radio buttons (radio group).
TypeCommand
ValuesCommand name
DefaultNone.
ExampleSee "Example code - Validate property" below.
validate command UpdateCounter;
radiogroup MySpecialValue {  
      validate command {  
         execute {  
   call GetCounterValue(MySpecialValue) into CounterValue;  
         }  
      }  
   }  

Example code - Validate property

validatecommand

DescriptionSpecifies the focusout command for the currency/measure control.
TypeCommand script
ValuesBehaviour defined in script
DefaultNone.
ExampleSee "Example code - Validate property" below, which pops up an alert when the value is greater than 10 (the same goes for the measure field).
validate command UpdateCounter;
currency EntryFee(CurrencyCode) {  
    unitlookup IsoCurrencyEntitySet(CurrencyCode);  
    unitselector IsoCurrencySelector;   
���validate command {  
�� ���execute {  
�� ������if [Amount > 10] {  
�� ���������alert("Amount greater than 10");  
�� ������}  
����� }  
}  

Example code - Validate property

value

Progress field

DescriptionSpecifies the value of each stacked part (value block) of the progress field.
Type
Values
DefaultNone
ExampleRefer to Progress field control, section How to use - Setting the appropriate properties for the progress field, to define a value for each stacked part progress field with an attribute.

Computed field

DescriptionSpecifies a string interpolation value, or calculates a numerical expression.
TypeString
ValuesAny given string or numerical expression (in strings).
DefaultNone
ExampleString:
Numerial expression:
The example shows aggregate functions on child records of a record.
Available aggregate functions are: sum, avg, min, max and count.

valuelabel

Progress field

DescriptionSpecifies the value label that appears on each stacked part of the progress field.
Type
ValuesPercentage, absolute value or string.
DefaultNone
Examplevaluelabel = ValueLabelAttribute;

variable

Command

DescriptionSpecifies a variable that can be set, and used within the execution of a command.
TypeEnumeration
Values
DefaultNone.
Examplevariable IndexidVar;

view

Calendar

DescriptionThe view property is used to define views in the calendar control.
TypeConstant
ValuesDay - The calendar is shown one day at a time, with or without time slots (based on if the events are all day events or not). An all day slot is always included in this view.
Week - The calendar is shown one week at a time, with or without time slots (based on if the events are all day events or not). An all day slot is always included in this view.






TimelineMonth - The calendar is shown one month at a time, with time slots spanning horizontally.
DefaultNone
Exampleview WorkWeek;

visible

DescriptionDetermines the visibility of a control. In addition to using boolean values, the visibility can also be defined using expressions that return a boolean value.
If using an expression the conditions will be checked against the record loaded in the page, therefore the attributes used for the condition must be from the entity of the page.
TypeBoolean or expression returning a boolean value
ValuesBoolean - true
Defaulttrue
Used inAddress Field, Date Range Field, Date Time Picker, Item Picker, List, Pie Chart, Process Viewer, Signature
ExampleBoolean - visibility = [false];
Expression - visible = [ActivityType = "ActivityWithRepresentative"];

Assistant - Steps

DescriptionDetermines if the step should be visible. If set to false, the step will be hidden from the step indicator as well.
TypeBoolean or an expression returning a boolean
ValuesBoolean: [true]
Default[true]
ExampleBoolean: visible = [true];
Expression: visible = [Attribute != Value];

Badge

DescriptionSpecifies the visibility of the badge.
TypeBoolean or expression returning a boolean value
Valuestrue - Badge is visible
Boolean - true (visible)
Defaulttrue
ExampleBoolean
Expression
visible = [TeamType != null];

Bar chart

DescriptionDetermines the visibility of the bar chart control. In addition to using boolean values, the visibility can also be defined using expressions that return a boolean value.
If using an expression the conditions will be checked against the record loaded in the page, therefore the attributes used for the condition must be from the entity of the page.
TypeBoolean or expression returning a boolean value
ValuesBoolean - true
Defaulttrue
ExampleBoolean - visibility = [false];
Expression - visible = [ActivityType = "ActivityWithRepresentative"];

Command

DescriptionSpecifies the visibility of the command by an expression based on the selected record(s).
TypeBoolean or expression returning a boolean value
Valuestrue - Command is visible
Boolean - true (visible)
Defaulttrue
ExampleBoolean
Expression
visible = [TeamType != null];

Computed field

DescriptionSpecifies the visibility of the computed field.
TypeBoolean or expression returning a boolean value.
ValuesBoolean - true (visible)
Default[true]
ExampleBoolean
Expression
visible = [TeamType != null];

Currency/Measure

DescriptionSpecifies the visibility of the currency/measure client control.
TypeBoolean or expression returning a boolean value.
ValuesBoolean - true (visible)
Default[true]
ExampleBoolean
Expression
visible = [TeamType != null];

Free text field/LOV

DescriptionSpecifies the visibility of the LOV.
TypeBoolean or expression returning a boolean value.
Valuestrue - LOV is visible
Boolean - true (visible)
Defaulttrue
ExampleBoolean
Expression
visible = [TeamType != null];

Funnel chart

DescriptionDetermines the visibility of the funnel chart control. In addition to using boolean values, the visibility can also be defined using expressions that return a boolean value.
If using an expression the conditions will be checked against the record loaded in the page, therefore the attributes used for the condition must be from the entity of the page.
TypeBoolean or expression returning a boolean value
ValuesBoolean - true
Defaulttrue
ExampleBoolean - visibility = [false];
Expression - visible = [ActivityType = "ActivityWithRepresentative"];

Line chart

DescriptionDetermines the visibility of the line chart control. In addition to using boolean values, the visibility can also be defined using expressions that return a boolean value.
If using an expression the conditions will be checked against the record loaded in the page, therefore the attributes used for the condition must be from the entity of the page.
TypeBoolean or expression returning a boolean value
ValuesBoolean - true
Defaulttrue
ExampleBoolean - visibility = [false];
Expression - visible = [ActivityType = "ActivityWithRepresentative"];

Markdown text

DescriptionSpecifies the visibility of the markdown text
Typeboolean
Valuestrue
Defaulttrue
Examplevisible = [true];

Progress field

DescriptionSpecifies the visibility of the progress field.
TypeBoolean or expression returning a boolean value
Valuestrue - Badge is visible
Boolean - true (visible)
Defaulttrue
ExampleBoolean
Expression
visible = [TeamType != null];

Radio button

DescriptionSpecifies the visibility of the radio buttons (radio group).
TypeBoolean or expression returning a boolean value
Valuestrue - Radio buttons (radio group) is visible
Boolean - true (visible)
Defaulttrue
ExampleBoolean
Expression
visible = [TeamType != null];

Tree (tree node only)

DescriptionSets the visibility of the current node based on the selected navigational context
TypeExpression
ValuesExpression of navigational context reference(s)
DefaultAvailable for all navigational contexts
Examplevisible = [Material or Installation];

visibility

DescriptionUsed to control when the sheet will be drawn on the card
TypeExpression
ValuesAn expression
Example[${<attribute>} = ""]

weeknumbers

Calendar

DescriptionDetermines whether week numbers are displayed in the calendar.
TypeBoolean
Valuestrue
Defaulttrue
Exampleweeknumbers = [false];

weekstart

Calendar

DescriptionThe property indicates the day to start the week. Ex: Mon, Tue, Wed, etc...
TypeVariable
Valuesvariable contains an attribute
DefaultNone
Exampleweekstart = StartOfWeek;

workdayend

Calendar

DescriptionThis property is used if corresponding schedule information is fetched and displayed in the calendar, based on the selected item in the page data source. The attribute indicating the end time of the scheduled work period.
TypeVariable
Valuesvariable contains an attribute
DefaultNone
Exampleworkdayend = WorkDayEnd;

workdaystart

Calendar

DescriptionThis property is used if corresponding schedule information is fetched and displayed in the calendar, based on the selected item in the page data source. The attribute indicating the start time of the scheduled work period.
TypeVariable
Valuesvariable contains an attribute
DefaultNone
Exampleworkdaystart = WorkDayStart;

zoomlevel

Gantt chart

DescriptionUsed to define the various timescale zooming levels available to the end user
TypeComma separated list of pre-define values
ValuesYear/Month/Day/Hour
Examplezoomlevels(Year, Month, Day, Hour);

1. ganttchart reference

[label]

DescriptionUsed as the title of the Gantt chart. It is also possible to set the title through a variable. For example, if the Gantt chart is a child element, attributes from the entity which the parent element is based on can be added to the label as a variable and it will assign the relevant value from the parent record at runtime.
TypeString
ValuesString or string containing variables
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a list for ${parent.attribute}";

[collapsed]

DescriptionDetermines if the Gantt chart control is collapsed or expanded when displayed to the user.
TypeBoolean
Valuestrue
Defaultfalse
Examplecollapsed = [true];

[filter]

DescriptionDetermines the filtering condition that should be applied to the records displayed in the Gantt chart. For the filter conditions, values from the current record of the page and search context can be used.
TypeExpression - Query Condition (see example below)
ValuesQuery Condition
DefaultNone
ExampleCurrent record of a page - filter = [LineCompany = Company];

Where values of PlanStart attribute in the Gantt chart is equal to the FromDate attribute of the search context of the page

2. ganttchart

[label]

DescriptionUsed as the title of the Gantt chart. It is also possible to set the title through a variable. For example, if the Gantt chart is a child element, attributes from the entity which the parent element is based on can be added to the label as a variable and it will assign the relevant value from the parent record at runtime.
TypeString
ValuesString or string containing variables
ExampleLabel with text only - label = "This is a title";
Label with a variable - label = "This is a list for ${parent.attribute}";

[zoomlevel]

DescriptionUsed to define the various timescale zooming levels available to the end user
TypeComma separated list of pre-define values
ValuesYear/Month/Day/Hour
Examplezoomlevels(Year, Month, Day, Hour);

[snaptime]

Descriptiona parameter that governs the time intervals that an activity is moved when the user drags it in time and re-plans it. This is used to set the default snaptime.
TypeNumeric value which represents minutes or free movements
Values�Free�, �1�, �5�, �10�, �15�, �30�, �60�
Examplesnaptime = 10;

[height]

DescriptionUsed to define the height of the Gantt chart
TypePre-define string value
Valuessmall/medium/large

[currenttime]

DescriptionUsed to call a DB function that returns the current time of the Gantt chart
TypeString
ValuesDB function name

[datagrid]

DescriptionUsed to add ganttcolumns to the Gantt chart to show in data table. The columns must be attributes of the Gantt chart entity.
TypeObject
Valuescollection of ganttcolumn objects and an optional reference to a card
Exampledatagrid {
label = "Project Id";
ganttcolumn Name;
}

[ganttchartitem]

DescriptionReference to the object that defines the start and end time of each Gantt item for each Gantt row
TypeReference object
ValuesName of ganttchartitem passing record array to populate items from
Exampleganttchartitem ProjectItem(ProjectItemArray);

[ganttchartrow]

DescriptionReference to the object that defines the sub-level
TypeReference object
ValuesName of ganttchartrow passing record array to populate rows from
Exampleganttchartrow SubProjectRow(SubProjectArray);

[scheduleid]

DescriptionAttribute in the entity that stores the calanderId used to fetch scheduled information.
TypeString
ValuesAttribute in entity
Examplescheduleid CalendarId;

[ganttchartschedule]

DescriptionRefers to an schedule object that defines where schedule data is fetch and how it is defined.
TypeReference object
ValuesGanttChartSchedule Reference
Exampleganttchartschedule ProjectWorkTimeCalendar(WorkingTimeArray);

[ganttcharttimemarker]

DescriptionRefers to an timemarker object that defines where timemarker data is fetch and how it is defined.
TypeReference object
ValuesGanttChartTimemarker Reference
Exampleganttcharttimemarker ActivityLateDatesTimemarker(ActivityLateDates);

[timerange]

DescriptionFunction with optional parameters to fetch start and end date
TypeString
ValuesFunction reference
Exampletimerange = GetTimerangeFromData();

3. ganttchartitem

[starttime]

DescriptionDefines which entity attribute holds the Gantt item start time.
TypeString
ValuesAttribute in entity
Examplestarttime EarlyStart;

[endtime]

DescriptionDefines which entity attribute holds the Gantt item end time.
TypeString
ValuesAttribute in entity
Exampleendtime EarlyFinish;

[card]

DescriptionConnects a standard card to the Gantt item. The card is used to show additional information and actions that can be performed on the item
TypeString
ValuesCardReferences
Examplecard ActivityCard;

[ganttchartitemstyle]

DescriptionOne or more styles that can be applied to a Gantt item. At a time only one style will be applied.
TypeObject
ValuesConditional GanttChartItemStyleReference
Exampleganttchartitemstyle ActivityGanttStyle = [TotalFloat != 0];
or
ganttchartitemstyle MilestoneActivityGanttStyle = [true];

[ganttfield]

DescriptionOne or more entity attributes that can be used to show minimum text inside the Gantt item bar. What is seen depends solely on the size of the bar. A lot of text should not be added here. Instead a card should be connected to show more details.
TypeString
ValuesEntity attribute
Exampleganttfield ActivityNo;

[ganttdependency]

DescriptionUsed to fetch and draw dependencies between Gantt items
TypeString
ValuesGanttChartDependencyReference
Exampleganttdependency GanttActivityDependency(ActivityDependencyArray);

[create command]

DescriptionThe command that is called when creating a new item
TypeObject
Valuescommand

[resize command]

DescriptionThe command that is called when resizing an item
TypeObject
Valuescommand

[move command]

DescriptionThe command that is called when moving an item from one row to another
TypeObject
Valuescommand

[delete command]

DescriptionThe command that is called when deleting an item
TypeObject
Valuescommand

[edit command]

DescriptionThe command that is called when editing item
TypeObject
Valuescommand

4. ganttchartrow

[datagrid]

DescriptionUsed to add ganttcolumns to the Gantt chart row to show in data table. The columns must be attributes of the Gantt chart row [entity][].
TypeObject
Valuescollection of ganttcolumn objects and an optional reference to a card
Exampledatagrid {
label = "Project Id";
ganttcolumn Description;
}

[ganttchartitem]

DescriptionReference to the object that defines the start and end time of each Gantt item for each Gantt row
TypeReference object
ValuesName of ganttchartitem passing record array to populate items from
Exampleganttchartitem SubProjectItem(SubProjectItemArray);

[ganttchartrow]

DescriptionReference to the object that defines the sub-level
TypeReference object
ValuesName of ganttchartrow passing record array to populate rows from
Exampleganttchartrow ActivityRow(ActivityArray);

[scheduleid]

DescriptionAttribute in the entity that stores the calanderId used to fetch scheduled information.
TypeString
ValuesAttribute in entity
Examplescheduleid CalendarId;

[ganttchartschedule]

DescriptionRefers to an schedule object that defines where schedule data is fetch and how it is defined.
TypeReference object
ValuesGanttChartSchedule Reference
Exampleganttchartschedule ProjectWorkTimeCalendar(WorkingTimeArray);

[orderby]

DescriptionDetermines the default order the Gantt chart root nodes should be displayed in.
TypeDataItemReference
ValuesComma separated DataItemReferences. You can optionally set the sort order using the keywords asc and desc.
DefaultDataItemReference asc
ExampleOrder rows without sorting -

orderby = ActivityType, MainRepresentativeId desc;

5. ganttchartitemstyle

[label]

DescriptionUsed as the title of the style. This will be displayed in the legend.
TypeString
ValuesString
Examplelabel = "Critical Activity";

[shape]

DescriptionOne of a predefined set of shapes. These shapes can be used to denote different types of items. Example, normal items, milestones, buffer times etc.
TypeString
Valuesdefault/schedule/icon/bracket/diamond/buffer
Exampleshape = default;

[emphasis]

DescriptionUsed to color the Gantt item differently.
TypeString
ValuesA value from default emphasis palette.
Exampleemphasis = Primary;

[icon]

DescriptionUsed in conjunction with shape type icon.
TypeString
ValuesAn icon from the icon library.
Exampleicon = "document-cart";

6. ganttchartschedule

[scheduleid]

DescriptionKey column for each calendar must be assigned this.
TypeString
ValuesAttribute in entity.
Examplescheduleid CalendarId;

[schedulestart]

DescriptionStart time of each shift.
TypeString
ValuesAttribute in entity.
Exampleschedulestart FromTime;

[scheduleend]

DescriptionEnd time of each shift.
TypeString
ValuesAttribute in entity.
Examplescheduleend ToTime;

[ganttchartitemstyle]

DescriptionEmphasis color can be set depending on a condition.
TypeObject
ValuesConditional GanttChartItemStyleReference.
Exampleganttchartitemstyle OvertimeStyle = [true];

7. ganttchartlegend

[legendgroup]

DescriptionGrouping which contains item styles.
TypeObject
ValuesString
Examplelegendgroup ItemLegendGroup {}

[label]

DescriptionLabel of the group.
TypeString
ValuesString
Examplelabel = "Items";

[collapsed]

DescriptionSet group collapsed depending on a condition.
TypeString
Valuesboolean.
Examplecollapsed = [true];

[ganttchartitemstyle]

DescriptionRefers to a itemstyle defined.
TypeString
ValuesString.
Exampleganttchartitemstyle ProjectSummaryStyle;

[ganttchartrowicon]

DescriptionRefers to a row icon defined.
TypeString
ValuesString.
Exampleganttchartrowicon ProjectRowIcon;

8. ganttdependency

[dependencytype]

DescriptionPredefined set of values which set the connection type.
TypeString
ValuesStartToStart/StartToFinish/FinishToStart/FinishToFinish.
Exampledependencytype StartToStart = [DependencyType = "StartToStart"];

[fromitem]

DescriptionId of the predecessor item.
TypeString
ValuesVariable in a string.
Examplefromitem = "${PredecessorActivitySeq}";

[toitem]

DescriptionId of the sucessor item.
TypeString
ValuesVariable in a string.
Exampletoitem = "${SuccessorActivitySeq}";

9. ganttcharttimemarker

[label]

DescriptionUsed as the title of the timemarker. This will be displayed in the legend.
TypeString
ValuesString
Examplelabel = "Project Constraints";

[starttime]

DescriptionDefines which entity attribute holds the Gantt timemarker start time.
TypeString
ValuesAttribute in entity.
Examplestarttime LateStart;

[endtime]

DescriptionDefines which entity attribute holds the Gantt timemarker end time.
TypeString
ValuesAttribute in entity.
Exampleendtime LateFinish;

[emphasis]

DescriptionUsed to color the Gantt timemarker differently.
TypeString
ValuesA value from default emphasis pallet.
Exampleemphasis = Complementary8