Erstellen Sie eine Datenstromaktion, um die Anwenderaktivität abzurufen

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

    • Erstellen Sie eine Datenstromaktion, um Anwenderaktivitäten aus einer SaaS-Anwendung abzurufen.

    Vorbereitungen

    Wenn Sie eine vorhandene verwenden ServiceNow® IntegrationHubSpoke: Finden Sie heraus, ob eine Datenstromaktion vorhanden ist, um Anwenderaktivitäten abzurufen, die Sie verwenden können, anstatt eine zu erstellen.

    Weitere Informationen zu Datenstromaaktionen finden Sie unter Datenstromaktionen .

    Erforderliche Rolle: Flow_Designer oder admin

    Warum und wann dieser Vorgang ausgeführt wird

    Überwachen Sie die Anwenderaktivität, um Softwareabonnements zu finden, die Ihr Unternehmen bezahlt, aber nicht verwendet wird. Sie können diese nicht verwendeten Abonnements zurückfordern, um die Softwareausgaben Ihres Unternehmens zu reduzieren.

    Entscheiden Sie vor dem Erstellen der Datenstromaktion, wie Sie eine aussagekräftige Anwenderaktivität definieren möchten. Eine aussagekräftige Aktivität kann eine Kombination von Anwenderaktionen sein. Erstellen Sie eine separate Datenstromaktion für jede Anwenderaktivitätsmetrik. Beispiel: Das Basissystem WebexDie Integration von Besprechungen definiert sinnvolle Aktivitäten als Hosting einer Besprechung. Es verwendet eine Datenstromaktion, um die Daten der zuletzt gehosteten Besprechungen für alle Anwender abzurufen. Wenn Sie auch gewünscht haben WebexIntegration von Meetings um die Anmeldung als aussagekräftige Aktivität einzubeziehen, erstellen Sie eine zweite Datenstromaktion, um die neuesten Anmeldezeiten für alle Anwender abzurufen.

    Ihre Datenstromaktion zum Abrufen von Anwendern kann eine Anwenderaktivitätsmetrik zurückgeben, z. B. Zeitpunkt der letzten Anmeldung. In diesem Fall müssen Sie keine Datenstromaktion erstellen, um Anwenderaktivität abzurufen, oder einen Subflow zum Abrufen der Anwenderaktivität, es sei denn, Sie möchten zusätzliche Anwenderaktivitätsmetriken definieren. Stellen Sie sicher, dass Ihr Subflow zum Abrufen von Anwendern diese Anwenderaktivitätsmetrik auf festgelegt hat Letzte Aktivität Geben Sie in ein Aktualisieren Sie Das Anwenderabonnement Aktion.

    Prozedur

    1. Navigieren zu Alle > Flow Designer > Designeran.
    2. Klicken Sie Auf Neu Und wählen Sie dann aus Datenstrom .
    3. Füllen Sie im Formular die Felder aus.
      Tabelle : 1. Formular „Aktionseigenschaften“
      Feld Wert
      Name Name Ihrer Wahl. Beispiel: Anwenderaktivität Abrufen .
      Zugänglich von Wählen Sie Aus Alle Anwendungsbereiche .
      Kategorie Lassen Sie dieses Feld leer.
      Schutz Wählen Sie Aus 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.
    4. Klicken Sie auf Absenden.
    5. Klicken Sie im Abschnitt „Eingaben“ der Aktionsstruktur auf Eingabe Erstellen .
    6. Fügen Sie eine Rückblickzeiteingabe hinzu.
      Tabelle : 2. Eingaben
      Bezeichnung Name Typ Obligatorisch
      Rückblickzeit Look_back_time Datum/Uhrzeit Ja
    7. Wenn die API, mit der Sie arbeiten, eine Anwenderauthentifizierung für Anforderungen erfordert, fügen Sie Eingaben für die Authentifizierung hinzu.
      Beispiele für allgemeine Anwenderauthentifizierungseingaben sind Administrator-Anwender-ID und Sitename. Weitere Informationen finden Sie in der Dokumentation Für Ihre ausgewählte API, um mehr über die Anforderungen für die Anwenderauthentifizierung in Ihrem spezifischen Fall zu erfahren. 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.

    8. Klicken Sie Auf Anforderung In der Aktionsstruktur.
    9. Füllen Sie im Formular die Felder aus.
      Tabelle : 3. 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 die SaaS-Anwendung ab, in die Sie integrieren.
      Paginierung aktivieren Ausgewählt.
      Vor jeder Anforderung ein Skript ausführen Nicht ausgewählt.
    10. Klicken Sie Auf Schritt „Paginierung einrichten“ In der Aktionsstruktur.
    11. Definieren Sie Paginierungsvariablen basierend auf den Abfrageparametern, die von der SaaS-API verwendet werden.

      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.
    12. 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 abgeschlossenes Beispiel für den Schritt „Paginierung einrichten“. 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, konvertieren Sie den Wert in eine Ganzzahl, führen Sie alle erforderlichen Vorgänge aus, und konvertieren Sie ihn dann wieder in eine Zeichenfolge.
    13. Klicken Sie Auf SOAP-Schritt Oder REST-Schritt In der Aktionsstruktur abhängig von der Option, die Sie für den Datenabruf ausgewählt haben.
    14. Wenn Sie ausgewählt haben SOAP , Geben Sie die Details ein.
      Tabelle : 4. 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. Sie ist auf die Verbindungs-URL aus dem HTTP(s)-Verbindungsdatensatz festgelegt, der mit dem Alias verknüpft ist.
      Details anfordern
      Umschlag erstellen Manuell .
      SOAP-Aktion API-Anforderung zum Abrufen einer Liste aussagekräftiger Anwenderaktivitäten. Beispiel: Das Basissystem WebexDie Integration von Besprechungen definiert eine sinnvolle Anwenderaktivität als Hosting einer Besprechung, sodass sie verwendet LstsummaryMeeting Anforderung zum Abrufen einer Liste aller Besprechungen. 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, um eine Liste aussagekräftiger Anwenderaktivitäten abzurufen, ein Startdatum, das als festgelegt ist Rückblickzeit Geben Sie und Ihre Variablen aus dem Schritt „Paginierung einrichten“ ein.
      Hinweis:
      Ein Beispiel für einen SOAP-Umschlag finden Sie in der Aktion „Anwenderaktivitäts-Datenstrom abrufen“, die in verwendet wird WebexAktualisieren Sie den Subflow „Anwenderaktivität“.
    15. Wenn Sie ausgewählt haben REST , Geben Sie die Details ein.
      Tabelle : 5. 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. Siehe Dokumentation Für die API, mit der Sie arbeiten, um zu erfahren, 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 „Paginierungseinrichtung“ erstellt haben.
      Fügen Sie einen weiteren Parameter für das Startdatum hinzu, damit die Anforderung Ergebnisse vom Startdatum bis zum aktuellen Datum zurückgibt. Legen Sie den Wert auf fest Rückblickzeit Eingabe.
      Hinweis:
      Stellen Sie sicher, dass Rückblickzeit Die Eingabedatums-/Uhrzeitvariable ist für die API, mit der Sie arbeiten, korrekt formatiert. Wenn Sie einen anderen Datentyp, z. B. eine Zeichenfolge, neu formatieren oder in einen anderen Datentyp konvertieren müssen, können Sie dies im Schritt „Aktionsvorverarbeitungsskript“ tun.

      Das folgende Bild zeigt ein abgeschlossenes Beispiel für den REST-Schritt. Dieses Beispiel stammt aus der Datenstromaktion „Auditprotokoll abrufen“, die in verwendet wird JiraAktualisieren Sie den Subflow „Anwenderaktivität“.

      REST-Schritt
    16. Klicken Sie Auf Wird Analysiert In der Aktionsstruktur.
    17. Füllen Sie im Formular die Felder aus.
      Tabelle : 6. 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
    18. Klicken Sie Auf Splitter-Schritt In der Aktionsstruktur.
    19. Füllen Sie im Formular die Felder aus.
      Tabelle : 7. Splitter-Schritt-Formular
      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 aussagekräftigen Aktivitätselement in der Antwortnachricht. Informationen zum Format der Antwortnachricht finden Sie in der Dokumentation der API, mit der Sie arbeiten.
      • Beispiel-XML-Elementpfad: /Message/body/Meeting
      • Beispiel-JSON-Elementpfad: $.Daten.Besprechung
    20. Klicken Sie Auf Ausgaben In der Aktionsstruktur.
    21. Klicken Sie Auf Ausgabe Erstellen Und bearbeiten Sie die Variable wie gezeigt.
      Tabelle : 8. Aktionsausgabe
      Bezeichnung Name Typ Obligatorisch
      targetObject targetObject Objekt Nein
    22. Fügen Sie untergeordnete Elemente für hinzu TargetObject Dient zum Speichern der Anwender-E-Mail-Adresse und des Datums der aussagekräftigen Aktivität.
      Beispielsweise könnte eine XML-Antwort so aussehen.
      <message>​
  <body>​
    <meeting>
      <meetingID>​12345</meetingID>​
      <startDate>​08/13/2019 20:08:16</startDate>​
      <hostEmail>​email@email.com</hostEmail>​
    </meeting>​
    <meeting>
      ...
    </meeting>
  </body>​
