Updated: November 5, 2019 7:17am

Appendix B. Hardware

Prism supports a full range of POS hardware devices, including printers, cash drawers and line display, as well as specialized devices like the Cayan Genius Customer Engagement Devices (CED). Hardware configuration requires editing settings in multiple areas and at multiple levels (e.g. at the subsidiary or store level and the workstation level).

Basic Steps for Configuring Hardware

  1. Install the necessary drivers for the hardware on a Prism workstation and connect the hardware. (Note: You cannot mix OPOS and Windows printers in a store; pick one driver type and stick to it.)
  2. Define general preferences related to hardware in Admin Console > Preferences & Settings > Node Preferences > Hardware. These general settings can be defined at the subsidiary- or store-level and include things like default line display messages and alignments, a hostname and port for an email server and custom printer type names for categorizing printers. At the store level, you can assign a default print action (e.g. Print/Update, Update Only, or Email) and default print design for individual document types.
  3. Additional settings are required in the workstation record of the workstation with the hardware. In the Workstation record, display HAL settings for the workstation and define settings for Shopper Display, Cash Drawers, OPOS Printers and Genius Device. 

Subsidiary and Store-Level Preferences (Node Preferences > Hardware)

Area Description
Line Display If using a line display, you can define the messages that will display and select which item information (e.g. price) will be displayed as items are scanned.
Print Preferences This area enables you to define separate printing settings for individual areas of Prism. For example, you can define one set of instructions for receipts and a different set of instructions for vouchers or inventory. Customize the Print dialog by selecting the individual elements to include on the dialog. Select default print designs to use when printing in each area.
General This area has a pair of specialized preferences: Use Wedge Barcode Scanner, and Cash Drawer Status Enabled.
Printer Types

In this area, you can define multiple printer types that can be assigned and help you differentiate printers. When defining Print Preferences, you assign a Printer Type to individual printers. This is useful for identifying printers dedicated to special purposes (e.g. receipt printer, letter printer, label, or label printer).

Email Server If you want to send email receipts, you must define the host information for the email server and specify the port.

Hardware and the Prism Proxy
The Prism Proxy is a gateway for handling requests/responses between a Prism web client and the Prism server. Hardware-related requests/responses are directed through the Proxy's Hardware Abstraction Layer (HAL). Other parts of the Prism Proxy facilitate processes such as client login and the loading of certain hardware-related Admin Console settings. The Proxy allows a Prism web client to discover and send commands to hardware devices (printer, cash drawer, Genius device) installed on a workstation that is connected to the Prism server. For example, this enables an associate using a tablet to ring up a sale and print the receipt on a workstation.

Printers (standard Windows)

  1. Install the necessary drivers for the printer on a Prism workstation and connect the printer.
  2. Define a new Printer Type for the printer(s), if needed. The printer types you define can be assigned to individual printers. In multi-printer environments, this can help users to identify the correct printer to use.
  3. If you defined a Printer Type in Step 2, assign the type to an individual printer. (Edit Workstation > HAL Settings).
  4. Adjust the Print Actions in Hardware > Print Preferences, if needed. This enables you to customize the workflow at POS when a user clicks Print/Update. For example, you can choose whether or not to display the print dialog, email receipts, etc.
  5. If necessary, modify the predefined document designs.
  6. When printing at POS, select the desired design (or accept the default design if a default is specified).

Node Preferences > Hardware > Printer Types
Printers in retail are typically used for specific purposes or are used in specific locations. For example, the printer used for printing price tags is usually different from the printer used to print receipts or documents like vouchers. Likewise, there might be a dedicated "back office printer."
Printer Types enable you to group printers by purpose or location. These Printer Types are used to select the Default Printer for the Print Dialog, and for selecting active printers for the Print action. A set of default printer types is defined (Receipt, Tag), but you can define you own types in Hardware > Printer Types preferences. After creating printer types, you can assign a printer type to individual workstations as needed. You can select each Printer Types that will be available when printing.

Use Same Printer Driver Type
Do not mix OPOS driver printers and Windows driver printers in the same store. Because printing preferences are defined at the store level, mixing the two types will cause problems when the print engine tries to assign a print design to the print job.

