About this release > Product documentation

Product documentation

You can access the full Kofax Communications Manager set for version 5.5.0 using the following link:

https://docshield.kofax.com/Portal/Products/KCM/5.5.0-3py4cyc64a/KCM.htm

You can also access the documentation directly from the product: When you click the Help button in KCM Designer, KCM Designer for Windows, KCM Core, or KCM Studio, documentation appears in a new browser window.

To access the online documentation, you must have an active Internet connection. If the security policy for your organization restricts Internet access or the Internet connection is not stable, you can access the documentation in offline mode while using the product. For more information, see the next section.

Offline documentation

To make the documentation available for use in offline mode, obtain the documentation files from the product package that you downloaded from the Kofax Fulfillment Site.

The product package includes the following documentation files for offline use:

  • KofaxCommunicationsManagerDocumentation_5.5.0_EN.zip: Contains the entire KCM documentation set in English. This file is required for all users working in offline mode.

  • Zip files that contain KCM Designer documentation translated to German, Spanish, French, Italian, Japanese, Dutch and Brazilian Portuguese. For example, the Spanish zip file name is KofaxCommunicationsManagerDocumentation_5.5.0_ES.zip.

    Note The KCM Designer online Help is the only item in the KCM documentation set that is translated to multiple languages at this time.

After you install the KCM product, follow the procedures below to extract the documentation .zip files for each KCM component as required. When you finish extracting the files, the documentation folder in each location will contain one or both of the following folders:

  • print with the PDF documentation

  • help with the KCM Designer Help

You can access the documentation in offline mode from these locations. Also, when you click a help button in a KCM component and select the required document, the system will open an offline, local copy of that document.

Note The names of the folders where you extract the documentation .zip files are hard-coded and case-sensitive. Do not rename the folders.

Offline documentation for KCM Designer Help

  1. Extract the contents of the help folder from the English documentation .zip file to:

    <deploy root>\<Tomcat installation folder>\Tomcat <version>\instance-WebDesigner-5.5\webapps\ccm_designer_<instance number>\doc\en

  2. If you require the Help in another language, extract the contents of the applicable documentation .zip file to the language folder, which resides here:

    <deploy root>\<Tomcat installation folder>\Tomcat <version>\instance-WebDesigner-5.5\webapps\ccm_designer_<instance number>\doc\<language>

    Supported languages:

    • de: German

    • es: Spanish

    • fr: French

    • it: Italian

    • ja: Japanese

    • nl: Dutch

    • pt_BR: Brazilian Portuguese

    For example, to use the KCM Designer Help in Spanish, extract the contents of the Spanish documentation .zip file to the es folder.

Offline documentation for KCM Studio and KCM Core Administrator

For KCM Studio and KCM Core Administrator, extract the print folder contents of the English documentation .zip file to:

<deploy root>\KCM\Documentation\5.5\en

Offline documentation for KCM Designer for Windows

For the KCM Designer for Windows component, which you install separately after the KCM product is installed, extract the contents of the English documentation. zip file to:

<deploy root>\KCM Designer Instance_<instance number>\Documentation\en

For more information on the KCM Designer for Windows installation and default location, see the Kofax Communications Manager Installation Guide.