Skip to main content

Manage workflows

Use Workflows to chain the API endpoints you set up in Manage APIs into steps. You can run a workflow on a schedule, or run it straight away to see what each step returns.

To open the screen, go to ManageIT → Manage Sources, then select Manage ▾ → Manage Workflows. You can also select Go to Workflows on Manage APIs. To go back, select Back to Manage Sources.

Before you start​

  • Set up at least one endpoint grouping with endpoints in Manage APIs.
  • Workflows run through your account's collector. Check that it's connected on Configure collector.

The workflows list​

The toolbar shows how many workflows you have. You can change what the list shows:

  • Search: type in the Search workflows by name or description box.
  • The status filter lets you choose All Workflows, Active Only or Inactive Only.

The table has the columns Workflow Name, Description, Steps, Schedule, Updated, Enabled and Actions. Schedule shows how often the workflow runs, for example 5 min, or Not scheduled.

When there are more workflows than fit on one page, use Previous and Next below the list.

Create a workflow​

  1. Select Create Workflow. The Create Workflow page opens.
  2. Under API Endpoints, find the endpoint you want. You can use the Search APIs... box, and sort by Default, Name (A-Z) or Name (Z-A).
  3. Select Add to workflow beside the endpoint, or drag it into Workflow Steps. The endpoint becomes the next step.
  4. Repeat for each step, in the order you want them to run. To take a step out, select Remove from workflow.
  5. Under Save details, enter a Workflow Name, for example Daily AppNeta Sync. You can also enter a Description.
  6. Set the Schedule Interval (seconds). It starts at 300, which is every 5 minutes.
  7. Leave Enabled selected to run the workflow on its schedule.
  8. Select Save Workflow.

ScoutIT AI saves the workflow and opens it for editing.

As soon as you add the first step, ScoutIT AI keeps the workflow in your list as Untitled workflow until you give it a name. To leave without saving your latest changes, select Cancel.

Configure a step​

  1. Under Workflow Steps, select the step. Its settings open on the Configuration tab. The step's method and full URL are shown at the top and can't be changed here.
  2. Fill in the fields you need:
    • Headers: one header per line, for example Content-Type: application/json.
    • Query Parameters: one parameter per line.
    • Body: the request body, for example JSON.
    • Step JSONata (optional): a JSONata expression for this step.
  3. Select Save step.

To use a value from an earlier step, refer to it as $steps. followed by that step's ID. The step that uses it then shows depends on and the step it needs.

To reshape the final output of the whole workflow, enter an expression in Final JSONata transform (optional) under Save details.

Run a workflow​

  1. Open the workflow.
  2. Select Execute. The button shows how many steps will run, for example Execute (3), and shows Executing… while it runs.

ScoutIT AI saves the workflow, runs it, and opens the Response tab:

  • A summary shows the run's status, how many steps passed and failed, and the total time in ms.
  • Each step shows its method, name, status, HTTP status code and time, with the step's output or error below.
  • Transformed result shows the final output after your Final JSONata transform (optional).

You need at least one step before you can select Execute or save.

Turn a workflow on or off​

In the workflows list, use the switch in the Enabled column. Hold the pointer over it to see Enabled — click to disable or Disabled — click to enable.

Edit a workflow​

  1. In the workflows list, select the workflow's name, or select Edit.
  2. On Edit Workflow, change the steps or Save details.
  3. Select Update Workflow.

Select Back to Workflows to return to the list.

Delete a workflow​

  1. In the workflows list, select Delete on the workflow.
  2. In the Delete Workflow dialog, select Delete.

Any scheduled runs of the workflow stop immediately. Select Cancel to keep the workflow.

Troubleshooting​

ProblemWhat to do
Workflow name is requiredEnter a Workflow Name under Save details, then save again.
No API groupings yet. Create endpoints first.Add a grouping and endpoints in Manage APIs.
No matching APIs found.Clear or change the Search APIs... box.
Workflow Execution Failed with Add at least one step before running the workflow.Add a step, then select Execute again.
Workflow Execution Failed with Execution failed:Check that your collector is connected on Configure collector, then try again.
Could not add step:Try adding the step again. If it keeps failing, check the endpoint in Manage APIs.
No workflows foundIf you searched, clear the search box or change the status filter. Otherwise, select Create Workflow.