For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Platform On-Prem
    • Overview
    • Navigate
    • Search resources
  • Apps
      • Overview
      • Navigate
        • Overview
        • Use
        • NSO Service Model Form Fields
        • Add Form Builder tasks
        • Use JSON schemas
    • Itential Automation Gateway
  • Resources
    • Itential Academy
    • Version lifecycle
    • Itential MCP
    • Accessibility conformance
    • Get support
    • FAQs
LogoLogo
Open sourceSupportFAQsDocs Home
AppsStudioForms

Add a Form Builder task to a workflow

Was this page helpful?
Previous

Use a JSON schema to create forms

Next
Built with

This is a legacy functionality in earlier Itential Platform versions. See the Platform 6.0.0 Breaking Change notice.

This page covers how to add a Form Builder task to a workflow. It does not describe the functionality of the Workflow Builder application.

If you are not familiar with the Workflow Builder application, consult the relevant user guide before proceeding.

You can use Form Builder to add a form to a workflow, allowing users to enter information as part of the business process.

1

Open or create a workflow

Create a new workflow or open an existing one.

2

Add the ShowFormByName task

Select FormBuilder in the Source Application dropdown list. Select ShowFormByName and add it to the workflow.

ShowFormByName task added to a workflow
3

Configure the manual task

Enter an appropriate summary and description, and assign it to the relevant User Group.

4

Configure the task variables

Configure the variables for the ShowFormByName task:

  • form_name — The name of the form.
    • Set Reference task to static.
    • Enter the form name as the Reference variable.
  • instance_data — If form values are entered by the user and are not populated by a previous task or external system:
    • Set Reference task to static.
    • Enter {} as the Reference variable.
Edit Task — configuring ShowFormByName variables
5

Save the workflow

Click Update, then Save the workflow.

6

Start the workflow and work the task

Click Start workflow. Navigate to the Work queue to view the task in the Available Tasks list. Click the task to initiate the work.

Example service form rendered from the workflow

Outgoing data format example:

1{
2  "/ncs:services/itential_test_devices:cisco-ios": [
3    {
4      "device": [
5        "csr01-atl"
6      ]
7    }
8  ],
9  "/ncs:services/aspan-vrf:aspan-vrf": [
10    {
11      "vpn-id": 1,
12      "vrf-name": "vrfName",
13      "route-target": [
14        {
15          "rt-export": [
16            {
17              "asn-ip": "1.1.1.2:33"
18            }
19          ]
20        }
21      ]
22    }
23  ]
24}

The internal reference to a form field retains the original value before the field was renamed.