Article last updated on the 1st of December 2020.
The Relations module is used for creating dynamic relations related to roles between entities across a solution. This is especially useful when creating many-to-many relations and can be used to always have an overview of relations between entities and personnel.
Administrators can set up specific relation types e.g. Lawyer and/or Client, and relation pairs, such as Lawyer <--> Client. Relation pairs always requires a setup with two relation types which must both be unique. Setting up a relation enables users to quickly navigate to and from entities which have some relation to each other.
Permissions can also be set up in such a way that only specific people can see certain relations. This is referred to as "Security trimming".
Relations can be set up to be displayed in a webpart on a WorkPoint page.
2. End User Guide
In this example, we will create a relation between a company and a project and display the relation in the company's Home page.
Once a button has been set up to create new relations in the My Tools menu, the relation is set up using this button:
1. In the My Tools panel, click the "All actions" button.
- From the All actions menu, expand the "New" tab.
- Select "New relation" from the menu to create a new relation.
- On the “Find entity” step, enter search strings in the supplied fields to find the project (in this case) you wish to create the relation to. If no business module entity can be found, you have the option of creating a new entity by clicking “Create …”, which will take you to the next step.
- If you have found an entity and want to edit it before creating the relation select the entity from the list and click on "Select and edit". In this case, we simply click "Select and continue".
- In this example, the company (Anderson's Custom Bikes) is set as "Organizer" as Relation type.
- The project defined in the previous step (Design of Bike0075) is set as "Project" as Relation type.
- In this case, start- and end dates for the relation are set. This information can be viewed when seeing the relation in the web part in WorkPoint 365. If start / end date is supplied, the relation will only be shown in the web part if today's date falls in between these two dates. The relation will also be shown if the user checks “Show inactive relations” in the web part settings.
- A description is set for the relation.
- A responsible user is set for this relation. Per default, this field is set to the user who is creating the relation. This can also be left empty.
- When satisfied with the information, click “Save relation” in the bottom right corner of the wizard, and the relation will be created in a matter of seconds.
Once a relation is established, you can inspect the relation's data by clicking the relation title in the webpart:
Note that the fields showing up in the pop-up window are defined by the default view of the relation entity.