Tersus: Model Properties

Model PropertiesDate: Feb 12, 2014Tags:HelpShared PropertiesShared properties are saved in the context of the model and apply to all instances of the same model.

Property

Meaning

Valid Values

Applicable to

Comments

authenticationMethod

Specify whether simple tomcat-based authentication is to be used

'None' / 'JDBC' / 'NTLM'

Root system

Applies only when using the studio's embedded server, and can be overridden in Configuration.XML
If set to JDBC/NTLM, implements the relevant simple tomcat authentication method, against the database/directory.
If set to None simple tomcat authentication will not be used, and you'll need to implement your own, modeled authentication.
If not value is specified, the authentication method is determined by checking the model hierarchy for the existence of a Database Record referencing the User_Roles table, and if found JDBC is assumed.

clientSideDatabase

Execute database plugins in server or client context

'server' / 'local'

Root system

When local, database plugins which are modeled in a client side process are executed on the client against a client-side database (available in certain browsers, currently Safari and Chrome). Plugins in a server side process are executed against the database server.
When server, all database plugins regardless of tier are executed on the server side.

dataSource

Alternative data source

A data source defined in the application’s “Configuration.xml” / context file

Database record

Overrides the default data source (jdbc/Main) for all database plugins referencing this record, and the Import Structure from Database wizard

Top-level services

Overrides the Main data source used in transactions issued by the service (see here)

format

Display/serialization format

Depends on data type

Atomic data types

For dates, see Java's SimpleDateFormat for details on the supported formats

javascript.constructor

Constructor used to create client side instances of a model

Name of a Javascript class

Any client side model

If missing, the value from the plug-in descriptor is used Deprecated

maxLength

Maximal number of data characters

Integer number

Atomic data types

Defines number of characters that can be stored (compare with html.maxLength) Deprecated

oldCssExclude

Exclude old (primarily non-mobile) platform CSS

'all' / 'mobile'

Root system

