Field Metadata Overrides

When Nintex Apps retrieves a field from a data object, it returns the field name and field display type as it is stored within the connection. This is part of the field's metadata —which describes what the data is and how it is used. Nintex Apps allows builders to override this metadata to modify the data's presentation at the field level.

Metadata Overrides

Use a metadata override to modify a field in ways that are not dictated within the original metadata.

Imagine connecting to a connection that defines fields in a way that Nintex Apps doesn't recognize—using, for example, a field with the Display type of MONEY, where Nintex Apps uses CURRENCY. Skud will not be able to access or use the data in the MONEY field because it's not a recognized display type.

By using a metadata override, the builder can recharacterize the field by changing the Display type property to CURRENCY, allowing Nintex Apps to access and display the data.

Metadata overrides can be used to:

  • Change the field display type or label

  • Override picklist entries with builder-generated values

  • Specify the number of decimal points for a number field

  • Create a picklist-style UI element and overlay it on a text field or number field

  • Prevent a field from behaving like a combobox, and instead let it behave like a text or picklist field

  • Make a field behave like a number instead of a string (or vice versa)

  • Bring in custom picklist values from an object— without bringing that object into the page as a model

    Note:  Nintex Apps can only override metadata for fields that exist within the connection.

Overriding field metadata

  1. In the Elements pane, click an existing model.
  2. Click Data.
  3. In the Model fields panel, click and select Override field metadata.

Once you select Override field metadata , a modal appears for setting the properties of the metadata override.

 

Once a field's metadata has been overidden, clicking the field within the Model fields panel opens the override properties modal.

Note:  Different types of fields offer different properties, and when you change the Display type property, new options become available.

Properties

  • Field ID: The name of the selected field.

  • Display type: The type of field. Options include:

    • Picklist fields and multi-select Picklists
    • String fields
    • Date and datetime fields
    • Number/integer, and currency fields
    • Address and phone fields
    • Text and textarea fields
    • URL fields
    • Boolean fields

  • Override field metadata: If checked, displays override options. These options vary depending upon the original Display type for the field.

    • Label: Replaces default field label with custom text. Use the field picker to select a field to use as the column label.

      Note:  This feature lets you choose another field's name and re-label the column with it, to shorten or clarify the column's identity or purpose for users.

    • Inline help text ( Form/Field Editor only ): If Show inline help is set in the field's General tab, Nintex Apps displays the text in this field as just-in-time user help.

      Note:  This option only works when the field is displayed in a Form.

    • Display type: A list of display types that the field can be converted into, including:

      Note: 

      This field lets you override the field type, temporarily altering how the field displays within Nintex Apps —into a new field type, termed a "display type." Overriding the field type in this way, however, does not alter the field type in the original connection.

      • Checkbox
      • Combobox
      • Currency
      • Date
      • Datetime
      • Email
      • Formula
      • Multi-select picklist
      • Number
      • Percent
      • Picklist
      • Reference
      • Text
      • Textarea
      • Url
      • Unique ID (UUID)

    Depending on the Display type selected, Nintex Apps offers additional properties:

    • Required: If checked, text input is required. This setting does not persist across Nintex Apps pages and does not override existing data model settings within the connection.

      Note:  Nintex Apps automatically respects the validation rules and field-level security from the connection.

    • Picklist source: The source for the values displayed in the picklist:

      • Manual: Picklist values are created manually by the builder in the Picklist tab.
      • Rows in model: Picklist values are pulled from a model.
      • Snippet: Picklist values are sourced from a JavaScript snippet.

    • Return type and Formula return type: Determines how Nintex Apps displays the resulting values:

      • Checkbox

      • Currency

      • Date

      • Datetime

        Note:  Nintex Apps stores all date and datetime fields in ISO 8601 format.

      When directly manipulating the value of a date or date time field in a Nintex Apps model, the value must be formatted as follows:

      • Dates: yyyy-MM-dd
      • DateTimes: yyyy-MM-dd'T'HH:mm:ss[.SSS]'Z'
      • Percent
      • Number
      • Text

    • Read-only: If checked, text fields are read only and cannot be edited by users. This setting does not persist across Nintex Apps pages.

      Note:  Nintex Apps automatically respects the validation rules and field-level security from the connection.

    • Restrict input to picklist entries: If checked, users must select from the provided picklist entries or their input will be discarded. If unchecked, users can enter values that do not correspond to the provided picklist values.

    • Placeholder: Text or prompts that appear inside editable sections within the component. Commonly used to provide instruction for more complex field requirements, this field is compatible with merge syntax.

    • Length:

      • For a currency field: The number of integers that can be entered in the field. Options: 0-17 or the field default.
      • For a text or textarea field: The maximum number of characters that can be entered in this field.

    • Decimal places: The number decimal places that can be used in the field. Options: 0-9 or the field default.

    • Rich text: Enable rich text for the field.

