Home
Administering Connections 6.5
Welcome to the HCL Connections 6.5 documentation. HCL Connections is social networking software designed for the workplace. Its features help you to establish dynamic networks that connect you to the people and information you need to achieve your business goals.
Installing
To install HCL Connections™, you need to follow a detailed series of procedures.
Post-installation tasks
After installation, you need to perform further tasks to ensure an efficient deployment.
Configuring additional HCL Connections applications
You must perform additional tasks to enable HCL Connections for the Orient Me home page, the Touchpoint interactive user experience, Community Libraries, Community Surveys, Metrics applications, and more.
Setting up stand-alone Elasticsearch
Deploy Elasticsearch as a stand-alone server for use with HCL Connections™, instead of deploying it as part of the Component Pack for Connections.
Configuring the Metrics feature for stand-alone Elasticsearch
Configure the stand-alone Elasticsearch instance to provide Metrics data for the HCL Connections™ deployment.
Configuring the Metrics SSL settings for Elasticsearch
Configure the HCL Connections™ deployment's Metrics SSL settings to connect to the new stand-alone Elasticsearch instance.

Administering Connections 6.5
Welcome to the HCL Connections 6.5 documentation. HCL Connections is social networking software designed for the workplace. Its features help you to establish dynamic networks that connect you to the people and information you need to achieve your business goals.
- What's new in HCL Connections
  Find out about features that are new or updated in this release of HCL Connections.
- Product overview
  Learn how to deploy, customize, and administer the HCL Connections social networking product.
- Planning
  Before installing HCL Connections™, study the system requirements, deployment options, and documentation conventions.
- Installing
  To install HCL Connections™, you need to follow a detailed series of procedures.
  - The installation process
    Review the steps that are required to install HCL Connections.
  - Pre-installation tasks
    Complete the following tasks before installing HCL Connections. If you are migrating from a prior release of HCL Connections, do not complete the tasks for creating databases or populating the Profiles database. The migration process handles those tasks automatically.
  - Installing HCL Connections
    Select the HCL Connections applications that you plan to use and install them in a clustered deployment.
  - Post-installation tasks
    After installation, you need to perform further tasks to ensure an efficient deployment.
    - Registering custom widgets
      Register all custom and third-party widgets starting with HCL Connections™ 6 CR1 \IFR1 to ensure they meet security requirements and can display in communities.
    - Reviewing the JVM heap size
      Review the size of the Java™ Virtual Machine heap and adjust it, if necessary, to avoid out-of-memory errors or to suit your hardware capabilities.
    - Configuring IBM® HTTP Server
      When you have successfully installed HCL Connections™ to run on WebSphere® Application Server, you can configure IBM® HTTP Server to handle web traffic.
    - Configuring the Home page administrator
      Create an administrator for Home page so that you can make changes to the application such as adding and removing widgets.
    - Configuring additional HCL Connections applications
      You must perform additional tasks to enable HCL Connections for the Orient Me home page, the Touchpoint interactive user experience, Community Libraries, Community Surveys, Metrics applications, and more.
      - Optional: Installing the Component Pack for Connections™
        The Component Pack for HCL Connections™ introduces new connectivity capabilities that enhance collaboration and boost productivity.
      - Setting up stand-alone Elasticsearch
        Deploy Elasticsearch as a stand-alone server for use with HCL Connections™, instead of deploying it as part of the Component Pack for Connections.
        Deploying stand-alone Elasticsearch
        Deploy Elasticsearch as a stand-alone instance in an HCL Connections™ deployment.
        Configuring the Metrics feature for stand-alone Elasticsearch
        Configure the stand-alone Elasticsearch instance to provide Metrics data for the HCL Connections™ deployment.
        Removing the SSL settings for type-ahead search
        Temporarily remove SSL settings that were configured for type-ahead search in an HCL Connections™ deployment, so that you can successfully enable Metrics.
        Configuring access to global Elasticsearch Metrics
        Configure the metrics-report-run security role to grant users the authority to view and interact with global metrics hosted by the stand-alone Elasticsearch instance in an HCL Connections™ deployment.
        Configuring access to Elasticsearch Metrics for communities
        Configure the community-metrics-run security role to grant users the authority to view community metrics hosted by the stand-alone Elasticsearch instance in an HCL Connections™ deployment.
        Configuring Metrics to connect to stand-alone Elasticsearch
        Configure communications between a stand-alone Elasticsearch instance and the HCL Connections™ deployment to support the Metrics feature.
        Configuring the Metrics SSL settings for Elasticsearch
        Configure the HCL Connections™ deployment's Metrics SSL settings to connect to the new stand-alone Elasticsearch instance.
        Deploying stand-alone Elasticsearch Metrics as your first use of metrics
        Deploying Elasticsearch-based metrics for HCL Connections™ involves testing the environment and then switching users to the Elasticsearch Metrics component.
        Verifying the Metrics functions on the stand-alone Elasticsearch instance
        Verify that the Metrics feature based on the stand-alone Elasticsearch instance works properly with the HCL Connections™ deployment.
        Configuring the Orient Me feature for stand-alone Elasticsearch
        If you are newly deploying Orient Me in Component Pack but already use stand-alone Elasticsearch for Metrics and Type-ahead Search features in your HCL Connections™ deployment, you can configure the stand-alone Elasticsearch instance to also provide Orient Me top updates data.
        Migrating data to Elasticsearch
        If you are moving to a stand-alone Elasticsearch instance from either the Component Pack for HCL Connections™, or from IBM® Cognos®, you can migrate existing data to the new deployment.
      - Setting up type-ahead search
        Enable type-ahead search in HCL Connections™ to suggest items in the search box based on content that is relevant to each user.
      - Installing Customizer Lite
        This topic describes how to install Customizer Lite. There are two deployment options, hereby referred to as Customizer Lite and Customizer Lite HA. Customizer Lite – the most basic deployment using a single Docker node running a single instance of each required service, and Customizer Lite HA – a more resilient deployment using a pair (or more) of Docker nodes all running instances of each required service with requests load balanced across available nodes.
      - Configuring Connections Content Manager for Libraries
        If you installed the Connections Content Manager add-on, you must configure FileNet® to work with Connections Content Manager. Choose the instructions that match your deployment: either an existing FileNet deployment, which you installed independently before you installed HCL Connections or a new, integrated FileNet deployment that is part of a new HCL Connections installation.
      - Optional: Configuring HCL Connections Docs with CCM
        You can enable community members to edit files in Community libraries online if you have already installed HCL Connections Docs.
      - Installing Community Surveys
        If you want to be able to conduct surveys within Communities to capture data and share it easily with your community in an activity stream, enable Community Surveys.
  - Optional: Installing and configuring the Tiny Editors for HCL Connections
    HCL Connections 6.5 can use the optional Tiny Editors: TinyMCE or Textbox.io, to replace the HCL Connections™ default rich text editor.
  - Copying Search conversion tools to local nodes for AIX and Linux
    To enable full indexing of data, copy the Search conversion tools to local nodes.
  - Copying Search conversion tools to local nodes for Windows
    To enable full indexing of data, copy the Search conversion tools to local nodes.
  - Optional post-installation tasks
    Complete the post-installation tasks that are relevant to your deployment.
