Configuring Interface Communication Methods

Communication methods defines how the OXI interface receives and transmits messages. In multi-property operations communication methods setup is either global or property-specific; with property-specific communication overriding global configuration for the property.

The communication methods must be set up for each interface before the interface can be activated.

Editing Interface Communication Methods

Note:

Each data flow direction requires its own setup. When no result are listed at a Property level, the Comm Method has been defined at Global (Chain) level.

Note:

• OPERA Cloud Exchange communication method allows you to configure only client (http/https) mode to communicate with ORS external system.

• Default Global communication method is set as client with URL https://fixme.url. 

• When user creates Property level communication methods, it  requires a valid client URL of an external system. 

• You are allowed to define property level communication for the respective Data flow based on the Interface Setup. 

• Changes in the communication method requires the Processor restart to take effect of the modified communication details.

• When communication method changed from Client to Server, a warning message "Messages cannot be fetched after 48 hours. To stop generating OXI Messages, Inactivate the External System for the Property." is displayed.

• When communication method deleting (switching from property to global), a warning message "Global communication mode will be used for message delivery. To stop generating OXI Messages, Inactivate the External System for the Property." is displayed.

1. From the Exchange menu, select Interface Setup and then select Communication Methods.

2. In the search panel select:

   1. Location

      1. Global: Select to configure for all properties

      2. Property: Select to configure for a specific property

         1. Property: Select a property from the list

   2. Interfaces: Click to select one or more OXI interfaces from the list

   3. Click Search.

3. Select an interface and data flow direction from the search result, then click the vertical ellipsis and select Edit.

   1. Location

      1. Global: Select to configure for all properties.

      2. Property: Select to configure for a specific property.

         1. Property: Select a property from the list.

   2. Communication Mode:

      1. HTTP(S)/Client: Select if the data is sent from OPERA Cloud to the External System

      2. Details

         1. URL: Based on the data flow selected, this will be the GET URL or POST URL and defines the web server location where OXI will either get the messages that are waiting for transfer to OPERA Cloud, or where it will post the messages to the external system.

         2. Username: Enter the username provided for the client URL when basic authentication is enabled.

         3. Password: Enter the password provided for the client URL when basic authentication is enabled

         4. Compress Data: Select checkbox to enable compression of the OXI messages prior to transmission to external systems

         5. Use Client Certificate: This option is enabled only when the URL is configured as HTTPS protocol. Select this check box to have the OXI processor use the client certificate to authenticate against the external system server and encrypt the messages exchanged with the external system server NOTE: This requires an additional support process to implement  

         6. Sleep Timeout: Enter number of minute where the interface rests between waking up and doing POST and GET functions. If the interface continues to receive messages, then it will not sleep. This field accepts decimals for times smaller than the (1) minute time. Time entered with a dot (.1) will be read as seconds (10 seconds).

         7. Timeout: Enter in seconds the duration the interface tries to establish a connection before treating it as "timed-out" and creating a log entry. At this time it will go into the "Sleep Time" before attempting again.

      3. Server: Select if the data is posted from the External System to OPERA Cloud

         1. Sleep Timeout:  Enter number of minute where the interface rests between waking up and doing POST and GET functions. If the interface continues to receive messages, then it will not sleep. This field accepts decimals for times smaller than the (1) minute time. Time entered with a dot (.1) will be read as seconds (10 seconds).

            Note:

            When Communication Mode is Server, OXI/PMSInterface endpoint URL will be provided to External Systems to call for get/post messages with OPERA Cloud using Interface Service Account created in Shared Security Domain.

             For more information, see Document 2329730.1 -SSD SYSTEM ADMINISTRATOR - Creating Interface Service Accounts.

4. Click Save.