Professional Documents
Culture Documents
Caterpillar Inc.
Certain parts of this document and the information herein are the property of Caterpillar Inc. and may not be reproduced, Disclosed, revealed or used except in accordance with the executed license agreement with Caterpillar or its authorized
Sub licensor. This document may contain materials and information that were not prepared or reviewed by Caterpillar.
Table of contents
TABLE OF CONTENTS.............................................................................................................4 1 INTRODUCTION....................................................................................................................5 1.1 PURPOSE..................................................................................................................................5 1.2 SCOPE......................................................................................................................................5 2 STW 2008A (AND PRIOR) ISSUES........................................................................................6 2.1 SUPPORT DROPPED FOR 2008A..............................................................................................6 2.2 STW MASTER INSTALLER 2008A...........................................................................................6 2.3 DESIGN DEFICIENCIES.............................................................................................................6
4.5.1 Licensing Changes 2009A and Older............................................................14 4.5.2 Licensing STW 2009B to STW 2010A............................................................14 4.5.3 Licensing STW 2009B to STW 2010A............................................................14 4.5.4 Support Applications STW 2008A (and Older).............................................14 4.5.5 Pre Upgrade......................................................................................................15 4.5.6 Upgrade ............................................................................................................16 4.5.7 Post Upgrade.....................................................................................................16
4.6 LOGGING...............................................................................................................................17 4.7 NETWORK INSTALL ISSUES...................................................................................................18
Introduction
1.1 Purpose
The purpose of this document is to communicate technical information relating to the installation functionality of the STW software suite. Specifically, this document describes how to install the applications in a silent mode, with their various requirements. The goal of this document is to help enable dealer IT staff implement silent, autonomous, centralized distribution of the STW product suite without the interaction of the end user.
1.2 Scope
This document contains information specific to the installation of all applications within the STW product suite. These include STW 2008A (legacy application), STW Launchpad, Service Report, SIS DVD, Cat Electronic Technician, Technical Analysis (TA), Component-Based Troubleshooting (CBT), and DBS Upload Utility.
Application STW Registry Default Registry Default SIS DVD Service Report CBT TA Data Technician Upload Utility FFS SIS OLE Server Registry Default Registry Default Registry Default Registry Default Registry Default Registry Default Registry Default Registry Default
Cat ET
The MI utility allows for installs to fail, and attempts to call the install in a full-UI mode to allow the user to try to handle the error. This scenario is expected to occur in the case of an invalid license on the PC for Cat ET. Other results are possible, specifically if a different instance of Windows Installer is currently running, or if an install fails. A good reference document is located here: http://msdn.microsoft.com/en-us/library/aa368542.aspx
3.7 Logging
In order to account for future issues during support, the MI directs each application, via a command line statement, to create a log file and output the log to a standard location. The location is as follows:
%ALLUSERSPROFILE%\Application Data\Caterpillar\Installer\
When the install is started, the MI directs each application to use verbose logging. This can use up a larger amount of space, and may be deleted prior to an upgrade without issue. Each new install, upgrade or repair will create a new log file in addition to any existing log files.
/L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\[Application][timestamp].log"
Please note: the target directory for the log must exist prior to initiating the install. If this directory does not exist, the install may fail.
10
4 Installation Automation
4.1 Overview
With the design changes beginning with the 2009A release, performing silent installs with 3rd party packages has become significantly easier to implement. Using command line implementations, it is possible to apply many customizations to an install. Each install is currently implemented using Windows Installer command line values. While these customizations are possible, these changes are to be performed at the dealers risk.
11
Cat Electronic Technician Setup Prerequisites Comments None The Cat ET install may actively prompt to restart the PC in some cases. During testing, we noted that it could possibly force a restart from silent. As a precaution, we recommend telling the install not to force the reboot with the command line statements below.
/s /v"/qn RebootYesNo="No" Reboot="ReallySuppress" /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\Electronic Technician.log"" /qn RebootYesNo="No" Reboot="ReallySuppress" /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\Electronic Technician.log"
SIS DVD Setup Prerequisites Comments Setup EXE command line MSI command line Upgrade Command None The upgrade installation requires additional command line parameters be set. Please see below.
/s /v"/qn /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\SIS DVD.log"" /qn /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\SIS DVD.log" /s /v"/qn REINSTALL=ALL REINSTALLMODE=vomus /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\SIS DVD.log""
Service Report Microsoft Dot Net 3 Standard MSI install, no custom actions required. Because Microsoft .Net 3 is required, this install may take longer to perform. For dealerships using an automated distribution system such as SMS or LanDesk, pushing the .Net 3 package out earlier can reduce time during the application install.
/s /v"/qn /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\STW Service Report.log"" /qn /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\STW Service Report.log"
Technical Analysis Microsoft Visual C++ Redistributable: vcredist_x86.exe TA installs the Crystal Reports printing engine, which in some
12
circumstances fails if vcredist_x86.exe is not installed first. This issue is at present known to be a Microsoft Vista-related issue. If Cat ET is installed first, the required files will already be installed, and this package is not required. Else, it is required to prevent DLL registration issues. Also, this install is not technically a silent install. Microsoft forces a UI-based install that does not require user action, but it will be displayed to the user as a quick prompt. Setup EXE command line MSI command line
/s /v"/qn /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\Technical Analysis.log"" qn /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\Technical Analysis.log"
CBT Setup Prerequisites Comments Setup EXE command line MSI command line None Standard MSI install, no custom actions required
/s /v"/qn /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\CBT.log"" /qn /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\CBT.log"
DBS Upload Utility None Standard MSI install, no custom actions required. In order to function properly, the end user will require IBM Client Access to be installed. Only the ODBC drivers are installed, not the fully licensed version of Client Access.
/s /v"/qn /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\DBS Upload Utility.log"" /qn /L*v \"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\DBS Upload Utility.log"
13
Caterpillar has provided applications that will help support the upgrade and maintenance process for the STW suite, which are located on the Knowledge Network. 14
4.5.4.1
STWMaintenance.exe
Maintenance Executable STWMaintenance.exe No additional parameters Microsoft .Net 2 Performs uninstalls of several applications, detects and enables any STW license on the PC, cleans filesystem.
ETUninstall.exe
Maintenance Executable ETUninstall.exe No additional parameters Microsoft Visual C++ 6 Performs the silent uninstall of Cat ET 2008B and older
BatchUpgrade.bat
Maintenance Executable BatchUpgrade.bat No additional parameters DOS Batch Script Provides an example of scripting the upgrade. This is an example, but could be used by the dealership to perform upgrades
Several complicated actions are required in order to perform a silent upgrade from Cat ET 2008B and earlier. To ease the actions required by the dealer IT staff, Caterpillar Inc. has provided an executable that will uninstall Cat ET silently, allowing the dealer IT staff to automate the upgrade. The following actions are performed by the ETUninstall.exe application. Additional Actions for Complete Upgrade: ETUninstall.exe Application Action Description Cat ET Uninstall The Cat ET 2008C release migrated the install from InstallScript to standard MSI. Prior to 2008C releases, upgrades cannot be performed in silent mode. This problem also impacts upgrading to 2008C from 2008A and below. Because of the complex nature of the Cat ET install, Caterpillar has created a utility for uninstalling the older 15
version. The utility performs the uninstall in silent mode, and returns a result code. Following the execution of ETUninstall.exe, the new release of Cat ET may be installed using standard automation methods.
IMPORTANT: If STW is not installed on the PC, the license for Cat ET is stored in the Cat ET directory. Starting with the 2009A release, Cat ET installs to a new directory by default. This could result in a loss of license. Therefore, we recommend reinstalling Cat ET to the original directory, using the Windows Installer INSTALLDIR variable.
4.5.5.2
Cat ET 2008C
Upgrading Cat ET 2008C requires no special action. During the 2008C release, the Cat ET installation tool went through a significant rewrite, allowing for silent upgrades to occur. The following actions are performed by the STWMaintenance.exe application. They must be performed after all other applications have been upgraded.
4.5.5.3 Miscellaneous
The TA application does require the Microsoft Visual C++ runtime to be installed as a prerequisite. Without this package installed, installing on Microsoft Vista may result in an install error. Additional Actions for Complete Upgrade Application Action Description TA Install As noted above, both a new install and upgrade of TA results in the user seeing a pre-requisite install prompt. To avoid the prompt, TA may be installed directly from the MSI, bypassing the prerequisite install steps. If this is done, we recommend either installing the VC runtime install first, or installing Cat ET (which contains the install internally).
4.5.6 Upgrade
With Cat ET 2008B and older uninstalled, all applications can be upgraded using standard install instructions provided above.
in silent mode. It will also perform actions require to re-enable the license located in the STW application directory. Doing so allows Cat ET and SIS DVD to continue operating using the original Additional Actions for Complete Upgrade: STWMaintenance.exe Application Action Description SIS Web Uninstall The SIS Web (SISOLEServer) is a standalone install. It is (SIS OLE typically uninstalled via the Master Installer application. Server) While not a necessary uninstall, it should be performed to clean the system. STW Uninstall The STW Container is a standalone install. It is typically Container uninstalled via the Master Installer application. While not a necessary uninstall, it should be performed to clean the system. In order to preserve the license on the PC after an upgrade, some files and registry keys will remain on the PC. Both Cat ET and SIS utilize these license files in order to allow the technician to continue operating with the original license. The FFS application is a standalone install. It is typically uninstalled via the Master Installer application. While not a necessary uninstall, it should be performed to clean the system.
FFS
Uninstall
4.6 Logging
When implementing a custom install package, Caterpillar does request following the standard logging methods described above. This information helps assist in future trouble-shooting if an application error were to occur. We recommend using the directory used by the STW Master Installer, but this is not necessary. In order to perform logging from the command line, the path to the log file is required. Because of Windows Installer syntax requirements, the path must include 1. Preceded by a backslash 2. Enclosed in quotes 3. Double-backslashes between directories. As an example, the path might look like the following:
\"C:\\Documents and Settings\\All Users\\Application Data\\Caterpillar\\Installer\\STW Launchpad.log""
17
18