Updated: January 9, 2024 1:11pm

Getting Started with Prism

1.14.7 Getting Started Guide PDF

2.2 Getting Started Guide PDF

This Getting Started Guide has instructions for upgrading to/installing Prism 2.x and changing basic configuration settings. If you need information about installing Prism 1.14.7 or earlier versions, download the PDF file linked above.
This topic is divided into the following sections:

  • Prism 2.x notes and installation best practices
  • Installing Prism "over-the-top" of 1.14.x
  • Installing a blank Oracle DB and new Prism 2.x
  • Joining a server to the enterprise
  • Initializing a server
  • Post-Upgrade/Install information about configuring preferences, security, and day-to-day replication of data between servers.
  • Silent install via command line (e.g., via scheduled task)
  • Upgrading to Prism 2.x from legacy versions of Retail Pro

EFT Configuration
A separate document is available for each EFT processor that Prism supports. Refer to the appropriate document for your EFT processor: Prism and Adyen, Prism and BS Payone, or Prism and Global Payments).

Prism 2.x - Notes
Prism 2.x is standalone
All data required to run Prism is maintained and managed within the core functionality of Prism 2.x. This includes managing inventory cost, price, and quantity, all document types, customer details, and preferences, and any other data which is required for operation within Prism.
Prism 2.x does not natively communicate with legacy Retail Pro apps
The Connection Manager in Prism 2.x does not support native connections between Retail Pro 9 and Retail Pro RIL. Data can only be communicated using Connection Manager profiles established between two Prism installations or a Prism installation and a "custom" profile connection. Where data is being brought into Prism via custom profile that data must be put in a format which is recognized as valid for processing by Prism. This is especially important for a Prism installation that relies on integrations, plugins, or ancillary products that leverage a connection directly to Retail Pro 9 or RIL. Prism 2.x will not work with integrations, plugins, or ancillary products which are developed to work specifically with the Retail Pro 9 or RIL API. Those integrations, plugins, and ancillary products must be migrated to utilize the Prism API and communicate directly with Prism, without the need for Retail Pro 9 or RIL, if they are expected to be used within a Prism 2.x environment.
Prism 2.x is not compatible with previous versions of Prism.
All versions of Prism prior to Prism 2.x leveraged legacy versions of Retail Pro to facilitate the management of some data required for general operations within Retail Pro. The Prism 2.x release will be standalone and will be responsible for management of all data within the Prism application and database. As such, Prism 2.x will expect to communicate with other Prism systems that "understand" it is the point of authority for all data within Prism. Simply put Prism 2.x is not being developed to work with versions of Prism prior to Prism 2.x, nor will it be tested in these mixed environments.
About Prism and the Enterprise Hierarchy
When installing Prism, it is important to install the servers from the top down, starting with the Root Authority server for the enterprise.
Every Prism enterprise has a single "HQ" system that serves as root authority for the company's servers. Install Prism on this system first. After Prism has been installed on the root authority system and initialized, proceed to install Prism on other servers. There can be an intermediate layer of Point of Authority (POA) servers between the HQ and store servers. Each server (except the Root Authority) must join the enterprise via a Tech Toolkit process. When joining a server to the enterprise, you must identify the server's POA. The POA is the upstream server in charge of enterprise data from the downstream server's point of view. When enterprise data is created/edited at the store level, it is communicated up the enterprise chain to the top, enforcing the synchronization of data throughout the enterprise. Changes made at the HQ flow downstream to POA and store servers. The profiles used for data replication determine which data is sent in each direction. For example, the 5. only data that typically needs to flow upstream from stores are transactions, Z-Out reports, customers and perhaps a few other data types.
•    POA and store servers are initialized with data from the HQ  via Prism-to-Prism initialization•   

Prism 2.0 hierarchy
 
 Enterprise Structure Rules and Best Practices:

  • To access or edit a node, the server must be up and running
  • Install Prism servers from the top down. Install the Prism HQ (root authority) first and initialize. The Root Authority cannot select a POA
  • Install the first tier of POA servers after the root is initialized
  • Any node other than the root authority can leave an enterprise
  • A superior node can eject a subordinate node that is offline
  • Nodes can modify the controller data for themselves and any subordinate nodes
  • To push data out from a server, you must create a profile and assign it to a connection
  • At Root Authority (Prism HQ) create a separate profile for each subsidiary to prevent each subsidiary from getting overwhelmed with data from other subsidiaries (if data is not needed)

