Erstellen Sie eine Datenstromaktion, um die Benutzeraktivität abzurufen

Erstellen Sie eine Datenstromaktion, um die Benutzeraktivität aus einer SaaS-Anwendung abzurufen.

Vorbereitungen

Wenn Sie eine vorhandene Spoke ServiceNow® IntegrationHub verwenden, prüfen Sie, ob sie über eine Datenstromaktion zum Abrufen der Benutzeraktivität verfügt, die Sie verwenden können, anstatt eine zu erstellen.

Weitere Informationen zu Datenstromaktionen finden Sie unter Datenstromaktionen.

Erforderliche Rolle: flow_designer oder admin

Warum und wann dieser Vorgang ausgeführt wird

Überwachen Sie die Benutzeraktivität, um Softwareabonnements zu finden, für die Ihr Unternehmen bezahlt, die aber nicht verwendet werden. Sie können diese nicht verwendeten Abonnements zurückfordern, um die Softwareausgaben Ihres Unternehmens zu senken.

Entscheiden Sie vor dem Erstellen der Datenstromaktion, wie Sie aussagekräftige Benutzeraktivitäten definieren möchten. Eine aussagekräftige Aktivität kann eine Kombination von Benutzeraktionen sein. Erstellen Sie eine separate Datenstromaktion für jede Benutzeraktivitätsmetrik. Zum Beispiel definiert die Basissystem-Besprechungsintegration Webex eine sinnvolle Aktivität als das Abhalten eines -Meetings. Sie verwendet eine Datenstromaktion, um die Daten der zuletzt gehosteten Besprechungen für alle Benutzer abzurufen. Wenn die Integration von Webex Meetings auch die Anmeldung als sinnvolle Aktivität umfassen soll, erstellen Sie eine zweite Datenstromaktion, um die letzten Anmeldezeiten für alle Benutzer abzurufen.

Ihre Datenstromaktion zum Abrufen von Benutzern gibt möglicherweise eine Benutzeraktivitätsmetrik zurück, z. B. die Zeit der letzten Anmeldung. In diesem Fall müssen Sie keine Datenstromaktion erstellen, um die Benutzeraktivität abzurufen, oder einen Subflow, um die Benutzeraktivität abzurufen, es sei denn, Sie möchten zusätzliche Benutzeraktivitätsmetriken definieren. Stellen Sie sicher, dass Ihr Subflow zum Abrufen von Benutzern diese Benutzeraktivitätsmetrik als Eingabe Letzte Aktivität in der Aktion „Upsert-Benutzerabonnement“ festlegt.

Prozedur

1. Navigieren zu Alle > Flow Designer > Designer.
2. Klicken Sie auf Neu, und wählen Sie dann Datenstromaus.
3. Füllen Sie die Felder des Formulars aus.

   Tabelle : 1. Formular „Aktionseigenschaften“

   Feld	Wert
   Name	Name Ihrer Wahl. Beispiel: Benutzeraktivität abrufen.
   Zugänglich von	Alle Anwendungsbereiche.
   Kategorie	Lassen Sie dieses Feld leer.
   Schutz	Keine.
   Anwendung	Spoke-App zur Integration in die SaaS-Anwendung. Diese Spoke-App kann eine vorhandene IntegrationHub -Spoke oder eine neue, von Ihnen erstellte Spoke sein.
   In-Flow-Anmerkung	Lassen Sie dieses Feld leer.
   Beschreibung	Beschreibung Ihrer Wahl.

4. Klicken Sie auf Absenden.
5. Klicken Sie im Abschnitt Eingaben der Aktionsgliederung 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 Benutzerauthentifizierung für Anforderungen erfordert, fügen Sie Eingaben für die Authentifizierung hinzu.
   Beispiele für allgemeine Eingaben für die Benutzerauthentifizierung sind die Administrator-Benutzer-ID und der Site-Name. In der Dokumentation für die von Ihnen gewählte API erfahren Sie mehr über die Anforderungen für die Benutzerauthentifizierung in Ihrem speziellen Fall. Wenn die API ein Zugriffstoken erfordert, wird später automatisch eine Variable „Anmeldeinformationswert“ 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 in der Aktionsgliederung auf Anforderung.
