The SPMS Application Clients can be installed on any machines that have the full Oracle Client installed, including the Oracle Data Access Components (ODAC) component.
Prerequisites
Ensure that the Microsoft .NET Framework 2 and 3.5 and 4.8 are enabled in Window Features before installing Oracle Full Client and OHC_SPMS_V20.3SETUP.exe.
Oracle 12c Database client with ODAC is installed on the target machine. See topic Oracle Database Client and ODAC Installation.
SPMS 20.3 Installer is downloaded and available in the target machine. See topic SPMS Installation File for download instructions.
SPMS 20.3 Package is downloaded and available in the target machine. See topic SPMS Package File for download instructions.
Ensure that the Windows Regional and Language Settings on the target machine is configured to US/UK and the language setting is set to English. This important to ensure that you get the expected SPMS functionality.
the existing EXE format, or
the new MSI format.
MSI format is a Windows Installer format that uses Microsoft’s Windows Installer service to configure or update installer packages. MSI format is normally the preferred format by Windows users to distribute in enterprise environments.
Install Desktop App Installer in EXE format using the Single Batch File
This is the preferred method to install SPMS Application Client with the EXE format installer. The SPMS Application Client can be installed by running a command and left unattended until it completes the installation. Follow the instructions below to install the SPMS Application Client.
Download both the SPMS Installer. See topic Where to Download to prepare the SPMS 20.3 Application Client Installation Package.
C:\Temp
folder.
Figure 6-1 SPMSClientInstall Folder SPMS Package
Copy the SPMS Installer – OHC_SPMS_V20.3SETUP.exe file to the C:\Temp\SPMSClientInstall\Installers
folder.
Figure 6-2 SPMS_V20.3SETUP in SPMSClientInstall
Note:
You will only need to prepare the SPMS 20.3 Application Client Installation Package once. Once you have the package ready, you can remotely copy the package to any target machine and run the one-step SPMS Application Client installation remotely.
You can start the unattended one-step installation of the SPMS Application Client by navigating to the C:\Temp\SPMSClientInstall\
folder.
Run the InstallSPMSApplications.bat using the Windows Administrative privilege by right-clicking the file and selecting Run as Administrator.
Note:
If you intend to run both the SPMS Application Client Version 7.0 / 7.30, and Version 8.0 / 20.1 / 20.2 / 20.3 or later on the same machine, you must disable the SPMS Version 7.0 / 7.30 FC Updater from running as it will interfere with the auto-registration of the SPMS DLLs in Windows Scheduled Tasks.
To disable SPMS Version 7.0 / 7.30, navigate to the SPMS Installed folder for Version 7.0 / 7.30 and rename the FC Updater.exe file to FC Updater.exe.bak.
After installing the SPMS Application Client, a pair of Windows Scheduled Task is created to handle the SPMS DLLs registration automatically.
Figure 6-3 Created Task in Task Scheduler
Note:
The Windows Scheduled Task, OHC Hospitality Cruise SPMS 7.3 Registration will auto-registers SPMS components for SPMS Version 7.0 / 7.30 and below.
The Windows Scheduled Task, OHC Hospitality Cruise SPMS 8.0 Registration will auto-registers SPMS components for SPMS Version 8.0 / 20.1 /20.2 / 20.3 and above.
Install Desktop App Installer in MSI format using Windows msiexec command
Download both the SPMS Installer. See topic Where to Download to prepare the SPMS 20.3 Application Client Installation Package.
Copy the SPMS Installer — Cruise SPMS Release 20.3 Setup.msi file to the C:\Temp
folder.
Copy the reporting tool Installer - CRRedist2008_x86.msi file to the C:\Temp
folder. When installing SPMS Desktop Application Client using the MSI format, the user must install the reporting tool separately.
Call the msiexec command to install. For command details, see: https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/msiexec
Before SPMS Version 8.0.14, it is only possible to run one version of SPMS and switch to another by manually registering the SPMS DLLs, which require Windows Administrative privilege.
When switching from SPMS Application Client for Version 7.0 / 7.30 to SPMS Application Client Version 8.0 / 20.1 / 20.2 / 20.3, the Windows Scheduled Task triggers the Oracle Hospitality Cruise SPMS 8.0 Registration, thus, registering the required SPMS DLL, automatically using the Windows SYSTEM privilege.
Similarly, when switching from SPMS Application Client Version 8.0 / 20.1 / 20.2 / 20.3 to Version 7.0 / 7.30, the Windows Scheduled Task triggers the Oracle Hospitality Cruise SPMS 7.3 Registration, thereby, automatically registering the required SPMS DLLs also by using the Windows SYSTEM privilege.
Switching to SPMS Application Client version 7.0 / 7.30
Run the FC Launch Panel of SPMS Version 7.0 / 7.30.
Figure 6-4 OHC Applications in Windows Explorer
Once launched, the prompt shown in the Figure below notifies you that the SPMS DLLs registration process will take place. You are to wait for the next message prompt before proceeding to the next step.
Figure 6-5 Auto Registration Notification of SPMS 7.0/7.30
Once the DLL registration completes, a new message prompt as shown in the Figure below appears.
Figure 6-6 Completion of SPMS DLLs version 7.30 Auto Registration
Follow the instructions in the message prompt and relaunch the FC Launch Panel for SPMS Version 7.0 / 7.30.
Note:
If you did not get the message prompts, navigate to the folder C:\tempDLL
and check whether the folder RegisteredSPMSv7_3 exists.
If the folder RegisteredSPMSv7_3 exists, this means that the SPMS DLLs are registered successfully, and you can relaunch the FC Launch Panel for Version 7.0 / 7.30.
Switching to SPMS Application Client version 8.0 / 20.1 / 20.2 / 20.3
Launch the version of OHC Launch Panel you wish to work on from the Oracle Hospitality Cruise folder.
Once the program opens, you will receive a notification prompt that registering the SPMS DLLs will take place. Click OK and wait for the next message prompt before continuing.
You will receive a confirmation prompt once the registration process completes. Click OK to close the message and proceed to relaunch the SPMS application.
Follow the instruction in the message prompt and relaunch the OHC Launch Panel for SPMS Version 8.0 / 20.1 / 20.2 / 20.3
Note:
If you did not get the message prompts, navigate to the folder C:\tempDLL
and check whether the folder RegisteredSPMSv8_0 exists.
If the folder RegisteredSPMSv8_0 exists as shown below, this means the SPMS DLLs are registered successfully and you can relaunch the OHC Launch Panel for Version 8.0 / 20.1 / 20.2 / 20.3.
Figure 6-7 RegisteredSPMSv8_0 Folder
This feature designed to prevents an unscrupulous party from performing a malicious attack on the SPMS application through DLLs replacement. By default, SPMS will allow DLLs from the following:
C:\Windows,
C:\Program Files,
C:\Program Files (x86),
C:\Oracle
Therefore, it is of utmost importance that you ensure the four folders above require Administrator level write access.
Should you intend to have an allowlist path other than the listed four, you should create an allowlist file (path.env) in the SPMS Installed folder – C:\Program Files (x86)\Oracle Hospitality Cruise
.
The format of the allowlist entry path is shown below. Each path is delimited with a semicolon character.
<AllowlistPath1>;<AllowlistPath2>;<AllowlistPathN>
You can refer to the SPMSClientInstall folder in the SPMS Package for a sample path.env file.
It is now possible for SPMS Application Client to easily connect to different SPMS Databases using different Database TNS Names by creating a new Database entry in the local OHCSecurity.par file using a different Database TNS Name from the actual Database TNS Name used in the SPMS Database Server. With this, the SPMS Application Client can connect to the SPMS Database using a TNS Name different from the actual Database TNS Name used in the SPMS Database Server.
Adding New Database TNS to the Local OHCSecurity.par
Using the Windows Administrative privileges, run the command “OHC Tools.exe” /m.
See Figure 4-6.
On the OHC Tools Main screen, click the Create New Connection button to create a new Database entry in the local OHCSecurity.par file using a different Database TNS Name
New Connection: The new DB TNS Name.
Current Connection: Existing DB TNS Name.
Database Password: Current DB Password.
Figure 6-8 SPMS Database TNS Creation Screen
After clicking the Login button, the SPMS User Authorization form appears.
Figure 6-9 SPMS User Authorization Screen
You must authorize using the SPMS Login credential to create a new Database entry to the local OHCSecurity.par file using a different Database TNS Name.
After the process completes, you can now connect to the same SPMS Database using the new Database TNS Name.
Figure 6-10 SPMS Launch Panel Login Screen
For the OHC Updater to automatically download the latest binaries or files on all SPMS Application Client machines, follow the instructions below to upload binaries or files to the SPMS Database.
Navigate to C:\Program Files (x86)\Oracle Hospitality Cruise
folder, launch the Launch Panel and log in using a Bypass Updater, by holding down the ALT Key + clicking the female user icon.
OHC UpdaterWatchdog.exe
OHCSPMSMobile.dll
OHCSPMSUI.dll
OHCWebSockets.dll
CRUFLFC.dll
OHCSPMSData.dll
OHCSPMSBusiness.dll
OHCSPMSUtils.dll
Additionally, on the Launch Panel, Utilities tab, update the Launch Panel, Updater, and UpdaterAgent to the latest program file from the downloaded patch set by right-clicking the program and selecting Properties. Click Update file and then click OK to save.
On the target SPMS Application Client machine, log in to Launch Panel without Bypass Updater to update all the programs.
A program UpdaterWatchdog is added to monitor and ensure the Updater remains active in the Task Manager, enabling the latest program to be downloaded from SPMS Database. If the Standard User cannot connect to the Updater, reinstall the SPMS Application Client
See topic: Install Desktop App Installer in EXE format using the Single Batch File in SPMS Desktop Application Clients Installation Steps.
Set up the OPI Manager. See topic OPI Shipboard Property Management System Installation Guide, Release 20.3 in Oracle Payment Interface 20.3.
Set up the OPI in SPMS. See topic: OPI Handling User Guide in the Oracle Help Center.
Select profile type and reservation to process.
Click the Start button to start the process.
Purge all OPI log files from C:\Users\Public\Documents\Oracle Hospitality Cruise
folder.
SPMS Encryption Key is securely stored in SPMS Secure Server and SPMS Database. The system will prompt a warning if the SPMS Encryption Key is found to have been tampered with and the key becomes invalid. The steps to resolve the invalid key is shown in the Warning prompt.
Figure 6-11 Invalid SPMS Encryption Key Warning
Open the Control Panel and select Programs, Programs and Features.
Select Oracle Hospitality Cruise SPMS from the program listed.
Click Uninstall on the menu bar.
Follow the instructions on the screen.
Troubleshooting
See Common Errors in SPMS Desktop Application Client Installation.