Skip to end of banner
Go to start of banner

3.1. Entities

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 20 Next »

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

NameDescriptionValue
id

Unique Identifier

Any
nameEntity NameAny
descriptionEntity DescriptionAny
tablenameThe Database table name which corresponds to the entityAny of the database table name that exists in the database
classnameThe path of the data classAny 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 ability to automatically apply entity assignments.true or false

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>PRODUCTTYPES</id>
			<name>Product Types</name>
			<description></description>
			<tablename>PRODUCTTYPES</tablename>
			<classname>com.crm.dataobject.products.CRMDOProductType</classname>
			<typeentityid></typeentityid>
			<masterentityid></masterentityid>
			<moduleid>PRODUCTS</moduleid>
			<metadatafile></metadatafile>
			<csrexcluded>true</csrexcluded>
			<plarexcluded>true</plarexcluded>
			<acrexcluded>true</acrexcluded>
		</entity>
		...
	</entities>
</entityconfig>
  • No labels