Home
Deploying HCL Connections Docs 2.0 CR3
Welcome to the HCL Connections Docs 2.0 CR3 documentation, where you can find information about installing and deploying HCL Docs 2.0 CR3. HCL Docs is a collaborative productivity suite that enables you to work on documents, spreadsheets and presentations together in the cloud. If you have HCL Docs 2.0, HCL Docs 2.0 CR1, or CR2 already installed, to install CR3, you only need to download the HCL Docs 2.0 CR3 zip package from FixCentral and extract the package. Then follow the instructions in the PDF file to install CR3. But if you have a version prior to HCL Docs 2.0, before installing CR3 package, you must follow instructions in this guide to install and deploy HCL Docs 2.0.
Installing
To install HCL Docs, complete the following procedures in the sequence shown.
Pre-installation tasks
A series of pre-installation tasks must be completed before you can deploy the HCL Docs infrastructure. These tasks include installing the system prerequisites and configuring both Windows™ and Linux™ operating systems.
Preparing the Sametime® chat infrastructure
If you want to use HCL Connections™ Docs with HCL Sametime® to add presence awareness and chat capability inside documents, you must set up the integration between these two products.
Setting up Sametime® integration when Connections is not installed
If your document repository is based on FileNet (CMIS ECM) rather than Connections 5.5, you must complete some additional steps to set up HCL Sametime® presence awareness and chat capability in HCL Connections™ Docs.
Mapping the Domino server between the user IDs stored in the LDAP
Ensure that the HCL Domino server maps correctly between the user IDs stored in the LDAP that the Docs server is connected to and the Notes Canonical Name format used inside the Domino address book and authentication/authorization.

Deploying HCL Connections Docs 2.0 CR3
Welcome to the HCL Connections Docs 2.0 CR3 documentation, where you can find information about installing and deploying HCL Docs 2.0 CR3. HCL Docs is a collaborative productivity suite that enables you to work on documents, spreadsheets and presentations together in the cloud. If you have HCL Docs 2.0, HCL Docs 2.0 CR1, or CR2 already installed, to install CR3, you only need to download the HCL Docs 2.0 CR3 zip package from FixCentral and extract the package. Then follow the instructions in the PDF file to install CR3. But if you have a version prior to HCL Docs 2.0, before installing CR3 package, you must follow instructions in this guide to install and deploy HCL Docs 2.0.
- Overview
  HCL Connections™ Docs extends HCL Connections, offering real-time, co-editing support designed to help users collaborate on documents together.
- Planning
  Before installing HCL Docs, review the system requirements and deployment options, and then complete the worksheets.
