Skip to end of banner
Go to start of banner

Entities metadata

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Next »

Entities

In this metadata file we can define entity related metadata that will be used by the application's core mechanisms such as the security restrictions, query language, collaboration rules, web hooks, alerts and approval mechanisms.

Attributes

NameDescriptionValue
id

Unique Identifier.

Any
nameEntity name.Any
descriptionEntity description.Any
tablenameThe database table name which corresponds to the entity.Any of the database table names that exist in the database
classnameThe 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
masterentityidThe id of the top most entity.Any entity id
moduleidThe identifier of the module the entity belongs to.Any of the module ids defined in the modules metadata file
metadatafileThe name of the metadata file the entity belongs to.Any of the metadata file name defined in the fields metadata folder
csrexcludedDefines if this entity will be excluded or not from the Conditional Security Restrictions (CSR) mechanism.true or false
plarexcludedDefines if this entity will be excluded or not from the Privacy Level Assignment Rules (PLAR) mechanism.true or false
acrexcludedDefines if this entity will be excluded or not from the Automatic Collaboration Rules (ACR) mechanism.true or false
segmentincluded Defines if this entity will be excluded or not from the Segmentation mechanism.true or false
notificationclassificationThe classification of the entity notification.Any module id
tagDefines the entity's tag that can be used to refer to the entity in queries and communication texts.Any entity
alertincludedDefines if the entity will be included in alerts mechanism.true or false
webhooksincludedDefines if the entity will be included in webhooks mechanism.true or false
approvalincludedDefines if the entity will be included in approvals mechanism.true or false
workflowruleincludedDefines if the entity will be included in workflow rule mechanism.true or false
dataentrypagexmlfileDefines the entity's data entry page.Any of the data entry page file path
crmuiclassnameDefines the User Interface class name of the entity.Any of the class names
crmuiloadmethodDefines the  User Interface method of the entity.Any of the methods included in class name

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>
  • No labels