1. Border Control Installation and User Guide
  2. Installing Cruise Property Management Border Control REST API/Web Application Server
  3. Cruise Property Management Border Control

2 Cruise Property Management Border Control

You can perform a custom installation or a typical installation. A custom installation allows you to exclude the products that you do not need. If you choose to perform a typical installation, you can still remove/disable the features that you do not need post installation.

The installation requires the user performing the installation to have an Administrator privilege.

To successfully install the Border Control application, you would need to run the below tasks:

  1. Cruise Property Management Border Control 23.1.0 or later.

  2. CruiseBorderControlDBUpdater_23.1.0.0.exe or later – to apply the latest Developer Express.

  3. OHC Border Control Database Updater_23.1.0.exe or later – to distribute scripts and update database fields required by the application.

Installing Cruise Property Management Border Control 23.1x

  1. Log in as a Microsoft Windows Administrative user.

  2. Start the installation program by right-clicking the CruiseBorderControl_23.1.x.exe and select Run as Administrator.

    Figure 2-1 Cruise Property Management Border Control Installation Page

    This figure shows the Installation Page for Cruise Border Control

  3. Click Next and navigate to the “Choose Install Folder”. The default folder is “C:\”.

    If you choose to install it in a different folder from the default, make sure you grant users the full folder permission so that the user can start the APIs or Apps.

  4. To grant the folder permission,

    1. Access the Properties dialog box

    2. Select the Security tab

    3. Click Edit

    4. In the Group or user name section, select the user(s) you wish to set permissions for

    5. In the Permissions section, use the checkboxes to select the right permission level

    6. Click Apply

    7. Click OK

  5. Click Next and navigate to “Choose Install Set” and if you choose,

    • Typical, most common application will be installed. This option is recommended for most users

    • Custom, you can customize the features to be installed as either WebApp or API or both to install based on the requirement

  6. Click Next to input the below fields:

    • Database connection String: <DBMachineName>:<DBPort>/<SID>

    • Database User: Database User

    • Database Password: Database Password

    • Database Keystore: DB Keystore’s password for database encryption. Minimum password length is 14 characters

    • API Hostname: API Server’s Hostname

    • API Port: API Server’s port number

    • Allow specific App Servers: Check to enable input of server machines with APP installed that are allowed to access the API. Uncheck if it apply to all servers

    • SSL Keystore File Path: Keystore file path which contain .JKS file extension

    • SSL Keystore Password: Keystore password

    • SSL Keystore Alias: Private key/Alias used to generate the keystore

    Figure 2-2 Cruise Property Management Border Control API Settings


    This figure shows the Cruise Property Management Border Control API Settings

  7. Click Next to input the OAuth Configuration settings’ fields.

    • OAuth Public Key File: OAuth public key file in .json file extension

    • OAuth Private Key File: OAuth private key file in .json file extension

  8. Click Next to input the “Web Application” port.

    • WebApp Port: Single instance of Border Control WebApp is supported. User need to choose an unused port for the installation

    • API Gateway: By default, it is based on the API Hostname and port number defined in previous step. However, if the API is located at another server, user need to define the installed API server name

    • Keystore File Path: If user has separate API server, then keystore file path has to be provided

    • Keystore Password: Keystore file path for the API Gateway if it is different from the default API Server

  9. Click Next for Pre-Installation Summary and verify that it is the desired set up.

  10. Click Install to begin installation.

    Note:

    For a better end user experience, at the end of the installation a installer.properties file containing all the configurations, encryption of passwords is created and added to folder where Border Control InstallAnywhere is placed.

    The installer.properties file’s content will be cleared once the InstallAnywhere application is triggered. If you would like to maintain the same configurations or information, please backup this file.

  11. API’s configuration is stored in the application.properties file of the installed folder.

  12. At the end of the installation, the system creates two (2) new Windows Services; namely Oracle Hospitality Cruise Property Management Border Control WebApp and Oracle Hospitality Cruise Property Management Border Control API.

    Figure 2-3 Cruise Property Management Border Control Window Services


    This figure shows the Cruise Property Management Border Control Window Services

  13. The system will create a folder Oracle Hospitality Cruise\ Border Control\v23.1 under the directory if it does not exist, and one or two (2) sub-folders - ‘API’, and/or ‘WebApp’, depending on the installation type.

Uninstalling / Modifying Cruise Property Management Border Control 23.1x

Any modification or uninstallation are perform through Windows Control Panel in a Maintenance mode. This would allow user to select the options to perform like add features, remove, or uninstall the product.

  1. Start the installation program by right-clicking the CruiseBorderControl 23.1.x.exe and select Run as Administrator.

  2. If you have already installed the application, the Setup starts in Maintenance mode, allowing you to reinstall.

    • Add features: InstallAnywhere will guide you through adding features to the installed set. By default, WebApp and API will be disabled if already installed

    • Remove features: InstallAnywhere will guide you through removing features of the installed product. You can uncheck the product features (WebApp / API) that need to uninstall. Checked features will remain installed

    • Uninstall Product: InstallAnywhere will remove all the features that were installed during product installation including files, folders and windows services.

Cruise Property Management Border Control Database Updater 23.1.0 or later

