Bridge Specifications
| Vendor | IBM |
| Tool Name | Cognos Framework Manager |
| Tool Version | C8 v8.1 to C11 |
| Tool Web Site | http://www.ibm.com/software/analytics/cognos/ |
| Supported Methodology | [Business Intelligence] BI Design (RDBMS Source, OLAP Source, Dimensional Target, Transformation Lineage, Expression Parsing) via XML File |
SPECIFICATIONS
Tool: IBM / Cognos Framework Manager version C8 v8.1 to C11 via XML File
See http://www.ibm.com/software/analytics/cognos/
Metadata: [Business Intelligence] BI Design (RDBMS Source, OLAP Source, Dimensional Target, Transformation Lineage, Expression Parsing)
Component: CognosRnFrameworkManager2 version 11.0.0
OVERVIEW
The bridge imports IBM Cognos Framework manager models 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
Cognos expressions may use a cognos proprietary macro language, the syntax of this language is not supported (parsed). Therefore lineage might be incomplete if any such macros are used.
FrameworkManager allows defining models with many locales, and selecting one of them as the default locale.
Please note that the bridge only supports the default locale for unique identification of objects, and lineage tracing purpose.
If you create FM QuerySubjects with different names in different locales, only the name in default locale will be used to connect to reports' expressions.
As requirement, FM models should be designed with a single locale, or your reports should match the default locale of their source FM model.
SUPPORT
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)
Q: How do I provide IBM Cognos Framework Manager metadata to support team to reproduce an issue?
A: If you have the Framework Manager project from which you published the package, please ZIP up that project and submit to support team.
If you do not have the Framework Manager project, you can export the IBM Cognos package of interest and send the resulting archive to support team.
For more details on exporting IBM Cognos server metadata please refer to IBM Cognos documentation, or to the description of IBM Cognos Content Manager import bridge.
Bridge Parameters
| Parameter Name | Description | Type | Values | Default | Scope | |||
| File | The bridge uses the native XML file from IBM Cognos Framework Manager: Use the ellipsis (...) button to navigate to the project's directory you want to import and select the file 'model.xml'. |
FILE | *.xml | Mandatory | ||||
| Folder representation | Select how folders from IBM Cognos Framework Manager should be represented. 'Ignore' Folders are ignored. 'Flat' Folders are represented as Diagrams. Their hierarchy is not preserved. 'Hierarchical' Folders are represented as Diagrams and their hierarchy is preserved. |
ENUMERATED |
|
Ignore | ||||
| Package representation | Select how the packages from IBM Cognos Framework Manager should be represented. 'Ignore' Ignore subject areas. 'Subject Areas' Represent packages as subject areas. 'Model' Represent the package as the model. (For published packages only) |
ENUMERATED |
|
Ignore | ||||
| Tables design level | This option controls the design level of the imported tables. It is particularly relevant when exporting metadata to a target tool which supports two views of the model: a logical view and a physical view. Some Data Modeling tools support this concept, where you can decide if a table appears both as a physical table and as a logical entity. Some Business Intelligence tools also support this concept, where you can decide if a table appears both in the physical model and in the business view of the model. 'Logical and physical' The tables will appear both in the logical view and in the physical view of the model. 'Physical' The tables will appear only in the physical view of the model . |
ENUMERATED |
|
Physical | ||||
| Ignore usage property | Specify whether the usage property of a queryItem should be used. 'True' QueryItem of usage attribute will be represented as a dimension attribute, and a queryItem of usage fact will be represented as a measure. 'False' Ignore query items. |
BOOLEAN |
|
True | ||||
| __Package repository path__ | The path of the published package in the IBM Cognos repository. | 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 -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. -java.parameters -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 -java.executable <Java Runtime Environment full path name> (previously -jre) It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g. -java.executable "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe" -environment.variable <name>=<value> (previously -v) None by default, e.g. -environment.variable 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 -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" IBM COGNOS FRAMEWORKMANAGER OPTIONS |
STRING |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"IBM Cognos Framework Manager (FM)" Metamodel CognosRnFrameworkManager2 |
Mapping Comments |
| Name | parameterName | |
| Argument | ProcParameter | |
| DefaultValue | value | |
| Kind | mode | |
| Name | parameterName | |
| Position | Position of the ProcParameter in the xml file | |
| AssociationRole | No equivalent, see Join Role | |
| Attribute | QueryItem | All QueryItems of a dbQuery will be mapped to an Attribute |
| Description | description | |
| Name | name | |
| Optional | nullable | |
| PhysicalName | columnName | |
| Position | Position of the QueryItem in the xml file | |
| BaseType | QueryItem | Computed from the datatype of the QueryItem |
| DataType | datatype | |
| Length | precision,size | Use Precision if it is not null, use Size otherwise |
| Name | datatype | |
| Scale | scale | |
| CandidateKey | Key | The first key by position in the xml file will be mapped as the primary candidate key of the dbQuery |
| Name | name | |
| UniqueKey | Always set to true | |
| Class | dbQuery | All dbQueries will be mapped to a Class |
| Description | description | |
| Name | name | |
| ClassDiagram | Folder, Package | A Class Diagram will be created for each folder if the option "Import folders" is not set to "No". And a Class Diagram will be created for each package if the option "Import packages" is set to "Yes". |
| Description | description | |
| Name | name | |
| ClassifierMap | modelQuery,Filter,Relationship | A Classifier Map will be created for each modelQuery/Filter/Relationship |
| Name | The name will be computed from the name of the modelQuery/Filter/Relationship | |
| Condition | Filter.Relationship | |
| Name | The name will be computed from the name of the Filter/Relationship | |
| DatabaseSchema | Data Source | A Schema will be created for each Datasource with a non empty schema |
| Name | schema | |
| DerivedType | QueryItem | Computed from the datatype of the QueryItem |
| DataType | datatype | |
| Length | precision,size | Use Precision if it is not null, use Size otherwise |
| Name | datatype | |
| Scale | scale | |
| DesignPackage | Namespace, Folder | A Package is created for each namespace, and for each folder if the option "Import folders" is set to "Hierarchical" |
| Description | description | |
| Name | name | |
| UserDefined | Set to false only for the packages created to keep the folder hierarchy. | |
| Dimension | modelQuery | |
| Description | description | |
| Name | name | |
| Type | Set to "FactDimension" if the Dimension contains at least one measure | |
| DimensionAttribute | QueryItem | All QueryItems of usage "attribute" or "identifier" of a modelQuery will be mapped to a Dimension Attribute |
| Description | description | |
| Hide | hidden | |
| Name | name | |
| Sort | unsortable | |
| Name | name | |
| Name | name | |
| FeatureMap | QueryItem,Filter,Relationship | A FeatureMap will be created for each QueryItem of a modelQuery and each expression of a Filter/Relationship |
| Name | The name will be computed from the name of the queryItem or Filter/Relationship | |
| Operation | expression | |
| Filter | Filter | |
| Description | description | |
| Name | name | |
| Hierarchy | Hierarchy | |
| Name | name | |
| HierarchyLevelAssociation | Hierarchy,Level | |
| Index | Index | |
| Generate | Always set to true | |
| Name | A name will be computed | |
| IndexMember | Index,QueryItem | |
| Name | The name will be computed from the name of the QueryItem | |
| Position | Position of the QueryItem in the xml file | |
| Join | Relationship | |
| Type | cardinality | |
| JoinRole | Relationship | |
| Multiplicity | cardinality | |
| Level | Level | |
| Name | name | |
| LevelAttribute | Level,QueryItem | |
| Name | name | |
| LevelKey | Level | |
| Name | name | |
| Measure | QueryItem | All QueryItems of usage "fact" of a modelQuery will be mapped to a Measure |
| DefaultAggregation | regularAggregate | |
| Description | description | |
| Hide | hidden | |
| Name | name | |
| Sort | unsortable | |
| Projection | Graphical information of Classes | |
| RelationshipProjection | Graphical information of Associations | |
| SQLViewAssociation | No equivalent, see SQLViewEntity | |
| SQLViewAttribute | No equivalent, see SQLViewEntity | |
| SQLViewEntity | Not mapped: all dbQueries will be mapped as Class. See Class. | |
| StoreConnection | Data Source | A Catalog will be created for each Datasource with a non empty catalog. |
| Name | catalog | |
| StoreModel | Namespace | The Model is the root Namespace. |
| Description | description | |
| Name | Name | |
| StoredProcedure | StoredProcedure,Function | |
| CppAbstract | Not used | |
| CppConcurrency | Not used | |
| CppFriend | Not used | |
| CppScope | Not used | |
| CppStatic | Not used | |
| CppVirtual | Not used | |
| Description | description | |
| Name | name | |
| Postcondition | Not used | |
| Precondition | Not used |