Abonnieren

UiPath Studio

UiPath Studio-Anleitung

Ü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.

11191119

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. UIAutomation.Activities also has a set of its own rules, identifiable by the UI- prefix.

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.
808808

Verwalten von Regeln

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

  • In the Project panel, click the settings_iconsettings_icon icon, then select Workflow Analyzer.
  • 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 jeder Regel, um eine für Ihr Projekt spezifische Konfiguration zu definieren.

10681068

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.

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.

997997

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.

Durch Doppelklicken auf ein Element im Panel Fehlerliste in der Fehlerliste wird die .xaml-Datei geöffnet und die Aktivität hervorgehoben, die den Fehler ausgelöst hat.

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.

10681068

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.

11801180

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.

Wenn Sie einen Prozess validieren oder analysieren, der Aktivitäten aus ungelösten Abhängigkeiten enthält, wird im Bereich Fehlerliste der gefundene Fehler zusammen mit einer Empfehlung und einem Link zur Dokumentation angezeigt.

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:

  • Der Pfad für die Windows Installer-Version (.msi) von Studio lautet standardmäßig C:\Program Files (x86)\UiPath\Studio\.
  • Wenn Studio im Benutzermodus (.exe) installiert wurde, ist der Standardpfad %LocalAppData%\UiPath\[Studio_version]\.

Regeln konfigurieren

Standardmäßig sind bei der Installation von Studio alle Regeln der Workflow-Analyse aktiviert. Konfigurieren von Regeln direkt in Studio:

  • Aktivieren oder deaktivieren Sie im Fenster „Einstellungen für Workflow-Analyse“ Regeln, indem Sie auf das Kontrollkästchen neben den einzelnen Regeln klicken.
  • Pfad %LocalAppData%\UiPath\Rules in der Datei RuleConfig.json. Suchen Sie eine bestimmte Regel, ändern Sie deren Parameter, ändern Sie den Parameter IsEnabled in false, um die Regel zu deaktivieren.

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.

625625

Analysieren von Dateien und Projekten

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

Folgende Befehle der Workflow-Analyse sind vorhanden:

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

Im obigen Beispiel prüft der folgende Befehl analyze -p "C:\Users\username\Documents\UiPath\BlankProcess\Main.xaml", ob die Variablennamen in einer .xaml-Datei in Großbuchstaben vorliegen.

10991099

Die Ausgabe des obigen Befehls gibt ein .json-codiertes Wörterbuch mit folgender Art von Informationen zurück:

  • ErrorCode : Die Regel-ID.
  • 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.
  • FilePath: Der Pfad zur analysierten Datei.

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.

Aktualisiert vor 2 Jahren


Über die Workflow-Analyse


Auf API-Referenzseiten sind Änderungsvorschläge beschränkt

Sie können nur Änderungen an dem Textkörperinhalt von Markdown, aber nicht an der API-Spezifikation vorschlagen.