Limitations
The following prerequisites exist for machines that will participate in a Prism enterprise.

  • Must have online connectivity to the POA to manage enterprise data or use enterprise features
  • User doing the setup must know the Public/Private addressing information for servers
  • A Prism server can initialize a server on a different version; however, some data may not replicate in such a scenario. Each release of Prism typically adds new resources. During the interim a server is on an older version, the server will not be able to send or receive data for any new resources. Once the servers are on the same updated version, data that did not replicate will replicate and the systems will "catch up" with each other.

Enterprise Structure Rules and Best Practices:

  • To access or edit a node, the server must be up and running
  • Install Prism servers from the top down. Install the Prism HQ (root authority) first and initialize. The Root Authority cannot select a POA
  • Install the first tier of POA servers after the root is initialized
  • Any node other than the root authority can leave an enterprise
  • A superior node can eject a subordinate node that is offline
  • Nodes can modify the controller data for themselves and any subordinate nodes
  • To push data out from a server, you must create a profile and assign it to a connection
  • At Root Authority (Prism HQ) create a separate profile for each subsidiary to prevent each subsidiary from getting overwhelmed with data from other subsidiaries (if data is not needed)

Replication Best Practices

  • For initialization, make sure the machine has an adequate number of CPU cores and amount of RAM. Enable Server Mode, if needed, for initialization.
  • Install Prism servers from the top down. Install the Prism HQ (root authority) first and initialize, then install child POAs. After that, install store servers and join them to the child POA. Do not first join store servers to a POA and then join that POA to the Prism HQ. Store servers lack the necessary controller information. Instead, unjoin the servers, join the POA to the Prism HQ and then join the store servers to the now-child POA.
  • Install the first tier of POA servers after the root is initialized
  • Edit the default company name and Controller No in Tech Toolkit BEFORE you install store servers
  • To access or edit a node, the server must be up and running
  • To push data out from a server, you must create a profile and assign it to a connection
  • Nodes can modify the controller data for themselves and subordinate nodes
  • Any node other than the root authority can leave an enterprise; a superior node can eject a subordinate node that is offline
  • Use caution when leaving/rejoining the enterprise. If a server leaves and then later rejoins the enterprise, the server must rejoin in the same position as before.  The Prism controller hierarchy can be disrupted by servers leaving and then rejoining the enterprise in a different position. Therefore, carefully consider the desired server hierarchy before installing servers.

Limitations
The following prerequisites exist for machines that will participate in a Prism enterprise.

  • Must have licensing for Prism 2.x and Software Assurance (SA) must be current
  • Must have online connectivity to the POA to manage enterprise data or use enterprise features
  • User doing the setup must know the Public/Private addressing information for servers

About Prism 2.x Licensing
Prism 2.x is a licensed product. During installation of Prism 2.x, users are required to enter a valid Client ID and License Key (Software Assurance (SA) code). This means that the client must purchase Prism licensing and SA must be current.

Essential Windows Configuration Steps for a Smooth Prism Installation
1. Log in using the Local Administrator account in the operating system.
2. Ensure Windows 10 or 11 Pro is installed; Home edition is not supported.
3. Clear the %TEMP% folder.
4. Disable Firewall.
5. Disable User Account Control (UAC) and restart the system.
6. Disable or create exceptions for your Antivirus or Windows Defender.
7. Disable Smart App Control.
8. Disable Reputation-based protection.
9. Under Exploit protection, disable the following options:
10. Control Flow Guard: Turn Off
11. Data Execution Prevention (DEP): Turn Off.
12. Apply all pending Windows updates.

Install Prism 2.x "over-the-top" of 1.14.x
This section has information about installing Prism 2.x "over-the-top" of an existing 1.14.7, 1.14.6, or 1.14.5 server. Care is required because Prism 2.x marks a significant departure from previous versions of Prism (1.14.7 and earlier) which rely on RIL or RP 9 for Inventory management. These steps are designed to protect the customer's data and ensure the conversion is completed in as timely a manner as possible.

Each of the following basic steps is explained in more detail in the sections that follow:
1.    Resolve outstanding data (refer to the table that follows).
2.    Make a full backup of the database using RIL Tech Toolkit.
3.    Install Prism 2.x.
4.    Enable/disable new features, permissions, and resources in 2.x.
Proxy Shutdown Required if Plugins Communicate Directly with Database
When installing Prism 2.x "over-the-top":

  • If the Prism Server has any plugins that communicate directly with the Prism database, close (exit) the Proxy.
  • If the Prism Server has plugins but those plugins connect to the database via a REST API, there is no need to close the Proxy.

