Enabling the display of IBM Docs help

After you install IBM Docs with Connections, if users cannot see IBM Docs Help, you must enable its display by adding the help section for IBM Docs to the Connections Help system.

Procedure

  • If the Connections version is prior to 6.0, perform the following steps on the IBM® Connections Deployment Manager server.
    1. Get the installation files:
      1. Log in to the Deployment Manager server with an administrative account.
      2. Create one of the following directories:
        • Linux: /opt/install/Docs/IBMDocsHelp
        • Windows: C:\install\Docs\IBMDocsHelp
        .
      3. Copy the help package IBMDocsHelp/ibmdocshelp.update.zip from the installation package and paste it to the directory that you created.
    2. Install the IBM Docs Help plug-in:
      1. Open a terminal window under the root account.
      2. Navigate to the following directory: /opt/IBM/WebSphere/AppServer/profiles/dmgr/bin
      3. Execute the following command: ./wsadmin.sh –lang jython
      4. When prompted, enter your WebSphere® Application Server credentials. Suggested default values are as follows:
        Field Value
        WAS Administrative Username wasadmin
        WAS Administrator password password
      5. Enter the following command to add the IBM Docs Help plug-in to the IBM Connections Help.
        • # AdminApp.update("Help", "partialapp", ["-operation", "addupdate", "-contents", "/opt/install/Docs/IBMDocsHelp/ibmdocshelp.update.zip"])
      6. Enter the following commands. '/opt/install/Docs' is the path in step 1 where you paste the IBMDocsHelp folder.
        • execfile("connectionsConfig.py")
        • LCConfigHelp.setHelp('/opt/install/Docs/IBMDocsHelp','activities','blogs','bookmarks','communities','files','forums','homepage','wikis','ibmdocs')
        • AdminConfig.save()
          Note: If you want to add an extra application to the IBM Docs help, you must list all the applications for which you are already providing help. Only the help files for applications that you list as parameters in the LCConfigHelp.setHelp command are displayed in the table of contents.
For example, if you installed all of the applications except wikis and Connections Mail, you can run the following command to include only the installed sections in the help system:
          • 
LCConfigHelp.setHelp('/opt/install/Docs/IBMDocsHelp','activities','blogs','bookmarks',
'communities','files','forums','homepage','profiles', 'ibmdocs')
      7. Close the wsadmin console:
        • # quit
    3. Rebuild the table of contents. Run the following procedure to force the help system to rebuild the table of contents on each node servicing the Help application:
      1. Stop the Help application.
      2. Delete the following directory on the servers running the Help application:
        • Linux: /opt/IBM/Websphere/AppServer/profiles/<AppServer Profile>/temp/<Node Name>/<Cluster Name>/Help
        • Windows: C:\IBM\Websphere\AppServer\profiles\<AppServer Profile>\temp\<Node Name>\<Cluster Name>\Help
      3. Restart the Help application. The directory will be recreated on Startup.
  • Connections 6.0 is supported since IBM Docs 2.0 CR2. To display the IBM Docs help in Connections 6.0 integration, follow the steps:
    1. Get the installation files:
      1. Get the help package from the installation package: IBMDocsECMHelp.
      2. Navigate to the directory IBMDocsECMHelp\KowledgeCenter and zip the usr folder into ibm_docs_kcci.zip.
      3. Place the ibm_docs_kcci.zip file into the /tmp directory where you run wsadmin.
    2. Stop the Help application. Run the following command:

      AdminControl.invoke('WebSphere:name=ApplicationManager,process=server1,platform=proxy,node=lc45linux1Node01,version=8.5.5.9,type=ApplicationManager,mbeanIdentifier=ApplicationManager,cell=lc45linux1Node01Cell,spec=1.0', 'stopApplication', '[Help]')

      Note: The values in italic are pool server specific.
    3. Update the Help application. Run the following command:

      AdminApp.update('Help', 'partialapp', '[-contents /tmp/ibm_docs_kcci.zip]')

    4. Save the update. Run the following command:

      AdminConfig.save()

    5. Start the Help application. Run the following command:

      AdminControl.invoke('WebSphere:name=ApplicationManager,process=server1,platform=proxy,node=lc45linux1Node01,version=8.5.5.9,type=ApplicationManager,mbeanIdentifier=ApplicationManager,cell=lc45linux1Node01Cell,spec=1.0', 'startApplication', '[Help]')

    6. Change the help url in IBM Docs. In Docs WAS DM server, locate folder ${WAS_ROOT}/profiles/Dmgr01/config/cells/${CellName}/IBMDocs-config/. In the concord-config.json file, revise the text_helpurl, sheet_helpurl, and pres_helpurl lines to the following: 
      "text_helpurl" : "/help/SSFHJY_2.0.0/com.ibm.usingdocs.doc/text/document/documents_frame.dita",
"sheet_helpurl" : "/help/SSFHJY_2.0.0/com.ibm.usingdocs.doc/text/spreadsheet/spreadsheets_frame.dita",
 "pres_helpurl" : "/help/SSFHJY_2.0.0/com.ibm.usingdocs.doc/text/presentation/presentations_frame.dita",
    7. Synchronize IBM Docs nodes.
    8. Restart IBM Docs cluster.