Offline documentation

The folder that you extracted from one of the TungstenRPADocumentation.zip files contains the API references in English. Access the RPA Java and RPA .NET API documentation from this folder.

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\Tungsten RPA 2025.2.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.

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

   The .war file includes documentation in all three languages. The language settings in Management Console determine which language is used.

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/TungstenRPAManagementConsoleDocumentation

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.

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\Tungste RPA Desktop Automation 2025.2.0.0\documentation

To switch to online mode, delete or move the documentation folder from the Tungsten RPA Desktop Automation 2025.2.0.0 folder.

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\Tungsten RPA Process Discovery Agent 2025.2.0.0

   • Example: C:\Program Files\Tungsten RPA Process Discovery Analyzer 2025.2.0.0

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

3. 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 Tungsten RPA Process Discovery Agent 2025.2.0.0 and Tungsten RPA Process Discovery Analyzer 2025.2.0.0 folders.

The offline documentation for Tungsten RPA Kapplets is contained in the TungstenRPAManagementConsoleDocumentation.war file that you 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, refer to "Install Kapplets" in the Tungsten 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 run.

     kapplets.services.mc.connection.url=http://<host-url>:<port>/ManagementConsole
     kapplets.services.mc.connection.shared-secret=<shared-secret-in-plain-text>
     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://:/TungstenRPAManagementConsoleDocumentation/@@language@@/help/rpa_help/help_main/kapplets
     kapplets.services.help.landing-url=http://:/TungstenRPAManagementConsoleDocumentation/@@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.

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

   • 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>/TungstenRPAManagementConsoleDocumentation/@@language@@/help/kap_help/kapplets
      - KAPPLETS_SERVICES_HELP_LANDING-URL=http://<host-url>:<port>/TungstenRPAManagementConsoleDocumentation/@@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.