Package template files

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.

• When selecting a template: Click Browse to select the template you want to package. If a template was selected in the Templates dialog, that selection is automatically input as the client file.

• When creating a shared files package: Use the drop-down list and select None (Create Shared Files Package). A Shared Files Package will be created. These packages consist of files that target multiple templates and cannot be uninstalled.

This field specifies a template name to identify the template that will be installed from this package.

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.

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.

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.

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.

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.

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.

Select to install the repackaged template in the document library.

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.

If selected, the Make Patch button displays when a user selects this template from Tools | Templates.

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.

Select to perform a verification of the files when they are compressed into the package.

Click to open the More Options dialog. The dialog provides two drop-down option lists:

Options for backing up the existing template:

• Default unselected
• Default selected
• Do not show backup option

Options for uninstalling the existing template:

• Optional, default selected
• Optional, default unselected
• Force uninstall
• Force overwrite

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.

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.

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.

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.

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.

Click this button to select another file path where layouts are located.

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.

Select an option to overwrite existing layouts.

• Merge folder contents

  Combines the selected layouts and overwrites any existing version of the layouts when the template is installed on the user's machine.

• Skip if folder exists

  Skips overwriting any layouts if they already exist on the user's machine.

• Delete existing folder and then replace

  Deletes the existing layout folder and copies layouts from 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.

The files selected for each category will be installed to the following locations:

• CaseView Browse Definitions: <Program Folder>
• CaseView Stylesheets: <Program Folder>\styles
• CaseView Cell Group Files: <Program Folder>
• Scripts: <Program Folder>\scripts
• Global Databases: <Program Folder>
• Knowledge Libraries: <Program Folder>\Library or specified during install
• Program Folder: <Program Folder>
• Client Files: <Program Folder>

This column specifies the file path of the files to be included.

Click this button to include individual files.

Click this button to include folders. Including a folder will include all of the files within the folder.

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:

• Execute before installation: Applications added here will be executed before the template is installed.
• Execture after installation: Applications added here will be executed after the template is installed.
• Execute before uninstillation: Applications added here will be executed before the template is uninstalled.
• Execute after unistillation: Applications added here will be executed after the template is uninstalled.

This field specifies a unique label assigned to each application.

This field specifies the file path of the application.

This field specifies the name of the application.

This field specifies additional parameters that are needed to run the executable. When the package is subsequently installed, the macros expand to the corresponding paths entered by the user on the Summary page and pass as parameters to the Template installer.

Available macros include:

• %PRG_PATH%: Path to the Caseware program folder as entered by the user.
• %TEMPLATE_PATH%: Path to the Template (or Document Library) folder as entered by the user.
• %KL_PATH%: Path to the Knowledge Library folder as entered by the user (if specified).
• %GUID%: GUID of the template being installed.
• %INSTALL_PATH%: Path to the folder containing the template's files (e.g., C:\Caseware\Template\MyTemplateName).

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.

Choose this option to prevent the selected executable from running in unattended mode.

The Advanced Options dialog allows you to control how Working Papers should handle external programs and script exit codes when installing templates.

• Installer waits until external program finishes executing: Removes a subscription to the selected content.

• Process program exit code: Unsubscribes from all dependent content on the selected item, but leaves you subscribed to the item itself.

  For example, if you unsubscribe from the dependent items on a File Request (an activity), you will not receive any notifications about comments or attachments on the activity. If another user modifies the File Request itself, however, you will receive a notification email.

• If exit code is: Select the condition that the template packager should verify.

  then: Select the result that the template packager should enforce if the condition is met. Options include:

  • continue install, do not report error

    The installation will continue as if no error occurred. No error will be reported.

  • continue install, report error

    The installation will continue until completion, the final page will indicate that the installation was completed, but an external program reported an error.

  • abort install, report error

    The installation will stop. A pop up dialog will display informing you that an error has occurred with the currently executing external program and installation will terminate. The final page of the installer will inform you that an error has occurred.

  • prompt to continue, report error

    The installation will stop. A prompt will display informing you an error occurred with the currently executing external program and will ask if you wish to continue with the installation. If you select No, installation will terminate and the final page will inform the user an error has occurred. If you select Yes, the installation will proceed and the final page will indicate the installation was completed, but an external program reported an error.