Prism File List
This document provides information about the files, folders and registry entries installed to a computer when a user installs Retail Pro Prism. The document is divided into the following sections:
- Apache
- Prism Server
- Prism Proxy
- Document Designer
- Prism Services
- Special Configuration Settings
- Registry Keys
Apache
Prism is a web-based application and uses Apache as its web server. Files for the Apache server are installed to the C:\Program Files\Apache Software Foundation\Apache folder. See your Apache documentation for more information. A few of the key folders and files related to Apache are listed below:
| Folder | |
|---|---|
| …\Apache\modules\mod_rprox.so | Apache file used by Prism. |
| ...\Apache\modules\mod_Prism.so | Apache file used by Prism. |
Prism Server
When you install the RP Prism server, the following sub-folders are installed to the …\ProgramData\RetailPro folder.
Refer to the following table for a description of the folders.
| Folder | Description |
|---|---|
| HardwareServices | The …\ProgramData\RetailPro\HardwareServices folder is created when you install the Prism Proxy. If you haven't installed the Prism Proxy, this folder will not be present. This folder contains configuration files related to the Prism Proxy and POS hardware. Configuration (.ini) and log files related to using RP Prism with hardware (e.g. printers, cash drawers, Genius CED, B+S Card Service, Adyen and line display) |
| ImportExport | This folder is used by the Data Migration Tool when migrating data from legacy Retail Pro 8 and Retail Pro 9 to Prism. |
| Server | Server files, including directories for configuration files, licensing files, log files, modules, and Web Client files. |
| TechToolkit | Logs and preferences for the Tech Toolkit application. |
…\ProgramData\RetailPro\HardwareServices\
This folder has various hardware-related files and folders. This folder is created when you install the Prism Proxy. If you haven't installed the Prism Proxy, this folder will not be present.
…\ProgramData\RetailPro\HardwareServices\Conf\
This folder contains configuration files related to the Prism Proxy and POS hardware.
…\ProgramData\RetailPro\HardwareServices\Logs\
This folder has log files related to using hardware devices with Prism.
…\ProgramData\RetailPro\HardwareServices\Modules\
Miscellaneous hardware files.
…\ProgramData\RetailPro\HardwareServices\OPOS114CCO\
Files for OPOS hardware devices.
…\ProgramData\RetailPro\HardwareServices\Plugins\
Cash drawer, line display and other hardware plugin files.
...\ProgramData\RetailPro\ImportExport\
This directory contains \Import\ and a \Working\ folders that are used when importing legacy data into Prism using the Data Migration Tool.
…\ProgramData\RetailPro\Server\
The …\ProgramData\RetailPro\Server folder contains the primary files and folders related to the RP Prism server. The following sub-folders are found in the …\ProgramData\RetailPro\Server folder: conf, Downloads, Help, Images (if exporting images from RIL), Libraries, Licensing, Logs, Modules, RabbitMQ, Reports, WebClient
…\ProgramData\RetailPro\Server\Conf\
For detailed information about the .ini files in this folder, see the "Prism Server .ini File Settings" section of this document.
Refer to the following table for a description of the configuration files.
| File | Description |
|---|---|
| ApacheModConfig.conf | Apache Monitor configuration file |
| EFTServiceModule.ini | Configuration file for the EFT service. |
| PrismBackOffice.ini | Configuration file for the PrismBackOfficeService. |
| PrismCommon.ini | Configuration file for the PrismCommonService. |
| PrismLogging.ini | Log settings for things like the number of days of logs to retain. PrismLogging.ini has a [global] section and sections for each individual Prism service. The settings defined in the [global] section apply to all services by default. To override the default settings in the [global] section, edit the corresponding section for the service. |
| PrismMQService.ini | Configuration file for the PrismMQService. |
| PrismPOSv1.ini | Configuration file for PrismPOSV1Service |
| PrismResiliencyServer.ini | Configuration file for the PrismResiliencyService. |
| PrismScheduling.ini | Configuration file for the PrismSchedulingService |
| PrismTechToolkit.ini | Configuration file for the PrismTechToolkitService |
| RPSLicensing.ini | Configuration file for the RPS Licensing service. |
…\ProgramData\RetailPro\Server\Downloads\
Deprecated: This folder has the CodeSite logging application (CS5_Tools.exe). CodeSite is scheduled be removed in a future release.
…\ProgramData\RetailPro\Server\images\
(only present if using images exported from RIL) If you have exported customer and inventory images using the V9ImageExporter.exe tool, this is the default folder where users will unpack the images for use by RP Prism. Users can change the directory for images in RP Prism preferences. This folder has sub-folders for customers, inventory and invn_style images.
…\ProgramData\RetailPro\Server\Libraries\
This folder has styles sheets and other supplemental files.
| Folder | Description |
|---|---|
| .css | Cascading style sheets used in supplement to the layouts file to define the presentation layer of RP Prism. |
| .js | Javascript files. |
… ProgramData\RetailPro\Server\Licensing\
| File | Description |
|---|---|
| LicenseServer.exe | RP Prism License Server. |
| libeay32.dll | Required file for SSL support. |
| ssleay32.dll | Required file for SSL support. |
...\ProgramData\RetailPro\Server\LicenseAgent\
This folder has the PrismLicenseAgent.exe program used to synchronize licensing.
…\ProgramData\RetailPro\Server\Logs\
| File | Description |
|---|---|
| EFTServiceModule[DateStamp] | Track activity by the RP Prism EFT service. A new log file is generated for each day. |
| LicenseServer[DateStamp] | Track activity by the RP Prism license server. A new log file is generated for each day. |
| PrismBackOfficeAsService_[DateTimeStamp] | Log files for the Prism Backoffice service. |
| PrismCommonAsService_[DateTimeStamp] | Log files for the Prism Common service (used by multiple program areas). |
| PrismMQServiceAsService_[DateTimeStamp] | Log files for the PrismMQ service, used for replication. |
| PrismPOSV1AsService_[DateTimeStamp] |
Log files for the PrismPOSV1 service. |
| PrismResiliencyServerAsService_[DateTimeStamp] |
Tracks actitivity for the PrismResiliencyServer. |
| PrismSchedulingAsService[DateTimeStamp] | Track activity for the Prism Scheduling service. |
| PrismTechToolkitAsService_[DateTimeStamp] | Track activity for Prism Tech Toolkit. |
| PrismWebmodule_[DateTimeStamp] | Log files for the Prism Web module. |
…\ProgramData\RetailPro\Server\RabbitMQ\
RabbitMQ Files schema and configuration files.
…\ProgramData\RetailPro\Server\Reports\
(Future release)
…\ProgramData\RetailPro\Server\WebClient\
This folder contains files used by the RP Prism web client.
| File | Notes |
|---|---|
| \api-documentation\ | Files used by the API Explorer for exploring the Prism API documentation. |
| \api-explorer \ | Files for browsing and exploring the API documentation. |
| \components \ | HTML files used in specific areas of the program. |
| \config\ | Configuration information for Javascript Object Notation files. |
| \docs\ | This area has documentation for client-side customizations. Here you will find information about the various models referenced by the API when creating customizations. |
| \etc\ | Encrypted password file. |
| \fonts\ | Font sets used in the UI. |
| \images\ | Images used in the UI. |
| \locale\ | Translation files. English, Russian, Japanese, Spanish, Chinese, etc. |
| \pages\ | HTML pages for the Admin Console and Store Operations areas. |
| \plugins\ | Files for plugins (customizations). The \plugins\EFT folder has files for the B+S Card plugin. The \plugins\sample folder has a sample customization for the Cayan EFT solution. |
| \scripts\ | Application scripts which control client operations and procedures. Current scripting information is written in Pascal programming language. |
| \styles\ | This folder contains style sheets used by RP Prism. One of the style sheets, customer.css, can be edited to customize the look and feel of the RP Prism client UI. Any changes made to the customer.css file persist even after installing updates to RP Prism. It is important that no other .css files in this folder are changed. |
| \template\ | Various template files used to render certain views in RP Prism. |
| \ttk\ | Some files used by the Tech Toolkit. |
| \ui-grid\ | AngularJS files used for displaying grids. |
| \views\ | These are main HTML files used to render views in RP Prism. There are two separate sets of files: Default and Portrait. The Portrait views are specially designed for use on smartphones with their limited screen area. |
…\ProgramFiles (x86)\RetailPro\
This folder has various ancillary applications available for RP Prism users.
| Folder | Description |
|---|---|
| \DocumentDesigner\ | (Only present if Document Designer was installed). DocumentDesigner.exe is an application for editing or creating printed document designs (e.g designs for 40-column receipts). |
| \ImageExporter\ | Image Exporter, used to export images from a user's RIL installation. |
| \PrismProxy\ | The Proxy is used to launch the Prism web client. When installing PrismProxy.exe, users have an option of installing a shortcut to the program file in this folder. |
| \Resiliency\ | PrismResiliencyServer.exe, an application that enables to perform centrals transactions in offline mode. |
| \Server\Backoffice\ | The PrismBackOffice.exe application facilitates working with inventory, purchase orders, vouchers, etc. |
| \Server\Common\PrismCommon.exe | This application handles tasks common to multiple areas. \Server\Replicaton\PrismMQ.exe PrismMQ, a messaging application used to transmit certain types of data between Prism servers. |
| \Server\Replicaton\ | PrismMQ, a messaging application used to transmit certain types of data between Prism servers. |
| \TechToolkit\ | Files for Prism TechToolkit.exe. |
PrismProxy
When you install the PrismProxy component, the PrismProxy folder is added to the …\Program Files (x86)\RetailPro folder. In addition to PrismProxy.exe, this folder has various programs related to using vendor-specific hardware (e.g. for EFT). The configuration file for PrismProxy is found in C:\ProgramData\RetailPro\Server Conf.
Document Designer
When you install Document Designer, the Document Designer folder is added to the …\Program Files (x86)\RetailPro folder. This folder has the DocumentDesigner.exe program, which enables users to modify the designs used when printing documents like receipts.
Prism Services
Multiple Windows services are the core of Retail Pro Prism. You can configure these services in TTK > Service Manager or by editing each service's .ini file (most are found in C:\ProgramData\RetailPro\Server\Conf\).
See the Services topic for more information.
Registry Keys
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node
| Path | Description |
|---|---|
| Retail Pro\Prism\Erlang | Registry keys for the Erlang programming language upon which RabbitMQ is built. |
| Retail Pro\Prism\Modules | Contains individual sub-registries for individual Prism components. The PrismProxy folder has subfolders for each Proxy installed. |
| Retail Pro\Prism\MRU | Contains keys for most recently used ports. |
| Retail Pro\Prism\Primary | Contains various server-related registry keys. |
| Retail Pro\Prism\RabbitMQ | RabbitMQ registry key. |
| Retail Pro\Prism\Versioned | Contains registry keys related to hardware and individual services. |
| Retail Pro\PrismBackOfficeService | Registry keys for the Prism Backoffice service. |
| Retail Pro\PrismCommonService | Registry keys for the Prism common service. |
| Retail Pro\PrismLicSvr | Registry keys for the Prism license server. |
| Retail Pro\PrismMQService | Registry keys for the PrismMQ service. |
| Retail Pro\PrismPOSV1Service | Registry keys for the Prism POS v1 service. |
| Retail Pro\PrismResiliencyService | Registry keys for the Prism Resiliency service. |
| Retail Pro\PrismSchedulingService | Registry keys for the Prism Scheduling Service. |
| Retail Pro\PrismTechToolKitService | Registry keys for the Prism Tech Toolkit service. |
| Retail Pro\RIL Enterprise Communication Manager | Registry keys for the RIL Enterprise Communication Manager, used to communicate data between the HQ server and the RIL Oracle database. |