Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel1
maxLevel7

Creating New Workflow

To create a new Workflow, follow the below steps:

  1. Navigate to the Workflow Builder screen and click on Create Workflow.

    Image Added
  2. On Create Workflow screen, add the new workflow details. Following are the details available on the screen:

    1. Add ‘Name’ represents the name of the Automation Workflow.

    2. ‘Identifier’ represents the unique identifier of the workflow.

    3. Add 'Description' for the workflow.

    4. Add ‘Retry Configuration’. The configuration enables the system to retry executing the operation in case of an error.

      1. Add the number of ‘Total Attempts’ for retries in case the operation fails.

      2. Configure the ‘Retry Interval’ to define the time interval between each Attempt.

      3. Backoff Factor

      4. Maximum Retry Interval

        Image Added
      5. Click on Create to create the Workflow.

The Workflow Designer is now open. You can now drag and drop the controls to design the workflow.

Configure Workflow Parameters

...

  1. Navigate to the Operations tab on Properties Panel.

  2. Enter the URI (Uniform Resource Identifier). It refers to the operation in the target system to be executed.

  3. Select the operation Method. It uses an API request chaining framework for bots to push or request data from your websites, systems, and web applications using Webservices.
    The following operation methods are available:

    • Get: To retrieve data

    • Post: To create data

    • Put: To edit the data

    • Delete: To delete the data

    • Patch:  To make partial updates to the resource 

  4. The system automatically displays the Supported Operation as invoke REST API.

  5. Specify the operation Timeout (in milliseconds), the amount of time to wait for a web service response when invoking an outbound request.

  6. Next, add the Path Parameter. This is part of a path segment that occurs after its name. Path parameters offer a unique opportunity to dynamically replace the values and pass them in the URL. Path parameters are used to identify a specific resource. Example, http://myserver.com/some-path/{parameter1}/path-continued/{parameter2}. 
    You may overwrite the configuration defined at the instance level or continue using the same. To ignore instance-level configuration, select Ignore Global Path Parameters.
    Click on + to add the operation-specific variable and values. 

  7. Query Parameters: The query parameters are sometimes referred to as optional parameters. The query parameters are separated from the hierarchical parameters by the question mark. Query parameters appear in the URL after the question mark (?) after the resource name. For example, https://myserver.com/resource-name?param1=value1&param2=value2.
    You may overwrite the configuration defined at the instance level with an operation-specific Query Parameter or continue using the same. To ignore instance-level configuration, select Ignore Global Query Parameters.
    Click on + to add the operation-specific field and value.

  8. Headers: Headers are mostly classified as request headers. You will have to set the request headers when you are sending the request. You may overwrite the configuration defined at the instance level with operation-specific Headers or continue using the same. To ignore instance-level configuration, select Ignore Headers.
    Click on + to add the operation-specific variable and values. 
    The following sample headers are encountered the most.

    1. Authorization: Includes credentials containing the authentication information of the client for the resource being requested. 

    2. Accept-Charset: This is a header that is set with the request and tells the server which character sets are acceptable by the client. 

    3. Content-Type: Indicates the media type (text/HTML, text/JSON, XML/custom, or multipart/form-data) of the response sent to the client by the server, this will help the client in processing the response body correctly.
      Note: Use multipart/form-data as Content-Type to send an attachment file to the client-server.

      Image RemovedImage Added

You Operation is configured.

...

  1. On the Workflow Designer screen, drag and drop the Create ScriptTask control. Here we can the script to be executed as part of the workflow.

    Image RemovedImage Added
  2. Select the Script Task and open the Properties Panel. On the Properties panel, configure the script details to be executed. Add the following details:

    1. On the Properties panel → General tab, add the general Service Task information:

      1. Add the Script Task Name.

      2. The script task accepts groovy script. Add the script to be executed.

        Image RemovedImage Added
    2. The variables used in the script are automatically identified as Input and Output parameters. On the Input/Output tab, the ‘getvariables’ are identified as ‘Input Parameters’ and ‘setvariables’ are identified as ‘Output Parameters’.

...

  1. Select XOR gateway and use the Sequence Message Flow or Association tool to create a link with the next element.

  2. Now select the link to add the associated rule.

  3. On the SequenceFlow properties panel, add the rule to be evaluated.

    1. Add rule Name and Documentation details

    2. In the Details section, add the rule to be evaluated. In the Condition Type, You can either add an expression or a script to evaluate the rule.

      1. For Expression:

        1. Select Expression as Condition Type.

        2. Add the rule in the Condition Expression field. Here you can refer to a parameter from the previous step and create the rule.

        3. To refer a parameter from a previous step, use $.out_<Activityname>_<paramtername>. For example, ${out_Activity_17mx2d1_default_status == 'SUCCESS'}.

          Image RemovedImage Added

          Note: Select the element and copy the element ID from the properties panel.

      2. For Script:

        1. Select Expression as Script.

        2. Add the script.

          Image RemovedImage Added
  4. Follow the above steps to create as many rules as required.

...