Configuring prebuilt apps

You can customize the prebuilt apps on watsonx Orchestrate by configuring their endpoints to use your custom app server. By doing so, you can customize the app's behavior by routing requests to your own app server.

Certain prebuilt apps require additional configuration to connect to your custom app endpoint. This variation in configuration requirements arises due to the diverse types of apps available on watsonx Orchestrate, each requiring distinct setups for custom endpoints.

Configuring endpoints per connection

For some apps, you can configure the endpoint and app connection simultaneously. You can input your custom endpoint in the API URL field while you configure the app connection. This ensures the app is directed to your custom endpoint.

The endpoint you set is specific to the connection it's applied to. Therefore, you can assign different endpoints to each personal or team connection, based on the need.

Example of API URL field
Figure 1. Example of API URL field.

Configuring endpoints per tenant

For certain prebuilt apps, you set the app endpoint for each watsonx Orchestrate tenant.

The apps that are not configured or those with incorrect endpoints display a red symbol on their app tile on the catalog page, indicating an issue.

Example of not configured app
Figure 2. Example of not configured app.

To configure the app endpoint:

  1. From the menu menu, select Skill studio.
  2. On the skills and apps page, select the Apps tab.
  3. Click the vertical ellipsis button of the app that you want to configure the endpoint.
    Note: The Apps tab lists only the apps that support the configuration. Included in the list are the apps that are imported by developers through OpenAPI specifications.
  4. Click Edit.

Then, follow the following procedure to configure the app endpoint:

  1. Click Configuration.

  2. Configure the app endpoint. The following table outlines the configuration for various fields related to setting up the app endpoint. Note that some fields might only apply to specific apps:

    Field Description
    Server URL The URL of your app endpoint. It is a mandatory field for all the authentication types.
    Token URL The URL used to validate the user connection. It is a mandatory field for OAuth2 password, OAuth2 client credentials and OAuth2 authorization code.
    Authentication type The method used by the users to connect to the app.
    Authorization URL The URL used to validate the user connection. It is a mandatory field for OAuth2 implicit and OAuth2 authorization Code.
    Client ID The ID you use to authenticate with the app. It is an optional field for all the OAuth2 credential types.
    Client secret The client secret you use to authenticate with the app. It is an optional field for OAuth2 password, OAuth2 client credentials and OAuth2 authorization code.

  3. Optional: Test the connection by clicking Test connection and set your connection credentials.

  4. Click Save.

After the app is updated to use the new endpoint and the status Configured is shown on the Skills and apps page.

Information:

  • When a builder incorporates the client ID and secret within the app, the connection process is simplified for the users. Instead of requiring users to manually enter the client ID and client secret, they can establish a connection by simply clicking the Connect app button.
  • When an admin configures the client ID and secret as team credentials, users can connect to the app without needing to manually enter the client ID and client secret. The values are automatically populated from the admin-configured data, simplifying the connection process for all team members.
  • When a builder includes only the client secret in the app, users only need to provide their client ID during connection, as the secret has already been set. If an admin configures the team credentials, the system prompts for the client ID alone, as the secret is pre-configured by the builder. Once the team credentials is set by the admin, users see the app as already connected.

Configuring app endpoints and skill schemas

In certain apps, modifying the endpoint can impact the skill schemas of the skills in that app. Creating a new app on the watsonx Orchestrate tenant provides a separate environment for endpoint configuration and associated schema modifications. This isolation ensures that changes made during endpoint configuration do not affect the skill schemas.

Note: A skill schema defines the structure and behavior of skills within an application. They outline how data is processed, actions are performed, and so on.

The Configure prebuilt skills window lists all apps that support this configuration. To open the Configure prebuilt skills window:

  1. From the menu menu, select Skill studio.
  2. On the skills and apps tab, select Configure prebuilt skills.

Then, to configure the endpoint by creating a new app, follow the steps of the procedure:

  1. Select the app that you want to configure.
  2. Select the skills for this new app.
  3. Click Connect app.
  4. On Custom URL (optional), set the new app endpoint.
  5. Click Connect app.
  6. Click Configure.

The customized prebuilt skills appear on the Skills and apps page with the Published status. Now, you can enhance that skill as an imported skill. For more information, see Enhancing and publishing skills.