Wiederverwendbare Bots erstellen

Lesen Sie die Leitlinien, um besser zu verstehen, wie man Bots oder Teilaufgaben für die Wiederverwendbarkeit entwickelt, vom Entwurf und der Erstellung bis zur Wiederverwendung.

Definieren Sie Voraussetzungen, Eingabe, Ausgabe und Variablen
Wenn Sie Bots für die Wiederverwendbarkeit erstellen, definieren Sie Folgendes:
  • Dokumentieren Sie alle notwendigen Voraussetzungen für die Verwendung Ihres Bots entweder als eigenständige Aufgabe oder als Teilaufgabe.
  • Bei der Erstellung Ihrer Bots definieren Sie Werte als Eingabe, Ausgabe oder lokal. Eingabe- und Ausgabevariablen werden verwendet, wenn Ihr Bot als Unteraufgabe verwendet werden soll, so dass es Werte von oder zu einem anderen aufrufenden Bot empfangen und zurückgeben kann.
  • Geben Sie bei der Definition von Eingabe- und Ausgabevariablen aussagekräftige Variablenbeschreibungen an, damit andere Entwickler wissen, wie sie mit Ihrer Unteraufgabe interagieren können.
  • Befolgen Sie einen etablierten Standard für die Benennung von Variablen. Überprüfen Sie die nutzerdefinierten Variablen von Automation Anywhere auf Richtlinien zur Benennung von Variablen. Ihre Variablen (benutzerdefiniert)
Befolgen Sie das Prinzip der Alleinverantwortung
Bots, die mit dem Ziel der Wiederverwendbarkeit entwickelt werden, sollten dem Prinzip der Alleinverantwortung folgen, das besagt, dass jede Teilaufgabe oder Komponente nur für einen einzigen Teil der Funktionalität des gesamten Bots verantwortlich sein sollte und dass diese Verantwortung vollständig von dieser Unteraufgabe oder Komponente gekapselt sein sollte.

Weitere Beispiele für Alleinverantwortung:

  • Eine Unteraufgabe, die eine einzelne Transaktion verarbeitet, aber für jede Transaktion auf einer Liste mehrfach aufgerufen werden kann.
  • Eine Unteraufgabe, die Daten für die Bildschirmanzeige auf einer einzigen Seite einer Website sammelt, kann jedoch mehrfach aufgerufen werden, wenn ein Bot durch die Seitennavigation läuft.
Erwägungen beim Bot-Design
Beachten Sie die folgenden Muster, auf deren Grundlage Vorlagen für die Verwendung entwickelt werden müssen:
  1. Primär-, Haupt- und Unter-Bots
    • Primär-Bot: Dieser Bot wird direkt aufgerufen, um den Prozess zu beginnen, durch Mechanismen wie die Zeitplanung durch den Control Room oder API-Aufruf. Fügen Sie die folgenden wichtigen Prozessschritte in den Abschnitt VERSUCHEN ein:
      1. Erstmalige Einrichtung des Prozesses.
      2. Validierung, dass die Einrichtung erfolgreich war. Prüfen Sie zum Beispiel, ob alle erforderlichen Dateien und Ordner vorhanden sind oder ob die Werte der Anfangsvariablen wie gewünscht ausgefüllt sind.
      3. Führen Sie die VORBEREITUNG des Desktops durch.
      4. Rufen Sie den Haupt-Bot auf, um die Geschäftslogik des Prozesses auszuführen.

      Im Abschnitt Abschluss führen Sie die NACHBEREINIGUNG des Desktops aus.

    • Haupt-Bot: Dieser Bot ruft die Unter-Bots nach Bedarf auf, um die Geschäftslogik des Prozesses auszuführen. Fügen Sie die folgenden wichtigen Prozessschritte in den Abschnitt VERSUCHEN ein:
      1. Validierung einer beliebigen Eingabe. Geben Sie zum Beispiel Variablenwerte aus dem Primär-Bot ein.
      2. Ausführung von Unter-Bots.
      3. Validierung jeder Ausgabe.
      4. Stellen Sie sicher, dass alle Werte der Ausgabevariablen, die auf der Ausführung des Haupt-Bots basieren, an den Primär-Bot zurückgegeben werden.

      Im Abschnitt ERFASSEN protokollieren Sie den Fehler und stellen Sie sicher, dass alle Werte der Ausgabevariablen, z. B. oStrResult, an den Primär-Bot zurückgegeben werden.

    • Unter-Bots
      • Ein Unter-Bot wird vom Primär-Bot oder Haupt-Bot aufgerufen, um die eigentliche Geschäftslogik auszuführen, die für die Automatisierung erforderlich ist. Sie werden auch als Helferaufgaben oder Dienstprogrammaufgaben bezeichnet, da ihr einziger Zweck darin besteht, beim Aufruf von Aufgaben zu helfen.
      • Verwenden Sie Ausgabevariablen, um einen Ergebnisindikator an den aufrufenden Bot entweder Main- oder einen anderen Unter-Bot zurückzugeben. Zum Beispiel: outStrResult. Der Wert enthält eine Fehlermeldung, wenn die Verarbeitung aufgrund eines Fehlers oder einer aufgetretenen Ausnahme nicht erfolgreich war.
  2. Haupt- und Unter-Bots: Dieses Muster beinhaltet den Primär- und den Haupt-Bot in einem einzigen Haupt-Bot. Das Entwurfsmuster des Unter-Bots ist dem oben erläuterten Entwurfsmuster ähnlich.
