How to crawl on-premises IBM Cognos Analytics

Once you have set up the cognos-extractor tool, you can extract metadata from your on-premises IBM Cognos Analytics instances by completing the following steps.

Run cognos-extractor

Crawl all IBM Cognos Analytics connections

To crawl all IBM Cognos Analytics connections using the cognos-extractor tool:

1. Log into the server with Docker Compose installed.
2. Change to the directory containing the compose file.
3. Run Docker Compose: sudo docker-compose up

Crawl a specific connection

To crawl a specific IBM Cognos Analytics connection using the cognos-extractor tool:

1. Log into the server with Docker Compose installed.
2. Change to the directory containing the compose file.
3. Run Docker Compose: sudo docker-compose up <connection-name>

(Replace <connection-name> with the name of the connection from the services section of the compose file.)

(Optional) Review generated files

The cognos-extractor tool will generate many folders with JSON files for each service. For example:

• folders
• explorations
• reports
• modules
• data sources
• and many others

You can inspect the metadata and make sure it is acceptable for providing metadata to Atlan.

Upload generated files to S3

To provide Atlan access to the extracted metadata, you will need to upload the metadata to an S3 bucket.

To upload the metadata to S3:

1. Ensure that all files for a particular connection have the same prefix. For example, output/cognos-example/contents/result-0.json, output/cognos-example/contents-details/result-0.json, and so on.
2. Upload the files to the S3 bucket using your preferred method.

For example, to upload all files using the AWS CLI:

aws s3 cp output/cognos-example s3://my-bucket/metadata/cognos-example --recursive

Crawl metadata in Atlan

Once you have extracted metadata on-premises and uploaded the results to S3, you can crawl the metadata into Atlan:

• How to crawl IBM Cognos Analytics

Be sure you select Offline for the Extraction method.