License
If you want to have a license for the BW Data Lineage Metadata API we need the SID of your BW system and the HANA schema in which the BW application is stored.
Requirements
The BW Data Lineage Metadata API can be started from any machine (Windows or Unix) which has access to the SAP HANA database.
A HANA database user is needed which has full select rights on the HANA schema on which the BW application is stored.
Installation
Windows
Download the latest version of the BW Data Lineage Metadata API and unzip it. Open the terminal or command line to work with the tool.
Unix
Download the zip and start the following command
mkdir DataLineage; tar -xzf <DataLineageFileName>.tar.gz -C DataLineage; chmod +x DataLineage/DataLineage.sh; chmod +x DataLineage/Core/DataLineage
Insert License
There are two possible ways to insert a license for BW Data Lineage API.
We sent you a license file or a license hash. What to do with them is described in the subchapters below.
Insert hash
Windows
DataLineage.cmd insert-license -l <license hash>
Unix
./DataLineage.sh insert-license -l <license hash>
Using license file
Add the file license.lic into the Core folder.
Maintain Connection Data
Normal Connection properties
To maintain the connection data you have to change the appsettings.json file.
See below how it might look like. It can contain multiple systems depending on what is maintained in our license.
Explaining the properties:
Property | Meaning | Example |
---|---|---|
BwSid | The System ID of your BW system | BI2, A4H, .. |
Server | The host or IP address of your HANA database | hdb.mycompany.de |
Database | The database on your HANA tenant where the BW application is located | HN2, HDB, SYSTEMDB … |
HanaSchema | The schema where the BW application is located | SAPBI, SAPA4H, SAPHANADB, … |
SqlPort | The SQL Port of your HANA DB. | 30213 |
UseSsl | If you have set up and want to use an SSL connection to your HANA database. | true, false |
Languages | List of Languages you want to export | [ "E", "D" ], [ "E" ], ["D", "C", "F"] |
User | User for the BW Data Lineage API. The user needs full select rights on the HANA schema of the BW system. | |
Password | Password of the user for the BW Data Lineage API |
Complex connection properties
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:
Run Application
The BW Data Lineage API can be started for one system.
To find all parameters you can use, try --help to get more information.
Windows
Run the application with the following command
DataLineage.cmd -s <SID> -h <HANA Schema> -d #for descriptions
Unix
Run the application from terminal
./DataLineage.sh -s <SID> -h <HANA Schema> -d #for descriptions