› TotalAgility documentation

TotalAgility documentation

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.

Full documentation set

A complete set of TotalAgility documentation includes the following items.

Guide/Help Description
Administrator's Guide

Provides information for administrators who are responsible for configuring and maintaining a TotalAgility installation.

API Documentation

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.

Architecture Guide

Provides an overview of the TotalAgility architecture, covering various deployments for on-premise, on-premise multi-tenancy, and Azure environments.

Best Practices Guide

Describes the best practices to follow when using TotalAgility to improve performance, cost, maintenance, availability, and security.

Configuration Utility Guide

Provides instructions for using the Configuration Utility to update settings across various configuration files for different installation and deployment types.

Designer Help

Provides details about using TotalAgility to design business jobs and cases, assign resources, create forms, integrate with external applications, and more.

Features Guide

Provides an overview of the TotalAgility features.

Installation Guide

Provides instructions on installing TotalAgility and integrating it with other products.

Integration Server Installation Guide

Provides instructions on installing TotalAgility Integration Server and integrating it with other products.

On-Premise Multi-Tenant Installation Guide

Provides instructions on installing and configuring a TotalAgility On-Premise Multi-Tenant system.

Prerequisites Guide

Provides system requirements for installing TotalAgility, instructions for running the Pre-requisite Utility, and a software checklist for various installation types.

Release Notes

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.

Reporting Tables

Describes the Dimension and Fact tables of the Kofax Reporting data warehouse that store information related to Capture client activities of TotalAgility.

Reporting Views

Describes the sample views provided with Kofax Reporting.

Tables for Analytics

Describes the TotalAgility tables and fields used by Kofax Analytics for TotalAgility.

Tenant Management System Help

Describes how to create and manage tenants using the TotalAgility On-Premise Multi-Tenant system.

Tenant Management System Installation Guide

Provides instructions for installing the TotalAgility Tenant Management System.

TotalAgility Apps Help

Includes a suite of applications that allows citizen developers to configure the workflow and capture items with little to no training. TotalAgility Apps encapsulates the following applications.

  • Business Data

  • Quick Capture

  • Quick Classification

  • Quick RPA

  • Quick Rules

  • Quick Skins

  • Quick Workflow

Web Capture Control Help

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.

Workspace Help

Provides details for using TotalAgility to design business jobs and cases, assign resources, create forms, integrate with external applications, and more.

Other documentation
Capture Client

Provides help for using Capture activities in TotalAgility.

Devices Help Provides details for managing devices connected to TotalAgility.
Export Connector for TotalAgility Provides instructions on managing an Export Connector and setting up an Export Connector for a document type.
KC/KTM Converter Provides instructions on how to convert Kofax Capture and Kofax Transformation Modules projects into the correct format so that they can be used in TotalAgility.
Kofax .NET Restful Web Service API for Device the Client Provides documentation for the Kofax .NET Restful Web Service API for the Device Client.
Kofax .NET Legacy API for the Device Client Provides documentation for the Kofax .NET Legacy API for the Device Client.
Message Connector Provides instructions on how to configure and use Kofax Message Connector.
MFP Starter Pack Getting Started Guide Provides instructions on how to use TotalAgility to import and process the MFP Starter Pack.
MFP Administrator Guides Describe how to prepare MFP devices to work with TotalAgility.
MFP Web Services Connector SDK Developer's Guide

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.

Repository Browser Provides instructions on how to use the Repository Browser to view the extraction results for a set of folders and documents.
Search and Matching Server Provides documentation of the Kofax Search and Matching Server, which handles search requests from various Kofax applications for large volumes of data located at a remote site.
Transformation Designer Provides instructions on how to use Transformation Designer to set up, store, and test projects that contain all the necessary information for processing documents.
Transformation Designer Scripting Provides an introduction to the WinWrap Basic Editor and an overview of the available scripting events.
XDoc Browser Provides help on using the XDoc Browser, a program that provides direct access to the document representation that is used by TotalAgility. With XDoc Browser, you can open and display an XDoc along with any referenced images for testing, demonstration, and debugging purposes.

