Versions Compared

Old Version 3

changes.mady.by.user Former user

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.

Description

...

Panel
nameblue

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 Namename.Any
descriptionEntity Descriptiondescription.Any
tablenameThe Database database table name which corresponds to the entity.Any of the database table name names that exists exist in the database
classnamethe The path of the data class.Any of the data classes that corresponds to the entity
typeentityid  masterentityid  

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
csrexcludedDefine if Defines 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 including data entry pages fields, based on conditions, which can be applied on specific organizational units.true or false
plarexcluded true or false
acrexcluded true or false

...

mechanism. The default value is false.true, false
plarexcludedDefines if this entity will be excluded or not from the Privacy Level Assignment Rules (PLAR) mechanism. The default value is false.true, false
acrexcludedDefines if this entity will be excluded or not from the Automatic Collaboration Rules (ACR) mechanism. The default value is false.true, false
audittrailexcluded Defines if this entity will be excluded or not from the Audit Trail Mechanism. The default value is false.true, false
segmentincluded Defines if this entity will be excluded or not from the Segmentation Mechanism. The default value is false.true, 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
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, false
webhooksincludedDefines if the entity will be included in webhooks mechanism. The default value is false.true, false
approvalincludedDefines if the entity will be included in approvals mechanism. The default value is false.true, false
workflowruleincludedDefines if the entity will be included in workflow rule mechanism. 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.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

Expand
titleEntities
Code Block
themeEclipse
languagexml
titleEntities
<entityconfig>
	<entities>
		<entity>
			<id>CUSTOMRENTALS</id>
			<name>key_rental</name>
			<tablename>TRN_RENTALS</tablename>
			<classname>com.crm.dataobject.rentals.CUSTOMCRMDORental</classname>
			<moduleid>CUSTOM_RENTALS</moduleid>
			<metadatafile>rentals</metadatafile>
			<masterentityid>ACCOUNTSRECEIVABLE</masterentityid>
			<workflowruleincluded>true</workflowruleincluded>
			<typeentityid>CUSTOMRENTALTYPES</typeentityid>
	        <audittrailexcluded>false</audittrailexcluded>
			<csrexcluded>false</csrexcluded>
        	<acrexcluded>false</acrexcluded>
			<plarexcluded>false</plarexcluded>
			<approvalincluded>true</approvalincluded>
			<alertincluded>true</alertincluded>
			<workflowruleincluded>true</workflowruleincluded>
			<webhooksincluded>true</webhooksincluded>
		</entity>
 
		<entity>
        	<id>CUSTOMRENTALSTATES</id>
        	<name>key_rental_state</name>
        	<classname>com.crm.dataobject.rentals.CUSTOMRentalState</classname>
        	<moduleid>CUSTOM_RENTALS</moduleid>
        	<csrexcluded>true</csrexcluded>
        	<acrexcluded>true</acrexcluded>
			<plarexcluded>true</plarexcluded>
			<segmentincluded>true</segmentincluded>
    	</entity>
		
		<entity>
			<id>CUSTOMRENTALTYPES</id>
			<name>key_rental_type</name>
			<tablename>TRN_RENTALTYPES</tablename>
			<classname>com.crm.dataobject.rentals.CUSTOMCRMDORentalType</classname>
			<moduleid>CUSTOMRENTALS</moduleid>
			<metadatafile>rentaltypes</metadatafile>
            <isarchived>true</isarchived>
            <archivecollections>TRN_RENTTYPEPRODUCTS</archivecollections>
            <archiverelatedentities>CUSTOMRENTALS</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>
        	<acrexcluded>true</acrexcluded>
		</entity>
		...
	</entities>
</entityconfig>