Studio-Benutzerhandbuch

Letzte Aktualisierung 17. Dez. 2024

Codierter Workflow

Codierte Workflows sind mit Low-Code-Workflows identisch, der einzige Unterschied besteht darin, dass Sie sie mit separaten Oberflächen erstellen:

Workflows haben eine visuelle Entwurfsoberfläche.
Codierte Workflows haben eine codebasierte Oberfläche.

Zudem können Sie codierte Workflows in Low-Code-Aktivitäten und -Workflows integrieren und einen hybriden Automatisierungsansatz verwenden. So können Sie die Vorteile codebasierter Automatisierung mit dem visuellen Entwerfen von Low-Code-Komponenten kombinieren.

Struktur

Codierte Automatisierungen verfügen über ein strukturiertes Design mit Namespaces, Hilfsklassen und Einstiegspunktmethoden. Das Framework codierter Automatisierungen ermöglicht es Ihnen, sie mit der Programmiersprache C# zu schreiben.

Folgen Sie der detaillierten Struktur einer codierten Automatisierung, wie in den folgenden Abschnitten beschrieben.

Wenn Sie eine codierte Automatisierung erstellen, wird automatisch ein Namespace mit dem Namen des Studio-Projekts generiert. Wenn Ihr Studio-Projekt beispielsweise „My project“ heißt, lautet der Namespace für alle codierten Automatisierungen „Myproject“.

Und wenn Sie eine codierte Automatisierung in einem Ordner in Ihrem Studio-Projekt erstellen, ist der Namespace der Name des Projekts und der Name des Ordners. Wenn Ihr Studio-Projekt beispielsweise „My project“ heißt und der Ordner „place“, dann ist der Namespace „Myproject.place“.

Automatisierungen mit codierten Workflows sowie codierten Testfällen verwenden die partielle Klasse CodedWorkflow aus dem Paket UiPath.CodedWorkflows. Diese Klasse gewährt der Automatisierung Zugriff auf die erforderlichen Schnittstellen für Dienste (entspricht Aktivitätspaketen), basierend auf den installierten Aktivitätspaketen in Ihrem Projekt.

Hinweis: Das Paket UiPath.CodedWorkflows ist automatisch enthalten, wenn Sie ein Aktivitätspaket importieren, das codierte Automatisierungen unterstützt, z. B. UiPath.System.Activities 23.10 oder höher.

`Codierter Workflow`

Codierte Automatisierungen erben die partielle Klasse CodedWorkflow und erstellen eine Beziehung des Typs CodedAutomationExample : CodedWorkflow. Das bedeutet, dass die Klasse CodedAutomationExample Attribute, Methoden und Funktionen von der Klasse CodedWorkflow erbt. Im Wesentlichen kann sie die Funktionen aufrufen und verwenden, die in der Klasse CodedWorkflow definiert sind, was eine Grundlage für die codierte Automatisierung bildet und es einfacher macht, darauf aufzubauen und das Verhalten der Automatisierung anzupassen.

Die Klasse CodedWorkflow wird als partielle Klasse deklariert, sodass Sie ihre Funktionen erweitern können, indem Sie die gleiche partielle Klasse CodedWorkflow in einer Codequelldatei definieren. So können Sie neue Felder und Methoden hinzufügen, um das Verhalten Ihrer codierten Automatisierungen weiter anzupassen. Mit diesem Ansatz können Sie eine Vor- und Nach-Schnittstelle speziell für codierte Testfälle implementieren.

Zudem erbt die partielle Klasse CodedWorkflow die Klasse CodedWorkflowBase.

`CodedWorkflowBase`

Die Klasse CodedWorkflowBase enthält die integrierten Funktionen, die eine codierte Automatisierung erbt. Diese Klasse enthält Methoden und spezifische Eigenschaften für die Verwaltung von Workflowinstanzen, den Runtime-Zugriff, die Verarbeitung von Dienstcontainern und die Konfiguration von Umgebungskontexten. Die Klasse CodedWorkflowBase bietet auch eine weitere separate Methode für die Protokollierung, die Sie selbst anpassen können.

Hinweis: Wählen Sie in den Code-Editor-Einstellungen die Option Quelldekompilierung aktivieren aus, um die Klasse CodedWorkflowBase anzuzeigen.

Sehen Sie sich die CodedWorkflowBase-Methoden in der folgenden Tabelle an:

