IBM Cognos ReportStudio - Import - Cloud

Talend Cloud Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend Data Catalog

Note: This bridge is not available in Talend Cloud Data Catalog by default. You need to set up a remote harvesting agent to import metadata from this source. For more information, see Deploying a remote harvesting agent in Talend Cloud Data Catalog Administration guide.

Bridge Specifications

Vendor IBM
Tool Name Cognos ReportStudio
Tool Version RN to C11
Tool Web Site http://www.ibm.com/software/analytics/cognos/
Supported Methodology [Business Intelligence] BI Report (Relational Source, Dimensional Source, Expression Parsing, Report Structure) via XML File
Data Profiling
Remote Repository Browsing for Model Selection
Multi-Model Harvesting
Incremental Harvesting

SPECIFICATIONS
Tool: IBM / Cognos ReportStudio version RN to C11 via XML File
See http://www.ibm.com/software/analytics/cognos/
Metadata: [Business Intelligence] BI Report (Relational Source, Dimensional Source, Expression Parsing, Report Structure)
Component: CognosRnReportStudio version 11.0.0

OVERVIEW
This bridge imports IBM Cognos Report Studio reports, specified in XML format.
REQUIREMENTS
n/a

FREQUENTLY ASKED QUESTIONS
n/a

LIMITATIONS
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html

SUPPORT
Provide a trouble shooting package with:
- the debug log (can be set in the UI or in conf/conf.properties with MIR_LOG_LEVEL=6)
- the metadata backup if available (can be set in the Miscellaneous parameter with option -backup)


Bridge Parameters

Parameter Name Description Type Values Default Scope
File Specify the IBM Cognos Report Studio XML file to import.

To create this file from inside Report Studio, use 'Tools->Copy Report to Clipboard', paste into empty file, and save with .xml extension.
FILE *.xml   Mandatory
Model name For reports produced in Report Studio versions prior to IBM Cognos 10.x specify the name of the reporting model.
(reports produced in IBM Cognos 10.x and later have the report name specified inside the report XML).
If the report name is not found inside the XML and is not specified by the user, the file name is used as the model name.
STRING      
__Connection list Internal semicolon delimited list of connection names and their data types. STRING      
Miscellaneous INTRODUCTION
Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g.
-connection.cast MyDatabase1="SQL Server"
Some options can be used multiple times if applicable, e.g.
-connection.rename NewConnection1=OldConnection1 -connection.rename NewConnection2=OldConnection2;
As the list of options can become a long string, it is possible to load it from a file which must be located in ${MODEL_BRIDGE_HOME}\data\MIMB\parameters and have the extension .txt. In such case, all options must be defined within that file as the only value of this parameter, e.g.
ETL/Miscellaneous.txt

JAVA ENVIRONMENT OPTIONS
-m <Java Memory's maximum size>
1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-m 8G
-m 8000M

