Skip to main content
IDs in Ardoq

Learn how components and references are uniquely identified in the Ardoq platform.

G
Written by Gleb Nikonov
Updated over a month ago

Overview

IDs are important in Ardoq because they allow you to uniquely identify components and references and to assign relationships between different components. Internally, the following IDs are available within Ardoq:

  • Component name

  • Custom ID

  • Ardoq ID

  • Ardoq OID

When importing data to Ardoq, each component must have a unique identifier to be importable:

Finally, all IDs can be previewed in the grid editor within a workspace:

However, auto-generated IDs (Ardoq OID and Ardoq ID) cannot be modified.

Component Name

A component name can be a valid identifier for any component whose name is unique — for instance, the name of a country. However, it won't work in cases like the names of people or cities, that may be the same but refer to different persons or places.

In such instances, Ardoq will flag that duplicate values are to be created and will automatically remove any component name after the first instance.

Custom ID

Custom IDs are user-defined IDs most useful for storing IDs imported from other platforms into Ardoq. Custom IDs can be used when bringing relationships from external system into Ardoq — for instance, relating applications to users who are owners of said application.

Ardoq will still create an Ardoq OID for any component with a custom ID.

Ardoq OID

Ardoq Object ID (OID) is an automatically-generated ID for every component and reference within Ardoq based on the MongoDB object ID. It can be used to create references during imports and is usually the ID used for components being exported to other platforms.

Ardoq ID

An Ardoq ID is intended to be a more human-readable alternative to an OID. Ardoq IDs are generated based on the first letters of each word in the name of the workspace and an incremented number. For instance, components in the New Business Units workspace will be called NBU-1, NBU-2, and so on.

Did this answer your question?