[Source] Attributes

Binding Field

Binding Field

lookupkeyvaluebinding

Field of the Datasource of the form where the Saved Field will be saved

SwatDataField

Maybe we can remove it and handle it automatically

Entity Name

DataSource

entityname

Datasource of the Select that is used to populate the entries in the list

DataSoruce

Entity Table

DataSource Table

entitytable

Table of the Datasource of the Select that will be used to populate the entries in the list (When the Datasource has just one table, this attribute does not need to be set)

Table

With one we also need to specify one

Key Value

Saved Field

lookupkeyvaluecolumn

Field of the Datasource of the Select that will be saved when an entry is selected

SwatDataField

Select with fields of the selected DSO

UI Key Field

UI Field

lookupkeyfield

Field of the Datasource of the Select that will be displayed in the input when an entry is selected

SwatDataField

Select with fields of the selected DSO

List of Options

Static List

listitempairs

Comma separated list of keys and values, if this attribute is set, the list will be used for the data of the component

Coma separated list

Use a DSO also for static lists

Max. Items Selected

Max. Items Selected

maximumselectionlength

Maximum number of entries that can be selected in the list

Number

Min. Items Selected

Min. Items Selected

minimuminputlength

Minimum number of characters required to start a search.

Number

Template

List Design

template

Name of the design that will be used to render the results of the list. Check Documentation for more information of each option

genericautocompletesearchtemplatedynselect_checkbox, GenericAutocompleteSearchTemplateDynSelect, GridFilterDynselectSearchTemplate, GenericAutocompleteSearchTemplate, GenericAutocompleteSearchTemplateDynSelect_line

We need to create a select

Template Options

List Design Fields

templateoptions

Name of the fields and/or constant values that will used for the icon, key and description in the template. (They need to be defined in that order with the | separator)

List with | separator (Icon | key | description)

Allow Clear

Allow Clear

allowclear

If enabled, the selected entries can be cleared with a button

Boolean

Allow Multiple Selects

Allow Multiple Items Selected

multiple

If enabled, multiple entries can be selected in the list

Boolean

Close on Select

Close on Select

closeonselect

If enabled, once the user selects an entry, the list will be closed

Boolean

Filter

Grid Filter Behaviour

filter

When this select is added to a grid as a column, it defines how the filter of that grid will behave. Check Documentation for more information of each option

#multiselect_filter, #dynselect_filter

How to handle the attributes that are just for grids (or forms)

Initial Fetch

Initial Fetch

initialfetch

Query that will filter the result of entries in the list the first time is opened. Check Documentation for more information of how to create the queries

initFetch:All (1000 records, default is 50)

Lookup Screen

Search Dialog Screen

axlookupdialog

Screen that will be opened in a dialog to facilitate the selection of an entry

Screen

Multiple Behavior

Grid Multiple Items Behaviour

multiplebehavior

When the select is added to a grid, it specified to what elements the “Allow Multiple Items Selected” attribute is applied. Check Documentation for more information of each option

standard, cell, filter+cell

We need to create the select. If Filter it only applies to the filter field, if Cell it only applies to the grid cells, if Filter & Cell it applies to both elements

Rows to batch

Rows to Batch

rowstobatch

Number of entries that will be loaded from the DSO in the list of entries (also when you search) Setting this attribute to 0 indicates that ALL records should be read

Number

Sort

Field Sort

defaultsort

Ascendent (asc) or descendent (desc) sort based on a field (E.g. asc fieldname)

asc/des fieldname

Info Button

Help Icon

infobutton

If eneabled the tooltip icon will be displayed

Boolean

When Help is set or or eventinfoselected is set we enable this

Initial Value

Initial Value

initialvalue

Key of an entry in the Datasource to set that entry as the initial value of the field

value

Label

Label

label

Label of the Input

Text

Label Position

Label Position

labelPosition

Location of the label in relation to the input

Left, Top

Mandatory

Mandatory Field

mandatory

If enabled, this field will be mandatory in the form that is added

Boolean

Note Below Field

Note Below Field

note

Text that will be displayed under the Field, it can be used as hints or help indications

Text

Placeholder

Placeholder

placeholder

Text displayed in the input until the user starts writing or selects an option

Boolean

Track Changes

Track Changes

haschangestrackingenabled

If enabled, the changes on this field will trigger the HasChanges in the form where this field is added

Boolean

Validation

Validation

validation

Validation can be used to define validation rules that display messages under a Form Field input

Text

it needs to be usable (it is not now except osiv) https://docs.dhtmlx.com/form__validation.html#validationevents

