Meta Integration® Model Bridge (MIMB)
"Metadata Integration" Solution

MIMB Bridge Documentation

MIMB Import Bridge from IBM Cognos Framework Manager (FM)

Bridge Specifications

Vendor IBM
Tool Name Cognos Framework Manager
Tool Version Cognos 8.1 to 12.x
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 Cognos 8.1 to 12.x 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.2.0

OVERVIEW
The import 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 https://metaintegration.com/Products/MIMB/Help/#!Documents/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
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).

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 import 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
Flat
Hierarchical
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
Subject Areas
Model
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
Logical and physical
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
False
True
True  
Macro values file File defining list of macro replacement values:
macro1=value1
macro2=value2
...
macroN=valueN

For example:
$machine=localhost
$runLocale=en
sq($runLocale)='en'
dq('Column ' + $runLocale)="Column en"
$Language_lookup{$runLocale}=EN
prompt('CountryName')=France
'[NAMESPACE].[QUERYSUBJECT].[QUERYITEM_'+$Language_lookup{$runLocale}+']'=[NAMESPACE].[QUERYSUBJECT].[QUERYITEM_EN]

FrameworkManager models may use macros to parameterize SQL statements.
The macros may contain dynamic prompts, which are only defined at runtime.
In such cases, the import bridge will print warnings in the log that it could not determine the value of a macro and will simply leave that macro without any substitution in the resulting model.
In order to determine the correct macro substitution values, the import bridge reads a macro values file with the macro and the correct value to substitute.
FILE *.*    
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>

Allows to save the input metadata for further troubleshooting. The provided <directory> must be empty.

-restore <directory>

Specify the backup <directory> to be restored.

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.caseinsensitive ConnectionName...

Overrides the default case sensitive 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.caseinsensitive "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 FRAMEWORKMANAGER OPTIONS
STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"IBM Cognos Framework Manager (FM)"
Metamodel
Cognos BI Reporting (FrameworkManager)
Mapping Comments
     
AliasClassifier Filter - Shortcut  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
Argument Argument  
DefaultValue Default Value  
Description Description  
Kind Kind  
Name Name  
NativeId Native Id  
NativeType Native Type  
PhysicalName Physical Name  
Position Position  
Attribute Column  
Comment Comment  
Description Definition  
DesignLevel Design Level  
InitialValue Initial Value  
Name Name  
NativeId Native Id  
Optional Nullable  
PhysicalName Physical Name  
Position Position  
Class Table  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
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 ConnectionPackage Data Source  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
PhysicalName Physical Name  
DesignPackage Dynamic Source, Data Source, Data Sources, Folder, Namespace  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
Dimension Calculation - Shortcut, Procedure Query, Database Query, Database Query - Shortcut, Model Query - Shortcut, Measure Dimension, Measure Dimension - Shortcut, Calculation, Dimension, Dimension - Shortcut, Model Query  
Description Description  
Hide Hide  
Name Name  
NativeId Native Id  
NativeType Native Type  
Type Type  
DimensionAttribute Attribute, DimensionAttribute Calculation, Query Item, 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 Filter  
Description Description  
Hide Hide  
Name Name  
NativeId Native Id  
NativeType Native Type  
Hierarchy Hierarchy  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
PhysicalName Physical Name  
Type Type  
Join Relationship, Scope Relationship  
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  
OlapSchema OlapSchema Namespace  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
PhysicalName Physical Name  
Stereotype Stereotype  
SQLViewAttribute View Column  
Comment Comment  
Description Definition  
DesignLevel Design Level  
InitialValue Initial Value  
Name Name  
NativeId Native Id  
Optional Nullable  
PhysicalName Physical Name  
Position Position  
SQLViewEntity View  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
StoreConnection StoreConnection Data Sources  
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 FrameworkManager 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  
StoredProcedure Function, StoredProcedure  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
PhysicalName Physical Name  
Postcondition Postcondition  
Precondition Precondition  
Semantics Code  

Last updated on Fri, 15 Nov 2024 17:43:11

Copyright © 1997-2024 Meta Integration Technology, Inc. All Rights Reserved.

Meta Integration® is a registered trademark of Meta Integration Technology, Inc.
All other trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.