Versions Compared

Old Version 5

changes.mady.by.user SGO

Saved on

compared with

New Version Current

changes.mady.by.user SGO

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



German

...

width70%

...

width40%

...

width60%

Das

...

Open Data Protocol

...

(OData) ist ein unter dem

...

Open Specification Promise

...

von

...

Microsoft

...

veröffentlichtes

...

HTTP-basiertes Protokoll für den Datenzugriff zwischen kompatiblen Softwaresystemen,

Einrichtung in SmartNotes

Sie können den Import von einem beliebigen OData-Dienst in der SmartNotes Import Administration festlegen, indem Sie einen Konnektor definieren und die Schnittstelle „Odata Service Import" auswählen. Anschließend müssen die entsprechende(n) Datenquelle(n) und ein Mapping definiert werden. Sollte die Schnittstelle nicht verfügbar sein, wenden Sie sich bitte an die technische SmartNotes-Hotline, um die entsprechende Bibliothek zu erhalten.

...

width30%

...

bgColor#ECECEC

<< Das SmartNotes Handbuch

...

German

🌐 Das SmartNotes Handbuch

English

The Open Data Protocol (OData) is an HTTP-based protocol published under Microsoft's Open Specification Promise for data access between compatible software systems.

Setup in SmartNotes

You can define the import from any OData service in the SmartNotes Import Administration by defining a connector and selecting the interface "Odata Service Import". Then the corresponding data source(s) and a mapping must be defined. If the interface is not available, please contact the SmartNotes technical hotline to obtain the appropriate library.

English

🌐 SmartNotes User Manual

German

Panel


Panel
titleDefinition des Connectors


Section


Column
width40%



Column
width60%

In der Registerkarte „Connector Administration" müssen Sie für den OData-Dienst „Import connection Paramters" angeben.

Host Ihres Odata-Dienstes z.B.: https://xxxx-api.s4hana.ondemand.com  der Dienst Root z.B.: sap/opu/odata/SAP/API_GRTRANSACTIONDATA_SRV,



Panel
titleAuthorization Type


Panel
titleBasic


Section


Column
width40%

Image Modified


Column
width60%

Diese Methode erstellt zunächst eine Zeichenkette, indem sie den Benutzer, einen Doppelpunkt und das Passwort aneinanderreiht. Schließlich wird die BASE64-Zeichenkette in den Autorisierungs-Header der an den ODATA-Dienst gesendeten Anfrage eingebettet.




Panel
titleauth2


Section


Column
width40%



Column
width60%

SmartNotes sendet hier zunächst eine Token-Anfrage an den Token-Endpunkt des Autorisierungsdienstes, um ein Zugriffstoken zu erhalten. Mit diesem Token holt es sich schließlich die Autorisierung für den Zugriff auf den Odata-Dienst.

Sie müssen hier den zusätzlichen Parameter AuthorizationServerRequest setzen, z.B. https://oauthasservices-xxxxx.hana.ondemand.com/oauth2/api/v1/token?grant_type=client_credentialsandthe logon parameters.



Panel
titleClientAuthentificationMethod


Panel
titleClient Secret Basic as Method


Section


Column
width40%

Image Modified


Column
width60%

Diese Methode erstellt zunächst eine Zeichenkette, indem sie eine Kunden-ID, einen Doppelpunkt und ein Kundengeheimnis aneinanderreiht. Schließlich bettet sie den BASE64-String in den Authorization-Header einer Token-Anforderung ein, die an den Authorization Service gesendet wird. Hier müssen Sie den zusätzlichen Parameter ClientAuthentificationMethod auf ClientSecretBasic und die Logon-Parameter setzen.




Panel
titleClient Secret Post as Method


Section


Column
width40%

Image Modified


Column
width60%

Diese Methode, die eine Client-ID und ein Client-Geheimnis in eine Token-Anfrage einschließt, verwendet die Anfrageparameter client_id und client_secret in der Anfrage des Autorisierungsdienstes. Sie müssen hier den zusätzlichen Parameter ClientAuthentificationMethod auf ClientSecretPost und die Logon-Parameter setzen.







