Document toolboxDocument toolbox

Preparation and installation


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.

  1. Connection via RFC to BW or ECC systems

  2. 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 >=

  • 7.40 SP27

  • 7.50 SP23

  • 7.51 SP13

  • 7.52 SP09

  • 7.53 SP07

  • 7.54 SP05

  • 7.55 SP03

  • 7.56 SP01

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:



Download the latest version of the Data Lineage Metadata API and unzip it. Open the terminal or command line to work with the tool.


Download the zip and start the following command

mkdir DataLineage; tar -xvf <DataLineageFileName>.tar.gz -C DataLineage; chmod +x DataLineage/; 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.

Insert hash


DataLineage.cmd insert-license -l <license hash>


./ insert-license -l <license hash>

Using license file

Add the file license.lic into the Core folder.

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>.


The following command will open a prompt to insert the password.

Command for versions < 1.2.5

DataLineage.cmd set-password -s <SID> -h <HANA Schema> -p <password>


The following command will open a prompt to insert the password.

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.


Run the application with the following command


Run the application from the terminal

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.


  1. Open the Task Scheduler in Windows

  2. Right Click > Create a task

  3. 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

  4. In the tab Trigger, you have to set the interval in which the task should be scheduled

  5. In the tab Actions, you have to insert the command which should be run.


  1. Make sure has execution rights (chmod +x)

  2. Edit the crontab file (crontab -e), adding the line for job

    1. Example for a job every 5 minutes:        */5 * * * * /<path>/ extract-all -s <SID>

  3. Make sure the job is in the jobs list after saving the file (crontab -l)

  4. If the job doesn't run as expected, check the logs (grep "DataLineage" /var/log/syslog)


© 2024 bluetelligence GmbH. All rights reserved.
No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of bluetelligence GmbH. The information contained herein may be changed without prior notice. bluetelligence and Performer Suite and their respective logos are trademarks or registered trademarks of bluetelligence GmbH. SAP, ABAP, BAPI, SAP NetWeaver, SAP BI, SAP BW, SAC, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany or an SAP affiliate company. All other product and service names mentioned are the trademarks of their respective companies.
Impressum – Legal Notice:
Privacy policy:
Atlassian privacy policy: