IBM Cognos ReportStudio - Import
Availability-note
AWS
AWS-only features are available at any of the following URLs: us.cloud.talend.com, eu.cloud.talend.com, ap.cloud.talend.com
Bridge Specifications
| Vendor | IBM |
| Tool Name | Cognos ReportStudio |
| Tool Version | ReportNet 1.1 to Cognos 12.x |
| 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 |  |
| Incremental Harvesting | |
| Multi-Model Harvesting | |
| Remote Repository Browsing for Model Selection | |
SPECIFICATIONS
Tool: IBM / Cognos ReportStudio version ReportNet 1.1 to Cognos 12.x 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.2.0
OVERVIEW
This import 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 MIMB Known Limitations or bundled in Documentation/ReadMe/MIMBKnownLimitations.html
SUPPORT
Provide a troubleshooting 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 -backup option, although this common option is not implemented on all bridges for technical reasons).
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 | |||
| Miscellaneous | INTRODUCTION Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g. -connection.cast MyDatabase1="MICROSOFT 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 -java.memory <Java Memory's maximum size> (previously -m) 1G by default on 64bits JRE or as set in conf/conf.properties, e.g. -java.memory 8G -java.memory 8000M -java.parameters <Java Runtime Environment command line options> (previously -j) This option must be the last one in the Miscellaneous parameter as all the text after -java.parameters is passed "as is" to the JRE, e.g. -java.parameters -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. Note: The majority of proxies are concerned with encrypting (HTTPS) the outside (of the company) traffic and trust the inside traffic that can access proxy over HTTP. In this case, an HTTPS request reaches the proxy over HTTP where the proxy HTTPS-encrypts it. -java.parameters -java.parameters -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass MODEL IMPORT OPTIONS -model.name <model name> Override the model name, e.g. -model.name "My Model Name" -prescript <script name> This option allows running a script before the bridge execution. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), 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" -postscript <script name> This option allows running a script after successful execution of the bridge. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), 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: -postscript "script.bat arg1 arg2" -cache.clear Clears the cache before the import, and therefore will run a full import without incremental harvesting. If the model was not changed and the -cache.clear parameter is not used (incremental harvesting), then a new version will not be created. If the model was not changed and the -cache.clear parameter is set (full source import instead of incremental), then a new version will be created. -backup <directory> This option allows to save the bridge input metadata for further troubleshooting. The provided <directory> must be empty. The primary use of this option is for data store import bridges, in particular JDBC based database import bridges. Note that this option is not operational on some bridges including: - File based import bridges (as such input files can be used instead) - DI/BI repository import bridges (as the tool's repository native backup can be used instead) - Some API based import bridges (e.g. COM based) for technical reasons. 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 option 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"="MICROSOFT SQL SERVER". The list of supported data store connection types includes: ACCESS APACHE CASSANDRA DB2/UDB DENODO GOOGLE BIGQUERY HIVE MYSQL NETEZZA ORACLE POSTGRESQL PRESTO REDSHIFT SALESFORCE SAP HANA SNOWFLAKE MICROSOFT SQL AZURE MICROSOFT SQL SERVER SYBASE SQL SERVER SYBASE AS ENTERPRISE TERADATA VECTORWISE HP 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 SourcePath=DestinationPath 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 /user1/folder=hdfs://host:8020/users/user1/folder/file.csv 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 /data=/users/John -connection.map /data=/users/paul On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g. -connection.map C:\data=M:\ -connection.map C:\data=N:\ -connection.casesensitive ConnectionName Overrides the default case insensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g. -connection.casesensitive "My Database" -connection.level AggregationLevel Specifies the aggregation level for the external connections, e.g.-connection.level catalog The list of the supported values: server catalog schema (default) IBM COGNOS REPORTSTUDIO OPTIONS -cognos.removeReportPages (previously -r) Remove the report pages and their graphical structure. -cognos.useReportSpecificationName Use the Cognos report specification name instead of the Cognos content manager name. |
STRING |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"IBM Cognos ReportStudio" Metamodel Cognos BI Reporting (ReportStudio) |
Mapping Comments |
| Attribute | Column | |
| Name | Name | |
| PhysicalName | Physical Name | |
| Position | Position | |
| Class | Table | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Condition | Report Filter Condition, Condition Filter | |
| Description | Description | |
| Hide | Hide | |
| InitialValue | Initial Value | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Optional | Optional | |
| PhysicalName | Physical Name | |
| Position | Position | |
| ConnectionPackage | Database Schema | |
| Name | Name | |
| PhysicalName | Physical Name | |
| DataAttribute | QueryItem, CalculatedMember, Language Variable, Calculated Measure, Boolean Variable, Member, String Variable, DataAttribute, DataAttribute Measure | |
| Description | Description | |
| InitialValue | Initial Value | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Optional | Optional | |
| PhysicalName | Physical Name | |
| Position | Position | |
| Usage | Usage | |
| DataSet | Variables, Query | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| PhysicalName | Physical Name | |
| DesignPackage | Query Package | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Dimension | Measure Dimension, Dimension | |
| Description | Description | |
| Hide | Hide | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Type | Type | |
| DimensionAttribute | Attribute, Key Level Attribute | |
| Description | Description | |
| Hide | Hide | |
| InitialValue | Initial Value | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Optional | Optional | |
| OriginalName | Original Name | |
| Position | Position | |
| Sort | Sort | |
| Filter | Report Filter | |
| Name | Name | |
| Hierarchy | Hierarchy | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| PhysicalName | Physical Name | |
| Type | Type | |
| Level | Level | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Measure | Measure | |
| DefaultAggregation | Default Aggregation | |
| Description | Description | |
| Hide | Hide | |
| InitialValue | Initial Value | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Optional | Optional | |
| Position | Position | |
| Sort | Sort | |
| Prompt | Prompt | |
| MultipleSelection | Multiple Selection | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Question | Question | |
| PromptAnswer | PromptAnswer | |
| InitialValue | Initial Value | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Optional | Optional | |
| Report | Report | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| ReportAttribute | Active Report Variable | |
| InitialValue | Initial Value | |
| Name | Name | |
| ReportAxis | Crosstab Corner, Crosstab Rows, Crosstab Columns, Axis | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Position | Position | |
| Role | Role | |
| ReportChart | Chart | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Position | Position | |
| ReportDataSet | Active Report Variables | |
| Name | Name | |
| ReportField | ReportField Measure, Field, Crosstab Node Member Body, Crosstab Node Member, ReportField Measure Body, Field Body, Chart Node Member, Chart Node Member Body | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Position | Position | |
| ReportMatrix | Crosstab | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Position | Position | |
| ReportPage | Page | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Position | Position | |
| ReportPageBody | Body | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Position | Position | |
| ReportPageFooter | Footer | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Position | Position | |
| ReportPageHeader | Header | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Position | Position | |
| ReportRectangle | Crosstab Nested Nodes, Rectangle, ReportTable, Chart Nested Nodes, Chart Node, Image, Crosstab Node | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Position | Position | |
| ReportTable | ReportList | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Position | Position | |
| ReportText | Html Item, Text | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Position | Position | |
| Value | Value | |
| StoreConnection | Model Connection, Database Connection | |
| Connection | Connection | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| PhysicalName | Physical Name | |
| StoreType | Store Type | |
| SystemMajorVersion | System Major Version | |
| SystemMinorVersion | System Minor Version | |
| SystemReleaseVersion | System Release Version | |
| SystemType | System Type | |
| SystemTypeOld | System Type Old | |
| StoreModel | ReportStudio Model | |
| Author | Author | |
| CreationTime | Creation Time | |
| Description | Description | |
| ModificationTime | Modification Time | |
| Modifier | Modifier | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| PhysicalName | Physical Name | |
| StoreType | Store Type | |
| SystemMajorVersion | System Major Version | |
| SystemMinorVersion | System Minor Version | |
| SystemReleaseVersion | System Release Version | |
| SystemType | System Type | |
| SystemTypeOld | System Type Old |