Create custom semantic type fields - Precisely Data Integrity Suite

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
2026

Semantic type fields add custom metadata to semantic types. Each workspace can define its own set of semantic type fields, which are available for assignment to all semantic types in that workspace. Use semantic type fields to identify sensitive data, enforce security policies, and track data lineage. The field creation process involves selecting a data type, configuring basic properties, setting validation rules, and defining display options.

When you create a semantic type field, certain properties are locked after creation and cannot be changed. Custom fields offer full editability of most properties, while default fields restrict changes to display options only.

  1. Go to Configuration > Catalog > Semantic Type Fields.
  2. Click Create Field.
  3. Select a Data Type.
    What's changed: In the new user experience, Data Type appears as Field type. For more information on the new experience, see About the new user experience.
  4. Configure basic field properties:
    • Field Name: Enter the display name (e.g., "PII", "Product Code").
    • API Name: Auto-generated programmatic identifier for API calls and integrations.
    • Category: Select Configuration or General.
    • Requirement: Select Required or Optional for the asset type.
    • Description (optional): Provide a description of the field's purpose.
    Note:
    • Custom fields: Once created, you can edit Field Name, Requirement, Description, Value Selection/Validation options, and Display Options. Data type and API Name cannot be changed.
    • Default fields: You can only edit Display Options (Listable, Show if Empty, Column Width, etc.). All other properties are locked.
  5. Configure Value Selection & Validation options based on the selected data type.
    What's changed: In the new user experience, Value Selection & Validation appears as Type configuration, Field Name appears as Field label, and API Name appears as Field ID. For more information on the new experience, see About the new user experience.
  6. Configure Display Options to control how the field appears in the user interface.
    • Show in list: Field appears in the list view grid.
    • Column Width (Optional): Specifies column width in the grid.
    • Show in details page: Field displays in the details panel.
    • Display in column: Field is shown as a grid column.
    • Show if empty: Field displays even when it has no value.
    • Editable in UI: Users can edit the field value in the UI.
    • Persist in filters: Field can be used as a filter criterion with persistent selection.
  7. Click Create Field to save the field.
    The new field becomes available for assignment to semantic types in your workspace.

Supported data types for semantic type fields

Semantic type fields support several data types, each with specific configuration options. When you create or edit a semantic type field, the available properties in the Value Selection & Validation section depend on the selected data type.

Data type Description Configuration options
Boolean A true or false value with customizable labels for each option.
  • Label for first option: The display label for the true value (e.g., "True", "Yes", "Enabled").
  • Label for second option: The display label for the false value (e.g., "False", "No", "Disabled").
  • Default value (optional): Select the default boolean value when creating new instances. You can set the default to true, false, or leave it unset.
Date A date value without time component. Default value (optional): Select a default date value for new instances using the calendar picker. The date format is DD MMM YYYY (e.g., 15 Jan 2024).
Date with Time A date and time value with timestamp information. Default value (optional): Select a default date and time value for new instances using the calendar and time picker. The format is DD MMM YYYY - hh:mm (e.g., 15 Jan 2024 - 14:30).
Decimal A numeric value with decimal precision.
  • Minimum value (optional): The minimum numeric value allowed for the field.
  • Maximum value (optional): The maximum numeric value allowed for the field.
  • Decimal places (optional): The number of decimal places to display and validate. For example, setting this to 2 restricts values to two decimal places (e.g., 10.25).
  • Default value (optional): The default decimal value assigned when creating new instances.
JSON A JSON-formatted text value for complex data structures.
  • No validation options: JSON fields do not have type-specific validation properties in the Value Selection & Validation section. The UI displays a "No options available for this field type" message. Configure display options as needed.
Link A URL or hyperlink reference.
  • Link name default value (optional): The default display text for the link.
  • URL default value (optional): The default URL for the link. Must start with https:// or http://.
List A collection of values.
  • Select list: Configure the list of available values for selection.
  • Allow multiple selections: When enabled (Yes), users can select multiple values from the list. When disabled (No), only a single value can be selected.
  • Default value (optional): Select a default value from the configured list.
Integer A whole number value with optional minimum, maximum, and increment constraints.
  • Minimum value (optional): The minimum numeric value allowed for the field.
  • Maximum value (optional): The maximum numeric value allowed for the field.
  • Default value (optional): The default numeric value assigned when creating new instances.
  • Increment (optional): The increment step for numeric fields, used when incrementing or decrementing values in the UI.
Reference List A reference to values from another list or catalog.
  • Reference configuration: Configure the reference source and mapping for the reference list values.
  • Display item list: When enabled (True), the reference list values are displayed as a list in the UI. When disabled (False), values are displayed in a different format (e.g., dropdown or search field).
  • Default value (optional): Select a default value from the referenced source.
Text (Simple Text) Plain text with optional validation pattern and maximum length.
  • Validation pattern (optional): A regular expression pattern to validate field values. For example, [A-Z]{2}\d{3} validates a 5-character product code with 2 uppercase letters followed by 3 digits.
  • Maximum length (optional): The maximum number of characters allowed for the text field.
  • Default value (optional): A default text value assigned when creating new instances. For HTML/Richtext fields, the default value field includes a rich text editor with formatting options including font selection, text styling (Bold, Italic, Underline), text alignment, link insertion, code blocks, and additional formatting tools.
Text (HTML/Richtext) Formatted text with HTML or richtext markup support.
Tag A tag or label value for categorization. Tag Type: Select the type or category of tags available for this field. This determines which predefined tags users can select.

Assign semantic type fields to semantic types

After creating or configuring semantic type fields, you can assign them to semantic types to classify and organize your data. The available fields include the custom fields you have created in your workspace, as well as any default fields.
  1. Go to Configuration > Catalog > Semantic Types.
  2. Create a new semantic type or click Edit on an existing one.
  3. In the semantic type creation or edit dialog, locate the section for assigning field values.
  4. Select or enter values for the available semantic type fields.
    The input method depends on the field type:
    • Boolean fields: Click the toggle buttons to select True or False.
    • Text fields: Enter text in the input field.
    • Numeric fields: Enter a number or use the increment or decrement controls.
    • Date fields: Select a date from the date picker.
    • Reference fields: Select a value from the dropdown list.
  5. Click Save to apply the field assignments.
    The field values are now visible in the semantic type details and can be used to filter and manage semantic types based on their properties and classifications.