Configuring Outbound Systems

Outbound System Configuration provides a way to enable integrations initiated from within OPERA Cloud.

For example, for an integrated CRM solution that follows the OPERA Cloud REST specification, you can define an Outbound Code with Outbound Type = CRM and configure the CRM system end point URL and authentication credentials. Then, from the respective area(s) of OPERA Cloud, you can make synchronous calls (GET/POST) from OPERA Cloud to/from the CRM system using the REST web services.

Note:

The screen is accessible for Role/Task Permission: Toolbox > Outbound System Configuration privileged users.

Note:

The Configured OAuth Token URL and Service Path URLs must be added to the proxy allow-list using a CX/MOS request.

Note:

Prerequisite: Proxy Server, Proxy server by pass controls needs to be configured under the OPERA Controls General group to work with any outbound calls that occur from the proxy server.

You can create the Outbound Code at the Global (Chain) or Property level for the available Outbound Types.

Adding Outbound Systems Configuration

1. From the side menu, select Toolbox, select System Setup, and then select Outbound System Configuration.

2. Click New and complete the following:

   1. Context. Select a value from the list.

      1. Select Global when you want to define chain-level outbound system configurations that can be used by all properties in the chain.

      2. Select Property when you want to define property-level outbound system configurations that can be used by the property

   2. Outbound Type. Select an Outbound Type for which you want to create a configuration.

   3. Outbound Code. Enter the unique Outbound Code you want to create, for example, SGAP1, CRMC1, CRMP1, and so on.

      Note:

      The Outbound Code is unique in the given OPERA Cloud multi-tenant instance.

   4. Outbound Description. Enter Summary Description of the Outbound System being configured.

   5. Protocol. Gets defaulted with the supported protocol REST or XML for the selected Outbound Type for user information.

   6. Enable External System: Select this option to create an External System Code and External Database Code in OPERA Cloud, the same as the Outbound Code.

   7. Enable Conversions: This option is enabled when you select the above option. Select this option to define Data Value Mappings for the specific conversion groups.

      1. When you try to create a Global Level Outbound Code, Enable Conversion is disabled as no versions are allowed at the Global level.

      2. Data Value Mapping conversions can be defined only for Property Level Outbound codes when this option is selected.

   8. External Property: This field is visible when the above option is selected for defining a Property conversion code.

   9. Authorization Type. Select a value from the list.

      1. BASIC – when an external system provides only basic authentication details, such as user account user name and service account password key details.

      2. OAUTH – when an external system provides open authorization details, such as OAuth Token URL, service account and key, and clientid and secrete credential details.

      3. TOKEN – when the vendor system provides only token based authorization. A token key up to 256 characters is allowed.

      4. NONE – when there is no authorization required. This is applicable only for CRM_LEGACY outbound type configurations.

   10. Grant Type. Select a value from the list:

       1. Password – when an external system provides you with Service Account and Key and Client ID and Key details.

       2. Client Credentials – when an external system provides you only the Client ID and Key details.

   11. Scope. Enter the Scope URL provided by the external system.

   12. Application Key. Enter the Application Key provided by the external system.

   13. Service Details.

       Enter details.

       1. Service Name. Defaulted value RESTAPIBaseURL.

       2. Service Path. Enter the external system's REST APIs base URL. The path should not include any relative paths, query parameters, or path parameters.

          1. For example, you need to set the Base URL only, which is https://mycrmsystem.com/crm/v1/.

          2. In this case, for Profile Lookup, the target URL generates as: https://mycrmsystem.com/crm/v1/externalSystems/{systemCode}/chains/{chainCode}/externalProfiles.

3. Click Save.

Editing Outbound System Configuration

1. From the side menu select Toolbox, select System Setup, and then select Outbound System Configuration.

2. Enter search criteria and click Search.

3. Select the Outbound System in search results, click the vertical ellipsis Actions, and select Edit.

   1. Update the configuration.

   2. Inactive. Select to make the outbound connection inactive. Deselect to activate.

   3. Make any necessary changes as required.

4. Click Save.

Deleting Outbound System Configuration

1. From the side menu select Toolbox, select System Setup and then select Outbound System Configuration.

2. Enter search criteria and click Search.

3. Select the Outbound System in search results, click the vertical ellipsis Actions, and select Delete.

4. Click Delete to confirm.

Testing Outbound System Connectivity

