integration-service
latest
false
UiPath logo, featuring letters U and I in white

Integration Service User Guide

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

Publishing

There are two steps to publishing a custom connector:
  1. Publish it to your tenant, to make it available in the Integration Service connector catalog to anyone in your organization.
  2. Publish it to the UiPath Marketplace, to make it available to everyone in the UiPath Community.

Publish the connector to your tenant

  1. Navigate to Connector Builder, open your custom connector, and select the Publish button at the top of the screen.
  2. The custom connector is now visible in the catalog and ready for use within Studio. You can establish connections and use your connector across the UiPath® product suite.
  3. Select the More options docs image menu icon next to each connector to Edit, Download, Unpublish, or Delete the connector.

Publish to Marketplace

Follow the steps below to start the Marketplace publishing process.

  1. Navigate to Integration Service.

  2. In the Connectors catalog, search for the custom connector you want to publish to the Marketplace.

  3. Select the connector and navigate to the Admin panel.

  4. Select the Publish to Marketplace button.


docs image

The publishing process is broken down into four steps:
  1. Details.
  2. Description.
  3. Files & Terms.
  4. Support.
Note: These steps are similar to creating a listing directly through the Marketplace, described in the Marketplace User Guide in Submit a listing. There are slight differences to make the publishing process more streamlined.

Description

The Description step provides Marketplace customers with more in-depth information on the connector, including:

  • Overview (supports a maximum of 5000 characters): Describe your listing and let people know what it contains and how they can use it. See the Marketplace guidelines for the Overview.

  • Features (supports a maximum of 500 characters): Let Marketplace customers know what value they can get from using your connector. See the Marketplace guidelines for Features.

  • Upload Images: Attach relevant screenshots to be displayed on your listing. This helps your audience navigate and understand what you are offering. See the Marketplace guidelines for images.

  • Video URLs: Add relevant presentations or demo videos to your listing. Make sure they are in YouTube or Vimeo format. See the Marketplace guidelines for videos.


docs image

Files & Terms

The Files & Terms step allows you to set the specifications of the files, as well as the legal details of the connector release.

  • Version: The version of the connector being published. We recommend matching the version being published to the version of the connector in your Integration Service tenant.

  • Release Notes: Add details about this release and for each new version you add afterward.

  • License: As a content creator, choose the type of license used for your content. For free listings, you can select and apply for an open-source software license or a Commercial License. We recommend using permissive licenses to increase usability for other Marketplace users. Make sure there is a clear and agreeable legal relationship between the content creator and the user. Refer to the UiPath Terms of Use for details about content licensing and the Marketplace guidelines for licences.

  • License URL: Add your license link. See the General FAQ - Listings section in the Marketplace User Guide for more details on licensing types.
  • Privacy Terms: Describe how (and if) the listing you are submitting is processing the user's personal data. You can share the Privacy Terms or link to applicable policies. By selecting No, you are confirming this listing does not process any personal information. See the Marketplace guidelines for privacy terms.
  • Documentation: Upload the user guide and other documentation necessary or helpful for the content implementation/usage. You can use a template (see User guide template for listings) or add the link to the website hosting your documentation. See the Marketplace guidelines for documentation.
  • Documentation URLs: Provide any links to documentation that could be helpful to Marketplace customers using your connector.


docs image

Support

Define the support type that the connector falls under. This can be defined as either Community Support or Supported by Publisher.

Note: Supported by Publisher is used for paid listings and is not currently supported through this publishing flow.

Review the terms and conditions, then select Submit.

Review process

Once you submit a connector to the Marketplace, it receives a status. This status is then displayed in the Admin tab of the connector.

The status changes based on user actions (like withdraw or archive) or actions taken by the Marketplace team.

Submitted

The connector has been submitted, but the Marketplace team has not yet started on reviewing the connector. The connector can still be withdrawn from the Marketplace.

docs image

In review

Once the Marketplace team begins the review of the connector, the status is set to In review. The review process includes an evaluation of:

  1. Listing details: We verify that all information has been filled out properly.

  2. Security: All components of the connector are scanned to check for malware or viruses.

  3. Functionality: The connector is tested to make sure the intended usage matches the connector and its activities as specified in the overview section.

Once a submission is In review, you can no longer take any actions on the connector until it moves into a new status.

Needs update

If the Marketplace team finds an area of the submission that needs to be updated, the status is moved to Needs update. In this case, you, as the submitter, receive an email with feedback from the Marketplace team.

Use the Withdraw submission button to withdraw the submission. Make the necessary changes to the connector using Connector Builder, and resubmit the connector. Your previous form details are pulled into the submission form.

docs image

Published

Once the Marketplace team approves the submission, it is published as a Marketplace listing.

The Published status is displayed in the Integration Service Connectors catalog.

docs image

Published (archive requested)

If Marketplace receives a request to archive a listing, the status is displayed as Published (archive requested) until the listing is archived and removed from Marketplace.

docs image

Archived

An archived listing is displayed as Archived. You can resubmit an archived connector at anytime.

docs image

  • Publish the connector to your tenant
  • Publish to Marketplace
  • Description
  • Files & Terms
  • Support
  • Review process

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.