Offline documentation

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.

  1. From the Kofax Fulfillment Site, download the documentation.zip file for the applicable language, such as English.
  2. Extract the contents of the compressed documentation file to your local computer.
  3. In the TotalAgility product installation files, inside the Agility.Server.Web\Help folder, create a folder for the desired language. For example, for accessing TotalAgility documentation offline for English, create the EN folder as follows:

    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.

    Devices

    \\TotalAgilityInstall\Agility.Server.Web\bin\Administrative\Help\Devices\EN

    DocumentConverter

    \\Kofax\Document Converter\web\en\WebHelp

    ExportConnector

    \\TotalAgilityInstall\Agility.Server.Web\Help\ExportConnector_help\EN

    KCKTM_Converter

    <%ProgramData%>\Kofax\Transformation\en_US\help\KCKTM_Converter

    MessageConnector

    \\Kofax\KIC-ED\MC\web\en\WebHelp

    RepositoryBrowser

    \\TotalAgilityInstall\Agility.Server.Web\Help\RepositoryBrowser\EN

    SDK_Documentation

    \\TotalAgilityInstall\Agility.Server.Web\Help\API\EN

    TenantManagementSystem

    \\TotalAgilityInstall\Agility.Server.Web.TenantManagement\TenantManagement\Help\TenantManagementSystem\EN

    TotalAgilityApps

    \\TotalAgilityInstall\Agility.Server.Web\Help\TotalAgilityApps\EN

    TransformationDesigner

    <%ProgramData%>\Kofax\Transformation\en_US\help\TransformationDesigner

    WebCaptureControl

    \\TotalAgilityInstall\Agility.Server.Web\Help\WebCaptureControl\EN

    Workspace

    \\TotalAgilityInstall\Agility.Server.Web\Help\Workspace\EN

    XDocBrowser

    <%ProgramData%>\Kofax\Transformation\en_US\help\XDocBrowser

    Activity folder within CaptureClient

    Example: DocumentReviewActivity

    \\TotalAgilityInstall\Agility.Server.Web\Forms\Controls\Capture\Help\DocumentReviewActivity\EN

  4. Navigate to the installation folder.

    For the help Perform the following steps

    • TotalAgility Designer

    • Devices

    • Transformation Designer

    • XDoc Browser

    • KC_KTM Converter

    1. Open TotalAgility Web.config in a text editor from the following location:

      \\TotalAgilityInstall\Agility.Server.Web

    2. Locate the <appSettings> section and remove http://docshield.kofax.com/KTA from the key value: <add key="OnlineHelpURL" value="http:// docshield.kofax.com/KTA"/>.

    TotalAgility Export Connector

    1. Open Agility.Server.ExportConnector.exe.config in a text editor from the following location:

      \\TotalAgilityInstall\Agility.Server.Web\bin

    2. Locate the <appSettings> section and remove http://docshield.Kofax.com/KTA from the key value: <add key="OnlineHelpURL" value="http://docshield.kofax.com/KTA"/>.

      Alternatively, run the Configuration Utility (available from the TotalAgility Product installation files at \\TotalAgilityInstall\Utilities\ConfigurationUtility) and remove the URL for online help from the OnlinehelpURL setting.

    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

    1. Open configuration.xml in a text editor from the following location:

      \\Kofax\KIC-ED\MC\web

    2. Locate the <OnlineHelp>1</OnlineHelp> section and replace 1 with 0.

    TotalAgility Document Converter

    1. Open configuration.xml in a text editor from the following location:

      \\Kofax\Document Converter\web

    2. Locate the <OnlineHelp>1</OnlineHelp> section and replace 1 with 0.

  5. Save and close the configuration file.
    Clicking the Help icon will launch the help for the installed product.