9. Füllen Sie die Felder des Formulars aus.

   Tabelle : 3. Anforderungsformular

   Feld	Wert
   So rufen Sie Daten ab	Wählen Sie entweder REST-Schritt oder SOAP-Schritt aus. Ihre Auswahl hängt von der API für die SaaS-Anwendung ab, die Sie integrieren.
   Paginierung aktivieren	Ausgewählt.
   Vor jeder Anforderung ein Skript ausführen	Nicht ausgewählt.

10. Klicken Sie in der Aktionsgliederung auf den Schritt Paginierungseinrichtung.
11. Definieren Sie Paginierungsvariablen basierend auf den von der SaaS-API verwendeten Abfrageparametern.

    Wenn Sie die offsetbasierte Paginierung verwenden, verwenden Sie die Paginierungsvorlage „Limit/Offset“ (Limit/Offset), um die Paginierungskonfiguration vorab zu laden.

    Hinweis:

    Der Wert der reservierten getNextPage- Variablen bestimmt, ob eine weitere Ergebnisseite angefordert werden soll. Solange die Variable getNextPageauf truegesetzt ist, sendet die Aktion weiterhin Anforderungen für die nächste Seite.
12. Schreiben Sie ein Paginierungsvariablenskript, um die Paginierungsvariablen zu aktualisieren.

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

    Die folgende Abbildung zeigt ein abgeschlossenes Beispiel für den Setup-Schritt der Paginierung. Dieses Beispiel stammt aus der Datenstromaktion Benutzer abrufen, die im Subflow Webex Abonnements herunterladen verwendet wird.

    

    Hinweis:

    Paginierungsvariablen unterstützen nur den Datentyp Zeichenfolge. Um mathematische Operationen auszuführen, konvertieren Sie den Wert in eine Ganzzahl, führen Sie die erforderlichen Operationen aus und konvertieren Sie ihn dann zurück in eine Zeichenfolge.
13. Klicken Sie in der Aktionsgliederung auf SOAP-Schritt oder REST-Schritt, je nachdem, welche Option Sie zum Abrufen von Daten ausgewählt haben.
14. Wenn Sie SOAPausgewählt haben, füllen Sie das Formular wie gezeigt aus.

    Tabelle : 4. SOAP-Schrittformular

    Feld	Wert
    Verbindungsdetails
    Verbindung	Verbindungs-Alias verwenden.
    Verbindungsalias	Verbindungsalias, den Sie beim Erstellen des Integrationsprofils erstellt haben. Wenn Sie noch kein Integrationsprofil erstellt haben, führen Sie die Schritte aus, um ein benutzerdefiniertes Integrationsprofil mit einem Verbindungsalias zu erstellen.
    Endpunkt	Dieser Wert wird automatisch ausgefüllt, wenn Sie den Verbindungsalias auswählen. Er wird 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 mit aussagekräftigen Benutzeraktivitäten. Zum Beispiel definiert die Basissystem-Meeting-Integration Webex eine sinnvolle Benutzeraktivität als das Abhalten eines Meetings, sodass die Anforderung LssumaryMeeting verwendet wird, um eine Liste aller Meetings abzurufen. Informationen zur Auswahl der entsprechenden Anforderung finden Sie in der Dokumentation für die von Ihnen gewählte API.
    SOAP-Umschlag	XML-Anforderungsnachricht zum Abrufen einer Liste aller Benutzer. In der Dokumentation für die von Ihnen gewählte API erfahren Sie, wie Sie eine XML-Anforderungsnachricht schreiben. Im Allgemeinen sollte der Header Ihre Eingabevariablen für die Benutzerauthentifizierung sowie die Variable Credential Value (Anmeldeinformationswert) als Zugriffstoken enthalten. Der Textkörper sollte die Anforderung zum Abrufen einer Liste mit aussagekräftigen Benutzeraktivitäten, ein Startdatum, das als Eingabe für die Rückblickzeit festgelegt ist, und Ihre Variablen aus dem Setup-Schritt für die Paginierung enthalten. Hinweis: Ein Beispiel für einen SOAP-Umschlag finden Sie in der Datenstromaktion Benutzeraktivität abrufen, die im Subflow Webex Benutzeraktivität aktualisieren verwendet wird.