When all, old platform CSS is excluded (this is primarily non-mobile oriented CSS which can be found in the 'old' sub-folder of the platform's 'style' folder).
When mobile, old CSS is excluded from <Mobile View> but included in <Desktop View>.
When not-specified old CSS is included in all views.

requiredPermission

Name of a permission

Free Text

Any model

Only users with this permission will be able to see/use the model (see Authorization Module)

serviceTimeout

Maximal time to run (in seconds)

Integer number

Top-level services

tableName

Name of table or view to which the record is mapped

According to database naming

Database Record

If missing, model name is used (after replacing each space by ‘_’)

tableType

Type of table to which the record is mapped

See MySQL documentation

Database Record

Relevant for MySQL only (and only if the ‘init_db’ parameter in the application’s “Configuration.xml” file is ‘true’)

value

Value of a constant

According to data type

Constants

html.adjustBottom

Causes the split pane to adjust its height so that the bottom matches the bottom of the screen

'true' / 'false'

Split Pane

html.adjustBottomMargin

Margin to keep from bottom of screen when adjusting height.

Number of pixels

Split Pane

The px unit is implicit, and should not be specified.

html.allowHTMLTags

Unless 'true', HTML tags are escaped in content text (<Value>)

'true' / 'false'

Text Display, Pane, Generic HTML Display

html.applicationTitle

Title application

Free text

Root system

If missing, model name of root system is used

html.borderWidth

The width of the outer border of the split pane

Number of pixels

Split Pane

The px unit is implicit, and should not be specified.

html.bottomPaneHeight

Height of the lower pane in a vertically split pane

Number of pixels

Vertically Split Pane

The px unit is implicit, and should not be specified.

html.caption

Caption text

Text

Label, Button, Checkbox, Radio Button, Checkbox, Table, Field (Mobile), Page

html.compactNavigationTabs

Display navigation tabs (perspectives and views) as needed

'true' / 'false'

Root system

If true, each user sees perspective and/or view tabs only if there is more than one perspective and/or view (in a given perspective) to display to that user.
If the user permissions limit the number of views in a given perspective to one, then view tabs in that perspective (appearing on top) are not displayed.
If the user permissions are such that all allowed views belong to a single perspective, then perspective tabs (appearing on the left or right side) are not displayed.

html.contentHeight

Height of scrollable content in a table (experimental)

HTML/CSS length units

Table

html.contentHeight

Height of content area in tabbed pane

HTML/CSS length units

Tabbed Pane

html.contentWidth

Width of scrollable content in a table (experimental)

HTML/CSS length units

Table

html.currencySymbol

Symbol to show as currency (e.g. '$')

Text

Number Display

html.customNavigation

Suppress the default navigation mechanism

'true' / 'false'

Root system

If true, each user sees the first permitted view, with no perspective and/or view tabs displayed. Navigation to other views must be explicitly modeled (e.g. using Display Actions/Switch View).

html.decimalPlaces

Number of decimal digits to display (-1 = no limit)

Integer

Number Display

html.height

Height of the display element

HTML / CSS length units

Most display elements

html.icon

Path to image

Text

Page

html.leftPaneWidth

The initial width of the left-side pane in a split pane

Number of pixels

Split Pane

The px unit is implicit, and should not be specified.

html.maxLength

Number of allowed characters

Integer

Input Fields

html.paddingWidth

Amount of padding inside the panes in a split pane

Number of pixels

Split Pane

The px unit is implicit, and should not be specified.

html.selectable

Indicates whether table rows should be selectable

'true' / 'false'

Table

html.size

Size of input field - maps to HTML size attribute

Number of characters

Input fields

html.showCaption

Indicates whether we show a caption for the table

'true' / 'false'

Table

html.showHeadings

Indicates whether we show column headings for a table

'true' / 'false'

Table

html.showPercentage

Show the number as percentage

'true' / 'false'

Number Display

html.sort

Activates sorting support on the table (arrow up / arrow down indicators on column headings , <Sort Order> data element, <On Sort> event handler)

'single' / 'multiple'

Table

html.src

Path to image

Text

Image

html.styleClass

CSS style class for the element (maps to HTML class attribute)

Text (space-separated list of style classe names)

Most display elements

html.targetWindow

Name of the target window. _blank always opens a new window. (see Javascript documentation )

Text (window name)

Popup

html.templatePath

Relative path to the HTML file that serves as a template

URL

Embedded HTML

html.templateURL

Relative path to the HTML file that serves as a template

URL

Popup / Dialog / Pop-in

Overrides the default platform template (popup.html for Popup, popin.html for Dialog/Pop-in - located in the server's root)

html.textDirection

Right to left or left to right

'rtl' / 'ltr'

Root system

If missing, left to right

html.textTranslation

Indicates whether the translation mechanism should apply to the element

'true' / 'false'

Most display elements

html.useThousandsSeparator

'true' / 'false'

Number Display

html.width

Width of the display element

HTML/CSS length units

Most display elements

html.windowHeight

Height of the pop-up or dialog

Number of pixels

Popup,Dialog

The px unit is implicit, and should not be specified.

html.windowOptions

Various window options - maps to window features passed to window.open - see Javascript documentation

Text

Popup

html.windowWidth

Width of the pop-up or dialog

Number of pixels

Popup,Dialog

The px unit is implicit, and should not be specified.

html.zebraTable

Adds alternating 'even' and 'odd' to the class of table rows to support 'zebra' style tables

'true' / 'false'

Table

html.wrapperStyleClasss

CSS style class for the display element's wrapper tag

Text (style class)

Most display elements

Deprecated

html.wrapperTag

An html tag that should wraps display element (will be replaced by wrapper_tags)

Text (html tag)

Most display elements

Deprecated

Local PropertiesLocal properties are saved in the context of a specific instance of the model, and do not apply to other instances of the same model.

Property

Meaning

Valid Values

Applicable to

Comments

mandatory

Indication whether an instance must exist

'true' / 'false'

Slots and data elements

Toggle by right-clicking the element

repetitive

Indication whether can have multiple instances

'true' / 'false'

Any element

Toggle by right-clicking the element

alwaysCreate

Indication whether to automatically create the element when its parent is created

'true' / 'false'

Display elements

If missing, the default is to create when the parent is created.
If ‘false’, the element will be created when it or one of its child elements are created - see also the Collections/Create plugin

columnName

Name of corresponding field in database record

According to database naming

Data elements (lead elements under a Database Record)

If missing, element name is used (after replacing each space by ‘_’)

columnSize

Size of column

Number

Data elements (leaf elements under a Database Record)

Applicable to DB2 on AS400.
If columnType property is set to 'CHAR', specifies the padding required when sent to Insert/Update/Call Procedure

columnType

Type of column

Valid data type

Data elements (leaf elements under a Database Record)

Applicable to DB2 on AS400.
If set to 'CHAR', and data element is of type text, assumes corresponding field is fixed size, and pads values sent to Insert/Update/Call Procedure with the required number of spaces, per the columnSize property

defaultValue

Value to use if corresponding field does not allow a null value

Anything

Data elements (leaf elements under a Database Record)

When database record is sent to Insert/Update/Call Procedure, with no value for the element, and the nullable property of the same element is set to 'false', the value specified here will be used instead of NULL.

databaseGenerated

Indication whether the value for the corresponding field is generated automatically by the database

'true' / 'false'

Data elements (leaf elements under a Database Record)

Default is 'false'.
If set to 'true', Insert will assume the field value will be automatically generated, and will be included in the <Inserted> exit output

excludeFromFieldName

Indication whether to ignore in name of corresponding field

'true' / 'false'

Data elements (under a Database Record)

If ‘true’, field names corresponding to child elements do not include it (e.g. if B in A/B/C is excluded, A/B/C is mapped to A_C rather than to A_B_C)

nullable

Indication whether null values are allowed in corresponding database field

'true' / 'false'

Data elements (leaf elements under a Database Record)

Default is 'true'.
If set to 'false', when database record is sent to Insert/Update/Call Procedure, with no value for the element, the value specified in the defaultValue property will be used.

primaryKey

Indication whether part of the primary key

'true' / 'false'

Data elements (leaf elements under a Database Record)

html.cellStyleClass

CSS style class for the table cell (TD tag) defined by the element

Text (style class)

Display elements inside Row

html.cellWidth

Width of table cell

HTML/CSS length attribute

Display elements inside Row

html.colSpan

Column span of table cell (HTML colspan attribute)

Integer

Display elements inside Row

html.rowSpan

Row span of table cell (HTML rowspan attribute)

Integer

Display elements inside Row

html.sortable

Indication whether the table can be sorted by this column

'true' / 'false'

Table cells (display elements inside Row)

Default is 'true'

html.sortColumnName

Database column name to use when calculating or analyzing <Sort Column>

Text

Table cells (display elements inside Row)

Default is element name