Catalog

Catalog acts as a storefront for all the applications, events, and schemas you've created in the Event Portal. It provides a searchable index of all event-related objects within an enterprise. Objects discovered and committed in Discovery, or created in Designer are automatically available in Catalog. Using Catalog's searchable interface, you can access all the existing events, schemas, and applications

On this page, we will dive into the detailed features and functionality of Catalog. We will walk you through some of the common activities you will perform when browsing and visualizing objects in Catalog. If you are getting started, take a look at Browse Event Streams and Visualize their Relationships.

Prerequisites

Ensure that you have the correct user role and permission in Event Portal.

  • Users with Event Portal Manager and Administrator roles can access all objects in Catalog.
  • Users with Event Portal User roles has limited viewing access in Event Portal. By default, they can only view shared events, shared schemas and Event API Products. They can be given access to one or more application domains. For more information on how to set application domain user access, refer to Designer.

Browsing for Published Objects in Catalog

As enterprises grow, the number of schemas, events and applications will increase to the point where browsing a list is no longer reasonable. Event Portal provides a rich search capability that enables you to always find what you are looking for with Catalog.

To browse Catalog for an event, application or schema, do the following:

  1. Log in to your PubSub+ Cloud account.

  2. Select the Catalog card or click Catalog on the left navigation bar.

  3. On the top menu, select Schemas, Events or Applications tab.

  4. Click on the search field and enter your search term. The system looks for content in all objects of that type; within the metadata or schema (if searching schemas). Alternatively, you can also filter items based on whether the object type is shared, application domain they are associated with, or the owners. For events, use the Topic Scheme filter to see the list of Solace or Kafka events. Likewise, for Applications, use the Application Class filter to see the list of Kafka Connector or Kafka Application
  5. Once you've found an application, event, or a schema of interest, you can perform the following tasks:
    • visualize relationships between an application, event, or a schema
    • view the revision history
    • add events to an application or add a schema to an event
    • generate an application's AsyncAPI specification document

Visualizing Object Relationships

The ability to view relationships is an important feature. For example, a data scientist may know the name of a JSON Schema attribute and could search schemas for that keyword. From there, he can locate the schema of interest and view the events which reference that schema. Furthermore, the user can now decide to consume one of these events, depending on the business context of the event and the problem they are trying to solve.

To visualize object relationships in Catalog, perform any of the following tasks:

  1. Log in to your PubSub+ Cloud account.

  2. Select the Catalog card or click Catalog on the left navigation bar.

  3. On the top menu, select Schemas, Events or Applications tab.

  4. Click an object of your choice to view its corresponding relationships.

Viewing Revision History

To view or edit the revisions of an application, event, or a schema, do the following:

  1. Log in to your PubSub+ Cloud account.

  2. Select the Catalog card or click Catalog on the left navigation bar.

  3. On the top menu, select Schemas, Events or Applications tab.

  4. Select the checkbox for you desired event, schema, or application from the list.

  5. Click on the revisions icon located on the top right to view the list of revisions for that object.

Viewing an Older Revision

You can view each revision to see the name of the person who made changes in that Rev. You can also see their change comments if they left any. When you select a previous revision of the object, you'll see a header, like the image below, at the top of the page. You can navigate and view changes for each revision.

The functions displayed on the revisions menu, similar to the above image, are described in the following table.

Function

Description

View Current Revision

View the latest revision of the object.

Compare with Previous

Coming Soon

Compare with Current

Coming Soon

Restore this Revision

Roll back the content of the object to the previous revision that you are viewing.

View Event Revisions

Return to the list of event revisions.

View Schema Revisions Return to the list of schema revisions.
View Application Revisions Return to the list of application revisions.

Previous and Next

View the previous or next revision of the object.

Restoring a Previous Revision

To restore an event, application, or a schema to a previous revision, do the following:

  1. Select the event, application, or schema that you want to restore to a previous version
  2. Click the revision icon () located on the top right.
  3. Select the version you want to restore and click the Restore or the Restore Revision icon.

Revision history is retained in Event Portal up to a max of 100 revisions per object before the oldest revisions is deleted. When you restore an older revision, a copy of the previous revision is automatically created. For example, if you restore Rev 39, a copy of Rev 39 is created, and that copy will become the new (current) revision.

Adding Events to Applications

To add an event to an application, do the following:

  1. Log in to your PubSub+ Cloud account.

  2. Select the Catalog card or click Catalog on the left navigation bar.

  3. On the top menu, select the Events tab.

  4. Browse the event you want to use and select the checkbox.

  5. Click Add to Application on the top right.

  6. On the Add Events to Application page, select an application you want to associate the event to. You can also browse for applications using the search field, filter applications within an application domain, or create a new application.

    Use the table setting icon () to manage columns or adjust truncation control.

  7. Once you've selected an application, click Next and follow the prompt.

Adding Schemas to Events

To add an event to an application, do the following:

  1. Log in to your PubSub+ Cloud account.

  2. Select the Catalog card or click Catalog on the left navigation bar.

  3. On the top menu, select the Schemas tab.

  4. Browse the schema you want to use and select the checkbox.

  5. Click Add to Event on the top right.

  6. On the Add Schema to Event page, select aschema you want to associate the event to. You can also browse for schemas using the search field, filter schemass within an application domain, or create a new schema.

    Use the table setting icon () to manage columns or adjust truncation control.

  7. Once you've selected a schema, click Next and follow the prompt.

Generating an AsyncAPI Specification in Catalog

To generate an AsyncAPI document for an application, perform the following steps:

  1. Log in to your PubSub+ Cloud account.

  2. Select the Catalog card or click Catalog on the left navigation bar.

  3. On the top menu, select the Applications tab.

  4. Browse the application you want to use and select the checkbox.

  5. Click AsyncAPI on the top right.

  6. Select the format and click Download.