BlueCielo Meridian Enterprise 2016 Administrator's Guide

Installing the webhelp documentation

The documentation for BlueCielo products is available in several formats:

• Printable Adobe PDF (.pdf) files
• Locally-installed Microsoft HTML Help (.chm) files
• Online webhelp (.htm) files

The Microsoft HTML Help files are installed and shown by default by the Meridian client applications. The webhelp files are available from BlueCielo by request.

The online webhelp files are shown when a user presses the F1 key within Meridian applications and the user has enabled the I prefer online help option in the User assistance experience group on the General tab in the Options dialog box of PowerUser. If the I prefer local help option is enabled, this value is ignored and the locally installed content (*.chm) files are shown instead. These options also affect the other Meridian client applications, for example, the web client, Meridian Enterprise Administrator and Meridian Enterprise Configurator.

The help documentation is hosted by BlueCielo at the URL http://documentation.bluecieloecm.com/. The documentation can also be hosted on your web server to place it inside of your organization's firewall if Internet access is not permitted, for example. In that case, you are responsible for installing and maintaining the documentation.

To install the webhelp documentation:

1. Create a folder structure on the web server where you want the files to reside. The folder structure should contain subfolders for the documentation for each language, product, version, and manual that will be installed. The folder structure should use the hierarchy: <Language>/<Product>/<MajorVersion>/<Document>. Valid names for these subfolders are listed in the following tables.
2. Copy the webhelp files (including any subfolders) to the web server in the appropriate <Document> subfolders.
3. If you did not create the folder structure within the default web site, create a virtual folder in the default web site that refers to the webhelp parent folder.
4. Set the WebHelpBaseURL registry value on each client computer that you want to show the installed documentation. For more information about the value, see HKEY_CURRENT_USER\Software\Cyco\AutoManager Meridian\CurrentVersion.
5. Set the WebHelpVersion registry value on each client computer that you want to show the installed documentation. For more information about the value, see HKEY_LOCAL_MACHINE\Software\Cyco\AutoManager Meridian\CurrentVersion
6. Instruct users to enable the I prefer online help option as described previously. Alternatively, set the UseWebHelp registry value on each client PC as described in HKEY_CURRENT_USER\Software\Cyco\AutoManager Meridian\CurrentVersion\Client\Settings.

Valid subfolder names for <Language> include: en

Valid subfolder names for <Product> include the following: 

Valid subfolder names for <MajorVersion> include the major version numbers (for example, 2016 or 2016 SP1) of Meridian Enterprise and its modules beginning with version 2012.

Valid subfolder names for <Document> include the following: 

Note    Not all documents are available for all products.

For example, if the Meridian Enterprise Administrator's Guide webhelp files are installed at //MeridianServer/BCWebHelp/en/meridian/2016/ag, the value of WebHelpBaseURL should be set to http://MeridianServer/BCWebHelp/. The trailing slash character is required.