SAP BusinessObjects Designer (File) - Import - 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:
  • is only supported on Microsoft Windows.

  • requires the tool to be installed to access its SDK.

Bridge Specifications

Vendor SAP
Tool Name BusinessObjects (BO) Designer
Tool Version 6.x 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 COM API on Universe (.UNV) File
Incremental Harvesting
Multi-Model Harvesting
Remote Repository Browsing for Model Selection
Data Profiling

Import tool: SAP BusinessObjects (BO) Designer 6.x to 14.x (http://www.sap.com/solutions/sapbusinessobjects/large/intelligenceplatform/)
Import interface: [Business Intelligence] BI Design (RDBMS Source, Dimensional Target, Transformation Lineage, Expression Parsing), Graphical Layout via COM API on Universe (.UNV) File from SAP BusinessObjects Designer (File) Import bridge: 'BoDesignerUnv' 10.1.0

This bridge relies on the Business Objects Designer OLE/COM API in order to import metadata from a Universe. Therefore, SAP BusinessObjects Universe Designer must be properly installed on the computer executing this bridge.

If unsure whether Designer is installed properly, be sure to check the following:
- Designer must be executed as a windows application on the machine that runs the bridge. It generally is installed as part of the BO "desktop" tools.
- for the API to work, Designer must be executed as a COM/ActiveX component, i.e., the Designer COM/ActiveX component must be properly registered. You may check that a key exists in the windows registry in HKEY_CLASSES_ROOT\Designer.Application.

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)
- a valid database connection to the data warehouse for the model you want to convert.

There is a tool available from SAP BusinessObjects which can test for some connectivity issues. Go to Start -> All Programs -> Business Objects XI -> Diagnostic Tool. You must login with the same credentials as you use with the MIMB bridge. Then go to the menu Tests -> Run All Tests. You should see that all tests 'Pass'.

In addition, one may customize the configuration file used to control what tests are performed. It is located at C:\Program Files (x86)\Business Objects\common\4.0\java\lib\TestClasses.xml in the default SAP BusinessObjects client installation.

If any of these tests fail, please contact the local SAP BusinessObjects Administrator to resolve these issues. Please refer to Chapter 5, 'Working with Firewalls' in the SAP BusinessObjects Administration Guide.

Additional notes:
- The database connection is used to detect the database type but it is not required.
- For BO 5.x, 6.x, 11.5, 12.x, 14.x there is the option of connecting to the server in standalone (no CMS) mode, if the bridge is running on the server.
- For BO 11.0 there is no standalone mode and you must have a valid login.


FREQUENTLY ASKED QUESTIONS

Q: What username and password should I supply into the BO login window?
A: If your company is using a network installation of Business Objects with a BO Repository managing users and access rights, please provide a BO username and password, the same way you would open the universe with BO Designer.
For example: supervisor (versions 5.x and 6.x) or Administrator (versions 11.x, 12.x, 14.x)
If you are not sure about which username and password to use, you should contact your company BO system administrator.
For version 11.x (XI), 12.x (XI R3), 14.x (XI R4) the user should be a member of BusinessObjects groups:
- 'Universe Designer Users' to be able to open universes.

Q: The bridge fails to complete for an unknown reason, what can I do ?
A: Please try to run the bridge again with parameter 'Execution mode' set to 'Interactive'.
The application may display an error in a pop-up window.

Q: How should I understand the warning message: The Connection 'DB' is not working?
A: This indicates that the database connection specified for the universe is not working. The bridge uses the connection to determine the universe's database type and the valid expressions functions associated to it.
Please check the universe connection is working properly in Designer.

Q: Can this bridge run from an application server as a Windows service?
A: No, BO Designer is a desktop application, running the Designer COM api and this bridge as a service is not supported. Please make sure that if running from a remote bridge server, it is configured to run as a regular desktop application, not as a service.

SUPPORT

Q: How do I provide information to help the support team reproduce an issue?
A: Provide the following files:
- Business Objects Designer 5.x and 6.x: open the universe in Designer, select 'Save for all users', and save it as a UNV file.

- Business Objects Designer 11.x and 12.x (XI): create a Business Intelligence Archive file (*.BIAR) using the Business Objects Import Wizard utility (ImportWiz.exe) and include the universe in it.

