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) 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.1.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.
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.
For XI versions 4.2 and older, 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 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 import bridge uses the WebIntelligence RESTful Web Service SDK.
For XI versions 4.0 up to SP5, the WebIntelligence import import bridge uses the deprecated WebIntelligence Report Engine (Rebean) SDK, which provides limited metadata.
For XI versions up to 3.x, the WebIntelligence import 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
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 reasons, 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 http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html
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 -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
| Parameter Name | Description | Type | Values | Default | Scope | |||||||||||
| 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. |
ENUMERATED |
|
Auto detect | ||||||||||||
| 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 |
STRING | localhost | Mandatory | ||||||||||||
| Authentication mode | The BusinessObjects Repository server authentication mode used to connect: '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 | ||||||||||||
| 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. |
STRING | Administrator | Mandatory | ||||||||||||
| Password | The BusinessObjects user password used to connect. | PASSWORD | ||||||||||||||
| Repository browsing mode | The mode of browsing for available objects in the BusinessObjects repository: 'Universes only' The tree of Universes and Folders is retrieved. No documents are retrieved. 'Connections only' The list of Connections is retrieved. 'All' The tree of Universes, Folders and Documents is retrieved. This mode requires more time to complete on large repositories. This is the default. |
ENUMERATED |
|
All | ||||||||||||
| 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 import 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. 'True' Import only the changes made since the last import 'False' import all metadata. This option is required after upgrading the import 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> |
BOOLEAN |
|
True | ||||||||||||
| Add dependent objects | Add documents dependent on selected universes: 'True' The documents dependent on selected universes are imported. 'False' 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. |
BOOLEAN |
|
True | ||||||||||||
| 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. 'None' |
ENUMERATED |
|
None | ||||||||||||
| 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. |
ENUMERATED |
|
As a flat structure | ||||||||||||
| 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 | ||||||||||||
| Multiple threads | Number of worker threads to harvest metadata asynchronously. - Leave the parameter blank to have the import 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. |
NUMERIC | ||||||||||||||
| Miscellaneous | INTRODUCTION Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g. -connection.cast MyDatabase1="MICROSOFT SQL SERVER" Some options can be used multiple times if applicable, e.g. -connection.rename NewConnection1=OldConnection1 -connection.rename NewConnection2=OldConnection2; As the list of options can become a long string, it is possible to load it from a file which must be located in ${MODEL_BRIDGE_HOME}\data\MIMB\parameters and have the extension .txt. In such case, all options must be defined within that file as the only value of this parameter, e.g. ETL/Miscellaneous.txt JAVA ENVIRONMENT OPTIONS -java.memory <Java Memory's maximum size> (previously -m) 1G by default on 64bits JRE or as set in conf/conf.properties, e.g. -java.memory 8G -java.memory 8000M -java.parameters <Java Runtime Environment command line options> (previously -j) This option must be the last one in the Miscellaneous parameter as all the text after -java.parameters is passed "as is" to the JRE, e.g. -java.parameters -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. Note: The majority of proxies are concerned with encrypting (HTTPS) the outside (of the company) traffic and trust the inside traffic that can access proxy over HTTP. In this case, an HTTPS request reaches the proxy over HTTP where the proxy HTTPS-encrypts it. -java.parameters -java.parameters -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass -java.executable <Java Runtime Environment full path name> (previously -jre) It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g. -java.executable "c:\Program Files\Java\jre\bin\javaw.exe" Some API based bridges (e.g. JDBC) may require a SSL / TLS based secure connection, no setup is needed when using an official certificate signed by a Certificate Authority (CA). However, when using a self signed certificate, then such a certificate needs to be imported in your java environment (before restarting your Java application) typically as follows: cd $JAVA_HOME/jre/lib/security mv jssecacerts jssecacerts.old $JAVA_HOME/bin/keytool -importkeystore -srckeystore {your_keystore} -keystore jssecacerts -environment.variable <name>=<value> (previously -v) None by default, e.g. -environment.variable var2="value2 with spaces" MODEL IMPORT OPTIONS -model.name <model name> Override the model name, e.g. -model.name "My Model Name" -prescript <script name> This option allows running a script before the bridge execution. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), 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" -postscript <script name> This option allows running a script after successful execution of the bridge. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), 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: -postscript "script.bat arg1 arg2" -cache.clear Clears the cache before the import, and therefore will run a full import without incremental harvesting. If the model was not changed and the -cache.clear parameter is not used (incremental harvesting), then a new version will not be created. If the model was not changed and the -cache.clear parameter is set (full source import instead of incremental), then a new version will be created. -backup <directory> This option allows to save the bridge input metadata for further troubleshooting. The provided <directory> must be empty. The primary use of this option is for data store import bridges, in particular JDBC based database import bridges. Note that this option is not operational on some bridges including: - File based import bridges (as such input files can be used instead) - DI/BI repository import bridges (as the tool's repository native backup can be used instead) - Some API based import bridges (e.g. COM based) for technical reasons. DATA CONNECTION OPTIONS Data Connections are produced by the import bridges typically from ETL/DI and BI tools to refer to the source and target data stores they use. These data connections are then used by metadata management tools to connect them (metadata stitching) to their actual data stores (e.g. databases, file system, etc.) in order to produce the full end to end data flow lineage and impact analysis. The name of each data connection is unique by import model. The data connection names used within DI/BI design tools are used when possible, otherwise connection names are generated to be short but meaningful such as the database / schema name, the file system path, or Uniform Resource Identifier (URI). The following options allows to manipulate connections. These options replaces the legacy options -c, -cd, and -cs. -connection.cast ConnectionName=ConnectionType Casts a generic database connection (e.g. ODBC/JDBC) to a precise database type (e.g. ORACLE) for SQL Parsing, e.g. -connection.cast "My Database"="MICROSOFT SQL SERVER". The list of supported data store connection types includes: ACCESS APACHE CASSANDRA DB2/UDB DENODO GOOGLE BIGQUERY HIVE MYSQL NETEZZA ORACLE POSTGRESQL PRESTO REDSHIFT SALESFORCE SAP HANA SNOWFLAKE MICROSOFT SQL AZURE MICROSOFT SQL SERVER SYBASE SQL SERVER SYBASE AS ENTERPRISE TERADATA VECTORWISE HP VERTICA -connection.rename OldConnection=NewConnection Renames an existing connection to a new name, e.g. -connection.rename OldConnectionName=NewConnectionName Multiple existing database connections can be renamed and merged into one new database connection, e.g. -connection.rename MySchema1=MyDatabase -connection.rename MySchema2=MyDatabase -connection.split oldConnection.Schema1=newConnection Splits a database connection into one or multiple database connections. A single database connection can be split into one connection per schema, e.g. -connection.split MyDatabase All database connections can be split into one connection per schema, e.g. -connection.split * A database connection can be explicitly split creating a new database connection by appending a schema name to a database, e.g. -connection.split MyDatabase.schema1=MySchema1 -connection.map SourcePath=DestinationPath Maps a source path to destination path. This is useful for file system connections when different paths points to the same object (directory or file). On Hadoop, a process can write into a CSV file specified with the HDFS full path, but another process reads from a HIVE table implemented (external) by the same file specified using a relative path with default file name and extension, e.g. -connection.map /user1/folder=hdfs://host:8020/users/user1/folder/file.csv On Linux, a given directory (or file) like /data can be referred to by multiple symbolic links like /users/john and /users/paul, e.g. -connection.map /data=/users/John -connection.map /data=/users/paul On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g. -connection.map C:\data=M:\ -connection.map C:\data=N:\ -connection.casesensitive ConnectionName Overrides the default case insensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g. -connection.casesensitive "My Database" -connection.level AggregationLevel Specifies the aggregation level for the external connections, e.g.-connection.level catalog The list of the supported values: server catalog schema (default) BUSINESS OBJECTS OPTIONS Note that the import 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: For XI versions 4.2 and older, a 32 bit JRE is needed for BusinessObjects Universes that use ODBC/OLEDB connections, Therefore, the import bridge should use the JRE delivered with BusinessObjects, e.g. -java.executable "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 import bridge. - the newer BusinessObjects Information Design Tool (IDT)'s universe.UNX for which a specific JRE can specified as defined below: -businessobjects.idt.java32.executable <JRE path> (previously -idtJre32) Sets the absolute path to JRE (javaw.exe on Windows) to be used for IDT, e.g. -businessobjects.idt.java32.executable "C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\win32_x86\jre8\bin\javaw.exe" -businessobjects.idt.java32.memory <path> (previously -idtJre32m) Sets the maximum size of the memory used by the JRE for IDT, e.g. -businessobjects.idt.java32.memory 1G -businessobjects.idt.java32.memory 1024M |
STRING |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"SAP BusinessObjects Repository XI" Metamodel BoRepository |
Mapping Comments |
| 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 | |
| DirectoryStructureModel | Repository | |
| Name | name | |
| FeatureMap | The Mapping Models use many ClassifierMaps to connect Objects and Filters defined in Universe models with Objects and Filters used in documents | |
| Folder | Folder, Category | |
| Description | description | |
| Name | name | |
| MappingVersion | Used to store stitching mappings between report models and universe models | |
| ModelVersion | Universe, Document | |
| MultiModelVersion | Repository | |
| StoreContent | Universe, Document | |
| Name | name | |
| 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. |
| Name | name |