SAP BusinessObjects Information Design Tool (IDT) (File) - Export - 7.1

Talend Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
7.1
EnrichProdName
Talend Big Data Platform
Talend Data Fabric
Talend Data Management Platform
Talend Data Services Platform
Talend MDM Platform
Talend Real-Time Big Data Platform
EnrichPlatform
Talend Data Catalog

Bridge Requirements

This bridge:
  • requires the tool to be installed to access its SDK.

  • is only supported on Microsoft Windows.

Bridge Specifications

Vendor SAP
Tool Name BusinessObjects (BO) Information Design Tool
Tool Version 14.1 to 14.x
Tool Web Site http://www.sap.com/solutions/sapbusinessobjects/large/intelligenceplatform/
Supported Methodology [Business Intelligence] BI Design (RDBMS Source, Dimensional Target, Transformation Lineage, Expression Parsing), Graphical Layout via Eclipse Java API on Universe (.UNX) File

SPECIFICATIONS
Tool: SAP / BusinessObjects (BO) Information Design Tool version 14.1 to 14.x via Eclipse Java API on Universe (.UNX) File
See http://www.sap.com/solutions/sapbusinessobjects/large/intelligenceplatform/
Metadata: [Business Intelligence] BI Design (RDBMS Source, Dimensional Target, Transformation Lineage, Expression Parsing), Graphical Layout
Component: BoInformationDesignToolUnx version 11.0.0

OVERVIEW
This bridge requires SAP BusinessObjects SDKs and a specific Java JRE as explained below.

REQUIREMENTS

JAVA REQUIREMENTS
BusinessObjects supports Java 8 only and is not compatible with any version of OpenJDK which may be the default JRE.
Use the Miscellaneous parameter to point to a Java Environment supported by BusinessObjects.
UNX Universes based on jdbc connections are supported with a 64 bit JVM.
UNX Universes based on other types of connections (odbc, oledb, ...) are only supported if using a 32bit JVM.
You may specify the path to a 32 bit JVM in this option, in order to support UNX universes based on an odbc connection.

BUSINESS OBJECTS SDK REQUIREMENTS
This bridge relies on the SAP BusinessObjects Semantic Layer Java SDK in order to export metadata to a UNX Universe. Therefore, the Semantic Layer Java SDK must be properly installed on the computer executing this bridge.
For XI versions 4.1 and newer, the Semantic Layer Java SDK is supported.
For XI versions 4.0 and older, the Semantic Layer Java SDK is not supported.

If unsure whether the Semantic Layer Java SDK is installed properly, be sure to check the following:
- SAP BusinessObjects Information Design Tool can be started on the machine which the bridge is running on. It generally is installed as part of the SAP BusinessObjects client tools.
- In Windows Control Panel > Programs > Programs and Features, you see 'SAP BusinessObjects BI platform 4.1 Client Tools'.
- In the BusinessObjects client tools installation directory, you see a folder 'SL SDK'. For example: C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\SL SDK

The required SL SDK is not installed by default. You need to install the SL SDK as an additional component to the Client Tools.
If the 'SL SDK' folder is not present in the client installation directory:
- click the button 'Uninstall/Change' on the 'SAP BusinessObjects BI platform 4.1 Client Tools' to run the installation wizard again,
- Select the Modify option and click Next twice.
- In the 'Select Features' screen, scroll down to Developer Components and check 'SAP BusinessObjects Semantic Layer Java SDK',
- Follow the remaining steps to install the Semantic Layer SDK resources on your machine. The 'SL SDK' folder should now be available.

Also, at bridge runtime be sure that you have:
- valid login access to a BO repository server (the bridge must login to the BO platform)

The BusinessObjects BI Platform SDK is based on CORBA technology.
When connecting to a remote server, the CORBA networking layer performs a bi-directional resolution of the server name/address.
Therefore, it is necessary to ensure that the specified server name/address can be resolved in the client environment.
The name resolution is usually successful when the client and server are part of the same enterprise network.
However when connecting from a client network to a server in a different network (for example Amazon AWS),
it may be necessary to configure an entry in the local host file (C:\Windows\System32\drivers\etc\hosts) like so:
1.2.3.4 servername

