Silent Installation Instructions - Packaged Templates

Problem:

When installing a packaged, repackaged, or patched template, you have the option of using the Install Template Package wizard (see Packager Help) to guide you through the necessary steps, or alternately, you can perform a completely automated, also known as an unattended, installation that requires no user input. An unattended installation means that you can install a greater number of packaged templates with a higher degree of efficiency. It also allows the creator of the unattended installation to predetermine and customize the various options available during the installation process.

Solution:

To enable this functionality, you need to create a response file (silentcwp.ini) in which you specify the desired values for all settings that require user input during installation. This file is placed in the same folder as the packaged template.

To perform an unattended installation of a packaged template:

Create a file called silentcwp.ini in the same folder as the packaged template that you want to install. See Appendix A for example silentcwp.ini file contents.

Note: .ini files can be edited in Windows Notepad.
In the silentcwp.ini file, configure the required settings as desired. Refer to Appendix B for a complete list of configurable items and their possible settings.

Note: Items for which a value is invalid or unspecified will be displayed during installation so the user can input the missing information.
Locate and run the template package (.cwp file) to begin the installation. The screens that are displayed during installation are determined by the settings you defined in the silentcwp.ini file.
If you chose to display the Confirmation page upon completion of the installation, exit the page to close the program. If you chose to hide the Confirmation page, the program will close automatically when installation is complete.

Appendix A - Example silentcwp.ini file

[SplashPage]

showErrors = 1

skipUseDefault = 1

[EULAPage]
showErrors = 0
acceptEULA = "yes"

[FolderPage]

showErrors = 0
skipUseDefault = 0
cwPath = "C:\Program Files\CaseWare"
destPath = "C:\Program Files\CaseWare\Template"
klPath = "default"
diffFolderConfirm = "ok"
overwriteConfirm = "default"
newFolderConfirm = "ok"
newKLFolderConfirm = "ok"

[ExtractPage]
showErrors = 0

[ConfirmPage]
showOn = "never"

Appendix B - Settings for a .ini file

[SplashPage]: Initial page displayed when installation begins.

showErrors

0 - hides any error dialogs.
1 (default) - displays any error dialogs.

skipUseDefault
0 (default) - does not skip the page.
1 - skips the page.

[EULAPage]: Displays the End User License Agreement.

showErrors
0 - hides any error dialogs.
1 (default) - displays any error dialogs.

acceptEULA
  Yes - accepts the EULA.
  No - does not accept the EULA and exits the installation.
  Default (default) - displays the EULA and allows the user to either accept or not accept.

codeX (where X is 1 through 10)

<codeValue> - specifies the installation code value for the Xth code field in the Install Code page.

[FolderPage]: Displays various destination folders.

showErrors
0 - hides any error dialogs.
1 (default) displays any error dialogs.

skipUseDefault
0 (default) - uses values specified for cwPath, destPath, and klPath, or as inputted by user.
1 - uses Packager default values and skips the page.

cwPath
<path> - specifies path to the Working Papers program folder.
Default - uses Packager default values for the program folder.

destPath
<path> - specifies a destination path for the installation.
Default - uses the default Templates or Document Library destination path.

klPath
<path> - specifies the path to the Knowledge Library.
Default - uses the default Knowledge Library path.

diffFolderConfirm
  Ok - allows the template to be installed to a location different form the previous location.
  Cancel - does not allow the template to be installed to a different location, and exits the installation.
  Default (default) - allows the user to choose to either allow installation to a different location, or cancel the installation.

overwriteConfirm
  Ok - allows the installation to overwrite the previous installation.
  Cancel - does not allow the installation to overwrite the previous installation, and exits the installation.
  Default (default) - allows the user to either allow the installation to overwrite the previous installation, or cancel the installation.

newFolderConfirm
  Ok - allows the creation of a new folder for the template.
  Cancel - does not allow the creation of a new folder for the template, and exits the installation.
  Default (default) - allows the user to either create a new folder for the template, or cancel the installation.

newKLFolderConfirm
  Ok - allows the creation of a new folder for the Knowledge Library.
  Cancel - does not allow the creation of a new folder for the Knowledge Library, and exits the installation.
  Default (default) - allows the user to choose to either create a new folder for the Knowledge Library, or cancel the installation.

[ExtractPage]: Displays the progress of the installation.

showErrors
0 - hides any error dialogs.
1 (default) - displays any error dialogs.

[ConfirmPage]: Concluding page indicating whether the installation succeeded or failed.

showOn
  Error - displays the page if an error occurred during installation.
  Never - does not display the page regardless of installation success or failure.
  Always (default) - displays the page regardless of installation success or failure.

Click here to view related articles.