Professional Documents
Culture Documents
Installation Manual
Copyright Notices and Disclaimers
Cat® MineStar Health - Technician Toolbox and its related written manuals and documentation are © 2021
Caterpillar. All rights reserved. No portion of these works may be reproduced, in whole or in part, for any pur-
pose, without the express written permission of Caterpillar. CAT, CATERPILLAR, LET’S DO THE WORK,
their respective logos, “Caterpillar Yellow”, the “Power Edge” and Cat “Modern Hex” trade dress as well as cor-
porate and product identity used herein, are trademarks of Caterpillar and may not be used without per-
mission.
Microsoft Windows is registered trademarks or trademarks of Microsoft Corporation in the United States and
other countries. Other third-party product names used herein may be the trademarks of their respective own-
ers.
Technician Toolbox and its related written manuals and documentation contain copyrighted content owned by
third parties which has been used under license from those third parties. Use of Technician Toolbox is subject
to the terms, conditions, limitations and disclaimers that apply to all third party-content contained herein.
Information in the document is subject to change without notice. Companies, names and data used as
examples herein are fictitious unless otherwise noted.
The user must be alert to potential hazards. He should also have the necessary training, skills and tools to per-
form these function properly.
Safety precautions and warning are provided in the instruction and on the product. If these hazard warnings
are not heeded, bodily injury or death could occur to you or to other persons. Caterpillar cannot anticipate
every possible circumstances that might involve a potential hazard. Therefore, the warnings in publication and
the warning that is on the product are not all inclusive. If a tool, procedure, work method or operating technique
that is not recommended by Caterpillar is used, ensure that is safe to use. Also check that the product will not
be damaged or made unsafe by the operation, lubrication, maintenance or repair procedures that are used.
Contents
Copyright Notices and Disclaimers 2
Contents 4
Introduction 6
Pre-installation Introduction 12
Database Backup 27
Connecting to a Machine 39
Serial Connection 41
Ethernet Connection 42
Troubleshooting 43
Files are not moving from an unmerged folder for a long time and the status of the files reflects 'Yet
to Merge' 46
Update Issues 48
Glossary 61
It is important to follow the navigation in the manual for the correct order of installation.
Software Version
MongoDB 3.4.6
Redis 3.0.503
NodeJS 10.16.0
Angular 4.3.6
Electron 1.6.11
CURL 7.54.0
For detailed information about license subscription and download portal access, please refer to below link:
https://dealer.cat.com.
Pre-installation Introduction
The section explains what you are required to do before starting your installation. Pre-installation tasks pre-
pare your computer for installing all of the software required by Technician Toolbox, as explained in the
manual.
Note: If Technician Toolbox is already installed, then it is necessary to uninstall before upgrading to
the new version.
Technician Toolbox
Standby Application System
Product
Compatible
Note:The account used to install Technician Toolbox on a computer needs Administration privileges.
The Technician Toolbox, VIMS Converter, Health Data Visualization and VIMS Forwarder applic-
ations cannot be installed on the same computer.
Note:The User Access Control pop-up displays based on the settings selected in Control
Panel.
3. The User Access Control pop-up displays. Click Yes to begin with the installation.
4. The License Agreement screen is displayed with Software End User Agreement.
5. If a valid software subscription purchase agreement has been entered in to, select I accept the agree-
ment and click Next.
6. The Ready to Install screen is displayed to view the settings before installing the Technician Toolbox.
Note: The installation process will get paused if clicked anywhere on the command prompt.
8. The Installation Checklist screen is displayed. After installation, the installer checks if the installed ser-
vices have been successfully started or not. The below Installation checklist displays the status of the
services.
Note: If any of the services did not start as expected after installation, the following screen is
displayed:
9. Click Next. After installation is completed, Completing Technician Toolbox Setup Wizard screen is dis-
played.
Application Folder:
The folder contains the executable and library files for Technician Toolbox.
The folder contains user data such as unmerged, export, empty, backup, backupdb, corrupt, SyncedToCAT
and log files shared among all users of the PC.
The folder contains Technician Toolbox master database files shared among all the users of the PC.
Note: Technician Toolbox can only be accessed by user with CWS account and Internet connection
for first time. A valid CWS account is required to log in theTechnician Toolbox application. Refer for
assistance with creating a CWS account, contact your local Cat Dealer. Refer to New User Creation
Manual for more information on creating new CWS ID.
To access the Technician Toolbox application, follow the steps outlined below:
4. Enter Username and Password in the respective fields, and click Login.
Note: If there is invalid or no CWS account for the user, then contact your dealership to activ-
ate the account.
5. When first time Technician Toolbox is logged in, the Acceptable Use Policy is displayed. After review-
ing the agreement and policies, the acceptance of policy is required to continue to the Technician Tool-
box
6. The Technician Toolbox home page appears. The following Dashboard page is displayed.
Note: The system should have Internet connectivity to log in the Technician Toolbox. Once
logged in, the login credentials are valid for 30 days. If the validity fails, then the user should
login again to access the application.
Note: The following Alert pop-up appears, when user launches the Technician Toolboxafter 30
days of login:
Database Backup
Before downloading and installing the upgraded version of Technician Toolbox, user should take the backup of
files available in the tool's database.
1. Select Settings at the upper right corner of the Technician Toolbox home page.
2. The Settings page appears. Select Manage Database from the settings page.
Note: The Machine Connection tab is the default landing screen of Settings option.
4. The Backup and Restore page appears. Click Backup to take the backup of current database.
9. The backup file will store in the following location by default: User-
s\Public\Caterpillar\TechnicianToolbox\backupdb.
10. In Restore section, the directory path specifies the folder location of saved database backup. The list
of backups available in directory path are displayed as table with timestamp and directory path. Refer
to Manage Local Database topic of MineStar Health Technician Tool help for more information
about restore process.
Case #1
Issue in Redis service - A pop-up message appears when the Redis cache service is already running for
other applications.
Solution #1
If Status shown is running, then first contact your System Admin for local IT issues. For further assistance to
continue the installation procedures, contact Product Support team (CatDigitalSupport@cat.com).
Case #2
Issue in Mongo DB - A pop-up message appears when the Mongo DB service is already running for other
applications.
Solution #2
If Status shown is running, then first contact your System Admin for local IT issues. For further assistance to
continue the installation procedures, contact Product Support team (CatDigitalSupport@cat.com).
Case #3
Issue in IP Window services - A pop-up message appears when the IP window service is already running
for other applications.
Solution #3
l Serial Connection
l Ethernet Connection
Different hardware utilizes different connection cables and methods, as shown in the table below.
Connection Cable
Compatible ECM ECM Part Number Connection Method
Part Number
Serial Connection
Serial connection utilizes the serial port on laptop or USB port through a USB-to-Serial adapter for com-
municating with the machine. Technician Toolbox must be configured to use the correct communication port
for connectivity. The port is set to COM1 for connectivity by default. You are allowed to change the port, if
necessary. Refer to Machine Connection topic of MineStar Health Technician Toolbox help within tool
for more information about connection settings and its serial connection.
Ethernet Connection
Ethernet connection utilizes the ethernet port on laptop or USB port through a USB-to-ethernet adapter for
communicating with the machine. Technician Toolbox must be configured to use the correct communication
port for connectivity. The port will not have any adapter selection by default after installation and user is expec-
ted to select the appropriate adapter from Settings page.
However, the laptop can be used in the field as well as in the office without changing the Settings of physical
network card.
Note:The connected ECM and IP address of the PC should be in the same network.
Refer to Machine Connection topic of MineStar Health Technician Toolbox help within tool for more
information about selection of physical adapter.
Troubleshooting
Installation not successful
Cause #1
Several factors can cause this condition. Other processes or programs may be using lots of system
resources, leaving insufficient resources for the installation to complete as normal.
Solution #1
Open the Windows Task Manager and examine the figures shown on the Performance tab. If the CPU is run-
ning at 100%, the system is probably just very busy and you should leave the installation to complete in its
own time. It is unusual for the system to be at 100% CPU for very long unless something very resource–
intensive is running. If something else is using a lot of resources, consider running the installation at a later
time. If no processes are known to be running and nothing obvious shows up when checking, it may be
prudent to run a virus scan to determine if a virus has made its way into the system.
Cause #2
Solution #2
Check that you have sufficient disk space to complete the installation. If there is no enough disk space avail-
able to install the Technician Toolbox, a message will display telling how much disk space you need to free
up. Once enough disk space has been made available, begin the installation again.
Cause #3
Solution #3
The system may hung or become unstable. Check for other programs that are still running and responding.
Click Applications tab of the Task Manager to see whether any programs have a status of Not Responding. If
any applications are not responding, then close them and see if the installation process continues. If not, you
may have to exit the installer and try again after the system resumes.
Cause #4
Solution #4
Check whether the IP window services are uninstalled properly. At some instances, the IP window service
might not get uninstalled fully due to system restrictions during uninstallation of Technician Toolbox. If IP win-
dow services are not installed properly, manually stop the services with the help of Admin rights and re-install
Technician Toolbox.
Note: Contact your System Admin for local IT issues. For further assistance to continue the install-
ation procedures, contact Product Support team (CatDigitalSupport@cat.com).
Cause #1
Issue in Mongo DB services - The application does not launch and user gets splash screen for a long time.
Solution #1
Files are not moving from an unmerged folder for a long time and the
status of the files reflects 'Yet to Merge'
Cause #1
Solution #1
Update Issues
Cause #1
Solution #1
Uninstall the .exe file of the Technician Toolbox from control panel. Reboot the computer and install the latest
version.
2. It was able to connect to A5 ECM but did not display data on the status page, real-time parameter page
and could not update the VIMS configurator.
Cause #1
The system in which the Technician Toolbox application was installed had an active firewall (Windows
Defender) which prevented it from receiving UDP traffic. Windows Defender was enabled while the SEP fire-
wall was disabled. Windows Defender has rules that block Technician Toolbox on public networks and this
instance was detected by the firewall as a public network and caused the issue.
Solution
There are firewall rules that block incoming UDP traffic from OpenJDK and Node.js. This can be fixed by chan-
ging the firewall rule to allow traffic from OpenJDK and Node.js. ECM connection will be possible once the fire-
wall rule is changed.
Note: There are no changes made to the Technician Toolbox application and it can establish a con-
nection with A5.
1. In Windows search, enter Windows Firewall and click Open of Windows Defender Firewall with
Advanced Security.
3. The Windows Defender Firewall with Advanced Security screen is displayed. In the left pane, click
Inbound Rules.
4. The Inbound Rules are displayed. Double-click the Node.js: Server-side JavaScript.
Note: These steps must be performed for OpenJDK Platform binary as well, if the
Action column is Block.
5. The Node.js: Server-side Javascript Properties screen is displayed. Under Action, select Allow the
connection option.
Cause #1
The parameter values are not displayed on the Status page, though Technician Toolbox successfully con-
nects with the Electronic Control Module (ECM). This is because SEA (Data Acquisition System) is not
installed.
Solution #1
The issue can be fixed by installing SEA (Data Acquisition System Installation) and re-flashing the ECM.
After making these changes, the values will be displayed on the Status page when the Technician Toolbox is
connected to the ECM through serial connection.
Note: The account used to uninstall Technician Toolbox needs Administration privileges. The user
should backup the files from tool's database, before uninstalling an upgraded version of Technician
Toolbox.
Note: If Technician Toolbox is already running, then the below pop-up message appears :
Note: The following pop-message is displayed, if some elements of the Technician Toolbox
cannot be removed:
Glossary
CURL
It is a computer software project providing a library and command-line tool for
transferring data using various protocols.
Datalogger
VIMS File which records data for a duration of 1 hour at a frequency of 1 second.
ECM
The Electronic Control Module (ECM) is an embedded system that controls the
aspect of the machine, such as temperature and pressure sensors.
Ethernet Connection
Ethernet Connection utilizes the Local Area Network (LAN) to connect with the
Electronic Control Module (ECM)for communicating with machine.
Loader payload
VIMS file which records the payload information of a loader. This provides user
the cycle details of a loader like the buckets count, number of passes, fuel used,
etc.
MongoDB
MongoDB is a cross-platform document-oriented database program.
Redis
Redis is an in-memory data structure project implementing a distributed, in-
memory key-value database with optional durability.
Serial Connection
Serial connection for connecting the serial port on laptop, or USB port through a
USB-to-Serial adapter to communicate with the machine.
Spring Boot
Spring Boot is an open source Java-based framework used to create a micro Ser-
vice.
Truck Payload
VIMS file which records the payload information of a truck. This provides user the
cycle details of truck such as payload carried in each cycle, fuel used, duration of
each cycle state, etc.
USB
Universal Serial Bus (USB) is common interface that enables communication
between devices and a host controller such as personal computer (PC).
VIMS
Vital Information Management System (VIMS) is a powerful tool for machine man-
agement that provides operators, service personnel and managers information
on a wide range of vital machine functions.