3 OHC OPI Manager
The OPI Manager comprises multiple tabs: Outstanding Process, Offline Token, Batch Settlement, Cancel Request, Tokenize Existing Credit Cards, Transaction Overview, and Configuration tab.
The following section describes the field definition of each tab and usage in the OPI Manager. The function buttons for each tab vary depending on the tab you access.
Configuration Tab
This section consists of Connection Setup, Parameter, and Schema Mapping between SPMS and OPI.
Figure 3-1 OPI Manager Configuration Tab
Connection
This section describes the Connection Setup.
Table 3-1 Connection Setup
Description | Value |
---|---|
OPI Interface URL |
OPI Interface URL. The format is ws://ip address: |
SPMS Client Port No. |
Uses the same SPMS client Port No. defined in OPI Daemon configuration Tool. |
OPI Daemon Port No. |
Uses the same OPI Daemon Port No. defined in OPI Daemon configuration Tool. |
Workstation No. |
Workstation number of the client. |
Merchant ID |
Payment Provider Merchant ID. |
Refresh
This function refreshes the Setup screen when clicked.
Test Connection
This function tests the successfulness of the connectivity to OPI.
Schema Mapping
The Schema Mapping is located in the left panel of the Configuration tab. This section describes the field mapping, pre-defined conditions, and the constant value between SPMS and OPI schema for different types of requests:
Table 3-2 Field Mapping
Request Type | Description |
---|---|
CancelRequest |
Send a cancel request. |
CcCourtesy |
Request type obtains the Gift Cards details. |
CcCourtesyOperationalSchema |
Request type obtains the Gift Cards details for Redeem and Restore. |
CcUsage |
Request type obtains the Credit Card details. |
CpAuthor |
Request type obtains the Get Initial Authorization and Incremental/ Top Up. |
CpPayOnly |
Request type is use for Direct Sale only. |
CpSettl |
Payment Settlement request. |
UpdateToken |
Request type to exchange offline token to online token. |
Get Token |
Request to exchange non-OPI token to OPI token. |
Each request type has the following table columns:
Table 3-3 Request Type
Column Name | Description |
---|---|
Field Name |
OPI schema field name. |
SPMS Field Name |
SPMS schema field name. |
Condition |
The condition for the data updating / selection. |
Constant Value |
The value to be updated / inserted based on the output from the Condition. |
Enabled |
Enable the field used in request type. |
Mandatory |
Mandatory flag for request type. |
Direction |
Request type flow. (In = response from OPI, Out = request sent to OPI). |
Get/Update Schema from OPI
This function sends a request to obtain the latest schema from OPI and updates the SPMS schema.
Refresh
This function refreshes the Setup screen when clicked.
Allow Offline
This function allows the use of the CPAuthor request type to use the offline tokens.
Outstanding Process Tab
The Outstanding Process tab lists all of the pending initial authorization/incremental records for OPI approval.
Overview
All pending statuses of initial authorization/incremental records appear in the grid consist of the following:
Table 3-4 Authorization/Incremental Records Detail
Column Name | Description |
---|---|
Cabin |
Account cabin number. |
First Name |
Account First Name. |
Last Name |
Account Last Name. |
Embarked |
Account embarkation date. |
Sequence No. |
The sequence number of the record. |
Auth. Amount |
Authorization amount of the record. |
Current Action |
Current action taking of the record. |
Card Expiry |
Account credit card expiry date. |
Silent Mode
Enabling this function allows the process to run in the background. Updated record status does not appear on the screen.
Start
This function triggers the request to process pending initial authorization and incremental records.
Time Out (second)
Defines the response time for the system to flag the outstanding process as a time-out in seconds.
Log Line
This function lists the number of records to appear in the log overview.
Clear Log
This function clears all logs from the log overview.
Hide Statistics
This function hides or shows the statistics panel on the right of the screen.
Offline Token Tab
The Offline Token tab stores the offline transaction token in exchange for an online token once the system is online.
This tab is disabled if PSD2 method is used.
Overview
All offline token records appearing in the grid consist of the following:
Table 3-5 Offline Token Records Details
Column Name | Description |
---|---|
First Name |
Account First Name. |
Last Name |
Account Last Name. |
Sequence No. |
The sequence number of the record. |
Card Status |
Status of the registered credit card. |
Current Action |
Current action taking of the record. |
Card Expiry |
Account credit card expiry date. |
Silent Mode
Enabling this function allows the process to run in the background. Updated record status does not appear on the screen.
Start
This function commences the token exchange from offline to online.
Time Out (second)
Defines the response time for the system to flag the outstanding process as a time-out in seconds.
Log Line
This function lists the number of records to appear in the log overview.
Clear Log
This function clears all logs from the log overview.
Batch Settlement Tab
The Batch Settlement Tab is a placeholder for all unprocessed records. You have an option to process the settlement records by batch or online, depending on the value set in Enable Online Settlement parameter.
If the parameter value is:
0 = The program sends all unprocessed settlement records to OPI in batches if the number of transactions matches the selection criteria. You can preview the records with the Preview button and press the Start button to begin. The process will stop once all records are processed/cleared from the screen.
1 = The program sends all unprocessed settlement records to OPI for immediate approval. Once the Start button is pressed, the program continually checks for unprocessed settlement records until you press the Stop button.
Overview
All pending settlements appearing in the grid consists of the following:
Table 3-6 Pending Settlements Details
Column Name | Description |
---|---|
Cabin |
Account cabin number. |
First Name |
Account First Name. |
Last Name |
Account Last Name. |
Embarked |
Account embarkation date. |
Sequence No. |
The sequence number of the record. |
Settl. Amount |
The settlement amount of the record. |
Current Action |
Current action taking of the record. |
Status |
Status of the record. |
Card Expiry |
Account credit card expiry date. |
Account Type
Filter for the account you wish to process. Option is disabled if parameter value is “1”.
Embark Date
Filter the records by the selected date. Option is disabled if parameter value is “1”
Cabin
Filter the records by the cabin number defined. Option is disabled if parameter value is “1”.
Preview
This function shows the records to process, and the statistic is shown on the right of the grid. Option is disabled if parameter value is “1”.
Page
This function navigates to the next / previous page of the records shown. You can also navigate to a specific page by entering a page number. Option is disabled if parameter value is “1”.
Silent Mode
Enabling this function allows the process to run in the background. Updated record status does not appear on the screen.
Start / Stop
The system only allow you to process the Batch Settlement from one client machine at a time. Records are sent to OPI for approval. Once the Start button is pressed, the button switches to Stop and vice-versa.
Time Out (second)
Defines the response time for the system to flag the outstanding process as a time-out in seconds.
Log Line
This function lists the number of records to appear in the log overview.
Clear Log
This function clears all logs from the log overview.
Hide Statistics
This function hides or shows the statistics by status listed below:
-
Records Approved
Shows the total of records and amount for the approved records.
-
Records Declined
Shows the total of records and amount for the declined records.
-
Records Time Out
Shows the total of records and amount of the timed out records.
-
Pending Outstanding Authorization
Shows the total of records and amount for the pending authorizations records that are not able to process.
Cancel Request Tab
The Cancel Request tab lists all pending statuses of the initial authorization, incremental, and settlement records sent to OPI for approval.
Overview
Table 3-7 Pending Status of Initial Authorization / Incremental / Settlement Records
Column Name | Description |
---|---|
Cabin |
Account cabin number. |
First Name |
Account First Name. |
Last Name |
Account Last Name. |
Embarked |
Account embarkation date. |
Sequence No. |
The sequence number of the record. |
Auth. Amount |
Authorization amount of the record. |
Current Action |
Current action of the record. |
Card Expiry |
Account credit card expiry date. |
Silent Mode
Enabling this function allows the process to run in the background. Updated record do not appear on screen.
Start
This function commences the Cancel request.
Time Out (second)
Defines the response time for the system to flag the outstanding process as a time-out in seconds.
Log Line
This function lists the number of records to appear in the log overview.
Clear Log
This function clears all logs from the log overview.
Hide Statistics
This function hides or shows the statistics of the records.
Tokenize Existing Credit Cards Tab
The Tokenize Existing Credit Cards tab lists all cards and changes the non-OPI token to OPI token. This feature duplicates the current checked-in and future reservations cards before tokenizing the card. Before you perform this step, you must ensure all invoice balances from the previous payment provider is settled. For checked-in reservation, if the credit card has been deactivated after a settlement, the system re-activates the card based on the settlement history.
This tab is disabled if PSD2 method is used.
Overview
All cards appearing in the grid consist of the following:
Table 3-8 Pending Status
Column Name | Description |
---|---|
First Name |
Account First Name. |
Last Name |
Account Last Name. |
Sequence No. |
The sequence number of the record. |
Card Status |
Current card status, inactive. |
Current Action |
Current action of the record. |
Card Expiry |
Account credit card expiry date. |
Start
This function commences the tokenization process.
Time Out (second)
Defines the response time for the system to flag the outstanding process as a time-out in seconds.
Log Line
This function lists the number of records to appear in the log overview.
Clear Log
This function clears all logs from the log overview.
Transactions Overview Tab
The Transactions Overview tab lists all records filtered by the selected Transaction Type, Transaction Status, Transaction Dates, and Account Type(s). The total number of transaction records displayed is based on the value set in the Number of Transaction per batch parameter.
The fields appearing in the Offline Token window are slightly different from the Initial Authorization, Incremental, and Settlement.
Overview
All Transaction Type Offline Tokens appearing in the grid consist of the following:
Table 3-9 Transaction Type Offline Token
Column Name | Description |
---|---|
Sequence No. |
The sequence number of the record. |
First Name |
Account First Name. |
Last Name |
Account Last Name. |
Expire Date |
Account credit card expiry date. |
Card No |
Credit Card No with a masked value. |
Card Status |
Current card status, inactive. |
Reason |
Card Non-Approval Text. |
Transaction Date |
Transaction Date. |
Account Type |
Account Type (Crew, Staff, Guest, Group & System Account). |
Account Type
This function filters the account type you wish to process.
Transaction Type
This function filters the transaction type to process – Offline Token, Initial Authorization, Incremental, and Settlement.
Transaction Status
Flag for the transaction status to process - Time out, Decline or Approved. Single selection.
Transaction Date
Filters the transactions by the selected date.
All Date
Retrieves all the transaction records without filtering the transaction modified date.
Page
This function navigates to the next/previous page of the records. You can use the Page number to go to a specific page.
Filter
This function filters and populates the selected information on the screen when clicked.
Figure 3-2 Transaction Overview
Retry
This function sends a retry request for Initial Authorization with Time Out status for all active cards.