1.877.833.1202

Creating Customized Online Help for FileHold

The software has context sensitive online help that takes you directly to the help page in our Knowledge Base. By default, all help requests are directed from the FileHold client (both the Desktop Application and the Web Client) by clicking the ? (question mark) found throughout the product to the associated help page shared over the internet. In some cases, customers or resellers may wish to create their own custom help for FileHold. The help can be customized for content, language, version, and client type (FDA and Web Client).

The default FileHold online help system is based on XML and asp.net. The instructions on how to create a customized help system are not included here, but if you need assistance you can contact sales@filehold.com for a price quote.

If you have the ability to create your own online help system, the following describes how the help file (helpmap.xml) can be modified to point to your own customized online help system for FileHold.

There are two files on the server that are referred to when calling the online help:

1. web.config -- Defines the name of the xml file used for the help system configuration. The default filename is helpmap.xml.

2. helpmap.xml  -- The help system configuration file that contains information such as the URL to the help system, the language, version, client type, help IDs, and the associated URLs for the help IDs.

Web.config File

The web.config file contains the name of the xml file that contains the information for the help system configuration. It is recommended that you keep the default file name and not modify this setting.

The web.config file is located on the FileHold server (Windows 2008): C:\Program Files\FileHold Systems\Application Server\HelpSystem.

Under <appsettings> enter the name of the help xml file in the "value" area. For example:

<configuration>
     <appSettings>
           <add key="helpmap" value="helpmap.xml"/>
     </appSettings>
     ...
</configuration>

Default Helpmap.xml File

The helpmap.xml file contains the configuration information for the help system. The default helpmap.xml file is located on the FileHold server (Windows 2008): C:\Program Files\FileHold Systems\Application Server\HelpSystem.

The xml file contains following elements:

  • <help> — The root element
  • <customURL> — Allows to redirect request to a custom url. Optional attributes: verId, lang, client. Tokens: {helpId}, {verId}, {lang}, {client}.
  • <baseURL> — Contains the base URL of a help content. Optional attributes: verId, lang, client.
  • <helpmap> — Element that contains the helpID and article.
  • <helpID> — Contains help identifier (helpID) located throughout the FileHold document management software.
  • <article> — Contains a relative URL that the helpID points to. Optional attributes: verId, lang, client.

Sample of the default helpmap.xml file:

<help>
  <!--
    Custom Url Tokens:
      - {helpId},
      - {verId},
      - {lang},
      - {client}.
   
    The 'customURL' element's optional attributes:
    - verId,
    - lang,
    - client.
   
    E.g.
    <customURL>http://www.yourdomain.com/help/?h=
External Links icon
{helpId}</customURL>
  -->
  <customURL>/help/HelpSystem/help.aspx?helpID={helpId}&amp;verID={verId}&amp;lang={lang}&amp;client={client}</customURL>
  <!--
    The 'baseURL' element's optional attributes:
    - verId,
    - lang,
    - client.
 
    Note:
    If there is no 'customURL' element without attributes
    the 'baseURL' element without attributes is required.
    <baseURL>/help/</baseURL>
  -->
  <!-- <errorURL>http://www.yourdomain.com/error.html</errorURL>
External Links icon
-->
  <!-- EXAMPLE
    The 'article' element's optional attributes:
      - verId,
      - lang,
      - client.
    Client types:
      - fda,
      - web,
      - fsc.
   
    Note:
    The 'article' element without attributes is required.
  <helpmap>
    <helpID>example</helpID>
    <article>example/default.html</article>
    <article verID="FH60">example/defaultv60.html</article>
    <article verID="FH65">example/defaultv65.html</article>
    <article verID="FH60" lang="pl">example/defaultv60pl.html</article>
    <article verID="FH60" lang="en">example/defaultv60en.html</article>
    <article verID="FH60" lang="en" client="fda">example/defaultclientv60en.html</article>
  </helpmap>
  -->
</help>

Customized Helpmap.xml File Example

The following is an example of a modified helpmap.xml file that directs requests all from the Web Client to a custom help system for the Polish language and directs all the requests from the FDA to the English language (default) help system at the URL www. myhelp.com.

<help>
  <customBaseURL lang="pl">http://wwww.myhelp.com/?h={helpid}</customBaseURL>
  <baseURL>http://www.myhelp.com/help/</baseURL>
  <treeURL>sitemap.html</treeURL>
  <helpmap>
    <helpID>example</helpID>
    <article client="fda">example/default.html</article>
    <article client="web" lang="pl">example/default_pl.html</article>
  </helpmap>
  ...
  <helpmap>
  ...
  </helpmap>
</help>

HelpIDs for Customizing the Software Online Help

Use the FileHold helpIDs to create custom URLs in the helpmap.xml file.

Download the list of FileHold helpIDs and the associated URLs.

Additional Information About the FileHold Help System

When the software is installed, the following file is automatically configured to point to the help on your server (Windows 2008):C:\Program Files\FileHold Systems\Application Server\WebClient\web.config.

Under <appSettings>, the

<add key="HelpSystem" value="http://exampleyourservername/FH/FileHold/HelpSystem/"/>

sets the location of help files. It is recommended that you do not change this without the assistance of the FileHold support team.