SAP-Daten-API mit Evolve - Automate_Studio_Manager - Latest

Handbuch zu Automate Studio Manager

Product type
Software
Portfolio
Integrate
Product family
Product
Automate > Automate Studio Manager
Version
Latest
Language
Deutsch
Product name
Automate Studio Manager
Title
Handbuch zu Automate Studio Manager
ft:lastEdition
2024-05-23
ft:lastPublication
2024-05-23T17:29:35.044212

Die SAP-Daten-API dient zum Hoch- und Herunterladen von Daten aus SAP. Die API ist sowohl für Evolve als auch für Studio Manager verfügbar. Diese Lösung wird durch den Skriptworkflow und die Einstellungen des Skriptworkflows gesteuert. Die API macht die JSON-Nutzlast und andere Details (wie SAP, Ausführungseinstellungen usw.) für das Buchen von Daten in SAP verfügbar.

Führen Sie die folgenden Schritte aus, um von Evolve aus auf die SAP-Daten-API zuzugreifen:

  1. Aktivieren Sie eine gültige Lizenz für die SAP-Daten-API.
  2. Erstellen Sie die Bibliothek für den SAP-API-Speicher.
  3. Erstellen Sie ein Skript in Studio, das zum Hinzufügen der SAP-API von Evolve aus verwendet werden soll. Siehe „Erstellen eines Skripts zur Integration in die SAP-Daten-API“ unter SAP-Daten-API mit Studio.
  4. Fügen Sie die SAP-API über die Registerkarte „Lösungen“ hinzu.

Bibliothek für den SAP-API-Speicher

Damit der Benutzer Lösungen von SAP-Daten-APIs auf Evolve speichern kann, muss er von Evolve aus eine neue Bibliothek erstellen. Nachfolgend sind die Schritte zum Erstellen einer neuen Bibliothek aufgeführt:

  1. Navigieren Sie in der Anwendung, in der die Bibliothek erstellt werden muss, zu „Evolve“ → „Konfiguration“ → „Bibliotheken verwalten“.

  2. Klicken Sie auf „Hinzufügen“.

  3. Der Typ SAPAPIStore sollte ausgewählt werden.

  4. Geben Sie Name und Beschreibung für die Bibliothek an. Beides sind Pflichtfelder.

  5. Aktivieren Sie Dokumentenhistorie aktivieren, wenn Sie bei der Ausführung Dokumente für die SAP-API-Lösung generieren möchten. Der Standardwert ist „False“.

  6. Klicken Sie auf Speichern.

  7. Navigieren Sie zur Seite „Lösungen“. Die neue Bibliothek müsste jetzt zusammen mit allen anderen Bibliotheken sichtbar sein.

Wenn der Schlüssel SapIntegrationAPIEnable aktiviert ist, wird der Bibliothekstyp SAPAPIStore auch für alle Evolve Anwendungen aktiviert. Diese Bibliothek wäre für Referenzdaten-Anwendungen nicht verfügbar. Der Bibliothekstyp „SAPAPIStore“ wird unter Bibliothek hinzufügen aktiviert. Nur die App Administratoren und globalen Administratoren dürfen diese Bibliothek hinzufügen.

Wenn Sie Berechtigungen für die Bibliothek vom Typ „SAPAPIStore“ verwalten möchten, navigieren Sie zu „Konfiguration“ → „Bibliotheken über Evolve verwalten“. Anschließend können Sie SAP-Daten-APIs auswählen, indem Sie auf das Kontrollkästchen im Tabellenraster klicken. Klicken Sie auf „Bibliotheksberechtigungen verwalten“. Genau wie die Formularbibliothek verfügt die Bibliothek SAPAPIStore über zwei Optionen für die Berechtigungsverwaltung (Prozessberechtigung und Bibliothek-Lösungsberechtigung), mit denen Berechtigungen für die Bibliothek „SAPAPIStore“ verwaltet werden können. Bei der Prozessberechtigung ist die Standardberechtigung auf Urheber festgelegt. Der Benutzer kann die Standardberechtigung löschen und eine beliebige Gruppe von Urheber-Berechtigungen hinzufügen. Die Bibliotheks-Lösungsberechtigung ist standardmäßig auf Lösungsentwickler und Lösungsprüfer festgelegt. Der Benutzer kann Standardberechtigungen löschen und eine beliebige Gruppe von Berechtigungen für Lösungsentwickler und Lösungsprüfer hinzufügen.