Resolve Outstanding Data
Before installing Prism 2.x, resolve the following data:

Requirement Notes
Empty RabbitMQ queues Make sure RabbitMQ queues are empty. Any remaining messages in the queue could be lost or not compatible with the upgraded system.

Back-up the Database
After the checklist has been completed, make a full backup of the Oracle RPROODS database using the TechToolkit.exe at the RIL.

Remove Profiles and Connections to RIL
Navigate to Admin Console > Connection Manager > RIL Dashboard > Connections.
Unlink any profiles for the server's connection to RIL.
Navigate to the Profiles tab. Delete the profiles.
Go back to the Connections tab. Select the connection and click Disconnect. This removes the connection.
 Log out of Prism.
Exit the Proxy. To exit, right-click the Proxy icon in the taskbar and select Exit on the right-click menu.

Uninstall DRS
Use the Windows Add or Remove Programs feature (or your preferred tool) to uninstall DRS.

Install Prism 2.x (New Install)
The Prism 2.x installation comes with an embedded Oracle database that is exclusively for the use of Retail Pro Prism. Prism 2.x also supports the MySQL database option (same as previous versions of Prism). Other database storage types, including Microsoft SQL Server are not currently supported. A common practice is to use an Oracle database at the RA due to Oracle being more performative with larger data sets; however, a Prism 2.x MySQL database being used on a RA machine is supported.
Prism 2.x cannot be initialized from legacy versions of Retail Pro (RP9, RIL, RP8), which is different from previous versions of Prism. Initializing Prism 2.x must be done using a Connection Manager Initialization profile from another Prism 2.x system.

System and Hard Disk Requirements
For current system and hard disk requirements, see the System Requirements topic.

Install Oracle Database
The Prism Oracle database files are available in two versions: Enterprise and Standard. Whichever version of the Oracle database you download, drill down and copy the "DB" folder to the "/Unpacked" folder of the Prism installation files.
With the "DB" folder within the "Unpacked" folder, launch the Autorun.exe for the Prism installation files. The Autorun.exe user interface now includes an option for installing Oracle. The Oracle option will be missing if the "DB" folder is missing or is in the wrong location.
 autorun menu with oracle option
Click the Prism Oracle Database button.
The Oracle installer launches.
Select "I accept the agreement" to accept the end user license agreement. Click Next >.
Accept EULA Oracle install 
Next, the default installation drive and disk space settings are displayed. Click Next >.
oracle memory 
Click Install to proceed with the installation of Oracle.
 oracle start install
A message is displayed when the process is finished. Click OK. Restart the computer to finish the process.
Click Install to proceed with the installation of Oracle.  A message is displayed when the process is finished.
oracle install complete message
Click OK. Restart the computer to finish the process. Select the radio button "Yes, restart the computer now" and then click Finish. After the computer restarts, navigate to the location of the downloaded installation files. The Oracle database files are installed by default to the root C:\ and C:\Program Files (x86) folders.
Install Prism Components
After installing the Prism Oracle database and restarting the computer, install the other Prism components in the order listed.

Component Description
Apache RP Prism uses an Apache web server. Install Apache before installing the RP Prism server.
Prism Server The RP Prism server is the data repository used by web clients. If you installed the Prism Oracle database, be sure to install the Prism Server for Oracle.
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 desktop shortcut.
Prism Document Designer  (optional) The Prism Document Designer enables users to edit the default Prism document designs (e.g., receipt designs) used when printing documents.

Basic Steps
1.    Install the Prism components.
2.    Launch the Prism Proxy using the desktop shortcut and log in using sysadmin/sysadmin credentials. Configure the following:

  • Admin Console > Installation Defaults: Edit the Controller Name and Controller Number and save the changes.
  • Join the server to the enterprise in TTK.
  • Admin Console > Connection Manager > Prism Dashboard > Profiles: Create a Prism-to-Prism initialization profile.
  • Admin Console > Connection Manager > Prism Dashboard > Initializations: Initialize the Prism server using the created profile.
  • Admin Console > Connection Manager > Prism Dashboard > Connections: Select the connection to the server's POA. Link the Profile to the connection.

