Using Form Builder
  • 03 Feb 2025
  • Dark
    Light
  • PDF

Using Form Builder

  • Dark
    Light
  • PDF

Article summary

Form Builder allows developers to construct user entry forms which integrate with Itential Platform workflows. In addition to constructing forms with standard inputs, developers can create forms from imported NSO YANG Service Models using the NSO NETCONF API. This native integration with NSO Services reduces the effort of having to duplicate the development of modeling services in both Itential Platform and NSO. With Form Builder, service models requiring changes are modified just once; changes made in NSO are automatically available for IP to consume.

The following figures show the user interface in Form Builder for the List View and Edit View. A description of each numbered element is provided in the reference table below each image.

List View

Figure 1: Form Builder View
01-formBuilderView

Label UI Element List View Function
1 New Form Creates a new form.
2 Delete Deletes form when check-box has been selected.
3 Form List List of forms; includes the form name, who created it, when it was created, who last updated it, and when it was last updated.
4 Edit Opens form for editing.
5 Import Form Imports a form.
6 Export Forms Exports each form that is checked in the form list.
7 Edit Forms Edit, delete and export form.

Edit View

Figure 2: Edit View
02-editView

Label UI Element Edit View Function
1 Form Name User must provide unique form name.
2 Data Elements Displays list of registered NSO services.
3 Meta Data Fields Allows user to define custom fields in the form.
4 Update Updates form and leaves Form Editor open.
5 Settings Opens a modal to change the settings of the form.
6 Preview Opens a modal to preview the form.
7 Clone Makes a copy of the current form.
8 Delete Form Deletes the current form.
9 Add Container/Table Adds a field container or table to the form.
10 Delete Deletes the form element.

 

Form Builder provides a simplified interface for constructing forms. Information on creating, exporting, and importing forms is outlined below.

How to Create a New Form

To create a new form:

  1. Open Form Builder from the Home page or the Applications menu.
  2. Click New Form (top-right corner of title bar).
  3. Give the form a unique name.
  4. Click Save.

How to Export a Form

To export a single form:

  1. Open Form Builder from the Home page or the Applications menu.
  2. Locate the form that you wish to export in the forms list.
  3. Click the export icon at the far right of a form in the list.

To export multiple forms:

  1. Open Form Builder from the Home page or the Applications menu.
  2. Click the check box for each form you wish to export.
  3. Click Export Forms (top-right corner of title bar).

How to Import a Form

To import a form:

  1. Open Form Builder from the Home page or the Applications menu.
  2. Click Import Form (top-right corner of title bar).
  3. Select the form data file you wish to import.
  4. Click Open on the file dialog.

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.