FREQUENTLY ASKED QUESTIONS
Q: What username and password should I supply as login?
A: Please provide a BO username and password, the same way you would open the universe with Information Design Tool.
For example: Administrator
If you are not sure about which username and password to use, you should contact your company BO system administrator.
The user should be a member of BusinessObjects groups:
- 'Universe Designer Users' to be able to open universes.

LIMITATIONS
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html
1. UNX Universes based on JDBC connections are supported. UNX Universes based on other types of connections (odbc, oledb, ...) are only supported if using a 32bit JVM.
2. Metadata coverage of the BusinessLayer is limited to Folders and Business Objects. Other objects (Filters, Hierarchies...) are not supported in 4.1.
3. Only universes based on relational data foundation are supported.

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
System Enter here the name of the BusinessObjects repository to login to.
This is the name of the Central Management Server. This server will be used to login, by default on port 6400. For example: localhost. If the CMS server is configured in a Cluster environment, the cluster name may be specified with the following syntax: cms:port@cluster. For example: localhost:6400@MYCLUSTER
STRING      
Authentication mode Select the login authentication mode to be performed.

'Enterprise'
BusinessObjects Enterprise login.

'LDAP'
Login using an LDAP server.

'Windows AD'
Login using a Windows Active Directory server.

Note: Windows AD authentication can be configured using Kerberos configuration files.
Update the file $MetaIntegration/conf/conf.properties to specify the Java virtual machine parameters:
M_JAVA_OPTIONS=-Djava.security.auth.login.config=C:\Windows\bscLogin.conf -Djava.security.krb5.conf=C:\Windows\krb5.ini

For details, see SAP Note 1621106:
http://service.sap.com/sap/support/notes/1621106
ENUMERATED
Enterprise
LDAP
Windows AD
Enterprise  
User name A repository installation of BusinessObjects (BO) requires the user to identify himself/herself using a login.
A standalone installation of BO does not require such identification. E.g.
Administrator

The user should be a member of the BusinessObjects group:
'Universe Designer Users'
To be able to open universes.
STRING   Administrator  
Password A repository installation of BusinessObjects (BO) requires the user to identify himself/herself using a login name and password. PASSWORD      
Directory Specify here the directory where to generate the universe files (Business Layer, Data Foundation).
This directory is usually the root directory of an IDT Project, or one of its sub directories.
DIRECTORY     Mandatory
Connection file Specify the local CNX connection file to use for the universe.
This connection file is usually located in the root directory of the IDT Project, or in one of its sub directories.
The bridge needs a working Connection to create new Tables and Joins in the universe. This is a mandatory parameter.
FILE *.cnx   Mandatory
Database catalog qualifier Specify the Database catalog qualifier, if any is necessary. This qualifier is used as a prefix, when inserting Tables into the DataFoundation.

For Microsoft Access, it is the path to the MDB file. E.g.
C:\Program Files (x86)\Business Objects\BusinessObjects Enterprise 12.0\Samples\en\UniverseSamples\efashion

For Microsoft SQLServer, it is the name of the database. E.g.
AdventureWorks2008
STRING      
Data model Outer Joins Most modeling and ETL tools only define the metadata of foreign keys and do not specify the type of SQL join (inner or outer) that should be defined in Business Intelligence tools.

This parameter controls the type of joins which are generated for each foreign key relationship.
'False'
Use only Inner joins for foreign key relationships.

'True'
Use the foreign key relationship optionality (optional versus mandatory) to determine if an 'Inner' or 'Outer' join should be used.
BOOLEAN
False
True
False  
Dimensional modeling detection When using this bridge to convert a data model created in a data modeling or ETL tool and then forward engineer it to an OLAP/BI model, the dimensional role that has been specified for each table (fact, dimension, outrigger) is always used by the bridge to infer how those tables are converted into BI facts and dimensions.