3.    Log out and log back in using your Prism username and password.
4.    Configure any Prism preferences and permissions that you want to propagate to the POAs or Store servers that will subsequently be installed.
5.    Install subordinate servers in a similar manner. Each subsequent server that is installed must be joined to the enterprise via Tech Toolkit.
Pre-Installation Checklist
Before installing and initializing a Prism server:

  • Make sure the server machine has adequate number of CPU Cores and Memory (minimum 2 CPU cores and 4GB or RAM). The more CPU cores and memory available, the faster initialization will complete.
  • Run Windows Updates and reboot the machine.

Install Apache
On the Autorun.exe menu, click Apache 2.4.43. The Installer will first check to make sure that you have the required Visual C++ runtime library. Click Yes to install the runtime library. After the required Visual C++ runtime library is installed, the installer's Welcome screen is displayed.
Apache installer welcome screen
On the Welcome screen, click Next >.  The Apache License Agreement is displayed.
Apache install license agreement
On the License Agreement screen, select I accept the agreement. Click Next >.
You must enter an email address during the install.
Apache install email address entry
Click Next >. The Ready to Install screen is displayed.
Apache installer, start install
Click Install.
When the install is complete, click Finish.
Apache installer finish screen
Install Prism Server
The Prism Server can be installed using either Oracle or MySQL for the database.
For both Oracle and MySQL, the installer will make sure Apache is installed.
On the Autorun.exe menu, click the Prism Server button.
Prism server install start

Click Next >. 
Prism 2.x is a licensed product. During installation of Prism 2.x, users are required to enter a valid Client ID and License Key (Software Assurance (SA) code). This means that the client must purchase Prism licensing and SA must be current. During the Prism Server installation, after the user clicks "I accept the agreement" and clicks the Next > button, the Prism License Check will begin. Enter the Client ID and License Key (SA Code) and click Validate.
license check

The Server Location screen is displayed. In the Server Name field, enter a FQDN for 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.)

Prism server install, License Agreement screen
 
Click Next >. The Server Database Connection screen is displayed.
When installing the Prism server, you are prompted to select the type of server to install.
Oracle: The default choice is Oracle .
MySQL: Select the MySQL option if you will be using a MySQL database with this Prism server. (Refer to the Prism MySQL Guide document for instructions.)
 
Prism server install, ssl check

Click Next>. The Server Identity File screen is displayed.
This checkbox is used when the machine previously had Prism installed and you need to install Prism again. In that case, you need to select the checkbox and navigate to the server identity file. Unless the install you are doing fits into that situation, you can leave the box unchecked and click Next >.
Prism server install, Server identity file check

The next screen asks if you have the Erlang programming language installed. The RabbitMQ messaging software that Prism uses is coded in Erlang; therefore Prism requires Erlang to be installed. Select the "No" radio button and click Next >.
Prism server install, Erlang check
Prism uses the RabbitMQ messaging software. The next screen asks if you have RabbitMQ installed. Click No and then click Next.
Prism server install RabbitMQ check

Confirm the install folder for the RabbitMQ database. Click Next.
Prism server install confirm settings screen
Click Install to start the install process. (If you want to double-check the settings, you can click the < Back button to go back and review.)  The Prism server takes a few minutes to install.
Prism server install, start installation screen
As you near the end of the installation, you are first prompted to select a default language.
 After selecting a language, click Next >.
Prism server install select language screen
You are next prompted to select the Regional Settings. This determines things like how dates and large numbers are displayed.
Prism server install regional setting screen
 Click Finish when done.
Prism server install finish

Install Prism Proxy
Click the Prism Proxy button on the Autorun.exe menu. 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.
The Welcome screen is displayed.
Prism Proxy install welcome screen
Click Next >.
 The Server Location screen is displayed. 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.)
Prism Proxy install screen two
Click Next >.
Enter the number of proxies that the workstation will use. (Note: Each Proxy will need to be assigned to a separate port on the following screen).
Prism Proxy install, enter number of proxies
Assign a different port to each proxy. Default = 8080.
Prism Proxy install, enter proxy port numbers
Select "Create a desktop icon." This will place an icon on the desktop that you can use to launch Prism. If you forget to create the desktop icon or don't want it, you can always launch Prism from the C:\Program Files (x86\RetailPro\PrismProxy folder.
Prism Proxy, install desktop shortcut
Click Install.
Prism Proxy install, start installation
Click Finish when the installation is complete.
Prism Proxy install, finish screen

