NSO Service Model Form Fields

NSO Service Model Form Fields

Guidelines

• To view device elements from a service model in Form Builder, you will need to specify where to find the YANG files. In newer versions of NSO adapter (version 4 and higher), this is configured in the yangdirs property of the adapter.
• To view service models in older versions of NSO adapter (pre version 4), include your YANG schemas in the load-path of ncs.conf.
• For more information on configuring the NSO adapter to get YANG, check the NSO NETCONF documentation for the adapter.

Create a Form Using NSO YANG Service Model

The following steps correspond to the labels shown in the figure below. To build a form on an NSO YANG service model:

1. Select the appropriate service from the Data Elements dropdown list.
   • The leafs defined in the model will automatically display below the dropdown box.
2. Drag-and-drop the fields to assign them to the form.
   • By default, the field label is the same as the leaf from the service model. See id in the example figure below.
   • To update the field label, click the field and type a new label.
3. Assign the Lists defined in NSO to the form.
4. Group the fields together within a Container.
   • Click the Add Container button to assign a Container to a Form.
   • Toggle the direction icon (double arrow in left corner) to arrange the Containers horizontally or vertically. Containers can also be nested within other Containers.
5. Assign a name to the Form.
6. Click Save.

Figure 1: Form from NSO Yang

Meta Data Fields

In addition to creating a form using the leafs defined in an NSO Yang service model, you can assign Meta Data Fields to a form. Three field types and a checkbox are available.

• Text Box - Allows any characters.
• Number Field - Accepts only numerical values.
• Checkbox - A Boolean field that can be checked or unchecked.
• Dropdown - Accepts one selected option from a dropdown list.

Figure 2: Meta Data Fields

Preview a Form

Once a form is saved, click the Form Preview button (eye icon) in the title bar to preview the form.

Figure 3: Preview Form

All form fields are editable in Preview mode, even those configured as a lead reference or enumeration in the YANG service model, just as they are when the form is allocated to a Workflow. The figure below illustrates the dropdown list generated by an NSO leaf reference.

Figure 4: Preview Form Dropdrown

Enable or Disable Constraints

The Validate Constraints checkbox in Forms allows a user to bypass the must statement validations defined in the YANG service models. The checkbox works at the form level, which means that disabling the checkbox will disable validations for the entire form. The checkbox does not, however, disable other form validations.

Examples

The example below shows a form with a leaf description which has constraints defined for length of the string (it must be between 3 to 8 characters). The leaf is a must statement (leafWithMust) that says the length of the leaf description should be exactly 5.

Figure 5: Form with Must

As seen below, the leaf description has only two characters, hence an error message is displayed for the leaf.

Figure 6: Form with Validation Error

Disabling the Validate Constraints checkbox did not remove the error message for the field as expected.

Figure 7: Form with Error Constraint Disabled

In the form below, it can be seen that validation of the description field passed since the number of characters is now three, but we can see that the field leafWithMust has failed since it requires the description field to have 5 characters.

Figure 8: Form with Must Error

However, when the Validate Constraints checkbox is not checked (disabled), validation of the must statement is disabled and now the form reports no errors.

Figure 9: Form without Errors

Mandatory vs. Required Field Constraint Validation Criteria

When building forms in Form Builder, some fields are mandatory, which means they must display a value in the field, and it cannot be overridden. Mandatory fields will always show a red asterik (*) or the text "Required" next to the field label. Constraints can also be set to restrict the values that display in the field, oftentimes based on the value of another field. This is known as field constraint validation, which helps to ensure valid form data is submitted. If the expected data is missing or incorrectly formatted, an error message is displayed with user feedback that explains what is needed.

Below are a few use case examples to show field constraint validation in forms.

Examples

As seen below, the Mandatory constraint validation is working as expected.

Figure 10: Mandatory Fields

For Required field constraint validation, there is a dependency between the key and the required field element that triggers the constraint validation. When a nested table key is not entered (set as required), the form will skip the table row.

Figure 11: Required Fields

For this use case, the table key is missing in the submitted form, and the output renders a garbage form. In this scenario, the form will submit, but the table row will be ignored, no matter if the user filled out Field A or Field B or both.

Figure 12: Missing Table Key

Below is the output data from this form. It does not contain any fields from the table row since it’s been ignored.

Output (Garbage)

{
  "name": [
    "test"
  ]
}

For this validation scenario, the table key was entered on the form, but the user cannot submit without filling out the required fields.

Figure 13: Missing Required Field

A successful scenario will show a valid table key along with the required field inputs.

Figure 14: Valid Key Required Field

Below is the expected output from a successful validation.

Output (Expected)

{
  "name": [
    "testValCrit"
  ],
  "table": [
    [
      {
        "key": "1",
        "fieldA": "A",
        "fieldB": "B"
      }
    ]
  ]
}

Resources

For more information on field constraint validation, see:

• YANG Data Modeling - Keys in Lists
• MDN Constraint Validation

Edit Form Field Properties

Once a field has been allocated to a form, you can configure some of its properties.

1. Hover your mouse over the field.
2. Click the Configure Properties icon (top-right corner). The Configure dialog box opens.

Figure 15: Configuration Button

Figure 16: Configure Propeties

Delete a Form Field

To remove a form field, click the trashcan icon.

Figure 17: Remove Form Field