Install a template package
The Template Installer Wizard guides you through the steps needed to install templates.
To install a template package:
- Double-click the template package to launch the Template Installer Wizard.
- On the Welcome screen, click Next.
- Read the License Agreement, then select I accept the terms in the license agreement. Click Next.
- Designate an installation directory for Working Papers. We suggest using the default directory. Click Next.
- Enter or Browse for the location of your Working Papers and Template folders if they do not match the defaults. If you are updating or overwriting a template package, you have the option to back up your existing template and uninstall your existing template. Click Finish.
The template package is installed. You can access the template in Working Papers from File | Templates or Tools | Templates.
Note: The template version automatically updates to match the current version of Working Papers.
Silent installation
If you want to install a template package where monitoring and manual input is not required during the installation process, you can perform a silent installation.
First, you'll first need to create a Silentcwp.ini file. The Silentcwp.ini file contains a list of the desired responses a user would make during installation. By running this file, you can bypass the need for user input.
To create a Silentcwp.ini file:
-
From the Windows Start menu, launch Notepad.
-
Enter the required responses for your installation. See the Sample Silentcwp.ini file for proper formatting.
Page Option Value Global: All pages in the installer silent - 0: Show the loading bar
- 1: Hide the loading bar
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 page
- 1: Skips 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 user to either accept or not accept
CodePage: Requires that a series of installation codes are entered showErrors - 0: Hides any error dialogs
- 1: (Default) Displays any error dialogs
codeX (where X begins with 1 and increases sequentially)
-
<codeValue>: Specifies the installation code value for the Xth code field in the Install Code page
Note: Any break in the sequence will break all subsequent codes. Ensure you enter a code, but leave it blank if you don't want to prepopulate the code on installation.
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 the template packager default values and skips page. Also ignores cwPath, destPath, and klPath.
cwPath - <path>: Specifies path to the Caseware Program folder
- default: Uses the template packager default value for the Caseware 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 template to be installed to a location different from previous location
- cancel: Does not allow template to be installed to a different location, and exits the installation
- default: (Default) The user can choose to either allow installation to a different location, or cancel the installation
overwriteConfirm - ok: Allows installation to overwrite the previous installation
- cancel: Does not allow the installation to overwrite the previous installation, and exits the installation
- default: (Default) The user can choose 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) The user can choose 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) The user can choose to either create a new folder for the Knowledge Library, or cancel the installation
autoUninstall - yes: Selects the Uninstall existing template checkbox. This allows the user to uninstall the template without working in the Template Packager Wizard
- no: Clears the Uninstall existing template checkbox. The prior template version will remain installed
- <blank>: (Default) The user can choose to either select or clear the Uninstall existing template checkbox
autoUninstallConfirm - ok: Allows uninstallation of previous template
- <blank>: (Default) The user can choose to confirm the uninstallation of the previous template
ExtractPage: Displays the progress of the installation showErrors - 0: Hides any error dialogs
- 1: (Default) Displays any error dialogs
folderOverwrite - merge: Merges contents of preexisting file folders with content of installed folders with the same name
- replace: Replaces preexisting file folders with installed folders with the same name
- skip: Skips the installation of the duplicate folder
- default: The user can choose how the installation process should handle any file folders with the same name as preexisting folders in destination directory
clientFileFolderOverwrite - replace: Replaces preexisting client file folders with installed folders that have the same name
- skip: Skips the installation of the duplicate client file folder
- default: The user can choose how the installation process should handle any client file folders with the same name as preexisting client file folders in destination directory
fileOverwrite - replace: Replaces preexisting client files with installed files that have the same name
- skip: Skips the installation of the duplicate client file
- default: The user can choose how the installation process should handle any client files with the same name as preexisting client files in destination directory
ConfirmPage: Concluding page indicating whether the installation succeeded or failed showOn - error: Displays page if an error occurred during installation
- never: Does not display page regardless of installation success or failure
- always: (Default) Displays page regardless of installation success or failure
openTemplate - 0: The template will not open after installation
- 1: The template will open after installation is complete
Note: Items for which a value is invalid or unspecified will be displayed during installation so the user can input the missing information.
- Click File | Save As.
- Navigate to the folder containing the template package you want to install. In the File name field, enter Silentcwp.ini. In the Save as type drop-down menu, select All Files (*.*). Click Save.
The Silentcwp.ini file is created in your template package folder. You can now perform a silent installation.
To silently install a template package:
- Ensure that the Silentcwp.ini file is in the same folder as the template package you want to install.
- Double-click the template package to begin installation.
- If you enabled the Confirmation page in the Silentcwp.ini file, click Close to complete the installation. If you disabled the Confirmation page, the installer will close automatically.
The template package is silently installed. Users can access the template in Working Papers from File | Templates or Tools | Templates.
Sample Silentcwp.ini file
Use the following sample to properly format your Silentcwp.ini file:
[Global]
silent = 1
[SplashPage]
showErrors = 1
skipUseDefault = 1
[EULAPage]
showErrors = 0
acceptEULA = "yes"
[CodePage]
showErrors = 0
code1="code1Value"
code2="code2Value"
code3=
code4="code4Value"
[FolderPage]
showErrors = 0
skipUseDefault = 0
cwPath = "C:\Program Files (x86)\Caseware"
destPath = "C:\Program Files (x86)\Caseware\Template"
klPath = "default"
diffFolderConfirm = "ok"
overwriteConfirm = "default"
newFolderConfirm = "ok"
newKLFolderConfirm = "ok"
[ExtractPage]
showErrors = 0
[ConfirmPage]
showOn = "never"