Installing the ARCHIBUS Help Systems Locally

Online Help on the ARCHIBUS web site

Accessing online help from Web Central, Smart Client, or the Smart Client Extension for CAD programs (either through the Help command or right-clicking on the Process Navigator) automatically brings you to the latest help systems that are stored on the ARCHIBUS web site.

ARCHIBUS automatically loads the online help system  for the language that is specified as your locale.

Since the help systems stored on the ARCHIBUS web site are continually updated, you will be working with the very latest help release from ARCHIBUS, Inc.

Install online help locally

Some sites wish to have users access the online help from the company's network rather than from the ARCHIBUS web site. In this case, you can install the help locally on your network.

You can install the help systems on your network by obtaining them from the ARCHIBUS DVD. Follow the procedure for your application server:

• Jetty
• Apache Tomcat
• IBM WebSphere
• Jboss
• Oracle WebLogic and BEA WebLogic 8.x

Once you install the help locally using the above links, see the Reference section below for accessing it.

Configuring the Help commands to access the locally-installed help

By default, the Help commands look for the online help systems on the ARCHIBUS web site. To have the Help commands access the locally-installed help, follow these instructions:

1. Open WEB-INF\config\help.properties for editing, update the file as shown below, and save it. If you cannot overwrite the file, save it in other location, and copy it over.
2. Replace the values in < > accordingly.
   • help.url=http://<ComputerName>:<PortNumber>/archibus_help/user(user.helpExtension)/archibus.htm
   • Help.SystemAdministrationUrl= http://<ComputerName>:<PortNumber>/archibus_help/system/sysman.htm

3. In order to the above change to work with Help commands on the home pages, you must republish home pages. From the Web Central Process Navigator, run the System Administration / ARCHIBUS System Administration / Add-In Manager / Publish Home Pages by Role task.

Reference: how to access the ARCHIBUS online help

Locally-installed online help

On the Windows Start/All Programs/ARCHIBUS menu, select the menu shortcut for accessing the user help.

You can also set up shortcuts to these paths.

Online help on the ARCHIBUS web site

You can access the English help systems online at the below URLs:

For non-English versions of ARCHIBUS User Help, the URL has the format, user_<Locale> where Locale is the language locale ID as shown in the table below. For instance, the URL for the ARCHIBUS User Help in French is: http://www.archibus.com/ai/abizfiles/v23_help/archibus_help/user_fr/archibus.htm.