ibmcognos.import

The ibmcognos.import property allows you to configure a data server connection that imports metadata. For example, you can integrate Cognos Analytics with Egeria by importing Egeria metadata.

Requirements

To integrate Cognos Analytics with Egeria, you must have the following:

  • a Cognos Analytics 11.2.0 environment or later installed, configured, and running
  • an Egeria environment with the analytics-modeling OMAS running Version: 2.5 or later.

    For more information, see Analytics Modeling Open Metadata Access Service (OMAS) (https://egeria.odpi.org/open-metadata-implementation/access-services/analytics-modeling/)

  • an Egeria catalog populated with at least one DeployedDatabaseSchema
Note:

If connecting via https, you must import the SSL certificates to the Cognos Analytics keystore. For instructions see: Importing certificate from an SSL enabled website to Cognos Analytics (https://www.ibm.com/support/pages/importing-certificate-ssl-enabled-website-cognos-analytics)

JSON Configuration

Integration of Cognos Analytics with Egeria is configured via a JSON document. This document describes the REST calls to make to the analytics-modeling OMAS.

To view the example egeria.json document: Download and extract this zip file: egeria.zip

The egeria.json document is divided into three sections, each section describing a REST call Cognos Analytics will make to Egeria’s analytics-modeling OMAS:

  1. schemas
    • Called when listing available schemas for a Data Source Connection
  2. tables
    • Called when listing available tables for a Data Source Connection schema
  3. modules
    • Called when loading metadata for a Data Source Connection schema
Note: You must review each section and ensure that they match the Egeria environment being called.
Updating attributes
In the egeria.json file, update the attributes shown in the following table:
Attribute Value 
(schemas|tables|modules).[0].url.scheme

Lines: 6, 38, 70

 Optional, adjust to http if not using https 
(schemas|tables|modules).[0].url.host

Lines: 7, 39, 71

 Adjust to match the hostname of ING’s Egeria server 
(schemas|tables|modules).[0].url.port

Lines: 8, 40 72

 Adjust to match the port number of ING’s Egeria server 
(schemas|tables|modules).[0].url.path

Lines: 9, 41, 73

 Adjust relative URL path to match ING’s Egeria server and username. These are represented as CST and system in the template relative URL path 
(schemas|tables|modules).[0].url.params.[0].value

Lines: 13, 45, 77

 Adjust with a DeployedDatabaseSchema GUID from ING’s Egeria server. For more information, see Finding a DeployedDatabaseSchema GUID

For example, here are the highlighted fields to change in the schemas section. Other sections follow the same pattern:

Example of fields that you must edit in a JSON file
Note: The attribute name sslVerificationOff forcefully disables SSL certificate verification.
Finding a DeployedDatabaseSchema GUID

The analytics-modeling OMAS provides an endpoint to quickly find all available DeployedDatabaseSchema instances and their GUIDs. This endpoint can be executed from the swagger-ui or via a REST call to the OMAS.

Here is an example:

Using REST API definition to find an available DeployedDatabaseSchema instance
Hosting the configuration file
For Cognos Analytics to use a JSON configuration file successfully, the file must either be:
  • hosted on an http server

    For example, with the URL http://hostname:3000/egeria.json

    OR

  • copied to a location that is common to all Cognos Analytics reporting nodes

    For example, with the URL file:///D:/config/egeria.json

Creating a data server connection that imports metadata from Egeria

Follow these steps:

  1. Go to the Create data server connection wizard.
    1. Click the Open menu icon Open menu icon.
    2. Click New > Data server.
  2. Select the data server type from the list of supported types.

    For example, select Microsoft SQL Server.

  3. In the field New data server connection, type a unique name for the connection.

    For example, type MSSQL_GOSALES1

  4. Beside Connections details, click Edit and enter the connection details for the type of connection that you are creating.
    1. Fill in the JDBC URL field.

      For example, type jdbc:sqlserver://server:12345;databaseName=GOSALES

    2. In the Connection Properties field, enter the following:

      ibmcognos.import=URL_of_JSON_file

      Here are two example URLS:

      • ibmcognos.import=file:///D:/egeria/config.json
      • ibmcognos.import=http://myserver:3000/config.json
  5. Under Authentication method > Use the following signon, select the signon from the drop-down list, or create a new signon by clicking the add icon add icon. In the New data server connection window on the Credentials tab, type a user ID and password.
  6. Click Test to verify that the connection works.
  7. Click Save to save the new data server connection.

Modeling with Egeria metadata

You are now ready to navigate to the Assets page to preview and load metadata as usual. Metadata is retrieved from Egeria via JDBC calls.

After you load a schema, you can see the results by creating a new data module using the schema as the source.

For more information, see Creating a data module.