{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"7"},"outline":{"value":"true"},"indent":{"value":"10px"},"style":{"value":"none"}},"macroMetadata":{"macroId":{"value":"07ec76aa899330c3e23578cc6b40236f"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"288c465f-3c03-47e1-a53d-da3edfa8d5f5"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"License","type":"text"}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Requirements","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Two possibilities to connect","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"There are two ways how the Metadata API can connect to your system.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Connection via RFC to BW or ECC systems","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Connection via HANA through ","type":"text"},{"text":"SQL API","type":"text","marks":[{"type":"link","attrs":{"href":"https://help.sap.com/docs/SAP_HANA_PLATFORM/0eec0d68141541d1b07893a39944924e/469e137b6d611014ac27bffe40be2f18.html?version=2.0.02&locale=en-US"}}]},{"text":" to BW, ERP, or HANA System","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"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 ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"https://bluetelligence.atlassian.net/wiki/spaces/DMA/pages/3481174077"}}]},{"text":").","type":"text"},{"type":"hardBreak"},{"type":"emoji","attrs":{"id":"atlassian-warning","text":":warning:","shortName":":warning:"}},{"text":" ","type":"text"},{"text":"No Function Module needed","type":"text","marks":[{"type":"strong"}]},{"text":" since version","type":"text"},{"text":" v1.4.0","type":"text","marks":[{"type":"strong"}]},{"text":" of the Metadata API and with SAP BASIS releases >=","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"7.40 SP27","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"7.50 SP23","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"7.51 SP13","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"7.52 SP09","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"7.53 SP07","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"7.54 SP05","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"7.55 SP03","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"7.56 SP01","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"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:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://bluetelligence.atlassian.net/wiki/spaces/DMA/pages/3059023897"}},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://bluetelligence.atlassian.net/wiki/spaces/DMA/pages/3551821825"}},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"inlineCard","attrs":{"url":"https://bluetelligence.atlassian.net/wiki/spaces/DMA/pages/3551854593"}},{"text":" ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Installation","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Windows","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Download the latest version of the Data Lineage Metadata API and unzip it. Open the terminal or command line to work with the tool.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Unix","type":"text"}]},{"type":"paragraph","content":[{"text":"Download the zip and start the following command","type":"text"},{"type":"hardBreak"}]},{"type":"codeBlock","attrs":{"language":"shell"},"marks":[{"type":"breakout","attrs":{"mode":"full-width"}}],"content":[{"text":"sudo mkdir DataLineage; sudo tar -xvf .tar.gz -C DataLineage; sudo chmod +x DataLineage/DataLineage.sh; sudo chmod +x DataLineage/Core/DataLineage","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Insert License","type":"text"}]},{"type":"paragraph","content":[{"text":"Two possible ways to insert a license for Data Lineage API exist.","type":"text"},{"type":"hardBreak"},{"text":"We sent you a license file or a license hash. What to do with them is described in the subchapters below.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Using license file","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the file license.lic into the ","type":"text"},{"text":"Core folder","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Insert hash","type":"text"}]},{"type":"paragraph","content":[{"text":"Windows","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"DataLineage.cmd insert-license -l ","type":"text"}]},{"type":"paragraph","content":[{"text":"Unix","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"./DataLineage.sh insert-license -l ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Maintain Connection Data","type":"text"}]},{"type":"paragraph","content":[{"text":"In the appsetting.json file you have to configure the connection an other data for running the app.","type":"text"}]},{"type":"paragraph","content":[{"text":"More information about that can be found ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"https://bluetelligence.atlassian.net/wiki/spaces/DMA/pages/3821928908"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Set Password","type":"text"}]},{"type":"paragraph","content":[{"text":"The following command in the command line sets an encrypted password into the appsettings.json file. ","type":"text"}]},{"type":"paragraph","content":[{"text":"In the following examples, the set password is done for BW-/ERP-systems with an RFC connection. Here the parameter -s is used. If you have a HANA connection you have to set the password with the parameter ","type":"text"},{"type":"hardBreak"},{"text":"-b ","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Windows","type":"text"}]},{"type":"paragraph","content":[{"text":"The following command will open a prompt to insert the password.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"DataLineage.cmd set-password -s ","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Command for versions < 1.2.5","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"DataLineage.cmd set-password -s -h -p ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Unix","type":"text"}]},{"type":"paragraph","content":[{"text":"The following command will open a prompt to insert the password.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"./DataLineage.sh set-password -s ","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Command for versions < 1.2.5","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"./DataLineage.cmd set-password -s -h -p ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Run Application","type":"text"}]},{"type":"paragraph","content":[{"text":"The BW Data Lineage API can be started for one system. ","type":"text"},{"type":"hardBreak"},{"text":"To find all parameters you can use, try --help to get more information.","type":"text"},{"type":"hardBreak"},{"text":"The following command is for examples only. The complete command list can be found ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"https://bluetelligence.atlassian.net/wiki/spaces/DMA/pages/3026681864"}}]},{"text":". ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Windows","type":"text"}]},{"type":"paragraph","content":[{"text":"Run the application with the following command","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"DataLineage.cmd extract-all -s ","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Command for versions < 1.2.5","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"DataLineage.cmd extract-all -s -h ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Unix","type":"text"}]},{"type":"paragraph","content":[{"text":"Run the application from the terminal","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"./DataLineage.sh extract-all -s ","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Command for versions < 1.2.5","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"./DataLineage.cmd extract-all -s -h ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Plan a regular job","type":"text"}]},{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Note that this only works from versions > 1.4.0.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Windows","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Open the Task Scheduler in Windows","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Right Click > Create a task","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":35.0},"content":[{"type":"media","attrs":{"width":786,"id":"3a37a71b-9440-4b01-b752-5e9fa87a9c2d","collection":"contentId-3026288655","type":"file","height":563},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":35.0},"content":[{"type":"media","attrs":{"width":632,"id":"4137f9df-949c-4ee0-aa43-feed5f52d060","collection":"contentId-3026288655","type":"file","height":480},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the tab Trigger, you have to set the interval in which the task should be scheduled","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the tab Actions, you have to insert the command which should be run.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":35.0},"content":[{"type":"media","attrs":{"width":454,"id":"0522a858-dfc0-46af-976c-0505aaed0e61","collection":"contentId-3026288655","type":"file","height":500},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Unix","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Make sure DataLineage.sh has execution rights (chmod +x)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Edit the crontab file (crontab -e), adding the line for job","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Example for a job every 5 minutes: ","type":"text"},{"text":"*/5 * * * * //DataLineage.sh extract-all -s ","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Make sure the job is in the jobs list after saving the file (crontab -l)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the job doesn't run as expected, check the logs (grep \"DataLineage\" /var/log/syslog)","type":"text"}]}]}]},{"type":"paragraph"}],"version":1}