15. Wenn Sie RESTausgewählt haben, füllen Sie das Formular wie gezeigt aus.

    Tabelle : 5. REST-Schrittformular

    Feld	Wert
    Verbindungsdetails
    Verbindung	Verbindungs-Alias verwenden.
    Verbindungsalias	Verbindungsalias, den Sie beim Erstellen des Integrationsprofils erstellt haben. Wenn Sie noch kein Integrationsprofil erstellt haben, führen Sie die Schritte aus, um ein benutzerdefiniertes Integrationsprofil mit einem Verbindungsalias zu erstellen.
    Basis-URL	Dieser Wert wird automatisch ausgefüllt, wenn Sie den Verbindungsalias auswählen. Er wird 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 für die API, mit der Sie arbeiten, erfahren Sie, wie Sie den Ressourcenpfad erstellen.
    HTTP-Methode	GET.
    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 als Eingabe für die Rückblickzeit fest. Hinweis: Stellen Sie sicher, dass die Variable Rückblickzeit -Eingabedatum/-uhrzeit für die API, mit der Sie arbeiten, richtig formatiert ist. Wenn Sie eine Neuformatierung oder Konvertierung in einen anderen Datentyp wie eine Zeichenfolge durchführen müssen, können Sie dies im Skriptschritt „Aktion Vorverarbeitung“ tun.

    Die folgende Abbildung zeigt ein abgeschlossenes Beispiel des REST-Schritts. Dieses Beispiel stammt aus der Datenstromaktion Audit-Protokoll abrufen, die im Subflow Jira Benutzeraktivität aktualisieren verwendet wird.

    
16. Klicken Sie in der Aktionsgliederung auf Analysieren.
17. Füllen Sie die Felder des Formulars aus.

    Tabelle : 6. Analyseformular

    Feld	Wert
    So werden eiWie werden Sie jeden Datensatz identifizieren?	JSON/XML-Splitter
    So werden die einzelnen Elemente in einem Objekt analysiert	Skriptparser

18. Klicken Sie in der Aktionsgliederung auf den Splitter-Schritt.
19. Füllen Sie die Felder des Formulars aus.

    Tabelle : 7. Splitter-Schrittformular

    Feld	Wert
    Quellformat	Wählen Sie XML oder JSON aus, je nachdem, welches Format die API-Antwort zurückgibt.
    Elementpfad	Absoluter Pfad zu einem aussagekräftigen Aktivitätselement in der Antwortnachricht. Informationen zum Format der Antwortnachricht finden Sie in der Dokumentation für die API, mit der Sie arbeiten. Beispiel für XML-Elementpfad: /message/body/meeting Beispiel für JSON-Elementpfad: $.data.meeting

20. Klicken Sie in der Aktionsgliederung auf Ausgaben.
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 targetObject hinzu, um die Anwender-E-Mail und das Datum der bedeutungsvollen Aktivität zu speichern.
    Eine XML-Antwort könnte beispielsweise so aussehen.

    <message>​
      <body>​
        <meeting>
          <meetingID>​12345</meetingID>​
          <startDate>​08/13/2019 20:08:16</startDate>​
          <hostEmail>​[e-mail]</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 Aktionsgliederung auf Skriptparser-Schritt.
24. Erstellen Sie ein targetObject- Ausgabeobjekt für jedes aussagekräftige Aktivitätselement in der Antwort, und ordnen Sie dann das Aktivitätsdatum und die Benutzer-E-Mail den untergeordneten targetObject- Elementen zu.

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

    Hinweis:

    Diese Beispiele zeigen die Arten von Elementen, die in einer Antwort enthalten sein können. 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. Um Ihre Datenstromaktion zu testen, klicken Sie auf Test.
    1. Zeigen Sie die Testergebnisse und Systemprotokolle an, um Details zu Fehlern zu erhalten.
       Um Systemprotokolle anzuzeigen, navigieren Sie zu Systemprotokolle > Systemprotokoll > Alle.
    2. Wenn Ihre Datenstromaktion Fehler aufweist, stellen Sie sicher, dass Sie die richtigen Endpunkte verwenden und die API-Anforderungen und -Antworten wie erwartet strukturiert sind.
26. Nachdem Sie sich vergewissert haben, dass die Datenstromaktion wie erwartet funktioniert, klicken Sie auf Veröffentlichen.

Vorheriges Thema: Erstellen Sie einen Subflow, um Benutzer abzurufen

Nächstes Thema: Erstellen Sie einen Subflow, um die Benutzeraktivität abzurufen