integration-service
2024.10
true
UiPath logo, featuring letters U and I in white

Integration Service for Automation Suite User Guide

Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated Dec 18, 2024

Connectors

Integration Service enables integrations/connections across all products in the UiPath® platform. It standardizes authorization and authentication for the systems you want to integrate with.

About connectors

Connectors help create a secure connection in association to applications external to UiPath. A connector is a powerful pre-built API integration that provides a consistent developer experience while simplifying the integration process.

Publishing connectors

Overview

To get started, access the Automation Suite platform. On the left-side menu, select Integration Service.

The Connectors catalog is empty by default. You can choose which connectors to install and publish to your workspace. This means you don’t have to deploy all available connectors for every release or update. You can easily publish, manage, and maintain connectors without unnecessary installations or testing.

The connector publishing user interface empowers admin users to manage the available connectors for installation or upgrade within their Automation Suite environment. This interface allows you, as an admin, to:

  • Publish connectors: Choose which connectors to install in your Automation Suite instance.
  • Bypass versions: Skip connector versions that may not be relevant or could affect existing workflows and select connector versions you need.

Managing the catalog

The Manage catalog option is accessible to users with administrator permissions. Users without admin permissions can only view the published connectors, and not the Manage catalog option.


docs image

To publish connectors to your workspace, take the following steps:

  1. Make sure Integration Service is correctly installed in your Automation Suite instance.
  2. Select Integration Service from the left navigation tab. This brings you to the Connectors page, which is empty by default.
  3. Select Manage catalog.
  4. The full list of connectors available in Integration Service is displayed. As an admin, you can select and install all available connectors, or select and install only the connectors you choose. Enable the checkbox for all the connectors you want to install, then select the Install button.

    You can use the global Install button or the Install option available on each connector.

    The installation process takes a few minutes, depending on the number of selected connectors.

docs image

Release status

The Release columns allows you to see which connectors are in preview. If no tag is present for a specific connector, it means the connector is in general availability.

docs image

Versions

As an admin, you can see the connector versions in the Manage catalog dashboard, together with one of the following tags:

  • Active: The connector is installed and active with the displayed version.
  • Latest (not installed): This connector is not installed, and this is the latest version.
  • Previously installed: The displayed version is the last version installed.
Tip: Select the More options menu on each connector to install it or access its documentation.

Once you complete the installation, you can return to the Connectors home page and see the list of published connectors.

Note: Activities are not immediately available in Studio Web. Please allow approximately 20 to 30 minutes for all activities to load.

Governance for connectors

For published connectors, you can setup a governance policy to:

  • Enable connectors per tenant: Select which connectors should be enabled for each tenant.
  • Manage authentication: Choose the authentication type for each connector.
  • Predefine credentials: Setup the credentials for private applications (Bring your own app).

For details, see the Settings for Integration Service policies in the Automation Ops User Guide.

Unpublishing

You cannot unpublish connectors. This prevents any impact on connections, triggers, or processes that might be using published connectors.

If you want to hide a connector after publishing, you can set up a governance policy in Automation Ops.

Working with connectors

A connector's page includes four tabs: Build, Connections, Triggers, and Activities.

Build

From the Build tab, you can start building a workflow with a connector by selecting one of the following options:

  • Build an automation in Studio from scratch – to start a Studio Web project using that connector.
  • Build an automation in Studio Desktop – to open the Studio Desktop application and create a new project.
Connections

In the Connections tab, you can view, edit, and manage your connections for that connector.

Triggers

In the Triggers tab, you can view, edit, and manage your triggers for that connector.

Activities

In the Activities tab, you can see a list of the activities and triggers available for that connector.

Governance policies for connectors

You can manage the connector catalog and connector authentication options through policies in UiPath® Automation Ops.

Policies allow you to overwrite or pre-define authentication settings (such as Bring your own app), or specify particular authentication details for your tenant or organization.

For more information, see Settings for Integration Service policies in the Automation Ops user guide.

Note: Policy deployments do not impact existing connections and workflows. A new policy affects only newly created connections.

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.