requires the tool to be installed to access its SDK.
is only supported on Microsoft Windows.
|Tool Name||BusinessObjects (BO) Repository|
|Tool Version||11.x to 14.x|
|Tool Web Site||http://www.sap.com/solutions/sapbusinessobjects/large/intelligenceplatform/bi/information-infrastructure/enterprise|
|Supported Methodology||[Business Intelligence] Multi-Model, Metadata Repository, BI Design (RDBMS Source, Dimensional Target, Transformation Lineage, Expression Parsing), BI Report (Relational Source, Dimensional Source, Expression Parsing, Report Structure), Graphical Layout via Java API|
|Remote Repository Browsing for Model Selection|
Tool: SAP / BusinessObjects (BO) Repository version 11.x to 14.x via Java API
Metadata: [Business Intelligence] Multi-Model, Metadata Repository, BI Design (RDBMS Source, Dimensional Target, Transformation Lineage, Expression Parsing), BI Report (Relational Source, Dimensional Source, Expression Parsing, Report Structure), Graphical Layout
Component: BoRepository11 version 11.0.0
This bridge extracts all files from BusinessObjects repository and imports the detailed metadata (including lineage) within each of them, including:
- BusinessObjects Universe design layers known including the classic BusinessObjects Designer's universe.UNV, and the newer BusinessObjects Information Design Tool (IDT)'s universe.UNX.
- BusinessObjects Reports including Crystal reports, Web Intelligence reports, Desktop Intelligence reports, and more.
This bridge requires SAP BusinessObjects SDKs and a specific Java JRE as explained below:
BusinessObjects supports Java 8 only and is not compatible with any version of OpenJDK which may be the default JRE.
The bridge will try to reuse the JRE bundled with the BusinessObjects Client software.
You may also 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.
BusinessObjects SDK Requirements:
The bridge relies on the SAP BusinessObjects Universe Designer OLE/COM API to import the Universe metadata. Therefore, SAP BusinessObjects Universe Designer must be properly installed on the machine executing this bridge.
The bridge relies on the SAP BusinessObjects Desktop Intelligence COM/OLE API to import the Report metadata. Therefore, SAP BusinessObjects Desktop Intelligence must be properly installed on the machine executing this bridge.
The bridge relies on the SAP BusinessObjects Web Intelligence SDK to import Report metadata.
For XI versions 4.0 SP6 and newer, the WebIntelligence import bridge uses the WebIntelligence RESTful Web Service SDK.
For XI versions 4.0 up to SP5, the WebIntelligence import bridge uses the deprecated WebIntelligence Report Engine (Rebean) SDK, which provides limited metadata.
For XI versions up to 3.x, the WebIntelligence import bridge uses the WebIntelligence Report Engine (Rebean) SDK.
The bridge relies on the Semantic Layer Java SDK to import Information Design Tool (IDT) universe metadata.
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:
- BusinessObjects Information Design Tool can be started on the machine which the bridge runs on. It generally is installed as part of the 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.
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 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.
At runtime, the bridge requires the following SAP BusinessObjects 'servers' to be started and enabled on the SAP BusinessObjects environment:
- for WebIntelligence Report Engine (Rebean) SDK: WebIntelligenceProcessingServer
- for WebIntelligence RESTful Web Service SDK: WebApplicationContainerServer (applicable for version XI R4.x)
Use the Central Management Console web application to check:
- Under the 'Servers' menu: the above servers are available and running correctly
- Under the 'Applications' menu: the 'RESTful Web Service' is available, it may not be installed by default.
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:
FREQUENTLY ASKED QUESTIONS
Q: What username and password should I supply as BO login?
A: Please provide a valid BO username and password, the same way you would login with Designer or Desktop Intelligence.
For example: Administrator
If you are not sure about which username and password to use, you should contact your BO system administrator.
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.
- 'Administrators' to be able to access favorite folders.
Q: The bridge fails to import a UNV universe for an unknown reasons, what can I do ?
A: Please try running the BusinessObjects Designer bridge to import the UNV universe, and set the parameter 'Execution mode' to 'Interactive'.
The application may display an error in a popup window.
Q: Why does the Crystal Report Application Server (RAS) fail to start?
A: Since version 12.0 (XI 3.0), one needs to configure the RAS manually, as follows:
- Using the CMS Administration web console, enable the Guest account.
As of version XI 3.0, the Guest account is disabled by default.
- Using the CMS Administration web console, configure the RAS startup command line with a parameter -ipport to specify a port number that you know to be free. For example, you can set the ipport switch to specify the default port 1566 with -ipport "1566". For further details, see the BusinessObjects Enterprise Administrator's Guide.
For older versions 11.x, similar recommendations still apply, the Guest account must be enabled, and the RAS server must be running and enabled. Use the Central Configuration Manager to check the status of the Report Application Server (RAS).
Q: What report file formats does this bridge support?
A: This bridge can read the report formats supported by SAP BusinessObjects Desktop Intelligence:
- BusinessObjects documents (*.rep)
- BusinessObjects document templates (*.ret)
- BusinessQuery Files (*.bqy)
- WebIntelligence 2.x documents (*.wqy)
- Crystal reports (*.rpt) since version 11
Q: What report file formats are not supported?
A: BusinessObjects Desktop Intelligence and this bridge do not support:
- WebIntelligence 6.x documents (*.wid)
- Crystal reports (*.rpt) prior to version 11
- Crystal OLAP Analysis reports (*.car)
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.
Q: What are the recommended firewall settings for running this bridge?
A: This bridge relies on the BusinessObjects client components to be able to communicate reliably with the BO server.
Designer, DesktopIntelligence, WebIntelligence and Crystal must be able to logon with the CMS, download and open universes and documents. If your firewall is not properly configured, the bridge may hang indefinitely, or fail with no clear explanation. For detailed firewall settings, please ask your system administrator and refer to the BusinessObjects documentation. Alternatively, you can disable the firewall and check the bridge runs correctly without it.
Q: Why some universe dependent report documents appear missing?
A: The subsetting by universe feature relies on the BO Repository metadata cache of dependency between universes and report documents, and therefore works well on production environments where all reports are actively used. However, in the context of BO Repositories in development and test environments, some universes and/or report documents may have been redesigned or moved leaving inaccurate dependency information in the BO Repository cache. In such case, all dependent report documents of a given universe may not be detected. The BO repository cache can be refreshed by editing such document, refreshing the queries, and saving it back into the BO server.
In order to verify that a particular document is properly linked to its universes in the BO server cache, you can:
- Start the CMC administration web console (not InfoView)
- Navigate through the public folders and find the document you are interested in
- Display the properties of the document
- The tab labeled 'Universe' (in versions 11.x) or 'Report Universes' (in versions 12.x) shows the universe dependencies
Q: What are the BO requirements to properly use the BO bridges?
A: Ensure all the following recommendations are met:
1. The bridge should be installed on a machine with the SAP BusinessObjects client installation only. It should not be installed on a machine which has SAP BusinessObjects server.
2. The bridge should be run as a desktop application, not as a Windows service.
3. Do not use remote access technologies such as Microsoft Netmeeting, SharedView or Office LiveMeeting, as COM-based remote access technologies have been known to interfere with the SAP BusinessObjects API's and thus bridge function.
4. Ensure that there are no firewall restrictions for access to the SAP BusinessObjects API and server. If the bridge is failing to connect properly, disable the firewall temporarily to ensure that it is not the cause of the failure.
5. Always use the SAP BusinessObjects user 'Administrator' when using this bridge, as many of the API calls that the bridge uses provide complete information only if one connects as the user 'Administrator'.
6. Be sure that the latest SAP BusinessObjects service packs are installed, and that they are installed consistently on the server and client machines.
7. Clean up the temporary universe download directory, as some stale or locked files can prevent importing universes. Delete all temporary files from this directory. This directory path is configured in Designer: Tools menu -> Options -> Save -> Default Universe Folder. This directory path may be saved in the registry in: HKEY_LOCAL_MACHINE\SOFTWARE\Business Objects\Suite XXXX\default\Shared\General\Directories\Universes
8. If there are any 'designer.exe' processes running on the system before running the bridge, terminate them using the task manager, as they could interfere with proper COM apis execution.
Q: Why are some universes imported which are not in the folders specified for the import?
A: The bridge tries to harvest a self-contained set of BO objects. If the bridge parameter 'Add dependent objects = True' the bridge will import all reports dependent on the specified universes and in case these reports depend on any other universes the bridge should import them as well, in order to be sure these reports are fully defined.
Q: Is there a way to test that the WebIntelligence RESTful Web Service is working correctly?
A: It is possible to test the BusinessObjects 14.x (XI R4) WebIntelligence RESTful Web Service by connecting to the following URLs:
Login api: http://boserver:6405/biprws/logon/long
InfoStore api: http://boserver:6405/biprws/infostore/12345
The developer documentation is available at:
The Curl command line utility allows automating such api calls as command line scripts:
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html
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 metadata to the support team to reproduce an issue?
A: Provide the following files:
- For BusinessObjects 6.x, save the universe(s) as UNV file(s) and document(s) as REP file(s) with check the check-box 'Save for all users' enabled.
- For BusinessObjects 11.x and 12.x (XI):
It is no longer possible to exchange metadata as files between different Central Management Server repositories.
To exchange universe(s) and document(s) between two CMS repositories, create a Business Intelligence Archive file (*.BIAR) using the BusinessObjects Import Wizard utility (ImportWiz.exe) and include the universe(s) and document(s) of interest in it.
- for BusinessObjects 14.x (XI R4):
Using the Lifecycle Management Console, create a 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 the support team.
|Version||The BusinessObjects software version.
This software version must be installed on the computer that runs this bridge.
Note that applying different SAP BusinessObjects Service Packs may or may not change the version number.
Use 'Auto detect' for the bridge to try to detect the version of the BusinessObjects client software installed locally.
|System||The BusinessObjects Repository server name used to connect.
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 can be specified with the following syntax: cms:port@cluster. For example: localhost:6400@MYCLUSTER
|Authentication mode||The BusinessObjects Repository server authentication mode used to connect:
BusinessObjects Enterprise login.
Login using an LDAP server.
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:
For details, see SAP Note 1621106:
|User name||The BusinessObjects user name used to connect.
A repository installation of BusinessObjects (BO) requires the user to identify himself/herself using a login.
For example: Administrator (versions 11.x and 12.x)
If you are not sure about which username and password to use, you should contact your company BO system administrator (supervisor).
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.
- 'Administrators' to be able to access favorite folders.
|Password||The BusinessObjects user password used to connect.||PASSWORD|
|Repository browsing mode||The mode of browsing for available objects in the BusinessObjects repository:
The tree of Universes and Folders is retrieved. No documents are retrieved.
The list of Connections is retrieved.
The tree of Universes, Folders and Documents is retrieved. This mode requires more time to complete on large repositories. This is the default.
|Repository subset||The subset of the BusinessObjects repository to import defined as a semicolon (;) separated list of IDs of universes, reports and/or folders.||REPOSITORY_SUBSET|
|Incremental import||Incremental import only extracts what has changed since the last import. The initial full metadata harvesting (model import) of a very large source system can take a long time. However the extracted metadata are organized as a multi-model, where each model is a unit of change (e.g. Schema of a RDBMS server, or report of BI server). Subsequent model imports are dramatically faster than the initial import as this bridge will automatically try to detect changes in the source system, in order to only process the modified, added or deleted models and reuse all unchanged metadata from the model cache. Note however that the detection of change is more or less efficient depending on the sources system: e.g. BI servers can quickly provide the list of new, modified or deleted reports, but not all data stores offer a schema level change detection.
Import only the changes made since the last import
import all metadata. This option is required after upgrading the bridge in particular to take full advantage of any additional metadata coverage.
For debugging purpose, the option -cache.clear of the Miscellaneous parameter can be used to clear one model from the cache which is located (by default) in: $HOME/data/MIMB/cache/<BridgeId>/<ModelId>
|Add dependent objects||Add documents dependent on selected universes:
The documents dependent on selected universes are imported.
The documents dependent on selected universes are not imported.
WARNING: This feature relies on the BO Repository metadata cache of dependency between universes and report documents, and therefore works well on production environments where all reports are actively used. However, in the context of BO Repositories in development and test environments, some universes and/or report documents may have been redesigned or moved leaving inaccurate dependency information in the BO Repository cache. In such case, all dependent report documents of a given universe may not be detected. The BO repository cache can be refreshed by loading such modified or moved report documents and refreshing the queries.
|Add specific objects||Add documents that do not depend on any universe:
'Universe independent Documents'
The documents that do not depend on any universe are imported.
|Crystal CORBA port||Specifies the client port number on which the Crystal SDK will communicate with the report application server (RAS). If no port is specified, the RAS server will randomly select a port for each execution. If specified, the RAS server will use that port to send metadata to the local client computer. Please make sure that the local Windows firewall is disabled, or allows receiving communication on this port. If using an enterprise firewall, configure it to allow communication from the RAS server to the client computer on this port. If a firewall is blocking communication, the client Crystal SDK will wait for metadata indefinitely.||NUMERIC|
|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.
|As a flat structure|
|Import joins||Specify whether joins and contexts should be imported.
The joins and contexts are imported.
The joins and contexts are not imported.
|Import hierarchies||Specify whether hierarchies should be imported.
The hierarchies are imported.
The hierarchies are not imported.
|Multiple threads||Number of worker threads to harvest metadata asynchronously.
- Leave the parameter blank to have the bridge compute the value, between 1 and 6, based on JVM architecture and number of available CPU cores.
- Specify a numeric value greater or equal to 1 to provide the actual number of threads.
If the value specified is invalid, a warning will be issued and 1 will be used instead.
If you experience out of memory conditions when harvesting metadata asynchronously, experiment with smaller numbers.
If your machine has a lot of available memory (e.g. 10 Gb or more), you can try larger numbers when harvesting many documents at once.
Note that setting the number too high can actually decrease the performance due to resource contention.
|Miscellaneous||Specify miscellaneous options identified with a -option followed by a value if required:
-m <Java Memory's maximum size>
1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-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.
-prescript "script.bat arg1 arg2"
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.
|Meta Integration Repository (MIR)
(based on the OMG CWM standard)
|"SAP BusinessObjects Repository XI"
|ClassifierMap||The Mapping Models use many ClassifierMaps to connect QuerySubjects and Filters defined in FM models with QuerySubjects and Filters used in reports|
|Connection||Used to store stitching mappings between report models and universe models|
|FeatureMap||The Mapping Models use many ClassifierMaps to connect Objects and Filters defined in Universe models with Objects and Filters used in documents|
|MappingVersion||Used to store stitching mappings between report models and universe models|
|NativeId||path or id|
|StoreModel||Universe, Desktop Intelligence Document, WebIntelligence Document||All runiverses and documents are imported using the Designer, Reporter and WebIntelligence import bridges. See the respective bridges specification for details on metadata mapping of each tool.|