Method	Beschreibung
`ICodedWorkflowServices services` Hinweis: Wir empfehlen Ihnen, die Methoden `Log`, `BuildClient` und `RunWorkflow` in der Klasse `services` und den dazugehörigen Diensten zu verwenden, anstatt sie als eigenständige, sofort verfügbare Methoden zu nutzen.	Bietet Zugriff auf die verfügbaren Dienste für codierte Workflows, z. B.: `OutputLoggerService`: Ermöglicht die Ausgabe von Protokollen mithilfe der `Log`-Methode. `OrchestratorClientService` (die `BuildClient`-Methode): Ermöglicht Ihnen die Aktivierung der Interaktion mit dem Orchestrator über die `BuildClient`-Methode. `WorkflowInvocationService`: Ermöglicht es Ihnen, andere Workflows mit der Methode `RunWorkflow` aufzurufen. `Container`: Der Container, in dem alle Dienste gespeichert sind. Ermöglicht Ihnen die Verwaltung von Ressourcen für codierte Workflows, wobei der automatische Import von Namespaces und Typen mit den `AutoImportedNamespaces`- und `AutoImportedTypes`-Methoden durchgeführt wird. Außerdem stellt er mit der `Resolve`-Methode eine Instanz eines bestimmten Dienstes bereit.
`serviceContainer(ICodedWorkflowServiceContainer)` Hinweis: Dies wurde durch `ICodedWorkflowServices services` ersetzt. Wenn Sie diese Syntax weiterhin verwenden, erhalten Sie eine Warnung, die Sie auf die Verwendung der neuen `services.Container`-Syntax verweist.	Bietet Zugriff auf den Container für die Abhängigkeitsinjektion, der für den aktuellen codierten Workflow spezifisch ist. Dieser Container, der als Dienstcontainer bezeichnet wird, ermöglicht es Ihnen, Instanzen von Diensten abzurufen, die darin registriert wurden.
`GetRunningJobInformation()`	Ruft Informationen über den aktuell ausgeführten Auftrag im Kontext des codierten Workflows ab. Die Methode greift auf die Eigenschaft `RunningJobInformation` des Objekts `executorRuntime` zu, die Informationen über Auftragsstatus, Fortschritt, Parameter und Zeitstempel enthält.
`Log(string message, LogLevel level` `= LogLevel.Info, IDictionary<string, object>additionalLogFields = null)`	Fügt zusätzliche Protokollfelder zu Protokollmeldungen mit angegebenen Attributen hinzu.
`RunWorkflow(string workflowFilePath,IDictionary<string, object> inputArguments = null,TimeSpan? timeout = null, bool isolated = false,InvokeTargetSession targetSession = InvokeTargetSession.Current)`	Stellt eine Struktur zum Ausführen eines Workflows im Kontext der angegebenen Workflow-Runtime bereit. Sie kann Parameter festlegen, eine potenzielle Isolierung verarbeiten und die Workflowausführung initiieren. Die zurückgegebene Aufgabe enthält die Ergebnisse des ausgeführten Workflows, einschließlich seiner Ausgabe und Eingabe-/Ausgabe-Argumente.
`RunWorkflowAsync(string workflowFilePath,IDictionary<string, object> inputArguments = null, TimeSpan?timeout = null, bool isolated = false,InvokeTargetSession targetSession = InvokeTargetSession.Current)`	Stellt eine Struktur zum asynchronen Ausführen eines Workflows im Kontext der angegebenen Workflow-Runtime bereit. Sie kann Parameter festlegen, eine potenzielle Isolierung verarbeiten und die Workflowausführung initiieren. Die zurückgegebene Aufgabe enthält die Ergebnisse des ausgeführten Workflows, einschließlich seiner Ausgabe und Eingabe-/Ausgabe-Argumente.
`DelayAsync(TimeSpan time)` und `DelayAsync(int delayMs)`	Hält die Ausführung asynchron für einen bestimmten Zeitraum an.
`Delay(TimeSpan time)` und `Delay(int delayMs)`	Hält die Ausführung für einen bestimmten Zeitraum an.
`HttpClient BuildClient(string scope = "Orchestrator", bool force = true)`	Erstellt einen HTTP-Client mit einem angegebenen Scope und Zugriffstoken.
`RegisterServices(ICodedWorkflowsServiceLocator serviceLocator)`	Registriert Dienste (Aktivitätspakete) im Dienst-Locator des codierten Workflows. Sie können dies überschreiben, wenn Sie benutzerdefinierte Dienste in den Container für die Abhängigkeitsinjektion einfügen möchten. Hier erfahren Sie, wie Sie benutzerdefinierte Dienste (codierte Aktivitätspakete) erstellen und verwenden.

Die Einstiegspunktmethode für codierte Workflows sowie codierte Testfälle heißt Execute() und wird entweder als Workflow oder TestCase zugeordnet. Sie können den Namen der Methode ändern, solange Sie ihn entweder Workflow oder TestCase zuordnen.

Sie können nur eine einzige Execute()-Methode ([TestCase] oder [Workflow]) innerhalb einer Datei verwenden, welche die Klasse Coded Workflow erbt.

In dieser Methode können Sie Eingabe- und/oder Ausgabeargumente hinzufügen, die In-, Out- oder In/Out-Argumenten in Low-Code-Automatisierungen entsprechen. Im Tutorial Arbeiten mit Eingabe- und Ausgabeargumenten erfahren Sie, wie Sie Argumente in codierten Automatisierungen verwenden.

Diese Einstiegspunktmethode dient als Startpunkt für die Ausführung der Automatisierungen. So lassen sich codierte Workflows und Testfälle aufgrund ihrer Execute()-Methode leicht als Einstiegspunkte identifizieren.