› Product documentation

Product documentation

The documentation set for Kofax RPA is available here:1

https://docshield.kofax.com/Portal/Products/RPA/11.3.0_5cdzhlgb3t/RPA.htm

You can also access individual guides and online help directly from Kofax RPA. When you click the help button in Design Studio, Management Console, Desktop Automation Service, Process Discovery and Kapplets online documentation appears in a new browser window.

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.

Offline documentation

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.3.0_EN.zip

    Contains the entire Kofax RPA documentation set in English.

  • KofaxRPADocumentation_11.3.0_JA.zip

    Contains the entire Kofax RPA documentation set in Japanese.

  • KofaxRPADocumentation_11.3.0_FR.zip

    Contains the entire Kofax RPA documentation set in French.

  • KofaxRPAManagementConsoleDocumentation-11.3.0.zip

    Contains the documentation for Management Console and Kapplets in English, Japanese, and French.

After you install the Kofax RPA product, follow these steps:

  1. Extract the contents of the KofaxRPADocumentation ZIP file for the language you require to a location on your computer.

    Then, rename the extracted folder to either EN, JA, or FR, depending on the language code specified in the .zip file name. For example, KofaxRPADocumentation_11.3.0_EN must be renamed to EN.

    The extracted folder for each language contains the following folders:

    • api
    • help
    • print
    • Resources

  2. Extract the contents of the KofaxRPAManagementConsoleDocumentation ZIP file to a location on your computer.

    You do not need to rename the extracted folder.

    The extracted folder contains the KofaxRPAManagementConsoleDocumentation.war file that includes the documentation in all of the three languages.

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 that you extracted from either of the KofaxRPADocumentation ZIP files contains the API references in English. You can access the RoboSuite Java and RoboSuite .NET API documentation from this folder.

Offline documentation for Design Studio

  1. Navigate to the location where you renamed the extracted documentation folder.

  2. Copy the EN, JA, or FR folder to the documentation folder inside the product files:

    Example: C:\Program Files\Kofax RPA 11.3.0.0\documentation

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

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

  5. Save the changes.

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

If you try to access the online documentation from Kofax RPA without Internet access, the Retrieving help and documentation warning is displayed. If you select Do not show this notification again and later you want to reset this option, select Show documentation retrieval notifications on the General tab in Design Studio Settings.

Offline documentation for Management Console

  1. Navigate to the location that contains the extracted KofaxRPAManagementConsoleDocumentation.war file.

    The .war file includes the documentation in all of the three languages, and the documentation to use will depend on the language that the Management Console is set to.

  2. Copy the file to:

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

  3. Start the Management Console.

  4. Open Settings > General > Base URL.

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

    Example: http://localhost:8080/KofaxRPAManagementConsoleDocumentation

  6. 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 location where you renamed the extracted documentation folder.

  2. Copy the EN, JA, or FR folder to the documentation folder inside the product files:

    Example: C:\Program Files\RPA DesktopAutomation 11.3.0.0\documentation

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

Offline documentation for Process Discovery

  1. In each of the installation folders, create a new folder called documentation. The actual path to the folders may be different.

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

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

  2. Navigate to the location where you renamed the extracted documentation folder.

    Copy the EN, JA, or FR folder to the newly created documentation folders.

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

Offline documentation for Kapplets

The offline documentation for Kofax RPA Kapplets is contained in the KofaxRPAManagementConsoleDocumentation.war file that you have already copied to the 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://:/KofaxRPAManagementConsoleDocumentation/@@language@@/help/rpa_help/help_main/kapplets
kapplets.services.help.landing-url=http://:/KofaxRPAManagementConsoleDocumentation/@@language@@/help/rpa_help/help_main/kapplets/c_rpakappletsmain.html

    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://<hosturl>:<port>/KofaxRPAManagementConsoleDocumentation/@@language@@/help/rpa_help/help_main/kapplets" type="java.lang.String" override="false"/>
<Environment name="kapplets.services.help.landing-url" value="http://<hosturl>:<port>/KofaxRPAManagementConsoleDocumentation/@@language@@/help/rpa_help/help_main/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>/KofaxRPAManagementConsoleDocumentation/@@language@@/help/kap_help/kapplets
 - KAPPLETS_SERVICES_HELP_LANDING-URL=http://<host-url>:<port>/KofaxRPAManagementConsoleDocumentation/@@language@@/help/kap_help/kapplets/c_rpakappletsmain.html

  2. Save the file. If Kapplets are installed on Tomcat and you adjusted the kapplets.xml file, you may need to restart the Tomcat server for the changes to take effect.

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

1 You must be connected to the Internet to access the full documentation set online.