Working with Events in the Developer Portal

Prerequisites for Consuming Events

• You must first add an OPERA environment from which to consume events before adding and subscribing to events.

• The OPERA environment must either have streaming enabled (see Streaming API) or have polling configured (see Configuring the Polling Subscription).

For information on working with business events in OPERA Cloud, refer to the Configuring Business Events topic in the OPERA Cloud User Guide. This topic also provides a list of business events and data elements.

Creating a Template of Events for an Application

The event template represents the list of events a given integration will use. When subscribing to consume events from a given OPERA environment, the template is a faster way to ensure the correct list of events is subscribed.

Before subscribing to consume events from a given OPERA environment, you must first create a template for the integration.

The template can be edited at any time. For example, your integration might change, and it now needs to consumer more events or fewer events.

Note:

Changes made on the template do not affect existing subscriptions to OPERA environments but will take effect when subscribing to new OPERA environments.

To configure the template events, complete the following steps:

1. Open the Developer Portal and click the Applications tab.

2. Search for and click an application to open it.

3. Click the Events tab.

4. Click Add Event to Template and complete the following information:

   1. Category: Select a category for the event, such as Reservation.

   2. Event: Select an event for the category, such as Check In.

      Note:

      To remove an event from the template, click the Remove link.

5. Click Add to add the event to the template.

6. Repeat these steps to add additional events to the template.

Once you have configured all the events your integration requires, click the Subscribed tab and choose any OPERA environment(s) from which to consume these events.

Subscribing to Events

A partner can subscribe to business events from a customer. Subscriptions to business events are specific to each application.

Use the Subscribe tab to subscribe to the list of events that you added on the Template tab.

1. Open the Developer Portal and click the Applications tab.

2. Search for and click an application to open it.

3. Click the Events tab.

4. Click the Subscribed tab.

5. Click the Subscribe link.

6. Select an Environment and click Subscribe.

   If one or more of the events on the template are not available for the selected environment, a warning appears. If accepted, only those events available in the selected environment are subscribed.

7. As a customer subscribing to events from your environment, select which hotels will consume the events.

The subscribed to event will be in a ‘Pending Approval’ status.

Note:

Only OPERA environments enabled for streaming appear in the list of environments. Events will not be subscribed if they are not available in the version of OPERA Cloud run by the selected environment.

Unsubscribing from Events

Once events are approved, you can unsubscribe from them as needed.

Note:

Unsubscribing from events on the Subscribe tab does not affect the events that appear on the Template tab. Also, changes made to events on the Template tab do not affect event subscriptions.

1. Open the Developer Portal and click the Applications tab.

2. Search for and click an application to open it.

3. Click the Events tab.

4. Click the Subscribed tab.

5. Under Event Subscriptions, locate the event and click the green arrow to expand it and then click Unsubscribe.

Approving Events

A customer with Developer Portal access can approve the consumption of events from a specific environment. The customer can approve a partner's request to consume events before any events are sent to the partner. This enables customers to protect their data.

1. Open the Developer Portal and click the Applications tab.

2. Search for and click an application to open it.

3. Click the Partner Applications tab.

   Note:

   Applications with pending event subscriptions appear with a red ribbon icon on the application card.

4. Click an application with a pending event to open it.

5. Click the Events tab.

6. Click Next to proceed with approval.

7. Select the properties for the event subscription and click Next.

8. Click Approve.

The event status changes to ‘In Progress’ and then to ‘Approved’ status. The partner can see this status in the Developer Portal.

Rejecting Events

1. Open the Developer Portal and click the Applications tab.

2. Search for and click an application to open it.

3. Click the Partner Applications tab.

4. Click an application with a pending event to open it.

5. Click the Events tab.

6. Click Reject to reject the subscription.

   The event status changes to ‘In Progress’ and then to ‘Rejected’ status. The partner can see this status in the Developer Portal.

Revoking Events

As a customer, if you no longer want a partner to consume events from your chain, deselect all hotels on the partner's application:

1. Open the Developer Portal and click the Applications tab.

2. Search for and click an application to open it.

3. Click the Partner Applications tab.

4. Click an application with a pending event to open it.

5. Click the Events tab.

6. Click Edit next to the list of hotels.

7. Deselect all the hotels.

8. Click Save.

Adding Events to Existing Subscription

To add events to an existing approved subscription:

1. Add the events on the Template tab (see the ‘Creating a Template of Events for an Application’ procedure above).

2. Subscribe again to consume events from the same environment (see the ‘Subscribing to Events’ procedure above).

Adding Hotels to an Existing Subscription

A customer with Developer Portal access can adjust an existing approved subscription to consume events from different hotels.

1. Open the customer or partner application.

2. Go to the Events tab.

3. Click Edit next to the list of hotels.

4. Select the hotels that can consume the events.

5. Click Save.