How To Configure Offline Help in WebFOCUS Reporting Server 9.3.0?

How To Configure Offline Help in WebFOCUS Reporting Server 9.3.0?

book

Article ID: KB0070256

calendar_today

Updated On:

Products Versions
ibi WebFOCUS 9.3.0

Description

Description :
Starting from WebFOCUS Release 9.3.0, the primary documentation (manuals, release notes, and other core documents) is not shipped with the WebFOCUS Reporting Server.
For users who use outside firewall blocking, for security reasons or prefer local documentation (typically due to internet latency), can download local copies from docs.tibco.com.

How To Configure Offline Help in WebFOCUS Reporting Server 9.3.0?


 

Issue/Introduction

How To Configure Offline Help in WebFOCUS Reporting Server 9.3.0?

Environment

Windows

Resolution

Procedure :

 

  1. To download the documentation zip file for the applicable product and release, go to its home page on docs.tibco.com and click the Download All Docs button.

  2. Transfer the zip file to the machine where the WebFOCUS Reporting Server resides and unzip it to a directory. Note that this directory must not be a directory under the server's home directory (as it would be deleted during a server update).

  3. In any editor or Web Console, add the following code to the server’s main configuration file (edaserve.cfg). This file is in the bin directory.

    hosted_help_url=http://myhost:myport/ibi_html/Default.htm
    

    where,

    myhost is the hostname where you have installed the WebFOCUS Reporting Server.

    myport is the HTTP port for the server.

    Important: This URL is case-sensitive. The case for the string must be exactly ibi_html/Default.htm or accessing the help fails.

    Here is an example of the edaserve.cfg file:
    -----------------------------------------------------------
    edahome = C:\ibi\srv92\home
    workspace_manager_name = "WebFOCUS 92 Server"
    server_type = ffs
    cfg_date = 02/09/2024 14:25:26
    nodejs_url = http://mycompany:8126
    hosted_help_url=http://mycompany:8121/ibi_html/Default.htm
    ----------------------------------------------------------------------------------

  4. In any editor or Web Console, add the following code to the server communications configuration file (odin.cfg) in the HTTP listener block. This file is in the etc directory.

    IBI_HTML = my_downloaded_doc_directory

    where,

    my_downloaded_doc_directory is the location of the directory where you unzipped the documentation zip file. This directory must contain the Default.htm file as well as other files and directories from the zip. Note that the location must be on the same machine as the WebFOCUS Reporting Server and should not be under the server home directory.

    Here is an example of the odin.cfg file:

    NODE = LST_HTTP
    BEGIN
      PROTOCOL = HTTP
      PORT = 8121
      CLASS = AGENT
      IBI_HTML = C:\Users\webfocus\wf-rs\documentation
    END
    
    ------------------------------------------
    
  5. Recycle the server.

    In case you desire to use a third-party server, you do not need to make any changes to the odin.cfg file. The value of hosted_help_url would be whatever the third party’s server URL path is set up for the Default.htm file. For example, http://mycompany/ibi-rs-documentation/Default.htm.