Planen von API-Aufgaben

Mit der Planung einer API-Aufgabe können Sie Automatisierungen initiieren, die von der Bot Runner-Infrastruktur (Nutzer und Geräte) unabhängig sind. Da API-Aufgaben in der Cloud laufen, entfällt die Notwendigkeit individueller Nutzerlizenzen, was Kosten spart und das Automatisierungsmanagement vereinfacht.

Sie können die verfügbaren API-Aufgaben zu bestimmten Zeiten ausführen lassen. Beispiel: Sie verarbeiten einen Stapel von Rechnungen in einer .csv-Datei, die jeden Mittwoch um 17 Uhr ausgeführt werden soll.
Anmerkung: Die Planung von API-Aufgaben im Control Room erfordert eine Enterprise Platform-Lizenz. Einzelheiten finden Sie unter Enterprise Platform.

Vorbereitungen

Vergewissern Sie sich, dass Sie in Control Room als Administrator oder als Nutzer mit den folgenden Berechtigungen angemeldet sind:
  • Ausführung eigener Bots planen
  • Berechtigung ALLE geplanten Aktivitäten aus meinen Ordnern verwalten auf Ordnerebene für eine bestimmte API-Aufgabe und alle Abhängigkeiten
  • API-Aufgaben als Nutzer ausführen.

    Weitere Informationen finden Sie unter „Als Nutzer ausführen“ für API-Aufgabe (apitaskrunner).

