In this article
- What is a relationship definition?
- Create a new relationship definition
- Adjust a relationship definition
- Object combinations
- Object property connections
- Source connections
Within BlueDolphin it is possible to automatically or manually establish a relationship between two objects. Initially, the relationship definitions are created by the insertion of a template. The Admin module illustrates how to create new relationship definitions or adjust existing ones.
What is a relationship definition?
The relationships within BlueDolphin are based on the relationship types of ArchiMate (see the table below).
Relationship |
Definition (or the opposite direction) |
Access |
Accesses (or Accessed by) |
Aggregation |
Aggregated by (or Aggregates) |
Assignment |
Assigned to (or Assigned from) |
Association |
Associated with (or Associated with) |
Composition |
Composes (or Composed of) |
Flow |
Flow to (or Flow from) |
Influence |
Influences (or Influenced by) |
Realization |
Realizes (or Realized by) |
Specialization |
Specializes (or Specialized by) |
Triggering |
Triggers (or Triggered by) |
Used By |
Used by (or Uses) |
From within the Admin module, you can give a “logical” name to a relationship based on the relationship definition. It is also possible to create multiple relationship definitions based on the same ArchiMate relationship type. After a relationship type has been adjusted, the structure is still based on the ArchiMate relationship. This ArchiMate relationship is also visible when you visualize objects in diagrams and views.
In addition, you can specify between which object definitions the relationship definition can be placed. You can also use Relationship definitions to ensure that relationships are found and placed automatically between BlueDolphin objects.
When you choose Relationship definitions in the Admin module, the screen below is shown.
Create a new relationship definition
Click the Add relationship definition button to add a new relationship definition to your BlueDolphin environment.
The following screen appears:
Type in the name for the new relationship definition and click OK.
Adjust a relationship definition
Once you have created a new relationship definition or selected an existing definition, you can further configure it. The first tab contains generic information about the definition.
The fields are explained in the table below.
Field |
Description |
Name |
The name of the relationship definition. |
Based on |
The ArchiMate relationship type on which this relationship definition is based. |
Weight |
The weight of the relationship type. |
Label |
The name of the relationship that is displayed to the user. |
Label alternative direction |
The name of the other direction that is shown to the user. |
Detect relationships |
After clicking the button Detect relationships, BlueDolphin will search for all possible relationships based on the configuration of the definition. |
Object combinations
When you want to make a relationship available for use in BlueDolphin, you must specify between which object definitions the relationship may be placed. The following screen is shown when you select the tab Object combinations.
Next, you will find a list of combinations between object definitions. By clicking on the trash icon, you can remove a permitted combination. The relationships that are already created will be retained and the user cannot select the relationship in the future.
To add a new combination, go to Admin > Configuration > Object definitions.
From there, select the object definition that you need and go to its Object combinations tab.
Click the button within the blue bar and the following screen appears:
Choose the second object definition and type of the relationship, then click Save. Now the combination is added to the relationship definition.
Object property connections
There are two methods to detect automated relationships in BlueDolphin. The first one is the Object property connections. You can use this method when an object includes properties that can be found in another object. You have defined these object properties by the object definition.
The tab Object property connections presents an overview of the available object property connections. To add an object property, go to Admin > Configuration > Object definitions.
From there, select the object definition that you need and go to the Object combinations tab.
To add an object property, go to the enabled object combination that you need and click the three-dot menu next to it.
Click Edit property connection and the screen below appears:
The fields are explained in the table below:
Field |
Description |
Connection name |
The name of the object property connection. |
From: Object definition |
Object definition from which the relationship flows. |
From: Link to object title |
Object title whose value has to be used in the search for a relationship. |
From: Object property |
Object property whose value has to be used in the search for a relationship. |
To: Object definition |
Object definition where the relationship flows to. |
To: Link to object title |
Object title whose value has to be used in the search for a relationship. |
To: Object property |
Object characteristic whose value has to be used in the search for a relationship. |
Connection pattern |
A regular expression to adjust the values of “FROM: Object property” so a match can be found. When nothing is specified, the values must match exactly. |
Standard relationship description |
Standard explanation which is included in the relationship when it is found via this definition. |
Source connections
The second method for detecting automated relationships within BlueDolphin is Source connection. You can use this method when you have a source that can serve as a connection table. You should have imported this source via the Admin module.
To add a source connection, go to Admin > Configuration > Object definitions.
From there, select the object definition that you need and go to the Object combinations tab.
To add a source connection, go to the enabled object combination that you need and click the three-dot menu next to it.
Click Edit source connection and the screen below appears:
The fields are explained in the table below.
Field |
Description |
Connection name |
The name of the object property connection. |
Select source |
The data source that is imported via the data collection module and contains link fields from the source. |
From: Search field |
The field from the link table which contains the FROM value. |
From: Object definition |
Object definition from which the relationship flows. |
From: Link to object title |
Object title whose value has to be used in the search for a relationship. |
From: Object property |
Value of the object property that has to be used in the search for a relationship. |
To: Search field |
The field from the link table which contains the TO value. |
To: Object definition |
Object definition where the relationship flows to. |
To: Link to object title |
Object title which value has to be used in the search for a relationship. |
To: Object property |
Value of the object property that has to be used in the search for a relationship. |
Relationship description |
Standard explanation which is included in the relationship when it is found via this definition. |
Comments
0 comments
Please sign in to leave a comment.