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.

Before you begin

Both the RDBMS-based metrics app and the Elasticsearch Metrics component are installed during the Connections 6.0 CR updates. The RDBMS-based metrics app is provided for testing purposes only and no Cognos® server is needed. Ensure that you have applied both the latest CR and the latest Connections Component Pack ifix, changed the number of shards for the index (if your environment warrants it), and enabled the Metrics component to connect to your Elasticsearch server.


  1. Validate that the Elasticsearch user experience is functioning well by updating the browser URL to use the test context root; for example, by replacing "/metrics" with "/metricssc" in the URL.
  2. From the Deployment Manager, load the Python script by entering the following commands:
    cd /opt/IBM/WebSphere/AppServer/profiles/Dmgr01/bin
    sudo sh -lang jython -user wasadmin_user -password wasadmin_password
  3. (Optional) Map user profile attributes to report dimensions.

    Metrics reports support up to three different dimensions, which are based on user profile attributes. The following user attributes are supported for mapping to report dimensions:


    By default, mapping is provided for the following three attributes:

    • - Mapped to the Geography dimension in Metrics reports
    • - Mapped to the Department dimension in Metrics reports
    • - Mapped to the Role dimension in Metrics reports

    You can change the attribute mapping by completing the following steps:

    Note: You should only change mappings with your first use of Metrics. Otherwise, Metrics data will be inconsistent and lead to incorrect report data.
    1. Get the default mapping:



    2. Update the mapping:

      Do not change the keys "attribute1", "attribute2", and "attribute3". Just replace the attributes with the values that you want to use.

      Run the following command:
      For example:
      MetricsAdminService.setUserAttributesMapping('{"attribute1":"","attribute2":"","attribute":""}' )
    3. Get the mapping again to verify that it was changed successfully:

      If the mapping did not update correctly, review the logs in the following location:


  4. When all validation is complete, run the following Python script to switch users to the Elasticsearch Metrics component:

    This script causes the RDBMS-based app to stop capturing data, and the Elasticsearch component to start capturing it.


What to do next

When you are ready to validate that Elasticsearch Metrics works properly with Connections, see Verifying the Metrics functions on the stand-alone Elasticsearch instance.