Start RP Prism
The first time you start Prism after installing, log in using the default sysadmin/sysadmin username/password combination. Use these default credentials to configure Installation Defaults and initialize the server. After initialization, clear the browser cache, enable permissions for groups, log out and then log back in using your username/password. Always launch Prism using the Proxy shortcut (if installed). Windows 10 users must use the right-click "Run as Administrator" option.
Prism Proxy desktop shortcut
Prism launches using the default browser and connects via the Port entered during installation of the Proxy. 
 Prism login dialog
Enter your username and password. Click the Login button. The first time you start Prism after installing, log in using the default sysadmin/sysadmin username/password combination. Use these default credentials to initialize. After initialization, clear the browser cache, enable permissions for groups, log out and then log back in using your regular Retail Pro username/password.
Click the Retail Pro button (lower-right corner) and select the desired area from the Prism Menu.   
Exit Prism (Logout)
1.    Touch or click the Retail Pro button (lower-right corner).    
2.    Touch or click the Logout button.    

Change Sysadmin Password
Security best practices call for changing the default "sysadmin" password at the earliest opportunity.
If one logs in as sysadmin, they will be able to change the sysadmin password.

Join Server to Enterprise
All servers other than the root authority (HQ) server must go through the Join-the-Enterprise process. Joining the Enterprise adds the server as a new node to an enterprise hierarchy. The user doing the configuration must know the IP address or FQDN of the server being added and the machines must  have online connectivity.
Configure Installation Defaults
After installing Prism and logging in, navigate to Admin Console > Installation Defaults. The Installation Defaults area is a separate area of the Admin Console where users can enter the Controller Name, Default Subsidiary and Store and the POA server for this Prism server. A default Controller Name of "RPS" is assigned. If this is the first Prism server being installed, the Ctrl No (Controller Number) will be set to "1." The Ctrl No must be unique within the enterprise and is incremented for each subsequent server installed.
Save the changes.
Join Server to Enterprise
At the root authority, log into tech toolkit.
Select "Add a Subordinate Server to " from the server menu.
Tech toolkit Server menu

Enter the FQDN or IP address of the server that will be joined to the root.
Enter the username and password that will be used to connect to the server.
Click the arrow button to proceed.
Add server, new server details

On the next screen, enter login information for the new server's Point of Authority (e.g., the root authority or an intermediate level POA).
 Add server, poa server details
When you click the next arrow, the JTE process starts. JTE includes a type of "mini-initialization" in which core resources are replicated to the new server.
Join the enterprise, finished 
When the process is finished, the new server will be listed under its POA. In the screenshot below, the user is logged in to the "Store" server. This is indicated by the green user icon. The user icon is red at those locations where the user is not logged in. All three servers (HQ, POA and Store) are online, as indicated by the green surrounding the cloud icon.
Tech Toolkit server list

As part of the JTE process, core resources are imported. The core resources are certain basic resources that are required to be in place for initialization to succeed. 
Next, initialize the POA server with data from the root authority (HQ) server.

Core Resources
When you join the enterprise, the system performs a type of mini-initialization and copies a group of resources known as the Core Resources from the POA to the subordinate system. As a result, when you go into the Profiles area on the Prism Dashboard, you will see a Core Resources profile already exists. The Core Resources profile is read-only. The Core Resources profile includes the following resources: controller, tenant, subsidiary, custom schema, transform design, season, tax area, price level, currency, store type and store.

Generate Server Identity File
A server identity file is a special file that helps a store recover from a hard-drive failure or other catastrophic failure to a server machine. Using the identify server file, the Prism install program will do the work needed so that the machine can claim its former node in the enterprise. If you do not use an identity script to rebuild a controller it will not be able to claim its former node when joining the enterprise. The file contains the necessary SID information to re-install Prism using the same controller, store, subsidiary as before.
Because of the crucial role it plays in restoring a system, you should create the server identity file at the first opportunity. A good time to create the file is when you add the connection (to the server itself) in Technician's Toolkit. After you add the connection, you can then go and export the identity script.
From the server menu, select Export Identity (Oracle) or Export Identity (MySQL).
The file is exported to the C:\Users\\Documents folder.

