Add-ins
latest
false
Banner background image
Add-ins User Guide
Last updated Jan 15, 2024

Quickstart

Introduction

The purpose of this guide is to show you how to use the UiPath Add-in for Mulesoft by performing a Start Job operation.

Start Job

To start a job, you must provide at least the following request body input parameters:

ParameterDescription
ReleaseKeyThe ID you get by performing Get Releases. The Orchestrator needs this key to run a specific version of a process.
StrategyFor modern folders we recommend making use of ModernJobsCount.
JobsCountHow often the job is executed.

InputArguments

If your job has input parameters, they can be sent as a JSON string in the InputArguments field. If it does not have input parameters, this field is ignored.
Note: You need the Folder ID to perform the Get Releases operation. This ID is also required in the Start Job operation. To get Folder Id you need to perform the Get Folders operation.


Follow these steps to perform the operation:
  1. In Anypoint Studio, click File, go to New and select Mule Project. Name the project and click Finish.
  2. In the Search field, type HTTP and drag the HTTP Listener to the canvas.
  3. Click the HTTP Listener, then click the green plus sign to the right of Connector Configuration. On the next screen, add the Host and Port, then click OK.
  4. Provide the Path to HTTP Listener with the URI parameter. Example: /job/start}.
  5. In the Responses tab, set the variable http.status with the default 200, as indicated in the image below:


Steps

  1. Provide Connection Configuration Details.
    • On the Mule Palette, search for the Get Folders operation and drag it onto the canvas. Click on the new configuration and provide configuration details as below:


  2. Provide the operation parameters.
    • Enter the $filter parameter value as: DisplayName eq 'UnattendedProcesses'.


    • This operation returns the Folder ID. You will use Set Variable to hold the value of Folder ID.
  3. Set Variable.
    • Search Set Variable in the Mule Palette, drag and drop it besides Get Folder.
    • Enter the variable name and value as seen below:


  4. Get Releases.
    • Search Get Releases in the Mule Palette, then drag and drop it besides Set Variable.
    • Enter the folderId, which you set as a variable in the previous step, as UIPATH Organization Unit Id.
    • This operation returnd the Release key, which is required in the Start Job operation.
  5. Start Job.
    • Search Get Releases in the Mule Palette, then drag and drop it besides Set Variable.
    • Enter the folderId, already set as variable, as UIPATH Organization Unit Id.
    • In the Body parameter, enter a JSON as seen below:
      %dw 2.0
      output application/json
      ---
      {
       "startInfo": {
        "ReleaseKey": payload.value.Key[0],
        "Strategy": "ModernJobsCount",
        "JobsCount": 1,
        "InputArguments": "{}"
       }
      }%dw 2.0
      output application/json
      ---
      {
       "startInfo": {
        "ReleaseKey": payload.value.Key[0],
        "Strategy": "ModernJobsCount",
        "JobsCount": 1,
        "InputArguments": "{}"
       }
      }
    • For a Successful response, set success payload as indicated below:
      output
      application/json
      ---
      {
      "message":"Operation has been executed successfully",
      "payload": payload
      }output
      application/json
      ---
      {
      "message":"Operation has been executed successfully",
      "payload": payload
      }


    • For a Failure response, set http.status as 500, and the error payload as:


      output
      application/json
      ---
      {
      "message":"There is an error while performing this operation.",
      "error":error
      }output
      application/json
      ---
      {
      "message":"There is an error while performing this operation.",
      "error":error
      }


  • Introduction
  • Start Job
  • Steps

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.