Eröffnung und Abschluss von Anwendungen
Alle Anwendungen, Dateien oder Fenster, die ein Bot oder eine Unteraufgabe öffnet, müssen durch denselben Bot oder dieselbe Unteraufgabe geschlossen werden.
  • Wenn ein Bot beispielsweise Microsoft Excel öffnet, um eine Tabellenkalkulation auszuführen, stellen Sie sicher, dass die Tabellenkalkulation und Excel geschlossen werden, wenn der Bot die Verarbeitung beendet.
  • Schließen Sie Anwendungen, wenn die Bot-Ausführung erfolgreich oder nicht erfolgreich ist.
  • Verwenden Sie den Block Abschluss der Operation Versuchen/Erfassen/Abschluss, um sicherzustellen, dass Anwendungen unabhängig vom Erfolg der Aufgabenbearbeitung geschlossen werden.
  • Falls die Anwendungen während der Tests nicht reagieren, sollten Sie die Befehlszeile verwenden, um die Anwendungen zwangsweise zu schließen (zu terminieren). Um z. B. Power Point zwangsweise zu schließen, lautet der Befehlszeilenbefehl:
    Taskkill /IM powerpnt.exe /F
Fehlerbehandlung
Überprüfen Sie nach Abschluss der Aufgabe, ob der Bot alle Fehler oder Ausnahmen erfolgreich behandelt.
  • Jede Aufgabe oder Unteraufgabe muss ihre eigenen Fehler behandeln.
  • Eine unbehandelte Ausnahme in einer Unteraufgabe kann zu Problemen in einer übergeordneten Aufgabe führen.
  • Verwenden Sie Versuchen/Erfassen/Abschluss-Blöcke auf der Stammebene eines jeden Bots.
  • Verwenden Sie Versuchen/Erfassen-Blöcke innerhalb einer Schleife, wenn Sie eine Operation mehrmals versuchen wollen, bevor Sie einen Fehler melden.
Behandeln von Ereignissen oder Ausnahmen
Abgesehen von Aktionsfehlern, die von Versuchen/Erfassen abgerufen werden, müssen Sie Codeprüfungen für andere Prozesse wie Ereignisse oder Ausnahmen durchführen. Wenn eine bestimmte Prozessbedingung auftritt, benachrichtigen oder protokollieren Sie diese Bedingungen für zusätzliche Analysen.
  • Entwickeln Sie einen konfigurierbaren Ereignis-Handler-TaskBot, der den Bedarf an Codeänderungen minimiert, wenn sich die Aktionen ändern. Pflegen Sie z. B. eine XML-Datei, die eine Definition aller möglichen Ereignisse oder Ausnahmen und alle Benachrichtigungsanforderungen beim Auftreten dieser Ereignisse oder Ausnahmen enthält.
  • Wenn im Code solche Ereignisse oder Ausnahmen auftreten, schreiben Sie die Informationen in ein Ereignisprotokoll. Sie können auch die Speichernutzung hinzufügen und einen Screenshot erstellen.
  • Führen Sie den Ereignis-Handler-TaskBot aus, um das Ereignis oder die Ausnahme zu verarbeiten. Geben Sie zum Beispiel eine Benachrichtigung mit Parametern wie E-Mail-Empfänger, CC-Empfänger oder Betreff aus der XML-Datei aus.
  • Wenn die Benachrichtigungsanforderungen für jede Umgebung variieren oder sich im Laufe der Zeit ändern, kann die Konfigurationsdatei aktualisiert werden, ohne dass der Code geändert werden muss.
