Oracle Hospitality OPERA Cloud ID Document Scanning ... Cloud ID Docum… · Oracle® Hospitality OPERA Cloud. ID Document Scanning Specifications . Version 1.0.1 . February 2018

Oracle® Hospitality OPERA Cloud

ID Document Scanning Specifications Version 1.0.1

February 2018

Copyright © 2016, 2018, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

3

Contents Contents .................................................................................................... 3

Preface ....................................................................................................... 4 Audience .................................................................................................................................. 4 Customer Support ................................................................................................................... 4 Documentation ........................................................................................................................ 4 Revision History ...................................................................................................................... 4

1 Overall Description .............................................................................. 5 A Business Case ....................................................................................................................... 5 Usability / Look & Feel ........................................................................................................... 6 Interfacing Responsibilities for this Effort ........................................................................... 7

2 Driver’s License and Identification Tags ............................................. 9

3 Passport and Visa Tags ....................................................................... 12

4 OPERA Cloud Configuration for Scanning ....................................... 14

5 Process Flow for Scanning ................................................................. 17

4 Preface

Preface This document outlines a technical implementation to allow OPERA Cloud to interface with third-party scanning hardware devices. This document covers communication with scanning devices where IFC8 property interface protocol or IP based integration is not used. The solution is agnostic and interfaces with any external hardware device that implements the required approach outlined. This document outlines a technical implementation that facilitates this requirement.

Audience This document is intended for those developing custom applications that interact with OPERA using OPERA’s ID Document Scanning Web Service operations.

Customer Support To contact Oracle Customer Support, access My Oracle Support at the following URL: https://support.oracle.com When contacting Customer Support, please provide the following: • Product version and program/module name • Functional and technical description of the problem (include business impact) • Detailed step-by-step instructions to re-create • Exact error message received and any associated log files • Screen shots of each step you take

Documentation Oracle Hospitality product documentation is available on the Oracle Help Center at http://docs.oracle.com/en/industries/hospitality/

Revision History Date Description of Change July 2015 • Initial publication December 2016 • Certification specs February 2018 • Update document format

https://support.oracle.com/

http://docs.oracle.com/en/industries/hospitality/

Overall Description 5

1 Overall Description A Business Case

In the functional process of managing Guest Data during the guest stay, it is required by law or important for business reasons to have the ability to scan guest identification artifacts and store this data as part of the profile or reservation record even when the user is not working on a mobile device. (Apps exists for iOS devices to leverage the onboard camera to “scan and scrape” identification data from an artifact and subsequently transfer to the OPERA Cloud application for incorporation via the business process.) As workstations do not have ORACLE supplied apps installed and running as a part of the typical OPERA Cloud instance, it is necessary to design a generic software bridge between the browser application and any third-party software that will enable the use of onboard or integrated hardware to capture images and subsequently identification data.

6 Overall Description

Usability / Look & Feel This image outlines the required map of functional elements:

Overall Description 7

Interfacing Responsibilities for this Effort Oracle responsibilities:

• A list of payload tags has been supplied that will be exchanged in any complete transaction (see chapter 2 & 3).

• Web Service specification for making third-party device or software “Hot” for a pending task. https://<vendorserver>:<port>/scan

• Web Service creation and implementation. o Java Script for local host call incorporated in OPERA apps (Cloud

Version 1.20.5.0 or higher). o Configuration elements for describing Service Name and LocalHost port

(see chapter 4). • Action Link/Button link for this functionality is available in the following areas:

o Located in Manage Profile > select profile > correspondence > Identification (see chapter 5 for process flow).

• Establishment of repository for the returned data and the ability to retrieve data and place it in the user’s screen (as Cloud Version 1.20.5.0 or higher):

o OSB Orchestration to deposit payload to file endpoint (as required). o Response service to deliver payload to the UI (payload encrypted and

stored as is done with attachments). o Exception handling and logging.

• Technical Documentation and Tech Services submission. Third-party responsibilities:

• Required to install and maintain a micro web service running from LocalHost of the PC that is to interface with their external hardware device. This micro web service provides the communication channel that OPERA Cloud requires so it can interact with the third-party’s external hardware/peripheral. All communication and data is expected to conform to standard SSL protocol. The certificate must be used and must be a signed Trusted Cert by the third-party vendor, which reflects the name listed in the URL configured in OPERA Cloud. Self-signed certificates can be supported for these purposes as allowed by the browser installed on the workstation:

o Third-party is responsible for developing a micro web service, which is installed on the client’s workstations and is served via a local host call over HTTPS. The web service operations allow us to control the clients connected device via AJAX calls.

8 Overall Description

o The challenge with this design is to get past both CORS and Mixed Content browser restrictions. To overcome this challenge, the third-party must perform the following. Third-party’s installer is responsible for appending the client’s host file with URL entry that OPERA Cloud can call. Do not simply overwrite the entire file as clients may have custom configurations. This entry should contain the client’s local IP address (typically, 127.0.0.1) and a corresponding Domain name that OPERA Cloud will use to issue requests against the micro web service. The URL name has yet to be decided. The hosts file entry should contain iPv4 and iPv6 entries. Example: # iPv4 Entry 127.0.0.1 YourComanyDomain # iPv6 Entry ::1 YourComanyDomain # iPv6 Entry fe80::1%lo0 YourComanyDomain

o The micro web service should support universal CORS access. This is done by performing the following. The Web Service's response header should contain the following two entries:

("Access-Control-Allow-Origin", "Client’s OPERA Cloud Install Domain").

("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept").

o Testing – A sample installation for certification is required. o A resource must be available to work with the certification team on

