Erstellen Sie Spoke- und Build-Aktionen, indem Sie eine OpenAPI-Spezifikation importieren
Automatisieren Sie eine Integration, und generieren Sie wiederverwendbare Aktionen, indem Sie eine OpenAPI-Spezifikation importieren.
Vorbereitungen
Erforderliche Rolle: admin
Prozedur
- Navigieren zu Alle > Prozessautomatisierung > Workflow-Studio.
- Klicken Neu erstellen > Spoke.
-
Wählen Sie im Bildschirm „Allgemeine Informationen“ ein Bild als Logo für Ihre Integration aus, und füllen Sie die Felder aus.
Hier sehen wir eine Integration mit Zoom als Beispiel.
Feld Beschreibung Spoke-Name Name zur Identifizierung der benutzerdefinierten Spoke. Beschreibung Beschreibung der benutzerdefinierten 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 Wert der Systemeigenschaft glide.appcreator.company.codekonfigurieren.
Dieser konfigurierte Wert wird verwendet, wenn der Wert App scope name generiert wird.
-
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.
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 Flow Designer.
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 Umleitung zum Spokes- Dashboard unter Integrationen. Nein, ich werde eine benutzerdefinierte Spoke erstellen. Option, um mit der Spoke-Erstellung fortzufahren. 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 benutzerdefinierte Spoke erstellen möchten.
Hinweis:Die folgenden Schritte gelten auch, wenn Sie die Spoke No, I will build custom (Nein, ich werde benutzerdefinierte Spoke erstellen) ausgewählt haben. Option.
Die Spoke wird erstellt, und eine Bestätigungsmeldung wird angezeigt.
- Wählen Sie im Bildschirm „Build-Informationen“ die Methode aus, mit der Sie Ihre Spoke erstellen möchten.
- Wählen Sie OpenAPI-Spezifikation aus, und klicken Sie auf Fortfahren, um eine OpenAPI-Spezifikation zu importieren.
- Klicken Sie für OpenAPI-Quelleauf Neuimportieren.
-
Führen Sie auf dem Bildschirm „Import new OpenAPI source“ (Neue OpenAPI-Quelle importieren) einen dieser beiden Schritte aus.
-
Wenn Sie den Import über eine URL durchführen möchten, wählen Sie Import aus URL für Importmethode aus , und geben Sie die URL in 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 Import aus URL für Importmethode aus , und geben Sie die URL in OpenAPI-URLan.
-
Klicken Sie auf Importieren.
Die OpenAPI-Quelle wird importiert.
- Klicken Sie für Aliasse für Verbindungen und Anmeldeinformationenauf Neu erstellen.
-
Füllen Sie im Bildschirm „Create new connection and credential alias“ (Neuen Alias für Verbindungen und Anmeldeinformationen erstellen) die Felder aus, und geben Sie die Aliasinformationen an.
Feld Beschreibung Verbindung 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 basierend auf der von Ihnen angegebenen OpenAPI-Spezifikation automatisch ausgefüllt. Sie können mit der Standardoption fortfahren oder sie nach Bedarf ä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 für die Verbindung mit der Drittpartei-Instanz oder dem Server. Diese URL wird basierend auf der von Ihnen angegebenen OpenAPI-Spezifikation automatisch ausgefüllt. Anmeldedaten Basierend auf der von Ihnen ausgewählten Konfigurationsvorlage 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 Sieauf Später ausführen.
-
Klicken Sie auf Absenden.
Der Verbindungsalias-Datensatz wird erstellt.
-
Klicken Sie auf Vorgänge generieren.
Alle Vorgänge, die mit der OpenAPI-Spezifikation ausgeführt werden können, werden aufgelistet.
-
Wählen Sie die erforderlichen Vorgänge aus.
Sie können nach den erforderlichen Aktionen suchen, indem Sie den erforderlichen 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 Ihren Anforderungen zu ändern und später zu veröffentlichen.
- Aktionen mit dem OpenAPI-Schritt werden erstellt. Weitere 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 Spoke-Detailseite unter aufgelistet Aktionen > Veröffentlicht.
Sie können diese veröffentlichten Aktionen verwenden, um Flows und Subflows gemäß Ihren Anforderungen zu erstellen.
- Wenn Sie Aktionen als Entwurf gespeichert haben, können Sie auf der Spoke-Detailseite unter auf diese Entwurfsaktionen zugreifen Aktionen > Entwurf.
- Um Laufzeitinformationen zu den Spoke-Aktivitäten anzuzeigen, klicken Sie auf der Spoke-Detailseite 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.
Zusammen mit dem Spoke-Aktivitätsprotokollkönnen Sie auch Details der verfügbaren Flows, Subflows und Aktionen auf der Spoke-Detailseite anzeigen.