1. Knowledge Base
  2. Editing Your Data
  3. Create References

Create References

Documenting References is one of the most powerful features of Ardoq. In Ardoq, you can link Components within a Workspace or even across workspaces in order document any type of reference.

Thanks to the flexibility of the Models, you can capture the implicit dependencies across models such as in the example bellow, showing implicit references between applications, infrastructure and business processes. Since it is possible to capture nearly any type of dependency, it is beneficial to have control over Tags and Filter in order to limit your view to what is most relevant.

Creating References

Creating references is easy in Ardoq. By creating the reference, all your views will automatically update to represent your new reference. You can utilize a number of methods in order to create a reference.

Depending on your preferences, you can choose to use the Smart Link Editor or the Markdown Editor. Follow the steps below to create a reference with the smart link editor. (Refer to the Markdown Editor for more information on how to use markdown).

Using the Smart Link Editor

The Smart Link Editor allows you to quickly create references or add new components that are automatically linked to.

                                                 

You can link between any views. The context bar will show you which component you are linking from.

To cancel the linking action, just press the Esc-key.

Step (1)

Hover over the gear icon and click the create link button.

Step (2)

Drag the link to the target source.


Step (3)

Select the link type. The type of references or dependencies you are able to select are determined by the model.


Documenting Return Values

In order to document return values, you must check that the link types as defined by your Models in the Model Editor. Here you can choose to allow return values per link type. (See below)


When creating a reference you will have an option to create a return value. If you have an existing link which you would like to edit, simply right click the link and select “edit”.

Was this article helpful?