Push data to Amperity from Oracle OPERA¶

Oracle OPERA is a property management solution that consolidates reservations, loyalty, sales and catering systems, and guest services into a single platform.

Your brand can configure Oracle OPERA to push profile and reservation events data to a websocket using the OPERA Cloud Streaming API , from which Amperity will pull events data.

Note

This connector requires configuration steps to be completed in Oracle OPERA first, and then within Amperity. Enable the profiles and events stream in Oracle OPERA only after the courier is configured in Amperity.

Important

Configure only one courier in Amperity for Oracle OPERA. Each time the courier runs it pulls all of the data that is available at that time to Amperity. This courier should be configured to run at least one time per week to avoid data loss. Depending on the volume of data that is pushed to Amperity, this courier may need to be configured to run more frequently, such as daily, every six hours, or some other frequency that is required to support your brand’s use cases and to prevent loss of streamed events data.

This topic describes the steps that are required to pull profile and events data to Amperity from Oracle OPERA:

Get details
Configure Oracle OPERA to stream profile and reservation events
Add courier
Enable streaming from Oracle OPERA
Run courier
Add to courier group

Get details¶

Oracle OPERA requires the following configuration details:

	Configure environment and application, get Oracle OPERA config settings Do the following steps in Oracle OPERA before configuring Amperity: Create an environment in Oracle OPERA . After the environment is created, get the enterprise ID and chain code for that environment. Caution Do not enable streaming in the Oracle OPERA environment until after the courier that will pull streamed data to Amperity has been configured. Get the client ID, client secret, and gateway URL for Oracle OPERA Register an application . After the application is registered, get the application key for that application.
	Configure Amperity Configure a courier for streaming events using the configuration settings from Oracle OPERA. Use the Client ID and Client secret to configure credentials. Use the Gateway URL, Application key, Enterprise ID, and Chain code to configure the courier.
	Configure business events for streaming, enable stream Configure the environment to stream individual datasets for the following business event types: Configure profile events. Review the list of profile events that are available from Oracle OPERA. Tip Profile events contain the following datasets: delete history, delete profile, delete relationship, new history, new profile, new relationship, purge profile, subscribed profile, update history, update profile, and update relationship. Configure reservation events. Review the list of reservation events that are available from Oracle OPERA. Tip Reservation events contain the following datasets: advance check-in, cancel, check-in, check-out, close guest folio, delete reservation, delete routing, delete guest message, delete trace, join guest, new reservation, new guest message, new routing, new trace, no-show, reactivate no-show, reactivate waitlist, reverse advance check-in, reverse check-in, reverse check-out, rollback cancel, separate guest from share, turnaway, update certificate, update reservation, update routing, update guest message, and update trace. Enable streaming in the environment that was created in Oracle OPERA. Note Business events have three layers: Module Action type Elements For example, within Oracle OPERA Profile events is the module, “new profile” is the dataset, and elements represents each field in the dataset. Run the Amperity courier manually, and then verify that streamed data is available in Amperity.
	Oracle OPERA makes streamed data available from the Streaming API . Important Configure only one courier in Amperity for Oracle OPERA. Each time the courier runs it pulls all of the data that is available at that time to Amperity. This courier should be configured to run at least one time per week to avoid data loss. Depending on the volume of data that is pushed to Amperity, this courier may need to be configured to run more frequently, such as daily, every six hours, or some other frequency that is required to support your brand’s use cases and to prevent loss of streamed events data.

Tip

Use SnapPass to securely share configuration details for Oracle OPERA between your company and your Amperity representative.

Configure Oracle OPERA¶

The following steps must be completed in Oracle OPERA before you can configure Amperity:

Create an environment in Oracle OPERA . After the environment is created, get the enterprise ID and chain code for that environment.

Caution

Do not enable streaming in the Oracle OPERA environment until after the courier that will pull streamed data to Amperity has been configured.
Get the client ID, client secret, and gateway URL for Oracle OPERA
Register an application. After the application is registered, get the application key for that application.

Add courier¶

A courier brings data from an external system to Amperity.

Important

Configure only one courier in Amperity for Oracle OPERA. Each time the courier runs it pulls all of the data that is available at that time to Amperity. This courier should be configured to run at least one time per week to avoid data loss. Depending on the volume of data that is pushed to Amperity, this courier may need to be configured to run more frequently, such as daily, every six hours, or some other frequency that is required to support your brand’s use cases and to prevent loss of streamed events data.

To add a courier

From the Sources page, click Add Courier. The Add Source page opens.
Find, and then click the icon for Oracle OPERA. The Add Courier page opens.

This automatically selects oracle-opera as the Credential Type.
From the Credential drop-down, select Create a new credential. Configure the credential using the Client ID and Client secret.
Under Oracle Opera Settings configure the Gateway URL, Application key, Enterprise ID, and Chain code.

Note