1. From the side menu select Toolbox, select System Setup, and then select Outbound System Configuration.

2. Enter search criteria and click Search.

3. Select the Outbound System in search results, click the vertical ellipsis Actions, and select Test.

4. Click OK.

   1. Test Connection Result Messages.

   2. When the configured Base URL service path is valid, it shows an information message, "Test Connection Successful."

   3. When the configured Base URL Service path is not secured, it shows an error, “Test Connection Failed - Processing Exception occurred.”

   4. When the configured Base URL Service path is not available, it shows an error, “Test Connection Failed with response status: 502-Bad Gateway.”

   5. When the configured Base URL service path is invalid, it shows an error, “Test Connection Failed - SSLHandshake Error. Please contact Oracle Support.”

   6. When Test connection is performed for GAMING_SGACSC, GAMING_SGCMP, it shows an error, “Test connection cannot be done for this configuration.”

   7. When Test connection is performed without adding the Service Path to the proxy allow-list, it shows an error, “Test connection not allowed through proxy. Please contact administrator.”

      Note:

      The test connection validates the Service Path URL only, which is configured and added to the proxy allow-list.

Outbound System Types and Respective Configurations

SCIENTIFIC GAMES ACSC

Outbound Type GAMING_SGACSC is used to integrate OPERA Cloud functionality and its respective REST APIs with Scientific Games ACSC functionality and its respective REST APIs. The Gaming Integration user must configure the Outbound Code with the following configurations:

• The Outbound Code should be created for the property that requires Scientific Gaming (SC) integration.

• Select the Outbound Type GAMING_SGACSC.

• Enter a unique Outbound Code, for example: SGACSCP1.

• Enter a description for the gaming system.

• Enable the external system, enable Conversions, and enable the external Property Code.

• Protocol is defaulted with REST for Scientific Games ACSC integration.

• Select Authorization Type OAUTH and provide the OAuth Token URL, for example: https://api.sgenvoy.com/oauth.

• Select Grant Type Client Credentials and enter the Client ID, Client Key, and Application Key provided by SG.

• Enter the RESP API Base URL Service Path provided by SG, for example: https://api.sgenvoy.com.

• Save the Outbound Code configuration.

  • Search for the Outbound Code created and navigate to the I Want To . . . option, Data Value Mappings.

  • Define the Conversion Codes for Address Type, Gender, Phone Type, State Code, Country Code, Language Code, Profile Type, Title, Membership Level, and Membership Type.

SCIENTIFIC GAMES CMP

The Outbound Type GAMING_SGCMP is used to integrate OPERA Cloud functionality and its respective REST APIs with Scientific Games CMP functionality and its respective REST APIs. The Gaming Integration user must configure the Outbound Code with the following configurations:

• The Outbound Code should be created for the property that requires Scientific Gaming (SC) integration.

• Select the Outbound Type GAMING_SGCMP.

• Enter a unique Outbound Code, for example: SGCMPPROP2.

• Enter a description for the gaming system.

• Enable the external system, enable Conversions, and enter the external Property Code.

• Protocol is defaulted with REST for Scientific Games integration.

• Select Authorization Type OAUTH and provide the OAuth Token URL, for example: https://api.sgenvoy.com/V1.6/oauth.

• Select Grant Type Client Credentials and enter the Client ID, Client Key, and Application Key provided by SG.

• Enter the RESP API Base URL Service Path provided by SG, for example: https://api.sgenvoy.com/V1.6/.

• Save the Outbound Code configuration.

  • Search for the Outbound Code created and navigate to the I Want To . . . option, Data Value Mappings.

  • Define the Conversion Codes for Address Type, Gender, Phone Type, State Code, Country Code, Language Code, Profile Type, Title, Membership Level, and Membership Type.

GAMING GENERIC

The Outbound Type GAMING_GENERIC is used to integrate OPERA Cloud functionality, such as Profile Lookup and Download, and Create Enrollment with any Gaming Vendor System that follows OPERA Cloud REST APIs specifications and standards.

• An Outbound Code should be created for the property that requires Scientific Gaming integration.

• Select Outbound Type GAMING_GENERIC.

• Enter a unique Outbound Code, for example: GAMGENPPROP3.

• Enter a description for the gaming system.

• Enable the external system, enable Conversions, and enter the external Property Code

  .

• Protocol is defaulted with REST for Scientific Games integration.

