Packages
Use packages to predefine and organize solution items efficiently for a specific industry vertical. Packages can include items such as processes, forms, DLLs, resources, data, business monitoring components, and system-related elements. You can also add other packages and miscellaneous files, such as an installation guide that may be useful, within your package.
Packages in Tungsten TotalAgility offer a flexible and robust way to manage solution components, streamline deployment, and maintain version control—while providing options for security, access management, and integration into modern development workflows.
Every time you save a package, a new version is created. Versioning a package enables solution designers to track changes and manage package iterations easily.
You can move packages between TotalAgility deployments, along with all their contents, for rapid and user-free deployment.
Note: You cannot include duplicate items within a package, but you can delete any referenced item.
You can export the latest version of all items in a package at once and import them into another system. The package definition is saved, enabling you to export the same items repeatedly with ease.
When exported, the Packages feature generates a ZIP file containing all specified data and items. Upon extraction, these contents are organized into subfolders, with file names that match those used in TotalAgility Advanced Studio. A subset of this data is proprietary and encrypted for security.
Items that can be included in a package
A package can contain items listed below.
-
User interface elements: Form templates, Navigations, Themes, Style sheets, Images, Sites, and Custom pages.
-
Capture elements: Folder types, Field formatters, Pdf profiles, Separation profiles, Scan/VRS profiles, Document conversion profiles, Import connections, Import sources, Field validators, and Capture control layouts.
-
Resources: Individuals, Groups, Personas, and Work allocation rules.
-
Queries: Job queries, Work queue queries, and System queries.
-
Packages: Packages and Miscellaneous files.
-
System settings: DLLs and Job schedules.
-
System data: Checklist templates, Checklist items, Data models, Document templates, Lookups, and Regular expressions.
-
Monitoring elements: Alerts, Events, and Targets.
-
When creating a new deployment, you can include Global variables, Web services, Device settings, Transformation settings, and Export connectors within the deployment configuration.
Items that cannot be included in a package
A package does not include certain items.
-
Items associated with resources:
-
Category for all
-
External resources
-
Personas, supervisors, and members (worker resources and group resources) for group resources
-
Supervisor, persona, working group, and associated groups for individual resources
-
Security roles
-
-
Items associated with Capture data:
-
Currency codes
-
Resources (workers and groups) and processes for entities
-
Resources (workers and groups) and forms for extraction groups
-
Resources (workers and groups) and forms for folder types
-
Server variables in the definition
-
The PDF generation, Scan/VRS, and Separation profiles if the "Include items associated with categories" option is selected.
-
-
Items associated with Queries:
-
Resources (workers or groups) and Processes for Job query and Work queue query
-
When you import a package, the Job, Work queue, and System queries are overwritten only if the “Overwrite Non-versioned items” option is selected.
-
-
Items associated with the System:
-
Category for all
-
Parent category and Resources (workers and groups) for the category
-
Process and server variables for job schedule
-
Manage packages
You can manage a package in several ways:
-
Automatically add all or selected associated items related to processes, forms, and categories, to a package. Existing items are overwritten.
-
Exclude specific items from the package. Package data is directly saved in the TotalAgility database upon saving.
-
Quickly add commonly used items or specific items, or items that have changed within a certain date range or period.
-
Upgrade by importing a new package version. Non-versioned items, such as checklists, lookups, Scan/VRS profiles, PDF profiles, custom pages, localization strings, personas, formatters, and others, are overwritten if they already exist on the target system.
-
Compare a package with the system package or with other packages to highlight new or modified items between versions.
-
Create a copy of a package.
-
Copy, open, modify, lock, unlock, and delete packages as required.
-
Assign access permissions to resources, ensuring only users with at least Read permissions can view a package.
-
Export packages for reuse and import packages or selected items into TotalAgility.
-
Define deployment configurations for different environments (such as test and production), enabling customization of global variables, server variables, web service integrations, device settings (Tungsten Front Office Server settings), transformation settings, and export connector settings based on deployment targets. During import you can overwrite values according to the selected deployment type.
-
Deploy packages to a deployment server.
-
Add package definitions and contents to GitHub, check out the latest versions, and commit changes as needed.
-
Protect all or certain items (supported item types listed below) within a package from unauthorized viewing or modification when imported into another machine. Upon upgrading TotalAgility, all existing items are treated as unprotected.
You can only protect the following artifacts types: Processes, Forms, Form templates, Business rules, Classification groups, Extraction groups, and Folders.
When working with protected items, restrictions apply to do the following:
-
Granting maintenance access when importing them into a target environment. (Source server items remain unaffected).
-
Opening or modifying these items (but you can include them in a package).
-
Modifying the maintenance access on these items when exported and imported into another machine, either individually or as part of a package.
-
Viewing 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: