| 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. |
Attributes
...
id
...
Unique Identifier.
...
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 | ||
|---|---|---|---|---|
| mainfield | The main field of the entity. | Any field of the entity | field | An entity field. |
| Any field fields | Contains the fields of the entity | |||
| collection | An entity collection. | Any collection of the entity | ||
| sql | The SQL statement. | Any SQL statement | ||
qlfieldname | The query language field name used in segments | The name of the value | ||
| workflowruleactionincluded | Indicates if the entity should be included in workflow rule actions. | true or false | ||
| workflowruleconditionincluded | Indicates if the entity should be included in workflow rule conditions and in which condition type(values are hardcoded based on condition type) to be selected | The name of the condition type | ||
| type | The type of the field(ex. java.lang.String, java.util.Date, java.math.BigDecimal, ,com.crm.dataobject.activities.CRMDOActivityCategory,) | Any valid type |
Example
...
| title | Metadata Fields |
|---|
| 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> <csrexcluded>true</csrexcluded> <plarexcluded>true</plarexcluded> <acrexcluded>true</acrexcluded> </field> <field> <id>type</id> <name>Type</name> <relatedentityxpath>type</relatedentityxpath> <xpath>name</xpath> <qlfieldname>activity.type</qlfieldname> <tag>activity.type</tag> <csrexcluded>false</csrexcluded> <plarexcluded>true</plarexcluded> <acrexcluded>true</acrexcluded> <audittrailexcluded>true</audittrailexcluded> <workflowruleactionincluded>false</workflowruleactionincluded> <xpath>name</xpath> <workflowruleconditionincluded>FIELD_CONTAINS_VALUE</workflowruleconditionincluded><type>com.crm.dataobject.activities.CRMDOActivityType</type> </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> |