Not dhtml

AfterKeyPress

After KeyPress

eventafterkeypress

Event executed when the user types in the list filter

Event

AfterSearchResultDisplay

After SearchResultDisplay

eventaftersearchresultdisplay

Event executed when the results are displayed in the dropdown

Event

BeforeFetch

Before Fetch

eventBeforeFetch

Event executed before fetching the data for the list of options

Event

Namespace

Namespace

eventnamespace

Namespace of the clientlogic where you logic will be available and implemented

Event

On change Event

On Change

onchange

Event executed when the user produce a change (when you type and when you select)

Event

On Validate

On Validate

eventakvalidate

Event executed whenever an entry is selected in the list

Event

Inconsistent with other events (in other fields is when you focus out)

OnEntry

On Entry

evententry

Event executed when the field get focus

Event

It is not used - Remove?

OnLeave

On Leave

eventleave

Event executed when the field loses focus

Event

It is not used - Remove?

OnStateChanged

On StateChanged

eventonstatechanged

Event executed when a state is changed through clientlogic

Event

OnInfoSelected

On Info Selected

eventoninfoselected

Event executed when the info button is clicked

Event

COnsider this if we want to remove the infoButton

Cache Results

Cache Results

cacheresults

If enabled, the results will be cached for future searches

Boolean

Column Position

-

column

-

Number

It is being calculated, is not visible

It is calculated, we need to hide it

Controls

Form Fields Linked

lookupcontrols

Fields from the form where this Select is added, that when an option is selected the fields values set in this attribute will be updated with the fields set in the Source for Form Fields Linked attribute (The order will define the link between the fields of this attribute and the fields in Source for Form Fields Linked Attribute)

SwatDataFields comma separated list

Lookup Fields

Source for Form Fields Linked

lookupfields

Fields of the datasource of the dynselect that will be used in the Form Fields Linked

SwatDataFields comma separated list

Delay

Delay for Request

delay

Delay for making the request to load the result, this is useful to wait for the user inputs

Number

Description Delimiter

Multiple Items Delimiter

multidelimiter

Specifies the delimiter used for multiple selections. Comma by default. It Has to match the delimiter used on the backend.

Text

Refresh On Filter Change

Refresh Grid On Change

autorefreshonfilterchange

When this select is added to a grid as a column, If enabled, When the selects filter has a change, the grid will be refreshed

Boolean

Empty Value

Clear Value

emptyvalue

When the select is cleared, this will be used as the “empty” value. It can be null, undefined or “”

Text

Enabled

Enabled

enabled

If disabled, the field will be read only and the value in the input cannot be changed

Boolean

Height

Vertical Slots Filled

height

Number of Vertical Slots that this field will fill in the form that is added

Number

Labels

-

labels

-

Boolean

It needs to be transformed to a checkbox

Not useful

Option Label

-

fieldlabel

-

Not used

List Items

-

listitems

-

Remove it, now maybe it’s calculated

Multiple Entries Behavior

-

multipleentriesbehavior

-

Trim

This Select needs to be created

Not used

PreSelectedExistingInput

Preset Value in Search

preselectexistinginput

If enabled, the value of the field will be preset in the search input of the list

Boolean

Row Position

-

row

-

Number

It is being calculated, is not visible

It is calculated, we need to hide it

Tab Index

Tab Navigation Index

tabindex

Order in the tab navigation of the form where this Select is added

Numbber

Tags

Allow Custom Values

tags

If enabled, allows to provide a value that does not exist in the list of entries

Boolean

TokenSeparator

Selected Item Trigger

tokenseparators

Character to allow the user to select an entry and start adding the next one

Pipe-delimited list -> e.g ‘tokenSeparators’: ‘,| ‘

Visible

Visible

visible

If false, the field will not be visible in the form that is added

Boolean

Width

Horizontal Slots Filled

width

Number of Horizontal Slots that this field will fill in the form that is added

Number

We need to adjust the attribute labels in forms for colummns → Horizontal slots

HELP

Tooltip Text

help

Text of the tooltip

Text

-

Field Label Menu

FIeldMenu

Menu to display actions next to the label of the field

Menu

Static List

lis-item-pairs

Comma separated list of keys and values. If this attribute is set, this list will be used for the data of the Component. (E.g. key1, value1, key2, value2, key3, value 3)

Comma Separated List

Result List Menu Code

ResultListMenuCode

Format Sign

formatSign

Label Menu

fieldMenu

Menu to display actions next to the label

OnStateChanged

On State Changed

