Erstellen Sie eine Datenstromaktion, um Anwender abzurufen

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 6 Minuten Lesedauer

    • Erstellen Sie eine Datenstromaktion, um eine Liste von Anwenderabonnements von abzurufen SaaSAnwendung.

    Vorbereitungen

    Wenn Sie eine vorhandene verwenden ServiceNow® IntegrationHubSpoke: Finden Sie heraus, ob eine Datenstromaktion vorhanden ist, um eine Liste von Anwendern abzurufen, die Sie verwenden können, anstatt eine zu erstellen. Weitere Informationen zu Datenstromaaktionen finden Sie unter Datenstromaktionen .

    Erforderliche Rolle: Flow_Designer oder admin

    Prozedur

    1. Navigieren zu Alle > Flow Designer > Designeran.
    2. Wählen Sie Neu.
    3. Wählen Sie Aus Datenstrom .
    4. Füllen Sie im Formular die Felder aus.
      Tabelle : 1. Formular „Aktionseigenschaften“
      Feld Wert
      Name Name Ihrer Wahl.

      Beispiel: Anwender Abrufen .
      Zugänglich von Alle Anwendungsbereiche .
      Kategorie Lassen Sie dieses Feld leer.
      Schutz Keine .
      Anwendung Spoke-App, die in integriert werden soll SaaSAnwendung.

      Diese Spoke-App kann bereits vorhanden sein IntegrationHubSpoke oder eine neue Spoke, die Sie erstellt haben.
      In-Flow-Anmerkung Lassen Sie dieses Feld leer.
      Beschreibung Beschreibung Ihrer Auswahl.
    5. Wählen Sie Absenden.
    6. Wenn die API, mit der Sie arbeiten, eine Anwenderauthentifizierung für Anforderungen erfordert, wählen Sie aus Eingaben Fügen Sie in der Aktionsstruktur Eingaben für die Authentifizierung hinzu.
      Beispiele für allgemeine Eingaben zur Anwenderauthentifizierung sind administrator-Anwender-ID Und Sitename . In der Dokumentation der ausgewählten API finden Sie Informationen zu den Anforderungen für die Anwenderauthentifizierung in Ihrem spezifischen Fall.Wenn die API ein Zugriffstoken erfordert, ein Anmeldeinformationswert Variable wird später automatisch erstellt. Sie müssen kein Zugriffstoken als Eingabe hinzufügen.

      Wenn Sie Ihre abgeschlossene Datenstromaktion in einem Subflow verwenden, definieren Sie, welche Werte als diese Eingaben übergeben werden sollen.

    7. Wählen Sie Aus Anforderung In der Aktionsstruktur.
    8. Füllen Sie im Formular die Felder aus.
      Tabelle : 2. Anforderungsformular
      Feld Wert
      So rufen Sie Daten ab Wählen Sie eine der beiden aus REST-Schritt Oder SOAP-Schritt .

      Ihre Auswahl hängt von der API für ab SaaSAnwendung, in die Sie integrieren.
      Paginierung aktivieren Ausgewählt .
      Vor jeder Anforderung ein Skript ausführen Nicht ausgewählt.
    9. Wählen Sie Aus Schritt „Paginierung einrichten“ In der Aktionsstruktur.
    10. Definieren Sie Paginierungsvariablen basierend auf den Abfrageparametern, die von verwendet werden SaaSAPI.

      Wenn Sie eine Offset-basierte Paginierung verwenden, verwenden Sie die Vorlage für Limit/Offset-Paginierung, um die Paginierungskonfiguration vorab zu laden.

      Hinweis:
      Der Wert der reservierten GetNextPage Variable bestimmt, ob eine weitere Seite mit Ergebnissen angefordert werden soll. So lang wie GetNextPage Variable ist Wahr , Die Aktion sendet weiterhin Anforderungen für die nächste Seite.
    11. Schreiben Sie ein Paginierungsvariablen Skript zum Aktualisieren der Paginierungsvariablen.

      Das Skript wird für jede Anforderung ausgeführt. Wenn Sie eine Paginierungsvorlage verwenden, passen Sie das vorinstallierte Skript nach Bedarf an.

      Das folgende Bild zeigt ein Beispiel für den Abschluss des Paginierungssetup-Schritts. Dieses Beispiel stammt aus der Datenstromaktion „Anwender abrufen“, die in verwendet wird WebexSubflow „Abonnements“ herunterladen.

      Schritt „Paginierung einrichten“
      Hinweis:
      Paginierungsvariablen unterstützen nur den Datentyp „Zeichenfolge“. Um mathematische Vorgänge auszuführen, müssen Sie den Wert in eine Ganzzahl konvertieren, alle erforderlichen Vorgänge ausführen und ihn dann wieder in eine Zeichenfolge konvertieren.
    12. Wählen Sie Aus SOAP-Schritt Oder REST-Schritt In der Aktionsstruktur, um Daten zu empfangen.
      • Wenn Sie ausgewählt haben SOAP-Schritt , Geben Sie die Details ein.
        Tabelle : 3. SOAP-Schrittformular
        Feld Wert
        Verbindungsdetails
        Verbindung Verwenden Sie Den Verbindungsalias .
        Verbindungsalias Verbindungsalias, den Sie beim Erstellen des Integrationsprofils erstellt haben. Wenn Sie noch kein Integrationsprofil erstellt haben, führen Sie die Schritte bis aus Erstellen Sie ein anwenderdefiniertes Integrationsprofil mit einem Verbindungsalias.
        Endpunkt Dieser Wert wird automatisch ausgefüllt, wenn Sie den Verbindungsalias auswählen.

        Dieser Wert wird auf die Verbindungs-URL aus dem HTTPS-Verbindungsdatensatz festgelegt, der mit dem Alias verknüpft ist.
        Details anfordern
        Umschlag erstellen Manuell .
        SOAP-Aktion API-Anforderung zum Abrufen einer Liste aller Anwender. Informationen zur Auswahl der entsprechenden Anforderung finden Sie in der Dokumentation der ausgewählten API.
        SOAP-Umschlag XML-Anforderungsnachricht zum Abrufen einer Liste aller Anwender. In der Dokumentation der ausgewählten API erfahren Sie, wie Sie eine XML-Anforderungsnachricht schreiben. Im Allgemeinen sollte der Header Ihre Eingabevariablen für die Anwenderauthentifizierung sowie für enthalten Anmeldeinformationswert Variable als Zugriffstoken. Der Text sollte die Anforderung enthalten, eine Liste aller Anwender und Ihrer Variablen aus dem Schritt „Paginierung einrichten“ abzurufen.
        Hinweis:
        Ein Beispiel für einen SOAP-Umschlag finden Sie in der Datenstromaktion „Anwender abrufen“, die in verwendet wird WebexSubflow „Abonnements“ herunterladen.
      • Wenn Sie ausgewählt haben REST-Schritt , Geben Sie die Details ein.
        Tabelle : 4. REST-Schrittformular
        Feld Wert
        Verbindungsdetails
        Verbindung Verwenden Sie Den Verbindungsalias .
        Verbindungsalias Verbindungsalias, den Sie beim Erstellen des Integrationsprofils erstellt haben. Wenn Sie noch kein Integrationsprofil erstellt haben, führen Sie die Schritte bis aus Erstellen Sie ein anwenderdefiniertes Integrationsprofil mit einem Verbindungsalias.
        Basis-URL Dieser Wert wird automatisch ausgefüllt, wenn Sie den Verbindungsalias auswählen. Sie ist auf die Verbindungs-URL aus dem HTTP(s)-Verbindungsdatensatz festgelegt, der mit dem Alias verknüpft ist.
        Details anfordern
        Build-Anforderung Manuell .
        Ressourcenpfad Pfad zur Ressource. Dieser Wert wird an die Basis-URL angehängt. In der Dokumentation der API, mit der Sie arbeiten, erfahren Sie, wie Sie den Ressourcenpfad erstellen.
        HTTP-Methode ABRUFEN .
        Abfrageparameter Fügen Sie Parameter für die Paginierung hinzu. Legen Sie die Werte als die Variablen fest, die Sie im Schritt „Paginierung einrichten“ erstellt haben.

        Das folgende Bild zeigt ein abgeschlossenes Beispiel für den REST-Schritt. Dieses Beispiel stammt aus dem Abrufen JiraDatenstromaktion für Anwender, die in verwendet wird JiraSubflow „Abonnements“ herunterladen.

        REST-Schritt
    13. Wählen Sie Aus Wird Analysiert In der Aktionsstruktur.
    14. Füllen Sie im Formular die Felder aus.
      Tabelle : 5. Formular wird analysiert
      Feld Wert
      So werden die einzelnen Datensätze identifiziert JSON/XML-Splitter
      So werden die einzelnen Elemente in einem Objekt analysiert Skriptparser
    15. Wählen Sie Aus Splitter-Schritt In der Aktionsstruktur.
    16. Füllen Sie im Formular die Felder aus.
      Tabelle : 6. Schritt „Splitter“
      Feld Wert
      Quellformat Wählen Sie Aus XML Oder JSON , Abhängig vom Format, das von der API-Antwort zurückgegeben wird.
      Elementpfad Absoluter Pfad zu einem Anwenderelement in der Antwortnachricht. Informationen zum Format der Antwortnachricht finden Sie in der Dokumentation der API, mit der Sie arbeiten.
      • Beispiel-XML-Elementpfad: /Message/body/user
      • Beispiel-JSON-Elementpfad: .data.user USD
    17. Wählen Sie Aus Ausgaben In der Aktionsstruktur.
    18. Wählen Sie Aus Ausgabe Erstellen Und bearbeiten Sie die Variable wie gezeigt.
      Tabelle : 7. Aktionsausgabe
      Bezeichnung Name Typ Erforderlich
      targetObject targetObject Objekt Nein
    19. Fügen Sie untergeordnete Elemente für hinzu TargetObject Basierend auf den untergeordneten Anwenderelementen, die in der Antwortnachricht zurückgegeben werden.
      Beispielsweise könnte eine XML-Antwort so aussehen.
      <message>​
  <body>​
    <user>
      <userID>​12345</userID>​
      ​<email>​email@email.com</email>​
      <firstName>​Jane</firstName>​
      <lastName>​Doe</lastName>​
      <lastLoginTime>​08/13/2019 20:08:16</lastLoginTime>​
      <active>​TRUE</active>​
    </user>​
    <user>
      ...
    </user>
  </body>​
