Configuration (appsettings.json) | Metadata API Documentation

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

BW, ERP & 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
BwSid	The System ID of your BW system	BW, BW/4HANA, ECC, S/4HANA, ERP	A4H, BI2, S4B, …
Server	The host or IP address of your HANA database	BW, BW/4HANA, ECC, S/4HANA, ERP, HANA	http://hdb.mycompany.de
SystemNumber	The system number of the BW system	BW, BW/4HANA, ECC, S/4HANA, ERP	00, 03, …
Client	The client of the BW system	BW, BW/4HANA, ECC, S/4HANA, ERP	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	Z_, /MYCOMP/Z_, …
Delimiter	since Metadata API version 1.6.9 Used to get the data from SAP systems. If the set delimiter is used in a description in SAP the CLI runs into an error. Per default the delimiter is set to ¦ (BROKEN BAR `U+00A6`) JSON naively supported escape sequences: form feed \f, tab \t, backspace \b Characters not naively supported by JSON, they must be written using Unicode notation: vertical tab \u000B	BW, BW/4HANA, ECC, S/4HANA, ERP	`U+007C` \| VERTICAL LINE `U+2016` ‖ DOUBLE VERTICAL LINE `U+2223` ∣ DIVIDES
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	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, 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. Note that an object in an excluded schema will still be listed if it has a relationship to a non-excluded object. For a complete exclude you can use HardHanaSchemaBlacklist since version 1.6.5	HANA	["_SYS_AFL", "_SYS_AUDIT", "_SYS_BI", "_SYS_BIC"]
NumberOfParallelConnections	Since Version 1.8.0: Handles the number of parallel connections to SAP Systems. Is used only in case of extracting and parsing the ABAP Code	BW, BW/4HANA, ECC, S/4HANA, ERP	1, 30, etc.
HardHanaSchemaBlacklist	Since Version 1.6.5: Completely excludes schemas which set here. A combination of HanaSchemaBlacklist and HardHanaSchemaBlacklist is possible	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, 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, HANA	true, false
Languages	List of Languages you want to export	BW, BW/4HANA, ECC, S/4HANA, ERP, 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, 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, HANA
ErpCriteria	criteria which could be set SQL like to include or exclude specific value. columns: ObjectName, ObjectType, ApplicationComponent SQL operators like, in, =, != AND, OR, NOT wildcards * % Only ErpCriteria or ErpComponentBlacklist may be set.	ECC, S/4HANA, ERP	`"TechnicalName in (Z, Y) and Type not in ('OSOA', 'TRAN') and ApplicationComponent not in ('BC', 'FI')"` synchronize only entities starting with Z and Y, which are not from type Extractors and Transaction and not in Application Components starting with BC and FI.
ErpComponentBlacklist	Blacklist of Application Components in of DDIC tables, views and CDS Entities Only ErpCriteria or ErpComponentBlacklist may be set.	ECC, S/4HANA, ERP	Recommended to start with a bigger blacklist in the beginning Expand blacklist here "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 REPOSRC	Code Extract	SQL `PROGNAME NOT LIKE '/1BCF41/%' AND PROGNAME NOT LIKE '/1BCWDY/%' AND PROGNAME NOT LIKE 'GP%' AND SUBC <> 'F' AND UNAM NOT LIKE 'SAP%' AND UNAM <> ''`
ExtractNewCds	handles if new CDS View entities should be part of the extract or not. If the parameter is not set in the configuration the default is false.	ECC, S/4HANA, ERP	true, false
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, 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
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	No manual input. The secret must be set with the first start of the API for SAC.	SAC
ExcludePrivateObjects	Handle if the private SAC entities should be included or excluded	SAC	true, false

Datasphere

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	No manual input. The secret must be set with the first start of the API for Datasphere.	Datasphere

Power BI

Property	Meaning	Connector	Example
ClientId	Client ID of Power BI (more details here)	Power BI	9aef7b94-ab09-493a-9b5f-8a8b6227cfce
AuthorizationUrl	Authorization URL of Power BI (more details here)	Power BI	https://login.microsoftonline.com/<TENANT-ID>/oauth2/v2.0/authorize
Scopes	Default shouldn’t be changed	Power BI	JSON `["https://analysis.windows.net/powerbi/api/.default"]`
EncryptedSecret	No manual input. The secret must be set with the first start of the API for SAC.	Power BI
Criteria	criteria which could be set SQL like to include or exclude specific value. columns: workspaceName capacityName SQL operators like, in, =, != AND, OR, NOT wildcards * %	Power BI	`"workspaceName NOT LIKE '%dev%' AND workspaceName NOT LIKE '%test%' AND capacityName NOT LIKE 'Premium%'"`

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.

JSON

"Upload": {
    "Url": "",
    "Tenant": "",
    "BasicAuthentication": {
      "Username": "",
      "EncryptedPassword": ""
    },
    "OpenIDConnect": {
      "ProviderUrl": "",
      "ClientId": "",
      "UserId": "",
      "EncryptedPassword": "will be with the first Upload"
    },
    "OnDelete": "",
    "Proxy": {
      "ProxyHost": "",
      "ProxyPort": 0,
      "NonProxyHosts": [],
      "ProxyUser": null,
      "ProxyPassword": null
    },
    "SystemSettings": [
      {
        "Scheme": "A4H",
        "DeploymentSystem": "/Systemkatalog/A4H",
        "SystemMappings": [
          {
            "SourceSystemScheme": "S4B",
            "LogicalSystems": [
              "S4BCDS_NEW",
              "S4BCLNT001",
              "S4B_CDS"
            ]
          },
          {
            "SourceSystemScheme": "A4H",
            "LogicalSystems": [
              "BW4CDS",
              "A4H_CDS"
            ]
          }
        ]
      },
      {
        "Scheme": "S4B",
        "DeploymentSystem": "/Systemkatalog/S4B",
        "SystemMappings": null
      },
      {
        "Scheme": "HDB",
        "DeploymentSystem": "/Systemkatalog/HDB",
        "SystemMappings": null
      },
      {
        "Scheme": "BI2",
        "DeploymentSystem": "/Systemkatalog/BW old/BI2",
        "SystemMappings": null
      }
    ]
  }