UiPath Documentation
automation-ops
latest
false
Automation Ops user guide
  • Getting Started
    • Introduction
      • Governance
      • Feeds Management
      • Automation Ops™ User Roles
      • Licensing
    • Solutions Management
    • Automation Ops feature availability
  • Governance
  • Source Control
  • CI/CD Pipelines
  • Feed Management
  • Logging

Settings for Integration Service policies

Settings for Integration Service governance policies in Automation Ops, covering catalog and custom connectors, authentication types, Connector Builder access, connection types, and deployment.

This page describes how to manage connectors, authentication options, and Integration Service features using Integration Service policies.

Manage the connector catalog​

The Catalog connectors tab lists all the connectors available in the Integration Service catalog. Use the checkboxes to enable or disable any connector.

By default, all the connectors are enabled, and all official settings and authentication options are enabled for each connector. Connectors added to the catalog after you save the policy start disabled until you enable them on this tab.

Tip:

Use Search and the Status, Categories, and Enabled filters to navigate through the list. You can also define what Columns you want to display. To change every connector in the list at once, select Enable all or Disable all.

Manage custom connectors​

The Custom connectors tab lists the custom connectors published in the tenants of your organization. Custom connectors belong to a single tenant, so you configure them one tenant at a time.

  1. Select the Custom connectors tab.
  2. Select Select tenants, then choose the tenants you want to configure.
  3. Use the checkboxes to enable or disable each tenant's custom connectors. To change every connector in the list at once, select Enable all or Disable all.
  4. Select Save.
Tip:

You can also choose tenants from the Tenant list.

The Search, Columns, Status, Categories, and Enabled filters work the same way as on the Catalog connectors tab. To configure authentication types and pre-define authentication parameters for a custom connector, select More options and then Configure connector, as described in the following sections. These settings apply only to users governed by this policy in the connector's tenant.

The settings for a tenant take effect only when the policy is deployed to that tenant.

Important:

In a tenant where the policy is deployed, custom connectors that are not enabled on this tab are disabled. Custom connectors published to a tenant after you save the policy start disabled until you enable them here.

Policies saved before the Custom connectors tab was available have no custom connector settings. In tenants where such a policy is deployed, all custom connectors are disabled until you enable them on this tab and save the policy.

Disable authentication types​

Select the More options icon and then select Configure connector to view a connector's supported authentication types.

You can enable or disable authentication types for users inside your organization. Once you deploy the policy, the connector's connection creation screen will only include the authentication types you enabled.

For example, you can restrict all users within your organization to use OAuth 2.0 authentication for a given connector, or allow them to bring their own OAuth 2.0 app.

Pre-define authentication parameters​

For each authentication type, select the More icon to configure authentication parameters.

You can pre-define values for any of the authentication parameters available for a given connector. For example, you can:

  • Hardcode the OpenAI API Key for anyone building workflows on a given tenant.
  • Enable Bring your own OAuth 2.0 app for Microsoft Outlook 365 and configure the application's Client ID and Client Secret.
  • Configure a custom Site URL for Jira.

Users don't see the parameters you pre-define when they create a connection. The connection uses the values from the policy.

Set the connection type for an authentication type​

For connectors from the catalog, you can also set the connection type that each authentication type uses. On the authentication type's configuration page, select an option from the Connection type dropdown:

OptionDescription
Users chooseDefault. Users select the connection type when they create a connection.
StandardConnections with this authentication type use the UiPath-hosted connector APIs.
Private (Relay)Connections with this authentication type go through Relay, using the Base URL set in the Private connection URLs section.

When you select Standard or Private (Relay), users who create a connection with that authentication type can't change the connection type, and don't need to enter the Base URL you configured.

  • Custom connectors don't offer this setting.
  • For Private (Relay), enter the Base URL that connections must use in the Private connection URLs section.
  • For Database Hub and SAP BAPI, the Base URL field isn't shown, because Relay doesn't use one for these connectors.
  • To restrict connection types for every connector in the tenant instead, use the Connectivity setting. For details, see Restrict connection types.

You can pin only the connection types that the Connectivity setting allows for the tenant. Types it doesn't allow are unavailable in the list. If you later turn off a type in Connectivity that a connector already pins, the policy can't be saved until you turn the type back on or change the pin to Users choose or to an allowed type.

Restrict access to Connector Builder​

On the Feature toggles tab, use the Enable Connector Builder? setting to control whether users in the tenant can build custom connectors. The setting is Yes by default.

When you select No, users governed by the policy cannot open Connector Builder. In Integration Service, the following options are unavailable and show a message that Connector Builder has been blocked by the administrator:

  • The Connector Builder button.
  • The Build your connector card in the Connectors catalog.
  • Edit in Connector Builder on the page of a custom connector that the user owns.

Restrict connection types​

On the Feature toggles tab, use the Connectivity setting to control which connection types users in the tenant can create. Both types are allowed by default.

OptionDescription
StandardUiPath-hosted connector APIs. No additional setup required.
RelayRoutes traffic through your organization’s Relay private network.

Clear Standard to require that every new connection in the tenant is created through Relay. You must keep at least one option selected; the policy cannot be saved with both cleared.

Users select the connection type under Advanced settings when they create a connection. When an option is not allowed by the policy, it is unavailable in that list. For details on the connection types, refer to Connecting to on-premises systems in the Integration Service user guide.

Note:

Relay must be configured before users can create Relay connections; for setup instructions, refer to Relay in the Automation Cloud admin guide.

Not all connectors support Relay connections: restricting a tenant to Relay only prevents new connections for connectors that don't, such as Oracle NetSuite. For connectors that don't use HTTP, such as SAP BAPI, Snowflake, and Database Hub, only the connections listed in Supported TCP-based connections in the Automation Cloud admin guide work with Relay.

Deployment​

Follow the steps described in Deploy Governance Policies to deploy the policy.

Note:

Integration Service policies are cached. It can take up to five minutes for changes to existing policies to be reflected in the connector catalog.

Policy impact​

When a catalog or custom connector is disabled through Automation Ops, you can check the policy's effects throughout the rest of the UiPath Platform, as follows:

  • In the Integration Service Connectors catalog, disabled connectors are listed separately. You cannot access the connector page or create a connection.
  • In Studio, at design time, when you add an activity for a disabled connector, you receive the following error message: "The connector was disabled by an Automation Ops policy. Check with your administrator or review the policy."
  • In Orchestrator, Apps, or other UiPath products that use Integration Service connections, you receive the same error message when trying to create a connection for a disabled connector.

Important things to consider​

When setting up a governance policy for Integration Service, take into consideration that:

  • Policies can overwrite the Integration Service official catalog configuration.
  • New policies do not affect existing connections and running workflows. Policy restrictions impact only new connections.
  • Connection management (like updating a connection) is no longer possible for a connector governed through an Automation Ops policy. An attempt to do so prompts a notification to contact your administrator.
  • Administrators can always overwrite policies using UiPath Automation Ops.

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated