Configuring Outbound Systems

Overview

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.

Note:

Enable Bypass Proxy when you configure the endpoint URL provided by Oracle Cloud within the same region. Do not enable if the URL is from a cross region or non-Oracle Cloud.

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 Toolbox menu, 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, such as 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. Bypass Proxy: Select the check box when the outbound system endpoint URL is provided by Oracle Cloud Service. 

   14. 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.

          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 Toolbox menu, 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 menu, 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 Toolbox menu, 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 menu, and select Delete.

4. Click Delete to confirm.

Testing Outbound System Connectivity

1. From the Toolbox menu, 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.

DATA VALUE MAPPINGS

Data Value Mapping (DVM) configuration is provided for defining conversions between OPERA Values and Outbound System values for the Outbound Codes created.

Data Value Mapping is visible only for the Outbound Codes created with Enable Conversions while creating the Outbound Code.

It is available under the I Want To . . . options.

1. Search for the Outbound Code created at the Global (Chain) or Property Level.

2. Click the I Want To . . . icon from the search results row where you want to define Data Value Mappings.

3. The Data Value Mapping screen launches in a pop-up window with Outbound Code as an Interface.

4. Select the required group from the left pane, and the right pane loads with the predefined codes if available.

5. You can create a new conversion, edit a conversion, or delete an existing conversion.

CUSTOM HEADERS

Custom Headers configuration is provided for defining the additional custom header names and values for the Outbound Codes created.

Custom Headers allow you to define a maximum of five custom header names and values that can be communicated with external systems during API calls.

Custom Headers configuration is available under the I Want To . . . options.

1. Search for the Outbound Code created at the Global (Chain) or Property Level.

2. Click the I Want To . . . icon from the search results row where you want to define Custom Headers.

3. The Custom Headers screen launches in a pop-up window.

4. Click Edit to define the Header Name and Header Value and then click Save.

5. You can edit and modify values for any changes, or you can delete a row by removing the field values (make the field blank) and save to update the configuration.

Configuring Custom Headers

A maximum of five header can be configured; standard headers cannot be configured as custom headers. To delete a header clear the Header Name and Header Value entry.

1. From the Toolbox menu, 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.

   1. Header Name: Enter a name for the header.

   2. Header Value: Enter a value for the header

   3. Click Save.

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:

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

2. Select the Outbound Type GAMING_SGACSC.

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

4. Enter a Description for the gaming system.

5. Enable the External System, enable Conversions, and enable the external Property Code.

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

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

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

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

10. Save the Outbound Code configuration.

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

    2. 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:

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

2. Select the Outbound Type GAMING_SGCMP.

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

4. Enter a Description for the gaming system.

5. Enable the External System, enable Conversions, and enter the external Property Code.

6. Protocol is defaulted with REST for Scientific Games integration.

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

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

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

10. Save the Outbound Code configuration.

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

    2. 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.

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

2. Select Outbound Type GAMING_GENERIC.

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

4. Enter a Description for the gaming system.

5. Enable the External System, enable Conversions, and enter the external Property Code

   .

6. Protocol is defaulted with REST for Scientific Games integration.

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

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

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

10. Save the Outbound Code configuration.

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

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

EXPERIAN QAS ADDRESS VALIDATION

The Outbound Type ADDRESS_QAS is used to integrate OPERA Cloud functionality and its respective REST APIs with the Experian QAS address validation functionality and its respective REST APIs. The OPERA Cloud Outbound Pattern framework transforms the OPERA REST specifications into Experian REST specifications during outbound communications. The Address Validation Integration user must configure the Outbound Code with the following configurations:

1. Outbound Code can be created at the Global (Chain) or Property level context based on the Address Validation integration requirement.

2. Select Outbound Type ADDRESS_QAS.

3. Enter a unique Outbound Code, for example: ADDQASCHAIN1.

4. Enter a Description for the Address Validation System summary.

5. Protocol is defaulted with REST for ADDRESS_QAS integration.

6. Select Authorization Type Token.

7. Enter the Token Details provided by Experian.

8. Enter the RESP API Base URL Service Path provided by Experian. For example, https://api.experianaperture.io.

9. Save the Outbound Code configuration.

10. Search for the Outbound Code created and navigate to I Want To . . . options: Custom Headers.

    1. Select New.

    2. Add header name as Add-Components.

    3. Add header value as True.

    4. Click Save.

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

    • Define the Conversion Codes for State Code (be sure to include the Country Code field in State Code Mapping), Country Code (Experian uses ISO3 codes).

GBG LOQATE ADDRESS VALIDATION

Outbound Type ADDRESS_GBG is used to integrate OPERA Cloud functionality and its respective REST APIs with GBG loqate address validation functionality and its respective REST APIs. OPERA Cloud Outbound Pattern framework transforms the OPERA REST specifications into GBG REST specifications during outbound communication. The Address Validation Integration user must configure the Outbound Code with the following configurations:

1. The Outbound Code can be created at the global (Chain) or property level context based on the Address Validation integration requirement.

2. Select Outbound Type ADDRESS_GBG.

3. Enter a unique outbound code, for example: GBGCHAIN1.

4. Enter a description for the Address Validation System summary.

5. Protocol is defaulted with REST for ADDRESS_GBG integration.

6. Select Authorization Type TOKEN.

7. Enter the Token details provided by GBG.

8. Enter the RESP API Base URL Service Path provided by GBG.

   • For example, https://api.addressy.com/Capture/Interactive/.

9. Save the Outbound Code configuration.

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.

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

2. Select the Outbound Type CRM.

3. Enter a unique Outbound Code, for example: CRMCHAIN1

4. Enter a Description for the CRM System summary

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

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

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

6. Protocol is defaulted with REST for CRM integration.

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

8. Enter the REST API Base URL Service Path provided by the CRM vendor. For example, https://api.mycrmsystem.com/apis/.

9. 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 like Profile Lookup and Download with legacy OPERA Reservation System (ORS) interfaces.

1. 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.

2. Select Outbound Type CRM_LEGACY.

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

4. Enter a Description for the CRM Legacy System summary.

5. Protocol is defaulted with XML for CRM_LEGACY integration.

6. Select an Authorization Type for the CRM Legacy integration.

   1. Select NONE for Non-SSD OPERA V5 ORS.

   2. Select BASIC for SSD OPERA V5 ORS.

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

8. Add a new Row, select GetExternalProfiles, and enter the Service Path to fetch profiles, for example: http://host/Operajserv/OperaWebSvcs/Lookup.

9. Add a new Row, select DownloadExternalProfile, and enter the Service Path to download profiles, for example: http://host/Operajserv/OXIServlets/ORSLookup.

10. Add New row, select GetMembershipDetails, enter service path for get membership details of the profile, for example: http://host/Operajserv/OperaWebSvcs/MemberInfo.

11. Add New row, select PostMembershipNumber, enter service path for download profiles, for example: http://host/Operajserv/OperaWebSvcs/NewMemberCard.

12. Add New row, select RedeemAward, enter service path for download profiles, for example: http://host/Operajserv/OXIServlets/ORSLookup.

13. Save the Outbound Code configuration

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

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

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

15. If you are trying to configure the ORS interface for the first time, refer to Interface Setup.

CRM for IATA

Outbound Type CRM_IATA is used to integrate the OPERA Cloud Travel Agent Profile's IATA number validation functionality with the IATA organization.

1. The outbound code should be created at the Property level.

2. Select Outbound Type CRM_IATA.

3. Enter a unique Outbound Code, for example: IATAP1.

4. Enter a Description such as IATA Validation System.

5. Protocol is defaulted with REST for CRM_IATA integration.

6. Select Authorization Type TOKEN.

7. Enter the Token value provided by IATA.

8. Enter the Application Key provided by IATA.

9. Enter the REST API Base URL Service Path provided by IATA organization:

   1. For example, https://globaldata.developer.iata.org/v1/checkacode.

10. Save the Outbound Code configuration.