Bridge Specifications
| Vendor | SAP |
| Tool Name | Business Suite 4 HANA (S/4HANA), ECC, R/3 ERP |
| Tool Version | 6.0 |
| Tool Web Site | https://www.sap.com/products/erp.html |
| Supported Methodology | [Business Application] Data Store (Physical Data Model, Logical Data Model) via JCO API |
SPECIFICATIONS
Tool: SAP / Business Suite 4 HANA (S/4HANA), ECC, R/3 ERP version 6.0 via JCO API
See https://www.sap.com/products/erp.html
Metadata: [Business Application] Data Store (Physical Data Model, Logical Data Model)
Component: SapR3 version 11.1.0
OVERVIEW
This bridge imports metadata from the SAP ECC ABAP dictionary.
REQUIREMENTS
This bridge relies on the SAP Java Connector (JCo) API libraries to connect and retrieve metadata. Therefore, the JCo libraries must be available on the machine executing this bridge.
The API communicates with the SAP server over the local network, and the following server ports may be used:
* Dispatcher port: 32NN used by SAP GUI for Windows and Java
* Gateway port: 33NN used for CPIC and RFC communications
* SNC secured Gateway port: 48NN used for CPIC and RFC encrypted communications
(where NN is your SAP Instance number from 00 to 99).
Make sure that your firewall settings allow communications on these ports.
Before using this bridge, you must configure the SAP ECC server by deploying an ABAP RFC function module.
You need an ABAP developer account to create the RFC FunctionModule on the SAP server.
This module responds to queries from this bridge, to retrieve the necessary metadata.
Supplemental documentation is available explaining how to deploy the RFC function module on the server at:
<InstallDir>/conf/MIRModelBridgeTemplate/SapR3/
The user account requires sufficient permissions to connect to the SAP server and execute the following RFC function modules:
* STFC_CONNECTION (check connectivity)
* RFC_SYSTEM_INFO (check system information)
* OCS_GET_INSTALLED_COMPS (check software versions)
* Z_MITI_DOWNLOAD (main metadata import)
The SAP Java Connector (JCo) libraries may call additional RFC function modules (RFC_PING, RFC_METADATA_GET, ...).
Please consult support note 460089 for details: https://launchpad.support.sap.com/#/notes/460089
FREQUENTLY ASKED QUESTIONS
Q: SAP server can be slow, is it possible work offline?
A Retrieving metadata from the SAP server may take a few hours depending on the volume of metadata, workload of the SAP server, and speed of network between the SAP server and the local machine.
- use the Miscellaneous parameter option -backup to save the downloaded metadata as text files in a local directory.
- use the Offline metadata directory parameter to read the metadata from previously downloaded text files, to speed up this bridge execution, avoiding the delay of downloading from the server again.
LIMITATIONS
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html
This bridge does not support incremental harvesting, SAP ABAP Dictionary does not have obvious internal borders or large units of change. The ABAP Dictionary is organized as a vertical tree of components with horizontal relationship links. The bridge allows you to import all or some branches of the hierarchy at a time.
It is recommended to divide up the import into separate models, because oftentimes only the user knows how to divide the dictionary vertically without breaking horizontal relationships.
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 option -backup)
Bridge Parameters
| Parameter Name | Description | Type | Values | Default | Scope | |||||||||||||||||||||
| Application server | Enter here the name or IP address of the SAP Application Server Host to connect to. | STRING | Mandatory | |||||||||||||||||||||||
| Router string | Enter here the SAP router string to use for a system protected by a firewall. | STRING | ||||||||||||||||||||||||
| System number | Enter here the SAP system number (instance ID of the ABAP instance). This is a two digit integer between 00 and 99. | NUMERIC | Mandatory | |||||||||||||||||||||||
| Client | Enter here the SAP system client ID. The client is identified with three digit numeric number from 000 to 999. | NUMERIC | Mandatory | |||||||||||||||||||||||
| User name | Enter here your logon user name, it must be a valid user name on the SAP system. | STRING | Mandatory | |||||||||||||||||||||||
| Password | Enter here your logon user password. | PASSWORD | Mandatory | |||||||||||||||||||||||
| Default language | Specify the language you would like to use. | ENUMERATED |
|
DE | ||||||||||||||||||||||
| JCo library path | This bridge reads metadata from SAP using the Java Connector (JCo) 3.0 API. Specify in this parameter the directory path where the JCo libraries are located. This directory should contain for example on Microsoft Windows: - sapjco3.jar - sapjco3.dll Different versions of the JCo libraries are available from SAP, for various operating systems and processor architectures. Make sure that you are using the correct JCo distribution for your environment. For example, if you use a 32bits Java JVM on a 32 bits Windows platform, you should use the 32bits JCo libraries for Intel x86 processor. For download, licensing and other information, please refer to https://support.sap.com/en/product/connectors/jco.html |
DIRECTORY | Mandatory | |||||||||||||||||||||||
| Offline metadata directory | In order to facilitate testing and reproducing SAP metadata environment, when that environment is not installed locally, this parameter allows importing metadata from files previously downloaded from the SAP server. Specify in this parameter the directory path where the downloaded files are located. No connection to the SAP server is needed in this case, the usual connection parameters are ignored. | DIRECTORY | ||||||||||||||||||||||||
| Content | Allows to reduce import scope to a set of objects smaller than the whole server content. You may specify a semicolon separated list of object identifiers, in the format TYPE_ID . Supported object type codes are BFMR (Application Component) and DEVC (Package). |
REPOSITORY_SUBSET | ||||||||||||||||||||||||
| Miscellaneous | INTRODUCTION Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g. -connection.cast MyDatabase1="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\jre1.8.0_211\bin\javaw.exe" -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> 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. For example: -prescript "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> Full path of an empty directory to save the metadata input files for further troubleshooting. 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"="SQL SERVER". The list of supported data store connection types includes: ACCESS CASSANDRA DB2 DENODO HIVE MYSQL NETEZZA ORACLE POSTGRESQL PRESTO REDSHIFT SALESFORCE SAP HANA SNOWFLAKE SQL SERVER SYBASE TERADATA VECTORWISE 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 DestinationPath=SourcePath 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 hdfs://host:8020/users/user1/folder/file.csv=/user1/folder 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 /users/John=/data -connection.map /users/paul=/data On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g. -connection.map M:\=C:\data -connection.map N:\=C:\data -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" SAP OPTIONS -jco.file <file path> Specify path to file with additional connection details such as the SNC connection details. This bridge appends parameters specified in this bridge configuration to the file before passing it to the BW Java Connector (JCo). -function <function module name> Changes the SAP ABAP function module name used by this bridge from its default value of "Z_MITI_DOWNLOAD" e.g. -function "Z_MYMITI_DOWNLOAD" -idocs.skip Do not import (skip) iDocs -functiongroups.skip Do not import (skip) Function Groups and Function Modules -programs.skip Do not import (skip) Programs |
STRING |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"SAP Business Suite 4 HANA (S/4HANA), ECC, R/3 ERP" Metamodel SAP ERP Central Component (SAP ERP Central Component) |
Mapping Comments |
| Attribute | Message, Table Field | |
| Description | Short Description | |
| Name | Name | |
| Optional | Optional | |
| Position | Position | |
| Class | Table, IDoctype | |
| Description | Description, Short Description | |
| Name | Name | |
| DataAttribute | Data Field | |
| Name | Name | |
| DataSet | Structure | |
| Name | Name | |
| DatabaseSchema | Schema | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| DerivedType | Data Element, Domain | |
| Description | Short Description | |
| Length | Length | |
| LowerBound | Lower Limit | |
| Name | Name | |
| NativeDataType | Data Type | |
| Scale | Decimal Places | |
| UpperBound | Upper Limit | |
| DesignPackage | Program, Transaction, Application Component, Function Group, Class, Package | |
| Description | Description, Short Description | |
| Name | Name | |
| NativeId | Id | |
| PhysicalName | Software Component | |
| ForeignKey | Foreign Key | |
| Name | Name | |
| Index | Index | |
| Description | Short Text | |
| Name | Name | |
| Unique | Unique | |
| IndexMember | Index Member | |
| SortOrder | Sort Order | |
| SQLViewAttribute | View Field | |
| Description | Short Description | |
| Name | Name | |
| Position | Position | |
| SQLViewEntity | View | |
| Description | Short Description | |
| Name | Name | |
| ViewStatement | View Statement | |
| StoreModel | Instance | |
| Name | Name | |
| StoreType | Store Type | |
| SystemType | System Type | |
| StoredProcedure | Function Module | |
| Description | Description | |
| Name | Name | |
| TypeValue | Domain Value | |
| Description | Short Description | |
| Name | Name | |
| Position | Position | |
| Value | Value |