About this task
If your IBM
Docs environment includes IBM
Connections 4.0 CR2, use the Example section at the end of this procedure to modify the ConnectionsconnectionsConfig.py
file. Otherwise, you get errors like "Invalid component name specified: ibmdocs".
- Start the WebSphere® Application Server administrative client from the app_server_root\profiles\dm_profile_root\bin directory on the system where you installed the Deployment Manager. Enter the following command to start the wsadmin client:
./wsadmin.sh -lang jython -user admin_user_id -password admin_password -port SOAP_CONNECTOR_ADDRESS_PORT
You must start the client from this directory. See Starting the wsadmin client
in the IBM
Connections product documentation for more details.
- Enter the following command to add the IBM Docs Help plug-in to the IBM Connections Help .ear application: AdminApp.update("Help", "partialapp", ["-operation", "addupdate", "-contents", "/tmp/ibmdocshelp.update.zip"])
Note: ibmdocshelp.update.zip is available from the IBM Docs release package. Upload it to the IBM Connections Deployment Manager server to run this command.
- Enter the following command to access the IBM Connections configuration files: execfile("connectionsConfig.py")
- Enter the following command to specify which applications you want to include in the help system's table of contents:
- temp_directory is the name of a temporary directory on your system. The directory that you specify can be any directory, but it must exist before you enter the command. When you enter the command, an XML file that is called helpData.xml is added to this directory and is used by the command.
Note: AIX® and Linux™ only: The directory must grant write permissions or the command does not complete successfully.
- application_name is the name of the application whose help section you want to include in the table of contents. List each application name and use commas to separate the names. The options are as follows:
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 LCConfifigHelp.setHelp
command are displayed in the table of contents.
For example, if you installed all the applications except wikis and Connections Mail, you can run the following command to include only the installed sections in the help system:
- To force the table of contents in the help system to reflect the change, stop the help application and delete the temporary help directory on each node where help runs.
For example, delete the C:\IBM\WebSphere\AppServer\profiles\AppSrv01\temp\node-name\cluster-name\Help directory.
This directory is re-created when the application restarts.
When a user opens the product help system, the table of contents lists only those sections that you wanted it to include.
If a help topic links to a topic that is no longer in the help system, the link text continues to be displayed, but returns an error when clicked.
Connections 4.0 CR2, there is a known issue that the connectionConfig.py file is not updated with the required "ibmdocs" configurations. If you get the following message, you must manually edit the file.
"Invalid component name specified: ibmdocs"
The file to edit is app_server_root\profiles\dm_profile_root\bin\connectionConfig.py
. Make sure the entries for allComponents
include one for IBM
Docs and are the same as the entries that follow.
Parent topic: Mandatory post-installation tasks
allComponents = ["activities", "blogs", "bookmarks", "communities", "files",
"forums", "homepage", "profiles", "wikis", "icmail", "ibmdocs"]
tocEntries = ["/com.ibm.lotus.connections.activities.help/activities_FAQ.xml",