Skip to main content

Custom Fields

Custom fields enable users to assign values to rules, workflows, or checks based on specific requirements.

Common Use Cases​

  • Facilitate the categorization and tagging of iceDQ rules to enhance organization and retrieval.
  • Capture supplementary data points that are essential for comprehensive reporting and analysis.
  • Store integration-specific information required for seamless data exchange with third-party systems.
  • Support tailored user experiences by allowing the capture of context-specific information.

Core Components​

  • Field Name: A unique identifier for the custom field, used internally by the system to reference the field in configurations and operations.
  • Display Name: The user-facing label for the field is shown in the application interface. It should be clear and descriptive to ensure users easily understand the field's purpose.
  • Field Types: Custom fields are available in multiple types, each designed to capture a specific type of data. Below are the key field types:
    • DatePicker: Allows users to select a date from a calendar interface.
    • DatetimePicker: Allows users to select both a date and time.
    • Label: Provides context or describes other input fields. A default value must be assigned when creating a label.
    • MultiSelectDropDown: Allows users to select multiple options from a list. Values are required when creating this field, and users can remove selections if needed.
    • Paragraph: Suitable for longer text input, typically spanning multiple lines.
    • SingleSelectDropDown: Allows users to select a single option from a list. Values are required when creating this field.
    • SingleSelectMap: Allows users to select a single location on a map. Values are required when creating this field.
    • Text: Simple input field for short, single-line text entries.
    • Toggle: Enables users to turn an option on or off, often used for settings or binary choices (e.g., "Enable/Disable"). Toggle fields automatically apply the values true and false, with the default set to false.
    • Number: Allows users to input numbers.

Best Practices​

  • Use descriptive field names: Ensure that field names are clear and meaningful to support easy identification and reference within the system.
  • Choose Intuitive Display Names: Display names should be user-friendly and self-explanatory, enabling users to understand the field's purpose quickly.
  • Review and Maintain Fields Regularly: Regularly assess Custom Fields to ensure they continue to serve their intended purpose. Remove or update fields that are no longer useful, and aim to create only those that are essential to data governance, analysis, or reporting needs.

How To: Create Custom Fields​

  1. Navigate to the Administration module.
  2. Select the Configurations tab.
  3. Select Custom Fields.
  4. Click on New Field to create a new custom field.
  5. Configure a new account:
    1. Account Name: Select the account under which the custom field needs to be created.
    2. Field Name: Enter a unique name for the field.
    3. Display Name: Enter a descriptive name which will be visible to users on the application.
    4. Field Type: Select the desired field type according to the specific context of the field.
    5. Description (Optional): Provide a brief description of the field, if needed.
  6. Click on Save to create the custom field.

Video Guide​

This video shows how to create a custom fields.

How To: Configure Custom Fields​

Some custom field types - such as Single Select Map, Single Select Dropdown, Label and Multi Select Dropdown - require pre-configured values to function as intended. The following steps outline how to configure values for these field types:

  1. Navigate to the Administration module.
  2. Select the Configurations tab.
  3. Select Custom Fields.
  4. Click on the name of the Custom Field that needs to be configured.
  5. Click on Add.
  6. Provide the following details to define a value for the field:
    1. Value: Specify the value that the field will take.
    2. Default: Select this option to set the value as the default. At least one value must be designated as the default.
    3. Description (optional): Add a brief description of the value, if necessary.
    4. Action: Click the checkmark icon to add the value to the field.
  7. Click on Save to apply the changes to the custom field.

This defines a valid input option for the field. Add multiple values as needed, based on the intended configuration and use case.

How To: Delete Custom Fields​

  1. Navigate to the Custom Fields section under the Configurations tab.
  2. Select the checkbox next to each field that needs to be deleted.
  3. Click on Delete to permanently remove the selected custom fields.
Last updated on