Erstellen Sie eine Spoke, und erstellen Sie Aktionen, indem Sie eine OpenAPI-Spezifikation importieren
Automatisieren Sie eine Integration, und generieren Sie wiederverwendbare Aktionen durch Importieren einer OpenAPI-Spezifikation.
Vorbereitungen
Erforderliche Rolle: admin
Prozedur
- Navigieren zu Alle > Prozessautomatisierung > Workflow-Studio.
- Klicken Neu erstellen > Spoke.
-
Geben Sie im Bildschirm „Spoke Info“ (Spoke-Informationen) an, ob Sie die Spoke in einem neuen oder einem vorhandenen Bereich erstellen möchten.
-
Wenn Sie die Spoke in einem neuen Bereich erstellen möchten, wählen Sie ein Bild als Logo für Ihre Integration aus, und füllen Sie die Felder aus.
Hier sehen wir als Beispiel eine Integration mit Zoom durch.
Feld Beschreibung Spoke-Name Name zur Identifizierung der anwenderdefinierten Spoke. Beschreibung Beschreibung der anwenderdefinierten Spoke. Hinweis:Der Wert des App-Bereichsnamens hat das folgende Format: x_<company-code> _<spoke-name> _<spoke> . Standardmäßig ist<company-code> ist, snc. Sie können den Unternehmenscode konfigurieren, indem Sie den Wert der Systemeigenschaft glide.appcreator.company.codekonfigurieren.
Dieser konfigurierte Wert wird verwendet, wenn der Wert des App-Bereichsnamens generiert wird.
-
Wenn Sie die Spoke in einem vorhandenen Bereich erstellen möchten, wählen Sie ein Bild als Logo für Ihre Integration aus, und füllen Sie die Felder aus.
Hier sehen wir eine Integration mit AWS als Beispiel durch.
Feld Beschreibung Anwendungsname Ein vorhandener Anwendungsname oder Bereich. Name des App-Umfangs Bereichsname, der basierend auf dem ausgewählten Anwendungsnamenautomatisch ausgefüllt wird. Beschreibung Beschreibung der anwenderdefinierten Spoke.
-
Wenn Sie die Spoke in einem neuen Bereich erstellen möchten, wählen Sie ein Bild als Logo für Ihre Integration aus, und füllen Sie die Felder aus.
-
Klicken Sie auf Fortsetzen.
Basierend auf dem angegebenen Namen und der Beschreibung werden die Spoke-Details angezeigt, wenn im Store übereinstimmende Spokes vorhanden sind.
-
Klicken Sie auf Details im Store anzeigen, um die Details der übereinstimmenden Spokes anzuzeigen.
Die Details der übereinstimmenden Spokes werden auf einer neuen Browserregisterkarte angezeigt.
-
Installieren Sie die -Spoke aus dem Store.
Weitere Einzelheiten finden Sie unter Install a ServiceNow Store application.
-
Navigieren Sie nach der Installation der Spoke zur Registerkarte Workflow-Studio.
Das System zeigt die Meldung Haben Sie eine Spoke aus dem Store installiert?.
-
Wählen Sie eine dieser Optionen aus, und klicken Sie auf Fortsetzen.
Option Beschreibung Ja, installierte Spoke anzeigen. Option zur Weiterleitung zum Spokes- Dashboard unter Integrationen. Nein, ich werde eine anwenderdefinierte Spoke erstellen. Option zum Fortfahren der Spoke-Erstellung. Nein, ich möchte die Spoke-Erstellung beenden. Option zum Schließen der aktuellen Registerkarte.
-
Klicken Sie auf Details im Store anzeigen, um die Details der übereinstimmenden Spokes anzuzeigen.
-
Klicken Sie auf Überspringen, wenn Sie die anwenderdefinierte Spoke erstellen möchten.
Hinweis:Die folgenden Schritte gelten auch, wenn Sie No, I will build custom (Nein, ich werde eine anwenderdefinierte Spoke auswählen) ausgewählt haben. Option.
Die Spoke wird erstellt, und eine Bestätigungsmeldung wird angezeigt.
-
Wählen Sie im Bildschirm Build-Info die Methode aus, mit der Sie Ihre Spoke erstellen möchten.
Sie können Ihre Spoke mit der OpenAPI-Spezifikation oder der Postman-Sammlung erstellen.
-
Wählen Sie OpenAPI-Spezifikation aus, und klicken Sie auf „ Fortsetzen “, um eine OpenAPI-Spezifikation zu importieren.
- Klicken Sie für die OpenAPI-Quelleauf Neuimportieren.
-
Führen Sie im Bildschirm „Neue OpenAPI-Quelle importieren“ einen der beiden folgenden Schritte aus.
-
Wenn Sie den Import über eine URL durchführen möchten, wählen Sie „ Von URL importieren“ für die Importmethode aus, und geben Sie die URL unter OpenAPI-URLan.
-
Wenn Sie manuell mit JSON- oder YAML-Code importieren möchten, wählen Sie Manuell aus JSON oder YAML importieren für Importmethode aus, und geben Sie den Code in JSON oder YAMLan.
-
Wenn Sie den Import über eine URL durchführen möchten, wählen Sie „ Von URL importieren“ für die Importmethode aus, und geben Sie die URL unter OpenAPI-URLan.
-
Klicken Sie auf Importieren.
Die OpenAPI-Quelle wird importiert.
- Klicken Sie unter Alias für Verbindungen und Anmeldeinformationenauf Neu erstellen.
-
Füllen Sie im Bildschirm Neuen Alias für Verbindungen und Anmeldeinformationen erstellen die Felder aus, und geben Sie die Aliasinformationen an.
Feld Beschreibung Verbindungs- und Anmeldeinformationsname Name zur Identifizierung des Aliasdatensatzes für Verbindungen und Anmeldeinformationen. Konfigurationsvorlage für die Authentifizierung Erforderlicher Authentifizierungsmechanismus für diese Integration. Stellen Sie sicher, dass der Authentifizierungsmechanismus mit der OpenAPI-Quelle kompatibel ist. Hinweis:Die Konfigurationsvorlage wird automatisch basierend auf der von Ihnen angegebenen OpenAPI-Spezifikation ausgefüllt. Sie können mit der Standardoption fortfahren oder sie entsprechend Ihren Anforderungen ändern. - Klicken Sie auf Alias erstellen und fortfahren.
-
Füllen Sie auf demselben Bildschirm die Felder aus, um den Alias zu konfigurieren.
Feld Beschreibung Verbindungsinformation Verbindungsname Name zur Identifizierung des Verbindungsdatensatzes. Verbindungs-URL Basis-URL zum Herstellen einer Verbindung mit der Instanz oder dem Server einer Drittpartei. Diese URL wird basierend auf der von Ihnen angegebenen OpenAPI-Spezifikation automatisch ausgefüllt. Anmeldedaten Je nachdem, welche Konfigurationsvorlage Sie ausgewählt haben, werden die relevanten Anmeldeinformationsfelder angezeigt. Geben Sie die erforderlichen Werte an, um den Anmeldeinformationsdatensatz zu konfigurieren. Wenn Sie den Aliasdatensatz später konfigurieren möchten, klicken Sie auf Später machen.
-
Klicken Sie auf Absenden.
Der Verbindungsalias-Datensatz wird erstellt.
-
Klicken Sie auf Operations generieren.
Alle Vorgänge, die mit der OpenAPI-Spezifikation ausgeführt werden können, sind aufgelistet.
-
Wählen Sie die erforderlichen Vorgänge aus.
Sie können nach den erforderlichen Aktionen suchen, indem Sie den gewünschten Begriff in die Suchleiste eingeben. Die Aktionen, die dem angegebenen Suchbegriff entsprechen, werden angezeigt.
-
Klicken Sie auf Veröffentlichen.
Alternativ können Sie auch Aktionen als Entwurf speichern auswählen, um die Aktionen als Entwurf zu speichern, sie nach Bedarf zu ändern und später zu veröffentlichen.
-
Klicken Sie auf Fertig: Zur Spoke wechseln, um zur Seite „Spokes“ zu wechseln und den Veröffentlichungsstatus anzuzeigen.
- Aktionen mit dem OpenAPI-Schritt werden erstellt. Informationen zum OpenAPI-Schritt finden Sie unter OpenAPI support in the REST step.
- Aktionseingaben und -ausgaben werden zugeordnet.
- Aktionen werden veröffentlicht und auf der Seite mit den Spoke-Details unter aufgeführt Aktionen > Veröffentlicht.
Sie können diese veröffentlichten Aktionen verwenden, um Flows und Subflows gemäß Ihren Anforderungen zu erstellen.
- Wenn Sie Aktionen als Entwürfe gespeichert haben, können Sie auf der Seite „Spoke-Details“ unter „“ auf diese Entwurfsaktionen zugreifen Aktionen > Entwurf.
- Um Laufzeitinformationen zu den Spoke-Aktivitäten anzuzeigen, klicken Sie auf der Seite „Spoke-Details“ auf Spoke -Aktivitätsprotokoll. Jedes Mal, wenn eine Spoke-Aktivität ausgeführt wird, generiert das System die entsprechenden Informationen als Spoke-Aktivitätsprotokoll. Klicken Sie auf die erforderliche Nummer, um das Aktivitätsprotokoll anzuzeigen. Jeder Vorgang im Spoke-Aktivitätsprotokoll weist einen der folgenden Statuswerte auf:
Status Beschreibung new Ein Ereignis für den Vorgang wird erstellt, und dieser Vorgang wird in Kürze ausgeführt. Fehler Der Vorgang konnte nicht ausgeführt werden. Verarbeitung Die Ausführung des Vorgangs wird ausgeführt. Erfolg Der Vorgang wurde erfolgreich ausgeführt.
Sie können Flows und Subflows auf der Spoke-Detailseite erstellen und in Ihrer Integration verwenden. Weitere Informationen finden Sie unter Erstellen von Flows und Subflows werden erstellt.
Neben dem Spoke-Aktivitätsprotokollkönnen Sie auf der Seite mit den Spoke-Details auch Details zu den verfügbaren Flows, Subflows und Aktionen anzeigen.