Prozedur

  1. Melden Sie sich bei Control Room an.
  2. Wählen Sie im linken Bereich eine der folgenden Methoden aus, um einen Zeitplan zu erstellen:
    • Klicken Sie auf Automatisierung.

      Klicken Sie auf das Aktionsmenü (vertikale Ellipse) rechts neben der API-Aufgabe, für die Sie einen Zeitplan erstellen möchten, und klicken Sie auf API-Aufgabe planen.

    • Klicken Sie auf Verwalten > Zeitplan > Zeitplan erstellen.
    Der Bildschirm Automatisierung und Abhängigkeiten wird angezeigt. Sie können auch auf die Option Auswählen klicken, um die spezifische API-Aufgabe zu finden.
  3. Wählen Sie die API-Aufgabe, die Sie planen möchten, und klicken Sie auf Auswählen.
    Der Bildschirm Zeitplan erstellen mit verschiedenen Registerkarten wird angezeigt.
  4. Auf der Registerkarte Automatisierung und Abhängigkeiten können Sie die folgenden Felder überprüfen und aktualisieren:
    • Automatisierungsdatei: Zeigt die ausgewählte API-Aufgabe an.

      Wenn Sie eine andere API-Aufgabe auswählen möchten, klicken Sie auf Auswählen.

    • Automatisierung und Abhängigkeiten ausführen mit: Wählen Sie eine der folgenden Versionen der API-Aufgabe zur Ausführung aus:
      • Aktuelle Version: Hiermit planen Sie die ausgewählte API-Aufgabe und die Abhängigkeiten mit der neuesten Version.
      • Produktionsbezeichnung: Hiermit planen Sie die ausgewählte API-Aufgabe und die Abhängigkeiten mit der Produktionsversion.

      Standardmäßig wird die neueste Version des API-Aufgabes ausgewählt.

    • Abhängigkeiten: Liste der Abhängigkeiten für die ausgewählte API-Aufgabe.
  5. Klicken Sie auf Weiter.
  6. Fügen Sie der API-Aufgabe die Planungsdetails hinzu.
    Wählen Sie im Feld Planen eine der folgenden Optionen aus:
    • Einmal ausführen: Führt die API-Aufgabe einmalig zum angegebenen Tag und zur angegebenen Stunde aus.

      Verwenden Sie die folgenden Optionen, um die Einstellung Einmal ausführen zu konfigurieren:

      • Anfangsdatum: Der Standardwert ist der aktuelle Tag.
      • Startzeit: Der Standardwert wird auf die nächste halbe Stunde aufgerundet.
      • Zeitzone: Dies ist die Systemzeitzone auf Ihrem lokalen Gerät.
        Anmerkung: Die Zeitzonen EST, HST und MST sind veraltet. Einzelheiten finden Sie unter Bevorstehende Funktionseinstellungen.
    • Wiederholt ausführen: Verwenden Sie diese Option, um Ihre API-Aufgabe so zu planen, dass sie zu einer bestimmten Uhrzeit an einem bestimmten Tag ausgeführt wird.

      Verwenden Sie die folgenden Optionen, um die Einstellung Wiederholt ausführen zu konfigurieren:

      • Anfangsdatum: Geben Sie das Datum ein, an dem die Ausführung des API-Aufgabes planmäßig beginnen soll.

        Geben Sie das Datum entweder manuell im Format JJJJ-MM-TT oder mithilfe des Popup-Kalenders ein. Der Standardwert für das Feld Anfangsdatum ist der aktuelle Tag, der auf Ihrem lokalen Gerät eingestellt ist.

      • Enddatum: Geben Sie das Datum ein, an dem die Ausführung planmäßig enden soll.

        Das Enddatum wird nicht standardmäßig festgelegt.

      • Startzeit: Geben Sie die Startzeit über die Dropdown-Liste ein, um den Zeitpunkt festzulegen, zu dem die Ausführung beginnen soll.

        Die Liste enthält vordefinierte Zeitwerte im 12-Stunden-Format in Intervallen von 15 Minuten. Sie können den Zeitwert auch manuell im 12-Stunden-Format einstellen.

      • Zeitzone: Wählen Sie sowohl für die Start- als auch für die Endzeit die Zeitzone aus.

        Der Standardwert ist auf den aktuellen Standort Ihres Systems eingestellt. Ein Zeitplan wird anhand der Zeitzone ausgeführt, die Sie beim Erstellen oder Bearbeiten eines Zeitplans ausgewählt haben.

      • Wiederholen jede: Wählen Sie diese Option, um den Zeitplan zu wiederholen.
    • Häufigkeit: Wählen Sie eine der folgenden Optionen als Häufigkeit für die Ausführung des Zeitplans:
      • Täglich: Wählen Sie die Anzahl der Tage, an denen der Zeitplan ausgeführt werden soll.
      • Wöchentlich: Wählen Sie die Wochen und die einzelnen Wochentage, an denen der Zeitplan ausgeführt werden soll.

        Wenn der Zeitplan beispielsweise alle zwei Wochen am Montag und Donnerstag ausgeführt werden soll, erhöhen Sie die Zahl in der Option Jede auf „2“ und aktivieren Sie die Kontrollkästchen „Montag“ und „Donnerstag“.

      • Monatlich: Wählen Sie eine der folgenden Optionen aus:
        • Tag: Wählen Sie den Tag des Monats, an dem der Zeitplan ausgeführt werden soll.
        • Am: Wählen Sie ein bestimmtes Vorkommen des Tages in den Monaten aus, in denen der Zeitplan ausgeführt werden soll.

          Wenn der Zeitplan beispielsweise immer am zweiten Donnerstag der Monate Januar, Mai und September ausgeführt werden soll, wählen Sie aus den gegebenen Optionen „Zweiter“, „Donnerstag“ sowie „Januar“, „Mai“ und „September“ aus.

        Anmerkung: Wenn die Sommerzeit aktiviert ist und das Anfangsdatum geplant ist, wird das Anfangsdatum in der Zeitzone angezeigt, zu der es gehört, und nicht gemäß der aktuellen Zeitzone des Nutzers. Nächstes Auftreten wird jedoch in der Zeitzone (Zeitzone im System des Nutzers) gemäß der Sommerzeit angezeigt.

        Für einen Zeitplan, der am 15. März in der Zeitzone GMT erstellt wurde, wird das Startdatum innerhalb der Zeitzone GMT als Mar-15th angezeigt. Wenn später die Sommerzeit aktiviert ist und Sie diesen Zeitplan im August in der Zeitzone BST bearbeiten oder anzeigen, wird das nächste Auftreten innerhalb der Zeitzone BST als August angezeigt.

        Wenn die Aufgabe beispielsweise über den Zeitraum vom 23.11.2023 9:00 Uhr bis 30.11.2023 9:00 Uhr mit der Häufigkeit „täglich“ ausgeführt werden soll, so wird die Aufgabe täglich ab dem 23.11.2023 um 09:00 Uhr ausgeführt, mit der letzten Ausführung der Aufgabe am 30.11.2023 um 09:00 Uhr.

    • Aktivieren Sie im Abschnitt Einstellungen verpasster Zeitplan das Kontrollkästchen Zeitplan erneut bereitstellen, um einen Zeitplan erneut bereitzustellen, der aufgrund einer Abschaltung des Control Rooms verpasst wurde.

      Wenn die Option Zeitplan erneut bereitstellen ausgewählt ist, werden Zeitpläne, die aufgrund einer Abschaltung des Control Rooms verpasst wurden, automatisch erneut bereitgestellt, nachdem der Control Room neu gestartet wurde. Außerdem wird ein Auditprotokolleintrag hinzugefügt, der als Ereignistyp Schedule misfired angibt.

      Anmerkung: Um eine erfolgreiche Bereitstellung zu gewährleisten, wenn Sie die Option Zeitplan erneut bereitstellen verwenden, müssen Sie den Kompilierungsdienst starten, bevor Sie die Control Room-Dienste neu starten.
  7. Klicken Sie auf Weiter.
  8. Verwenden Sie die Registerkarte Als Nutzer ausführen für Folgendes:
    • Wählen Sie die Nutzer aus der Liste Verfügbare „Als Nutzer ausführen“-Nutzer aus und klicken Sie auf den Pfeil nach unten, um Ihre Auswahl hinzuzufügen.

      Die von Ihnen ausgewählten Benutzer werden in der Tabelle Ausgewählt angezeigt. Mit dem Pfeil nach oben können Sie alle ausgewählten Benutzer entfernen.

      Anmerkung: Das System generiert einen Benutzer namens apitaskrunner, der mit der Rolle AAE_API Task Runner verknüpft ist, um den „Als Nutzer ausführen“-Kontext für API-Aufgaben einzurichten.
    • Wählen Sie im Feld Anzahl der zu verwendenden „Als Nutzer ausführen“-Nutzer festlegen eine der folgenden Möglichkeiten:
      • Alle „Als Nutzer ausführen“-Nutzer: Wählen Sie diese Option aus, um alle Nutzer, die in der Tabelle Ausgewählt verfügbar sind, als „Als Nutzer ausführen“-Nutzer anzugeben, während die API-Aufgabe ausgeführt wird.
      • Nutzerdefinierte Anzahl von „Als Nutzer ausführen“-Nutzern: Wählen Sie diese Option, um eine bestimmte Anzahl von Benutzern aus der Tabelle Ausgewählt anzugeben, die Sie als „Als Nutzer ausführen“-Nutzer verwenden möchten.

        Beispiel: Die Tabelle Ausgewählt enthält fünf Benutzer, und Sie möchten nur drei als „Als Nutzer ausführen“-Nutzer verwenden. Geben Sie 3 ein. Die drei Nutzer, die oben in der Tabelle aufgelistet sind, werden als „Als Nutzer ausführen“-Nutzer verwendet, während die API-Aufgabe ausgeführt wird.

  9. Klicken Sie auf Weiter.
  10. Optional: Auf der Registerkarte Allgemein können Sie die Standardeinstellungen für die folgenden Optionen ändern:
    • Aktivitätenname: Bearbeiten Sie den API-Aufgabe oder benennen Sie ihn um.
    • Automatisierungspriorität: Klicken Sie auf das Dropdown-Menü, um die Automatisierungspriorität festzulegen.

      Die Automatisierungspriorität ist standardmäßig auf Mittel eingestellt. Sie können sie jedoch ändern, damit die Automatisierungen entsprechend für die Bereitstellung verarbeitet werden.

  11. Klicken Sie auf Zeitplan erstellen.
    Die API-Aufgabe ist geplant. Sie können den Status der geplanten API-Aufgaben auf der Seite Managen > Geplant einsehen.