To access the full documentation set online, see the Kofax TotalAgility Documentation page.
To launch the online help for the installed version of the product, click the Help icon in the application.
When upgrading to TotalAgility 7.11.0 from an earlier version, ensure that the check box for "Import system Workspace package" is selected to view the Workspace help online; otherwise, you must import the WorkspaceHeader form from the TotalAgility Workspace package.
You can access the Kofax TotalAgility documentation online as well as offline mode.
A complete set of TotalAgility documentation includes the following items.
Provides information for administrators who are responsible for configuring and maintaining a TotalAgility installation.
Includes the details of the supported APIs excluding deprecated methods, a list of supported methods for each service, and all inputs and outputs including the required fields, field types, and enumerations, any special information about the method, some coding examples, and the details behind concepts used.
Provides an overview of the TotalAgility architecture, covering various deployments for on-premise, on-premise multi-tenancy, and Azure environments.
Describes the best practices to follow when using TotalAgility to improve performance, cost, maintenance, availability, and security.
Provides instructions for using the Configuration Utility to update settings across various configuration files for different installation and deployment types.
Provides details about using TotalAgility to design business jobs and cases, assign resources, create forms, integrate with external applications, and more.
Provides an overview of the TotalAgility features.
Provides instructions on installing TotalAgility and integrating it with other products.
Provides instructions on installing TotalAgility Integration Server and integrating it with other products.
Provides instructions on installing and configuring a TotalAgility On-Premise Multi-Tenant system.
Provides system requirements for installing TotalAgility, instructions for running the Pre-requisite Utility, and a software checklist for various installation types.
Include key details about the new and enhanced features and any changes in behavior in TotalAgility 7.11.0. It also lists any known and resolved issues in this version of TotalAgility.
Describes the Dimension and Fact tables of the Kofax Reporting data warehouse that store information related to Capture client activities of TotalAgility.
Describes the sample views provided with Kofax Reporting.
Describes the TotalAgility tables and fields used by Kofax Analytics for TotalAgility.
Describes how to create and manage tenants using the TotalAgility On-Premise Multi-Tenant system.
Provides instructions for installing the TotalAgility Tenant Management System.
Provides details for using a Web Capture control in creating multi-page documents, creating a new document in a new folder, deleting pages that have been incorrectly scanned, and more; also, describes the buttons available in a Web Capture control toolbar.
Provides details for using TotalAgility to design business jobs and cases, assign resources, create forms, integrate with external applications, and more.
Provides help for using Capture activities in TotalAgility.
Provides an overview and instructions for developing inputs with the MFP Web Services Connector Software Developer Kit (SDK). Along with this guide, the SDK provides documentation for the Web services.
If you require offline documentation, you can download it from the Kofax Fulfillment Site. For each language, a separate documentation package is available to download as a compressed file, such as TotalAgilityDocumentation_7.11.0_EN.zip for English or TotalAgilityDocumentation_7.11.0_FR.zip for French.
The English and Japanese .zip files include both help and print folders. The print folder contains PDF guides, such as the installation guide and administrator's guide. The .zip files for other languages contain a limited set of localized files.
The following procedure describes accessing TotalAgility documentation offline for English.
In a distributed environment, copy files on the Web server, and apply the Web.config changes on the Application and Web servers.
| Copy the contents from the folder | Paste the contents to the folder |
|---|---|
| Designer | \\TotalAgilityInstall\Agility.Server.Web\Help\TotalAgility_designer\EN |
The TotalAgility installer creates the TotalAgility_designer and API folders inside the Help folder. You must manually create other folders such as Workspace and TotalAgilityApps and then copy the contents into the respective folders.
TotalAgility Export Connector
For the Transformation Designer, XDoc Browser, and KC_KTM Converter Help to work offline and make sure that TotalAgility is actively connected to Transformation Designer. To connect TotalAgility to Transformation Designer, log in to Transformation Designer and click File > Connections and provide the connection path.
TotalAgility Message Connector
TotalAgility Document Converter