SAP BusinessObjects Designer (Repository) - Import
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 |
| Data Profiling |  |
| Incremental Harvesting | |
| Multi-Model Harvesting | |
| Remote Repository Browsing for Model Selection |  |
SPECIFICATIONS
Tool: SAP / BusinessObjects (BO) Designer version 6.x to 14.x via COM API
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: BoDesignerRepo version 11.2.0
OVERVIEW
This bridge imports Business Intelligence (BI) reporting metadata from a SAP BusinessObjects Universe.
REQUIREMENTS
WARNING: This bridge uses the COM API of a Windows based tool client and/or SDK which must be (a) properly installed, (b) licensed on behalf of a Windows user capable of running this tool, and (c) capable of accessing the tool server content. In addition:
(1) As recommended by the tool vendor, the tool server must NOT be installed/coexist on the same machine where the tool client (and the bridge) is installed/running because of potential conflicts of resources, including with respect to COM API.
(2) Windows COM API based tools are notoriously unstable after repeated failures or lack of system resources, which requires a Windows reboot to make that tool COM API work properly again.
(3) If this bridge is running as an application, then it must be logged with the same above Windows user.
If the bridge is running as a Windows service, then go to the services manager of Windows, right-click on the MIMB Application Server service, and go to the "Log On" tab to define an account by name under which the service will run.
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 Client 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.
The COM TypeLibrary (designer.tlb) registry key is expected as follows:
For version 14.x: HKEY_LOCAL_MACHINE\SOFTWARE\Classes\TypeLib\{F7B2D53E-16DF-472C-BEA1-24791A5F881F}
For version 12.x: HKEY_LOCAL_MACHINE\SOFTWARE\Classes\TypeLib\{FB14D5A5-A14D-42F5-AEC4-351874DFD86F}
For version 11.x: HKEY_LOCAL_MACHINE\SOFTWARE\Classes\TypeLib\{1DC0CC78-1662-4FEE-B073-C5BE441F49B1}
For version 5.x/6.x: HKEY_LOCAL_MACHINE\SOFTWARE\Classes\TypeLib\{33E93100-9D43-11D1-843F-0000C020EDE3}
You may also try to register the COM TypeLibrary manually:
- Open a Command window as Administrator.
- Navigate to where Designer.exe is located (win32_x86 or win64_x64 folder of your BO Client Tools install).
- Run: Designer.exe /RegServer
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 BusinessObjects 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.
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 debug log. Debug log can be set in the UI or in conf/conf.properties with MIR_LOG_LEVEL=6
Q: How do I provide information to help the support team reproduce an issue?
A: Provide the following files:
- BusinessObjects Designer 5.x and 6.x: open the universe in Designer, select 'Save for all users', and save it as a UNV file.
- BusinessObjects Designer 11.x and 12.x (XI): create a Business Intelligence Archive file (*.BIAR) using the BusinessObjects Import Wizard utility (ImportWiz.exe) and include the universe in it.
- BusinessObjects 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 BusinessObjects repository to login to. - For BusinessObjects 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 BusinessObjects 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 BusinessObjects does not require you to login. |
STRING | Mandatory | |||||||
| Authentication mode | The login authentication mode. Only applicable to version 11.0 and greater. For versions 5.x and 6.x, this parameter is ignored. 'Enterprise' BusinessObjects 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 |
ENUMERATED |
|
Enterprise | ||||||
| Username | 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. 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 | Mandatory | |||||||
| Password | 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. 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 | ||||||||
| Universe repository path | This parameter is used to access a specific universe stored in a BusinessObjects Repository. Specify the path of the universe, and the bridge will connect to the Repository, import (download) the universe, and read its metadata. For BusinessObjects version 11.x and 12.x (XI), the format of universe path is: {/UniverseFolder}*/UniverseName. Example: /Xtreme Sample Universe For BusinessObjects version 5.x and 6.x, the format of universe path is: UniverseDomain/UniverseName. Example: Universe/efashion |
REPOSITORY_MODEL | Mandatory | |||||||
| Silent execution | Specify 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. |
ENUMERATED |
|
Silent | ||||||
| Close after execution | Close the BusinessObjects application after importing the model. '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 | 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. |
ENUMERATED |
|
Physical | ||||||
| Class representation | 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. '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 | ||||||
| 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 BusinessObjects 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. 'False' The joins and contexts are not imported. |
BOOLEAN | True | |||||||
| Import hierarchies | Specify whether hierarchies should be imported. 'True' The hierarchies are imported. 'False' The hierarchies are not imported. |
BOOLEAN | True |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"SAP BusinessObjects Designer (Repository)" 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 |