About this release > Product documentation

Product documentation

The full Kofax TotalAgility documentation set is available online:

https://docshield.kofax.com/Portal/Products/KTA/7.9.0-ud9cfx6hos/KTA.htm

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 following documentation files are available for offline use:

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.
  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:

    Note 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

      Note 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\help\en_US\help\TransformationDesigner

    • 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 help and Devices 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 Kofax 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 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.