188.8.131.527 What's New
This topic has information about the following new features and functionality added in Prism 1.14.6
- Style Management
- EFT with Adyen
- Special Orders
- Z-Out Audit
- Rename Prism Server tool
- Document Design Report Groups
- RIL Conversion Tool
- B+S Configuration file changes
- Genius Mini UI changes
- Email receipts in HTML format
- Document Lookup Enhancements
- Sort Column Shows Arrow (Up or Down)
- Change Receipt Tax Area permission
- Change Item Tax Code at POS permission
- Modify Workstation on Z-Out Reports permission
- Promotions - Allow Price Increase
- Promotions - PL Price Discount Type enhancement
- Central server settings moved to Installation Defaults
- Default Number of Copies for Print/Update
- Edit Coupon Sets
- Merchandise Exchange Workflow changes
- Proxy Customization Max Retry Setting
- Retain XLogs Setting
- SDK Samples available in GitHub
- Prism Boolean Flags
- GETLIMIT changes
Styles enable you to group inventory items that possess similar characteristics, but vary in size, color, or some other attribute. In a style, each size and color combination is a separate item. For example, a sweater sold in four sizes and two colors comprises a style of eight items. Each member of a style shares the same DCS Code, Vendor Code and either Description 1 or Description 2. These fields make up the style definition. Within a style, fields like Size and Attribute distinguish the individual items.
Inventory UI Changes for Styles
As part of the style management feature, users will notice the following new interface elements in the Prism Inventory area:
- Style Lookup/Item Lookup toggle button in Inventory enables you to switch easily between Item Lookup and Style Lookup
- Style Details screen for adding/editing style information
- Style grid that displays style item information in the grid cells; users can change the value displayed in the grid cells. (e.g. OH Qty, Price, Cost, Margin)
- Functionality to create and edit grid scales
- Grid format preferences for customizing style lookup grids
Store Operations > Merchandise > Inventory > Style Lookup:
EFT with Adyen
Adyen is a global payment company and is primarily used with Prism in European markets. Merchants can use Adyen for processing of Prism credit, debit and gift card transactions.
The Adyen Personal Engagement Device (PED) sits on the retail countertop and connects to the POS via IP network cables. The PED 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).
- Connect the PEDs to the LAN and download the latest software updates.
- Log in to the Adyen web portal and configure PEDs.
- Download updated config to PEDs.
- Add a new customization for Adyen in Admin Console > Customizations.
- Select Adyen as the EFT Provider in Admin Console > Preferences & Settings > Node Preferences > Transactions > Tenders > EFT Server Configuration.
- Edit the customizations.js and customizations.html files to enable Adyen and disable other EFT providers (located in C:\progrm Data\Retailpro\Server\Webclient
- Configure HAL settings at each workstation that has a PED.
- Restart the Proxy.
- Edit Prism Adyen Configuration settings. When save, get blue toasty.
- Right-click Proxy icons and select Reload HW Config. (If doesn't work, restart Proxy).
- Run transactions in Prism. Review the transactions on the Adyen web site.
Special orders enable customers to order items not normally carried in inventory, or to order a special shipment of an item that already exists in inventory.
- When creating a special order for a new item, the user enters basic item information and the new item is added to Prism inventory with a Special Order flag selected.
- Items that have the Special-Order flag selected can be listed on documents (purchase orders, transfer orders, slips and adjustment memos).
- Items that have the Special Order flag selected can be added to a transaction as a regular sale item or as an order item (on a customer order).
- Clearing the Special Order flag in Inventory "upgrades" the item to a regular item.
- If a currently inactive item is listed on a special order, upon document update the item will be activated and the Special-Order flag selected.
Enable Special Orders and Set Minimum Deposit Percentage
By default, Special Orders are disabled. To enable special orders, navigate to Preferences and Settings > Node Preferences > Transactions > Orders and select the Enable Special Orders checkbox. After you enable special orders in preferences, the "Special Order" button will be available on the transaction Options button menu. You can optionally define a minimum deposit percentage for special orders and require that a deposit be taken when a special order is created.
Node Preferences > Transactions > Orders:
DevTrack ID #18232
The Z-Out Audit feature enables retailers to monitor sales activity via a Z-Out report without going through the reconciliation process. This gives the retailer visibility to the overage or shortage for that one isolated Z-Out Open and Z-Out Close, enabling earlier flagging of abnormalities, while still being able to roll up all the Z-Outs at the end of the day.
The Z-Out Audit feature is only available in Structured Z-Out mode.
When using the Z-Out Audit feature, the user goes through a process like the normal Z-Out Close process minus the reconciliation step.
To use Z-Out Audits, you must enable the Enable Structured Z-Out Audit option in Node Preferences > Reporting > X/Z-Out. When "Enable Structured Z-Out Audit" is selected, the menu in Z-Out reports has a Z-Out Audit button (in addition to the regular Structured Z-Out buttons for Open Register and Close Register).
Basic Flow for Audit Register
- Navigate to Point of Sale > x/Z-Out.
- Click the Z-Out button.
- Click Audit/Close Register.
- The workflow is the almost the same as for a regular Z-Out close register action. You define register criteria (the report filter), enter the closing amount and match non-currency tenders.
- The difference is on the final screen. Instead of prompting to reconcile the drawer, users will see an Audit button.
Clicking Audit will create an audit record. Click the Close button to close the report without creating an audit record.
Click the Back button to edit the report, if needed.
Z-Out Audit Notes
- Audits are only available for systems using Structured Z-Out reports
- Audits may be performed for open drawers only (not closed drawers)
- Audits reconcile register balances
- Audits do not close Z-Out registers
- "Total Over/Short" values will be calculated for the drawer period. Calculated from the register open counts.
- "Audit Over/Short" values will be calculated for the audit period. Calculated from the most recent audit counts. If no previous audits exist, calculated from the register open counts.
- Running Z-Out Close will calculate a final "Audit Over/Short" amount.
Reconfigure Host Computer tool
DevTrack ID #18510The Reconfigure Host Computer tool in the Prism Technicians Toolkit leads you through the process of renaming a computer that has Prism installed. Special steps are required to ensure the machine can rejoin the enterprise under the new name.
- The process requires disconnecting data links between servers; therefore, the process should be done when no sales or other activity is taking place.
- This tool is intended to be used only in conjunction with computer name changes not for changes like changing or joining workgroups or domains.
- Check enterprise connections and leave the enterprise. If the host computer has subordinates, those subordinates must disconnect and leave the enterprise as well.
- Change the computer name using the Windows System Properties feature. Don't restart the computer after changing the name!
- Launch Technician's Toolkit and run Step 1 of the Reconfiguration Process.
- Run Step 2 of the Reconfiguration Process.
- Rejoin the enterprise. If the host computer has subordinates, those subordinates must rejoin the enterprise as well.
DevTrack ID #12642
Report groups enable retailers to create different document designs and then print the documents as a group. For example, some retailers need to keep a printed copy of the document at the store with the word "copy" on it (in order to prevent incorrect returns). Using a report group prints the documents one after the other.
Launch Document Designer and click the Groups button.
To create a new group, click the New button.
In the New Group modal, enter a Group Name and select the designs to include in the group by moving them from the Available column to the Selected column. Use the arrow keys to move designs back and forth.
Click OK. The group is saved and is now available in the "Group" drop-down.
RIL Converstion Tool
The RIL Conversion tool (RILConv.exe) prepares a Retail Pro 9 system for upgrade to RIL. The tool cleans up your Retail Pro 9 files, folders and registry keys and performs other tasks that enable you to install RIL. After running the RILConv.exe tool, install RIL as part of the Prism install for 184.108.40.2067 (or above).
The tool will systematically:
- Shutdown executables (e.g. Retail Pro 9, ECM)
- Stop services
- Uninstall services
- Unregister plugin dlls
- Uninstall (Delete) plugin dlls
- Remove Retail Pro 9 and ECM folders
- Remove registry keys.
- Add new RIL registry keys for Oracle database
The tool is compatible with Retail Pro 9.4.10. If you are on an earlier version of Retail Pro 9, you must upgrade to 9.4.10 first.
Before Running the Tool
The tool should only be run by existing Retail Pro 9 users when ready to transition to RIL. Do not try to run the RIL installer without first running the RILConv.exe tool.
Make a complete backup of:
- Your database, including Oracle database (not necessary for client-only installs)
- Retail Pro 9 translation files
- All addons, customizations, etc.
- All Licensing (using ServiceManager.exe).
- ECM security configuration and profiles
Launch and Run the RIL Conversion Tool
Contact Retail Pro Technical Support to obtain the RIL Conversion tool. They will tell you where to download the tool. After you download the tool, copy it to the system that is undergoing the conversion.
Use Windows Explorer to navigate to and launch RILConv.exe.
Select the Enable RIL Trial Mode checkbox. and click the Run Process button.
A confirmation is displayed. Click Yes to proceed.
Processing starts. You can view the progress of the RIL conversion process in the text box.
When the process is finished, click OK.
Tech Toolkit Service
DevTrack ID #17420
The TechToolKit Service is a new api that, when fully developed, will support a web based version of Prism TechToolKit. In this initial release of the service its features are limited to a basic Prism HealthCheck and providing the code base for the new Reconfigure Prism Host Computer tool.
The HealthCheck includes a Service Monitor and a System Monitor. These are turned off by default. While the HealthCheck's feature set will be expanded in future releases, the following describes functionality in this release.
The Service Monitor, when enabled, checks Prism services' status every 60 seconds and restarts any Prism-related service that has stopped or did not start.
If there is a Prism service you do not want the Monitor to restart, enter its exact name (as shown in the ToolKit's Service Manager listing) in the "Service Monitor-Service Exclusions" edit box.
The System Monitor, when enabled, checks available diskspace, memory, and other system attributes. However the alert messaging system will be implemented in a future release. For now, the System Monitor results are logged in the PrismTechToolKit log file when available disk space falls below the specified threshold.
You can view or edit the settings for the TechToolkit service in the Service Manager tool of Tech Toolkit, or by editing the PrismTechToolkit.ini file (located in …\ProgramData\RetailPro\Server\Conf folder).
Note that these settings are dynamic. If they are changed, it is not necessary to restart PrismTechToolKit Service. The settings will take effect on the next HealthCheck run cycle.
PrismTechToolKit service settings
|HealthCheck Run Interval (seconds)||The service will check Prism services' status every 60 seconds and restart any Prism-related services that have stopped or are not running. Enter the number of seconds between each health check. Default = 60.|
|Service Monitor Enabled||If selected, service monitoring is enabled. The service monitoring tasks include restarting services. Default = Disabled|
|Service Monitor Service exclusions||Enter the names of any services that should be excluded from monitoring.|
|Service Monitor - Restart all services||If selected, all services are restarted automatically. Default = Enabled|
|System Monitor Enabled||If selected, system monitoring is enabled. The monitoring tasks include the disk space check described next. Default = Disabled|
|Available Disk Space Alert %||When available disk space reaches the specified percentage, an alert is sent. Default = 10. Important: The alert is not displayed to the end user; the alert is written to TechToolkitService log file.|
|Scale Service||Enables multiple instances of the service to run. This option should only be enabled at the direction of technical support. Default = Disabled|
Reference: See the Services topic for more information about Prism services.
Prism 1.14.6 includes updates to the B+S configuration files (Customizations.html and Customizations.js). When upgrading to 1.14.6 from 1.14.5 or an earlier version, you must make the following edits to the configuration files:
- In the Customizations.html file, add a reference to the bs.service.js in the list of script tags.
- In the Customizations.js file, add a line that will push dependencies for B+S Card Service.
Note: Fresh installs of Prism 1.14.6 include updated versions of the configuration files so no edits are necessary.
var dependencies = ;
/*DO NOT MODIFY ABOVE THIS LINE!*/
/*DO NOT MODIFY BELOW THIS LINE!*/
ng.module('prismApp.customizations', dependencies, null);
Genius Mini Workflow Changes
DevTrack ID #17410
This release includes changes to the workflow when using the Cayan Genius or Genius Mini device.
For both the standard Genius device and the Genius Mini:
- Updated UI for all Cayan features (credit/debit, gift card)
- Updated workflow for Cayan gift card balance check, add value, and purchase actions
Email Receipts in HTML format
DevTrack ID #18799
Prism Email receipts are now sent in HTML format. Previously, Prism would generate a .pdf file of the receipt and attach the email to the email sent to the customer.
Sending email receipts in HTML format (instead of as an attached PDF) has the following benefits:
- Easier to read for mobile device users
- Less likely to be flagged as a security risk by email servers
- Can be printed without having to first open an attachment
Note: Gift receipts cannot be emailed at the current time.
Prism also has new preferences that enable you to customize the subject line in Email receipts.
|Default Email Subject Line||This enables you to define the default subject line and the sender's email address that is displayed in the From: field of the email.|
|Document Email Subject Line||By default, the Email Subject Line will read: "Your receipt # " followed by the document number of the transaction. You can configure preferences to use different text and/or a different database field. See the "Customizing Document Email Subject Line" section. Maximum number of characters = 80|
Prism Email Server Preferences:
Document Lookup Enhancements
This release includes various updates that help to standardize the UI and workflow in the document lookup areas.
- Search elements have a dropdown for the user to select the desired value (instead of freeform entry, which is prone to typing errors).
- Pagination is applied when many records are returned
- If the selected search element requires an operator, you must set the appropriate operator (e.g. EQUALS or CONTAINS).
- Permissions control ability of employees to lookup individual document types.
- Each document lookup area has a corresponding Grid Formats preference where you can define the available filters, default filter set, and default visible columns.
Document Lookup Basics
When you access a document lookup area like Purchase Order Lookup, you will see a screen that is split into two panes. The left pane is for defining search criteria. The right pane is for displaying the results of your search.
Click the Search By drop-down to see a list of the available filter elements. Use the scrollbar or arrow keys to view the list. Click the desired element (or press
When you add a search element to the interface, you must also select an operator. For most elements, you can select the desired value from a drop-down menu. This is easier than typing the value and avoids user-entry errors.
You can add multiple search elements.
When ready. click Search. The Results pane displays the matching documents. Use the pagination buttons to navigate the list if many documents are returned.
The Filters area (left) and Results pane (right) in Purchase Order Lookup
Show Sort Column, Sort Order
DevTrack ID #16563
When you sort a grid column, you will now see a bold up/down arrow in the top right of the column, indicating the order of the sort (ascending or descending). This makes it easy for a user to immediately know which column is being used to sort data as well as the direction of the sort.
In the screenshot below, Inventory search results are sorted by the UPC column in ascending order, as shown by the bold arrow point up.
Change Receipt Tax Area at POS
DevTrack ID #17819
A new permission controls employees' ability to change the tax area on a transaction. To edit the tax area on a transaction, a user must belong to a group that is assigned the POS - Change Tax Area permission. Employees who belong to a group with the permission can navigate to Transaction Details > Taxes and select a different Tax Area from the drop-down.
Change Item Tax Code at POS
DevTrack ID #17573
A new permission controls employees' ability to change an item's tax code on a transaction. To edit an item's tax code on a transaction, a user must belong to a group that is assigned the POS - Change Item Tax Code permission.
Employees who belong to a group with the permission can navigate to Item Details > Taxes tab and select a different Tax Code from the drop-down.
Modify Workstation permission for X/Z-Out Reports
DevTrack ID #18161
A new permission enables retailers to control the ability of employees to modify a workstation's X/Z-Out settings.
Assign the X/Z-Out - Modify Workstation permission to employee groups that should be able to modify the workstation settings for X/Z-Out reports.
If the employee does not belong to a group with the permission, the employee cannot modify the filter settings for X/Z-Out reports. This helps ensure consistency across reports.
Promotions: PL Price Discount Type Enhancements
DevTrack ID #18879
In the Reward Details section of new promotions, certain promotion types (e.g. BOGOs) provide a "PL Price" Reward option (in addition to Discount Amount and Discount Percentage). So when the promotion is triggered, instead applying a discount amount or percentage, the promotion will change the reward items' price to the selected PL Price Level. When using the PL Price reward type for a promotion, you can now apply additional discounts on top of changing to the selected PL Price Level. Previously, the PL Price discount type only could apply the selected price level's price; further discounts were not allowed.
When the user selects the PL Price option on the Reward Details screen of a BOGO, an "Additional Discount Type" element is added to the user interface. The user can then enter an additional discount amount or percentage. By default, the Additional Discount Type field is set to None. The additional discount amount or price is calculated from the PL Price. This feature is especially useful when promotions are being applied against the MSRP and the MSRP price level is not the currently active price level.
If you click the Additional Rule button, fields for entering additional discounting information are displayed (see illustration below). There is another "Additional Rule" button at the bottom of the screen. This enables you to add multiple rules on top of the PL Price discount type. If you need to delete one of these additional rules, click the Delete button.
For more information, see the Promotions - Reward Details topic
Allow Price Increase on Promotions
DevTrack ID #19093
When using the Price (or PL Price) as the Discount Type on a promotion, there are times when the promotion increases the receipt price of an item. The "Allow Price Increase" setting is now available on promotions on the Activation Details screen.
When enabled, the promotion can apply to an item regardless if it increases the current receipt price (same as previous behavior).
When disabled (default), the promotion will not apply to any items if it increases the current receipt price from the current value
Sample Activation Details screen with Allow Price Increases checkbox:
Centrals Server settings moved to Installation Defaults
DevTrack ID #18734
Preferences related to centrals are now found in Installation Defaults. Previously, these preferences were found in Node Preferences > Transactions > Centrals. Moving the preferences to Installation Defaults ensures that the settings are applied consistently to all stores and workstations for the installation.
Important! These changes require you to reconfigure preferences for centrals for each installation that uses centrals.
The following table lists the centrals server settings:
|Centrals Server Address||The IP address or FQDN of the designated centrals server.|
|Centrals Server Port||The port to use for communication with the centrals server. Default - 50025|
|Centrals Server Timeout||The number of seconds Prism will attempt to establish a connection to the centrals server. If the connection cannot be established, the system will wait the designated interval time and then try again (up to the designated number of retry attempts). Default = 30|
|Resiliency Check Interval||The number of seconds Prism will wait between checks to see if the link to the centrals server has been restored. Default = 10|
Prism Centrals Server Preferences in Installation Defaults:
Default Number of Copies for Print/Update
DevTrack ID #17840
The Default Copies setting in Print Preferences enables you to print multiple copies of a document (i.e. a printed receipt) by default. Printing multiple copies of a receipt or other document is required (or desired) in certain regions. Previously, users had to remember to change the number of copies in the Print dialog at runtime. Having the default setting at the desired number of copies means there is one less thing for the Associate at POS to worry about.
Navigate to Admin Console > Node Preferences > Hardware > Print Preferences. In Print Areas, select the desired document type (e.g. POS Transactions > POS Receipt). Select Dialog in the Default Action.
In the Print Dialog area, edit the Default Copies setting to the desired value. Save the changes.
When the user prints the document, the defined number of copies will print automatically. Depending on the setting in the "Default Action" field, the user may or may not see a dialog where the number of copies can be changed at runtime.
Admin Console > Hardware > Print Preferences with new Default Copies setting
Edit Coupon Sets
Users can now edit coupon sets as a group. Previously, only individual coupons could be edited. This change enables you to reuse coupon sets that contain unused serial coupons.
Change the "Used" count for all coupon codes back to zero. This enables the coupon set to be reused again.
For example, a merchant gives a weekly coupon to each employee. The employees can use the coupon at the company's snack shop. The coupon given to the employees each week uses the same ID. The coupons never expire, but the coupon can only be used once per week. If the coupon is used, it is expired until the following week.
Using the new Edit Set button on the Coupon Set UI, a user can reset all the coupons, enabling them to be reused.
When the user clicks Edit Set, a modal opens. The changes made in the modal are applied to all coupons in the set. Editable values are "Issued", "Used", "Start Date" and "End Date".
Sample Coupon Set in Edit Mode
Merchandise Exchange Workflow
DevTrack ID #18975
Users will notice a small change in the workflow for returns that make it easier to do a straight item-for-item exchange. When an item is listed as a return item and then as a sale item, Prism will show both the return and the sale as separate line items on the transaction (instead of consolidating the quantities). This makes it easier to identify a transaction as an exchange.
The workflow for listing the return item is the same as before: List the item being returned and change the Item Type to "Return." Reference the original purchase transaction, if needed. The return item is now listed on the transaction. List the item a second time. By default, the Item Type is set to "Sale". The item is now listed on the transaction twice: once as a return item and once as a sale item.
The screenshot below shows a transaction with the same item listed twice, once as a sale item and once as a return item.
Proxy Customization Max Retry Setting
DevTrack ID #18609
The CUSTOMIZATION table has a new MAX_NOTIFICATION_TRIES column. Previously, if a proxy was unable to connect to a customization, the system would try a total of three times to establish the connection. Using the new column, you can change the default setting of ‘3' to whatever value you wish.
Sample Customization showing Retry setting:
The RetainXLogs setting is located in each Prism service's config file (INI) file. The Prism Logger maintains logs by keeping the most recent RetainXLogs
RetainXLogs has been set to "9" by default in all Prism services' config files. However, prior to this release, the RetainXLogs feature had become inoperative causing an indefinite accumulation of log files.
This setting is now enforced when:
- A service starts.
- A service is running and a new log file is created. (As in the past, a new log is created when the current log file has reached the specified max size or max number of lines.)
- 3A service stops.
Note that when this release is installed on an existing Prism system all log files for each service exceeding the RetainXLogs existing setting will be deleted when each service restarts keeping only the most recent.
Examples of RetainXLogs settings and their effect:
• RetainXLogs=11 // Keeps the current log file and the most recent 10 others, for a total of 11.
• RetainXLogs=0 // A setting of 0 or less than 0 turns off the feature and log files for the service accumulate indefinitely.
A setting of 0 would be pointless because it would direct the Logger to continually check the RetainXLog setting while a service is running and then delete a log files shortly after it is created. If the intent is to remove all log files, there is a feature in TechToolKit to do this logs or this can be done once manually then use RetainXLogs to manage log files going forward.
• RetainXLogs=1 // Keep only the current, that is, last log file. Not a wise setting, for illustration purposes only.
RetainXLogs can be viewed and edited either manually in a service's config / INI file or in TechToolKit's ServiceManager tool as shown in the screenshot below. If a service is running when a change is made, the change will take effect when the service is restarted.
Move SDK Samples from BitBucket to GitHub
DevTrack ID #18470
Developers of Prism customizations can now access the Prism SDK via GitHub. Previously, the Prism SDK was hosted on BitBucket.
The new home for the Prism SDK is...
Prism Boolean Flags
DevTrack ID #17587
Prism uses several flag fields that are used to indicate an "on/off" status for the field. A common example is the Active flag. If selected, the item or record is active; if not selected, the item or record is inactive. Previously, these flag fields were integer fields, with zero representing the "off" state and 1 representing the "on" state. Now, these flag fields are represented by the Boolean data type, with the Boolean "False" value representing the "off" state and "True" representing the "on" state.
PrismServer installer will now add a GETLIMIT section with keys and values to the following Prism config files: PrismBackoffice.ini, PrismCommon.ini, RPSServiceModule.ini. This change will limit the total number of records returned by a GET request for customerlist, InventoryList, InventoryStyleList to 100. The intent of the GETLIMIT is to catch GET requests that unintentionally request a huge data payload that could slow or hang a Prism service. This could occur when a request is generated dynamically and fails to include a filter.
The following resources have a default GETLIMIT of 100 defined:
- RPSRestServiceModule.ini: company, customer, customerlist, document, drawerevent, inventory, timeclock, zoutcontrol
- PrismBackOffice.ini: adjustment, document, inventory, purchaseorder, transferorder, transferslip, vendorinvoice
- PrismCommon.ini: customer, customerlist
- The GETLIMIT only applies to GET requests that don't include pagination. Most GET requests from the web client in which large amounts of data may be returned include pagination. As such most web client requests will not be affected by a GETLIMIT specification.
- The GETLIMIT section is added to config files in both fresh and over-the-top installs.
- If a user has changed a GETLIMIT value for a resource, an over-the-top install will not overwrite that GETLIMIT value.
- After changing a GETLIMIT setting, the service must be restarted for it to take effect.
- To remove a GETLIMIT restriction on a resource in an INI file, set the value to 0. Removing the GETLIMIT section has the same effect, however, the next over-the-top install will reinsert the GETLIMIT section for that resource.
- GETLIMIT key values must be edited manually in the individual .ini files (not in the Service Manager area of Tech Toolkit).