FileNet P8 Platform, Version 5.2.1              

Accessing the documentation

The base documentation URL identifies the server where the IBM® FileNet® P8 documentation is located. You must decide whether you want to access the online documentation in IBM Knowledge Center or a locally installed information center.

About this task

The simplest way to access documentation is by using the IBM FileNet P8 online documentation at http://www.ibm.com/support/knowledgecenter/SSNW2F_5.2.1. However, if this is not possible, for example because your application is in an environment where internet access is not available, you can install documentation on a local application server and deploy the help as a web application. The following table compares the options.

Table 1. Comparing IBM Knowledge Center online documentation and the local information center
  Online documentation Local information center
Requires internet access Yes No
Requires local application server No Yes
Supports mixed versions of IBM FileNet P8 components No Yes
Is customizable No Yes

If you install the information center locally, you can use an application server that is uniquely dedicated for that purpose, or you can use one that is prepared for Content Platform Engine, Application Engine, or Workplace XT.

Procedure

To determine the value for the base documentation URL for your documentation:

  1. Determine the base documentation URL as follows, depending on which documentation option you have chosen to use:
    Option Description
    Online documentation in IBM Knowledge Center http://www.ibm.com/support/knowledgecenter/SSNW2F_5.2.1/
    Locally installed information center http://server-name:port/application-name/topic/
    server-name
    The name of the server where the IBM FileNet P8 local information center will be installed.
    port
    The optional port number.
    application-name
    The name of the deployed IBM FileNet P8 documentation application. The application name is typically p8docs.

    For a server-name of myserver, a port of 8080, and an application-name of p8docs, the base documentation URL is http://myserver:8080/p8docs/topic/.

  2. Icon representing the worksheet
    Record the base documentation URL in your customized Installation and Upgrade Worksheet for each instance of that property for each component that requires it. To find this property, search the worksheet for instances of Documentation server URL or Documentation URL in Column F, Property or Parameter (in user interface).
    Option Description
    Workplace XT Append com.ibm.p8.xt.user.doc/ to the initial portion of the base documentation URL. For example, the base documentation URL for Workplace XT would be http://www.ibm.com/support/knowledgecenter/SSNW2F_5.2.1/com.ibm.p8.xt.user.doc/.
    Workplace Append com.ibm.p8.doc/ to the initial portion of the base documentation URL. For example, the base documentation URL for Workplace would be http://www.ibm.com/support/knowledgecenter/SSNW2F_5.2.1/com.ibm.p8.doc/.
    All other components Enter only the initial portion of the base documentation URL, for example, http://www.ibm.com/support/knowledgecenter/SSNW2F_5.2.1/.


Last updated: March 2016
p8ppi166.htm

© Copyright IBM Corporation 2013, 2016.