-j <Java Runtime Environment command line options>
This option must be the last one in the Miscellaneous parameter as all the text after -j is passed "as is" to the JRE, e.g.
-j -Dname=value -Xms1G
The following option must be set when a proxy is used to access internet (this is critical to access https://repo.maven.apache.org/maven2/ (and exceptionally a few other tool sites) in order to download the necessary third party software libraries.
-j -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass -Dhttps.proxyUser=user -Dhttps.proxyPassword=pass

-jre <Java Runtime Environment full path name>
It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-jre "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-v <Environment variable value>
None by default, e.g.
-v var1=value1 -v var2="value2 with spaces"

MODEL IMPORT OPTIONS
-model.name <model name>
Override the model name, e.g.
-model.name "My Model Name"

-prescript <script name>
The script must be located in the bin directory, and have .bat or .sh extension.
The script path must not include any parent directory symbol (..).
The script should return exit code 0 to indicate success, or another value to indicate failure.
For example:
-prescript "script.bat arg1 arg2"

-cache.clear
Clears the cache before the import, and therefore will run a full import without incremental harvesting.
Warning: this is a system option managed by the application calling the bridge and should not be set by users.

-backup <directory>
Full path of an empty directory to save the metadata input files for further troubleshooting.

DATA CONNECTION OPTIONS
Data Connections are produced by the import bridges typically from ETL/DI and BI tools to refer to the source and target data stores they use. These data connections are then used by metadata management tools to connect them (metadata stitching) to their actual data stores (e.g. databases, file system, etc.) in order to produce the full end to end data flow lineage and impact analysis. The name of each data connection is unique by import model. The data connection names used within DI/BI design tools are used when possible, otherwise connection names are generated to be short but meaningful such as the database / schema name, the file system path, or Uniform Resource Identifier (URI). The following options allows to manipulate connections. These options replaces the legacy options -c, -cd, and -cs.

-connection.cast ConnectionName=ConnectionType
Casts a generic database connection (e.g. ODBC/JDBC) to a precise database type (e.g. ORACLE) for SQL Parsing, e.g.
-connection.cast "My Database"="SQL SERVER".
The list of supported data store connection types includes:
ACCESS
CASSANDRA
DB2
DENODO
HIVE
MYSQL
NETEZZA
ORACLE
POSTGRESQL
PRESTO
REDSHIFT
SALESFORCE
SAP HANA
SNOWFLAKE
SQL SERVER
SYBASE
TERADATA
VECTORWISE
VERTICA

-connection.rename OldConnection=NewConnection
Renames an existing connection to a new name, e.g.
-connection.rename OldConnectionName=NewConnectionName
Multiple existing database connections can be renamed and merged into one new database connection, e.g.
-connection.rename MySchema1=MyDatabase -connection.rename MySchema2=MyDatabase

-connection.split oldConnection.Schema1=newConnection
Splits a database connection into one or multiple database connections.
A single database connection can be split into one connection per schema, e.g.
-connection.split MyDatabase
All database connections can be split into one connection per schema, e.g.
-connection.split *
A database connection can be explicitly split creating a new database connection by appending a schema name to a database, e.g.
-connection.split MyDatabase.schema1=MySchema1

-connection.map DestinationPath=SourcePath
Maps a source path to destination path. This is useful for file system connections when different paths points to the same object (directory or file).
On Hadoop, a process can write into a CSV file specified with the HDFS full path, but another process reads from a HIVE table implemented (external) by the same file specified using a relative path with default file name and extension, e.g.
-connection.map hdfs://host:8020/users/user1/folder/file.csv=/user1/folder
On Linux, a given directory (or file) like /data can be referred to by multiple symbolic links like /users/john and /users/paul, e.g.
-connection.map /users/John=/data -connection.map /users/paul=/data
On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g.
-connection.map M:\=C:\data -connection.map N:\=C:\data

-pppd
Create the connections and connection data sets in DI/ETL design models. This feature should only be used when intending to export to another DI/ETL tool.

IBM COGNOS REPORTSTUDIO OPTIONS
-r
Remove the report pages and their graphical structure.
STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"IBM Cognos ReportStudio"
Metamodel
CognosRnReportStudio
Mapping Comments
     
Attribute Column When a query uses a TabularSQL object, the Columns in use can be inferred by parsing the SQL statement
Name name  
BaseType   No datatype information is available in ReportStudio
Class Table When a query uses a TabularSQL object, the Tables in use can be inferred by parsing the SQL statement
CppClassType   Set to ENTITY
CppPersistent   Set to True
Name name  
ClassifierMap   ClassifierMap objects are used to hold the lineage of Query DataSets, ReportDataSets
Operation expression text can be a Cognos native expression or a SQL statement
Condition FrameworkManager Filter Condition are used to hold the lineage of Filters and WhereClauses for tabular DataSets
Name name  
DataAttribute QueryItem The QueryItems of each TabularSet, TabularModel, TabularSQL and TabularReference are imported as DataAttribute
Name name  
Position position  
DataSet Queries, Tabular Sets The query TabularSets, TabularModels, TabularSQL and TabularReference objects are imported as DataSets
Name name  
DatabaseSchema Database Schema When a query uses a TabularSQL object, such DatabaseSchemas can be inferred by parsing the SQL statement
Name name  
DerivedType   No datatype information is available in ReportStudio
DesignPackage FrameworkManager Namespace, ReportStudio Folder DesignPackages reflect the reporting objects organization hierarchy as in the ReportSudio Query Explorer panel, as well as the organization hierarchy of objects used from the FrameworkManager model as in the ReportStudio Model Explorer panel
Name name  
UserDefined   set to FALSE
Dimension FrameworkManager QuerySubject The QuerySubjects used by the report queries are imported as Dimension
Name name  
DimensionAttribute FrameworkManager QueryItems  
Name name  
FeatureMap   FeatureMap objects are used to hold the lineage of QueryItems DataAttributes, ReportDataAttributes
Operation expression text can be a Cognos native expression or a SQL statement
Filter FrameworkManager Filter The Filters used by the report queries are imported as Filters
Name name  
Hierarchy FrameworkManager Hierarchy Inferred from QueryItems expressions used in the report Queries
Name Name  
HierarchyLevelAssociation FrameworkManager Hierarchy and Level Inferred from QueryItems expressions used in the report Queries
Name Name  
Level FrameworkManager Level Inferred from QueryItems expressions used in the report Queries
Name Name  
LevelAttribute FrameworkManager LevelAttribute Inferred from QueryItems expressions used in the report Queries
Name Name  
Measure FrameworkManager QuerySubject measures Inferred from QueryItems expressions used in the report Queries
Name Name  
OlapSchema FrameworkManager Namespace An OlapSchema is created to represent all namespaces from FrameworkManager used in the report
Name name  
Report Report  
Name file name The report name can be retrieved from the Cognos Repository if the bridge runs via the Repository bridge
ReportAttribute Query Item The QueryItems actually used on the report pages
Name name  
Position position  
ReportAxis CrossTab axis available since Cognos version 8
Role horizontal or vertical axis  
ReportChart Chart Legacy charts (Cognos 8 and earlier), enhanced charts (Cognos 10)
ReportDataSet Query A query used by a report page
Name name  
ReportField Report Field display of a Query Item on a report page
Name name if available
ReportMatrix CrossTab  
ReportPage Report Page  
Name name  
ReportPageBody Report Page Body  
ReportPageFooter Report Page Footer  
ReportPageHeader Report Page Header  
ReportRectangle   Rectangles are generic objects used to represent various layout html structures such as Tables, Blocks, Images
ReportTable List  
ReportText Text, Label  
Value textual value  
StoreConnection Database Catalog When a query uses a TabularSQL object, such DatabaseCatalogs can be inferred by parsing the SQL statement
Name name  
StoreModel Report XML File The model is built using the elements contained in the report XML file
Name file name The report name can be retrieved from the Cognos Repository if the bridge runs via the Repository bridge