Ausführen von Bots auf anderen Computern
Wenn Sie einen Bot entwerfen, ermöglichen Sie die Ausführung auf anderen Computern als dem Computer, auf dem der Bot erstellt wurde.
  • Verwenden Sie Variablen für lokale Dateipfade, Netzwerkfreigaben oder Fenstertitel, damit Ihr Bot von anderen Rechnern aus erfolgreich ausgeführt werden kann.
  • Erwägen Sie die Verwendung globaler Werte für Umgebungsmarkierungen oder Netzwerkfreigaben, auf die mehrere Bots Zugriff benötigen.
  • Verwenden Sie gegebenenfalls Platzhalterzeichen für Fenstertitel, damit Bots unabhängig von der spezifischen Umgebung oder Version der Zielanwendung ausgeführt werden können. Verwenden Sie zum Beispiel anstelle von
    Salesforce - Professional Edition - Internet Explorer
    das Folgende:
    Salesforce - * - Internet Explorer
Verwenden von Eingabeaufforderungen, Nachrichtenfeldern und Endlosschleifen
Eingabeaufforderungen und Nachrichtenfeld-Aktionen stoppen die Ausführung der Bots, wenn sie auf eine Nutzereingabe warten. Sofern keine Nutzereingabe erforderlich ist, sollten Sie die Bots ohne Eingabeaufforderung-Anweisungen gestalten.
  • Wenn Sie Schleifen verwenden, stellen Sie sicher, dass alle Schleifen ein definitives Ende haben, indem Sie die Anzahl der Iterationen klar definieren oder angeben, wo Schleifenabbrüche stattfinden müssen.
  • Wenn Ihr Bot als unbeaufsichtigter Bot laufen soll, entfernen oder deaktivieren Sie alle Eingabeaufforderungen oder Nachrichtenfelder.
  • Wenn Sie Bots für ein beaufsichtigtes Automatisierungsszenario erstellen, sind Nachrichtenfelder und Eingabeaufforderungen oft sinnvoll oder erforderlich, damit Bots wie erwartet laufen. Verwenden Sie Nachrichtenfelder, um verschiedene Variablen anzuzeigen, z. B. Antworten, Ausgaben oder Werte.
Speichern sensibler Daten im Credential Vault
Der Control Room umfasst den Credential Vault, der zum Speichern sensibler Daten wie Nutzernamen, Kennwörter, API-Schlüssel und Token verwendet werden kann.
  • Wenn Sie einen Bot erstellen, erstellen Sie einen Locker im Control Room unter Verwendung des Credential Vault, um Anmeldeinformationen zu speichern und sie bei Bedarf abzurufen, indem Sie auf die Anmeldeinformation und das Attribut verweisen. So können Nutzer Bots erstellen, die APIs nutzen oder Anmeldungen durchführen, ohne dass Bot-Ersteller die erforderlichen Anmeldedaten direkt in einem Bot hart codieren müssen.
  • Codieren Sie keine sensiblen Anmeldeinformationen in einen Bot oder einer Unteraufgabe, da die fest codierte Speicherung in einem Bot ein Sicherheitsrisiko darstellt.
  • Wenn Credential Vault-Werte in einem Bot verwendet werden müssen, vergewissern Sie sich, dass alle Locker-Namen und -Anmeldedaten in der Bot-Dokumentation eindeutig definiert sind. Geben Sie bei Bedarf an, wie Sie Anmeldedaten erhalten können, z. B. einen API-Schlüssel oder ein Token.
