Über die Workflow-Analyse

Die Workflow-Analyse ist eine statische Codeanalyse, die sicherstellt, dass Ihr Projekt hohe Qualitäts- und Zuverlässigkeitsstandards erfüllt. Eine statische Codeanalyse überprüft, ob Inkonsistenzen bestehen, ohne das Projekt tatsächlich auszuführen, im Gegensatz zu dynamischen Analysen, die während der Ausführung erfolgen.

Workflow Analyzer uses a set of rules to check for various inconsistencies unrelated to project execution. The rules are based on Automation Best Practices and take into consideration variable and argument naming, empty sequences or workflows, package restrictions, and so on. The analyzer does not identify errors in execution or compilation.

Die Option ist auf der Menüband-Registerkarte Design sowie den Schaltflächen Datei analysieren und Projekt analysieren verfügbar. Die erste führt eine Analyse der Datei durch, die gerade im Panel Designer fokussiert ist, während die zweite alle Dateien im Automatisierungsprojekt analysiert.

Studio comes with a set of built-in rules, identifiable by the ST- prefix. The UIAutomation.Activities, Excel.Activities, Testing Activities, and Mail.Activities also have their own rules, identifiable by the prefix.

Sie können auch benutzerdefinierte Regeln erstellen. Weitere Informationen finden Sie unter Erstellen von Workflow-Analyse-Regeln im Entwicklerhandbuch.

Hinweis:

Die integrierten Studio-Regeln können nicht auf ältere Studio-Versionen portiert werden. Regeln aus kompatiblen Aktivitätspaketen können jedoch in älteren Studio-Versionen verwendet werden, in denen die Workflow-Analyse enthalten ist.

Namenskonvention für Regeln

Each rule has an ID, name, description, and recommendation. The ID contains the origin, category, and number. For example, Variables Naming Convention has the ST-NMG-001 ID:

• ST gibt an, dass die Regel in Studio integriert ist.

• NMG - shows that the rule is part of the Naming Rules category. Rules part of Project Anatomy Rules category have the ANA abbreviation, those part of Design Best Practices the DBP, and so on.

• 001 ist die Nummer der Regel.

  

Umfang

Jede Regel hat einen Anwendungsbereich, für den sie gilt:

• Activity: The rules are enforced at activity level, checking variables, arguments, properties. Variables Naming Convention is one such rule.
• Workflow: Rules perform checks in a single project file, for example Unused Variables.
• Projekt: Überprüfungen werden auf Projektebene durchgeführt.

Aktion

Regeln verfügen über eine Reihe von Aktionen, die festgelegt werden können:

• Fehler: Generiert einen Fehler im Panel Fehlerliste.
• Warnung: Generiert eine Warnung im Panel Fehlerliste.
• Info: Generiert eine Meldung im Panel Fehlerliste.
• Ausführlich: Erstellt große Protokolldateien.

Check the Logging Levels page to learn more about logging with Studio.

Verwalten von Regeln

Das Projekt oder die Datei wird basierend auf der Grundlage von Regeln analysiert, die im Fenster Projekteinstellungen verfügbar sind:

• Klicken Sie im Panel Projekt auf das Symbol , und wählen Sie dann Workflow-Analyse aus.
• Klicken Sie im Menüband auf die Schaltfläche Datei analysieren, und wählen Sie dann in der Dropdownliste Einstellungen für Workflow-Analyse aus.

Regeln können nach Scope und Aktion gefiltert werden. Deaktivieren Sie das Kontrollkästchen neben den einzelnen Regeln, um eine projektspezifische Konfiguration zu definieren. Standardmäßig werden Regeln nach Code im Fenster angeordnet, und aktivierte Regeln werden zuerst angezeigt.

Auf Standardwert zurücksetzen

Nachdem Änderungen an den Standardwerten von Regeln vorgenommen wurden, sei es Regex oder Schwellenwerte, können die Werte auf den Standardwert zurückgesetzt werden, indem Sie mit der rechten Maustaste auf die Regel klicken und dann Standard zurücksetzen auswählen.

Validierung

Die Validierung der Datei oder des Projekts wird bei jedem Auslösen der Workflow-Analyse durchgeführt. Validierungsoptionen sind auf der Menüband-Schaltfläche Datei analysieren verfügbar, Datei validieren und Projekt validieren.

Diese Aktion prüft, ob Variablen, Argumente, Ausdrücke und Importe richtig konfiguriert sind. Die Aktion Datei validieren kann mit der Taste F8 ausgelöst werden, und Projekt validieren mit Umschalt+F8. Die Validierung kann jederzeit abgebrochen werden.

Die Datei(en), die Fehler enthalten, werden im Panel Projekt mit einem roten Punkt markiert, und die Fehler werden in den Panels Fehlerliste und Ausgabe angezeigt.

Wenn Sie im Fehlerlistenbereich auf ein Element doppelklicken, wird die .xaml geöffnet und das Element hervorgehoben, das den Fehler ausgelöst hat, unabhängig davon, ob es sich um eine Aktivität, ein Argument oder eine Variable handelt.

Wenn nicht alle .xaml-Dateien validiert sind, kann das Projekt nicht gedebuggt, ausgeführt oder veröffentlicht werden. Haltepunktbedingungen werden nicht ausgewertet.

Verwalten von Fehlern

Wenn sie ausgelöst wird, prüft die Workflow-Analyse das Projekt oder die Datei anhand des konfigurierten Regelsatzes und protokolliert die gefundenen Fehler entsprechend der Regelaktion im Panel Fehlerliste.

Das Panel Fehlerliste filtert Elemente nach Fehlern, Warnungen und Meldungen. Das Dropdownmenü „Scope“ ist nützlich, um Fehler nach Projekt, aktueller Datei oder einer bestimmten Datei in der Automatisierung zu filtern. Zusätzlich können Elemente nach Regel-ID gefiltert werden.

Klicken Sie auf eine gefundene Warnung oder einen Fehler, um die Empfehlung der Regel und einen Link zur Dokumentationsseite für die jeweilige Regel anzuzeigen.

Zusätzlich zu Regelverletzungen zeigt der Fehlerlistenbereich auch Fehler an, die bei der Ausführung der Workflow-Analyse auftreten können. Wenn die Workflow-Analyse oder eine der konfigurierten Regeln nicht ausgeführt werden kann, wird ein Fehler mit Details zur Fehlerursache in der Beschreibung protokolliert.

Unterstützung der Befehlszeile

Die Benutzeroberfläche der UiPath.Studio.CommandLine.exe-Befehlszeile enthält eine Reihe von Parametern, um Dateien oder Projekte anhand bestimmter Regeln zu prüfen, auch in CI/CD-Pipeline-Konfigurationen.

UiPath.Studio.CommandLine.exe ist im Installationsordner verfügbar:

• Bei Installationen pro Maschine ist der Standardpfad %ProgramFiles%\UiPath\Studio\
• Bei Installationen pro Benutzer ist der Standardpfad %LocalAppData%\Programs\UiPath\Studio

Hinweis:

UiPath.Studio.CommandLine.exe erfordert keine Studio-Lizenz.

Regeln konfigurieren

Standardmäßig sind alle Workflow-Analyse-Regeln bei der Installation von Studio mit Ausnahme der folgenden Optionen aktiviert:

• Standardwerte für Argumente
• Nicht definierte Ausgabeeigenschaften

Sie können Regeln konfigurieren:

• Aktivieren oder deaktivieren Sie im Fenster „Einstellungen für Workflow-Analyse“ Regeln, indem Sie auf das Kontrollkästchen neben den einzelnen Regeln klicken.
• From the RuleConfig.json file, path %LocalAppData%\UiPath\Rules. Find a specific rule, modify its parameter, change the IsEnabled parameter to false to disable the rule. Optionally, if the path is not accessible, you can place the RuleConfig.json file in a custom location and include the path to the file in the command. For more information, see Analyze Files and Projects.

Die Regeln sind nach ihrer eindeutigen ID organisiert, die auch in den Einstellungen für die Workflow-Analyse sichtbar ist.

For example, in the image below only the Variables Naming Convention rule was enabled and received the ([A-Z]) Regex expression. This means that variable names must be uppercase. All the other rules were disabled in this example.

Analysieren von Dateien und Projekten

Nachdem Sie die Regeln konfiguriert haben, greifen Sie auf die Benutzeroberfläche der UiPath.Studio.CommandLine.exe-Befehlszeilen zu.

Die folgenden Workflow-Analyse-Befehle sind verfügbar:

• analyze: Analysiert das gesamte Projekt. Der Pfad zur Datei project.json.
• analyze-file: Analysiert eine einzelne Datei. Der Pfad zur Datei .xaml.

Die folgenden Argumente sind für Workflow-Analyse-Befehle möglich:

Argument	Beschreibung
-p, --project-path	Zum Analysieren einer Datei geben Sie den Pfad zur .xaml-Datei an. Zum Analysieren des gesamten Projekts geben Sie den Pfad zur project.json-Datei an.
-c, --config-path	Der Pfad zur RuleConfig.json-Datei. Geben Sie diesen Pfad nur an, wenn die Regelkonfigurationsdatei nicht am Standardspeicherort platziert wird (%LocalAppData%\UiPath\Rules).
--help	Die für jeden Befehl verfügbaren Argumente anzeigen.
--version	Die Version von UiPath.Studio.CommandLine.exe überprüfen.

Der Befehl UiPath.Studio.CommandLine.exe analyze-file -p "C:\BlankProcess\Main.xaml" analysiert z. B. nur eine Datei in einem Projekt, Main.xaml. Die Ausgabe des Befehls gibt ein json-codiertes Wörterbuch mit den folgenden Informationen für jede Regelverletzung zurück:

• FilePath: Der Pfad zur analysierten Datei.

• ErrorCode : Die Regel-ID.

