Metadata Entities

The entities.XML file has an XML structure that describes all the entities implemented within the software. By including the entities in the XML file, we are stating that any Conditional Security Restrictions, Privacy Level Assignment Rules and Automatic Security Restrictions can be applied to them, and can be configured in the Security Management.

Attributes

Name	Description	Value
id	Unique Identifier.	Any
name	Entity name.	Any
description	Entity description.	Any
tablename	The database table name which corresponds to the entity.	Any of the database table names that exist in the database
classname	The path of the data class.	Any of the data classes that corresponds to the entity
typeentityid	The identifier of a related entity where corresponds to the type information of the current entity.	Any of the entity ids defined in the entities metadata file
masterentityid	The id of the top most entity.	Any entity id
moduleid	The identifier of the module the entity belongs to.	Any of the module ids defined in the modules metadata file
metadatafile	The name of the metadata file the entity belongs to.	Any of the metadata file name defined in the fields metadata folder
csrexcluded	Defines if Conditional Security Restrictions (CSR) are excluded or not from the ability to restrict features of the system related with the entity.	true or false
plarexcluded	Defines if any Privacy Level Assignment Rules (PLAR) are excluded or not from the ability to automatically apply privacy levels on entity records.	true or false
acrexcluded	Defines if Automatic Security Restrictions (ACR) are excluded or not from the ability to automatically apply entity assignments.	true or false
segmentincluded	Defines if segments are excluded or not for the entity.	true or false
notificationclassification	The classification of the entity notification.	Any module id
tag
alertincluded	Defines if the entity will be included in alert definitions	true or false
webhooksincluded		true or false
approvalincluded		true or false
workflowruleincluded		true or false
dataentrypagexmlfile
crmuiclassname
crmuiloadmethod

Example

Entities

Entities

<entityconfig>
	<entities>
		...
		<entity>
			<id>PRODUCTS</id>
			<name>Products</name>
			<description></description>
			<tablename>PRODUCTS</tablename>
			<classname>com.crm.dataobject.products.CRMDOProduct</classname>
			<typeentityid>PRODUCTTYPES</typeentityid>
			<masterentityid></masterentityid>
			<moduleid>PRODUCTS</moduleid>
			<metadatafile>products</metadatafile>
			<csrexcluded>false</csrexcluded>
			<plarexcluded>true</
			<acrexcluded>true</acrexcluded>
		</entity>
 
		<entity>
			<id>ACTIVITIES</id>
			<name>Activities</name>
			<description></description>
			<tablename>ACTIVITIES</tablename>
			<classname>com.crm.dataobject.activities.CRMDOActivity</classname>
			<typeentityid>ACTIVITYTYPES</typeentityid>
			<masterentityid></masterentityid>
			<moduleid>ACTIVITIES</moduleid>
			<metadatafile>activities</metadatafile>
			<csrexcluded>false</csrexcluded>
			<plarexcluded>false</plarexcluded>
			<acrexcluded>true</acrexcluded>
			<segmentincluded>true</segmentincluded>
			<notificationclassification>CUSTOMER_CARE</notificationclassification>
			<tag>activity</tag>
            <alertincluded>true</alertincluded>
            <webhooksincluded>true</webhooksincluded>
            <approvalincluded>true</approvalincluded>
            <workflowruleincluded>true</workflowruleincluded>
            <dataentrypagexmlfile>activities/activity</dataentrypagexmlfile>
            <crmuiclassname>CRMUIActivity</crmuiclassname>
            <crmuiloadmethod>loadForm</crmuiloadmethod>
	 	</entity>
		...
	</entities>
</entityconfig>