Prüfen unabhängiger Aufgaben
Wenn Sie Bots für die Wiederverwendbarkeit erstellen, gestalten Sie sie so, dass sie unabhängig von anderen Unteraufgaben getestet werden können.
  • Nutzen Sie den Ansatz des Test-Driven-Development (TDD): Wenn Sie einen neuen Bot oder eine neue Funktion in einer Anwendung hinzufügen, schreiben Sie einen Testfall dafür.
  • Definieren Sie in einem Testfall die spezifische Funktion, die diese Funktion oder diese Funktionalität validiert.
  • Um das Prinzip der Alleinverantwortung und die Wiederverwendbarkeit zu gewährleisten, sollten Sie viele kleinere Aufgaben erstellen, die unabhängig voneinander getestet werden können.
Verwenden von Kommentaren und Schritten
Mit Hilfe von Kommentaren können Entwickler in ihren Bots Beschreibungen zur Verfügung stellen, so dass andere Bot-Entwickler besser verstehen können, wofür die einzelnen Abschnitte, Codeblöcke oder Unteraufgaben gedacht sind. Fügen Sie klare Kommentare hinzu, damit die Entwickler den Zweck der Funktion eines bestimmten Codeblocks verstehen können.
  • Wenn Bots an den Bot Store übermittelt werden, wird durch Kommentare vermittelt, wie der Bot angepasst werden kann.
  • Die Verwendung von Kommentaren erleichtert die Wartung des Codes, da die Abschnittsbeschreibungen dabei helfen, festzustellen, wo Änderungen erforderlich sein könnten, damit die Entwickler eine schnellere Problemlösung anstreben können.
  • Kommentare zu Bots, die in Arbeit sind, können bei der Erstellung von Platzhaltern für zukünftige Arbeiten hilfreich sein. Erwägen Sie die Verwendung eines TODO-Befehls als Erinnerung daran, die Logik in den Bot einzufügen, aber aktualisieren Sie die Kommentare, wenn die Arbeit abgeschlossen ist.
  • Automation 360 enthält die Schritt-Aktion, die die Möglichkeit bietet, den Code in logische Gruppen einzuteilen, um die Lesbarkeit und den Ablauf zu verbessern.
  • Erstellen Sie eine Übersicht über die wichtigsten Ziele Ihres Bots, indem Sie leere, gelabelte Schritt-Aktionen verwenden. Wenn das erledigt ist, gehen Sie zu jedem Schritt zurück und vervollständigen die Logik für den Schritt.
Erstellen von Protokollierungsdateien
Die Identifizierung von Problemen ohne Protokolle kann schwierig sein, wenn Bots auf einer beliebigen Anzahl von Bot Runnern unbeaufsichtigt laufen. Softwareentwickler, Support-Teams und Bot-Eigentümer sind auf Protokolle angewiesen, um zu verstehen, wo bei ihren Automatisierungen Probleme auftreten und wie sie diese diagnostizieren können. Bots müssen Fehler protokollieren, um Fehlerdetails zu erhalten.
  • Nutzen Sie die Fehlerbehandlung und Bildschirmaufzeichnungen, um besser zu verstehen, wann ein Bot oder eine Unteraufgabe auf einen Fehler stößt.
  • Verwenden Sie die Vorlage A2019 aus dem Bot Store, die grundlegende Funktionen für Fehlerbehandlung, Protokollierung und Momentaufnahmen mit dem anpassbaren Stammverzeichnis für die Pflege älterer Protokolldateien enthält.

    Bot Store bot template

  • Erstellen Sie bei Bedarf zusätzliche Protokolldateien, die einen vollständigen Prüfungsverlauf für alle Vorgänge eines Bots oder einer Unteraufgabe enthalten. Die zusätzlichen Protokolldateien können Audit-, Fehlerbehebungs- und Leistungsinformationen über den Bot sowie die folgenden Informationen enthalten:
    • Start- und Endzeit des Haupt-Bots.
    • Start- und Endzeit der Unteraufgabe.
    • Der Zeitpunkt der Fertigstellung bestimmter Meilensteine, die im Bot definiert sind.
    • Anzahl der in einer Eingabedatei empfangenen Transaktionen.
    • Anzahl der erfolgreich verarbeiteten oder fehlgeschlagenen Transaktionen.
See also: Best practices: Building reusable and secure Automation 360 bots and packages