External Web Services - Automate_Studio_Manager - Latest

Automate Studio Manager Guide
Product type
Software
Portfolio
Integrate
Product family
Automate
Product
Automate > Automate Studio Manager
Version
Latest
Language
English
Product name
Automate Studio Manager
Title
Automate Studio Manager Guide
Copyright
2024
First publish date
2018
Last updated
2024-07-22
Published on
2024-07-22T13:20:59.472887

You can do the following on the External Web Services page:

  • Add an external web service
  • Edit an external web service
  • Delete an external web service
  • View external web services
  • Import and export external web services
Note:

You cannot delete default or system external web service connections. These connections are created by default with names (CognitiveServices and Google), and they are used internally for maps and translations. For these connections to work, you must add the associated API Key.

View external web services details

You can view external web services details on the Connections menu, under the External Web Services tab. The following details are listed:

  • Connection Name
  • Scope Level
  • URL
  • API Key

You can filter on any column on the External Web Services tab.

Note:

In the Administrator App, you can view only global-level external web service connections. If you open the External Web Services page from within the User App, however, you can view external web service connections created at both the User App (local) and Administrator App (global) levels.

Add an external web service

  1. Go to Connections > External Web Services.
  2. Click Add. The Add New Service panel appears.

  3. On the Add New Service panel, complete the following information:

    • Connection Name – Enter a Connection Name
    • Service URL - Enter the Service URL.
    • API Key – Enter the API Key to authenticate a call/request to web services. The API Key is optional because web services do not require API keys to establish connection.
  4. Click Save. You will be notified that the web service has been added successfully.

Edit an external web service

  1. Go to Connections > External Web Services.
  2. Select the external web service in the tabulated list on the External Web Services page and click Edit.
  3. On the Update Service panel, make your changes.
  4. After all your changes have been made, click Save. You will be notified that the external web service details updated successfully.
Note:

The Connection Name field cannot be edited.

Delete an external web service

  1. Go to Connections > External Web Services.
  2. Select external web service in the list on the External Web Services page and click Delete.
  3. When prompted to confirm the deletion, click Yes. You will be notified that the external web service were successfully deleted.

Further info: You cannot delete default or system external web service connections. These connections are created by default with names (CognitiveServices, Google), and they are used internally for maps and translations. For these connections to work, you must add the associated API Key.

If a deleted external web service is added again using the same configuration and connection name, the solutions will work as they did before. There is no need to redeploy the solution.

Import or Export an external web service

  1. Go to Connections > External Web Services.
  2. Select the external web service in the tabulated list on the External Web Services page and click Import or Export.
  3. When prompted to confirm, click Yes. You will be notified that the external web service has been imported or exported successfully.