Skip to main content

ARIS Technical Help

Make online help available (optional)

From Service Release 28 and higher, documents and online help are no longer installed. If your company does not allow access to the ARIS Documentation Website, you can provide this content using an internal Web server with SSL configuration and redirecting ARIS.

Prerequisites

  • You have access to a Web server with SSL configuration.

  • You have downloaded the zipped help file from the ARIS Download Center, for example ARIS_Installation_and_Documentation_<version>.zip, and unzipped it to the Root directory of your Web server.

Procedure. Procedure

  1. Start ARIS Cloud Controller (ACC) and establish a connection.

  2. Enter the path to your internal Web server on which the documents and the online help are provided:

    help.url="<URL to your Web server>"

    Syntax: "https://<server>:<port number>"

    The default path is: help.url="https://docs.aris.com/"

  3. To reconfigure the abs, copernicus, and arcm runnables using the help.url of your Web server, enter the following on all nodes:

    reconfigure abs_<s, m, or l> help.url="<URL to your Web server>"

    reconfigure copernicus_<s, m, or l> help.url="<URL to your Web server>"

    reconfigure arcm_<s, m, or l> help.url="<URL to your Web server>"

  4. To specify the version of the content to be used, enter the following for each runnable on all nodes:

    reconfigure <runnable> help.version="10.2026.4.0"

    Example

    reconfigure abs help.version="10.2025.10"

The help is redirected to your internal Web server.

After an update setup, the help on your internal Web server will keep the current version until you have downloaded the corresponding zipped help file from the ARIS Download Center and updated your Web server.