Updated: April 19, 2024 8:39am

Prism Licensing

PDF

  • In Prism 1.14.7 (and earlier), you don't have to enter a Client ID or Product Key when installing Prism.
  • Starting with Prism 2.0, you have to enter a Client ID and Product Key to install Prism and to install upgrades.
  • Licensing in Retail Pro Prism (version 2.3 and later) is based on the number of sites and seats purchased in the RPLicensing (https://rplicensing.retailpro.com).

This topic focuses on licensing in Prism 2.3 and later. 

Introduction

Licensing in Retail Pro Prism (version 2.3 and later) is based on the number of sites and seats purchased. Purchase the number of sites and seats required for your enterprise and then activate licensing and allocate those sites and seats among the controllers (servers) in the enterprise. 

  • The number of sites limits the number of active stores in the enterprise. 
  • The number of seats limits the number of users who can connect at one time. 

Prism Tech Toolkit includes a Licensing area where you activate licensing and allocate sites/seats. To access the Licensing area, click the menu for a controller and select Licensing. 
 
Prism Version Backward Compatibility
Although Prism 2.3 is backward-compatible with previous versions of Prism (e.g., 1.14.7, 2.2.1, 2.2), the server on 2.3 (e.g., the RA) will be unable to replicate data downstream until the downstream servers have upgraded to 2.3. The downstream servers can still replicate data upstream.
Windows Version Compatibility
Compatible with Windows 10, Windows 11, Windows Server 2016 and later (not compatible with Windows Server 2012). 
Sample Prism Tech Toolkit Licensing area at Root Authority (RA):
 

About the Prism Enterprise Hierarchy
Prism is deployed in a hierarchy, or tree structure, with a single Root Authority (RA) server at the top of the hierarchy (e.g., a server at headquarters). In smaller enterprises individual store servers replicate data directly with the RA. In larger enterprises there may be an intermediate Point of Authority that sits between the RA and stores. Each server (except the RA) joins the enterprise through a Technician's Toolkit process. This structured hierarchy enforces synchronization of data (including licensing) through the enterprise. Servers must be joined to the enterprise and online to be assigned site and seat allocations from the RA. Prism replicates licensing information downstream from the RA to subordinate servers.
About Controllers
Sites and seats are allocated to controllers. A controller is any server that has Prism installed. This could be a store server, a Point-of-Authority (POA) server, or the Root Authority (RA) server. Each controller consumes one site and one seat for itself.

Basic Steps for Licensing (Over-the-top install)
1.    Purchase the number of sites and seats required by your enterprise.
2.    If the current number of active stores in the enterprise exceeds the number of purchased sites, stores will be deactivated based on Last Modified Date. To avoid this, deactivate/activate the desired stores BEFORE activating licensing. First, change workstation assignments so that workstations are no longer assigned to the stores to be deactivated. Next, deactivate stores until the number of active stores is equal to or less than the number of purchased site licenses.
3.    Install Prism 2.3 on the Root Authority (RA) server. 
4.    At the RA launch Prism using the Proxy shortcut. A prompt explains licensing is inactive and must be activated in Tech Toolkit. 
5.    Log in to Tech Toolkit as the SYSADMIN user and activate licensing. 
6.    Allocate sites and seats among the enterprise's controllers. Licensing information will be replicated downstream from the RA to child nodes (POAs and stores).
7.    Install Prism 2.3 on the other controllers in the enterprise in a top-down fashion (i.e., if there are POAs, install the Prism 2.3 upgrade on those POA servers before installing the upgrade on store servers).
8.    Once licensing has been replicated and consumed at the subordinate controllers, users can log in and use Prism. 
Open Port Requirements
Port 443 at the RA must be open. The Prism Licensing website (https://rplicensing.retailpro.com) only accepts secure connections over port 443 (https).
Limitations/Considerations

  • The preferred upgrade approach is to upgrade all servers to 2.3 at once. If business realities prevent this, upgrade the RA first, then POAs. Stores on the older (pre 2.3) version of Prism will still be able to send data (e.g., transactions) upstream to the POA or RA; however, data sent downstream from the 2.3 RA or POA will remain in the PrismMQ consumer cache until the child node upgrades to 2.3. Once the child node upgrades to 2.3, PrismMQ will process in the consumer cache messages (including licensing).
  • To receive license allocations and synchronize licensing, child nodes must have a network connection to their parent and replicate core resources correctly.
  • Only the RA communicates with the RPLicensing web site. The RA replicates licensing downstream to other controllers in the enterprise. 
  • If there are intermediate POAs, those POAs allocate licensing to subordinate nodes (e.g., store servers). Be sure to assign enough sites/seats to a POA so that POA can assign sites/seats to any nodes below it (while also reserving one site/seat to the POA node itself).
  • Each node in the enterprise (including the RA) requires at least one site and one seat for itself. This site/seat is automatically deducted from the number of sites/seats available for allocation.
  • A seat license is required for each device connected to Prism.
  • Customizations that log in via the Prism API using the PRISM_CUSTOM user do not consume a seat.
  • Centrals authentication using the PRISM_CUSTOM user will not consume a seat when performing Centrals functions. Any other user will consume a seat for Centrals. Assign the PRISM_CUSTOM user to a group with the needed Centrals-related permissions for each location using centrals. 
  • You cannot access Admin Console at an unlicensed installation.
  • PrismLicenseAgent.exe runs from …\ProgramData\RetailPro\Server\LicenseAgent\

Key Licensing Terms
The table below explains key licensing terms used in this topic.

Term Description
Activation The process of activating licensing for a specific Client ID# via communication with the Retail Pro licensing web site (https://rplicensing.retailpro.com). Activation requires an Internet connection over port 443 and entry of the Client ID# and Activation Password. After activating licensing and allocating licensing to controllers, users can log in to Prism and create documents and records.
Active/Inactive Store An Active store has its Active flag set to True (selected). If the Active flag is False (cleared), the store is inactive. The Active flag can be found on the General tab of the Store record in Admin Console > Node Preferences > Node Selection > [Store]. When activating licensing, if the number of active stores exceeds the number of purchased sites, stores will be inactivated as needed (based on last modified date). To avoid this happening, deactivate/activate the desired stores before activating licensing.
Controller A controller is a node (server) in the enterprise. A controller with child nodes (e.g., stores) is a Point of Authority. The controller at the top of the enterprise hierarchy is the Root Authority. Only controllers that have joined the enterprise can be allocated licensing.
Deactivation When you deactivate licensing at the RA, the enterprise will go down. At that point, Prism workstations cannot be seated until licensing is activated again in Tech Toolkit. In general, only deactivate licensing under the direction of Technical Support.
Point of Authority A controller with child nodes. In smaller enterprises, stores replicate data directly with the RA, so the RA is also the POA. In larger enterprises, stores replicate data with an intermediate-level POA that facilitates replication of data between the stores and the RA.
RPLicensing web site https://rplicensing.retailpro.com
The licensing authority for all retailers' Prism primary license servers. Handles activation and synchronization. An Internet connection over port 443 is required for license activation so Prism can communicate with the licensing web site. 
Root Authority (RA) The controller at the top of the enterprise hierarchy. Activate licensing at the RA. The RA is the only controller that communicates with the licensing web site. Licensing information will replicate downstream from the RA to other servers in the enterprise.
Site An active store or a physical installation.
Seat A client connection to the database. A controller will always consume one seat license. Each device running Prism consumes a seat license, whether the device is using Prism for point-of-sale, back-office management, store operations, reports, inventory management, etc. Multiple users, like store clerks for example, can share a single seat license by taking turns logging on and logging off.
Software Subscription An active Software Subscription agreement allows a retailer to activate/synchronize licensing and provides access to Prism updates. 
Global Expiration Date The date that, when reached, sets the installation to an inactive state. Beginning 10 days before the expiration date, users will see a warning message when logging into Tech Toolkit and the Global Expiration Date will be highlighted. Beginning five days before expiration, users will additionally see a warning when logging into the Prism web client.
Subordinate Server A server that has joined the enterprise (pointing at its POA) and is online. After the subordinate server has joined the enterprise, it can be allocated site/seats.
Synchronization Synchronization is the process of activating and periodically validating the licensing information between a controller and the controller's parent. See the "About Synchronization" section.

About Synchronization
Periodically (at least once every 30 days), each controller must synchronize licensing with its parent. In the case of the RA, the RA synchronizes licensing information with the RPlicensing web site. Synchronization validates the enterprise's current licensing information and takes place automatically without user interaction if the parent is online. If a controller is unable to synchronize with its parent, users will start to see reminders starting 10 days before the end of the 30-day period. The inability to synchronize could be because 1) the Internet connection is down, or 2) there is a mismatch in the current hardware signature on the machine and the hardware signature known by the RPLicensing web site.
If the RA is unable to contact the RPLicensing web site and the 30-day period expires, the following occurs:

  • The enterprise is unable to replicate data (except Core Resources).
  • The enterprise cannot create vouchers.

If the 30 days are exceeded and vouchers/replication is disabled, once communications between the RA and the subordinate nodes resume, the functionality will be automatically re-enabled.  This will require time to replicate throughout the enterprise to restore functionality at all locations.
The synchronization requirement applies to all nodes in the enterprise. This means EVERY store must communicate with its POA. Warning messages will be displayed starting 10 days before the end of the 30-day synchronization period. If communication still has not occurred after 30 days, initialization/replication of non-core resources and creation of vouchers is disabled for that node and all its subordinates. Functionality will be re-enabled when communication is restored.
Failure to Synchronize due to Mismatch in Hardware Signature
You cannot synchronize if there is a mismatch in the current hardware signature on the machine and the hardware signature as known by RPLicensing web site; RPLicensing recognizes it as a new activation, potentially triggering an error. 
The exact information in the system signature that, if changed, will cause a hardware mismatch error is proprietary; however, changes that will prevent synchronization and count as a "new activation" are:

  • Installing a new OS
  • Entering a new Windows licensing code
  • Changing internal hardware (NIC, etc.)

You won't be informed that there is a hardware signature mismatch until you try to manually synchronize the RA with RPLicensing by clicking the Sync with Retail Pro button.

Sync with Retail Pro
At the RA, the Licensing Information screen includes a Sync with Retail Pro button that will immediately synchronize licensing information with the RPLicensing web site. 
More Options > Sync Locally 
At non-RA servers, the More Options dropdown includes a Sync Locally option that synchronizes licensing for a parent with any subordinate nodes.

Best Practices
Before Activating, Compare Purchased Sites to Active Stores
If the number of active stores exceeds the number purchased sites, upon license activation stores will be deactivated as needed (oldest stores deactivated first, based on Last Modified Date). To avoid this, before activating licensing, deactivate stores until the number is less than or equal to the number of purchased sites. 
To avoid undesired deactivation of stores: 
1. Review the list of active stores and compare it to the number of purchased sites. 
2. Before deactivating a store, review the list of assigned workstations and re-assign workstations to an active store if needed. To change the store to which a workstation is assigned, drill down to the workstation record (Admin Console > Node Preferences > Node Selection > [Store] > [WS]). On the General tab, enter a Number and select a different Store. (Note: By default, workstations do not have a Number; however, to save edits to the workstation record you must enter a Number.) Save the changes.
3. Next, deactivate individual store records by clearing the Active checkbox in the store record. This will free up site licenses. To access store records, navigate to Admin Console > Node Preferences > Node Selection > [Subsidiary] > [Store].
4. Finally, if needed, activate the desired store records (up to the number of purchased sites) by selecting the Active checkbox in the store record.

Allocate Licensing from Top-Down, De-allocate from Bottom-Up
When allocating sites and seats, allocate from the top down. Be sure to assign enough sites/seats to a POA so that POA can assign sites/seats to any nodes below it (while also reserving one site/seat to the node/POA itself. When de-allocating sites/seats, start with child nodes and then move to the POAs and finally the RA if needed. 
If importing Data using DMT, Import Data before Activating Licensing

If migrating data from legacy V8/V9 to Prism 2.3 using the Data Migration Tool, import data first, then activate licensing and verify correct active stores. If you activate licensing first and then import data, there may be a period of time before licensing ‘catches up' to data that was imported. 
Log Out when Exiting Prism

Log out when exiting Prism. Do not simply close the browser. Logging out ensures the seat license is returned to the pool.
Licensing Security
You can control employee access to Licensing-related tasks using the following permissions. Please note there is not a permission for activating licensing. After installing Prism 2.3 on the RA controller, you should log in to Tech Toolkit and activate licensing using the default sysadmin/sysadmin credentials (no permission needed). After licensing is activated, assign the following licensing permissions to employee groups to control access to licensing.

Permission Description
Licensing - Change Allocation Allow group members to change the allocation of sites and seats among the enterprise's controllers.
Licensing - Deactivation Allow group members to deactivate the licensing for a controller.
Licensing - Disconnect Session Allow group members to disconnect user sessions. Disconnectng the session frees the seat license.

Activate Licensing and Allocate Sites/Seats
This section has information about how to:

  • Activate licensing at the Root Authority (RA) server
  • Allocate sites and seats among the enterprise's controllers

Requirements

  • You must log in to Tech Toolkit as the SYSADMIN user.
  • The Root Authority server must have Internet access over port 443 to communicate with the licensing web site (https://rplicensing.retailpro.com).

About the Client ID# and Product Key/Activation Password
To install Prism and activate licensing, you need the Client ID# and Product Key/Activation Password.  The Client ID# identifies the retailer. The Product Key/Activation Password is automatically generated and linked to the Client ID#.

To Activate Licensing at the RA (Over-the-top install)
1. Install the 2.3 upgrade on the Root Authority (RA) server.
2. Launch Prism using the Proxy shortcut.
3. A prompt is displayed. You can only access Tech Toolkit (or exit).
 Prompt displayed when licensing is inactive
4. Log in to Tech Toolkit as the SYSADMIN user. Upon successful login you will see a screen for entering the Client ID and Product Key (also known as Activation Password). 

  • If you used a generic Client ID and password when installing the Prism server, enter the "real" information for activation and click Validate. 
  • If you used the "real" Client ID/Password during the server install, leave the Client ID and Activation Password fields blank and click Validate.

.
Enter Client ID and Password 

After validation, the page will update to show Licensing information including the Product Key and the maximum number of sites and seats.
7. Click Activate License. 
 Activate license button
A confirmation message is displayed. Click Activate to proceed. 
 Activate license confirmation
8. The activation process may take 20-60 seconds. When finished, the Licensing screen will refresh and show additional options for working with licensing. 
After activation but before allocating sites, seats

What happens if the user activating licensing is assigned to a store that gets inactivated?
A situation that can occur is the user activating licensing is assigned to a store that is made inactivated upon license activation. In that case, the user will be logged out. Upon logging back in to Prism, the user will have access to the Administration Console area only. In the Administration Console, navigate to Node Preferences > Node Selection and edit the active/inactive status of individual stores to the desired state. After the active stores are set, return to Tech Toolkit > Licensing and allocate sites/seats.

Allocate Sites and Seats
After activating licensing at the Root Authority, allocate the sites and seats among the enterprise's subordinate controllers (servers). The controllers in the enterprise are listed on the left side of the screen in Tech Toolkit. 
Allocate sites and seats from the top-down. In our example enterprise, after activating licensing, the Allocations table lists two controllers: RA and its subordinate node POA1. The STR1 node is not directly connected so it is not listed in the Allocations table at the RA; however, STR1 will be listed in the allocations table at POA1.
In the Allocations table below, we can see the enterprise has purchased 10 sites and 50 seats, all of which are currently allocated to the RA.
To allocate sites/seats, select the desired subordinate controller in the Allocations table and click Edit Allocation.
Sample Allocations table before allocating sites/seats:
 Licensing table before allocating sites, seats

If allocating sites/seats to a POA, remember to allocate enough sites/seats to allow the controller to assign sites/seats to any nodes below it. The number of available sites and seats for allocation are displayed below the text boxes.
In our example, we will allocate two sites and five seats to the POA1 controller. Note that even though the RA has 10 sites and 50 seats, in the Edit Allocation modal, we can see that only 9 sites and 49 seats are available for allocation. This is because the RA reserves one site and one seat for itself.
 Allocate licensing from RA
After allocating sites and seats to subordinate controllers, licensing information will be replicated downstream.
In our example, the POA1 controller will allocate sites and seats to its subordinate node: STR1.
Log into Tech Toolkit at the POA and navigate to the Licensing area.
The Allocations table lists the controller and its directly connected subordinate nodes. In our example, the POA1 controller and its directly connected subordinate node: STR1 are shown. Click Edit Allocation.
 POA edit allocations
Note that although the POA has two sites and five seats, only one site and four seats are available for allocation. This is because the POA reserves one site and one seat for itself. Enter the desired number of sites and seats and click the blue check mark. In our example, we will allocate one site and three seats to STR1. 
 POA edit allocation to store
Once licensing has replicated to the STR1, users at STR1 can log in to Prism 2.3.
View Allocation Ancestry
Below the Allocations table is a "View Allocation History" button. Click View Allocation Ancestry to view a hierarchy of license allocations throughout the enterprise. This makes it easier to find and view licensing information for any node in the enterprise.
The information you can view includes:
Starting Controller (the controller at the top of the enterprise hierarchy)
Sites and Seats Available
Sites and Seats Allocated Out
Sample Allocation Ancestry for subordinate (store) node:
Allocation ancestry
Replication of Licensing
Licensing information is replicated downstream from the root authority (RA) to subordinate controllers as part of Core Resources. To ensure smooth replication of licensing, allocate licensing from the top-down (if it becomes necessary to de-allocate licensing, de-allocate from the bottom-up). 
If the RA is on 2.3 but child nodes are on a lower version (e.g., 2.2.1 or lower), those child nodes can still replicate data upstream, but the RA can't replicate data downstream. In practical terms, when looking at the RabbitMQ queues for Day-to-Day replication, you will see messages are being received, but those messages are not consumed by the consumer cache. Once you upgrade the stores to 2.3, RabbitMQ will consume those cached messages.
Priority of Licensing Resource
Resources are processed in order based on Priority. Licensing information is currently assigned Priority of 85.
Replication of Licensing Information to Newly Joined Subordinate Servers
Important! When a server joins the enterprise, that server will not be licensed until BOTH of the following are complete: 

  • The JTE process is complete, including initialization
  • That server's parent has allocated licensing and the licensing has been consumed by the child

Check the progress of licensing replication
Navigate to the Day to Day tab in Connection Manager.
Monitor the Sent/Received/Failed status of the controllerlicense and prismlicensetransmit resources:
D2D licensing

Sites and Seats Check
Sites Check
The number of active stores between all subsidiaries cannot exceed the number of site licenses. For example, if a retailer has a 10-site license and the Active checkbox is already selected for stores 000 through 009 (total of 10 stores), then when the retailer tries to make an eleventh store active, a message explains that no site licenses are available. In this situation, you can inactivate one or more stores or purchase additional sites.
Seats Check

The number of logged-in users at a site cannot exceed the number of seats allocated to that site. For example, if a controller is allocated 10 seats, there can be a maximum of 10 active user sessions. If a user tries to log in when no seats are available, a message explains the maximum number of seat connections has been reached. Users with the required permission can disconnect a session to free up a seat, if needed. For example, there may be one or more "stale" sessions that you can disconnect to free up seat licenses.
If you need more seats, but none are available, other options are:

  • Update licensing allocations by reducing the seat count of a different site first, then increasing the seat count at the desired site
  • Purchase additional seats then update licensing allocations.

Notes

  • If you open a new tab and log in to Prism on that new tab, another seat license is consumed. 
  • If you close the web browser, you will be logged out and the seat license will be returned to the pool; however, best practice is to log out.
  • If you click the Refresh button on the web browser, you will be logged out, Instead, use F5, Ctrl+F5, or Ctrl+R to refresh the browser.
  • No user may enter the Prism web client with an unseated session. The web client logs the user out when it detects an unseated session. 
  • For Centrals authentication, use the PRISM_CUSTOM user and that user will not consume a seat when performing Centrals functions. Any other user, including SYSADMIN will require a seat, and if one is not available when needed, Centrals will give an error. Assign the PRISM_CUSTOM user to a group with permissions to perform the necessary Centrals functions at each location using centrals. 
  • Users with unseated sessions may enter the TTK in certain cases (see the following section). 

TTK Seat Check
Tech Toolkit has special rules to determine whether a log-in consumes a seat license: 

  • Sysadmins: The single SYSADMIN user ("sysadmin" username) can always log in to TTK and perform all operations without taking a seat but will take a seat if available.
  • Users who have the "System Admin" checkbox selected in the employee record can always log in to TTK and perform all operations without taking a seat but will take a seat if available.
  • Admin group members: ADMIN group members can log in to TTK and perform licensing activities only without taking a seat but will take a seat if available. Other TTK activities will require a seat. The ADMIN group is created by the system and should never be renamed.
  • Other groups and users: Users who are not ADMIN group members and do not have the System Admin flag selected but who do belong to a group with the LICENSING - DISCONNECT SESSION permission will have access to the Active Sessions modal to disconnect sessions. Other users always require a seat to log in and the functionality they have access to is dictated by their group permissions.

 


Sessions
Click the View Active Sessions button to view a list of sessions. The number of available seats is shown at the bottom of the screen.  
There are four ways to disconnect a session:

  • Log out.
  • While viewing active sessions, highlight a session and click the Disconnect button.
  • Close a tab on the web browser
  • Click the Refresh button on the web browser

Important! If you forget to log out, that seat license will continue to be consumed until a user manually disconnects the session. Best practice is to always log out when you are finished using Prism. 
Sample sessions list:
view active sessions

Removing a Server from the Enterprise
If you remove a subordinate node from the enterprise, that node's allocated sites/seats will be returned to its POA. 
When viewing licensing allocations at the POA, there will be a button labeled 'View Orphaned Allocations.' 
At the POA of the removed server, navigate to the Licensing area. Below the Allocations table click the View Orphaned Allocations button. A list of all orphaned allocations is displayed. Each row lists a former controller and its former allocations.

  • If you were to insert that node back into the same position in the enterprise, that node would automatically be reassigned its previous sites/seats (removing them from Orphaned Allocations). If you do NOT plan to re-insert that node back in the same position in the enterprise hierarchy, you can re-claim those licenses for the POA. 
  • If you do not plan to re-insert the node into the enterprise and instead want the POA to claim the allocations, select the desired Controller Name and click Claim Allocations. When you click Claim Allocations, the allocations are returned to the "Available" list for the POA to allocate as needed.

Sample "Orphaned Allocations" screen:
orphaned allocations

Extend Licensing
More Options > Extend Licensing
The Extend Licensing feature provides retailers with a way to extend an expired Software Subscription by 10 days by entering a key code issued by Technical Support. Obtaining a temporary license key code from Technical Support is sometimes needed to keep the enterprise up and running when normal license synchronization is unavailable due to natural disasters or other events. The temporary license only considers the Software Subscription date. The expectation is that the retailer will extend the Software Subscription Expiration Date using standard procedures in the Retail Pro licensing web site and synchronize licensing before the end of the 10-day period.
Select More Options > Extend Licensing. Copy and paste the new key code into the text box. Click OK.

Deactivate Licensing
Deactivating licensing will take the enterprise down. In general, only deactivate licensing at the direction of Technical Support. A possible use case for deactivating licensing is if you need to replace the RA server or make a major change to the RA server.
At the RA controller, navigate to the Licensing area. Click More Options and select Deactivate License.
 Deactivate license confirmation
Hardware Signature must Match Signature in OPS to Deactivate
You cannot deactivate licensing if there is a mismatch in the current hardware signature on the machine and the hardware signature as known by RPLicensing web site. If a machine crashes and you build another machine from a backup, you must first synchronize/reactivate licensing.
Sessions
Click the View Active Sessions button to view a list of sessions. The number of available seats is shown at the bottom of the screen.  
 There are four ways to disconnect a session:

  • Log out.
  • While viewing active sessions, highlight a session and click the Disconnect button.
  • Exit the Prism Proxy.
  • Close the web browser.

Sample sessions list:
View active sessions
  
 
PRISM_CUSTOM user
Prism includes a special internal user (PRISM_CUSTOM) that is used by customizations. 
The internal user: 

  • Has EMPL_NAME of CUSTOM
  • Is added to Prism as part of the install process if the user does not already exist.
  • Has default login credentials of . The default password can be changed. 
  • Can only have its password changed and be assigned to a group. Otherwise, is not editable.
  • CANNOT be deleted but can be inactivated.
  • CANNOT have its information purged with the PII removal tool.
  • CANNOT login from the Prism web client.
  • When logged in (via API) will NOT take a seat.
  • When logged in (via API) will have whatever access is provided through permissions and other system settings (i.e., sysadmin flag in Employee record). if you have multiple customizations, you will have to give the internal user ALL the permissions needed by all the customizations. There is not a separate internal user for each customization.
  • In Prism, employees are their own type of record but are also a subset of customer records. The CUST_TYPE flag indicates if the customer is also an employee. The PRISM_CUSTOM user has a corresponding PRISM_CUSTOM customer record (with the CUST_TYPE flag selected. The PRISM_CUSTOM customer record enables the PRISM_CUSTOM user to assign Home Subsidiary, Home Store, Store Assignments, Permissions, etc.

Seat Requirements for Plugins/Customizations
Some external tools consume a seat license. Refer to the following table.

Plugin Consume Seat License?
EFT No.
Adyen No.
Biometrics N/A
Accounting Link No. Accounting Link version 2.3.0.1 is compatible with Prism 2.3
AppCard Yes.
RP Companion Yes.
Prism iOS App Yes.
Doc Designer No.
RabbitMQ No.
API Exp[orer When using the PRISM_CUSTOM user, no seat is consumed. Other users require a seat.
Property Management Link (PML) No.
PRISM_CUSTOM No (when logged in via API)

Logs for Licensing Activities
Click More Options and select View Licensing Logs.  
A list of recent log messages is displayed. At the top of the log are controls for:

  • Converting store SIDS to Store Names 
  • Showing all events or only errors and warnings.

Sample Licensing Log:
sample licensing log
Licensing Information
The Licensing area displays licensing-related information. The Licensing area includes a Show More Details/Show Less Details toggle button to show/hide some of the fields. Refer to the following tables:

Field Description
Client ID The Client ID# identifies the retailer in the licensing database. The Client ID# is assigned automatically when the client record is saved. 
Activation Key The Activation Key is automatically generated when the client record is saved. 
Activation Count Each time licensing is activated, the Activation Count increments.
Max Activations A maximum of four activations are allowed.
Activation Date The date licensing was last activated.
Global Expiration Date The date that, when reached, sets the installation to an inactive state. Beginning 10 days before the expiration date, users will see a warning message when logging into Tech Toolkit; beginning five days before expiration, users will see a warning when logging into POS.
Purchased Sites Number of site licenses purchased.
Purchased Seats Number of seat licenses purchased.
Active Session Count Current number of active sessions across the enterprise.
Licensing Host License server.
Licensing Port PrismLicenseAgent.exe communicates with the Licensing Host on port 80.
Last Sync Date of the last license synchronization with the RPLicensing web site.
Max Store Count Maximum number of stores. This may be different from the maximum number of sites because some site licenses may be used strictly as a "point of authority."
Software Subscription Expiration Date Software Subscription expiration date.
Licensing Activated By The employee who activated licensing.
Last Modified By The employee who last made a change to licensing or license allocations.
Last Modified On The date licensing was last modified.
Licensing Controller Sid N/A
License Info Sid N/A

Sample Licensing Information:
Software subscription information