Einstellungen für die SAP-API-Genehmigung können auf der Seite „Anwendung“ → „Präferenz“ → „Designpräferenz“ über die folgenden drei Optionen hinzugefügt werden. Der Standardwert ist bei allen drei Optionen „False“.

  1. Lösungsgenehmigung: Wenn auf „True“ gesetzt, wird die an Evolve übermittelte Lösung überprüft, bis der Prüfer sie von den Aufgaben genehmigt.

  2. Selbstgenehmigung: Wenn auf „True“ gesetzt, kann der Benutzer, der die Lösung übermittelt, die Lösung selbst genehmigen. Der Name des Benutzers wird dann während der Übermittlung oder Aktualisierung der SAP-Daten-API unter der Prüferliste angezeigt.

  3. Grund für die Ablehnung der Lösung: Wenn auf „True“ gesetzt, muss der Benutzer einen Grund für die Ablehnung der Lösung definieren.

SAP-API über die Registerkarte „Lösungen“ hinzufügen

Sobald die Bibliothek SAPAPIStore aus den Lösungen ausgewählt wurde, wird die Option API hinzufügen verfügbar. Diese Option ist nicht sichtbar, wenn der angemeldete Benutzer über die Rolle Lösungsentwickler verfügt. Der autorisierte Benutzer kann auf API hinzufügen klicken, um mithilfe von Skripten ein Web-API-Schema zu generieren und Daten aus SAP in das JSON-Schema hochzuladen/herunterzuladen.

Durch Klicken auf API hinzufügen wird ein Assistent angezeigt, der folgende drei Schritte umfasst: API-Informationen, Dateien auswählen und Prüfer auswählen.

API-Informationen umfasst folgende Felder:

  1. Name: Der Service-/Lösungsname, er sollte auf Bibliotheksebene eindeutig sein.

  2. Kategorie: Hilft beim Kategorisieren von Lösungen in verschiedene Kategorien, die später mithilfe von Filtern auf der Lösungsseite herausgefiltert werden können. Die Kategorie ist kein Pflichtfeld.

  3. Beschreibung: Kann vom Benutzer verwendet werden, um zu erklären, worum es bei der Lösung geht. Die Beschreibung ist kein Pflichtfeld.

API-Erstellung umfasst zwei Optionen: Aus Transaktion erstellen und Aus Query erstellen; Die Standardoption ist „Aus Transaktion erstellen“. „API-Erstellung“ umfasst folgende Felder:

  1. Datei auswählen: Nur das Skript mit JSON-Zuordnung wird zum Generieren von API-Schemata unterstützt. Wenn das Skript vom Typ „Query“ ist, werden die Systemauslastungsstufen (niedrig, mittel und hoch) angezeigt.

  2. Viewer: Es gibt zwei JSON-Viewer: Textbereich und JSON-Viewer; die Standardauswahl ist „JSON-Viewer“. Beide Viewer haben eine feste Breite und Höhe und ermöglichen eine Bildlaufleiste entsprechend dem JSON-Text.

Sie müssen ein Skript in Studio erstellen, das in Evolve verwendet werden soll. Siehe „Erstellen eines Skripts zur Integration in die SAP-Daten-API“ unter SAP-Daten-API mit Studio.

Nach der Durchsuchung einer gültigen Skriptdatei über Datei auswählen generiert der Service-Methodenaufruf API-Spezifikationen und zeigt diese im JSON-Viewer an. JSON hat drei Registerkarten: InputPayload, OutputPayload und ErrorPayload. Die API-Spezifikationen für „InputPayload“ und „OutputPayload“ entsprechen der Skriptdatei, und „ErrorPayload“ ist ein festes Array. Der Datentyp, der dem Skriptdatentyp und den API-Spezifikationen entspricht, ist in den generierten Nutzlasten verfügbar.

„InputPayload“ und „OutputPayload“ verfügen über folgende Abschnitte:

  1. RunParameter: Enthält alle Eingabefelder für die Transaktion. Das Query-Skript zeigt alle benutzerdefinierten Kriterienfelder an und ignoriert fest definierte Kriterienfelder.

  2. SolutionDetail: Enthält die Felder „SolutionName“, „LibraryName“ und „AppName“.

  3. RequestParameter: Enthält alle Laufzeiteingaben, d. h. Anzahl der Datensätze, „GetRecordCount“ usw.

  4. SAPDetails: Enthält die Pflichtfelder „ConnectionName“ und „EvolveUser“. Die anderen Felder wie „SAPUser“, „SAPCredentials“ und „Windows-Anmeldedaten“ sind optional.

