Transaction-based ROI for API automation

In this example, you will build an API automation for an opportunity and use the Pipeline Accelerator package and actions to measure the realized automation value by calculating the number of business records or transactions that have been completed.

Procédure

  • Create and configure the opportunity in CoE Manager.
    1. Create an opportunity, see Créer et gérer des opportunités.
    2. Follow one of the below options to configure the opportunity to measure the number of times the automation has run.
      • In the opportunity intake form, select # of records processed for How is the process measured question.
      • In the Opportunity > Details > Forecasted Savings tab, select # of records processed in How is Process Measured option.
    3. Specify the time (in minutes) required to process a single record and the number of records processed per month.
  • Create an API automation in the Control Room to open a web page.
    1. On the left panel, click Automation.
      A list of available bots and forms are displayed.
    2. Click Create > Tâche API.
    3. In Name field, enter Calculate transaction ROI.
    4. Click Create & edit.
      The API automation is now created. Note down the unique automation ID of the automation. In this example, it is 5678.
  • Create the following user-defined variables using the Create variable (+) icon at the top of the Variables menu.
    Variable name Variable type
    ResponseDictionary Dictionary
    SampleString Text
  • Create a session to enable connection and interaction with Shibumi.
    1. From the Actions panel, double-click or drag the Pipeline Accelerator > Start Pipeline Accelerator Session action.
    2. In the Session name field, provide a name, enter transactionROI.
    3. In the Shibumi base URL field, enter the base URL as per your region.
      In this example, base URL used is https://app.shibumi.com.
    4. In the Shibumi enterprise ID field, enter the enterprise ID.
      In CoE Manager, navigate to Admin Advanced > Additional Settings.
    5. In the Shibumi program id field, enter the program ID.
      Click the menu (three vertical dots) on the right and select Info > ID. Example, 1.
    6. Enter the Client ID and Client secret.
      Raise a service request to receive the client ID and secret through email.
    7. Enter the API username and password.
      The username and password of your CoE Manager instance tied to the client ID and client secret.
  • Send transaction ROI details.
    1. From the Actions panel, double-click or drag the REST Web Services > Get method action.
      1. In the URI field, enter the URI of the web page you want to open.

        Example, https://www.salesforce.com/in/.

      2. In the Proxy configuration field, select System.
      3. In the Authentication Mode dropdown, select No Authentication.
      4. In the Wait for action to complete (in milliseconds) field, enter 60000.
      5. Assign the output to a variable field, choose the Dictionary option and select ResponseDictionary variable from the dropdown.
    2. From the Actions panel, double-click or drag the If > If action to configure the conditional statement.
      1. In the Condition drop-down list, select Dictionary.
      2. From the Dictionary variable drop-down list, select the variable ResponseDictionary.

        The Key field is automatically updated to the value Response.

      3. From the Dictionary type drop-down list, select String.
      4. In the Operator drop-down list, select Equals to(=).
      5. In the Target Value field, type HTTP/200 OK.
    3. From the Actions panel, double-click or drag the Pipeline Accelerator > Update process metrics action into the If container.
      1. In the Session name field, enter transactionROI.
      2. In the Automation ID field, enter 5678.
      3. In the Process name field, enter Calculate transaction ROI.
      4. In the Date field, choose Variable option and enter the $System:Date$.
      5. In the Mode field drop-down, select Add.
      6. In the Process metrics field, select Dictionary option.
      7. Click Add to update the successful automation execution count in CoE Manager.
        Field Value
        Type Number
        Key Actual_Successful_Executions_per_Day__m
        Value 1
      8. Click Add to update the failed automation execution count in CoE Manager.
        Field Value
        Type Number
        Key Actual_Failed_Executions_per_Day__m
        Value 0
      9. In the Status field drop-down, select the variable SampleString.
    4. From the Actions panel, double-click or drag the If > Else action to configure the alternative sequence of action.
    5. From the Actions panel, double-click or drag the Pipeline Accelerator > Update process metrics action into the Else container.
      1. Perform steps Transaction-based ROI for API automation to Transaction-based ROI for API automation.
      2. Click Add to update the successful automation execution count in CoE Manager.
        Field Value
        Type Number
        Key Actual_Successful_Executions_per_Day__m
        Value 0
      3. Click Add to update the failed automation execution count in CoE Manager.
        Field Value
        Type Number
        Key Actual_Failed_Executions_per_Day__m
        Value 1
      4. In the Status field drop-down, select the variable SampleString.
    You can see the updated metrics in CoE Manager (Opportunity > Transaction Tracking > Transaction Metrics)
    transaction roi transaction metrics
    You can see the ROI information in the CoE Manager opportunity dashboard.
    transaction roi dashboard