Article: AN0001628Updated: 29.03.2019
It is possible to enter description format in several places for object definition. This format creates a text by means of several commands. These commands are available depending on object, for which the description is defined. In the format you can use whatever column from the class, parent classes or child classes, name of the model, class etc. You can use in it also short description of the child classes. You cannot use short description of the class itself or its parent classes. You can add other text between these commands, e.g. separators.
Examples of several description formats:
{{column.name}}
{{column.requested-when}} - {{column.appl-role}}
{{column.date}} - {{column.description}}
Definition
Definition of the format is simple. Commands are entered between characters {{ and }}. Following table describes all the available commands. Some commands have alias in order to shorten the notation. Commands can be input in upper case or lower case.
| Command |
Description |
|
app.parameter.__parameter_code__
application.parameter.__parameter_code__
app.par.__parameter_code__
application.parameter.__parameter_code__
|
Command returns value from an application parameter. |
| model.id |
Command returns Id of the current model. |
| model.code |
Command returns code of the current model. |
| model.name |
Command returns name of the current model. |
|
model.par.__parameter_code__
model.parameter.__parameter_code__
|
Command returns value from a model parameter. |
| class.id |
Command returns Id of the current class. |
| class.name |
Command returns name of the current class. |
| class.code |
Command returns code of the current class. |
| query.id |
Command returns Id of the current query. |
| query.name |
Command returns name of the current query. |
| query.code |
Command returns code of the current query. |
| column.__column_code__ |
Command returns column value of the current record. |
|
var.__property_name__
variable.__property_name__
|
Commnad returns variable value. |
| parent |
It switcheds context to the parent class. If there is no parent class, an error is returned. |
| firstparent |
It switcheds context to the first parent class. If there is no parent class, an error is returned. |
| child |
It switcheds context to the child class. If there is no child class, an error is returned. |
| lastchild |
It switcheds context to the last child class. If there is no child class, an error is returned. |
Variables depend on the use case.E.g. there are some vaiables for import and other for export. You can find a list of respective variables in the help to the particular page with use of Description format.
When using Description format for class class record can be refered. From this record class and model can be identified. However, there is no reference to a query. Therefore, all the commands available for class cannot be used with a query. Context of use always matters.
When variable column...is used and DataRow is not available, an empty text is returned.
Parent and child classes
If the Description format is evaluated for a class record, you can use commands for changing context to the parent or child classes. in the default state there is record class set. If the record has parent classes, you can switch to the direct parent class by menas of parent command. Similarly, by using child command you can switch to the first child class. Commands parent and child can be used also in a multiple way one after another.
parent.class.name
parent.column.abc
parent.parent.column.abb
child.column.abc
lastchild.class.name
firstparent.class.name
firstparent.column.id