| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
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 (/4HANA) or ERP, S/4HANA system. Or the 3-digit HANA DB ID of your HANA database.
Requirements
| Info |
|---|
Two possibilities to connect There are two ways how the Metadata API can connect to your 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).
|
The Data Lineage Metadata API can be started from any machine (windows Windows or unixUnix) which has with access to your SAP System or the underlying SAP HANA database.
A HANA database user is needed which has full select rights on the HANA schema on wihch the BW application is stored.
Installation
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:
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
| Code Block | ||||
|---|---|---|---|---|
| ||||
sudo mkdir DataLineage; sudo tar -xvf <DataLineageFileName>.tar.gz -C DataLineage; sudo chmod +x DataLineage/DataLineage.sh; sudo chmod +x DataLineage/Core/DataLineage |
Insert License
Two possible ways to insert a license for Data Lineage API exist.
We sent you a license file or a license hash. What to do with them is described in the subchapters below.
Using license file
Add the file license.lic into the Core folder.
Insert hash
Windows
| Code Block | ||
|---|---|---|
| ||
DataLineage.cmd insert-license -l <license hash> |
Unix
| Code Block |
|---|
Maintain Connection Data
Other settings
Run Application
| ||
./DataLineage.sh insert-license -l <license hash> |
Maintain Connection Data
In the appsetting.json file you have to configure the connection an other data for running the app.
More information about that can be found here.
Set Password
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 the parameter -b <HANA HDB>.
Windows
The following command will open a prompt to insert the password.
| Code Block | ||
|---|---|---|
| ||
DataLineage.cmd set-password -s <SID> |
Command for versions < 1.2.5
DataLineage.cmd set-password -s <SID> -h <HANA Schema> -p <password>
Unix
The following command will open a prompt to insert the password.
| Code Block | ||
|---|---|---|
| ||
./DataLineage.sh set-password -s <SID> |
Command for versions < 1.2.5
./DataLineage.cmd set-password -s <SID> -h <HANA Schema> -p <password>
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.
The following command is for examples only. The complete command list can be found here.
Windows
Run the application with the following command
| Code Block | ||
|---|---|---|
| ||
DataLineage |
...
Unix
Provide execution rights in terminal, if needed:
chmod 777 ./BwDataLineage or
_chmod +x BwDataLineage_
Run the application with ./BWDataLineage from terminal
Plan a regular job
Windows
...
.cmd extract-all -s <SID> |
Command for versions < 1.2.5
DataLineage.cmd extract-all -s <SID> -h <HANA Schema>
Unix
Run the application from the terminal
| Code Block | ||
|---|---|---|
| ||
./DataLineage.sh extract-all -s <SID> |
Command for versions < 1.2.5
./DataLineage.cmd extract-all -s <SID> -h <HANA Schema>
Plan a regular job
In most scenarios, it makes sense to pull the metadata of a system regularly. A recurring job should be created for this purpose. This chapter describes how to do it in Windows and Unix environments.
Note that this only works from versions > 1.4.0.
Windows
Open the Task Scheduler in Windows
Right Click > Create a task
In the general tab, you can give the task a name and should choose the second option “Execute independently of the user login”. You can also change the user here
In the tab Trigger, you have to set the interval in which the task should be scheduled
In the tab Actions, you have to insert the command which should be run.
Unix
Make sure DataLineage.sh has execution rights (chmod +x)
Edit the crontab file (crontab -e), adding the line for job
Example for a job every 5 minutes:
*/5 * * * * /<path>/DataLineage.sh extract-all -s <SID>
Make sure the job is in the jobs list after saving the file (crontab -l)
If the job doesn't run as expected, check the logs (grep "DataLineage" /var/log/syslog)