| Panel | ||
|---|---|---|
| ||
The entity's main field metadata required by the application's core mechanisms such as the security restrictions, query language, collaboration rules and workflow mechanisms. |
Attributes
| Name | Description | Value |
|---|---|---|
id | Unique Identifier. | Any |
| name | A name that describes the main field/collection. | Any |
| xpath | Thexpathmain field/collection name. | Any |
| relatedentityxpath | The path of the related entity (if one exists). | Any valid entity |
| method | The method that will be used to set the field's value. | Any valid method name |
| tag | The tag that will be used to refer to this field in query language and communication texts. | The path of the value |
| csrexcluded | Indicates if the field should be excluded from the conditional security restrictions mechanism. The default value is false. | true, false |
| audittrailexcluded | Indicates if the field should be excluded from the audit trailed fields. The default value is false. | true, false |
| mainfield | The main field of the collection. | Any field of the collection |
| field | A collection field. | Any field of the collection |
| sql | The SQL statement. | Any SQL statement |
qlfieldname | The query language field name used in segments | The name of the value |
| segmentpreviewname | Defines whether the field is to be displayed when previewing a segment as the entity's number, name, alternative code or description. | ENTITYNUMBER, ENTITYNAME, ENTITYALTCODE, ENTITYDESC |
| workflowruleactionincluded | Indicates if the entity should be included in workflow rule actions. The default value is false. | true or false |
| workflowruleconditionincluded | Indicates if the entity should be included in workflow rule conditions and in which condition type to be selected | FIELD_CHANGE, FIELD_CONTAINS_VALUE, FIELD_FROM_TO_VALUE_CHANGE |
| type | The type of the field | Any valid type |
Example
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
<mainfield>
<id>custom_number</id>
<name>key_number</name>
<xpath>number</xpath>
<qlfieldname>rental.number</qlfieldname>
<segmentpreviewname>ENTITYNUMBER</segmentpreviewname>
<csrexcluded>true</csrexcluded>
<audittrailexcluded>true</audittrailexcluded>
</mainfield> |