eventOnStateChanged

Event executed when a state is changed through clientlogic

Event

EventSelect

On Select

EventSelect

Event executed when the user selects or unselect an entry

Event

EventRowSelected

On Row Selected

EventRowSelected

Event executed when the user single click in an entry

Event

EventRowChosen

On Row Chosen

EventRowChosen

Event executed when the user double click in an entry

Event

EventOnInitialize

On Intialize

eventOnInitialize

Event executed when the Grid is rendered

Event

eventOnDrop

On Drop

eventOnDrop

Event executed on a drop operation (Drag and drop Behaviour enabled)

Event

EventOnContextMenuIsOpen

On Context Menu Opened

EventOnContextMenuOpen

Event executed before the Context Menu of a row is opened

Event

EventBeforeSelected

Before Selected

eventBeforeSelected

Event executed before a row in the Grid is selected

Event

BeforeFetch

Before Fetch

eventBeforeFetch

Event

We should remove it

WIDTH-CHARS

WIDTH-CHARS

Number

We should hide it

Width

width

Initial width of the panel (if the user profile doesn’t have a value set)

Number

Update Record Container

updateRecordContainer

Screen

Check with Mike why we need this

SUBTYPE

subtype

Not used, we can hide it

showZeroAsEmtpy

showZeroAsEmtpy

If enabled, the cells with zero values will be displayed as empty

Boolean

It needs to be converted to a checkbox

Rows

rows

Number

Not used, we should remove it

Row Position

row

Number

It is being calculated, is not visible

It is calculated, we need to hide it

Record Create

RecordCreate

Screen

Check with Mike if we can hide it

MinWidth

minWidth

Minimum width in pixels that the panel can be resized

Number

MinHeight

minHeight

Minimum height in pixels that the panel can be resized

Number

minDimension

minDimension

If its disabled the values MinHeight and MinWidth will be ignored

Boolean

maxColumnCharacters

Maximum Column Characters

maxColumnCharacters

Maximum number of characters that will be displayed in each column of a row. This can useful for cases where there are long strings in a specific column which will cause very high rows (In multiline mode) or very wide columns (No multiline mode)

Number

We should check it to see if we can bring it back (not used now)

keepSelection

Keep Selections

keepSelection

If enabled, the rows selected will be maintained after a reload in the grid

Boolean

instanceRestrictions

instanceRestrictions

Cando pattern that restrict instance name objects that will be rendered

Cando Pattern

hideHeader

hideHeader

If enabled (and no border title or panel menu is set) the panel header will be hidden

Boolean

groupBy

groupBy

It is used to group the entries into different clusters (See documentation for more info)

Text

https://jira-build-one.atlassian.net/browse/SWAT-8581

Folder Window to Launch

FolderWindowToLaunch

Screen that is launched when an entry is clicked (if updaterecordcontainer is not set, otherwise that one will be used for this case)

Screen

fixWidth

fixwidth

If enabled the width of the panel cannot resized

Boolean

fixHeight

fixheight

If enabled the height of the panel cannot resized

Boolean

filterOnLeave

filterOnLeave

If enabled the filters are trigger when the user leave focus of the filter input

Boolean

Filter Mode

filterMode

If server it performs the search on the backend if client it performs it in the frontend

Server, Client

Entries Links

usageBehaviour

Specifies if the row titles are links that open screens or not

Link, No Link

Entity Name

Entity Name

Entity of the connected DSO that will be displayed in the Grid (If only one Entity exists in the DSO, there is no need to set anything in this attribute)

Enabled

Enabled

enabled

If enabled, it allows to edit the entries in each Grid cell

Boolean

documentationPath

documentationpath

If a link is set, an icon will be displayed in the panel header that when clicked, it will open that link. It can be used for documentation proposes

Text (Link address)

customStyle

customStyle

Value for the HTML akStyle attribute when rendered, it can be used to style this component

Text

Copy Record Container

copyRecordContainer

Screen that is launched in a dialog to copy an entry

Check with Mike if we can remove it

Context Menu

Row Context Menu

contextMenu

Menu that will be displayed as a Context Menu in each individual row while it’s hovered

Menu

batchingMode

bachingmode

If enables the pagination in the Grid

Boolean

AutoFocus

Auto Focus

autofocus

If enabled, the Grid will be automatically focused on after a data refresh

Boolean

addRecordContainer

addrecordcontainer

Screen that is launched in a dialog to create a new entry

Screen

Check with Mike if we can hide it

Layout Position

Layout Position

Layout Position

Position where this object will be in the layout

