Getting Started with Event Portal¶

This document takes you through a first design in Event Portal on Sovereign Home Cloud: two application domains, an event shared between them, and the views that show the result. Each step links to the Solace Cloud documentation for the full procedure; Event Portal works the same way here, except where Differences from Solace Cloud says otherwise.

Before You Begin¶

Sovereign Home Cloud is installed and you can open the Cloud Console on your console hostname.
You have a user in an organization. The Ops User Interface (UI) administrator creates organizations and users; see Administering with the Ops UI.
Console sessions end 30 minutes after you sign in, whether or not you're active. If you land on the sign-in page, sign in again; saved work isn't lost.

Open Event Portal from the Cloud Console's navigation.

1. Create an Application Domain¶

In Designer, create an application domain and give it a topic domain, such as acme/orders, so events in it share a topic prefix.

See Application Domains and Topic Addresses.

2. Create a Schema and an Enumeration¶

In the application domain, create a schema for the event's payload, and an enumeration for any topic level with a fixed set of values, such as a region.

See Schemas and Enumerations.

3. Create an Event¶

Create an event with a topic address, such as acme/orders/{region}/created, where {region} is a variable bound to the enumeration, and attach the schema. Mark it shared so applications in other domains can use it.

See Events.

4. Create an Application and Release It¶

Create an application that publishes the event. Then move its version to Released. Event Portal blocks the release while it references objects that are still in Draft: release the enumeration, schema, and event first, then the application.

From the application version, download its AsyncAPI document in version 2.5.0 or 3.0.0.

See Applications.

Create a second application domain with an application that subscribes to the event. Because the event belongs to the first domain, adding it creates an event access request.

Review and approve the request in Designer, from the event access requests list. No email is sent when a request is made or approved, so the owners of the first domain need to check the list.

6. Group Events into an Event API Product¶

Create an Event API that includes the event, then an Event API Product that includes the Event API, with a plan.

See Event APIs and Event API Products.

7. Check the Results¶

View	What to expect
Designer graph	The event connects the publishing application to the subscribing application in the second domain, within a few seconds of the change
Catalog	Searching for the event's name finds the applications, event, schema, Event API, and Event API Product
KPI Dashboard	Loads. Reuse metrics are recalculated every six hours, so they read zero right after you create objects

8. Export and Import¶

Export both application domains to a JSON file, and import them into another organization or installation to copy the design.

See Exporting and Importing Application Domains.

Using the REST API¶

The Event Portal REST API is served from your own hostname, with an API token your installation issues. Give the token the Event Portal permissions your client needs. See Using the REST API for the base URL, tokens, and troubleshooting.