Entity
About Entity
Entities include people and companies that are known to Framework ECM. To make it easy to manage the number of entities in the system, users can assign multiple roles to a single person or company.
The Entity screen is used to manage system entities. An entity is a single 'thing' (person, place, etc.) about which data can be stored.
In Framework ECM, an entity is ascribed an entity role. An entity role refers to the function performed or maintained by an entity. It determines where in the system an entity can be selected.
Team Entity
For companies that utilise construction teams, it is possible to set entities to only apply to specific teams, meaning that certain suppliers will only show within the respective teams jobs. This is ideal for construction logistics where businesses may operate across differing regions but do not want entities to apply to all teams that work under that region/division.
Procedures
Resolving An Entity
This procedure is designed to resolve duplicate entities in the system. This involves keeping one entity, replacing all the duplicate entity links and allocations to this one entity, then deleting the duplicate.
- From the Entity Roles list, select the required entity role.
- Click Resolve. The Resolve Entity dialog will be displayed.
- Enter the criteria.
- From the Entities to be Resolved list, select an entity.
- Click Resolve and confirm action.
Creating An Entity
- From the Entity Roles list, select the required entity role.
- Click New. The Create/Select Entity confirmation prompt will appear.
- Click Yes if the entity will be a new entity (i.e., they do not already exist in the system). The Select Entity dialog will be displayed.
- From the Entity Type list, select the type of entity.
- Click OK. The General tab of the Person Details dialog, Name Details dialog, or Company Details dialog will be displayed.
- For each tab of the dialog, select and enter details or select the New button in the toolbar to create a record.
Creating A Role For An Existing Entity
Framework ECM entities may belong to one or more roles.
Example
- From the Entity Roles list, select the required entity role.
- Click New. The Create/Select Entity confirmation prompt will appear.
- Click No if the entity is already in the system. The Entity Search dialog will be displayed.
- Enter the search criteria.jami
- Click Search.
- From the Search Results list, select an entity.
- Click OK. The Create Entity Role confirmation prompt will appear.
- Click Yes to confirm. The General tab of the Entity Role dialog will be displayed.
- Enter the details.
- Select the Custom Fields tab.
- Enter the details.
- Click OK. The dialog will close and the entity role will be added to the entity.
Managing Roles For An Existing Entity
Once roles have been assigned to an entity, they can be managed using the Roles tab on the Person Details dialog. Here roles can be removed or made inactive.
Using the Delete function on this dialog removes the individual role completely with a hard delete.
Individual roles can be made inactive by editing the role and changing the flag Inactive flag to Yes in the Entity Role dialog. It can be made active again by changing the flag back to No.
Removing or making a role inactive means the entity will no longer be available for selection in ECM for that role.
Deleting An Entity
Entities are never physically removed from Framework ECM. When all entity roles are removed or made inactive the entity is no longer displayed for new selection in any list in Framework ECM. These entities remain within Framework ECM to ensure that historical data is handled correctly.