Customizing a Dynamic Form Field Configuration

Modify the example Dynamic Form Fields Configuration to create a custom dynamic form fields (DFFs) configuration.

Introduced in January 2025

Define the views, groups, and fields you want to create. Views appear as additional tabs in the configuration slide-out. You can aggregate fields into groups to organize the fields logically.
Before you begin, initiate your DFFs configuration.
  1. Open your DFFs configuration file. 
    ...
            "views": [
                {
                    "key": "View_Example",
                    "order": "10",
                    "displayText": "View Example",
                    "helpText": "",
...
  2. To specify the name of your custom tab, modify the displayText key.
  3. Specify the order in which the tab appears. NI recommends the following order values.
    • Assign your first custom tab to order "10".
    • Increment subsequent tabs by 10. For example, "20" and "30".
    Incrementing by 10 allows you to re-order tabs or insert new tabs between existing tabs easily.
  4. Optional: Modify the i18n key so you can provide a localized version of the tab you are adding. 
    ...
                    "i18n": [
                        {
                            "localeId": "de",
                            "displayText": "View Beispiel",
                            "helpText": ""
                        }
...
    1. Specify the localeId. Use one of the following supported values.
      • "fr" for French
      • "de" for German
      • "en" for English
      • "ja" for Japanese
      • "zh" for simplified Chinese
    2. Update displayText with the localized text.
    By default, SystemLink Enterprise shows the value for displayText you defined in the views key. SystemLink Enterprise shows the localized value for displayText when the following conditions are met.
    • You define displayText in the i18n key.
    • You set your browser language to one of the supported localized languages.
  5. Optional: List the key values for the groups you plan to use to organize your fields on the user interface. You define these groups further down in the configuration file. 
    ...
                    "groups": [
                        "Group_1_Example",
                        "Group_2_Example"
                    ]
...
    1. Specify the fields that the group contains.
  6. Define the groups you plan to use to organize your fields on the user interface. 
    ...
"groups": [
        {
            "workspace": "f58beba8-66de-4ba5-89f4-3388fd814f2e",
            "key": "Group_1_Example",
            "displayText": "Group 1 Example",
            "helpText": "",
...
    1. List the key values for the fields that the group contains. You define these fields further down in the configuration file. 
      ...
            "editable": false,
            "fields": [
                "Text_Field_Example",
                "Checkbox_Field_Example",
                "Number_Field_Example",
                "Enum_Field_Example"
            ]
...
  7. Define the fields you want to add. The example configuration file includes one field of each type.
    • "TEXT"
    • "BOOLEAN"
    • "NUMBER"
    • "ENUM"
    ...
    "fields": [
        {
            "workspace": "f58beba8-66de-4ba5-89f4-3388fd814f2e",
            "key": "Text_Field_Example",
            "type": "TEXT",
            "displayText": "Text Field Example",
            "helpText": "Help Text",
...
    1. Optional: Delete the fields you do not want to add.
    2. Optional: Duplicate the fields you want to add more of. Create a unique key value for any field you duplicate.
    3. Update the display text.
    4. Optional: Add a i18n key so you can provide a localized version of each field you are adding.
  8. Add requirements and validation parameters for the field. 
    ...
                }
            ],
            "editable": true,
            "mandatory": false,
            "defaultValue": null,
            "validation": {
                "minValue": 0,
                "maxValue": 10
            }
...
  9. Save your updated configuration file.
  10. Copy the contents of the configuration file and use the DFF API to update your initial configuration. 
    post_nidynamicformfields_v1_update-configurations
  11. Open SystemLink Enterprise.
  12. Navigate to the resource you specified in the configuration file to see your dynamic form fields.