• Select Authorization Type OAUTH and provide the OAuth Token URL, for example: https://gaminghost.com/v1/oauth.

• Select Grant Type Client Credentials and enter the Client ID, Client Key, and Application Key provided by the gaming vendor.

• Enter the RESP API Base URL Service Path provided by SG, for example: https://gaminghost.com/v1.

• Save the Outbound Code configuration.

  • Search for the Outbound Code created and navigate to the I Want To . . . options, Data Value Mappings.

  • Define the Conversion Codes for Address Type, Gender, Phone Type, State Code, Country Code, Language Code, Profile Type, Title, Membership Level, and Membership Type.

CRM GENERIC

Outbound Type CRM is used to integrate OPERA Cloud CRM functionality, such as Profile Lookup and Download, and create enrollment in any CRM Vendor System that follows OPERA Cloud REST APIs specifications and standards.

• An Outbound Code can be created at the Global (Chain) or Property level context based on the CRM system integration requirement.

• Select the Outbound Type CRM.

• Enter a unique Outbound Code, for example: CRMCHAIN1

• Enter a description for the CRM System summary

• Enable External System, enable Conversions, and enable External Property Code. When Enable External System is selected:

  • An External System code gets created automatically, the same as Outbound Code with the Lookup flag enabled.

  • An External Database code gets created automatically, the same as Outbound Code and the same code is available for Profile Lookup.

• Protocol is defaulted with REST for CRM integration.

• Select Authorization Type Basic, or Oauth, or Token with the respective authorization details based on the CRM vendor details provided.

• Enter the REST API Base URL Service Path provided by the CRM vendor.

  • For example, https://api.mycrmsystem.com/apis/.

• Save the Outbound Code configuration.

  Note:

  For more information, see: Prerequisites for Enrolling Guests in External Loyalty Programs.

CRM FOR LEGACY ORS

Outbound Type CRM_LEGACY is used to integrate OPERA Cloud CRM functionality, such as Profile Lookup and Download, with legacy OPERA Reservation System (ORS) interfaces.

• The Outbound Code can be created at the Global (Chain) or Property level context based on the CRM system integration requirement.

  Note:

  It is recommended that you create at Global level if all the properties of the Chain use the same OPERA Reservation System (ORS) system.

• Select Outbound Type CRM_LEGACY.

• Enter a unique Outbound Code, for example: CRMORSCHAIN1.

• Enter a description for the CRM Legacy System summary.

• Protocol is defaulted with XML for CRM_LEGACY integration.

• Select an Authorization Type for the CRM Legacy integration.

  • Select NONE for Non-SSD OPERA V5 ORS.

  • Select BASIC for SSD OPERA V5 ORS.

• Enter the Application Key if provided by the legacy system.

• Add a new row, select GetExternalProfiles, and enter the service path to fetch profiles, for example: http://host/Operajserv/OperaWebSvcs/Lookup.

• Add a new row, select DownloadExternalProfile, and enter the service path to download profiles, for example: http://host/Operajserv/OXIServlets/ORSLookup.

• Save the Outbound Code configuration

• If you are using an existing ORS system for Lookup and Download:

  • Ensure the Lookup flag is enabled for the External System ORS under OPERA Cloud Administration > Interfaces > Business Events > External System.

  • Associate the Outbound Code with the External Database Code of the ORS Interface under Toolbox > External Database.

• If you are trying to configure the ORS interface for the first time:

  • Refer to Interface Setup Help.

SERVICE LOCATOR GENERIC

Outbound Type SL_GENERIC is used to configure the Outbound system details for the OPERA Cloud UI and Oracle Hospitality Integration Platform (OHIP) platform request traffic for the Service Locator routing.

The Service Locator configuration allows you to configure API routing with the outbound systems configured with Outbound type SL_GENERIC.

• The Outbound Code can be created at the Global (Chain) or Property level context based on the Service Locator integration requirement.

• Select the Outbound Type SL_GENERIC.

• Enter a unique Outbound Code, for example: SLGENC1.

• Enter a description for the Outbound System summary.

• Protocol is defaulted with REST for SL_GENERIC integration.

• Select Authorization Type Basic, or Oauth, or Token with respective authorization details based on the Outbound system vendor details provided.

• Enter the REST API Base URL Service Path provided by Outbound Systems.

  • For example, https://api.mycrmsystem.com/apis/.

• Save the Outbound Code configuration.