Node Preferences > Hardware > Print Preferences
In the Print Preferences area, assign a default print action for document areas

  1. Navigate to the Administration Console.     
  2. Select the Node Selection link.    
  3. Navigate to the desired Store and then tap or click the Set Context button.     
  4. Select the Print Preferences link.    
  5. Select a Print Area.    
  6. Select a Default Printer Type.     
  7. Select a Default Print Design. Note: The available designs will vary based on the Print Area selected.    
  8. Select or clear Print Dialog controls as needed. The options that are selected will be included on the Print dialog UI; those that are cleared will be hidden.    
  9. Save the changes.     

Override Sub Areas
Some areas of Print Preferences have sub areas. When defining preferences for these areas, there is an extra option to Override Sub-Areas. If the Override Sub-Areas check box is selected, it means that the settings defined at the root level will override any sub-level settings.
OPOS Printers
Users can configure OPOS printers using the same basic steps as with other printers. If you have an OPOS printer connected to the workstation, information for the printer will be displayed when you click the OPOS Printers tab in the Workstation record.
Bluetooth Printers
Prism includes support for printing to a Bluetooth printer from an iOS device. This enables retailers to pair an iPad or iPod Touch with a mobile receipt printer for mobility and flexibility at POS.

  • Only available from iOS devices
  • Requires Epson mobile receipt printers with Bluetooth support (Epson TM-P20 and TM-P60ii have been tested)
  • Only one Bluetooth printer per device is supported (pairing two or more Bluetooth printers to a device is allowed in iOS, but is an invalid configuration in Prism)
  • Prism users must install version 1.8.2 of the iOS Launcher

Steps to configure Prism for use with Bluetooth

  1. Make sure the Bluetooth printer is turned on, within range of the iOS device and not paired with any other iOS device. Navigate to the Settings area for the iOS device and assign an available Epson printer to the device. When the printer's name appears in the Devices list, select it to begin pairing. When pairing is complete, the printer will report "Connected". (If pairing fails, try again until it succeeds).
  2. When Bluetooth pairing is complete, open the Prism iOS Launcher. When the Prism iOS Launcher starts up, it will discover the paired Bluetooth printer during hardware discovery.  This is similar to the way the Prism Proxy discovers local hardware on a Windows workstation. Note: The iOS Launcher will check the version of Prism running on the server at login and will alert the user if the Prism version is incorrect)
  3. Login to Prism. The Launcher registers printers to the Prism server upon login.  If connecting directly to the Prism server, only the Bluetooth printer will be registered; if connecting through the Prism Proxy, both Bluetooth and Windows printers will be registered. The Bluetooth printer should now be available for printing receipts from Prism.  If the Launcher is running through the Prism Proxy, Windows network printers will also be available for printing. 

AirPrint

  1. Make sure the printer can be accessed on the same WiFi network that the iOS device is using.
  2. Open the Prism iOS Launcher and login to Prism.
  3. The Launcher registers a generic "AirPrint" resource to the Prism server upon login.  In addition, if a Bluetooth printer is paired with the device, this Bluetooth printer will also be registered.  If connecting through the Prism Proxy, Windows printers will also be registered.
  4. Create a document to be printed from Prism.
  5. From the print menu, select "AirPrint".
  6. This opens Apple's AirPrint dialog box, which is built into iOS.  From there the user may select the printer from the WiFi network, and the number of copies to be printed.
  7. Once printing is complete, the AirPrint dialog box will close and control returns to Prism.

Note: If this is the first time the iOS device is connecting to Prism, the device will register its name as the workstation name in Prism's Administration Console.  The AirPrint resource will not be created until a second login attempt.  This is already a requirement for use of the iPod Touch, because on first login it uses the Default layout, which is the wrong layout for this device.  So the user must change the layout setting to Portrait and login again.  But for the iPad this second login is also required to register the AirPrint resource, even if no other configuration is required for the device.

Genius Device
The Genius Customer Engagement Device (CED) is a special device for performing EFT transaction. The Genius CED accepts all traditional swiped credit cards, PIN debit cards, and gift/loyalty cards. All signatures are captured directly on the CED screen and stored digitally (instead of on paper receipts).
To configure the Genius device, access Workstation Preferences, select the HAL Settings tab and then select the Genius Device link. You will have to first add the Genius device. When adding the Genius device, you will have to enter the Logical Device Number (LDN).

  1. Open a web browser, point to the Prism server and log in.    
  2. Select Administration Console.     
  3. Select Node Preferences and select a node.    
  4. Select a subsidiary and store.    
  5. A list of workstations is displayed. Touch or click the Edit button for your workstation.    
  6. Select the HAL tab and then select the HAL from the drop-down.    
  7. Select the Genius link/tab. Touch or click the Add Genius Device link.    
  8. Enter the device number (LDN) and the IP Address to which it connects. Leave the default port of 8080.    
  9. Touch or click the Save button.     
  10. Stop the Proxy and then restart.    

