17.4.5 Managing REST Source Catalogs

Create a catalog of REST Data Source metadata that can be used by all applications in a workspace to create REST Data Sources.

REST Source Catalogs contain metadata about REST Data Sources. Developers can search and browse a catalog and then create REST Data Sources for their applications. You can share REST Source Catalogs by exporting the REST Data Source catalog to a file and then importing it into another workspace or another instance.

• Creating a REST Source Catalog
  Create a REST Source Catalog in Workspace Utilities.
• Editing a REST Source Catalog
  Edit an existing REST Source Catalog in Workspace Utilities.
• Managing Catalog Groups
  Use Catalog Groups to organize catalogs into categories..
• About Exporting and Importing a REST Source Catalog
  Move REST Source Catalog to another instance by exporting it to a file and then importing the file into the target instance.

17.4.5.1 Creating a REST Source Catalog

Create a REST Source Catalog in Workspace Utilities.

REST Source Catalogs contain metadata about existing REST Data Sources. REST Source Catalogs are organized in Groups. First, create a group and then create catalogs within the group. Once the REST Source Catalog is present, REST Data Sources can be added to it. To create a REST Source Catalog, you create a group, then create the catalog, and finally associate the REST Data Source with the catalog.

To create a REST Source Catalog:

1. Navigate to the REST Source Catalogs page:
   1. On the Workspace home page, click the App Builder icon.
   2. On the App Builder, click the Workspace Utilities icon.
   3. On the Workspace Utilities page, click REST Source Catalogs.
      The REST Source Catalogs page appears. REST Source Catalogs are organized into categories called groups. First create a group and then create the catalog.
2. Create a group:
   1. From the Tasks list, Manage Catalog Groups.
   2. Click Create Group.
   3. In the Catalog Group Details dialog:

      • Name - Specify the name of the catalog group.

      • Description - Describe the purpose of the group.

      • Click Create.

3. Click the REST Source Catalogs breadcrumb to return to the REST Source Catalogs page.
4. Create a catalog:
   1. Click Create Catalog.
   2. In the REST Source Catalog Details dialog:

      • Group - Select a group used to organize the catalog and assist developers when creating services.

      • Name - Specify the name of the catalog. Catalog names must be unique within a workspace.

      • Internal Name - Specify an internal name of the catalog. The Internal Name is used to identify a catalog across multiple APEX instances. If a catalog is imported and a catalog with the same internal name already exists, then the existing catalog will be overwritten.

      • Description - Describe the REST Source Catalog.

      • Click Create.

5. Create the REST Data Sources to be included in the catalog. See Creating a REST Data Source.
6. Asssign the REST Data Source with the REST Source Catalog:
   1. Edit the REST Data Source. Click the REST Source Name.
   2. Under REST Source Catalog, click Save to Catalog.
   3. In the Save to REST Source Catalog dialog, verify the following:

      • Catalog Group - Select a Catalog Group. If the service will not be added to an existing catalog, select Add a new Catalog Group and follow in on-screen instructions.

      • Catalog - Select the Catalog to which the service will be added. Choose Add a new Catalog if the service will not be added to an existing catalog.

      • REST Source Name - Displays the current REST Source Name.

   4. Click Save to Catalog.
7. Repeat the previous step for each REST Data Source to be added to the catalog.

17.4.5.2 Editing a REST Source Catalog

Edit an existing REST Source Catalog in Workspace Utilities.

To edit a REST Source Catalog:

1. Navigate to the REST Source Catalogs page:
   1. On the Workspace home page, click the App Builder icon.
      The App Builder home page appears.
   2. Click the Workspace Utilities icon.
   3. On the Workspace Utilities page, click REST Source Catalogs.
      The REST Source Catalogs page appears. REST Source Catalogs are organized into categories called groups.
2. To edit a catalog:
   1. Click the Catalog name.
      The REST Source Catalog Details dialog appears.
   2. Edit the appropriate attributes. To learn more about an attribute, see field-level Help.
   3. Click Apply Changes.
3. To delete a catalog.
   1. Click the Catalog name.
      The REST Source Catalog Details dialog appears.
   2. Click Delete.
4. To edit a catalog Group:
   1. Click the Group name.
      The Catalog Group Details dialog appears.
   2. Edit the appropriate attributes. To learn more about an attribute, see field-level Help.
   3. Click Apply Changes.
5. To associate a new REST Data Source with a catalog:
   1. Navigate to REST Data Source.
   2. Under REST Source Catalog, click Save to Catalog.
   3. In the Save to REST Source Catalog dialog, verify the options and click Save to Catalog.

17.4.5.3 Managing Catalog Groups

Use Catalog Groups to organize catalogs into categories..

To manage Catalog Groups:

1. Navigate to the REST Source Catalogs page:
   1. On the Workspace home page, click the App Builder icon.
      The App Builder home page appears.
   2. Click the Workspace Utilities icon.
   3. On the Workspace Utilities page, click REST Source Catalogs.
      The REST Source Catalogs page appears.
2. From the Tasks menu on the right side of the page, click Manage Catalog Groups.
3. To add a Catalog Group:
   1. Click Create Group.
   2. In the Catalog Group Details dialog:

      • Name - Specify the name of the catalog group.

      • Description - Describe the purpose of the group.

      • Click Create.

4. To edit a catalog group.
   1. Click the Catalog Name.
   2. In the Catalog Group Details dialog:

      • Name - Specify the name of the catalog group.

      • Description - Describe the purpose of the group.

      • Click Apply Changes.

5. To delete a Catalog Group:
   1. Click the Catalog Name.
   2. Click Delete.

17.4.5.4 About Exporting and Importing a REST Source Catalog

Move REST Source Catalog to another instance by exporting it to a file and then importing the file into the target instance.

Exporting a REST Source Catalog to another instance involves the following steps:

1. Create the REST Source Catalog.
2. Export the REST Source Catalog. See Exporting a REST Source Catalog.
3. Import the exported file into the target Oracle Application Express instance. See Importing a REST Source Catalog.
4. Install the exported file either directly after importing the file, or later from the Export Repository. See Installing Other Files from the Export Repository.