| Panel | ||
|---|---|---|
| ||
Metadata FieldsThe fields XML files are XML files that describe all the fields and datapaths of their respective entity (i.e. the accountsreceivable.xml describes the AccountReceivable entity). By including these fields in these XML files, we are stating that certain restrictions can be applied to them. In order to apply the restrictions at a field, the field's filename should be included in entities metadata file in the corresponding entity's <metadatafile> tag. | ||
In fields metadata file, we define the entity's fields metadata required by the application's core mechanisms such as the security restrictions, query language, collaboration rules and workflow mechanisms.
What does this section cover?
|
Attributes
| Name | Description | Value |
|---|---|---|
id | Unique Identifier. | Any |
| name | A name that describes the main field/field/collection. | Any |
| xpath | The xpath main field/field/collection name. | Any |
| relatedentityxpath | The path of the related entity (if one exists). | Any valid entity |
| method | The method name. | Any valid method name |
| tag | Used to fill in necessary information in templates. They indicate what values to be loaded when using the Referring To in communications. | The path of the value |
| csrexcluded | Indicates if the entity should be excluded from the conditional security restrictions. | true or false |
| plarexcluded | Indicates if the entity should be excluded from the privacy level assignment rules. | true or false |
| acrexcluded | Indicates if the entity should be excluded from the added conditional restrictions. | true or false |
| mainfield | The main field of the entity. | Any field of the entity |
| field | An entity field. | Any field of the entity |
| collection | An entity collection. | Any collection of the entity |
| sql | The SQL statement. | Any SQL statement |
Example
...
| title | Metadata Fields |
|---|
| mainfield | The main field of the entity. | Any field of the entity |
| fields | Contains the fields of the entity and their metadata information | A list of entity fields |
| collections | Contains the collections of the entity and their metadata information | A list of entity collections |
Example
| Code Block | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Metadata Fields | <entityfieldconfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../xsd/fields.xsd">
| |||||||||
<entityfieldconfig> <mainfield><id>number< <id>custom_number</id><name>Number< <name>key_number</name> <xpath>number</xpath><tag>accounts_receivable <qlfieldname>rental.number</tag> qlfieldname><csrexcluded>true</csrexcluded> <plarexcluded>true</plarexcluded> <acrexcluded>true</acrexcluded> <segmentpreviewname>ENTITYNUMBER</segmentpreviewname> </mainfield> <fields>
<field>
<id>name<<id>custom_type</id><name>Name< <name>key_type</name><xpath>name< <relatedentityxpath>type</xpath> relatedentityxpath><tag>accounts_receivable.name</tag> <xpath>name</xpath><csrexcluded>true</csrexcluded> <plarexcluded>true</plarexcluded> <acrexcluded>true</acrexcluded> <workflowruleconditionincluded>FIELD_CONTAINS_VALUE</workflowruleconditionincluded> </field> ...
</fields>
<collections> <collection><id>subscriptions< <id>custom_items</id><name>Account subscriptions< <name>key_items</name><relatedentityxpath>< <relatedentityxpath/relatedentityxpath> ><xpath>subscriptions< <xpath>items</xpath><tag>accounts_receivable <qlfieldname>rental.subscription</tag> <csrexcluded>true</csrexcluded> <plarexcluded>true</plarexcluded> <acrexcluded>true</acrexcluded> items</qlfieldname> <method><ejbname>CRMUIAccountReceivable< <ejbname>CUSTOMCRMUIRental</ejbname><methodname>loadSubscriptionsTab< <methodname>loadItemsTab</methodname> <parameters> <parameter> <xpath>[DTO]</xpath> </parameter> </parameters> </method> <mainfield><id>number< <id>custom_serialNumber</id><name>Subscription Number< <name>key_serialNumber</name><relatedentityxpath>< <relatedentityxpath>installedItem</relatedentityxpath><xpath>number< <xpath>altCode</xpath><tag>accounts_receivable <qlfieldname>rental.subscription items.serial_number</tag> qlfieldname> </mainfield> <fields> <field><id>type< <id>custom_code</id><name>Type< <name>key_product_code</name><relatedentityxpath>type< <relatedentityxpath>installedItem</relatedentityxpath><xpath>name< <xpath>product/code</xpath><tag>accounts_receivable <qlfieldname>rental.subscription items.type< product_code</tag> qlfieldname> </field> ...... </fields> </collection> </collections> </entityfieldconfig> |