› Product documentation

Product documentation

The full Kofax TotalAgility documentation set is available online on the Kofax TotalAgility documentation page.

To launch the online help for the installed version of the product, click the Help icon on the application.

When upgrading to TotalAgility 7.10.0 from an earlier version, make sure that the "Import system Workspace package" check box is selected to view the Workspace help online. If you do not select this option during the upgrade, then post upgrade, you must import the WorkspaceHeader form from the TotalAgility Workspace package.

Offline documentation

If the security policy for your organization restricts Internet access and requires you to access offline documentation while working with Kofax TotalAgility, you can download the compressed documentation files from the Kofax Fulfillment site.

The English .zip file includes both help and print folders. The print folder contains Kofax TotalAgility guides and the help folder contains the online help files. The .zip files for other languages contain only the localized help files. The documentation files available for offline use are mentioned in the following procedure.

This procedure describes accessing TotalAgility documentation offline for English.

  1. From the Kofax Fulfillment Site, download the documentation.zip file for the applicable language.
  2. Extract the contents of the compressed documentation file to your local computer.
  3. On the TotalAgility installation media, in the Agility.Server.Web\Help folder, create a subfolder 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 and make Web.config changes on the Application and Web servers.

    • Copy the contents from the Designer folder to:

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

      The TotalAgility installer creates the TotalAgility_designer and API folders within the Help folder. You must manually create other folders such as Workspace and TotalAgilityApps and then copy the contents into the respective folders.

    • Copy the contents from the Workspace folder to:

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

    • Copy the contents from the WebCaptureControl folder to:

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

    • Copy the contents from the TransformationDesigner folder to:

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

    • Copy the contents from KCKTM_Converter folder to:

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

    • Copy the contents from XDocBrowser folder to:

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

    • Copy the contents from the TenantManagementSystem folder to:

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

    • Copy the contents from the TotalAgilityApps folder to:

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

    • Copy the contents from the ExportConnector folder to:

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

    • Copy the contents from the activity (such as DocumentReviewActivity) folder within the CaptureClient folder to:

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

    • Copy the contents from the Devices folder to:

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

    • Copy the contents from the RepositoryBrowser folder to:

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

    • Copy the contents from the SDK_Documentation folder to:

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

    • Copy the contents from the DocumentConverter folder to:

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

    • Copy the contents from the MessageConnector folder to:

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

  4. Navigate to the installation folder and do the following:
    • For TotalAgility Designer help and Devices help, Transformation Designer help, XDoc Browser help and KC_KTM Converter help:

      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"/>.

        Alternatively, run the Configuration Utility (available from the Installation media at:

        \\TotalAgilityInstall\Utilities\ConfigurationUtility

        and remove the URL for online help from the OnlinehelpURL setting.

      For Transformation Designer, XDoc Browser and KC_KTM Converter Help to work offline, 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.

    • For TotalAgility Export Connector help:

      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"/>.

    • For TotalAgility Message Connector help:

      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.

    • For Document Converter help:

      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.