Anmerkung: Speichern Sie SAP-Anmeldedaten oder Windows-Anmeldedaten auf Evolve für Evolve Benutzer, damit das Klartextkennwort beim Netzwerkaufruf nicht traversiert wird, während die API über einen Drittanbieter-Client ausgeführt wird.

Prüfer auswählen ist sichtbar, wenn die Kennzeichnung Lösungsgenehmigung unter Einstellungen für die SAP-API-Genehmigung auf „True“ gesetzt ist. Die Option verfügt über das Dropdown-Menü Prüfer, das alle Benutzer anzeigt, die in der aktuellen App die Rolle eines Lösungsprüfers innehaben. Wenn die Einstellung Selbstgenehmigung auf „False“ gesetzt ist, wird der aktuell angemeldete Benutzer nicht im Dropdown-Menü angezeigt, selbst wenn der aktuelle Benutzer in der App die Rolle des Lösungsprüfers innehat. Ohne Auswahl eines Prüfers kann die Lösung nicht übermittelt werden.

Nach der Übermittlung der Lösung wird diese auf der Lösungsseite in den Spalten „Lösung“, „Beschreibung“, „Status“, „Kategorie“, „Geprüft von“ und „Erstellt von“ angezeigt.

Die URL für SAP-Daten-APIs lautet <RoutePrefix>/api/v1/SAPIS

Anmerkung: Einzelheiten zum API-Schema sind unter SAP-Daten-API-Spezifikation dokumentiert.

Wenn die Kennzeichnung Lösungsgenehmigung unter „Einstellungen für die SAP-API-Genehmigung“ auf „True“ gesetzt ist, muss die Lösung über den Prüfer übermittelt werden. Nach der Übermittlung der Lösung wird die Aufgabe dem Prüfer zur Prüfung zugewiesen. Wenn die Einstellung Grund für die Ablehnung der Lösung aktiviert ist, muss der Lösungsprüfer Kommentare für die Ablehnung angeben. Wenn der Lösungsworkflow angewendet wird, funktioniert API aktualisieren nur dann, wenn sich die Lösung im Status Produktion befindet.

SAP-API über die Registerkarte „Lösungen“ aktualisieren

Der Benutzer kann die Option API aktualisieren für die Lösung verwenden, die sich im Status Produktion befindet. Wenn die Lösungsgenehmigung in den Einstellungen für die SAP-API-Genehmigung (Seite „Anwendung“ → „Präferenzen“ → „Designpräferenzen“) aktiviert ist, wird die Lösung überprüft, bis sie vom zugewiesenen Prüfer genehmigt wird. Lösungen, die noch geprüft werden, können nicht aktualisiert werden. Nachdem die Lösung genehmigt und in die Produktion verschoben wurde, kann der Benutzer die SAP-Daten-API-Lösung aktualisieren. Wenn die Lösungsprüfung deaktiviert ist, befindet sich die Lösung immer in Produktion, und der Benutzer kann die SAP-API-Lösung bearbeiten. Nachfolgend finden Sie die Informationen zur Option „API aktualisieren“:

  1. Navigieren Sie zu „Lösungen“, und wählen Sie „SAP-Daten-API-Bibliothek“ aus.

  2. Wählen Sie die SAP-API-Lösung (in Produktion) aus, die Sie aktualisieren möchten, indem Sie auf das im Lösungsraster vorhandene Kontrollkästchen klicken.

  3. Klicken Sie auf API aktualisieren.

  4. Der Dienst-/Lösungsname ist schreibgeschützt. Kategorie und Beschreibung können bearbeitet werden.

  5. Der Skripttyp wird entsprechend dem vorhandenen Skripttyp ausgewählt, und andere Optionen werden deaktiviert. Mit der Option Datei auswählen kann derselbe Skripttyp hinzugefügt werden.

  6. Die Dienst-URL und JSON-Ansichten (Textbereich und JSON-Viewer) sind schreibgeschützt.

  7. Diese Schritte sind sichtbar, wenn die Kennzeichnung Lösungsgenehmigung unter Einstellungen für die SAP-API-Genehmigung auf „True“ gesetzt ist. Das Dropdown-Menü Prüfer zeigt alle Benutzer an, die in der aktuellen App die Rolle des Lösungsprüfers innehaben. Wenn der aktuelle Lösungsprüfer in der Prüferliste verfügbar ist, wird derselbe Prüfer ausgewählt.

  8. Wenn die Einstellung Selbstgenehmigung auf „False“ gesetzt ist, sollte der aktuell angemeldete Benutzer nicht im Dropdown-Menü angezeigt werden, selbst wenn der aktuelle Benutzer in der App die Rolle des Lösungsprüfers innehat. Ohne Auswahl eines Prüfers kann die Lösung nicht übermittelt werden.

  9. Durch diese Aktion wird eine neue Version der Lösung erstellt.