Initialize Prism 2.x Server
The amount of time required to initialize Prism will depend on the size of your database, especially the size of inventory and customers. The larger the data set, the more time is required. Please set aside enough time for initialization to complete. Remember, if you have just installed Prism, you first need to configure Installation Defaults and join the enterprise.
At the newly added server, launch the Prism Proxy and log into Prism. Navigate to Admin Console > Connection Manager > Prism Dashboard.
When a server is joined to the enterprise, among the changes that occur are the Prism Dashboard user interface is updated to include tabs for defining profiles, initializing the server, etc.
Click the Profiles tab and define a profile to use for initialization.
Click the Connections tab.
A list of servers to which this server is connected is displayed.
 Click the connection to the server's POA.
A lower pane is now displayed. If this is a new installation, there are no profiles assigned to the connection yet.
In the Linked column, click the checkbox to link the profile to the connection.
Click the Initializations tab.
In the From Server field, select the server that will be the data source for the initialization To select a different server, click in the text box and select the desired server.
Click Start Initialization.
Click the check box for the server that will be initialized and select the Profile to use.
Click Start.
You can monitor the progress by viewing the Messages Sent and Total Messages fields and by viewing the progress bar. Keep in mind that the sending of messages can finish relatively quickly while the processing of those messages (as shown in the progress bar) takes longer. Any errors that occur during initialization are listed beside the flame icon.  
Create Test Transaction after Initialization
After initialization completes, log out of Prism and log back in using your Prism username and password. You should land on the POS main menu.
Click the New Transaction button. Scan or type an item and enter a customer to confirm everything is working. Conduct further testing to ensure data was replicated correctly.
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, here is what you should do:
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.

Prism Main Areas
Prism divides tasks into a few different sets of operations: POS, Store Operations and Administration. POS tasks are typically handled in the front of the store with cashiers and associates and includes sub-areas for Point of Sale, Customers and X/Z-Out reports. Store Operations tasks are typically handled in the back of the store (backoffice) by managers and others and include sub-areas for Inventory, Purchase Orders, Vouchers, Transfer Orders, Transfer Slips and Adjustment Memos. When a user logs in to Prism, the Point of Sale main screen is displayed, showing various buttons that provide access to POS tasks. To navigate to a different area, for example, Store Operations, click the Retail Pro button in the lower-right corner of the screen. This displays the Prism menu options to navigate to Point of Sale, Store Operations, Admin Console, Change Password, etc.
Sample Prism Main POS menu:
Prism POS menu

About Day-to-Day Replication
Day-to-Day (D2D) Replication refers to the sending of data on a regular basis between servers. Unlike initialization, which is typically a one-time operation that sends all available data downstream, Day-to-Day replication occurs on a regular basis, in both directions, and sends only a subset of records.
D2D replication is carried out by creating one or more profiles that include the desired resources and then linking each profile to the correct connection. When creating profiles for D2D, you can send only the specific data types needed by the receiving location. This reduces overhead and replication times. Resources that are unlikely to change, like Departments or Vendors, can be excluded, or sent only occasionally. You can use the Advanced Filters feature to apply fine-grained control over the specific records that are replicated. In certain situations, the same profile that is used for initialization can also be used for D2D replication.

Summary of Profiles Created

 - At POA

Profile Type Purpose Description
Prism-to-Prism Initialization of Store Server by POA At each POA, on the Prism Dashboard create a Prism-to-Prism profile for initializing store servers with data from the POA.
Prism-to-Prism Day-to-Day Replication with Prism HQ At each POA, on the Prism Dashboard create a Prism-to-Prism profile for sending transactions and other documents upstream from the POA to the HQ server.
Prism-to-Prism Day-to-Day Replication with Stores under POA's control At each POA, on the Prism Dashboard create a Prism-to-Prism profile for sending data downstream to the stores under the POA's control. To limit the amount of data replicated to stores, you can create a separate profile for each store and use an Advanced Filter to only send the records needed by that store.

 - At Stores

Profile Type Purpose Description
Prism-to-Prism Day-to-Day Replication with POA At each Prism store, create a profile to send the data created at the store upstream to the store's Point of Authority (POA). This profile only needs to send a few types of data. Specifically, the profile should include the document, customer, zoutcontrol, drawereventhistory and employee resource.