certifying the solution. o Third-party must provide technical documentation of their micro web

service operations.

Driver’s License and Identification Tags 9

2 Driver’s License and Identification Tags Driver's License / ID

Key Short Description

Full Description Format Sample Value

IDType ID Type The type of ID used or presented to the front desk.

ID Code

DRV, ID

FirstName First Name The first name of the ID card holder.

Alpha Numeric

MiddleName Middle Name The middle name of the ID card holder.

Alpha Numeric

LastName Last Name The last name of the ID card holder.

Alpha Numeric

Sex Gender Gender of the ID card holder.

1 Letter M , F

BirthDate Date of Birth Date of birth that appears in the identification card.

ISO standard date (YYYY-MM-DD)

2014-10-05

Nationality 2-letter Nationality

The short code for the ID card holder's nationality. This is in a 2-letter format.

2 Letters US

City City The city where the card holder is residing.

Alpha Numeric

Naples

County County The county where the card holder is residing.

Alpha Numeric

Collier

State State The state where the card holder is residing. This should adhere to ISO code.

ISO standard state code

FL

Country Country Code The country where the card holder is residing. This should adhere to ISO code.

ISO standard country code

US

10 Driver’s License and Identification Tags



CountryLong Country full name

The full name of the country where the card holder is residing.

Alpha Numeric

United States of America

PostalCode Postal Code / Zip Code

The zip/postal code where the card holder is residing.

Numeric 34105

ExpirationDate Expiry Date The expiration date of the identification card.


10/5/2014

Address1 Address first line

The address of the ID card holder.

Alpha Numeric

Address2 Address second line

Additional line for the address if needed.

Alpha Numeric

Address3 Address third line


Alpha Numeric

LicenseNumber LicenseNumber The license number of the ID card holder.

Alpha Numeric

PersonalNumber Local ID Number

The local ID number of the ID card holder.

Country Specific Number

IssueDate Date of Issuance The date where the identification card is issued. This should adhere to ISO standard.


10/5/2014

PlaceOfIssue Place of Issue The place where the identification card is issued.

Alpha Numeric

PlaceOfBirth Place of Birth The place where the ID card holder is born.

Alpha Numeric

Image Full Image The full image of ID card.

Base64

FaceImage Face Image The face image that appears in the ID card.

Base64

Driver’s License and Identification Tags 11



SignImage Signature Image The signature image of the ID card holder.

Base64

12 Passport and Visa Tags

3 Passport and Visa Tags Passport/Visa



IDType ID Type The type of ID used or presented to the front desk.

ID Code PASS, VISA

PassportNumber Passport Number

The passport number of the document/ID holder.

Alpha Numeric

FirstName First Name The first name of the document/ID holder.

Alpha Numeric

MiddleName Middle Name The middle name of the document/ID holder.

Alpha Numeric

LastName Last Name The last name of the document/ID holder.

Alpha Numeric

Sex Gender Gender of the document/ID holder.

1 Letter M , F

BirthDate Date of Birth Date of birth that appears in the document.


10/5/2014

PlaceOfBirth Place of Birth The place where the document/ID holder is born.

Alpha Numeric

Dhaka

Nationality 2-letter Nationality

The short code for the document/ID holder's nationality. This is in a 2-letter format.

2 Letters BD

NationalityLong Nationality full name

The full name of the document/ID holder's nationality.

Alpha Numeric

Bangladeshi

Passport and Visa Tags 13



Country Country Code The country where the document/ID holder is residing. This should adhere to ISO code.

ISO standard country code

BD

CountryLong Country full name

The full name of the country where the document/ID holder is residing.

Alpha Numeric

Bangladesh

ExpirationDate Expiry Date The expiration date of the document/ID.


10/5/2014

Address1 Address first line

The address of the document/ID holder.

Alpha Numeric

Address2 Address second line


Alpha Numeric

Address3 Address third line


Alpha Numeric

IssueDate Date of Issuance The date where the document/ID is issued. This should adhere to ISO standard.


10/5/2014

Image Full Image The full image of document/ID.

Base64

FaceImage Face Image The face image that appears in the document/ID.

Base64

SignImage Signature Image The signature image of the document/ID holder.

Base64

PersonalNumber Local ID Number

The local ID number of the document/ID holder.

Country Specific Number

14 OPERA Cloud Configuration for Scanning


Create Local Host Entry for the Micro Service 1. Add <vendorserver> record to the list of localhost entries in the workstation Host file if

not added in associated vendor setup. OPERA Cloud Configuration Items 2. Turn on License code to enable ID scan capabilities:

Note that License is an add-on under the OPERA PMS (OP*_500) Product Code. 3. Turn on the ability to scan documents into OPERA Cloud (Desktop Document

Scanning):

OPERA Cloud Configuration for Scanning 15

4. Add the appropriate tasks to configure and scan in the appropriate roles for the users in the system:

5. Configure the document scanner URLs and ports. Property Interface Setup >

Document Scanner > Select Vendor:


6. Add and configure for third-party scanner:

7. Once the configuration is saved, follow the instruction for setting up the third-party

scanner on the test workstation.

Process Flow for Scanning 17

5 Process Flow for Scanning 1. Navigate to the desired profile, edit and select the correspondence jump >

identification tab, and then select the scan link:

After the scan link is selected, the application initiates the scan process and returns the artifacts collected by the interfaced devices:

Documents

Oracle Hospitality OPERA Cloud ID Document Scanning ... Cloud ID Docum… · Oracle® Hospitality OPERA Cloud. ID Document Scanning Specifications . Version 1.0.1 . February 2018