Add a Form Builder Task to a Workflow
  • Dark
    Light
  • PDF

Add a Form Builder Task to a Workflow

  • Dark
    Light
  • PDF

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

Note: If you are not familiar with the Workflow Builder application, consult the relevant user guide for clarification on any of the information discussed in this section.

You can use Form Builder to add a Form to a workflow. This allows the user to enter information as part of the business process.

To add a form to a workflow:

  1. Create a new workflow, or open an existing one.
  2. Select FormBuilder in the Source Application dropdown list.
  3. Select ShowFormByName and add it to the workflow.

Figure 1: Example Task
15-formWorkflowTask

  1. Configure the manual task.
    • Enter an appropriate summary and description
    • Assign it to the relevant User Group.
  2. Configure the variables for the ShowFormByName task.
    • form_name This variable is the name of the Form.
      • Select static as the Reference task.
      • Enter the name of the Form as the Reference variable.
    • instance_data If the form values are entered by the user and are not populated by a previous task or external system, configure the following:
      • Select static as the Reference task.
      • Enter {} as the Reference variable.

Figure 2: Edit Task
16-editTask

  1. Click Update.
  2. Save the workflow
  3. Click the Start workflow button.
  4. Navigate to the Work queue to view the task in the Available Tasks list.
  5. Click the task to initiate the work.

Figure 3: Example Service Form from Workflow

17-newServiceFormExample

Outgoing Data Format Example

{
  "/ncs:services/itential_test_devices:cisco-ios": [
    {
      "device": [
        "csr01-atl"
      ]
    }
  ],
  "/ncs:services/aspan-vrf:aspan-vrf": [
    {
      "vpn-id": 1,
      "vrf-name": "vrfName",
      "route-target": [
        {
          "rt-export": [
            {
              "asn-ip": "1.1.1.2:33"
            }
          ]
        }
      ]
    }
  ]
}

Note: The internal reference to the Form Field retains the original value before it was renamed.


What's Next