- Installing
  To install HCL Docs, complete the following procedures in the sequence shown.
  - Pre-installation tasks
    A series of pre-installation tasks must be completed before you can deploy the HCL Docs infrastructure. These tasks include installing the system prerequisites and configuring both Windows™ and Linux™ operating systems.
    - Install HCL Connections
      Install Connections 6.5, including the WebSphere® Deployment Manager at the minimum fix pack level, and create a Connections cell to contain HCL Docs.
    - Configuring the operating systems
      Before you install any more applications, you need to make some changes to the operating systems on the servers.
    - Installing Python
      The HCL Docs deployment requires a Python 2.7.3 or later runtime environment. For non-Windows installations, ensure that Python is installed on the IBM® Connections Deployment Manager and on all Linux™ servers hosting an File Viewer, HCL Docs, or HCL Docs proxy node.
    - Installing WebSphere® Application Server
      The IBM® WebSphere® Application Server installation consists of two parts: IBM Installation Manager and the WebSphere Application Server itself.
    - Configuring HCL Docs shared storage
      The shared storage for the Editor Server and Document Format Conversion Server uses NFSv3 or CIFS, and the shared storage for the Viewer Server and Document Format Conversion Server uses either NFSv3 or CIFS. Procedures for both the NFS and CIFS cases are provided -- complete the tasks appropriate to your deployment.
    - Preparing the HCL Docs database infrastructure
      HCL Connections™ Docs has dependencies on IBM DB2 or Oracle database products.
    - Removing clusters and servers
      Before you install, check whether any cluster and server names that you want to use already exist, for example, IBMDocsCluster, IBMDocsMember 1,...,n, IBMConversionCluster, IBMConversionMember1,...,n , IBMViewerCluster, IBMViewerMember1,...,n, IBMDocsProxyCluster and IBMDocsProxyMember1,...,n. If they already exist, you must remove them.
    - Installing extra language packs
      For some locales, you might have to install extra language packs for an operating system.
    - Preparing the Sametime® chat infrastructure
      If you want to use HCL Connections™ Docs with HCL Sametime® to add presence awareness and chat capability inside documents, you must set up the integration between these two products.
      - Setting up Sametime® integration when Connections is installed
        If your deployment includes Connections 5.5, use this task to set up presence awareness and chat capability of Sametime Communicate 9.0.0.1 or Sametime Complete 9.0.0.1 in HCL Connections™ Docs.
      - Setting up Sametime® integration when Connections is not installed
        If your document repository is based on FileNet (CMIS ECM) rather than Connections 5.5, you must complete some additional steps to set up HCL Sametime® presence awareness and chat capability in HCL Connections™ Docs.
        Configuring WebSphere for SSO and exporting the LTPA key
        As part of configuring SSO for Domino environments, you must configure WebSphere Application Server for SSO and export the LTPA key.
        Creating the SSO configuration document on the Domino server
        As part of setting up SSO for Domino environments, you must create the SSO configuration document on the Domino server.
        Mapping the Domino server between the user IDs stored in the LDAP
        Ensure that the HCL Domino server maps correctly between the user IDs stored in the LDAP that the Docs server is connected to and the Notes Canonical Name format used inside the Domino address book and authentication/authorization.
        Configuring the Domino server to use the Web SSO Configuration Document
        Configure the HCL Domino server to use the Web SSO Configuration Document
    - Configuring CCM and other repositories for use with Docs
      You can use HCL Docs with repositories other than Connections Files. This section describes how to configure IBM Connections Content Manager (CCM) as the repository, or, how to configure a repository outside of Connections, IBM Content Navigator (ICN).
  - Installing the HCL Docs components
    You can run theHCL Docs GUI Installer or use the scripts to install the components.
  - Post-installation tasks
    These post-install steps are required after an installation or uninstall/install of HCL Docs. During an upgrade, these changes are preserved so do not need to be repeated during the upgrade process.
  - Uninstalling HCL Docs components
    You can use the installer or use uninstall scripts to uninstall HCL Docs automatically.
- Upgrading or migrating
  You can upgrade HCL Connections™ Docs from the previous two releases to the current release by using the installer or upgrade scripts. You can also install the latest release on new hardware and then do a side-by-side migration from the old to the new.
- Security
  You might need to refer to this section during deployment. HCL Docs supports WebSEAL. This section is for setting up single sign-on (SSO) if installing HCL Docs in the same cell as IBM® Connections.
- Performance tuning
- Troubleshooting and support
  To isolate and resolve problems with your deployment, you can use the troubleshooting and support information.

Mapping the Domino server between the user IDs stored in the LDAP

Ensure that the HCL Domino server maps correctly between the user IDs stored in the LDAP that the Docs server is connected to and the Notes Canonical Name format used inside the Domino address book and authentication/authorization.

About this task

You can skip this step if the Domino server and WebSphere Application Server share the same directory.

Procedure

If the users exist in both the LDAP directory and the Domino Directory:
- In the user's Person document, click Administration. Under Client Information, enter the user name DN that is expected by WebSphere Application Server in the LTPA user name field. Typically, this is the user's LDAP distinguished name (DN). Be sure to separate the name components with slashes. For example, if the LDAP DN is uid=jdoe,cn=sales,dc=acme, dc=com, enter the value as follows: uid=jdoe/cn=sales/dc=acme/dc=com
If users exist in only the LDAP directory:
- Open the Directory Assistance document for the LDAP Directory (or create a directory assistance database and configure the Domino server to use this DA database). In the SSO Configuration section, enter an LDAP attribute that should be used as the name in an SSO token created for this user. This attribute will be used in the LTPA token when the LTPA_UserNm field is requested. It is important to ensure that the selected field contains the user name that WebSphere Application Server expects. Options for this field include:
  - Any appropriate LDAP attribute, as long as it uniquely identifies the user.
  - A value of $DN to use the LDAP distinguished name. This is the most common configuration, indicating that the user's LDAP DN is the name expected by WebSphere Application Server, rather than a name in an arbitrary LDAP field.
  - Leaving it blank to default to the Domino distinguished name, if known. Otherwise, the default will be the LDAP distinguished name.
Note: From theHCL Domino welcome page in the HCL product documentation, you can find information to help you choose the correct configuration parameters based on your environment.

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site.