Metadata Fields

The 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

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 and for workflows(alert, webhook from R9).	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
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, etc.)	Any valid type

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>