• ActivityDisplayName: Der Anzeigename der Aktivität (null falls nicht zutreffend).

• Item: Der Name und der Typ des Elements (z. B. Aktivität oder Variable), in dem die Fehlermeldung generiert wurde.

• ErrorSeverity: Der Wert des Parameters DefaultAction, der die konfigurierte Protokollmeldung für jede Regel ist, entweder „Warnung“, „Fehler“, „Info“ oder „Ausführlich“.

• Description: Die Beschreibung der Regel.

• Recommendation und URL: Die empfohlenen Änderungen zur Lösung des Problems, zusammen mit dem Link zur Dokumentation mit weiteren Informationen.

  

Um eine RuleConfig.json-Datei zu verwenden, die an einem benutzerdefinierten Speicherort abgelegt wird, fügen Sie dem Befehl den Speicherort hinzu. Um den vorherigen Befehl als Beispiel zu verwenden, um Regeln mit der Datei zu konfigurieren, die sich in C:\CustomFolder\RuleConfig.json befindet, führen Sie den Befehl wie folgt aus: UiPath.Studio.CommandLine.exe analyze-file -c "C:\CustomFolder\RuleConfig.json" -p "C:\BlankProcess\Main.xaml".

Um den Exitcode des Befehls zurückzugeben, führen Sie echo %errorlevel% aus, nachdem Sie den Befehl ausgeführt haben. Wenn keine Meldungen mit dem Fehler ErrorSeverity vorhanden sind, wird der Code 0 zurückgegeben. Andernfalls wird 1 zurückgegeben.

Bitte beachten Sie, dass einige der Einträge möglicherweise nicht mit einer Regel verknüpft sind, sondern Fehler sein können, die von der Workflow-Analyse generiert werden. Beispielsweise wird bei einer leeren .xaml-Datei ein Fehler angezeigt.

Die als Präfix für einen Eintrag verwendeten Globally Unique Identifier (GUID) werden bei jeder Ausführung generiert und gelten nur für das aktuelle Ergebnis.

Exportieren von Workflow-Analyse-Ergebnissen

Um Studio so zu konfigurieren, dass die Ergebnisse jeder Workflow-Analyse in den Projektordner exportiert werden, gehen Sie zu Studio Backstage-Ansicht > Einstellungen > Design und aktivieren Sie die Option Analyzer-Ergebnisse exportieren.

Wenn diese Option aktiviert ist, werden die Ergebnisse jeder Workflowanalyse im Unterordner \.local\.analysis\ des Projektordners in einer Datei gespeichert, die mit dem Zeitstempel der Analyse benannt ist, gefolgt von project_analysis_results.json (wenn die Option Projekt analysieren verwendet wird) oder file_analysis_results.json (wenn die Option Datei analysieren verwendet wird).

Hinweis:

Der Ordner .local ist ausgeblendet. Sie können die Anzeige ausgeblendeter Elemente in den Einstellungen von Windows-Explorer aktivieren.

Die Datei enthält die folgenden Informationen zu jeder aktivierten Regel:

• RuleId: die Regel-ID.
• RuleName: Name der Regel.
• Parameters: Die anpassbaren Parameter in der Regel, falls zutreffend.
• Severity – Die Regelaktion, wenn die Regel verletzt wird.
• ErrorsDescription: Eine Liste der Fehlermeldungen, die ggf. von der Regel generiert werden.

Erzwingen der Workflow-Analyse vor der Ausführung oder Veröffentlichung

You can prevent the execution and/or publishing of projects that contain Workflow Analyzer errors by enabling the following options from Studio Backstage View > Settings > Design:

• Analyse vor Ausführung erzwingen – Jedes Mal, wenn eine Datei oder ein Projekt ausgeführt/debuggt wird, überprüft die Workflow-Analyse alle Regeln mit der Aktion Error und nur wenn keine Fehler gefunden werden, ist die Ausführung zulässig.
• Analyse vor Veröffentlichung erzwingen – Jedes Mal, wenn die Veröffentlichung initiiert wird, überprüft die Workflow-Analyse alle aktivierten Regeln unabhängig von ihrer Aktion, und nur, wenn keine Regelverletzungen mit der Aktion Error vorhanden sind, ist die Veröffentlichung zulässig.

Wenn „Analyse vor Veröffentlichung erzwingen“ aktiviert ist und die Veröffentlichung erfolgreich ist (es treten keine Regelverletzungen mit der Aktion Error auf), werden die Ergebnisse der Workflowanalyse in das veröffentlichte .nupkg-Paket in der Datei project_analysis_results.json gespeichert in \lib\net45\.analysis\ eingefügt. Die Datei enthält die folgenden Informationen zu jeder aktivierten Regel:

• RuleId: die Regel-ID.
• RuleName: Name der Regel.
• Parameters: Die anpassbaren Parameter in der Regel, falls zutreffend.
• Severity – Die Regelaktion (wenn die Regel verletzt wird).
• ErrorsDescription: Eine Liste der Fehlermeldungen, die ggf. von der Regel generiert werden.