</message>
      Fügen Sie für diese Antwort die untergeordneten Elemente wie gezeigt hinzu.
      Tabelle : 9. Untergeordnete Elemente für targetObject
      Bezeichnung Name Typ Obligatorisch
      E-Mail E-Mail Zeichenfolge Nein
      Last_activity Last_activity Zeichenfolge Nein
    23. Klicken Sie in der Aktionsstruktur auf Skriptparser-Schritt .
    24. Erstellen Sie ein TargetObject Ausgabeobjekt für jedes aussagekräftige Aktivitätselement in der Antwort, und ordnen Sie dann jedes Aktivitätsdatum und die Anwender-E-Mail-Adresse zu TargetObject Untergeordnete Elemente.

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

      Hinweis:
      Diese Beispiele zeigen die Arten von Elementen, die in einer Antwort enthalten sein könnten. 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.email = xmlDoc.getNodeText('/meeting/hostEmail');
    outputs.targetObject.last_activity = xmlDoc.getNodeText('/meeting/startDate');
})(inputs, outputs)
      Beispielskript, das eine JSON-Antwort analysiert. 
      (function parse(inputs, outputs) {
    var record = JSON.parse(inputs.sourceItem);
    outputs.targetObject.email = record.hostEmail;
    outputs.targetObject.last_activity = record.startDate;
})(inputs, outputs)
    25. Klicken Sie auf, 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.
    26. Nachdem Sie überprüft haben, ob die Datenstromaktion wie erwartet funktioniert, klicken Sie auf Veröffentlichen .