- Uninstalling HCL Connections
  Uninstall HCL Connections.
- Migrating and updating
  Migrate HCL Connections™ and its supporting software to the latest release and then update the installation with the latest deployment, interim fixes, or Cumulative Refresh (CR).
- Administering
  Run administration and maintenance tasks to keep your environment up-to-date. For example, learn how to customize your deployment or how to use the wsadmin utility to edit configuration files. You can also schedule tasks, maintain application databases, moderate content, or manage users and their roles.
- Customizing
  Customize HCL Connections™ to fit your environment.
- Security
  HCL Connections™ provides a flexible security infrastructure that supports an open, easily shareable data model.
- Mobile
  See the HCL Connections™ Mobile documentation for Connections Cloud and Connections on-premises.
- Developing
  Get information about how to use the APIs provided with HCL Connections™ and how to use Connections Customizer to modify the Connections pages that are returned to users.
- Troubleshooting and support
  To isolate and resolve problems with your HCL products, you can use the troubleshooting and support information. This information contains instructions for using the problem-determination resources that are provided with your IBM® products, including HCL Connections™.

Configuring the Metrics SSL settings for Elasticsearch

Configure the HCL Connections™ deployment's Metrics SSL settings to connect to the new stand-alone Elasticsearch instance.

Before you begin

This task only applies to a stand-alone Elasticsearch deployment where type-ahead search was not enabled. If you previously enabled type-ahead search for Elasticsearch, skip this task because you have already completed these steps. If you installed Elasticsearch as part of the Component Pack for Connections, skip this task because it does not apply.

Procedure

To ensure a secure connection, retrieve the PKCS12 and CA Signer certificates from the Elasticsearch server.

Note: If you are migrating from the Component Pack version of Elasticsearch, do not overwrite your previous keys certificates.
Copy the certificate files to the Deployment Manager in a common location readable and writable by all WebSphere® Application Server nodes.
Open wsadmin, making sure that you use the -lang jython option. For example, on Unix, run the following commands to open wsadmin:
```
cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin
./wsadmin.sh -lang jython 
```

Run the following commands to merge the signer certificate into the elasticsearch-metrics.p12 keystore:

execfile('esSecurityAdmin.py')
enableSslForMetrics('KEYSTORE_FULL_PATH', 'STORE_PASSWORD', 'SIGNER_CA_FULL_PATH', 'ELASTICSEARCH_HTTPS_PORT')
quit

For example:

execfile('esSecurityAdmin.py')
enableSslForMetrics('/opt/IBM/elasticsearch-metrics.p12', 'Elasticsearch_CA_password', '/opt/IBM/chain-ca.pem', '9200')

Copy the updated elasticsearch-metrics.p12 file from the Deployment Manager to the same location on the WebSphere® Application Server nodes.
If you are using type-ahead search on a separate cluster, add the SSL configuration as explained in Setting up certificates for type-ahead search.

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.