Packages

Use a package to predefine the items for your solution.

A package typically implements a Kofax TotalAgility solution for an industry vertical. A package can include items related to processes, forms, DLLs, resources, data, business monitoring, and system. Additionally, you can include a package within a package and add miscellaneous files to a package. Every time you save a package, a new version is created. Versioning helps a solution designer in tracking changes to the package. You can move a package from one TotalAgility deployment to another together with its constituents and quickly deploy it without much user intervention. You can only include an item once in a package and cannot include duplicate items. You can delete any referenced item.

You can export the latest version of all the package items at once and import them into another system. The package definition is saved so you can easily export the same items again.

A package can include the items listed in the following table.

You can manage a package in the following ways:

• Automatically add all or selected associated items related to processes, forms, and categories to a package. The items that already exist in the package are overwritten.

• Select the items to exclude from the package. On saving the package, the package data is saved in the TotalAgility database.

• You can quickly add commonly used items or specific item types from a selected artifact to the package, or search for the items that have been modified since a specific date or time, or between certain periods so you can quickly add all or individual items to the package.

• Upgrade from one version to another by importing a package. The non-versioned items, such as checklists, lookups, Scan/VRS profiles, PDF profiles, custom pages, localization strings, personas, formatters, and others get overwritten if they already exist on the target system.

• Compare a package with the system package or with other packages to view the items that have changed between versions. The items which are different and new in the selected packages are highlighted.

• Create a copy of a package.

• Open, modify, lock, unlock and delete a package.

• Add miscellaneous files such as an installation guide or other items that may be useful for using the package.

• Assign access permissions to one or more resources to grant access to the package. Resources with at least Read permissions can access a package.

• Export a package for reuse.

• Import the entire package or the selected items to TotalAgility.

• Create different deployment configurations for a package to allow the user to define different values for global variables, server variables, web service integrations, device settings (Kofax Front Office Server settings), transformation settings, and export connector settings based on different types of deployment targets, such as test and production environments. During import it allows the user to overwrite the values based on the selected deployment type when exporting the package.

• Deploy a package to a deployment server. You can compare the results between the current server package and the contents on the selected deployment server and then deploy the package to the deployment server. The deployed package is exported with values and imported to the selected deployment server by applying the import options.

• Add a package definition and its contents to GitHub. You can get the latest version of the package and its contents and check it out from GitHub. You can check in the package and its items to GitHub.

• Protect all or certain items (supported item types listed below) of a package to prevent other users from viewing or modifying them when they are imported into another machine. On upgrading TotalAgility, the system treats all items within the existing packages as unprotected.

  You can only protect the following types of artifacts in a package: Processes, Forms, Form templates, Business rules, Classification groups, Extraction groups, and Folders.

  You cannot do the following for the protected items:

  • Grant maintenance access to the protected item when importing a protected item into a target environment. However, it has no impact on the item on the source server.

  • Open or modify these items but can consume them (including in a package).

  • Modify the maintenance access on these items when exported and imported into another machine either individually or as part of a package.

  • View the protected items, such as classification or extraction group, in the Transformation Designer.

  When viewing the package configuration on the target server, the protected settings are not retained even though the items are protected within that system.

How to:

• Create a package

• Deploy a package to a deployment server

• Add a package to GitHub

• Work with packages

• Compare packages