The combination of gateway URL, application key, and chain code uniquely identifies a stream.
Under Oracle Opera Settings configure the load operations to pull each of the business events datasets that were made available. For example:
```
{
  "FEED-ID": [
    {
      "type": "load",
      "file": "join-guest-data"
    }
  ],
  "FEED-ID": [
    {
      "type": "load",
      "file": "update-history-data"
    }
  ],
  ...
  "FEED-ID": [
    {
      "type": "load",
      "file": "check-in-data"
    }
  ],
  "FEED-ID": [
    {
      "type": "load",
      "file": "delete-guest-message-data"
    }
  ]
}
```
Important

If the business events are changed in Oracle OPERA you must configure a new courier. Feed configuration within Amperity can be edited, but if the list of business events that are made available from the Oracle OPERA change a new courier must be configured.
Click Save.

Enable streaming from Oracle OPERA¶

Configure the Oracle OPERA environment to stream individual datasets for the following business event types:

Profile events: Review the list of profile events that are available from Oracle OPERA.

Tip

Profile events contain the following datasets: delete history, delete profile, delete relationship, new history, new profile, new relationship, purge profile, subscribed profile, update history, update profile, and update relationship.
Reservation events: Review the list of reservation events that are available from Oracle OPERA.

Tip

Reservation events contain the following datasets: advance check-in, cancel, check-in, check-out, close guest folio, delete reservation, delete routing, delete guest message, delete trace, join guest, new reservation, new guest message, new routing, new trace, no-show, reactivate no-show, reactivate waitlist, reverse advance check-in, reverse check-in, reverse check-out, rollback cancel, separate guest from share, turnaway, update certificate, update reservation, update routing, update guest message, and update trace.

When finished enable streaming in the environment that was created in Oracle OPERA, after which you can run the Amperity courier manually and verify that streamed data is available in Amperity.

Run courier manually¶

Run the courier again. This time, because the load operations are present and the feeds are configured, the courier will pull data from Oracle OPERA.

To run the courier manually

From the Sources tab, open the menu for the courier with updated load operations that is configured for Oracle OPERA, and then select Run. The Run Courier dialog box opens.
Select the load option, either for a specific time period or all available data. Actual data will be loaded to a domain table because the feed is configured.
Click Run.

This time the notification will return a message similar to:
```
Completed in 5 minutes 12 seconds
```

Add to courier group¶

From the Sources tab, click Add Courier Group. This opens the Create Courier Group dialog box.
Enter the name of the courier. For example: “Oracle OPERA”.
Add a cron string to the Schedule field to define a schedule for the orchestration group.

A schedule defines the frequency at which a courier group runs. All couriers in the same courier group run as a unit and all tasks must complete before a downstream process can be started. The schedule is defined using cron.

Cron syntax specifies the fixed time, date, or interval at which cron will run. Each line represents a job, and is defined like this:
```
┌───────── minute (0 - 59)
│ ┌─────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌────────────── month (1 - 12)
│ │ │ │ ┌─────────────── day of the week (0 - 6) (Sunday to Saturday)
│ │ │ │ │
│ │ │ │ │
│ │ │ │ │
* * * * * command to execute
```
For example, 30 8 * * * represents “run at 8:30 AM every day” and 30 8 * * 0 represents “run at 8:30 AM every Sunday”. Amperity validates your cron syntax and shows you the results. You may also use crontab guru to validate cron syntax.
Set Status to Enabled.
Specify a time zone.

A courier group schedule is associated with a time zone. The time zone determines the point at which a courier group’s scheduled start time begins. A time zone should be aligned with the time zone of system from which the data is being pulled.

Use the Use this time zone for file date ranges checkbox to use the selected time zone to look for files. If unchecked, the courier group will use the current time in UTC to look for files to pick up.

Note

The time zone that is chosen for an courier group schedule should consider every downstream business processes that requires the data and also the time zone(s) in which the consumers of that data will operate.
Add at least one courier to the courier group. Select the name of the courier from the Courier drop-down. Click + Add Courier to add more couriers.
Click Add a courier group constraint, and then select a courier group from the drop-down list.

A wait time is a constraint placed on a courier group that defines an extended time window for data to be made available at the source location.

Important

A wait time is not required for a bridge.

A courier group typically runs on an automated schedule that expects customer data to be available at the source location within a defined time window. However, in some cases, the customer data may be delayed and isn’t made available within that time window.
For each courier group constraint, apply any offsets.

A courier can be configured to look for files within range of time that is older than the scheduled time. The scheduled time is in Coordinated Universal Time (UTC), unless the “Use this time zone for file date ranges” checkbox is enabled for the courier group.

This range is typically 24 hours, but may be configured for longer ranges. For example, it’s possible for a data file to be generated with a correct file name and datestamp appended to it, but for that datestamp to represent the previous day because of how an upstream workflow is configured. A wait time helps ensure that the data at the source location is recognized correctly by the courier.

Warning

This range of time may affect couriers in a courier group whether or not they run on a schedule. A manually run courier group may not take its schedule into consideration when determining the date range; only the provided input day(s) to load data from are used as inputs.
Click Save.