Home
Deploying HCL Connections Docs 2.0.1
Welcome to the HCL Connections Docs 2.0.1 documentation, where you can find information about installing and deploying HCL Docs 2.0.1. HCL Docs is a collaborative productivity suite that enables you to work on documents, spreadsheets and presentations together in the cloud.
Planning
Before installing HCL Docs, review the system requirements and deployment options, and then complete the worksheets.
Server information worksheets
These worksheets provide the relevant information needed to successfully deploy HCL Docs.
Editor Proxy Server
The Editor Proxy Server contains the Editor Proxy servers which are used for session affinity in HCL Docs. Session affinity routes requests for the same document from different clients to the same HCL Docs Document server node.

Deploying HCL Connections Docs 2.0.1
Welcome to the HCL Connections Docs 2.0.1 documentation, where you can find information about installing and deploying HCL Docs 2.0.1. HCL Docs is a collaborative productivity suite that enables you to work on documents, spreadsheets and presentations together in the cloud.
- 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.
  - HCL Docs system requirements
    Ensure that your systems support the HCL Docs system requirements needed for successful deployment within the HCL Connections environment.
  - Deployment options for scale
    Typically HCL Docs is deployed in one of two deployment topologies. Medium-to-large deployments are used in test and production environments to achieve optimum scaling, load balancing, and failover, whereas imple deployments are used in a proof-of-concept environment to get up and running quickly.
  - Integration options
    HCL Docs supports integrating with different products on various environments. Before installing, you must have information about which integration option you want.
  - HCL Docs shared storage overview and requirements
    HCL Docs shared storage is used by each of the HCL Docs components to store drafts or transfer files between servers. This shared storage can be hosted from an external storage device or one of the existing servers in your IBM® Connections and HCL Docs deployment.
  - Server information worksheets
    These worksheets provide the relevant information needed to successfully deploy HCL Docs.
    - Server architecture
      This diagram shows the server architecture on which the examples throughout this guide are based. You need to modify this architecture according to your environment.
    - Database server
      The database server is used by the HCL Docs components to store and retrieve session information while the documents are being edited as well as other information needed by HCL Docs.
    - HCL Docs Shared Storage Servers
      Shared storage is required between the HCL Docs and Conversion servers as well as between the File Viewer and Conversion servers. This is used for HCL Docs internal storage of the drafts as documents are being edited.
    - WebSphere® infrastructure
      Each of the HCL Docs components are WebSphere-based applications so each server needs to have a supported WebSphere® installed and configured. This topology also requires that a WebSphere Deployment Manager is installed in addition to the other WebSphere servers on the conversion, docs and proxy servers.
    - IBM® HTTP Servers
      IBM® HTTP Servers (IHS) are used for loadbalancing and redirecting the docs related urls to the corresponding HCL Docs components. In most cases, the existing IHS server used for your IBM Connections environment can be used.
    - IBM® Connections
      HCL Docs is an extension to IBM® Connections Files and Communities. As an extension, it requires a number of the IBM Connections applications to be installed including Files, Communities, News and Common.
    - Document Format Conversion Server Cluster
      The Document Format Conversion Server Cluster contains the Conversion servers that handle converting of files to and from the HCL Docs editors and HCL File Viewer.
    - Editor Server Cluster
      The Editor Server Cluster contains the Docs server which provides the core logic for processing of the documents. These servers will communicates with IBM® Connections through the HCL Docs Extension plug-in. When users open or edit a document in IBM Connections, the web page redirects the user to the HCL Docs service for further processing.
    - Editor Extension
      The Editor Extension provides the mechanism to be able to launch the HCL Docs editors from within Connections Files and Communities. This will be installed on the same server as the Connections Applications.
    - Viewer Server Cluster
      The Viewer Server Cluster contains the Viewer servers which provides the ability to view the latest published version of a document.
    - Viewer Extension
      The Viewer Extension provides the mechanism to be able to launch the HCL File Viewer from within Connections Files and Communities. This will be installed on the same server as the Connections Applications.
    - Editor Proxy Server
      The Editor Proxy Server contains the Editor Proxy servers which are used for session affinity in HCL Docs. Session affinity routes requests for the same document from different clients to the same HCL Docs Document server node.
- Installing
  To install HCL Docs, complete the following procedures in the sequence shown.
- 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.

Editor Proxy Server

The Editor Proxy Server contains the Editor Proxy servers which are used for session affinity in HCL Docs. Session affinity routes requests for the same document from different clients to the same HCL Docs Document server node.

General:

WAS Version and Operating System fields help provide information to IBM® support or those helping with the deployment to ensure the supported WebSphere® server and proper version are being used. The Install Directory (Docs Proxy) is where the Docs Proxy server will be installed on the Docs Proxy node. The OS account for install is the user that will be used for the deployment of Docs Proxy. The Cluster Name is the name of the cluster created for the Docs Proxy.

The Docs Proxy HTTP Port, Docs Proxy HTTPS Port and Docs Proxy IBM HTTP Server alias will be used when configuring the IHS server plugin-cfg.xml file to ensure proper routing of the docs requests.

Table 1. Editor Proxy Server general parametersThis table provides suggested default values pertaining to Editor Proxy Server.
Field Name	Parameter
WAS Version	`WAS_VERSION`, for example, `8.5.5.1`
Operating System	`RHEL_VERSION`, for example, `Red Hat Enterprise Linux 6.4 (x86_64)`
OS account for install	`OSACCOUNT_LINUX`, for example, `root`
Cluster Name	`IBMDocsProxyCluster`
Docs Proxy HTTP Port	`DocsProxyCluster_HTTPPORT`, for example, `80`
Docs Proxy HTTPS Port	`DocsProxyCluster_HTTPSPORT`, for example, `443`
Docs Proxy IBM® HTTP Server alias	`VHOST_IHS`, for example, `Connections.example.com`
Install Directory (Docs Proxy)*	`DocsProxyCluster_INSTALLPATH`, for example, `/opt/IBM/ConnectionsDocs/DocsProxy`

*The actual location that the proxy will be installed is <Install Directory (Editor Proxy)>/Proxy

Servers:

Record all the servers that will be part of the Editor Proxy server. Note though that Editor Proxy does not need to be deployed on each of the Editor Proxy servers. Instead you can deploy Editor Proxy from one of the Editor Proxy nodes or the Deployment Manager and it will be deployed to each of the Editor Proxy nodes in the cluster listed in the table.

Table 2. Docs Proxy cluster servers parametersThis table provides suggested default values for Editor Proxy servers.
	Server	Node Name	Server Name
1	`DocsProxyCluster_HOSTNAME_1`, for example, `Docs01.example.com`	`DocsProxyCluster_NODENAME_1`, for example, `Docs01`	`IBMDocsProxyMember1`
2	`DocsProxyCluster_HOSTNAME_2`, for example, `Docs02.example.com`	`DocsProxyCluster_NODENAME_2`, for example, `Docs02`	`IBMDocsProxyMember2`

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.