SAP-API anzeigen

Klicken Sie zum Anzeigen der SAP-API auf die Option API anzeigen, nachdem Sie eine bestimmte Lösung aus der SAP-API-Bibliothek ausgewählt haben. Vollständige Daten werden auf einer einzelnen Seite angezeigt, wie in der Referenzschemaansicht. JSON kann in beiden JSON-Viewern angezeigt werden, d. h. im Textbereich und im JSON-Viewer.

Die Dienst-URL wird als <BaseURL/GatewayURL>/api/v1/SAPIS sichtbar.

SAP-Daten-API ausführen

Zur Ausführung der Integrations-API füllt der Benutzer die Authentifizierungskopfzeile und die Nutzlast aus und sendet diese zur Ausführung an einen gültigen exponierten Endpunkt. Führen Sie die folgenden Schritte aus, um die SAP-Daten-API auszuführen:

  1. Füllen Sie vor der Ausführung alle erforderlichen Eingabefelder der Nutzlast aus, wie z. B. „Authentifizierungskopfzeile“, „SolutionName“, „LibraryName“, „AppName“, „ConnectionName“, „EvolveUser“ usw.

  2. Evolve-Benutzer müssen für die API-Ausführung die Rolle Urheber innehaben.

  3. Für Transaktion – Die SAP-Daten-API-Lösung im Status „Produktion“ darf auf dem Produktionsserver ausgeführt werden. Es gilt die neueste Version der Lösung. Die SAP-Daten-API-Lösung im Status „Prüfung“ oder „Abgelehnt“ darf auf einem SAP-Nichtproduktionssystem ausgeführt werden; „Validieren“ würde sowohl auf dem SAP-Produktions- als auch auf dem -Nichtproduktionssystem ausgeführt.

    Für Query – Die SAP-API-Lösung im Status „Produktion“ darf auf Produktions- und Nichtproduktionsservern ausgeführt werden. Es gilt die neueste Version der Lösung. Die SAP-API-Lösung im Status „Prüfung“ oder „Abgelehnt“ darf auf einem SAP-Nichtproduktionssystem ausgeführt werden.

  4. Der EvolveUser wird verwendet, um Rolle und Richtlinien zu überprüfen und Anmeldedaten mit dem angegebenen ConnectionName zu vergleichen, wenn SAP-Anmeldedaten und Windows-Anmeldedaten nicht weitergegeben werden.

    Für die Ausführung der SAP-API-Lösung gelten folgende Einstellungskriterien:

    1. SAP-Anmeldedaten.

    2. Windows-Anmeldedaten.

    3. Evolve Benutzer

    Die Standardeinstellung ist die Verwendung von EvolveUser, um die Verwendung von Klartextkennwörtern über das Netzwerk zu vermeiden.

  5. Nach der Ausführung wird das Ausführungsergebnis (Protokoll und Ausgabefelder) im JSON-Dokument überschrieben.

  6. Wenn die Dokumentenhistorie in der Bibliothek aktiviert ist, werden Dokumente eindeutig als ServiceName_TimeStamp(in Zahlen) identifiziert. Das Dokument ist eine Textdatei, die „InputPayload“ und „OutputPayload“ im JSON-Format enthält. Wenn der Benutzer ein Kennwort angibt, wird das Kennwort nicht im Dokument gespeichert. Das Dokument hat keinen Workflow, daher lautet der Status immer „Abgeschlossen“.

Wenn Sie die API-Nutzung anzeigen möchten, wählen Sie aus der Lösungsbibliothek eine beliebige Lösung aus, und klicken Sie auf „API-Nutzung“. Die Ansicht „API-Nutzung“ enthält die Spalten „Titel“, „Datendatei“, „Datum und Uhrzeit der Aktivität“, „SAP-System“, „Hochgeladene Datensätze“ und „Ausführungsfehler“. Darin werden detaillierte Informationen zur API-Ausführung angezeigt.

Navigieren Sie für den Import/Export der Integrations-API-Lösung zur Lösung (d. h. Test), und laden Sie das Skript herunter. Jetzt können Sie mithilfe des heruntergeladenen Skripts eine neue Lösung hinzufügen.