Updated: July 1, 2020 12:08pm

Install Prism HQ Server

This section has information about installing the Prism HQ server. The HQ server has the role of root authority and should be the first server on which Prism is installed. After the HQ server is installed and initialized with data from RIL Oracle, install Prism on POAs or store servers..  
Install Prism at HQ
Run Windows Updates and reboot the machine.
Navigate to the location of the Prism install files on your computer. You either downloaded these from the Retail Pro web site or they were provided by a Retail Pro Business Partner. Double-click the Autorun.exe file. You will see a screen for installing individual Prism components. Depending on your configuration and database type, not all components may be required; therefore each component must be installed separately. A full installation of RP Prism requires an Apache web server, Prism Server, Prism Proxy, and Prism Retail Pro DRS; Document Designer is optional.
Autorun.exe for installing Prism components:
prism components

Prism components

Component Description
Apache RP Prism uses an Apache web server. Install Apache before installing the RP Prism server. From time to time, the version of the Apache web server used by Prism requires upgrading. Before upgrading to the new version, you must uninstall the older version of Apache. When uninstalling Apache, make sure to remove any registry keys associated with the old version.
Prism Server

Two versions of the Prism server are currently available: Oracle and MySQL. The RP Prism server is the data repository used by web clients. You can install the RP Prism server on the same machine as the source RIL Oracle database or a different machine. The instructions in this topic refer to using the Oracle database option for the Prism server. For information about using the MySQL option, click here.

Prism Proxy

The Prism Proxy enables a Prism web client to communicate with printers, cash drawers and other hardware devices that are on a workstation connected to a Prism server. You should always launch RP Prism via the Proxy. You can install one proxy, or multiple proxies. The Multi Proxy allows different web clients to use different hardware configurations when connecting to a workstation with the Proxy installed. Consider a workstation that has a line display and a Genius CED. One web client can be configured to use the line display (e.g. on port 8080); another web client can be configured to use the Genius CED on port 8081.

  • When installing the Proxy on Windows 7, a maximum of 10 proxies can be run.
  • When installing the Proxy on Windows XP, a maximum of three proxies can be run.


The install program checks if you have Visual C++ installed. If not installed, the program will display a prompt to install Visual C++. Click "Yes" to install if prompted.

Retail Pro Prism DRS Install Retail Pro Prism DRS on the machine where RIL Oracle  is installed. You don't have to install Prism DRS on MySQL machines.
Document Designer The Prism Document Designer enables users to edit the default Prism document designs used when printing documents.
Technician's Toolkit The toolkit is installed automatically when you install the Prism server, so most installations won't need to run this installer. This install option enables you to install the toolkit on a Proxy only machine.

Install Apache

