Subscribe

UiPath Integration Service

The UiPath Integration Service Guide

Overview

Triggers provide a uniform mechanism for subscribing to events from the Connector platforms. It gives you the flexibility to automatically start automations or processes in Orchestrator.

Prerequisites

Before you can configure Triggers, make sure the following conditions are met:

  • The Integration Service is enabled and provisioned for your tenant
  • The Triggers tab is displayed in the Integrations window
  • You have already setup an Unattended or Non-production Robot in your Orchestrator instance
  • You are using Studio & Robot version 21.10 or higher.

Using Triggers in the Integration Service

Create your process

Create your process in UiPath Studio as you would normally do. Using the Integration Service, any automation can be triggered for any process.

To receive the details of a record, you can also follow the indications below:

  • If you want to know the actual Connector, Event, Record Type or Record that triggered the process in your workflow, you can define the following input arguments of type String in your process.
    Integration Service will populate them automatically when it starts the job.
    • UiPathEventConnector
    • UiPathEvent
    • UiPathEventObjectType
    • UiPathEventObjectId

📘

Note:

Find out more about how Arguments work and how to manage them here.

  • To retrieve and work with a record that has a trigger on a job run, use the UiPathEventObjectId input argument to retrieve the record from the source system.

Here is an example of how the input argument values are passed by Integration Service.

Publish your process

Publish your process to Orchestrator to as you would normally do. You can publish it to a shared folder or a personal workspace. Make sure to create a process out of your package.

Configure your trigger

To add a Trigger, you will have to:

  1. Access the Automation Cloud.
  2. On the left-side menu, click on Integration Service. The Integration Service window includes three separate tabs: Connectors, Connections, and Triggers.
  3. Access the Triggers tab and click on the Add Trigger button.
  4. Select the desired Connector and Connection from their respective dropdown menus. If there is only one connection configured for that particular connector, it will be selected automatically.
  5. Select the desired Event and Record from their respective dropdown menus.

📘

Note:

Event types may vary with the connector.

  1. On the right, select the Process to execute.
  2. Select the Runtime license (the runtime used to execute the jobs that are launched by the trigger) from the drop-down. Available options: NonProduction, Unattended, Headless, TestAutomation, AutomationCloud, Serverless, Development.
    • The list of runtimes shown is based on the response received from Orchestrator, i.e. the “assigned” runtime licenses to that folder. For the selected runtime, a message indicates the number of runtimes assigned.
    • For more information, see Managing Triggers in Orchestrator and Runtimes documentation.
  3. Click the Add Trigger button to create your trigger and activate it.

Alternatively, you can create a new trigger from the Connections tab. To do that, you will have to:

  1. Click on a connection's More Actions button.
  2. Select the Add trigger option.
  3. Select the desired Event and Record Type from their respective dropdown menus. In this case, the Connector and Connection are already selected and cannot be changed.
  4. On the right, select the Process to execute and the respective Runtime license.
  5. Click the Add Trigger button to create your trigger and activate it.

📘

Note:

Event monitoring is currently set to poll every 5 minutes. As such, it could take up to 5 minutes before the associated process starts.

You can see a job's details under the Jobs tab in your Orchestrator Folder. A job started from Integration Service will show its source as Integration Trigger.

Adjustable Polling Interval

When you create a new connection and set up an event trigger on that connection, the polling interval is set by default to 5 minutes.

You can customize this interval using the Adjustable Polling Interval feature, which allows you to choose the interval on which event triggers check for new object events.

🚧

Important:

You can have only one polling interval per connection, even though you can have several triggers set up per connection. Changing the polling interval affects all the associated triggers on a connection.

Polling runs and checks for new events on all associated triggers immediately after the interval is changed. If a poll is running when you change the interval, the service waits for the existing poll to finish, then starts another one.

Changing your polling interval

You can change your polling interval from the Automation Cloud – Integration Service page, either from a specific connector’s page or from the Connections tab.

  1. In Automation Cloud, access Integration Service.
  2. Go to the Connectors page and select a connector.
  3. In the connector’s page, select a connection to open the Connection Details page.
  4. Click on the interval found under the connection name, as follows:

Alternatively, you can configure your polling interval from the Connections tab:

  1. In Automation Cloud, access Integration Service.
  2. Go to the Connections tab.
  3. Select a specific connection to open the Connection Details page.
  4. Click on the interval found under the connection name.
  5. The Update polling interval window is displayed.
  6. You can choose one of the available options or set up a Custom interval, in minutes or hours. The polling interval must be more than 1 minute and not longer than 24 hours or 1440 minutes.

The following error message warns you if you enter an incorrect value: The polling interval must be a natural number from 1 to 1440 minutes or 24 hrs.

  1. Click Update Interval.

Other Trigger features

Trigger Run History

You can view a trigger's run history by simply clicking on it in the Triggers tab. In the new page, the Attempts' history is displayed in the lower part of the interface.

This history shows events that were received by the Integration Service and whether the process was successfully launched, in which case it will show the word Successful in the State column.

📘

Note:

The Successful state only indicates that the job was successfully launched. It does not reflect whether the job was successfully executed to the end or not.

❗️

In case a job fails to start, its State will appear as Failed. Hover with the mouse cursor over the Failed state to view the error message.

To check if a job was successfully executed, click the View job logs button. It will redirect you to Orchestrator, where all the necessary information on job execution is displayed.

Delete trigger

Go to the Triggers tab in the Integration Service window. Click the More Actions button corresponding to your trigger and select Delete.

Trigger details view

Simply click on a trigger to view its details

Activate/Deactivate a trigger

To activate or deactivate a trigger, you will first have to click on it to view its details. Then click the switch located in the upper-left side of the window.

Automatically disabling a trigger upon failure

A trigger is disabled and set to error state if you are not able to start the job after 11 attempts (~34 hours) for a single event or if the job does not start for the last 100 events.

The 10 retries for every event are done with an exponential back-off strategy. Each subsequent retry attempt comes after a delay twice as long as the previous attempt.

Renaming a trigger

Follow the steps below to rename a trigger:

  1. Access the Triggers tab.

  2. Hover with the mouse cursor over the name of the trigger you wish to modify and you should now see the Edit button displayed.

📘

Note:

Alternatively, you can select your trigger from the list to access the detailed view. The Edit button is located on the right side of your trigger name.

  1. Click the Edit button and you can choose a new name for your trigger.

Updated a day ago

Triggers


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.