Shopper Display
The Shopper Display customization enables a regular Genius CED to lists all items, as well as fees, discounts and the total, whereas the standard line display for Genius can only display a single line at a time.
When using the Shopper Display, the screen refreshes automatically as items are added or removed. This enables both the customer and the Associate to clearly see all the elements comprising the transaction, resulting in a more satisfying shopping experience for the customer.
The ShopperDisplay.exe is installed to the same folder as the Prism Proxy (C:\ProgramFiles\RetailPro\PrismProxy and is run on the same machine as the Proxy and it communicates with the Proxy.

Displaying Item Description
When an item is scanned, the item's description is displayed. When configuring the Shopper Display, you can select which item description field to use (Default = Desc 1). When selecting an item description field, keep in mind that the Genius device has a limited screen area for displaying these descriptions (18 characters), with the rest of the description truncated if the limit is exceeded.
Basic Steps for Configuring/Using the Shopper Display

  1. Configure Transaction > Tender > EFT preferences and enable use of the Genius device.
  2. Configure Hardware preferences and select the Description field to use.
  3. Add Genius device and configure ( tab).
  4. On the machine with the CED: Configure Workstation Preferences > HAL Settings > Shopper Display.
  5. Perform transactions in Prism, using the Genius device to take payment.

Genius Options for using Shopper Display
The Shopper Display must be enabled for use separately from the Genius device. Users can use Genius for EFT AND the Shopper Display, or use Genius for EFT and another device for the Shopper Display or only use the Genius for EFT with no Shopper Display.

Shopper Display Registered as Customization
When you install this release of RP Prism, the Shopper Display is automatically registered in the Customization area of the Administration Console. Each Proxy/HAL connected to the server can then use the Shopper Display. You can modify the default settings of the customization configuration, if necessary.

Configure EFT Preferences
Launch the Admin Console and select Node Preferences > Transactions > Tenders > EFT Server Configuration. Select the checkbox for "Use Genius Device" and enter your Merchant Name, Merchant Site ID and Merchant Key.

Configure Prism Hardware Preferences
In Node Preferences > Hardware > Shopper Display, you can select the item description field that will be displayed on the Genius device screen. Description 1 through Description 4 fields are available. When selecting the description, keep in mind that the Genius will only display the first 18 characters of the field value. This preference is inherited from Corp to SBS to Store to WS. Once a Genius Device has been defined for a proxy to be used for EFT, it will become available for selection as a Shopper Display device in the workstation record. Each Genius device is identified by its Logical Device Number (LDN).  The IP address of the device is displayed (read-only).

Note: To configure the Shopper Display feature, the Genius device must be defined as Active in HAL settings and the "Use Genius Device" setting must be selected in 'Preferences and Settings > Transactions > Tenders > EFT Server Configuration'

Using the Shopper Display at POS

  1. Scan the item(s) being purchased. When a user starts a new transaction, the Genius display is initially blank. As items are scanned and fees/discounts entered, the Genius display screen shows each item.
  2. Add any fees or discounts using the Transaction Details dialog.
  3. Touch or click Tender Transaction. The "Please wait for Cashier" message is displayed."
  4. Swipe the card. A message is displayed asking "Confirm the Transaction Amount: Accept?
  5. Tap Accept. Print/Update the Receipt

Notes about Sales Transactions using the Shopper Display

  • Items are listed with a quantity and price. Items without descriptions are displayed as . Fee and Shipping are listed as a single line items, with a quantity of 1.
  • The Shipping value is a sum of all shipping values, item and document level.
  • Discounts (Transaction) are listed as a single line item, with a quantity of 1 or -1, depending on the direction. A regular discount has a quantity of "1" and the amount is a negative value. The example above is a "negative discount". A negative discount has a quantity of "-1" and the value is a positive amount.  Retailers occasionally use a negative discount such as this as a way to apply a third Fee to a transaction (RP Prism is limited to two "fees" per transaction).
  • If the transaction only has order items, regardless of the number of order items, the only line displayed on the Genius device will be "Order Deposit Due." The value is the "Minimum Deposit Due" on the transaction (based on preferences).

Shopper Display in Multi-Proxy Environment
The Shopper Display can be used in a multi-Proxy environment. To Add Shopper Display Customization and Assign Port, follow these steps:

  1. First, edit the ShopperDisplay.ini file to include the ports that will be used. The ShopperDisplay.ini file is found in the … \ProgramData\RetailPro\Server\Conf folder.    
  2. Launch the Prism Proxy and log in.  Go into the Admin Console and drill down to the desired workstation. Click the Edit button.    
  3. Click the HAL Settings tab. Select a Proxy from the drop-down.    
  4. Click Add Customization.     
  5. Navigate to the drop-down and select the Shopper Display customization.    
  6. Enter a Port Override. Default = Port 5678    
  7. Click the Save button.  Click the Exit button.    
  8. Go back to the HAL Settings tab. Select the next Proxy. Repeat the process to add the Shopper Display Plugin and assign the next sequential Port number. Repeat until you have added the Shopper Display customization and a Port to all Proxies.    
  9. Exit the Proxy and then restart.    

Configuring RP Prism Settings in iOS Device
When configuring RP Prism settings in an iOS device, be sure to assign the correct IP Address for the Genius device.

Cash Drawers
You can manage up to two cash drawers. To configure HAL for cash drawers, access the Workstation record, select the HAL Settings tab, and then select the Cash Drawers tab. Enter a time out value for each drawer and then select Save. Please note that if you want to control the opening of the cash drawer via Prism preferences and permissions, then the drawer must use OPOS drivers. If the drawer uses the standard Windows drivers, then POS users will be able to open the cash drawer with no controls simply by clicking the Pop Drawer button.
Transactions > General: Open Cash Drawer Prevents New Receipt
If selected, users will be prevented from starting a new transaction unless the cash drawer is closed. This preference requires that you also select the Cash Drawer Status Enabled check box.
Transactions > Tenders > Tender Requirements - Open Drawer
In Tender Requirements, you can select the individual tenders that will cause the cash drawer to open. The cash drawer will only open if the tender used has the "Open Drawer" checkbox selected in Tender Requirements preferences. This is typically only needed for tenders such as Cash and Foreign Currency but may also be necessary for other tenders such as Gift Cards, Gift Certificates and Credit Cards. If you have configured everything else correctly and the drawer still doesn't open as expected, check and make sure that "Cash" or other tender has the "Open Drawer" checkbox selected in Tender Requirements.

Cash Drawer Permissions
POS Open Cash Drawer: Allow group members to open a cash drawer using the Pop Cash Drawer button.

Pop Cash Drawer
The Pop Cash Drawer button on the POS home screen enables a user to open the cash drawer outside of a normal POS transaction (e.g. automatic drawer opening when giving change to the customer). Opening the cash drawer is a POS action that retailers often want to control using security. If using OPOS drivers, then opening of the cash drawer is controlled by Prism preferences and permissions. If using Windows drivers for the cash drawer, then Prism preferences and permissions are not applied and users can freely open the drawer using the Pop Cash Drawer button. You can also pop the cash drawer manually using the Pop Cash Drawer button (Prism Proxy required).

Pass Through Cash Drawers
Instead of connecting to the workstation via a USB cable, a pass-through cash drawer connects to a receipt printer via a RG-12 telephone line cable. When the workstation updates a receipt, a command (the kick code) is sent to open the cash drawer, the signal passes through the printer and continues on to the connected cash drawer, triggering the drawer to open.
To use a pass-through cash drawer with Prism, you need to enter the correct kick code for Windows-driver receipt printers so that when a receipt is printed, the cash drawer opens automatically. Previously, only OPOS-driver based printers could be used with cash drawers. This enables retailers to use their existing Windows-driver-based hardware with Prism. You can find the kick code by looking in the printer's manual, or by calling the printer's manufacturer.

  1. Install the printer's drivers and connect the printer to the Prism workstation and to the cash drawer. When using a pass-through cash drawer, the printer is usually connected to the cash drawer via a RJ-12 phone jack that provides power.
  2. Navigate to Workstation Preferences > HAL for the workstation. Select the Cash Drawers tab.
  3. Click Add Direct Cash Drawer.
  4. Enter the Hardware ID, Kick Code and select the Printer. Save the changes. The Printer you added is now displayed in the list.
     

Line Display
A line (pole) display shows item information (e.g. price, description) as each item is scanned. You can define the messages used by Line Display in Prism preferences at the Corporate, Subsidiary, or Store level. Select Node Preferences > Hardware > Line Display.
You can define one or two lines of the following:

  • Default message (e.g. company/corporate info or greeting)
  • Item information (e.g. description and price)
  • Total Display (e.g. Subtotal and Transaction Total)
  • Information about configuring the available line display preferences can be found in the RP Prism Admin Console Guide.

Note: Genius users should please see the Prism Genius document for information about configuring line display for the Cayan Genius CED.

Biometrics
Prism includes support for biometric login of employees. Biometric login enables employees to log in using a thumbprint or fingerprint that is scanned by a special device attached to the workstation. Biometric entry is allowed wherever users are prompted for credentials (Note: Biometric login is used in the ‘live' Prism application only; it is not used in configuration areas.)
Biometrics have become increasingly important as retailers seek strong methods of authentication beyond the traditional username/password. The main problem is that username/password combinations can be discovered via social engineering or brute force attacks, giving unauthorized users access to the network. Fingerprints, being unique to each individual, provide greater security.

SecuGen Hamster plus model is the only biometric scanner currently supported.
Basic Steps for Biometrics
1.    Plug the biometric device into the USB port. The device should be "plug-and-play" without the need for further configuration.
2.    Add the Biometrics customization in the Admin Console at the Prism server.
3.    Register the Biometrics with individual workstations.
4.    The Biometric Login button will be added to the standard Prism login dialog. Users can click the button and then scan the designated thumb or fingerprint to login.
Register Customization
Important! You must enter the Customization record info correctly. Any mistakes will cause biometric log in to fail.

  1. In the Admin Console, click Customizations.    
  2. Click Add New Customization.    
  3. Enter the following information:

    Name: Biometrics
    Version: 1.0.0
    Developer ID: 001
    Customization ID: 003
    Control Address: 127.0.0.1
    Port: 6001
    Timeout: 30000 (timeout value is in milliseconds)
    Manifest File Location: c:\Program Files (x86)\RetailPro\PrismProxy\Biometrics.exe (Path to the local biometrics executable)
    Manifest Type: Local
    Auto Start: Checked
    Auto Stop: Checked    
4.    Save the changes and then add the customization to the workstation record, as described in the following set of steps.    
6.    Logout then Reload HW Config    Right click on Proxy task bar icon and select "Reload HW Config"

Add Biometrics Customization to Workstation

  1. Edit the Workstation record and select HAL Settings> Customizations active.    
  2. Click Add Customiztion.   
  3. Select #001 Biometrics - 127.0.0.1:6001 choice from drop down    
  4. In the Local Path field, enter
  5. c:\Program Files (x86)\RetailPro\PrismProxy\Biometrics.exe     
  6. Save the changes.    

Register New Fingerprint
Before a user can log in using Biometrics, the user must register the fingerprint in Employees > Change Password. To register a thumb or fingerprint, three successful scans must be entered. The final scan requires entry of the employee's password. Note: Sysadmin user is not available for this operation.

  1. Select Change Password from the Prism menu.     
  2. In the Biometrics area, click the Add button.    
  3. First scan: Enter a description (e.g. Right Thumb). Click Scan. Place your finger on the scanner and wait for the Green toast message. If a red toast message is displayed, re-scan the finger.     
  4. Second scan: Select Scan and repeat for the second scan.    
  5. Enter your Prism password and press scan for the third and final scan. Note: You are the only one in control of your registered fingerprints. Deleting them can be done by you only for example.    
  6. Repeat for other fingerprints. Click Done and then save the changes.    

Login using Biometric Data
When the Biometric customization is installed and registered on a workstation, whenever a login prompt is displayed, the interface will include a Biometric Login button. Click the Biometric Login button, click the Scan button and then place your thumb or finger in the biometric device. When the scan is successfully recognized, a green pop-up message is displayed.