Versions Compared

Old Version 28

changes.mady.by.user Marios Michael

Saved on

compared with

New Version Current

changes.mady.by.user Former user

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 ManagementIn 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
statusentityidThe identifier of a related entity where corresponds to the status information of the current entity.Any of the entity ids defined in the entities metadata file
stateentityidThe identifier of a related entity where corresponds to the state information of the current entity.Any of the entity ids defined in the entities metadata file
categoryentityidThe identifier of a related entity where corresponds to the category information of the current entity.Any of the entity ids defined in the entities metadata file
masterentityidThe id of the top most entity./ Multiple entitiesAny entity id / MULTIPLE_ENTITIES
moduleidThe identifier of the module the entity belongs to.Any of the module ids defined in the modules metadata file
qlfilterSQL conditions, that the collection that are added to, will be filtered out by, when retrieved by a segmentAny valid SQL criterion
ownergroupfieldsqlSQL script that calculates the owner group id field when masterentityid value is MULTIPLE_ENTITIESAny valid SQL script
privacylevelfieldsqlSQL script that calculates the privacy level id field when masterentityid value is MULTIPLE_ENTITIESAny valid SQL script
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) are excluded or not from the ability to restrict features of the system related with the entitymechanism. The default value is false.true or , false
plarexcludedDefines if any Privacy this entity will be excluded or not from the Privacy Level Assignment Rules (PLAR) are mechanism. The default value is false.true, false
acrexcludedDefines if this entity will be excluded or not from the ability to automatically apply privacy levels on entity recordsAutomatic Collaboration Rules (ACR) mechanism. The default value is false.true or , false
acrexcludedaudittrailexcluded Defines if Automatic Security Restrictions (ACR) are this entity will be excluded or not from the ability to automatically apply entity assignmentsAudit Trail Mechanism. The default value is false.true or , false
segmentincluded Defines if segments are this entity will be excluded or not for the entityfrom the Segmentation Mechanism. The default value is false.true or , false
notificationclassificationThe classification of the entity notification.Any module id
tagDefines if the entity will have fields to be replaced in data entry pages.Any entity's tag that can be used to refer to the entity in queries and communication texts.Any entity
unrestrictedtagincludedDefines if the entity can use unrestricted tags. The default value is false.true, false
dynamiclinktagincludedDefines if the entity can use dynamic links. The default value is false.true, false
alertincludedDefines if the entity will be included in alerts mechanism. The default value is false.true or , false
webhooksincludedDefines if the entity will be included in webhookwebhooks mechanism. The default value is false.true or , false
approvalincludedDefines if the entity will be included in approvals mechanism. The default value is false.true or , false
workflowruleincludedDefines if the entity will be included in workflow rule true or falsemechanism. The default value is false.true, false
isarchivedDefines if the entity can be archived using the Archiving Utility. The default value is false.true, false
archiverelatedentitiesDefines the identifiers of the related entities when isarchived is set to true.Any of the entity ids defined in the entities metadata file
dataentrypagexmlfileDefines the entity's data entry page xml file path in case a user wants to open the page in modal.Any of the data entry page file path
crmuiclassnameDefines the User Interface class name of the related entity to load methods from.Any of the class names
crmuiloadmethodDefines the method to call when loading an objectthe  User Interface method of the entity.Any of the methods included in class name

Example

Expand
titleEntities
Code Block
themeEclipse
languagexml
titleEntities
<entityconfig>
	<entities>
		...
		<entity>
			<id>PRODUCTS<<id>CUSTOMRENTALS</id>
			<name>Products<<name>key_rental</name>
			<description></description>
			<tablename>PRODUCTS<<tablename>TRN_RENTALS</tablename>
			<classname>com.crm.dataobject.productsrentals.CRMDOProduct<CUSTOMCRMDORental</classname>
			<moduleid>CUSTOM_RENTALS</moduleid>
			<typeentityid>PRODUCTTYPES<<metadatafile>rentals</typeentityid>metadatafile>
			<masterentityid><<masterentityid>ACCOUNTSRECEIVABLE</masterentityid>
			<moduleid>PRODUCTS<<workflowruleincluded>true</moduleid>workflowruleincluded>
			<metadatafile>products</metadatafile><typeentityid>CUSTOMRENTALTYPES</typeentityid>
	        <audittrailexcluded>false</audittrailexcluded>
			<csrexcluded>false</csrexcluded>
  			<plarexcluded>true</      	<acrexcluded>false</acrexcluded>
			<acrexcluded>true<<plarexcluded>false</acrexcluded>plarexcluded>
			<<approvalincluded>true</entity>approvalincluded>
 
			<entity><alertincluded>true</alertincluded>
			<id>ACTIVITIES<<workflowruleincluded>true</id>workflowruleincluded>
			<name>Activities<<webhooksincluded>true</name>webhooksincluded>
			<description></description></entity>
 
			<tablename>ACTIVITIES</tablename>
		<entity>
        	<id>CUSTOMRENTALSTATES</id>
        	<name>key_rental_state</name>
        	<classname>com.crm.dataobject.activitiesrentals.CRMDOActivity<CUSTOMRentalState</classname>
        	<moduleid>CUSTOM_RENTALS</moduleid>
        		<typeentityid>ACTIVITYTYPES</typeentityid><csrexcluded>true</csrexcluded>
        	<acrexcluded>true</acrexcluded>
			<masterentityid><<plarexcluded>true</masterentityid>plarexcluded>
			<moduleid>ACTIVITIES</moduleid><segmentincluded>true</segmentincluded>
    	</entity>
		
		<metadatafile>activities</metadatafile><entity>
			<csrexcluded>false<<id>CUSTOMRENTALTYPES</csrexcluded>id>
			<plarexcluded>false</plarexcluded><name>key_rental_type</name>
			<acrexcluded>true<<tablename>TRN_RENTALTYPES</acrexcluded>tablename>
			<segmentincluded>true</segmentincluded><classname>com.crm.dataobject.rentals.CUSTOMCRMDORentalType</classname>
			<notificationclassification>CUSTOMER_CARE<<moduleid>CUSTOMRENTALS</notificationclassification>moduleid>
			<tag>activity<<metadatafile>rentaltypes</tag>metadatafile>
            <alertincluded>true<<isarchived>true</alertincluded>isarchived>
            <webhooksincluded>true<<archivecollections>TRN_RENTTYPEPRODUCTS</webhooksincluded>archivecollections>
            <approvalincluded>true<<archiverelatedentities>CUSTOMRENTALS</approvalincluded>
            <workflowruleincluded>true</workflowruleincluded>
            <dataentrypagexmlfile>activities/activity</dataentrypagexmlfile>
            <crmuiclassname>CRMUIActivity</crmuiclassname>archiverelatedentities>
			<csrexcluded>true</csrexcluded>
			<acrexcluded>true</acrexcluded>
			<plarexcluded>true</plarexcluded>
		</entity>
		<entity>
			<id>CUSTOMRENTALTYPEPRODUCTS</id>
			<name>key_rental_type_product</name>
			<tablename>TRN_RENTTYPEPRODUCTS</tablename>
			<classname>com.crm.dataobject.rentals.CUSTOMCRMDORentalTypeProduct</classname>
			<moduleid>CUSTOMRENTALS</moduleid>
			<acrexcluded>true</acrexcluded>
			<plarexcluded>true</plarexcluded>
			<csrexcluded>true</csrexcluded>
            <crmuiloadmethod>loadForm</crmuiloadmethod>	<acrexcluded>true</acrexcluded>
	 	</entity>
		...
	</entities>
</entityconfig>