Creating a Concert workflow

A workflow is a user-defined algorithm containing a series of automated tasks or processes that are executed in a specific order to achieve a particular goal. These tasks can include various network operations, such as configuration, provisioning, auto-remediation, or troubleshooting.

Before you begin

  • You must install Concert Workflows add-on to an OCP cluster or virtual machine. Refer to Installing Concert Workflows for instructions.
  • You must have authenticated the connection with the external tools and services referenced in the workflow. You can do this before, during, or after you create the workflow.
  • Alternatively, you can import a custom workflow (JSON) file or a template workflow downloaded from the IBM Automation Library. Refer to Importing a Concert workflow.

Instructions

Note: The following instructions apply if you are using the embedded version of Concert Workflows as opposed to a standalone instance. If you are using the standalone version, refer to Creating workflows in the IBM Rapid Infrastructure Automation documentation.

Refer to the following instructions to create a new Concert workflow.

  1. Click Workflows > Manage from the main navigation.
  2. Click Create workflow.
  3. Enter name for the workflow.
  4. Enter a workflow description for internal reference.
  5. Select the Layout type to use in the workflow editor:
    • Flow layout shows the logical representation of the workflow structure.
    • Flat layout shows blocks in sequence and allows greater control over the code.
  6. Click Select template to choose from a set of system templates for common use case. These templates provide an ideal starting point to learn about the following aspects of workflow operations:
    • Building workflows.
    • Using common workflow blocks, such as If, Else, While, Try, Catch, ForEach, Break, and Continue.
    • Creating and manipulating variables, arrays, and objects.
    • Sending HTTP requests.
    • Populating authentication credentials for SSH connections and connecting to remote hosts.
    Note: System templates do not include the workflows in the IBM Automation Library. To use a workflow from the automation library, download the JSON file and import the workflow template to Concert.
  7. Click Create.
  8. In the Start section, add user and system variables and values for the parameters required to execute the workflow.
    Note: If you are creating a workflow from a template, relevant variables will appear here, in which case, you need only provide the requested values.
  9. In the User variables section, select or deselect boxes to indicate if the variable is an input variable (In) or an output variable (Out). If an output variable, you can enable logging (Log) to store the response. If an input variable, specify whether the parameter value is required (Required).
  10. Expand the cURL section to view a sample REST API endpoint for the workflows, including any defined variables. You can use this URL to test the workflow from a remote system.
  11. Next to Group, select the relevant worker group from the list. A worker group is a logical collection of devices that can be targeted by a workflow. Refer to the IBM Rapid Network Automation documentation for details.

    The default worker group is applied if a custom one is not set.

  12. Select or deselect the checkbox next to MET to enable or disable manual execution time (MET) to simplify reports on the return on investment (ROI) calculation. This allows you to see the time in minutes that is saved by running the workflow as opposed to completing the task manually.
  13. Build the workflow sequence: To build the workflow sequence, drag and drop blocks from the integration list on the left. Each block represents an action, control, or function related to a supported integration.
    • Drag and drop blocks from the list of supported actions in the left side panel. Actions are organized into folders based on the relevant integration, common actions, or custom folders. Alternatively, you can click the add (+) icon to add blocks to your flow.
      Note: You can view Concert-specific actions in the block list in the IBM folder. Navigate to IBM > Concert to view all related sub-folders. When using a Concert action, you must provide a valid API key generated in the Concert UI.
    • Select each box to view the required parameters. Enter the parameter values required to execute each action. In some cases, this may require authentication credentials for relevant external tools and services.
  14. For each block (action), review and provide the required parameter values in the Object editor side panel or inline if using the flat layout.
  15. Click Run to execute the workflow. You can see the results under Logs to ensure it executed as expected.
  16. Click Save to save the workflow.

The new workflow appears in the list shown under Workflows > Manage. You can click the Actions menu next to each workflow in the list to perform various tasks.

Next step

Create and schedule Concert Workflows job to run automatically at specific times, dates, or intervals. You can also use automation rules trigger the Concert Workflows job automatically based on various Concert assessments and recommendations.