- Business Objects Designer 14.x (XI R4): using Lifecycle Management Console create promotion job that has the required Infoobjects in it. Export the job as BIAR file. Below is the outline (for more details please see "Lifecycle management console for SAP BusinessObjects Business Intelligence platform 4.0 User Guide"):
1. Log into the lifecycle management console application. By default, you will be taken to the "Promotion Jobs" page.
2. Select New Job.
3. Enter the name, description, and keywords for the job in the appropriate fields.
4. In the "Save Job in" field, browse and select the repository folder where you want to save the job.
5. From the Source drop-down list, select the current system.
If the name of the current system is not listed, select the Login to a new CMS option. A new window is launched. Enter the name of the current system along with the username and password.
6. In the Destination drop-down list, select "Output to LCMBIAR File".
7. Click Create. A new job is created and stored in the CMS repository of the current system.
8. Add Infoobjects to the Job (including universes and connections of interest). You can also use the Manage Dependencies option to include the dependents of the selected Infoobjects.
9. Once done adding Infoobjects to the job, click Promote. The "Promote" window appears.
10.Click Export. You can choose to save the resulting BIAR file to a File System or an FTP location.
Send the BIAR file to support team.


Bridge Parameters

Parameter Name Description Type Values Default Scope
System Enter here the name of the Business Objects repository to login to.

- For Business Objects version 11.x and 12.x (XI), it 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

- For Business Objects version 5.x and 6.x, it is the name of the repository defined by the Supervisor application, for example: bomain. If this parameter is empty, Designer will perform an Offline login. A standalone installation of Business Objects does not require you to login.
STRING      
Authentication mode Select the login authentication mode to be performed.

This parameter is only applicable to version 11.0 and greater.
For versions 5.x and 6.x, this parameter is ignored.

'Enterprise' - Business Objects Enterprise login.
'LDAP' - Login using an LDAP server.
'Windows AD' - Login using a Windows Active Directory server.
'Windows NT' - Login using a Windows NT domain server.
'Standalone' - Standalone (no CMS), not available in version 11.0

The default authentication mode is 'Enterprise'.
ENUMERATED
Enterprise
LDAP
Windows AD
Windows NT
Standalone
Enterprise  
User name A repository installation of Business Objects (BO) requires the user to identify himself/herself using a login.
A standalone installation of BO does not require such identification.
For example: supervisor (versions 5.x and 6.x) or Administrator (versions 11.x and 12.x)
If you omit the username or password, a BO Login dialog box will be displayed, in which you should enter your usual BO login username and password.
In order to avoid Designer to prompt the Login dialog box when running this bridge remotely on a server, you should fill this parameter value.
For version 11.x and 12.x (XI), the user should be a member of BusinessObjects groups:
- 'Universe Designer Users' to be able to open universes.
STRING      
Password A repository installation of Business Objects (BO) requires the user to identify himself/herself using a login. A standalone installation of BO does not require such identification.

If you omit the username or password, a BO Login dialog box will be displayed, in which you should enter your usual BO login username and password.

In order to avoid Designer to prompt the Login dialog box when running this bridge remotely on a server, you should fill this parameter value.
PASSWORD      
File The import path name corresponds to the name of the Universe FILE to import. FILE *.unv   Mandatory
Silent execution Specify here whether to execute in interactive or silent mode.

'Silent' - The application runs in silent mode, pop-up windows and message boxes are blocked. This mode does not require user intervention, but may cause execution termination with unknown error.

'Interactive' - The application runs in interactive mode, allowing pop-up windows and message boxes. This mode may require user intervention to acknowledge pop-up windows, and allows the user to resolve issues during execution.

The default execution mode is 'Silent'.
ENUMERATED
Silent
Interactive
Silent  
Close after execution Close the Business Objects application after importing the model. By default the tool will be closed.

'False' - The application is left open on the desktop after the bridge has run.
'True' - The application is closed after the bridge has run.

Note that the application is started on the same machine where this bridge is running.

If running this bridge remotely on a distant server, this parameter should be set to 'True', otherwise the application will be left running on the server.
BOOLEAN   True  
Table design level This parameter 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 the 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.

Please set the parameter to:
'Logical and physical' - If you would like the tables to appear both in the logical view and in the physical view of the model.
'Physical' - If you would like tables to appear only in the physical view of the model (default).
ENUMERATED
Physical
Logical and physical
Physical  
Class representation This parameter controls how the tree structure of Classes and subClasses should be imported. The bridge will import each Class containing Objects as a Dimension (as defined by the CWM OLAP standard). In addition, Classes and subClasses can also be imported as a tree of Packages (as defined by the CWM and UML standards).

'As a flat structure' - No Packages are created (default).
'As a simplified tree structure' - A Package is created for each Class with subClasses.
'As a full tree structure' - A Package is created for each Class.
ENUMERATED
As a flat structure
As a simplified tree structure
As a full tree structure
As a flat structure  
Include List of Values This parameter controls how the bridge should import the List of Values associated to Objects. Since the target tool may not be able to display such a list, this algorithm is not enabled by default. Importing the List of Values via the Business Objects API also requires more time to perform the import. BOOLEAN   False  
Import joins Specify whether joins and contexts should be imported.