This tab is available when the Display type is Picklist or Multi-select Picklist and the Picklist Source is Manual.

Click add Add to create a new value for the picklist dropdown menu, then configure:

  • Value: The value that is stored and used in the connection.
  • Label: The text displayed to the end user.

Create as many entries as needed.

This tab is available when the Display type is Picklist or Multi-select Picklist and the Picklist Source is Rows in a model.

  • Model: The model that contains the field from which picklist entries are drawn.
  • Entry value: The field used as the source for the values in the picklist.
  • Entry label: The text displayed to the end user.

This tab is available when the Display type is Formula.

Construct a formula in the Enter Formula field by clicking the buttons (and fa-caret-down dropdowns) provided:

  • Insert field: The field from the model's object to be used in the formula.

  • Insert operator: The operator that defines the relationship between the field and its function. (Standard operators are used.)

    Note:  Equality operators are always interpreted strictly, meaning they compare both type and value.

    • For example, the formula 1 = "1" returns false, because "1" is a string type, even though the value could be interpreted as one.

    • Even if these equality operators are formatted non-strictly— = and !== — Nintex Apps nonetheless interprets them strictly. Both = and == are interpreted as follows:

      1 = "1" returns false 1 == "1" also returns false

      Important:  In previous Nintex Apps releases, equality operators could be used non-strictly as == for equal and !== for does not equal. As of the Brooklyn Q2 Point Release, this functionality is no longer supported.

  • Insert function: The desired function for the formula. For more on functions, see Formula and Function Reference.

This tab is available when the Display type is Reference.

Reference setup

The reference Display type allows you to create a connection between the field (which is in a specific connection) and separate, secondary connection (the "reference"). In this tab, configure that relationship:

  • Connector: The reference connector.
  • Connection: The specific connection to use as the reference.
  • SObject/Entity Type: The specific object within the referenced connection.
  • Related entity: key field: The field on the reference object that will serve as a "bridge" between the reference connection and the primary connection. (Used as a "key" to link the data.)
  • Relationship field name: The name of the field on the referenced object, stored as a UI-only field on the primary object to display a plain-language name for the referenced object. (This field stores information about the record that is referenced by the end user.)

This section lets you specify additional fields that can be added as related data. These added fields are then used in search, or in display templates.

Click add Add to create a new Related-data field, then configure:

  • Field: The field name.

This tab is used to determine pre-populated values that display during new record creation.

Note:  The properties available are determined by Display type.

  • Content: Options include:

    • Single specified value: Use a specific value to pre-populate the field.

      • Value: The value to display to the user.

        Note:  Different display types offer different value options

        • Date fields include options to select:

          • Date formula syntax
          • A specific date (selected from a calendar picker)

    • Datetime fields include options to select a specific time.

    • Boolean fields let you choose true or false.

    • Multiple specified values: Use a set of specified values to pre-populate the field.

      • Values: The values. For each additional value, click Add another value.

    • Field from another model: Use a field from another model to pre-populate the field.

      • Source model: The name of the model that contains the field.
      • Source field: The specific field on the source model.

    • Page/URL parameter value ( Nintex Apps for Salesforce ): Use a Salesforce Lightning page or URL parameter (for example, the ID parameter) to pre-populate the field.

      • Parameter: Indicates the specific parameter.

    • Running user attribute: Returns records if the value of a field on the model matches the value of a field on the current user's record. Options include:

      • Default currency
      • First name
      • Last name
      • Email
      • Locale
      • Name
      • Organization ID
      • Organization name
      • Profile ID
      • Profile name
      • Session Id
      • User ID ( default )
      • User name
      • Use role ID
      • User type
      • Is multi currency org