On the Autorun.exe menu, click the Apache 2.4.43 button. You can accept the defaults {Note: You will be prompted to enter an admin email address during installation.

Install Prism Server
On the Autorun.exe menu, click the Prism Server button.
On the first screen, click Next >.
prism server install welcome screen

Enter the Fully-Qualified Domain Name (FQDN) or IP Address of the server. Leave the port at 80.
prism server install screen 2

When installing the Prism server, you are prompted to select the type of server to install.
Prism server install

  • Oracle: The default choice is Oracle. This means that you will be initializing Prism using the data on an RIL Oracle database.
  • MySQL: Select the MySQL option if you will be using a MySQL database with this Prism server.

In the Server Name field, enter the FQDN of the server machine. The SSL Port is set to 80. This means that Prism will use HTTP (not HTTPS). (If you have SSL certificates, change the SSL Port to 443 and install the certificates later using the Tech Toolkit SSL Manager.)
The next screen asks if you have a server identity file.
Prism server identify file

A server identify file is a file that saves certain key information needed to reinstall Prism.  Unless this is a reinstall, you can leave the box unchecked and click Next. [Note: You will generate a server identity file later in the install process that can be used if you ever need to reinstall Prism.] Follow the on-screen prompts to complete the rest of the Prism Server install.
Prism server install finish

When the installation nears completion, you are prompted to select a language.
Server install choose language

Next, choose a region for regional settings.
Server install choose region

Click Finish when done. You must restart your computer to complete the installation.
server install finish

Step 3 - Install Prism Proxy
When the Prism Server installation finishes, install the Prism Proxy.
Prism Proxy install

For effective communication between web clients and the Proxy, the Proxy should point at a server on the local network.
proxy install server

After entering the server information, you can accept the defaults, unless you are installing multiple Proxies. If you are installing multiple Proxies, enter the number of proxies you want to run. Click Next.
Number of proxies

Enter a port number for each Proxy. The Proxy runs on port 8080 by default. If you selected to run multiple proxies, a different port number is used by each proxy. By default, the port numbers for multiple proxies are assigned the next sequential port number (e.g. 8081, 8082, 8083). Click Next.
Prism Proxy port

Make sure you select the option to install a desktop icon.  Click Next.
proxy install icon

 

Step 4 (Optional) - Install Prism DRS
If you intend to send data back to RIL, you must install the Retail Pro Prism DRS application.
If you need to send data back to RIL, you must install the Retail Pro Prism DRS application.
DRS install screen 1

Click Install to begin the installation.
drs install screen 2

 

Click Next to continue and follow the on-screen prompts to complete the installation.
drs install finish

Click Finish to complete the install.
DRS install finish

 



Configure Installation Defaults at HQ
 Launch Prism using the Proxy shortcut on the desktop.  (Windows 10 users should use the right-click "Run as administrator" option) Log in using the default sysadmin/sysadmin credentials.Proxy shortcut
Navigate to Admin Console > Installation Defaults. Change the RIL Address to the hostname or IP address of the source RIL Oracle. The Controller Name and RIL Address should not be the same computer name.

Install defaults
 

Connect to RIL Server
Next, navigate to Admin Console > Connection Manager. If you added the RIL Address in Installation Defaults, then you can select the server from the Server Address dropdown. If you didn't add the server in Installation Defaults, you can add it now by clicking the Add \ Edit Local RIL Server Button.

add or edit ril server

Under "Server Address" enter the computer name of the HQ installation (it should match the RIL Address that you entered under Installation Defaults). Click Save.
ril_server_connect

A drop-down menu will appear, and the server you just added should be listed. Select that server then click "Connect". [Note: If the server was previously entered in Installation Defaults, you can select it from the Server Address dropdown.]
Ril connect

The connection between the two servers is established. Additional tabs become available on the RIL Dashboard.
Create Initialization Profile
Click the Profiles tab.
Click the Add button. The Create Profile screen is displayed.
Under "Type" select "RIL to Prism". Name the Profile something to indicate that information will be transferred from HQ to RIL.
Select the specific resources that should be sent from the HQ to the POA during initialization.
Select the Subsidiaries whose data will be sent.
Save the profile.

Prism to RIL Profile

Initialize Prism HQ Server with Data from RIL Oracle
Navigate to Connection Manager > RIL Dashboard > Initializations.  Select the RIL server in the dropdown and click Start Initialization.
Start HQ initialization

You will see a screen that enables you to select the servers to initialize and the profile to use for the initialization. Select the checkbox for the server and select the Profile you created in the dropdown. Click the Start button.
Start HQ initialization screen 2

Failed/Stopped Initializations
Initialization can take a long time for larger databases and can sometimes fail to complete successfully. If an initialization fails or is stopped for whatever reason:
Create a new Sender profile that starts from the resource after the last COMPLETED resource. For example, if the initialization was in the middle of the Inventory resource when the failure occurred, the new Sender profile should include Inventory and the rest of the resources to the bottom of the list. Run initialization again using the new Sender profile.
When you create a new Sender profile and restart, it may take a while to process the first resource (the resource that was being initialized when the failure occurred). This is because the program must do a slower UPDATE operation on each of the resource's records that are already in the tables. Once the program finishes the updates and reaches the unprocessed records for the resource, it switches to the much faster INSERT operation. There currently is no way to restart a failed/stopped initialization from the specific point of failure. The entire resource in which the failure occurred must be sent again.

RIL Dashboard - Initializations tab
On the RIL Dashboards - Initializations tab, you can see initialization information about each of the servers initialized by RIL connections:

  • Number of Sent, Received Failed records
  • The date of the most recent initialization
  • Profile used for initialization
  • Total messages and messages sent
  • Number of servers

Sample RIL Dashboard - Initializations tab:
RIL Dashboard - Initializations tab

Next: Install Prism on POA or Store Server

Factors that Affect Initialization Times

  • CPU Cores and Memory: Minimum of four CPU cores and 8GB of RAM. The more CPU cores and memory available, the better initialization performance will be, especially when used in conjunction with Server Mode.
  • Server Mode: Server mode enables the initialization process to take full advantage of the CPU cores and memory. By default, only half of the CPU cores are used. When using Server Mode, you can use up to N-1 CPU cores, that is, all cores except one. Set the Prism Initialization Receive thread count to four or the number of cores you have allocated if you allocate more than four.
  • Type of Record: Resources such as "COMPANY" are simple and can be communicated quickly, even in large numbers. Other resources, such as customer, are more complex and take longer.
  • Number of Stores: The number of stores is one of the primary factors influencing the time required for initialization. During initialization, each item's quantity and other information must be sent to every store.  As the number of stores increases, the time required for initialization also increases.
  • Number of Defined Preference Settings: The more preference settings in RIL Oracle that are used will also increase initialization times.
  • Using Promotions: If the Promotions Plugin is used, this will lengthen initialization times.
  • First Initialization or Subsequent: The first time you initialize, multiple records are added to the RP Prism tables using a single INSERT statement. The second time you initialize, RP Prism has a record of the first initialization and therefore each record is added using a separate UPDATE statement, increasing initialization times.
  • Log Levels: If log levels are set to 3 (verbose), initialization times will increase.


Create Day-to-Day Replication Profiles
To replicate data back and forth between the Prism HQ server and RIL Oracle database, you need to create a Prism to RIL profile for sending data back to RIL Oracle database. Select the Prism Dashboard > Profiles tab. Click the Add button. In the Type field, select Prism to RIL. Enter a user-friendly Name for the profile.
Select the Resources that you want to send back to RIL. Select the Subsidiaries that will be sent the data.
Save the profile.
Link Profiles to connections
You need to link a profile to the appropriate connection. Go back to the RIL Dashboard > Connections tab. Click the check mark for the RIL connection. When you click the checkmark, you will see an area for linking profiles to the selected connection. Click the blue check box to link a profile to the selected connection. Be sure to link a profile for both directions of the connection.

connection tab, profiles linked

Post Initialization Tasks at Prism HQ
Configure Permissions and Preferences
After initializing the Prism HQ server, you are still logged in as the default sysadmin user. One of your first tasks after installing and initializing Prism should be to configure security permissions, especially for the ADMIN group.
Prism uses a role-based security system in which individual employees are assigned to groups and groups are assigned permissions. Prism includes a set of default groups and you can add your own, if needed. After assigning permissions to groups, log out and then log back in using a valid Prism username/password (e.g. an admin user's account). This ensures that user identity is captured in log files and system records from the very start.
Preferences can be configured at the Corporate, Subsidiary, or Store level. Configure any preferences that you want the Prism HQ server to control.

Multi-Subsidiary Installations
In a multi-subsidiary environment, first install the server that you want to be the "root authority" for the enterprise. For example, first install Sub 1 as a standalone, making it the root authority. After Sub 1 is installed, install the server for other subsidiaries. These other subsidiary servers will point to the root authority as their POA. Typically, all the non-root subsidiary servers will initialize with data from the same RIL Oracle server as the root authority. The individual stores at each subsidiary can point to their own subsidiary server as the POA.

Installation Notes
Install Apache Notes

  • When applying certain configuration changes (e.g. turning on logging), users are required to stop the Apache service and then start it again (aka "bounce" the service). Please note that choosing the "Restart" option is not sufficient. Users must select the "Stop" option, wait for the service to stop, and then select the "Start" option.
  • From time to time, the version of the Apache web server used by Prism requires upgrading. Before upgrading to the new version, you must uninstall the older version of Apache. When uninstalling Apache, make sure to remove any registry keys associated with the old version.

Prism Proxy Notes
The Prism Proxy enables a Prism web client to communicate with printers, cash drawers and other hardware devices that are on a workstation connected to a Prism server. You should always launch RP Prism via the Proxy.
The Multi Proxy allows different web clients to use different hardware configurations when connecting to a workstation with the Proxy installed. Consider a workstation that has a line display and a Genius CED. One web client can be configured to use the line display (e.g. on port 8080); another web client can be configured to use the Genius CED on port 8081. When installing the Proxy on Windows 7, a maximum of 10 proxies can be run.
The Prism Proxy install program checks if you have Visual C++ installed. If not installed, the program will display a prompt to install Visual C++. Click "Yes" to install if prompted.

Retail Pro Prism DRS Notes
Install Retail Pro Prism DRS on the machine where the source RIL Oracle is installed. This may be the same machine as the Prism server or a different machine. The Retail Pro Prism DRS program is used for replicating data between an RIL Oracle database and Prism. If you are using MySQL as the database, don't install Retail Pro Prism DRS.

Document Designer Notes
Prism Document Designer provides retailers with an easy way to modify the default receipt and X/Z-Out reports. For information about using Document Designer, see the Prism Document Designer document.

Next Topic: Install POA or Store Server