</message>
      Fügen Sie für diese Antwort die untergeordneten Elemente wie gezeigt hinzu.
      Tabelle : 8. Untergeordnete Elemente für targetObject
      Bezeichnung Name Typ Erforderlich
      userID userID Zeichenfolge Nein
      E-Mail E-Mail Zeichenfolge Nein
      firstName firstName Zeichenfolge Nein
      lastName lastName Zeichenfolge Nein
      LastLoginTime LastLoginTime Zeichenfolge Nein
      aktiv aktiv Wahr/falsch Nein
    20. Wählen Sie Aus Skriptparser-Schritt In der Aktionsstruktur.
    21. Erstellen Sie ein TargetObject Ausgabeobjekt für jedes Anwenderelement in der Antwort, und ordnen Sie dann jedes untergeordnete Anwenderelement einem zu TargetObject Untergeordnetes Element.

      Das Parser-Skript wird für jedes Anwenderelement ausgeführt.

      Hinweis:
      Diese Beispiele zeigen die Typen von Elementen, die im Allgemeinen in einer Antwort auf eine Anforderung zum Abrufen von Anwendern enthalten sind. Kopieren Sie diese Skripts nicht direkt. Verwenden Sie Elementnamen aus der Dokumentation für die API, mit der Sie arbeiten.
      Beispielskript, das eine XML-Antwort analysiert. 
      (function parse(inputs, outputs) {
    var xmlDoc = new XMLDocument(inputs.sourceItem, false);
    outputs.targetObject.userID = xmlDoc.getNodeText('/user/userID');
    outputs.targetObject.email = xmlDoc.getNodeText('/user/email');
    outputs.targetObject.firstName = xmlDoc.getNodeText('/user/firstName');
    outputs.targetObject.lastName = xmlDoc.getNodeText('/user/lastName');
    outputs.targetObject.lastLoginTime = xmlDoc.getNodeText('/user/lastLoginTime');
    outputs.targetObject.active = xmlDoc.getNodeText('/user/active');
})(inputs, outputs)
      Beispielskript, das eine JSON-Antwort analysiert. 
      (function parse(inputs, outputs) {
    var record = JSON.parse(inputs.sourceItem);
    outputs.targetObject.userID = record.userID;
    outputs.targetObject.email = record.email;
    outputs.targetObject.firstName = record.firstName;
    outputs.targetObject.lastName = record.lastName;
    outputs.targetObject.lastLoginTime = record.lastLoginTime;
    outputs.targetObject.active = record.active;
})(inputs, outputs)
    22. Wählen Sie aus, um Ihre Datenstromaktion zu testen Testen .
      1. Zeigen Sie die Testergebnisse und Systemprotokolle an, um Details zu Fehlern zu erhalten.
        Navigieren Sie zu , um Systemprotokolle anzuzeigen Systemprotokolle > Systemprotokoll > Allean.
      2. Wenn Ihre Datenstromaktion Fehler aufweist, stellen Sie sicher, dass Sie die richtigen Endpunkte verwenden und dass die API-Anforderungen und -Antworten wie erwartet strukturiert sind.
    23. Wählen Sie aus, nachdem Sie überprüft haben, ob die Datenstromaktion wie erwartet funktioniert Veröffentlichen .

    Nächste Maßnahme

    Erstellen Sie einen Subflow, um Anwender abzurufen.