The CruiseBorderControlDBUpdater_23.1.0.exe installshield creates a folder that distributes the necessary DLLs and the OHC BC Database Updater, which allow you to update the database required by Border Control.

The installation requires the user performing the installation to have Administrator privilege.

Pre-requisites

  1. Microsoft .NET Framework 2.0, 3.5, and 4.8 features are enabled on the target machine.

  2. Oracle 19c Database client with ODAC is installed on the target machine. See topic Oracle Database Client and ODAC Installation in the SPMS Installation Guide.

Installing Cruise Property Management Border Control Database Updater

  1. Log in as a Microsoft Windows Administrative user.

  2. Start the installation program by right-clicking the CruiseBorderControlDBUpdater_23.1.0.0.exe and select Run as Administrator.

  3. Click Next and navigate to the “Custom Setup” window. The default installation folder is C:\Oracle Hospitality Cruise\

    If you choose to install it to a different folder, make sure you grant users the full folder permission so that the user can start the Database Updater.

  4. Click Next and navigate to the “Ready to Install” window.

  5. Click Install to begin installation.

Uninstalling Cruise Property Management Border Control Database Updater

  1. Start the installation program by right-clicking the CruiseBorderControlDBUpdater_23.1.0.0.exe and select Run as Administrator. If an updater version already exist, the Setup starts in Maintenance mode, allowing you to remove or reinstall.

  2. Select the uninstall option and wait until uninstall is complete. In the case of reinstall, follow the prompts presented to uninstall and install.

OHC Border Control Database Updater

To complete the installation, you will need to run OHC Border Control Database Updater to update the database to latest Border Control requirements.

  1. Run the Windows Explorer program and navigate to the \Oracle Hospitality Cruise\Border Control DB Updater\v23.1.

  2. Double-click the OHC Border Control Database Updater.exe to launch the program.

  3. At the Welcome screen, click the Next button to navigate to the next screen.

  4. On the Database Connection screen, enter the SPMS Database TNS name and Database Schema Password.

  5. If the Database TNS name or Database Schema password is incorrect, you will receive an error message. Correct the information and retry.

  6. To validate the Database connection, click the Test Connection button.

  7. Click the Next button to proceed to the Options screen and select the mode to run.

    • Standard: Updates the Database with the required changes

    • Simulation: Checks and generate a list of changes applicable to this version, but it will not run the update on the database

  8. Click the Next button to confirm and proceed with the install.

  9. Click Next to start the process.

  10. The progress of the update is shown in the Status screen. When the update completes, click the Next button to continue.

  11. Once the database update completes, you will find a process log is saved in the Public Document folder “C:\Users\Public\Document\Oracle Hospitality Cruise”. Alternatively, you can click the Copy to Clipboard button to save the file.

  12. Click the Finish button to exit the Database Installer.

Applying Patch and Updates

To apply the latest patch, you would need to run the below executable.

  1. CruiseBorderControlPatch_23.1.1.0.

  2. CruiseBorderControlDBUpdater_23.1.1.0

  3. OHC Border Control Database Updater

Cruise Property Management Border Control Patch 23.1.x

This CruiseBorderControlPatch_23.1.x.x.exe Patch Upgrade Setup distributes the latest WebApp and API application files required by the Oracle Hospitality Cruise Property Management Border Control 23.1.x.x. You must have an administrative privilege to be able to perform this task.

Note:

If you already have a version installed, and you are applying a patch, you can copy over the existing installer.properties files from installer folder the same directory as the installer you're running. This allows the installer to pre-populate the configuration with any previously set values. If you are installing the version for the first time, you can skip this step.

  1. Start the installation program by right-clicking the patch installer Cruise Property Management Border Control 23.1.x.x.exe and select Run as Administrator.

  2. If Cruise Property Management Border Control 23.1.x is already installed and the existing DB Keystore password does not meet the password criteria of 14 characters, a prompt will appear requesting you to enter a new DB Keystore password of 14 characters or more. You will also need to enter the Database Password as a form of validation that you are patching the correct database.

  3. The installer will display an “Upgrade” button; upon clicking it, a prompt will appear stating, “Uninstalling older version: Oracle Hospitality Cruise Property Management Border Control 23.1.x”
    Figure shows the Pre-Installation Summary

  4. Once the uninstallation is successful, the patch upgrade will begin.

  5. At the end of the installation, the patch upgrade will supersede any previous patch with the version you are applying. Re-running the patch will brings you to Maintenance mode.

  6. If Cruise Property Management Border Control 23.1.x doesn't already exist, the installer would typically proceed with a standard installation process. See Installing Cruise Property Management Border Control 23.1x.

Cruise Property Management Border Control Database Updater Patch 23.1.x

The process flow remains the same for Cruise Property Management Border Control Database Updater Patch 23.1.x, as depicted in topic Cruise Property Management Border Control Database Updater 23.1.x. Any new scripts introduced in the patch will be applied during the update.

OHC Border Control Database Updater Patch 23.1.x

The OHC Border Control Database Updater updates the database user with the latest database scripts, fixes and functionality. You should have a valid database credentials to run the OHC Border Control Database Updater.