Versions Compared

Old Version 26

changes.mady.by.user Marios Michael

Saved on

compared with

New Version 27

changes.mady.by.user Marios Michael

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
nameblue

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.

...

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 Conditional Security Restrictions (CSR) are excluded or not from the ability to restrict features of the system related with the entity.true or false
plarexcludedDefines 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
acrexcludedDefines if Automatic Security Restrictions (ACR) are excluded or not from the ability to automatically apply entity assignments.true or false
segmentincludedDefines if segments are excluded or not for the entity.true or false
notificationclassificationThe classification of the entity notification.Any module id
tag  Any entity
alertincludedDefines if the entity will be included in alert definitionsalertstrue or false
webhooksincluded Defines if the entity will be included in webhooktrue or false
approvalincluded Defines if the entity will be included in approvalstrue or false
workflowruleincluded Defines if the entity will be included in workflow ruletrue or false
dataentrypagexmlfile  
crmuiclassname  
crmuiloadmethod  Defines the data entry page xml file path in case a user wants to open the page in modalAny of the data entry page file path
crmuiclassnameDefines the class name of the related entity to load methods fromAny of the class names
crmuiloadmethodDefines the method to call when loading an objectAny of the methods included in class name

Example

Expand
titleEntities
Code Block
themeEclipse
languagexml
titleEntities
<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>