Integrated reporting with Cognos Analytics

You can configure OpenPages instances to use IBM® Cognos® Analytics for your organization's reporting requirements.

You can set up the integration with Cognos Analytics when you provision an OpenPages instance. You can also set up the integration for instances that already exist.

You can integrate multiple OpenPages instances with a single Cognos Analytics instance.

Before you begin

The Cognos Analytics instance and the OpenPages instance can be installed on different namespaces other than the IBM Software Hub namespace.

When the Cognos Analytics namespace and OpenPages namespace are different, you must run the following commands to set the Cognos Analytics instance namespace variable:

export COGNOS_ANALYTICS_INSTANCE_NAMESPACE="ca-instance-namespace"

Then, run the following commands to update the OpenPagesInstance CR:

 cpd-cli manage update-cr --component=openpages_instance \
 --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
 --patch="{\"metadata\":{\"enableIntegrationWithCognos\":True,\"cognosNamespace\":\"${COGNOS_ANALYTICS_INSTANCE_NAMESPACE}\"}}" \
 --extra-vars='{"cr_name":"${INSTANCE_NAME}"}' \
 [--tethered_instance_ns=${PROJECT_CPD_INSTANCE_TETHERED}]

Environment variables must be available. For more information, see Setting up installation environment variables.

Procedure

If you did not enable the integration when you provisioned OpenPages, do the following steps:
1. Set the CPD_ROUTE environment variable:
```
export CPD_ROUTE=$(oc get route cpd -n ${PROJECT_CPD_INST_OPERANDS} -o jsonpath={".spec.host"})
```
  The command uses the PROJECT_CPD_INST_OPERANDS variable, which is already defined in your installation environment variables script.
2. Run the following command:
```
 cpd-cli manage update-cr --component=openpages_instance \
 --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
 --patch="{\"metadata\":{\"enableIntegrationWithCognos\":True}}" \
 --extra-vars='{"cr_name":"${INSTANCE_NAME}"}' \
 [--tethered_instance_ns=${PROJECT_CPD_INSTANCE_TETHERED}]
```
  Replace ${INSTANCE_NAME} with the name of your OpenPages instance.
  
  Use the --tethered_instance_ns parameter if the OpenPages instance is installed in a tethered project.
3. Wait until the status of the process is Complete.
Log in to OpenPages as an administrator.
Complete the following steps:
1. Click > System Configuration > Settings.
2. Search for "hidden".
3. Select Show Hidden Settings and set value to true.
4. Search for "Cognos".
5. Select Cognos SDK URL and set value to https://internal-nginx-svc.{CPD_NAMESPACE}.svc.cluster.local:12443/cognosanalytics/{PROJECT_OPERAND_NAMESPACE}/bi/api/soap. Replace the environment variable names.
6. Select Cognos Dispatcher Service URL and set value to https://${CPD_ROUTE}:443/cognosanalytics/${PROJECT_OPERAND_NAMESPACE}/bi/v1/disp.
Click > Integrations > Cognos Analytics.
Optional: In the OpenPages Instance Name, type the name you want to use for the integration in Cognos Analytics. The default value is the name of your OpenPages instance.

For example, if you use openpagesinstance-2, the folder in Cognos Analytics will be Team content/openpagesinstance-2.

You can, for example, use a folder that is called Dev, and then later use another that is called UAT. Your OpenPages instance can use only one folder at a time, but you can switch between them by updating the OpenPages Instance Name field.
Click Enable.
Click Submit.
Refresh OpenPages by doing the following steps:
1. Close all OpenPages browser windows.
2. Open a new incognito or private window.
  
  Or, clear the OpenPages session cookies, which are called OPJSESSIONID-POD<N>.
  
  For example, in Chrome, go to Settings > Privacy and security. Click See all cookies and site data. Click the OpenPages URL, and then delete the OPJSESSIONID-POD<N> cookies.
Update the reporting framework:
1. Click > Cognos Analytics > Reporting Framework Generation.
2. Ensure that All Models is enabled, and then click Submit.
The framework models are published to Cognos Analytics in the Team content/<op_instance_name>/OpenPages Packages folder.
Verify the integration.
- Click to open the Primary menu and click Analytics.
- Add a report to your dashboard, and open the report.

What to do next

After you set up the integration, enable Cognos Analytics in your OpenPages instance and generate the reporting framework. For more information, see Configuring and generating the reporting framework.