A field is metadata that can be added to a component or reference to provide additional information. For example, you can add a Version Number field to an Application component to store details about the version that the application is currently on.
Ardoq metamodels come with metamodel-specific fields and references, but custom fields and references can be added as well.
Fields can be searched and filtered to help you narrow down your selection of components or references.
When to Use Fields
A field is usually used to qualify a component or provide additional context for it. For example, an Application component might have a Service Level Agreement field or a Life Cycle field.
In other cases, a field will not be enough to describe the complexities of a component. In that case, it is better to create a new component with its own descriptive fields and then create a relationship between the two components.
For example, if you have a Server component, adding a field called Operating System will not be enough to describe precisely which variant of an Operating System is running on the server. That is, the Operating System has its own version, life cycle, business criticality and so on — too many details to easily capture in a field or even a number of fields.
In this situation, we recommend creating an Operating System component with its own relevant fields and then connecting it to the Server component through a reference like Runs on.
Creating New Fields
All components have a number of built-in fields, such as type and last modified.
You can create fields in bulk when importing data using an integration.
To create a new field in a workspace:
Click the gear icon (Metamodel and workspace) in the top-right corner of the screen.
Under Edit metamodel, click Manage fields.
On the Fields tab, click Add field in the top-right corner.
Under Label, type the name of the new field and click Create "<your field name>". To reuse a field that already exists in your organization, select it from the list instead.
Choose the field type and click Next.
Under Applies to component types or Applies to reference types, select at least one type. Save stays disabled until you do.
Click Save.
Field Types
Use field types to easily store different types of data about your components and references.
Field type | Description |
Text | Stores alphanumeric characters of variable length. |
Number | Stores numerical values |
Stores email addresses | |
Text paragraph | Stores longer pieces of text, often used for notes or descriptions |
Date time | Stores a single date (e.g. creation date) |
Checkbox | Stores Note on Resetting: While clicking a checkbox in Data Inventory toggles between Checked and Unchecked, you can reset a checkbox back to "Not set" using any of these methods:
|
List | Allows users to select from a predefined list of options. |
Select multiple list | Allows users to select multiple options from a predefined list. |
User | References a user within the Ardoq platform. |
URL | Stores web addresses |
Date range | Stores a start and end time |
Calculated field | Stores values derived from multiple inputs. E.g. Calculates and stores the health score derived from adding up the business and technical fit scores of applications. Learn more about calculated fields in this article. |
File | Stores a URL linking to a file and can be used to preview the file within Ardoq. Currently limited to the SAP Signavio integration. |
Number Field Formatting
Number fields are displayed according to the user's selected locale. In addition, the number field can either be formatted as a plain number or as a currency. When creating or editing a number field, there is a drop-down where the formatting can be defined.
Visualizations Adjusted By Field Values
Fields that use numerical values can change the visualizations, such as the Treemap. Click the “By custom field” and select the field from the drop-down menu. Your visualization will then automatically be recalculated according to represent the field you selected.
For fields that apply to both the parent and the child, the visualization will present the accumulated value:
FAQ
Are there any reserved field types?
Yes, Ardoq has several reserved field names within Ardoq that cannot be used to name your custom fields. They are listed in table below for your reference:
description | isPublic icon |
If you attempt to use one of these as a field name, you'll be presented with the following message:
Field Label (Name): We recommend keeping field labels to 100 characters or fewer.
Field Description: Descriptions can support up to 10,000 characters.
If you have questions or need more information, browse our Knowledge Base or reach out to us from our website or using the in-app chat.