ServiceNow Application Scope

UiPath.ServiceNow.Activities.ServiceNowScopeActivity

Tipp:

While the ServiceNow Application Scope activity can use standard authentication (UserName) and (Password), it is highly recommend to use OAuth security for all your connections per the steps below.

Die ServiceNow-Aktivitäten verwenden das Protokoll OAuth 1.0, um eine authentifizierte Verbindung zwischen UiPath und Ihrer ServiceNow-Instanz herzustellen. Diese Verbindung autorisiert einen Roboter, die ServiceNow-APIs aufzurufen und in Ihrem Namen auf Ressourcen zuzugreifen.

Um die Autorisierung zu aktivieren, erstellen Sie einen OAuth-Anwendungsendpunkt für Ihre ServiceNow-Instanz. Durch Erstellen dieses Endpunkts werden ein OAuth-Clientanwendungsdatensatz, eine Client-ID und ein geheimer Clientschlüssel generiert, um den authentifizierten Zugriff auf Ihre Instanz zu aktivieren.

After creating your endpoint, you enter your ServiceNow credentials along with the application endpoint URL, Client ID, and Client Secret in the ServiceNow Application Scope activity.

Tipp:

Integrationsbenutzerrollen sollten nur die minimal erforderlichen Berechtigungen zum Ausführen der Aufgaben zugewiesen bekommen, die durch die Aktivitäten in diesem Paket aktiviert werden (z. B. admin, itil, Soap_ecc usw. sollten nicht für Integrationsbenutzerrollen verwendet werden). Eingehende Webdienste, die Tabellen ändern, sollten auf die entsprechenden Systemrollen beschränkt sein. Weitere Informationen finden Sie im Abschnitt Rollen in der ServiceNow-Dokumentation.

Wie es funktioniert

Die folgenden Schritte und das folgende Nachrichtensequenzdiagramm sind ein Beispiel dafür, wie die Aktivität von der Entwurfszeit (d. h. den Aktivitätsabhängigkeiten und Eingabe-/Ausgabeeigenschaften) bis zur Laufzeit funktioniert.

1. Schließen Sie die Einrichtungsschritte ab.
2. Fügen Sie eine Aktivität für jede SecureString -Eingabeeigenschaft hinzu (z. B. insgesamt zwei – eine für Kennwort und eine für ClientGeheimnis)
3. Add the ServiceNow Application Scope activity to your project.
4. Geben Sie Werte für die Authentifizierungs- und Verbindungseigenschaften ein.
5. Erstellen und geben Sie eine IConnection -Variable für Ausgabeeigenschaften ein.

   • You can use this variable in subsequent uses of the ServiceNow Application Scope activity.

     

Wenn bei der Standardauthentifizierung Probleme auftreten, lesen Sie Tipps zur Standardauthentifizierung.

Im Textkörper der Aktivität

To build your project and enable the Object Wizard in other activities, you must use the Connection Wizard by clicking the Configure button.

Weitere Informationen finden Sie im Abschnitt Assistenten auf der Seite „Über“ .

Eigenschaften

Authentication

• Username - The username for your ServiceNow instance. Enter a String variable.
  • Dieser Wert kann sich von Ihrem ServiceNow-Konto unterscheiden, wenn Sie über mehrere Instanzen verfügen.
  • Der Benutzername ist mit dem Kennwort verknüpft. Es wird empfohlen, dass Sie eine String -Variable generieren, indem Sie dem Abschnitt Anmeldeinformationsassets erstellen der Setup- Anleitung folgen.
  • Um Ihre String -Variable einzugeben, verwenden Sie eine Aktivität, die Ihr Anmeldeinformations-Asset ausgibt (siehe Beispiel unten).
• Password - The password (associated with the Username) to your ServiceNow instance. Enter a String or String variable.
  • Dieser Wert kann sich von Ihrem ServiceNow-Konto unterscheiden, wenn Sie über mehrere Instanzen verfügen.
  • Der Benutzername ist mit dem Kennwort verknüpft. Es wird empfohlen, dass Sie eine String -Variable generieren, indem Sie dem Abschnitt Anmeldeinformationsassets erstellen der Setup- Anleitung folgen.
  • Um Ihre String -Variable einzugeben, verwenden Sie eine Aktivität, die Ihr Anmeldeinformations-Asset ausgibt (siehe Beispiel unten).
• Client Secret - The SecureString used to authorize communications between UiPath and your ServiceNow instance. Enter a SecureString variable.
  • Das ClientGeheimnis wird für Ihre ServiceNow-Instanz generiert, wenn Sie eine Anwendungsregistrierung abschließen. Weitere Informationen finden Sie im Abschnitt OAuth einrichten der Einrichtungsanleitung .
  • Informationen zum Generieren einer SecureString -Variablen finden Sie im Abschnitt Erstellen von Anmeldeinformationsassets der Setup- Anleitung.
  • Um Ihre SecureString -Variable einzugeben, verwenden Sie eine Aktivität, die Ihr Anmeldeinformations-Asset ausgibt (siehe Beispiel unten).