Layout positions

Track Changes

haschangestrackingeneabled

If enabled, the changes on this Grid will trigger the HasChanges in the Panel where it is added

Boolean

titleHeader

titleheader

if none, it hides the header, if parent, it shows the header of the parent, if parentonly it only shows the header of the parent

Text

https://jira-build-one.atlassian.net/browse/SWAT-656

Show Grid Filter

showGridFilter

All, None, Column Only

It needs to be checked how to work with it

Resource

resourceName

We should remove it

Panel Menu

Panel Menu

panelMenu

Menu that will be displayed next to the Panel title in the Panel Header

Menu

multiSelect

Multiple Select

multiselect

If enabled multiple rows can be selected

Boolean

Multiline

Multiline

multiline

If enabled, rows can wrap to use multiple lines

Boolean

Floating Action Button

Floating Action Button Menu

floatingActionButton

Menu that will be displayed as a Floating Action Button over the Grid

Menu

Drag and Drop Behaviour

Drag and Drop Behaviour

dragDropBehaviour

Disable, doesn’t enable the drag and drop. If “Move” it removes the entry in the source, if copy it keeps it

Disabled, Copy on Drop, Move on Drop

BorderTitle

Panel Title

bordertitle

Text that is displayed in the Panel header of this Object

Text

OnStateChange

On State Change

OnStateChanged

Event executed when a state of this object is changed through client logic

Event

EventPreInitialize

EventPreInitialize

Event executed before the object is initialised (before EventSyncOnInitialize)

Event

typeRange

typeRange

Ignore in dialogs

tabindex

tabindex

Ignore in dialogs

PrivateData

PrivateData

Not used

ID

Test ID

akid

Value for the HTML akid attribute when rendered, it can be used to identify this component in testing

Text

Design Placeholder

Template Placeholder

designplaceholder

If enabled, the object will be used as a placeholder in tempaltes

Boolean

They should be hidden evrywhere

Design Placeholder Options

Template Placeholder Options

designplaceholderoptions

Options for the use of this object as placeholder in templates

Text

They should be hidden evrywhere

Track Changes

Track Changes

haschangestrackingenabled

If enabled, the changes on this object will trigger the HasChanges in the object where this one is added

Boolean

Rules Behaviour

Rules Behaviour

rulesbehavior

Serialized json that is generated and assigned automatically to describe the behaviour/interaction with Corticon.js

Serialized json

UIComponentAlias

Component Alias

uicomponentalias

Alias for the component to be accessible trough client logic

Text

UiComponent

Component Path

uicomponent

Path to the component that will be lazy loaded

Text

hasChangesStyle

hasChangesStyle

Value for the HTML akHasChanges attribute when rendered, it can be used to style this component when it has changes

Text

EventSyncOnInitialize

EventSyncOnInitialize

Event executed when this object is initialised without delay

EventOnClose

On Close

EventOnClose

Event executed when this object is closed

Event

Title Short

Taskbar TItle

titleshort

Text that will be displayed in the taskbar item that represent this Window. If empty the Window Title will be used. You can use placeholders from the primaryDSO

Text

Title

Window Title

title

Text that will be displayed in the Window header. You can use placeholders from the primaryDSO

Text

RulesMetadata

(ASK ANDREI)

instanceRestrictions

instanceRestrictions

Cando pattern that restrict instance name objects that will be rendered

HtmlClass

htmlclass

Css class that is added to the HTML class attribute of the element

Text

Check if we need it

Has Error Style

haserrorsstyle

Value for the HTML akHasErrors attribute when rendered, it can be used to style this component when it has errors

Text

Floating

Pin Window

floating

If enabled, the Window will stay on top of other windows until closed

Boolean

ClosingBehaviour

ClosingBehaviour

It defines if when the window is closed it goes back to desktop or to the previously selected taskbar item

returnToDesktop, “”

Layout

Layout

LayoutOptions

It defines the Layout that is the structure that defines how many panels are in the Screen and how they are positioned

Layout Structure

Window Menu

Window Menu

TitleMenu

Menu that will be displayed in Window Header.

Menu

isModal

Is Modal

isModal

If enabled, the Window will act as a Modal Window (All UI elements outside the Window will be blocked)

Boolean

Icon

Window Icon

icon

Icon that will be displayed next to the Window Title in the Window header

FontAwesome Icon

On Initialize

On Initialize

EventOnInitialze

Event executed when this object is initialised (it has a delay)

Event

customStyle

customStyle

Value for the HTML akStyle attribute when rendered, it can be used to style this component

Text