If you want a license for the Data Lineage Metadata API we need the SID of your BW(/4HANA) or ERP, S/4HANA system. Or the 3-digit HANA DB ID of your HANA database.
Two possibilities to connect
There are two ways how the Metadata API can connect to your system.
Connection via RFC to BW or ECC systems
Connection via HANA through SQL API to BW, ERP, or HANA System
You can decide how you want to connect. For the RFC approach you need to install a Function Module in your development system and transport it through your landscape (more is described here). No Function Module needed since version v1.4.0 of the Metadata API and with SAP BASIS releases >=
The Data Lineage Metadata API can be started from any machine (Windows or Unix) with access to your SAP System or the underlying SAP HANA database.
Depending on the approach you have chosen, you will need a HANA, a BW, or an ERP user. Which rights are needed is described in the system-specific pages:
If you decided on the RFC connection you use the properties below BwSystemConfiguations. If you decided on the HANA SQL connection you use the properties below HanaSystemConfiguations.
It can contain multiple systems depending on what is maintained in our license (see below what it might look like).
Explaining the properties:
The System ID of your BW system
RFC & HANA
BI2, A4H, …
The host or IP address of your HANA database
RFC & HANA
The system number of the BW system
00, 03, …
The client of the BW system
001, 800, …
The prefix of the function module for the RFC connection
since v1.4.0 you can run the Metadata API without installing a function module. In that case you do not have to set it in appsettings file (more infos here).
Z_, /MYCOMP/Z_, …
DO NOT USE WITHOUT CONSULTNG BLUETELLIGENCE. Only works together with the prefix property. Controls that all data for an RFC connection is retrieved via the *RFC_GET_STRING function module.
The database on your HANA tenant where the BW application is located
HN2, HDB, SYSTEMDB, …
The schema where the BW application is located
SAPBI, SAPA4H, SAPHANADB, …
Schemas which should not be analyzed during the process of getting metadata from HANA. It totally make sense to restrict it via the list at least for some technical SAP schemas.
["_SYS_AFL", "_SYS_AUDIT", "_SYS_BI", "_SYS_BIC"]
The SQL Port of your HANA DB. Normally the SQL Port is 3<instance number>13. To figure out the SQL Port use this guide or visit the SAP help for more information.
If you have set up and want to use an SSL connection to your HANA database.
List of Languages you want to export
RFC & HANA
[ "E", "D" ], [ "E" ], ["D", "C", "F"]
User for the BW Data Lineage API. The user needs full select rights on the HANA schema of the BW system.
RFC & HANA
No manual input. The password must be set via command line (see here). In that case a property EncryptedPassword is stored in the appsettings.json file. If you need to use a clear password, please use the connection string.
Instead of using the delivered content of the appsettings.json file, you can use a connection string if you need to set more properties for your HANA database. That is important if you use e.g. proxy servers and users.
For more detailed information you can visit the SAP guide.
Example of ConnectionString:
If you do not insert a password in the connection string you can also set an encrypted password via command line (see here).
Connection properties for upload
If you want to upload the file directly to a platform you need to maintain the parameters to upload your metadata.
The following command in the command line sets an encrypted password into the appsettings.json file.
In the following examples, the set password is done for BW-/ERP-systems with an RFC connection. Here the parameter -s <SID> is used. If you have a HANA connection you have to set the password with parameter -b <HANA HDB>.
The BW Data Lineage API can be started for one system. To find all parameters you can use, try --help to get more information. The following command is for examples only. The complete command list can be found here.