• ClientId - The auto-generated, unique ID of your application registry. Enter a String variable.
  • Die ClientID wird für Ihre ServiceNow-Instanz generiert, wenn Sie eine Anwendungsregistrierung abschließen. Weitere Informationen finden Sie im Abschnitt OAuth einrichten der Einrichtungsanleitung .
  • Die ClientID ist mit dem ClientGeheimnis verknüpft. Es wird empfohlen, dass Sie eine String -Variable generieren, indem Sie dem Abschnitt Anmeldeinformationsassets erstellen der Setup- Anleitung folgen.
  • Um Ihre String -Variable einzugeben, verwenden Sie eine Aktivität, die Ihr Anmeldeinformations-Asset ausgibt (siehe Beispiel unten).
• Lokaler Port (optional) – Der lokale Port für die Umleitung. Der Standardwert ist 10001. Geben Sie einen String oder String -Variable ein.
• Use OAuth 2.0 - Check this to use OAuth2 code grant flow of ServiceNow.

Allgemein

• DisplayName - The display name of the activity. Enter a String or String variable.

Verbindung (Connection)

• EndpointURL - The URL of your ServiceNow instance. Enter a String or String variable. The URL should be to your ServiceNow instance and not the Redirect URL in your application registry.

Sonstiges

• Privat (Private) - Bei Auswahl werden die Werte von Variablen und Argumenten nicht mehr auf der Stufe Verbose protokolliert.

Optionen

• ReportApiErrorAsException - When selected, API error responses are reported in BusinessActivityExecutionException by all child activities that use this application scope. When cleared, the child activity populates the API error message in the ResponseStatus output property and workflow execution continues. Check the ResponseStatus property to confirm successful execution.

Ausgabe

• ServiceNowConnection - A record of your established connection that you can use in subsequent ServiceNow Application Scope activities. Enter a IConnection variable (UiPath.BAF.Models.Connection.IConnection).

Vorhandene Verbindung verwenden

• ExistingServiceNowConnection - A connection record from a parent ServiceNow Application Scope activity that you can use instead of establishing a new connection. Enter a IConnection variable (UiPath.BAF.Models.Connection.IConnection).
  • The IConnection variable must be from a previously run SeriviceNow Scope activity (parent) that still has an active connection.
  • If you're unable to establish a connection using this property, try re-running your parent ServiceNow Application Scope activity.

Beispiel

Die folgende Abbildung zeigt ein Beispiel für die Aktivitätsabhängigkeitsbeziehung und Eingabe-/Ausgabe-Eigenschaftswerte.

Schritt-für-Schritt-Anweisungen und Beispiele finden Sie in der Schnellstartanleitung .

Tipps zur Standardauthentifizierung

Im ServiceNow-Aktivitätspaket kann die Standardauthentifizierung (Benutzername und Kennwort) zum Ausführen von Aktivitäten verwendet werden. Die Schritte sind im Folgenden beschrieben:

Entwurfszeit

Geben Sie zur Entwurfszeit den Benutzernamen und das Kennwort mit der Endpunkt-URL ein, und diese Details werden gespeichert. Beachten Sie, dass die Anmeldeinformationen nicht mit ServiceNow für die Standardauthentifizierung auf Scope-Ebene validiert werden. Erst zu einem späteren Zeitpunkt, wenn ServiceNow-Entitäten in einer einzelnen Aktivität oder zur Laufzeit während der Ausführung einer Aktivität abgerufen werden, werden diese grundlegenden Authentifizierungsanmeldeinformationen zur Authentifizierung verwendet.

Wenn die angegebenen Anmeldeinformationen für die Standardauthentifizierung falsch sind, wird beim Laden der Entitätsliste ein Fehler ausgegeben, da die gespeicherten Anmeldeinformationen für die Standardauthentifizierung verwendet werden, um eine Verbindung mit ServiceNow herzustellen und Entitäten-/Tabellennamen abzurufen.

If the credentials (Username, Password, EndpointUrl) are correct the entities will be populated in the activity dropdown like below:

Laufzeit

Stellen Sie sicher, dass die Anmeldeinformationen im Eigenschaftenbereich auf der rechten Seite ausgefüllt werden.

Wenn die Anmeldeinformationen korrekt sind, wird die Aktivität ausgeführt. Wenn es falsch ist, wird zur Laufzeit ein Fehler ausgegeben, wie unten gezeigt: