SAFE X3 V2 configuration console > Documentation server 

The documentation server provides the documentation for implementing the configured solution. This documentation is supplied in a compressed format (CHM format) under windows and decompressed (HTML) for UNIX.

From the version V7 on, the product documentation is available on line. A documentation server component exists and can be configured for the product, even though it is neither configured nor managed by the Configuration console Safe X3 V2.

Configuration

To implement the Documentation server, it is necessary to:

  • load the Documentation Server component,
  • configure the Documentation Server component,
  • publish the solution on the Documentation server.

Loading

To change this component click Add in the documentation server panel.

For more information on the component loading dialog box, see the documentation on the Parameters entry component.

The Console loads the different parameters of the Documentation server component:

The status of the Documentation component is Idle. Once configured, this value changes to Active.

Configuration

Documentation access format

Two types of access to the documentation exist: The access type chosen depends on the client used and the operating system:

  • Compressed format (CHM)
    • Only for a Client Server client if the documentation server is installed on a Windows machine.

  • Decompressed format (HTML)
    • For a CS client if the documentation server is installed on a Windows machine.
    • For a CS client if the documentation server is installed on a UNIX machine.
    • Mandatory for a Web client irrespective of the machine (Windows or Unix).

To configure the Documentation server component, enter the mandatory parameter:

  • Root access for the documentation: path to access the documentation via the SAFE X3 C/S client (with a UNC path, you must manually share the directory used to access the documentation on the server).
  • Use format of the client workstations: informs the SAFE X3 client that it needs to be configured to use the help at a compressed format (CHM) or decompressed format (HTML).

If you choose to publish your documentation via an Apache server installed on the same machine as the documentation server, you can enter the Apache installation path parameter. When this setup is entered, the console adds an alias (/AdxDoc_[DocComponentName]) in the httpd.conf of the Apache server.
If the Documentation Server component is located on a Unix server, you must manually restart the Apache server to take this new alias into account.

For the SAFE X3 Client Server client to access the documentation via the Apache server of the documentation server, the value of the Root access for the documentation parameter needs to be: http://[MachineName][HTTPPort]/AdxDoc_[DocComponentName]

Once the parameter(s) is/are entered, click Configure.

You can check the access to the documentation: click Doc. TestClient or Doc. testWeb.

If the application is destined to be used via Web, the documentation format must be ‘decompressed’. To change this format, click “Decompress (HTML)”. button. After the documentation has been decompressed, the value of the Documentation decompressed parameter changes to Yes.

The documentation installed on a UNIX server is always supplied in the decompressed format. It is not useful to perform a Decompress/Compress action.

Important note: no space in the documentation server installation path.

Documentation format

Documentation format

If the application is destined to be used via Web, the documentation format must be ‘decompressed’. To change this format, click "Decompress (HTML)". After the documentation has been decompressed, the value of the Documentation decompressed parameter changes to Yes.

This operation is used to extract all the documentation in HTML format from the CHM file. Once the Documentation decompressed parameter changes to Yes, and thus the generated HTML files as well, it is no longer possible to go back to the compressed documentation status.

The documentation can be decompressed at any time using the Decompress (HTML)button. This operation will nevertheless overwrite the existing HTML files if the documentation has already been decompressed.

It is also possible to "compress" the documentation in order to create a CHM file from the existing HTML files. This operation overwrites the original CHM file and replaces it with the new CHM file generated from the existing HTML files. It is not possible to compress a Documentation that has has not been broken down. To compress a documentation, click Compress (CHM). In order for the CHM generation to take into account new documentation HTML files, these must be indexed in the current documentation. As a matter of fact, the CHM generator works in "spider" mode and finds the new documentations by following the HTML links of the current documentation. Simply add the links in the HTML document of the general index.

Note: These operations can take a while if the documentation is installed in several languages. In effect, the compression or breaking down of the documentation is applied to all the languages installed for the documentation.

Publish

Solution publication

To publish the solution on the documentation server, click Documentation Server and then Publish.

Click Add in the toolbar and select the solution to publish in the list of the solutions managed by the console.

Following the publication, the documentation is automatically available in the help menu of the SAFE X3 client.

Update

To update the documentation server, follow these steps:

  • Install the update (check out the installation procedures for further information) in order to replace your version with the new one.
  • Select the documentation server to be configured in the Documentation servers panel.
  • For Windows, decompress the CHM if necessary by clicking Uncompress (HTML).
  • Click Configure to update the configuration of the component and the existing publications.

Note: During the configuration, all the published solutions should be accessible in order to update the documentation information. If some solutions cannot be accessed or are locked, warnings will be sent upon configuration of the Documentation server component.

Deconfiguration

To unconfigure the Documentation Server component, follow the steps described below:

  • Unpublish all the solutions published on the Documentation Server in the Publicationscreen.
  • Click Deconfigure In the configuration screen of the Documentation Server component: the component status changes from Active to Idlescreen. 
  • Uninstall your component on the host server.