This parameter controls how additional table's dimensional role (fact, dimension, outrigger) is to be detected, if the source model did not specify that table's dimensional role.

'Only as defined by source model'
Use the tables dimensional role if defined by the source model.

'Autodetect additional Facts and Dimensions'
Automatic detection of fact and dimension tables from the relational schema, based on foreign keys. This algorithm considers tables with only incoming foreign keys as fact tables. Tables with outgoing foreign keys are considered dimension tables or outrigger tables depending on the minimum distance (number of foreign key relationships) to a fact table. Tables with no foreign key relationships to any other tables are considered to be dimension tables.

'Manually specified additional Facts and Dimensions'
Manually specify the fact and dimension tables.
ENUMERATED
Only as defined by source model
Autodetect additional Facts and Dimensions
Manually specified additional Facts and Dimensions
Autodetect additional Facts and Dimensions  
Dimensional modeling detection Fact tables When using this bridge to convert a data model created in a data modeling or ETL tool then and forward engineer it to an OLAP/BI model, the dimensional role that has been specified for each table (fact, dimension, outrigger) is used by the bridge to infer how those tables are converted into BI facts and dimensions. Specify the list of fact tables of your model in this parameter, and the bridge will consider those tables as fact tables when generating dimensions and measures. E.g.
dbo.Fact1; Fact2

This parameter is useful if the source tool does not support this notion of table dimensional role, and may be used to work around the limitations of the source tool.

The behavior of this parameter may be combined with the 'Dimensional modeling detection Dimension tables' parameter, so that some tables are handled as facts and the others as dimensions.
STRING      
Dimensional modeling detection Dimension tables When using this bridge to convert a data model created in a data modeling or ETL tool and then forward engineer it to an OLAP/BI model, the dimensional role that has been specified for each table (fact, dimension, outrigger) is used by the bridge to infer how those tables are converted into BI facts and dimensions. You may use this parameter to control whether the bridge should assume that all tables are dimensions.

'True'
The bridge assumes that all tables are dimensions.

'False'
The bridge uses the dimensional role specified on each table, if any.

This parameter is useful if the source tool does not support this notion of table dimensional role, and may be used to work around the limitations of the source tool.

The behavior of this parameter may be combined with the 'Dimensional modeling detection Fact tables' parameter, so that some tables are handled as facts and the others as dimensions.
BOOLEAN
False
True
True  
Miscellaneous Specify miscellaneous options identified with a -option followed by a value if required:

GENERAL 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.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.

BUSINESS OBJECTS OPTIONS
Note that the bridge's default JRE may not compatible with SAP BusinessObjects depending:
- on the JRE version: e.g. OpenJDK 11 instead of Oracle JVM 8
- or the JRE edition: 64 bit can work except if the BusinessObjects Universe uses ODBC/OLEDB connections, in such case a 32 bit JRE is needed.
Therefore, the bridge should use the JRE delivered with BusinessObjects, e.g.
-jre "C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\win32_x86\jre8\bin\javaw.exe"

In addition, a BusinessObjects repository may contain two types of Universes that may have different JRE requirements:
- a classic BusinessObjects Designer's universe.UNV for which is read by a C++ COM based bridge.
- the newer BusinessObjects Information Design Tool (IDT)'s universe.UNX for which a specific JRE can specified as defined below:

-idtJre32 <Java Runtime Environment full path name>
Absolute path to javaw.exe on Windows to be used for IDT, for example
-idtJre32 "C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\win32_x86\jre8\bin\javaw.exe"

-idtJre32m <Java Memory's maximum size>
Maximum size of the memory used by the JRE for IDT, e.g.
-idtJre32m 1G
-idtJre32m 1024M
STRING      

 

Bridge Mapping

Mapping information is not available