| Panel | ||
|---|---|---|
| ||
Metadata EntitiesThe 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. |
...
| Name | Description | Value |
|---|---|---|
| id | Unique Identifier. | Any |
| name | Entity name. | Any |
| description | Entity description. | Any |
| tablename | The database table name which corresponds to the entity. | Any of the database table names that exist in the database |
| classname | The 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 |
| masterentityid | The id of the top most entity. | Any entity id |
| moduleid | The identifier of the module the entity belongs to. | Any of the module ids defined in the modules metadata file |
| metadatafile | The name of the metadata file the entity belongs to. | Any of the metadata file name defined in the fields metadata folder |
| csrexcluded | Defines 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 |
| plarexcluded | Defines 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 |
| acrexcluded | Defines if Automatic Security Restrictions (ACR) are excluded or not from the ability to automatically apply entity assignments. | true or false |
| segmentincluded | Defines if segments are excluded or not for the entity. | true or false |
| notificationclassification | The classification of the entity notification. | Any module id |
| tag | Defines if the entity will have fields to be replaced in data entry pages. | Any entity |
| alertincluded | Defines if the entity will be included in alerts | true or false |
| webhooksincluded | Defines if the entity will be included in webhook | true or false |
| approvalincluded | Defines if the entity will be included in approvals | true or false |
| workflowruleincluded | Defines if the entity will be included in workflow rule | true or false |
| dataentrypagexmlfile | Defines the 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 |
| crmuiclassname | Defines the class name of the related entity to load methods from | Any of the class names |
| crmuiloadmethod | Defines the method to call when loading an object | Any of the methods included in class name |
...