Define fields on asset types

Data Integrity Suite
Product
Spatial_Analytics
Data_Integration
Data_Enrichment
Data_Governance
Precisely_Data_Integrity_Suite
geo_addressing_1
Data_Observability
Data_Quality
dis_core_foundation
Services
Spatial Analytics
Data Integration
Data Enrichment
Data Governance
Geo Addressing
Data Observability
Data Quality
Core Foundation
ft:title
Data Integrity Suite
ft:locale
en-US
PublicationType
pt_product_guide
copyrightfirst
2000
copyrightlast
2025

When adding custom fields, be thoughtful about what metadata will be most useful for your specific data governance use cases. Field should capture attributes that matter for the types of analysis, reporting, and governance your organization needs.

Create a field for an asset type

  1. Navigate to Configuration > Governance and then select the asset type tab: Business Assets or Technical Assets.
  2. Add a new field to a selected asset type. There are two ways to define a new field on an asset type:
    • Click the asset type row from asset type list view to open its Information panel Select the Fields tab and click the + (Add Field) button.
    • OR, on the asset type list page, click asset type name to open its Details page. Select the Fields tab and click the Create Field button.
  3. In the Create Field dialog, choose a Field Type from the list.
  4. Configure the following settings for the selected field type as required. The additional settings that are available will vary depending on the selected field type.
    • Field Name: A name for the field. It must be unique within that asset type.
    • API Name: Represents the name that is referenced when loading data using the API and it must be unique. It is automatically generated based on the value that you enter for the Field Name.
      Warning: You cannot define a field with an API Name of KeyPath, Path, or DisplayPath. Additionally, you cannot change an API name after the field type has been saved.
    • Category: The category that the field will be included in. Fields that are added to the same category are grouped together on the asset detail page. If a category is not assigned to a field, it appears in the General property category. You can use the ellipsis to choose from defined categories for the asset type.
    • Field Description: To display in a tool tip when hovering over the field on the asset detail page.
    • Listable: Determines whether or not the field appears as a column in the asset list view. If it is set to True, then Column Width (pixels) and Sort Order settings are available:
      • Column Width (pixels): Sets a value, in pixels, for the column width of the field when it appears in the asset list view.
      • Sort Order: Defines how multiple fields of the same asset are displayed in the asset list view. By default, fields are sorted in ascending order and you can choose to sort them in ascending or descending order. If you define a Sort Order on multiple fields on an asset, the data is first sorted on the field with the lowest sort order value. If there are two records with the same value, the data will then be sorted on the field with the next lowest sort order value.

        For example, you have a "Country" field with a sort order of 1, and a "Town" field with a sort order of 2. There are two records in the country field with the same value: India, UK, USA and USA. In this case, the USA records would be sorted according to the Town field, with the Boston record listed before the Chicago record.

    • Requirement: Sets whether or not a particular field is required when completing a form. This drop-down has the following three options available:
      • Required: Sets whether or not a particular field is required when completing a form, such as adding a new user and needing to specify their title. When bulk loading data, required fields are displayed in bold.
      • Key: Sets whether or not a field is a 'key field' for the selected asset type. A key field is a field in a record that contains unique data which can be used to distinguish that record from all other records. An account number, a product code or a customer name are examples of key fields. On some asset types, you cannot define a key field. In this case, the key field is defined by default. For example, the default key field for Reference List Items is the Code field.
        Warning: If you change the key fields on an asset type, after data has been loaded, you will need to edit the existing assets to ensure that the updated key fields are used. Any change to key fields will invalidate the duplicate check functionality on existing records and could result in duplicate data when bulk loading.
      • Optional: You can choose this if you would like to keep it as an optional requirement.
    • Show In Details Tab: Determines whether or not the field appears on the asset detail page and the information side panel.
      • If this option is not selected, the field is hidden from the Details tab.
      • Display in Column: If Show In Details Tab is checked, you can select Display in Column to display the field in a column on the asset detail page. When enabled, displays the field in a column on the asset details page. Multiple adjacent fields with this option are displayed on the same line.
        Note: This setting is applicable to all asset types that have a detail page, and does not apply to these field types: JSON, Relation Lookup, and Tag.
      • Display in Tab: When enabled, displays the field in a tab on the asset details page. Multiple adjacent fields with this option are organized into a single tabbed view. Available for Relation Lookup field types.
    • Display as Badge: When enabled, displays relationship fields as tabs on the details page. Available for List field types pointing to reference lists. Only one list field per asset type can be configured with the Display as Badge setting. Commonly used for fields like Certification Status to highlight status in the title bar.
    • Show if Empty: If this option is selected, the field will always be displayed on an asset detail page, even if there is no specified value. This option is not selected by default. The default behavior is to only display fields that have specified values.
    • Persist in Filters: If selected, the field appears as a persistent filter in the asset list view.
  5. Once all the settings are configured, click Create Field to save the new field. You can also click on Add and Create Another to save the current field and immediately start creating a new one

These options are available when you click the ellipsis next to a field:
  • Move To Top: To move the field to the top of the list.
  • Move Up: To move the field up by a row.
  • Move Down: To move the field down by a row.
  • Move To Bottom: To move the field to the bottom or end of the list.

View details for a field

  1. Navigate to Configuration > Governance. Select the asset type tab: Business Assets or Technical Assets to see all the associated fields for each asset type.
  2. Click on an asset type row and open the Fields tab. A list of all the fields for that asset type will appear.
  3. Click the ellipsis next to a field name and then select View Information. Alternatively, you can click the field row.
  4. Both the options open the Information side panel with all the details of that field.

Edit a field for an asset type

Note: Not all fields are available for edit.
  1. Navigate to Configuration > Governance. Select the asset type tab: Business Assets or Technical Assets to see all the associated fields for each asset type.
  2. Click on an asset type row and open the Fields tab. A list of all the fields for that asset type will appear.
  3. Click the ellipsis next to a field name and select Edit.
  4. An Edit Field dialog box with existing field details will appear.
  5. Modify the details of the field as required and click Save.

Delete a field for an asset type

Warning: Ensure that you actually want to delete the field. This operation cannot be undone.
  1. Navigate to Configuration > Governance. Select the asset type tab: Business Assets or Technical Assets to see all the associated fields for each asset type.
  2. Click on an asset type row and open the Fields tab. A list of all the fields for that asset type will appear.
  3. Click the ellipsis next to a field name and select Delete.
  4. A dialog box asking for confirmation will appear. To proceed, click Delete.