Role - Atfinity documentation

Search…
Role
Definition
A role describes the relationship between two ontologies. A single instance of an ontology can have multiple roles. Examples of roles are: 'account holder', 'signatory', 'power of attorney', and 'beneficial owner'.
Example:
Peter Müller, an instance of the ontology ‘Person’, can have the role of ‘Account Holder’ in Contract #1234. At the same time, Müller can have the role of ‘Beneficiary Owner’ in Contract #5678 and the role of ‘Power of Attorney’ in Contract #9101.
​
Options
On the 'Roles' screen, click 'Add Role' to create a new role. These are your options:
Option
Description
Key
Provide a key that will be used in RuLa to reference this role. The key must be unique (not used somewhere else) and written in PascalCase, e.g. AccountHolder, PowerOfAttorney.
Name
The name of the role in your default language.
Outcome Ontology
A role describes the relationship between the instance of the ontology it's applied to, and the instance of the outcome ontology you select here.
Looking at the example above, Müller is the instance of the ontology 'Person', who has a role as AccountHolder in the instance #1234 of the outcome ontology 'Contract'.
Always shown in Party Matrix?
Yes: this role will always be shown in the party matrix at the top of a tab.
Merge on Creation
Yes: the role will be added to existing instances in the case.
No:  a new instance will be created, with the role added to it.
Example: with the role 'Signatory', you likely want to create a new instance of the ontology Person, whose only role is signatory. It is unlikely a person with role signatory in a case also has other roles, like 'Accountholder'. So here, Merge on Creation should be set to No.
But if you create the role 'Accountholder', it is very likely you will add that to a person who already exists in the case. Set Merge on Creation to Yes.  
Ontologies
Select the ontologies that can take up this role, by clicking 'Add Ontology'.
Information
Located in the right half of the screen, the Information tab shows you in what pieces of information this role is featured.
References
This tab gives an overview of all locations in atfinity where the role is referenced, for example in which documents or process rules it is used.
The order in which Roles appear in a case, is determined by the order they have in the configuration. Find details on how to change this order here.
Interactions
A role has interactions with these other key concepts:
​Ontology: a role describes the relation between two ontologies.
​Rule: a rule can dictate the creation of an ontology with the role.
​Document: by referencing the role in a condition attached to a document, this document will only be included in the case if an instance has that specific role, for example.
​Information: each piece of information has a specification on which role (or ontology) it is about.
​
Glossary - Previous
Proof
Next - Glossary
Workflow
Last modified 1yr ago
Copy link
On this page
Definition
Options
Interactions