Skip to main content
What Are References?

Learn how references connect components, and why they are first-class data objects in their own right.

Kristine Marhilevica avatar
Written by Kristine Marhilevica
Updated over 2 months ago

Overview

References define the relationship between components. Well-defined references provide clarity into how elements of your organization are tied together and form the basis for uncovering insights into making organizational improvements.

References have a source component and a target component. In the example below, the Person component and the Organizational Unit component are connected together with the Belongs To reference β€” indicating that, in other words, that a person belongs to an organizational unit.

A component can have multiple source references and destination references β€” both of which are necessary for creating complex metamodels. For example, in the Application Rationalization metamodel, the Application component has 5 incoming and 5 outgoing references.

For a video walkthrough of references, take a look at our video guide to references.

Reference Types

By default, Ardoq has a generic built-in reference type called an implicit reference. It is intended to specify that two components are related in some way, but it doesn't make their relationship explicit. We don't recommend using implicit references unless you intend to make the reference explicit later.

Instead, we recommend creating re-usable references that clearly establish a relationship between components. For example:

  • Person Owns Application

  • Person Reports to Person

  • Application Runs on Server

Once a reference type is created, it can be re-used throughout the workspace it was created in.

Creating References

There are a number of ways to create references between components within Ardoq:

  • From the sidebar in Workspace view

  • From the Grid Editor

  • From the Tabular Importer when using an out-of-the-box integration

  • From the Ardoq REST API

Create References Directly in the Navigator Sidebar

By hovering over the source component you want to start the reference from, you will see a "link" icon showing on the right side. Click it once (do not hold it), and drag it to the component you want to target , then click again.

If you need to open a Parent to access child components after you clicked on the source component, just right-click.

Ardoq parent access child components
Ardoq parent

This will open the Reference tab on the right side. You can then choose the right reference and additional information if necessary.

Ardoq reference

Create Multiple References At Once in Ardoq

This is how you create multiple references at once:

  1. Bulk select components in the navigator (hold down shift or control/command while clicking).

  2. Click the link icon on one of the selected components.

  3. Select whether the references should be incoming or outgoing.

  4. Edit details for all references.

Ardoq multiple references

Using the Grid Editor To Create References

As you might be using the Grid Editor to create new components, you can also use this for creating references.

First, open your Grid Editor at the bottom of the page:

Ardoq grid editor

Choose References and adjust window:

Ardoq references

Start creating new references or change existing ones in the Grid Editor by choosing Target components and Source. As with most functions in Ardoq, be aware that what you see and can choose from is context-sensitive. You will only see the components from the workspace you are standing in, and the level of components that you are standing in.

Choose Workspace level for all Parents, and the correct Parent for the underlying children components:

Ardoq grid editor

Using the View Dependency Matrix For Making References

First, choose the View "Dependency Matrix", and open up the Workspace containing your Source Component(s). Then choose the Targets component(s) Workspace. The Target Workspace has to be opened as well.

Ardoq dependency matrix view

Choose the kind of Reference you wish to create by clicking on the "On cell click" and choose between references already created for the Source Workspace. You will now be creating that reference when you click. The component left side will be the Source and the component showing at the top will be the Target.

Ardoq target
Ardow source

If you clicked the wrong field, just right-click and choose Delete Reference.

Ardoq delete reference

Note

The parent-child relationship is not implemented as a reference but instead derived from hierarchy. As such, you cannot define parent and children components across different workspaces.

Did this answer your question?