Uploading RPA Add-Ons
Uniphore RPA works with pre-defined coverage handlers, called Add-Ons, to enable powerful, customized automation capabilities for any application. You select and upload an RPA Add-On using the X-Console.
An Add-On package can be built according to your specific application requirements, or obtained from a library of available RPA coverage handlers.
Each Add-On contains all the coded functions and metadata required to perform the automation for its covered application. Each Add-On is associated with a single covered application.
Uniphore RPA is supplied with several pre-defined Add-Ons that provide coverage knowledge for the following platforms:
Microsoft Windows
Chrome Browser
A coverage writer can use these 'out-of-the-box' Add-Ons as the basis for creating Add-Ons that extend automation coverage for a specific covered application.
Important
Before you can begin using Uniphore's RPA capabilities, enable RPA here for your account.
About the Add-Ons Page
You access the Add-Ons page from the RPA menu section of the X-Console.
 |
The Add-Ons page lists all coverage Add-Ons which are currently available for this account, and provides access to key details for each:
Item | Description |
|---|---|
Name | The name of the Add-On, defined in its upload package. |
Type | The Add-On type, either Coverage or Utilities, defined in its upload package. |
Selected Version | The version of the Add-On currently selected for execution on the Details page for that Add-On. When a newer version of the Add-On is available, the Update Available icon will appear alongside the version number. |
Upload | The source of the Add-On, either Local or Marketplace. |
Description | A description of the Add-On, defined in its upload package. |
When the list is long, you can locate a specific Add-On by entering a few letters from its name in the Search for Add-Ons field at the upper right of the current panel.
Note
Add-On Marketplace capabilities are disabled in the current X‑Platform version.
Uploading an Add-On
When you need to add new application coverage to Uniphore RPA, you upload a pre-defined Add-On that contains all of the automation know-how that will be required for RPA operations:
From the RPA menu section of the X-Console, click Add-On. The Add-Ons page will be displayed, as shown above.
At the top of the page, click the Add New Add-On button. The file browser appears.
Browse to the desired Add-On .zip package, select it, and then click Open. X-Console will upload the selected Add-On package.
When uploading is finished, a completion popup message will be displayed.
If the upload was not successful, a popup message will be displayed indicating why the selected Add-On could not be uploaded.
After you have successfully uploaded the new Add-On, you will need to assign it to a Covered Application in order for Uniphore RPA to use it.
Note
An RPA Add-On can be added or updated only in DEV or TEST environments.
Viewing Add-On Details
To view details for an Add-On, click its name on the Add-Ons page. The details page for the selected Add-On will be displayed:
 |
Item | Description | ||
|---|---|---|---|
Add-On Name | The name of the Add-On, defined in its upload package. | ||
Type | The Add-On type, either Coverage or Utilities, defined in its upload package. | ||
Platforms | The application platform(s) that are covered by the Add-On (e.g., Windows, Java, Web). This value is defined in the upload package. | ||
Versions | Displays a list of all uploaded Add-On versions which are available for execution by Uniphore RPA.
Basic details for each Add-On version are provided in the list. To open more details about a specific Add-On version, click the small arrow to the left of its version number, as shown above. Activating an Add-On Version The currently active version is indicated with a green checkmark. To change the active version, click the radio button next to the version you want to activate, as shown above. A warning dialog will be displayed:
Click Yes to confirm the version change. |
Updating an Add-On
You may occasionally need to update your coverage for an application, for example, in order to add new features or capabilities for automation.
Uniphore RPA enables you to upload new versions of an Add-On whenever required:
At the top right of the details page for the selected Add-On, click Upload New Version. The file browser appears.
Browse to the desired Add-On
.zippackage, select it, and then click Open. X-Console will upload the selected Add-On package.When uploading is finished, a completion popup message will be displayed.
If the upload was not successful, a popup message will be displayed indicating why the selected Add-On could not be uploaded.
Important
When you upload a new Add-On version, it does not automatically become the active Add-On version. You must activate and assign the new version in order for it to become the version that Uniphore RPA executes, as detailed above.
Handling Upload Failures
An Add-On upload can fail due to one of the following reasons:
the Add-On package does not contain a valid
manifest.jsonfilethe Add-On package does not contain a valid
coverage.jsfilethe Add-On package includes one or more unrecognized or unrequired files
the Add-On package size exceeds 200 MB
You will need to determine the precise reason for the failure and correct it before the Add-On can be uploaded to X-Console.