Panel
titleLogon Parameter


Section


Column
width40%

Image Modified


Column
width60%

Wenn das Kontrollkästchen „Technischer Benutzer" im Anmeldedialog aktiviert ist, werden der Benutzer und das Passwort verschlüsselt in der Datenbank gespeichert.




Panel
titleAdditional HeaderX (optional)


Section


Column
width40%

Image Modified


Column
width60%

Dieser bietet die Möglichkeit, zusätzliche Header in der Konnektordefinition zu speichern, wie z.B. accept-language:de (das „:" trennt den Schlüssel und den Wert des Headers)


Nachdem Sie den neuen Konnektor definiert haben, müssen Sie zur Registerkarte Datenquellenverwaltung wechseln und mindestens eine Datenquelle definieren.






Panel
titleDataSource-Definition


Section


Column
width40%

Image Modified


Column
width60%

Eine Datenquelle stellt die parametrisierte Anfrage an den OData-Dienst dar.




Section


Column
width40%

Image Modified


Column
width60%

In der Datenquellendefinition müssen Sie mindestens den Ressourcenpfad angeben wie GRTransactionData(P_ConsolidationUnitHierId='$',P_ConsolidationPrftCtrHierId='$',P_ConsolidationSegmentHierId='$',P_KeyDate=datetime'2019-12-31T00:00:00')/Results or GRTransactionData(@Parameter_1,@Parameter_2,@Parameter_3,@Parameter_4)/Results using @Parameter_1, @Parameter_2… als Platzhalter.

Mit dem Select-Parameter können Sie die auszuwählenden Felder / Dimensionen angeben, z.B. ConsolidationVersion,FiscalYearPeriod,ConsolidationLedger,FinancialStatementItem

Mit dem Parameter Filter können Sie Filtereinschränkungen definieren, die mit Hilfe von Operatoren angewendet werden:

eq" ↔=

gt ↔ >

lt  ↔ <

und verknüpfen sie mit den logischen Operatoren AND und OR, z. B. ConsolidationGroup eq 'CG3' and ConsolidationVersion eq 'Z10'  and FiscalYearPeriod eq '0122019' and ConsolidationUnit eq 'S3002'

Mit dem Expand-Parameter können Sie die Navigationseigenschaften angeben, die bei Bedarf erweitert werden sollen.




Section


Column
width40%

Image Modified


Column
width60%

Anschließend können Sie eine Vorschau auslösen, um zu prüfen, ob alle Verbindungs- und Datenquellenparameter korrekt eingerichtet sind.




Panel
titleMapping des Anfrageergebnisses


Section


Column
width40%

Image Modified


Column
width60%

In der Mapping-Administration müssen Sie festlegen, welche und wie die Daten gemappt und importiert werden sollen. Bitte lesen Sie dazu unser Kapitel Mapping-Administration in dem Sie auch Informationen zu den Verarbeitungsfunktionen finden.

Nachdem Sie alles korrekt eingerichtet haben und eine gültige, nicht leere Positionsvorschau erhalten haben, ist die Importdefinition vollständig eingerichtet.

...

Column
width33%

<< Zurück zu - MSSQL Stored Procedure --

Column
width34%

Zurück zur Übersicht - SmartNotes Benutzerhandbuch

...

width33%

...






English

...

width70%

...

width40%

...

width60%

The Open Data Protocol (OData) is an HTTP-based protocol published under Microsoft's Open Specification Promise for data access between compatible software systems.

Setup in SmartNotes

You can define the import from any OData service in the SmartNotes Import Administration by defining a connector and selecting the interface "Odata Service Import". Then the corresponding data source(s) and a mapping must be defined. If the interface is not available, please contact the SmartNotes technical hotline to obtain the appropriate library.

...

width30%

...

bgColor#ECECEC

<< SmartNotes User Manual

...

...

Column
width33%

<< Back to - MSSQL Stored Procedure --

Column
width34%

Back to overview - SmartNotes User Manual

...

width33%

...

Panel


Panel
titleConnector Definition


Section


Column
width40%



Column
width60%

In the Connector Administration Tab You have to specify for the OData service Import connection Paramters

e.g. https://xxxx-api.s4hana.ondemand.com

the Service Rooot

e.g. sap/opu/odata/SAP/API_GRTRANSACTIONDATA_SRV,



Panel
titleAuthorization Type


Panel
titleBasic


Section


Column
width40%

Image Modified


Column
width60%

This method, first, builds a string by concatenating the user, a colon and the password. Finally, embeds the BASE64 string in the Authorization header in the request send to the ODATA Service.




Panel
titleauth2


Section


Column
width40%



Column
width60%

SmartNotes first sends here a token request to the token endpoint of the Authorization Service to get an access token. Finally, it uses this token to get the Authorization to access the Odata Service.

You have here to set the additional Parameter AuthorizationServerRequest e.g. https://oauthasservices-xxxxx.hana.ondemand.com/oauth2/api/v1/token?grant_type=client_credentialsandthe logon parameters.



Panel
titleClientAuthentificationMethod


Panel
titleClient Secret Basic as Method


Section


Column
width40%

Image Modified


Column
width60%

This method, first, builds a string by concatenating a client ID, a colon and a client secret. Finally, embeds the BASE64 string in the Authorization header in a token request send to the Authorization Service. You have here to set the additional Parameter ClientAuthentificationMethod to ClientSecretBasic and the logon parameters.




Panel
titleClient Secret Post as Method


Section


Column
width40%

Image Modified


Column
width60%

This Method include a client ID and a client secret in a token request is to use the client_id and client_secret request parameters in Authorization Service Request. You have here to set the additional Parameter ClientAuthentificationMethod to ClientSecretPost and the logon parameters.







Panel
titleLogon Parameter


Section


Column
width40%

Image Modified


Column
width60%

If the checkbox “Technical User” is checked in the logon dialog, the user and the password will be stored encrypted in the database.




Panel
titleAdditional HeaderX (optional)


Section


Column
width40%

Image Modified


Column
width60%

It offers the possibility to store additional headers in the connector definition such as accept-language:de (the “:” separates the key and value of the header)

After defining the new connector You have to move to the datasource administration tab and to define at least one data source.






Panel
titleDataSource Definition


Section


Column
width40%

Image Modified


Column
width60%

A data source represents the parameterised request to the Odata Service.




Section


Column
width40%

Image Modified


Column
width60%

In the Datasource definition You have at least to specify the Resource Path like GRTransactionData(P_ConsolidationUnitHierId='$',P_ConsolidationPrftCtrHierId='$',P_ConsolidationSegmentHierId='$',P_KeyDate=datetime'2019-12-31T00:00:00')/Results or GRTransactionData(@Parameter_1,@Parameter_2,@Parameter_3,@Parameter_4)/Results using @Parameter_1, @Parameter_2… as placeholders (please see Figure 4).

By the Select Parameter You can specify the fields / dimensions to be selected e.g. ConsolidationVersion,FiscalYearPeriod,ConsolidationLedger,FinancialStatementItem

By the Filter parameter You can define filter restrictions to be applied using the operators:

eq ↔ =

gt ↔ >

lt ↔ <


and joining them using the logical operators AND and OR e.g. ConsolidationGroup eq 'CG3' and ConsolidationVersion eq 'Z10'  and FiscalYearPeriod eq '0122019' and ConsolidationUnit eq 'S3002'

By the Expand Parameter You can specify the navigation properties to be extanded if necessary.



Section


Column
width40%

Image Modified


Column
width60%

Afterwards you can trigger a preview to check if all connection and datasource parameter are set up correctly.




Panel
titleMapping of the request result


Section


Column
width40%

Image Modified


Column
width60%

In the mapping administration you have to define which and how the data should be mapped and imported. Please read our chapter Mapping Administration where you will also find information on the processing functions.

After you have set up everything correctly and received a valid, non-empty position preview, the import definition is completely set up.

...




German

🌐 Das SmartNotes Handbuch

English

🌐 SmartNotes User Manual