Post Installation Checklist
Here are some key settings to review after installing Prism and joining the enterprise. Note: This is not meant to be a comprehensive list as each retailer's specific needs will differ.
Preferences Checklist

  • Lookup Method is set to UPC by default. Change to ALU if needed.
  • Tax Method is set to Sales Tax by default. Change to VAT if needed.
  • Price Levels have been defined.
  • Tenders must be explicitly set for Take, Give and Return. (Node Preferences > Transactions > Tenders > Tender Requirements). If tender rounding is used, those instructions must be configured in Tender Requirements, too.
  • Exchange Rates (and denominations) must be configured in Global Preferences.
  • Verify that Discount Reasons, Fee Types, UDF fields and POS Flags replicated correctly.
  • You will have to configure document sequences. You can set sequences at the Subsidiary, Store or Workstation level. You set the desired level Prism Node Preferences. You then set the desired specific starting numbers for each document type in the Subsidiary, Store, or Workstation record.

Employees

  • Make sure employees have been imported or defined. Verify things like the
  • Employee Max Discount %
  • Employee Store Assignments
  • To create transactions, the employee must be assigned to the store. You can verify store assignments in the employee record.

Customers
Make sure customers have been replicated. Verify any key settings that you use like customer discount %, tax area, store credit balance, user-defined fields, etc.
Subsidiary Settings
Price Level, Base Currency and Season. Configure Document Sequences if sequences are set at subsidiary level.
Store Settings

  • Subsidiary - Make sure the store assigned to the correct subsidiary
  • Tax Area
  • Price Level
  • Document Sequences (if sequences are set at store level).

Hardware Checklist

  • Install the necessary drivers for the hardware device on a Prism workstation and connect the hardware device.
  • In the Workstation record > HAL Settings, edit settings for the specific hardware device type as needed. (Note: If you don't see the device listed, right-click the Proxy icon in the taskbar and select Reload Hardware Config).
  • For printers, adjust the Print Actions in Hardware > Print Preferences, if needed.
  • Replication checklist 
  • Be sure to install each server in the proper top-down order.Make sure each non-root server points to the correct POA.
  • In Admin Console > Connection Manager, verify a connection exists for each server that needs to talk directly to another server.
  • Make sure a profile is assigned to each side of the connection.
  • Test each connection by sending some test data. For example, create a test profile for a single resource, say customers. Next, create a new customer at one server and then replicate the data using the test profile. Check to make sure the new customer record arrived at the other server.
  • Generate a server identity file and save it for later use if the server crashes or has to be reinstalled.

SSL Certificates
Users are responsible for providing their own SSL certificates to run Prism using HTTPS. You must purchase your own SSL certificates from a certificate authority and then install the certificates using the SSL Manager tool in Tech Toolkit.
Employee Management and Security
When you first install Prism, a single default employee group called the Administrator group is created. This default Prism Administrator group enables users to log in to Prism the first time and initialize the system (default login credentials are sysadmin/sysadmin). When you initialize Prism, employee groups are copied from the Point of Authority (POA) to the new server. The default Administrator group, having served its purpose,  is overwritten during initialization.
Preferences
After initialization is complete and permissions are assigned, you can customize Prism preferences to best meet the needs of your business. Preferences enable retailers to customize various aspects of the program workflow and interface. Configuration of preferences is required for using certain RP Prism features, such as Promotions, Loyalty, EFT, Centrals and Send Sale. Key settings that you will want to define right away include:
•    Document sequence numbers
•    Tax Method (Sales Tax or VAT)
•    Tender Requirements (allowed tenders for payment, change, returns, etc.)
For information see the RP Prism Admin Console document.
Exclude Prism from Anti-Virus Scans
This section provides information about excluding Prism folders from scans performed by anti-virus programs. This includes but is not limited to Windows Defender. If users fail to exclude Prism folders from the scans performed by anti-virus programs, program performance can be severely impacted.
Exclude the following folders from any anti-virus programs.

Excluded Program Location
Exclude Prism C:\ProgramData\RetailPro
Exclude Apache C:\Program Files (x86)\Apache Software Foundation
Exclude RabbitMQ C:\Program Files (x86)\RabbitMQ Server
Exclude Oracle C:\Oracle
Exclude MySQL C:\ProgramData\MySQL

Limitations on Windows 10, Windows 11

  • The Proxy must be launched using right-click "Run as Administrator" option.
  • Windows World Wide Web Publishing Service must be disabled

Proxy Configuration
For effective communication between web clients and the Proxy, the Proxy should point at a server on the local network. This enables the proxy to fulfill its primary purpose, which is enabling web clients in the POS lanes to communicate with printers and other POS hardware. If you need to change the server to which the Proxy points, first uninstall the Proxy and then reinstall the Proxy, this time pointing to the desired local server.