Keywords: References, dependencies, relations
This article goes through the creation and editing of references and their dependencies.
We'll cover three different actions:
Create a reference between two components
Create a new reference type
Edit a reference type
Create a Reference
Let's start with how you create a reference between two components.
A reference documents a dependency between two components. Each reference has a source component and a target component.
1. To create a reference, hover the cursor over the source component in the component list on the left-hand side of the screen. A link icon will appear to the right of the component name. Click on this link icon.
2. Without holding the mouse button down, move the cursor to the target component and click on it. This will open a "Create Reference" wizard on the right-hand side of the screen.
3. Select which type of reference you are creating from the drop-down list. The alternatives in the list are those defined in the model for this workspace. Click save.
Create or Edit a Reference Type
The reference types are linked to your dataset. This will help you document consistently what is important to optimize filtering and view output. We highly recommend being as specific as possible when working with references, to make filtering and working with views easier for you when you have a lot of data. If in doubt, two unique references are better than one.
To create or edit a reference type:
In the left navigation sidebar, go to Data > Data Inventory.
Select and open your target dataset or component type (e.g., Application).
Click on Workspace manager at the top left.
In the side menu, select Metamodel.
Go to the Reference types tab:
To create: Click
+ Add reference type.To edit: Click on an existing reference type from the list to modify its details, line formatting, or cardinality.
Enter or update the details and click Save in the top-right corner.
Note: The dataset where you create or manage reference types represents the source component type (where the outgoing relationship arrow originates).
Tip: References can also have Fields, just create a field and make sure it is set for a reference type.
Bulk editing and reversing References:
There are 2 ways to easily edit several references at once and/or change their direction.
1.- In the Block diagram view you can draw a box around the references you wish to edit, and then right clicking on any of them.
2.- Also in the Block diagram view, apply a "Group by workspace" grouping rule in the perspectives menu. Then toggle the "Collapse all" view modifier in the top menu bar. All references should now be aggregated and can now all be edited (or reversed) at once by right clicking them.
Keep in mind that if you reverse references between two workspaces that do not have the same reference types, you will have to select a new reference type for the grouped references. You can also keep it unselected to keep it at its original value.
If you still have questions or need more information, reach out to us via our website or by using the in-app chat. After all, we're here to help.
FAQ: How can I delete a reference type that I no longer wish to use?
To delete a reference type, go to Manage Reference Types in the sidebar menu. Note that the reference type must not be in use across the workspace. If deletion isn’t possible, create a perspective filter to locate individual references using that type, delete those references first, and then proceed to remove the reference type.