Package template files
When packaging a template, you determine the files to include and how the Template Installer wizard will look and behave. In addition to identifying the template to be packaged, you also decide on the location where it should be installed, the layouts to include, and any external files that need to be installed with the template.
To package template files:
- Launch Working Papers.
- From the File menu, click Templates.
- Add your new template file. Select the template and click Package.
- The Create Template Package dialog displays. Click Next.
- Set the global options for your template package. Click Next.
- Set the branding options for your template package. Click Next.
- Select a layout for your template package. Click Next.
- Specify the files and folders to include in your template package. Click Next.
- Specify any external applications to execute before or after installation. Click Finish.
The template files are packaged. You can distribute the template package to your staff for installation.
Global options
Specify how the Template Installer Wizard will look and behave.
Option | Description |
---|---|
Output File |
This field displays the file path where the packaged template will be located. CaseWare only supports the existence of one .ac or .ac_ file in this folder. Client files residing in subfolders of the top-level folder are not supported. Click Browse to choose a different location and specify a file name. |
Client File |
|
Template Name |
This field specifies a template name to identify the template that will be installed from this package. |
Version |
This field specifies a version number for the package. Enter version numbers in the boxes to keep track of different versions. The version number is added to the registry during the installation of the template. The version information is used to determine which version to overwrite when you are patching a template. |
Version Tag |
This field specifies a unique tag provided to the package. You might want to have different builds of the same version (for example a US build and a Canadian build). The version tag is added to the registry during the installation of the template. The version information is used to determine which version to overwrite when you are patching a template. |
Registry File |
Select a registry file if there are elements in the template that require modification of the registry. Use the drop-down menu or click Browse to select a registry file. |
Allow this template to be repackaged |
Select to allow the template to be repackaged. Note: Preventing templates from being repackaged on a machine where the template is already installed is a known security measure. |
Allow minimal options on repackage |
Select to specify additional controls if Allow this Template to be Repackaged is selected. When this check box is selected and a template is being repackaged, only the Global Options page is displayed in the wizard. Within the Global Options page only the Output File and Template Name fields can be changed. |
Enforce a minimum CaseWare version of: |
Select to limit the template to be used with a minimum version of CaseWare Working Papers. If this check box is selected, use the drop down list to select a version and enter a build number in the Build field to specify the minimum version of Working Papers and build number for this template to be used in. |
Install template in document library |
Select to install the repackaged template in the document library. |
Do not register template |
Select to install the template without registering it. No registry key will be added for the template and it will not be displayed in the list of templates that new client files can be based on. Note: This option is only available if Install Template in Document Library is selected. |
Allow template patch package creation |
If selected, the Make Patch button displays when a user selects this template from Tools | Templates. |
Allow user to directly open template after install |
Select to allow the template to be opened after installation. In the last page of the installation wizard, a check box (Open the Template for editing) is shown. If this check box is selected the template will be opened in template mode once the template packager is closed. |
Ensure that the files in the package match the actual file list |
Select to perform a verification of the files when they are compressed into the package. |
More... |
Click to open the More Options dialog. The dialog provides two drop-down option lists: Options for backing up the existing template:
Options for uninstalling the existing template:
|
Branding options
Customize the branding of the Template Installer Wizard.
Option | Description |
---|---|
EULA |
Include an End User License Agreement (EULA) that the user must accept before the installation can proceed. You can enter the file name, use the drop-down list, or click Browse to select an *.rtf or *.txt file. |
Intro Page Text |
Include text to be displayed on the first page of the installation wizard. You can enter the file name, use the drop-down list, or click Browse to select an *.rtf or *.txt file. |
Watermark |
Include a custom image to show on the left side of the first page of the installation wizard. You can enter the file name, use the drop-down, or click Browse to select a *.bmp file. For optimum resolution, the size of the watermark graphic must be 165x450 pixels. A preview of the watermark displays at the bottom of the dialog. |
Header |
Include a custom image in the header of the installation wizard. You can enter the file path, use the drop-down list, or click Browse to select an *.rtf or *.txt file. A preview of the header displays at the bottom of the dialog. |
Icon |
Include a custom icon to represent a template in the Templates dialog. You can enter a file path, use the drop-down list, or click Browse to select a *.bmp or *.ico file. A preview is shown in the Icon box. A preview of the icon displays at the bottom of the dialog. |
Layout
Customize the layout of the Template Installer Wizard.
Option | Description |
---|---|
Change Source |
Click this button to select another file path where layouts are located. |
Layouts |
Select the check box beside each layout you want to include in the template package. Note: If the selected layout requires dependent layouts, those layouts are automatically included, even if you haven't selected them. The next time you package template files, the layouts previously selected and their dependent layouts are automatically selected and are always included in the package. |
Overwrite Actions |
Select an option to overwrite existing layouts.
Note: If the selected layout requires dependent layouts, those layouts are automatically included, even if you haven't selected them. The next time you package template files, the layouts previously selected and their dependent layouts are automatically selected and are always included in the package. |
Specify files
Specify which files to include in the template package and where to install them.
Option | Description |
---|---|
Destination |
The files selected for each category will be installed to the following locations:
|
Source File Name |
This column specifies the file path of the files to be included. |
Add Files |
Click this button to include individual files. |
Add Folder |
Click this button to include folders. Including a folder will include all of the files within the folder. |
Remove | Click this button to remove a file or folder. |
External programs
Specify which external programs to execute before or after installation, or uninstallation of the template package.
Option | Description |
---|---|
Add |
Add an external program to execute with the template package. You can designate when the program will execute by filing it under the applicable label:
|
Remove | Remove an external program from executing with the template package. |
Label |
This field specifies a unique label assigned to each application. |
Source Folder |
This field specifies the file path of the application. |
Executable |
This field specifies the name of the application. |
Command line |
This field specifies additional parameters that are needed to run the executable. The additional parameters are passed to the Template Installer which will run the executable and append the command line parameter. |
Include all files and subfolders in the same directory |
Select this option to include all supporting files needed for installing the application. Note: Use this check box with caution; if, for example, you put the executable on your C: drive and select this check box, then all files on your C: drive are included in the template package. |
Do not run in unattended mode |
Choose this option to prevent the selected executable from running in unattended mode. |
Advanced... |
The Advanced Options dialog allows you to control how Working Papers should handle external programs and script exit codes when installing templates.
|