Manually integrating HCL Docs with Connections

HCL Connections Docs is supported on a larger set of operating systems than what HCL Docs officially supports. HCL Docs and File Viewer extensions are required to be installed on the Connections server. If the operating system does not support the scripts provided or does not support the required level of Python, you might need use a manual process to integrate HCL Docs into your HCL Connections deployment.


  1. Import an object type for HCL Docs files.
    1. Copy the <Unzipped_Docs_Install_Package>/config/ibmdocs.xml file to the Connections Files customization folder (<connections_install>\data/shared/customization/objecttypes).
  2. Configure the URL customizer (files-url-config.xml)
    1. Locate files-url-config.xml in the WebSphere® Application Server Deployment Manager configuration folder.
      Example: was_install/profiles/Dmgr01\config\cells\CELLNAME\LotusConnections-config\files-url-config.xml.
    2. Copy and paste the following example into the XML file, within the existing <config></config> tags. If you are using different ports for HTTP and HTTPS, you must update the port numbers.
      <objectType name="ibmdocs:file"  urlCustomizer=""> 
      <property name="server.port.http" value="[default port, like 80] "/>
      <property name="server.port.https" value="[ssl port, like 443]"/> 
      <property name="link.custom" value="/docs/app/doc/lcfiles/{fileId}/editorview/content"/> </objectType>
  3. Configure files-config.xml file for HCL Docs.
    1. Locate files-config.xml in the WebSphere® Application Server Deployment Manager configuration folder.
      Example: was_install/profiles/Dmgr01/config/cells/CELLNAME/LotusConnections-config/files-config.xml
    2. Copy and paste the following content (used to define the app-connector role that is used in later steps) into the XML file, within the existing <config></config> tags:
      <objectType id="00000000-00000-0000-0001-00000000000000">
      <action enabled="true" name="uploadNewVersion"/>
      <action enabled="true" name="download"/>
      <action enabled="false" name="downloadEmptyFile"/>
      <action enabled="true" name="restoreVersion"/>
  4. In the WebSphere® Application Server administrative console, map a user to the app-connector role for Files. This user is used by HCL Docs to communicate with Files.
    Note: If you are using a user other than the default Connections administrator associated with the J2C Alias connectionsAdmin, ensure that this user is also assigned as an administrator.
    1. Log in to the WebSphere® Application Server Deployment Manager administrative console from the browser.
    2. Click Applications > Application types > Websphere enterprise applications.
    3. Click the Files application.
    4. Click the security role for user/group mapping.
    5. Select app-connector. Click Map users.
    6. Type the ID that you are using for the HCL Docs administrator, and click search.
    7. Select the name from the available column and click the right-arrow to move the name to the selected column.
    8. Click OK, and then click OK again to close the security role mapping screen.
    9. Save the changes to the master configuration.
  5. Disable the Open this File feature. In Connections Files, a user, when downloading a file, can open it directly in the browser instead of saving it. Whether the file can be opened is determined by local applications. When HCL Docs and File Viewer are enabled, Open this File is not needed because users can use HCL Docs or File Viewer to open the file. There are two ways to disable the feature:
    • To disable the feature for all files, set <inlineDownload enabled="false"/> in files-config.xml.
    • To disable the feature for a file type, set openFromWeb="false" for corresponding mime-type in mime-files-config.xml, for example:
      <mapping mediaType="document"  mimeType="application/vnd.oasis.opendocument.text"> <extension openFromWeb="false">odt</extension> </mapping>
  6. Synchronize changes and restart the applications:
    1. Open the WebSphere® Application Server Deployment Manager administrative console from the browser, and click System administration > Nodes.
    2. Restart the Files application from Applications > Application Types > Websphere enterprise applications.
  7. Step 6b should have resulted in importing the ibmdocs.xml file content automatically. To verify that the object type was imported, complete the following steps:
    1. In a terminal window, start the wsadmin administrative interface from the Deployment Manager. When prompted, specify your WebSphere® Application Server credentials.
      • cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin
      • ./ –lang jython
    2. Run the following command to verify that the object was imported:
      • execfile("")
    3. Use FilesObjectTypeService.browseTypes() to look for the localName of the returned types to see whether ibmdocs.xml is there. If it is, do not import it again. If it is not there, run the following commands to import the object type:
        • FilesObjectTypeService.importType(/opt/IBM/Connections/data/shared/customization/objecttypes/ibmdocs.xml)
          Note: You must specify the full path to the ibmdocs.xml file.
        • FilesObjectTypeService.browseTypes() (Confirms that the object type was successfully imported)
  8. Select all Connections nodes, and click Full Resynchronize to synchronize your changes to all cluster nodes.
  9. Ripple-start the common, infra, and Files Connections clusters.