Panel | ||
---|---|---|
| ||
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 | Applicable for |
---|---|---|---|
id | Unique Identifier. | Any | field, collection |
name | A name that describes the main field/collection. | Any | field, collection |
xpath | The xpath main field/collection name. | Any | field, collection |
relatedentityxpath | The path of the related entity (if one exists). | Any valid entity | field, collection |
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. | true, false | |
plarexcluded | Indicates if the field should be excluded from the privacy level assignment rules. | true, false | |
acrexcluded | Indicates if the field should be excluded from the added conditional restrictions. | true, false | |
audittrailexcluded | Indicates if the field should be excluded from the audit trailed fields. | true, 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 | |
qlfieldname | The query language field name used in segments | The name of the value | |
qlfilter | SQL conditions, that the collection that are added to, will be filtered out by, when retrieved by a segment | Any valid SQL criterion | |
segmentpreviewname | |||
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 to be selected | The name of the condition type | |
type | The type of the field | Any valid type |
Example
...
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> <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> items</qlfieldname><plarexcluded>true</plarexcluded> <acrexcluded>true</acrexcluded> <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> |