Prism Tech Toolkit
Note: A new version of the Prism Toolkit was introduced in 1.14.7. The information in this topic will be updated to include information on both the 1.14.7 version and the prior version. Check back later for updates.
Prism 1.14.6 Tech Toolkit
The Tech Toolkit includes a number of tools to facilitate administration and configuration of Prism:
- Log Viewer to view logs from a central portal
- Service Manager to start/stop/configure services
- System Information to get information about the host system, including Prism version
- Scheduler for scheduling tasks
- SSL Manager to install and manage SSL certificates
- Data Utilities (Inject Postal Codes for US and Canada into the database)
- Reconfigure Host Computer to do necessary reconfiguration when changing the name of a machine that has Prism installed
- Tool Dashboard for launching tools like Document Designer and Image Exporter)
Launch the Toolkit
The executable for the toolkit, TechToolkit.exe, is installed to: …\Program Files (x86)\RetailPro\TechToolkit folder. You can manually launch the TechToolkit.exe from this folder, if desired or use the shortcut automatically installed to the desktop when you install the Prism server. By having the toolkit as a separate .exe from Prism, an administrator can have both Prism and the toolkit open at the same time. Important! To start/stop services from within the toolkit, you must right-click the toolkit shortcut and select "Run as Administrator."
The following table provides information about the navigation buttons on the toolkit UI.
|View system information.|
|Access Log Viewer.|
|Access Enterprise Manager.|
|Access Service Manager.|
|Access SSL Manager.|
|View task information and schedule new tasks to run at regular intervals.|
|Inject postal code data for US and Canada into the database.|
|Reconfigure Host Computer. Use this tool to do the necessary reconfiguration when changing the name of a Prism server machine.|
|Launch Document Designer.|
|Launch Code Site Viewer.|
|Access Tech Toolkit preferences.|
|Access Connection Manager.|
The Service Manager area of Tech Toolkit makes it easier for technicians to access the services used by Prism. In the Service Manager area of Tech Toolkit, you can start and stop services, view info about dependencies and change configuration settings. Previously, users had to navigate to each file individually via Windows Explorer (e.g. to change log settings for multiple files).
Make sure "Default (local machine)" is selected in the connection drop-down
Select Tools > Service Manager from the menu.
Select the desired service from the list.
Details for the service are displayed. You can start or stop the service, if needed.
Prism Service Manager:
Start/Stop Services and Prism
You can start and stop individual services, or all Prism services using the following UI buttons:
|Start the currently selected Prism service.|
|Stop the currently selected Prism service.|
|Refresh the display of services.|
|Start all Prism services in order.|
|Stop all Prism services in order.|
|Restart all Prism services.|
|Set Global logging options for the service.|
Track Additional Services
The Scheduler Service has its own set of preferences that enable you to add non-Prism services to the list of services that can be monitored using the Scheduler Service.
Select Toolkit > Preferences from the Tech Toolkit menu.
Select Service Manager.
Click the checkbox for Track Additional Services.
Select the desired service from the drop down.
Click the Add button. The service is added to the list of services being tracked.
(Optional) You can select to have Prism automatically start, stop, or restart the database and RabbitMQ services whenever a user starts, stops, or restarts Prism.
Track Additional Services preference setting:
Click the System Info tab to display information about the user's system. This can be useful for troubleshooting and ensuring the system meets RP Prism System Requirements.
|Machine Name||Name of the host or virtual machine.|
|Operating System||Operating system installed on the machine.|
|OS Details||OS version and build information.|
|OS Version||Operating system version (e.g. Windows 10).|
|OS Architecture||OS architecture (e.g. intel x64)|
|OS Platform||OS Platform. (Currently Windows is the only supported platform)|
|OS System Path||Path to the OS system files.|
|CPU Name||Name of the processor being used.|
|CPU Speed||Processor speed. For example, a reading of 3392 indicates a processor speed of 3.4 GHz|
|CPU Count||Number of CPU cores on the system.|
|CPU Architecture||CPU Architecture (e.g. x86).|
|CPU Identity||Additional information that identifies the manufacturer of the processor.|
|CPU Revision||Revision number of the processor.|
Hard Disk Information
|HD Space||Amount of hard disk space on the system (in kilobytes)|
|HD Space Available||Amount of hard disk space currently available.|
|HD Type||Hard Disk type (e.g. Fixed Disk).|
|HD File System||Hard Disk file system type. Currently NTFS is the only file system supported.|
|HD Volume Name||Hard Disk volume name.|
|Memory Total||Amount of total RAM on the system.|
|Memory Available.||Amount of RAM currently available.|
|Memory in Use||Percentage of the total RAM that is currently in use.|
The Prism Tech Toolkit includes a built-in log viewer that gives technicians easy access to all Prism-related logs to review and update settings (ex: set all log levels to zero post Prism deployment in order to boost performance).
- EFT Service Module
- License Server
- Prism Back Office
- Prism Common
- PrismMQ Service
- Prism Resiliency Server
- V9DRS PubSub
- Select a Log File Type from the drop-down.
- In the displayed list of logs, double-click a log, or select the log and click the Open Selected File button. . The log entries are displayed in the text window below the list.
Sample Log Viewer
The Tech Toolkit Scheduler is a user interface to the Retail Pro PrismSchedulingService. The PrismSchedulingService is a Windows service that runs in the background and executes tasks defined in Scheduler. Tasks are API processes, technically termed "actions," which perform specific functions.
The Scheduler user interface in Tech Toolkit enables users to adjust the timing and other settings of the currently defined tasks. End users cannot add new tasks to Scheduler at this time other than by doing do from Prism, e.g., by creating a new Markdown. The main use for the Scheduler UI in Tech Toolkit, is to provide an easy way for users to adjust the settings of existing scheduled tasks such as time of day to run, interval/how often (daily, every other day), or to turn a task off.
Key Uses of Scheduler UI in Tech Toolkit
- Adjust default settings of tasks to better match business hours, data loads, or other factors
- Check the success or status of specific scheduled tasks
- From time to time, delete once-only tasks that have successfully run
Prism Scheduler currently schedules and runs the following predefined tasks:
|Customer History Daily Process||This process repeats every 15 minutes. It generates Customer History records from POS transactions and customer orders.|
|Customer History Initialization Process||This is a one-time operation set to run during the night after the new CH feature is first installed. This process generates CH records from past transactions. After that, the CH Daily process is responsible for generating CH records as customer transactions are created.|
|Purge Scheduled Task Run Records||This is a system housekeeping task that clears out past task run history records based on the value in DaysOfRunHistory field in each task record. A value of 0 means keep all task run records. A value greater than 0 means keep only the most recent
|Update Active Season||This task updates the Active Season, if needed, based on the date range for Seasons defined in Prism preferences. The Active Season is used for seasonal pricing and is displayed in Subsidiary and Store records.|
|Cleanup PI Sheet||1) PI Sheet results will show a 'Creation' status(to give info about creation of new PI Sheet only) column with these values : Completed, Failed, Pending(shows Spinner)
2) If there is pending PI Sheet to be created, that PI Sheet can't be selected in the grid and no further actions are possible unless the PI creation is completed or failed
3) Inactive PI Sheets can be deleted from UI, new 'Delete' button is added to button bar. [Only Inactive PI Sheets can be deleted - Behind the scene deletion process is actually handled by the scheduler-TTK, in UI it just filters out PI Sheets which are marked for deletion]
4) If the new PI Sheet creation is failed then it would be made inactive and shows the PI result grid
Add New Task
- In the Tech Toolkit, click the Scheduler button. If a log is displayed, enter your Prism login credentials.
- The Schedule interface is displayed.
- Click Add Task. In the cells of the table, enter Task Details, such as a Name and Description, Start and End Date, Start and End Time, etc.
- Once you click out of the row, the record is saved and any further edits must be made in Form View.
- With the task selected in the list, click Open Form View (or use the right-click option).
- Edit details as needed. The edits are saved automatically. Click Close when finished.
Sample Task Form:
Refer to the following table for information about the available settings.
|Start Date||Day and time the task will start.|
|End Date||Day and time the task will end, If null then no end date.|
|Start Time||Start time for the time frame that the task can be run.|
|End Time||End time for the time frame that the task can be run.|
|Active||True if the task should be run currently. Inactive tasks will not be run.|
|Task Run Interval||(OneTime, Daily, Weekly).|
|Recur Every||Recur Every is based on Frequency, For instance if set to Daily and Recur Every is 1 the task will run every day, If set to 2 the task will run every other day.|
|Repeat every n||Repeat every N Seconds or Minutes.|
|Timeout (seconds)||Number of seconds to wait for service to start. Default 60 seconds. 0 means wait forever, -1 means do not wait at all, Positive integer is how many seconds to wait.|
|Days of the Week||(weekly tasks only) Seven-character string of zero or one. specifying SMTWTFS zero being false and 1 being true. Only applicable to Weekly schedules.|
|Max Retries on Error||Tells the Scheduling service to set a task to not active if it throws consecutive < MaxRetries # > errors. User can re-set task to active and execution cycle will attempt again. If Max Retries is null or 0, it is ignored by Scheduling service.|
|Days of Run History||If > 0, it tells the Scheduling service to keep only
|Workstation||Must be populated only for some tasks whose action requires a workstation "sit", such as price manager actions. Otherwise, can be left blank. However, if populated for a task that does not require it, the workstation populated must be valid otherwise the task will not run.|
|Action URL||Action URL with parameters.|
|Action Payload||If required, a JSON CLOB for the request payload.|
|Task Edit/Delete||Default = OK Edit No Delete.|
|Task Type Code||Four-character alpha-numeric free-form field to allow users to group or filter tasks. For example: PM for price manager or PMM for price manager markdown. Or, SYS for system. Currently grouping and filtering has not been implemented in the UI but will be in later release as more tasks get added to the Scheduler.|
|Public flag||If selected, only Public schedules will be replicated.|
On the bottom of the Scheduler UI is a toolbar with buttons for navigating back and forth from one task to another. Click the Lock icon to lock the task name.
Right-click to Open Form View
When viewing the grid, you can right-click on any field and select Open Form View to view the task in Form View. Form View is usually more convenient for editing tasks.
Add Non-Prism Services via Scheduler Preferences
The Scheduler Service has its own set of preferences that enable you to add non-Prism services to the list of services that can be monitored using the Scheduler Service.
- Select File > Preferences from the Tech Toolkit menu. Select Service Manager on the left.
- Click the checkbox for Track Additional Services.
- Select the desired service from the drop down.
- Click the Add button. The service is added to the list of services being tracked.
- (Optional) You can select to have Prism automatically start, stop, or restart the database and RabbitMQ services whenever a user starts, stops, or restarts Prism.
You can modify the Scheduling Service's configuration file (SchedulingService.ini) by editing the file in a text editor or in the Service Manager area of the Prism Technician's Toolkit.
By enabling the Auto-Refresh option, a user can view task status in real-time. The task's TaskRun record will be refreshed with execution progress at the interval selected by the user: Every 10, 15, 30 or 60 seconds
The task will display the current status and a processing update message in the Task Run grid. This helps avoid situations where a user is looking at stale information on the Task Run grid.
To enable auto-refresh, click the drop-down arrow on the Auto-Refresh UI element, located at the bottom of the screen. You can select to refresh All tasks or One task.
- All = Refresh all tasks and task run data.
- One = Single task manual refresh or set task to auto-refresh.
The UI will show the current Auto-Refresh setting, on or off.
From the displayed pop-up menu, select the desired interval: 10, 15, 30 or 60 seconds.
The Status field displays the current status of the scheduled task.
Holds the tasks current task status. Possible values are:
0 - Running
1 - Idle
2 - Error
3 - Scheduled (meaning not yet run).When a new task is added, it will show as Scheduled until such time as it runs. When the task completes, it will show as "Completed" if it is a OnceOnly task, otherwise it will show as "Idle." The ScheduleTaskRun record holds more status detail on the last execution of the task.Duplicate Multiple Tasks
The Duplicate Multiple Tasks setting enables you to control what happens when multiple task records attempt to run the same action url simultaneously (at the same or overlapping times).
Possible values are:
0 - BlockWaitRun
1 - BlockDeactivate
2 - BlockDelete
3 - Allow
After you receive the SSL certificate(s) from the certificate authority (CA), you need to install the certificates using the SSL Manager in Tech Toolkit. Copy the certificate files from the CA to a folder where they can be accessed by SSL Manager. You will also need the private key file (.key) that was generated as part of the certificate signing request.
Launch Tech Toolkit from the desktop shortcut and log in. Use the right-click "Run As Administrator" option.
Select the desired server from the Current Connection dropdown.
Click the SSL Manager button.
Click Select Certificate. Browse to the location of the certificate (.crt) file.
Click Select Key File. Browse to the location of the file that contains the private key.
Click Update Prism Config.
Sample SSL Manager interface:
Revert To Unsecured
Tech Toolkit's SSL Manager creates a backup of both the prism.conf and rabbitmq.config files before applying SSL changes. If there is a problem with the SSL configuration, click the Revert to Unsecured button to reapply the backed up configuration (prism_backup.conf).
SSL Manager check of Prism Components
The SSL Manager will detect which Prism components are on the machine: Prism Server, RabbitMQ, and/or the Prism Proxy.
- If Prism Server is on the machine, the SSL Manager will modify the prism.conf file to apply the certificates.
- If RabbitMQ is installed, the SSL Manager will modify the rabbitmq.config file.
- If the Proxy is installed, the SSL Manager will apply the certificate file names to the Proxy.ini file.
Once the certificates are applied, the SSL Manager will alert the user to restart Apache or RabbitMQ as needed. If the proxy is being secured, that will also need a restart. The CA cert is only required for configuring RabbitMQ. There is a RabbitMQ checkbox; if checked, this enables the CA Cert file to be applied. If unchecked, this field is disabled. If RabbitMQ is not installed, the checkbox and CA Cert fields are disabled automatically.
Sample PrismProxy.ini file:
The Data Utilities area has small tools that clean up or alter the Prism data structure. Currently, the only data utility available is the Postal Code Injection utility. This data utility will populate the database with US and Canada postal codes for use with the Prism Postal Code Lookup feature. Populating the database with ZIP Code data takes one to two hours. Plan accordingly.
Before you can run the Data Utilities tool to populate the database with ZIP Code data, you need a database connection (not a REST connection). Add a new connection or edit an existing connection so that the Type field is set to "Database."
Click the Data Utilities button.
The UI is displayed.
Click Execute. There is a timing warning. Click Execute. Go away for a while will take between 1 and 2 hours depending on several factors. Once completed there is a message dialog indicating the data has been injected.
Once postal codes have been injected, you can use the Postal Code Lookup feature by enabling it in Admin Console > Preferences & Settings > System > General
Reconfigure Host Computer
This section has information about required steps and reconfiguration when renaming a computer that has Prism installed. These special steps and reconfiguration ensure the machine can rejoin enterprise using the new name. Use the Reconfigure Host Computer tool in the Tech Toolkit to do the necessary reconfiguration.
- The process described in this topic 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.
Check Enterprise Connections and Leave the Enterprise
Launch TechToolkit.exe from the desktop shortcut using the right-click "Run as Administrator" option and log in.
Select your machine from the "Current Connection" drop-down.
Click the Enterprise Manager button. Log in if prompted.
Click Leave the Enterprise. (Note: If a password was defined for the connection, you will be prompted to log in again.)
Change the computer name using Windows System Properties
The interface and steps to change the computer name in Windows System Properties will vary depending on your version of Windows.
(In Windows 10)
Navigate to the Control Panel > System and Security. In the System area, click "See the Name of this Computer."
In the Computer name, domain, and workgroup settings area, click Change Settings.
In the System Properties modal, click the Computer Name tab. Click the Change button.
Enter the new name. Click OK.
VERY IMPORTANT: After renaming, you will be prompted to restart the computer. DO NOT RESTART the computer when prompted by Windows. Instead return to the Reconfigure Host Computer tool and continue the renaming process. DO NOT RESTART THE COMPUTER!
Run Step 1 of the Reconfiguration Process
You must log in to the computer with the credentials of the user that installed Prism and RabbitMQ. If Prism was installed by a different user than RabbitMQ, log in as the user that installed RabbitMQ.
In Prism Tech Toolkit, click the Reconfigure Host Computer tool button.
Notice that the Reconfiguration Process combo box is not set yet.
Select Step 1 from the Reconfiguration Process combo box. When you select "1" in the combo box, additional fields are displayed on the right. In the New Computer Name field, enter the new name for the server. This must match the computer name you entered in Windows System Properties. In the Prism Database Type field, select the type of database that is installed on the machine that is being renamed: Oracle or MySQL
Click the Start Reconfig Process button.
Step 1 takes only a few seconds to run. Near the end of Step 1, an error message will display, informing you that the connection to RabbitMQ has been lost. Ignore this message. The process stops RabbitMQ on purpose. The computer will reboot automatically.
After reboot, re-login as the same user.
After login, a program immediately launches to complete RabbitMQ reconfiguration. This process takes several minutes to complete. A progress form will display the actions being taken and provide Step 2 instructions at the end.
Run Step 2 of the Reconfiguration Process
Step 2 updates Prism tables with the host's new name. This step must be run before using Prism and before rejoining the enterprise. Make sure all other applications are closed and then launch Tech Toolkit and log in.
In the Reconfiguration Process combo box, select "2".
Press the Start button. The process should take less than one minute; however, various services are stopped and restarted and on some systems this may take longer. If Step 2 takes longer than one minute you may receive a time-out error message. If you receive such a time-out error, click OK and then wait 15 seconds. Next, check the Enterprise Manager tool in the Tech Toolkit. You should see the updated server address for the Controller record.
Rejoin the Enterprise
Rejoin the host computer to the enterprise (Note: If the host has any subordinate servers, rejoin those subordinates to the host first).
Post Process Considerations
Regenerating SSL Certificates
If Prism or RabbitMQ are using SSL, their certificates must be regenerated after the rename process completes. After regenerating the certificate for Prism, you may use the Prism Tech Toolkit SSL Manager to apply the new certificate.
Updating Retail Pro License
If Retail Pro RIL (or Retail Pro 9) is installed on the machine, you will need to contact Retail Pro to update that license because the license is based, in part, on the computer name.
The Tools area of the Tech Toolkit gives Prism users a convenient way to access tool such as Document Designer and V9ImageExporter. Click the button for a tool to immediately launch the tool (Login required). Note: The Code Site button is only active if you have installed CodeSite and activated CodeSite in the Workstation record.Add a Tool to Tools Menu
You can add third-party tools to the Tech Toolkit Tools menu. This provides the same convenient access to all needed tools. For example, an administrator might want to add a link to a network analysis tool.
- Click the Add button. In the displayed dialog, enter a caption for the tool and then click the ellipsis button to browse to the application location. Click OK when finished.
- The tool is added to the "User Tools" section.
Edit or Delete a Tool
Right-click on the tool icon and select edit or delete.