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.

Attributes

Name	Description	Value	Applicable for
id	Unique Identifier.	Any	field, mainfield, collection
name	A name that describes the main field/collection.	Any	field, mainfield, collection
xpath	The xpath main field/collection name.	Any	field, mainfield, collection
relatedentityxpath	The path of the related entity (if one exists).	Any valid entity	field, mainfield, collection
method	The method that will be used to set the field's value.	Any valid method name	field, mainfield, collection
tag	The tag that will be used to refer to this field in query language and communication texts.	The path of the value	field, mainfield, collection
csrexcluded	Indicates if the field should be excluded from the conditional security restrictions mechanism.	true, false	field, mainfield, collection
plarexcluded	Indicates if the field should be excluded from the privacy level assignment rules.	true, false	field, mainfield, collection
acrexcluded	Indicates if the field should be excluded from the added conditional restrictions.	true, false	field, mainfield, collection
audittrailexcluded	Indicates if the field should be excluded from the audit trailed fields.	true, false	field, mainfield, collection
mainfield	The main field of the collection.	Any field of the collection	collection
field	A collection field.	Any field of the collection	collection
sql	The SQL statement.	Any SQL statement	field, mainfield, collection
qlfieldname	The query language field name used in segments	The name of the value	field,mainfield, collection
qlfilter	SQL conditions, that the collection that are added to, will be filtered out by, when retrieved by a segment	Any valid SQL criterion	field,mainfield, collection
segmentpreviewname			field,mainfield, collection
workflowruleactionincluded	Indicates if the entity should be included in workflow rule actions.	true or false	field,mainfield, collection
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	field,mainfield, collection
type	The type of the field	Any valid type	field,mainfield, collection

Attributes

Name	Description	Value
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

Example

Metadata Fields

Metadata Fields

<entityfieldconfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../xsd/fields.xsd">
	<mainfield>
		<id>number</id>
		<name>Number</name>
		<xpath>number</xpath>
		<tag>accounts_receivable.number</tag>
		<csrexcluded>true</csrexcluded>
		<plarexcluded>true</plarexcluded>
		<acrexcluded>true</acrexcluded>
	</mainfield>
		
	<fields>
		<field>
			<id>name</id>
			<name>Name</name>
			<xpath>name</xpath>
			<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>
            <workflowruleconditionincluded>FIELD_CONTAINS_VALUE</workflowruleconditionincluded> 
            <type>com.crm.dataobject.activities.CRMDOActivityType</type>
        </field>
		...
 
	</fields>
 
	<collections>
		<collection>
			<id>subscriptions</id>
			<name>Account subscriptions</name>
			<relatedentityxpath></relatedentityxpath>
			<xpath>subscriptions</xpath>
			<tag>accounts_receivable.subscription</tag>
			<csrexcluded>true</csrexcluded>
			<plarexcluded>true</plarexcluded>
			<acrexcluded>true</acrexcluded>
			<method>
				<ejbname>CRMUIAccountReceivable</ejbname>
				<methodname>loadSubscriptionsTab</methodname>
				<parameters>
					<parameter>
						<xpath>[DTO]</xpath>
					</parameter>
				</parameters>
			</method>
			<mainfield>
				<id>number</id>
				<name>Subscription Number</name>
				<relatedentityxpath></relatedentityxpath>
				<xpath>number</xpath>
				<tag>accounts_receivable.subscription.number</tag>
			</mainfield>
			<fields>
				<field>
					<id>type</id>
					<name>Type</name>
					<relatedentityxpath>type</relatedentityxpath>
					<xpath>name</xpath>
					<tag>accounts_receivable.subscription.type</tag>
				</field>
				
				...
 
			</collection>
	</collections>
</entityfieldconfig>

Fields metadata

Attributes

Attributes

Example