Document toolboxDocument toolbox

Configuration (appsettings.json)

General

To maintain the configuration data you have to change the appsettings.json file.
Per default the appsettings.json file is empty.

Every system you want to connect needs its object in the appsetting.json file.

Parameter per system type

RFC & HANA

in this chapter, it is described what to do to maintain the settings for the following connector types:
ECC, BW, S/4HANA, ERP, BW/4HANA, ABAP Relations, HANA

ECC, BW, S/4HANA, ERP, and BW/4HANA, ABAP Relations connectors are named in the following ABAP connectors. In contrast, there are HANA connectors.

If you want to connect to an ABAP connector you can choose between a RFC connection or a HANA connection which will get the information directly from the HANA database below the ABAP connector.

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.

Explaining the properties:

Property

Meaning

Connector

Example

Property

Meaning

Connector

Example

BwSid

The System ID of your BW system

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations

A4H, BI2, S4B, …

Server

The host or IP address of your HANA database

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations, HANA

http://hdb.mycompany.de

SystemNumber

The system number of the BW system

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations

00, 03, …

Client

The client of the BW system

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations

001, 800, …

Prefix

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

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations

Z_, /MYCOMP/Z_, …

UseAlwaysGetString

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.

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations

true, false

Database

The database on your HANA tenant where the BW application is located

HANA

HN2, HDB, SYSTEMDB, …

HanaSchema

The schema where the BW application is located

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations, HANA

SAPBI, SAPA4H, SAPHANADB, …

HanaSchemaBlacklist

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.

HANA

["_SYS_AFL", "_SYS_AUDIT", "_SYS_BI", "_SYS_BIC"]

SqlPort

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.

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations, HANA

30213

UseSsl

If you have set up and want to use an SSL connection to your HANA database.

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations, HANA

true, false

Languages

List of Languages you want to export

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations, HANA

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

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations, HANA

 

EncryptedPassword

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.

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations, HANA

 

ErpComponentBlacklist

Blacklist of Application Components in of DDIC tables, views and CDS Entities

ECC, S/4HANA, ERP

Recommended to start with a bigger blacklist in the beginning

"ErpComponentBlacklist": [
"AC*",
"AP*",
"BC*",
"BI*",
"BNS*",
"BW*",
"CA*",
"CO*",
"CRM*",
"CS*",
"DI*",
"EC*",
"EHS*",
"EIM*",
"EP*",
"EPM*",
"FI*",
"FIN*",
"FS*",
"GRC*",
"HAN*",
"HUG*",
"ICM*",
"IM*",
"IN*",
"IS*",
"KM*",
"LCM*",
"LE*",
"LO*",
"LOD*",
"MBL*",
"MDM*",
"MOB*",
"OPU*",
"PA*",
"PD*",
"PE*",
"PLM*",
"PM*",
"PP*",
"PPM*",
"PS*",
"PSM*",
"PT*",
"PY*",
"QM*",
"RE*",
"SAP*",
"SCM*",
"SD*",
"SLC*",
"SLL*",
"SV*",
"TM*",
"TR*",
"WEC*",
"WP*",
"XAP*"
]

CustomReportsFilter

Filter on the table PROGNAME

ABAP Relations

PROGNAME NOT LIKE '/1BCF41/%' AND PROGNAME NOT LIKE '/1BCWDY/%' AND PROGNAME NOT LIKE 'GP%' AND SUBC <> 'F' AND UNAM NOT LIKE 'SAP%' AND UNAM <> ''

SplitFilesChunckSize

Chunck size to split the Details, Buildups, and BuildupDescriptions file to multiple files by a number of entities.

0 - default. Output 1 file

BW, BW/4HANA, ECC, S/4HANA, ERP, ABAP Relations, HANA

0, 10000, 1000000

Connection String for HANA Connection

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

SAC

Property

Meaning

Connector

Example

Property

Meaning

Connector

Example

Url

URL of the SAC instance

SAC

https://mysacinstance.eu10.hcs.cloud.sap

TokenUrl

Token URL of the SAC instance

SAC

https://mysacinstance.authentication.eu10.hana.ondemand.com/oauth/token

ClientId

Client ID for the OAuth Authentication in SAC

SAC

 

EncryptedSecret

SAC

true, false

ExcludePrivateObjects

Handle if the private SAC entities should be included or excluded

SAC

 

Datasphere

Property

Meaning

Connector

Example

Property

Meaning

Connector

Example

AuthorizationUrl

Authorization URL of the Datasphere Instance

Datasphere

 

Url

URL of the Datasphere instance

Datasphere

https://mydspinstance.eu10.hcs.cloud.sap

TokenUrl

Token URL of the Datasphere instance

Datasphere

https://mydspinstance.authentication.eu10.hana.ondemand.com/oauth/token

ClientId

Client ID for the OAuth Authentication in Datasphere

Datasphere

 

RedirectUrl

Redirect URL

Datasphere

http://localhost:8089

EncryptedSecret

Datasphere

true, false

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.

image-20240607-080506.png

 

© 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: https://bluetelligence.de/en/imprint
Privacy policy: https://bluetelligence.atlassian.net/wiki/spaces/DMA/pages/4188635149/Privacy+Policy
Atlassian privacy policy: https://www.atlassian.com/legal/privacy-policy