SAP BusinessObjects Repository XI - Import

Bridge Specifications

Vendor	SAP
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
Data Profiling
Incremental Harvesting
Multi-Model Harvesting
Remote Repository Browsing for Model Selection

SPECIFICATIONS
Tool: SAP / BusinessObjects (BO) Repository version 11.x to 14.x via Java API
See http://www.sap.com/solutions/sapbusinessobjects/large/intelligenceplatform/bi/information-infrastructure/enterprise
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.2.0

OVERVIEW
This import 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.

REQUIREMENTS
This import bridge requires SAP BusinessObjects SDKs and a specific Java JRE as explained below:

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.

Java Requirements:
BusinessObjects supports Java 8 only and is not compatible with any version of OpenJDK which may be the default JRE.
The import bridge will try to reuse the JRE bundled with the BusinessObjects Client software.
UNX Universes based on JDBC connections are supported with a 64 bit JVM.
For XI versions 4.2 and older, UNX Universes based on other types of connections (ODBC, OLE DB, ...) are only supported if using a 32bit JVM.

BusinessObjects SDK Requirements:
The import 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 import bridge.

The import 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 import bridge.

The import 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 import 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 import 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 import 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 import 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:
1.2.3.4 servername

For networking and connectivity troubleshooting advice, please consult SAP Note 2151044
https://me.sap.com/notes/0002151044

You may also use the BI Platform Support Tool Communication Analyzer, as described in SAP Note 2393817
https://me.sap.com/notes/2393817

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 import bridge fails to import a UNV universe for an unknown reason, what can I do?
A: Please try running the BusinessObjects Designer import 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 import bridge support?
A: This import 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 import bridge do not support:
- WebIntelligence 6.x documents (*.wid)
- Crystal reports (*.rpt) prior to version 11
- Crystal OLAP Analysis reports (*.car)

Q: Can this import 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 import bridge as a service is not supported. Please make sure that if running from a remote import 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 import bridge?
A: This import 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 import 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 import 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 import 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 import 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 import bridge function.
4. Ensure that there are no firewall restrictions for access to the SAP BusinessObjects API and server. If the import 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 import bridge, as many of the API calls that the import 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 import 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 import bridge tries to harvest a self-contained set of BO objects. If the import bridge parameter 'Add dependent objects = True' the import bridge will import all reports dependent on the specified universes and in case these reports depend on any other universes the import 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:
http://help.sap.com/businessobject/product_guides/boexir4/en/xi4sp9_webi_restful_ws_en.pdf
The Curl command line utility allows automating such API calls as command line scripts:
http://curl.haxx.se/

LIMITATIONS
Refer to the current general known limitations at https://metaintegration.com/Products/MIMB/Help/#!Documents/mimbknownlimitations.html

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

Bridge Parameters

Bridge Mapping