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

• KofaxRPADocumentation-11.2.0_EN.zip

  Contains the entire Kofax RPA documentation set in English.

• KofaxRPADocumentation-11.2.0_JA.zip

  Contains the entire Kofax RPA documentation set in Japanese.

• KofaxRPADocumentation-11.2.0_FR.zip

  Contains the entire Kofax RPA documentation set in French.

After you install the Kofax RPA product, extract the contents of the documentation .zip files for the languages you require. The .zip file for each language contains the following folders:

• API

• Best Practices

• Design Studio
• Desktop Automation Service
• Management Console
• Process Discovery

After you extract the files, the documentation folder for Design Studio, Desktop Automation Service, and Process Discovery will have the following structure:

• EN, JA, or FR (English, Japanese, or French, respectively)

  • print and/or help (PDF documentation and Help for Kofax RPA, respectively)

For the Management Console, there are no documentation or language code folders, and only the ManagementConsoleHelp.war file will be added to the Management Console program files.

When the offline documentation is installed for an RPA component according to the instructions below, the component will use the offline version of the documentation by default, even if an active Internet connection exists.

Offline API documentation

The API folder contains the API references in English.

1. Copy the API folder from the English .zip file extracted above to any folder on your computer.

2. In this folder, double-click Overview.html to open the API documentation.

Offline documentation for Design Studio

1. Open the Design Studio folder from the English .zip file extracted above and copy the EN folder to the following folder:

   C:\Program Files\Kofax RPA 11.2.0.0\documentation

2. If you require the Japanese or French documentation, open the Design Studio folder from the Japanese or French .zip file extracted above and copy the JA/FR folder to the same location.

3. Start Design Studio and navigate to Settings > Design Studio Settings.

4. On the General tab, in Documentation location, select Offline in the list.

5. Save the changes.

To switch to online mode, select Online in Design Studio Settings and save the changes.

Offline documentation for Management Console

1. Open the Management Console folder from the English .zip file extracted above and copy the ManagementConsoleHelp.war file to:

   C:\<Tomcat installation folder>\Tomcat <version>\webapps

   Note The English, Japanese, and French .zip files contain the same .war file, which includes English, Japanese, and French documentation, respectively. If you copied the .war file from the English .zip file and you require the Japanese or French version of documentation, no further actions are needed.

2. Start the Management Console.

3. Open Settings > General > Base URL.

4. Select Use local documentation. In Local documentation base URL, specify the URL to the Tomcat website containing the documentation.

   Example: http://localhost:8080/ManagementConsoleHelp/

5. Save the changes.

You may need to refresh the Management Console for the changes to take effect.

To switch to online mode, clear Use local documentation in the Base URL settings and save the changes.

Offline documentation for Desktop Automation Service

1. Navigate to the folder documentation that resides in:

   C:\Program Files\RPA DesktopAutomation 11.2.0.0

2. Open the Desktop Automation Service folder from the English .zip file extracted above and copy the EN folder to the documentation folder.

3. If you require the Japanese or French documentation, open the Desktop Automation Service folder from the Japanese or French .zip file extracted above and copy the JA/FR folder to the same location.

To switch to online mode, delete or move the documentation folder from the RPA DesktopAutomation 11.2.0.0 folder.

Offline documentation for Process Discovery

1. In each of the following folders, create a new folder called documentation.

   • C:\Program Files (x86)\Kofax RPA Process Discovery Agent 11.2.0.0

   • C:\Program Files (x86)\Kofax RPA Process Discovery Analyzer 11.2.0.0

2. Open the Process Discovery folder from the English .zip file extracted above and copy the EN folder to the newly created documentation folders.

3. If you require the Japanese or French documentation, open the Process Discovery folder from the Japanese or French .zip file extracted above and copy the JA/FR folder to the same locations.

To switch to online mode, delete or move the documentation folder from the Kofax RPA Process Discovery Agent 11.2.0.0 and Kofax RPA Process Discovery Analyzer 11.2.0.0 folders.

Offline documentation for Kapplets

The offline documentation for Kofax RPA Kapplets is contained in the same .war file as for the Management Console, which you have already copied from the English.zip file to the required location on your computer (Tomcat installation folder). To use the Kapplets documentation in offline mode, follow these steps.

1. Depending on whether Kapplets are installed in embedded mode, on Tomcat, or on Docker, configure the required properties in the respective configuration file. For information on each installation scenario, see "Install Kapplets" in the Kofax RPA Installation Guide.

   • Embedded mode. Create an application-help.properties file using the following template and place it next to the application.properties file in the folder where Kapplets are run.

     kapplets.services.mc.connection.url=http:// <host-url>:<port>/ManagementConsole
     kapplets.services.mc.connection.username=<username>
     kapplets.services.mc.connection.password=<password>
     kapplets.services.help.languages-map[en]=EN
     kapplets.services.help.languages-map[ja]=JA
     kapplets.services.help.languages-map[fr]=FR
     kapplets.services.help.base-url=http://<host-url>:<port>/ManagementConsoleHelp/@@language@@/help/kap_help/kapplets
     kapplets.services.help.landing-url=http://<host-url>:<port>/ManagementConsoleHelp/@@language@@/help/kap_help/kapplets/c_rpakappletsmain.html
     

   Note In this scenario, the offline documentation can be used only if the Management Console is deployed on Tomcat.

   • On Tomcat. To the kapplets.xml file, add the following properties at the end of the file.

     <Environment name="kapplets.services.help.languages-map[en]" value="EN"   type="java.lang.String" override="false"/>
     <Environment name="kapplets.services.help.languages-map[ja]" value="JA"   type="java.lang.String" override="false"/>
     <Environment name="kapplets.services.help.languages-map[fr]" value="FR"   type="java.lang.String" override="false"/>
     <Environment name="kapplets.services.help.base-url" value="http://<host-url>:<port>/ManagementConsoleHelp/@@language@@/help/kap_help/kapplets"   type="java.lang.String" override="false"/>
     <Environment name="kapplets.services.help.landing-url" value="http://<host-url>:<port>/ManagementConsoleHelp/@@language@@/help/kap_help/kapplets/c_rpakappletsmain.html"   type="java.lang.String" override="false"/>
     

   • On Docker. In the docker-compose.yml file, add the following properties at the end of the file.

      - KAPPLETS_SERVICES_HELP_LANGUAGES-MAP[en]=EN
      - KAPPLETS_SERVICES_HELP_LANGUAGES-MAP[ja]=JA
      - KAPPLETS_SERVICES_HELP_LANGUAGES-MAP[fr]=FR
      - KAPPLETS_SERVICES_HELP_BASE-URL=http://<host-url>:<port>/ManagementConsoleHelp/@@language@@/help/kap_help/kapplets
      - KAPPLETS_SERVICES_HELP_LANDING-URL=http://<host-url>:<port>/ManagementConsoleHelp/@@language@@/help/kap_help/kapplets/c_rpakappletsmain.html
     

2. Save the file. You may need to restart the Tomcat server for the changes to take effect.

To switch to online mode, delete the four properties from the configuration file, save the changes, and restart the server.