'True' - The joins and contexts are imported. (Default)
'False' - The joins and contexts are not imported.
BOOLEAN   True  
Import hierarchies Specify whether hierarchies should be imported.

'True' - The hierarchies are imported. (Default)
'False' - The hierarchies are not imported.
BOOLEAN   True  

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"SAP BusinessObjects Designer (File)"
Metamodel
BoDesigner
Mapping Comments
     
AliasClassifier AliasTable  
Name Name  
AliasFeature AliasColumn  
Name Name  
Association Join The "Retrofit Joins" bridge option allows to reverse engineer the simple joins into foreign key relationships, such as simple equi-joins and outer-joins. Complex joins such as theta-joins cannot be retrofited.
AssociationRole Join Represent both ends (Table1 and Table2) of the join
Multiplicity Cardinality and Outer  
Source   Based on the cardinalities
AssociationRoleNameMap Join Associates the columns of table1 to the column of table2.
Attribute Column  
DesignLevel   as defined by the "Table Logical information" bridge option
Name Name  
Position   In the order returned by the Designer API.
BaseType Column, Object BaseTypes are created to represent the columns and objects datatype
DataType   See datatype conversion array
Name   Derived from the datatype
PhysicalName   Derived from the datatype
CandidateKey Column A primary key is created for columns part of tables primary key
UniqueKey   Set to True
Class Table  
CppClassType   Set to ENTITY
CppPersistent   Set to True
DesignLevel   as defined by the "Table Logical information" bridge option
Name Name  
ClassDiagram Structure Pane One default Diagram is created to display the tables and joins used in the universe
Name   set to <Main Subject Area>
ClassifierMap Join, Filter, Class Used to hold the traceability of Joins, Filters and Classes, via FeatureMap objects.
Name Name  
Condition Filter, Join Used to hold the WhereClause statement of Filters and Joins via a FeatureMap object.
DatabaseSchema Owner If the Universe uses owner names
Name Name  
DerivedType Object List of Values  
DataType   See datatype conversion array
Name List Name  
UserDefined   Set to True
DesignPackage Class One default Package is created to store the tables and joins used in the universe. The classes are also imported as a tree of logical packages, or flattened into the default package, as set by the "Import Classes" bridge option.
Description Class description  
DesignLevel   Set to LOGICAL_ONLY for Classes
Name Name  
Dimension Class, SQL Derived Tables A dimension is created for each Class containing Objects
Description Description  
Hide Hide  
Name Name  
Type   Set to Regular by default, set to Fact if the Class holds measure objects Set to View for SQL Derived Tables
UserDefined   Set to True
DimensionAttribute Object Object of dimension or detail qualification
Description Description  
Hide Hide  
Name Name  
Sort Sort  
DrillPath CustomHierarchy Custom Hierarchies are imported as MIRDrillPath because they can span multiple MIRDimensions (Classes)
Name Name  
DrillPathLevelAssociation CustomHierarchy Element  
Name Name  
FeatureMap Join, Filter, Object Used to hold the traceability of Joins Condition, Filters Condition and Objects
Name Name  
Operation Select and Where Clause parsed SQL expression, empty if simple enough (direct mapping)
Filter Filter  
Description Description  
Hide Hide  
Name Name  
ForeignKey Join A foreign key is created to represent the columns involved in the join
Join Join  
Type Outer  
UserDefined   Set to True
JoinGroup Join Context  
Name name  
JoinRole Join 2 JoinRoles are created for each join
Multiplicity Cardinality and OuterJoin  
Level Default Hierarchy and CustomHierarchy Element  
Name Name  
LevelAttribute Default Hierarchy and CustomHierarchy Element  
Name Name  
Name Name  
Measure Object Object of measure qualification
DefaultAggregation Function  
Description Description  
Hide Hide  
Name Name  
Sort Sort  
OlapSchema Universe Represents the universe as a container of business objects available for use in reports
Name Name  
Projection Table Display Graphical Information
X x  
Y y  
SQLViewAssociation   Views are managed as regular Tables in the tool
SQLViewAttribute   Views are managed as regular Tables in the tool
SQLViewEntity   Views are managed as regular Tables in the tool
StoreConnection Qualifier, Database connection If the Universe uses qualifier names
Name Name  
StoreModel Universe The model is built using the tables, columns, joins, classes and objects defined in the universe
Comment Comments  
Description Description  
Name LongName  
PhysicalName Name name of the .UNV file (8 characters)
SystemType   Inferred via the connection to the database
SystemTypeOld   Inferred via the connection to the database
TypeValue Object List of Values  
Position   In the order returned by the Designer API.
Value Value