Installing the Archibus Help Systems Locally
Accessing Archibus Help from the Archibus Help URL
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 Navigator's processes) automatically brings you to the latest help systems that are stored on the Archibus web site. For example, https://help.archibus.com/user_en/archibus.htm.
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.
Install Archibus 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.
Users running the Apache Tomcat application server can install the help systems on your network by requesting the help zip files from Archibus Customer Service. Follow the procedure for your application server:
Once you install the help locally using the above links, see the Reference section below for accessing it.
Note: Beginning with Archibus V26.1, we provide a series of zip files rather than a war file that automatically deploys.
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:
- 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.
- Replace the values in
< >accordingly.help.url=http://<ComputerName>:<PortNumber>/archibus_help/user(user.helpExtension)/archibus.htmHelp.SystemAdministrationUrl= http://<ComputerName>:<PortNumber>/archibus_help/system/sysman.htm
-
In order to the above change to work with Help commands on the home pages, you must republish home pages. From the Navigator, run the System / Add-In Manager / Publish Home Pages by Role task.
Reference: how to access the Archibus online help
Locally-installed online help
Set up shortcuts to these paths.
| Help System | URL |
|---|---|
| Archibus User Help (English) | http:// <SystemName>:<PortNumber>/archibus_help/user_en/archibus.htm
|
| System Management Help | http:// <SystemName>:<PortNumber>/archibus_help/system/sysman.htm
|
| Non-English Archibus User Help | the URL includes the locale suffix added to the "user" folder, such as:http:// <SystemName>:<PortNumber>/archibus_help/user_fr/archibus.htm |
Online help on the Archibus web site
You can access the English help systems online at the below URLs:
| Help System | URL |
|---|---|
| Archibus User Help (English) | https://help.archibus.com//user_en/archibus.htm |
| System Management Help (English) | https://help.archibus.com/system/sysman.htm |
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: https://help.archibus.com//user_fr/archibus.htm.
| Language | Locale ID |
|---|---|
| German | de |
| French | fr |
| Italian | it |
| Spanish | es |