Governance

Hinweis: Auf dieser Seite wird das dateibasierte Governance-Modell für Studio dokumentiert. Informationen zum Bereitstellen von Richtlinien aus Automation Ops finden Sie im Handbuch zu Automation Ops.

Um sicherzustellen, dass Studio-Benutzer die Development-Standards und bestimmte Regeln einhalten, können Organisationen Governance-Richtlinien erzwingen, die Studio-Funktionalitäten steuern.

Sie können Governance-Richtlinien auf eine der folgenden Arten durchsetzen:

• Erstellen und Bereitstellen von Richtlinien aus Automation Ops, einer benutzerfreundlichen Webanwendung.
• Verwenden Sie ein dateibasiertes Governance-Modell, das darin besteht, eine JSON-Richtliniendatei zu erstellen und die Datei lokal, extern oder über den Orchestrator bereitzustellen.

Die aktuellen Funktionen sind:

• verschiedene Richtlinien pro Studio-Profil erzwingen
• Einschränken der Verwendung von Paketfeeds aus dem Fenster Pakete verwalten und Backstage-Ansicht > Einstellungen > Quellen verwalten.
• Erzwingen von Organisationsentwicklungsstandards mithilfe von Workflow-Analyse-Regeln.
• Design- und Standorteinstellungen erzwingen und mehrere Einstellungen konfigurieren, die in Studio nicht verfügbar sind
• Aktivieren Sie das Senden von Studio-Nutzungsdaten an Ihre Organisation.
• Verwendung bestimmter Repositorys für GIT Source Control erzwingen

Im folgenden Video finden Sie einen Überblick über die in Studio verfügbaren Governance-Funktionen und eine Demo zur Verwendung in StudioX.

Um eine Governance-Richtlinie zu erzwingen, müssen Sie zunächst in Studio eine Governance-Datei generieren, dann konfigurieren Sie die Datei mit den darin enthaltenen Parametern und wenden die Richtlinie nach einer der folgenden Möglichkeiten an:

• Verwenden einer lokalen Datei (zu Testzwecken) – Platzieren Sie die Governance-Datei im Roaming-Ordner auf der Maschine, auf der Studio installiert ist.
• Verwenden einer externen Datei (für große Bereitstellungen) – Platzieren Sie die Governance-Datei in einem Pfad (z. B. einem HTTP/HTTPS-Server), auf den entweder ein Registrierungsschlüssel oder ein Asset in Orchestrator verweisen.
• Verwenden eines Assets in Orchestrator – Kopieren Sie den Inhalt der Governance-Datei in ein Asset in Orchestrator.

Governance-Datei generieren

Der erste Schritt bei der Durchsetzung von Entwicklungsstandards in Ihrer Organisation besteht darin, eine Governance-Datei aus Studio zu generieren oder manuell eine ähnliche Datei zu erstellen, die alle oder einen Teil der oben aufgeführten Funktionen enthält.

Wichtig: Die Governance-Datei muss den Typ .config mit dem folgenden Namen aufweisen: uipath.policies.config.

Um eine Governance-Datei mit Ihrer aktuellen Konfiguration aus Studio zu generieren, wechseln Sie zur Registerkarte „Backstage-Ansicht“ > „Hilfe“, und wählen Sie Governance-Datei generieren aus. Die exportierte Datei kann im gesamten Team freigegeben werden.

Hinweis: Wenn Automation Ops für Ihre Organisation aktiviert ist, werden Sie aufgefordert, auszuwählen, ob eine klassische oder eine moderne Richtlinie generiert werden soll. Wählen Sie die klassische Option für das dateibasierte Governance Modell aus. Die moderne Option generiert Richtlinien, die Sie dann in Automation Ops importieren können, um eine einfache Migration zu diesem Modell zu erreichen.

Verwenden Sie die Schaltfläche unten, um das Beispiel herunterzuladen, das alle Workflow-Analyseregeln enthält. Passen Sie das Beispiel an die Anforderungen Ihrer Organisation an.

Download-Beispiel

Governance-Datei konfigurieren

Dateiversion und Dateibeschriftung

Governance-Dateien können unterschiedliche Versionen und einen benutzerdefinierten Namen haben.

{
    "Metadata": {
        "Version": "1.0"
                "LastUpdatedUtc": "2021-08-25T07:49:26.3089368Z",
                "Availability": null
    },
    "Info": {
        "Name": "Sample Policy Registry Key"
    }
}

Parameter	Values
„Metadaten“ > „Version“	major.minor zwischen Anführungszeichen ""
„Info“ > „Name“	Bezeichnung in Anführungszeichen "", sichtbar in Start > Hilfe, unter Unternehmensrichtlinie.

Studio-Profile

Die Governance-Datei kann Richtlinien für Studio- und StudioX-Benutzer enthalten, diese müssen jedoch pro Profil strukturiert sein. Richtlinien für Studio müssen von denen für StudioX wie im folgenden Beispiel getrennt werden:

{
    "Profiles": {
        "Development": {
            "Shell": {
                "IsFeedbackEnabled": true,
                "HideGettingStartedScreen": false
            },
            "PackageManager": {},
            "Analyzer": {}
        },
        "Business": {
            "Shell": {
                "IsFeedbackEnabled": true,
                "HideGettingStartedScreen": false
            },
            "PackageManager": {},
            "Analyzer": {}
        }
    }
}

Parameter	Values
„Profile“	Für Studio: Development Für StudioX: Business Nicht mehr verwendet Für Studio Pro: StudioPro Sie können beide Profile in derselben Datei hinzufügen.

Einstellungen, die Benutzer nicht in Studio konfigurieren können

Mit den Parametern unter "Shell" können Sie verhindern, dass Produktionsläufe über StudioX ausgeführt werden, indem ein Limit für die Anzahl der Ausführungen festgelegt wird, die ein Benutzer für ein Projekt ohne Änderungen ausführen kann.

Darüber hinaus können Sie konfigurieren, ob das Feedbackformular und der Begrüßungsbildschirm für Benutzer verfügbar sind.

{
      "Shell": {
        "IsFeedbackEnabled": true,
        "HideGettingStartedScreen": false,
        "RequireUserPublish": {
          "PermittedConsecutiveRuns": 3,
          "DialogMessage": null,
          "LogToQueue": {
            "QueueName": "NameOfQueue",
            "QueueFolder": "NameOfQueueFolder"
          }
        }
      }
}

Studio-Einstellung	Parameter	Values
Aktiviert oder deaktiviert das Formular Feedback senden, auf das über die Studio-Titelleiste zugegriffen werden kann.	"IsFeedbackEnabled"	Entweder true oder false.
Aktiviert oder deaktiviert den Begrüßungsbildschirm mit Links zur UiPath Academy, einem Einführungsvideo und Tutorials, der beim Öffnen von Studio angezeigt wird.	"HideGettingStartedScreen"	Entweder true oder false.
Die Parameter unter "RequireUserPublish" ermöglichen es Ihnen, die Anzahl der aufeinanderfolgenden Ausführungen zu begrenzen, die von Studio für ein Projekt ausgelöst werden können, das keine Änderungen aufweist, und die Protokollierungseinstellungen für Ereignisse zu konfigurieren, bei denen der Grenzwert überschritten wird. Dies kann verwendet werden, um zu verhindern, dass Benutzer Produktionsabläufe über Studio auslösen. Wir empfehlen, produktionsreife Projekte im Orchestrator zu veröffentlichen und über den Assistant auszuführen.	"RequireUserPublish" 1	Keine Angabe
Maximale Anzahl von aufeinanderfolgenden Ausführungen eines Projekts ohne Änderungen.	„PermittedConsecutiveRuns“ 1	Geben Sie die zulässige Häufigkeit ein. Wenn der Wert null oder eine negative Zahl ist, wird kein Limit festgelegt.
Meldung, die dem Benutzer in einem Dialogfeld angezeigt werden soll, wenn die zulässige Anzahl von aufeinanderfolgenden Ausführungen überschritten wird. Das Dialogfeld fordert den Benutzer auf, entweder das Projekt zu veröffentlichen oder die Ausführung abzubrechen.	"DialogMessage"	Geben Sie eine benutzerdefinierte Nachricht ein, die zwischen Anführungszeichen "" angezeigt wird. Wenn der Wert null ist, wird die folgende Meldung verwendet: Anscheinend führen Sie Produktionsläufe direkt von Ihrem Projekt aus durch. Ihre Organisation erfordert, dass Sie Ihr Projekt in Orchestrator veröffentlichen und von Ihrem UiPath Assistant ausführen.
Die Parameter unter "LogToQueue" bieten Ihnen die Möglichkeit, eine Orchestrator-Warteschlange zu konfigurieren, in der Ereignisse protokolliert werden sollen. Die folgenden Informationen werden für jedes Ereignis protokolliert: Benutzername, Projektname, Hash der Haupt-XAML-Datei und Zeitstempel der lokalen Maschine.	"LogToQueue"	Keine Angabe
Orchestrator Warteschlange, in der die Datensätze gespeichert werden sollen.	"QueueName"	Geben Sie den Namen der Warteschlange in Anführungszeichen "" ein. Wenn der Wert null ist, werden keine Datensätze gespeichert.
Orchestrator-Ordner mit der Warteschlange, in der die Datensätze gespeichert werden sollen.	"QueueFolder"	Geben Sie den Namen des Orchestrator-Ordners zwischen Anführungszeichen "" ein. Wenn der Wert null ist, werden keine Datensätze gespeichert.

1 – Änderungen werden nur im StudioX-Profil wirksam.

Verfügbare Vorlagenspeicherorte

Sie können verhindern, dass die Feeds „Offiziell“ und „Marktplatz“ unter Start (Studio Backstage-Ansicht) > Vorlagen in der Liste der Speicherorte angezeigt werden, von denen aus Vorlagen hinzugefügt werden können. Die Feeds sind standardmäßig aktiviert.

{
      "TemplatesManager": {
        "Feeds": [
          {
            "Name": "Official",
            "IsEnabled": true
          },
          {
            "Name": "Marketplace",
            "IsEnabled": true
          }
        ]
      }
}

Parameter	Values
„VorlagenManager“	„Feeds“	„Name“	Der Vorlagenspeicherort (Official, Marketplace) in Anführungszeichen.
		„IsEnabled“	Entweder true oder false.

Verwendung von Paketquellen

Sie können das Aufrufen, Hinzufügen oder Entfernen von Paketquellen pro Studio oder StudioX mithilfe der Governance-Datei einschränken.

{
    "PackageManager": {
        "AllowAddRemoveFeeds": false,
        "AllowEnableDisableFeeds": false,
        "AllowOrchestratorFeeds": true,
        "Feeds": [{
                "Name": "Organization Internal Feed",
                "Source": "https://[company].pkgs.visualstudio.com/_packaging/nuget-packages/nuget/v3/index.json",
                "IsEnabled": true
            },
            {
                "Name": "Official",
                "Source": "https://www.myget.org/F/workflow",
                "IsEnabled": true
            }
        ]
    }
}

Parameter		Values
„Paket-Manager“	„AllowAddRemoveFeeds“		Entweder true oder false.
	„AllowEnableDisableFeeds“		Entweder true oder false.
	„AllowOrchestratorFeeds“		Entweder true oder false.
	„Feeds“	„Name“	Bezeichnung zwischen Anführungszeichen "", sichtbar in Pakete verwalten.
		Quelle	Feedquelle zwischen Anführungszeichen "", sichtbar in Pakete verwalten.
		„IsEnabled“	Entweder true oder false.

Wenn die Parameter „AllowAddRemoveFeeds“ und „AllowEnableDisableFeeds“ auf true festgelegt sind, kann der Benutzer Feeds ändern, die im Paketmanager verfügbar sind. Wenn Änderungen vorgenommen werden, werden sie beim Neustart von Studio beibehalten.

Wenn der Parameter „AllowOrchestratorFeeds“ auf true gesetzt ist und der Roboter mit Orchestrator verbunden ist, können Benutzer die standardmäßigen Orchestrator-Feeds nicht deaktivieren.

Feeds, die in der Governance-Datei definiert sind, werden dem Abschnitt Standardpaketquellen im Fenster Pakete verwalten hinzugefügt, und der Benutzer kann die benutzerdefinierten Feeds (sofern die erforderlichen Rechte in der Governance-Datei bereitgestellt werden) zum Abschnitt Benutzerdefinierte Paketquellen hinzufügen.

Bitte beachten Sie, dass der Pfad zum lokalen Feed für Installationen pro Benutzer C:\Users\CurrentUser\AppData\Local\Programs\UiPath\Studio\Packages lautet.

Einstellungen des Aktivitätenbereichs (nur StudioX)

Mit den Einstellungen unter ActivitiesManager können Sie bestimmte Aktivitäten ausblenden und die Verwendung des Filters Entwickler anzeigen in StudioX erzwingen.

"ActivitiesManager": {
        "AllowShowDeveloper": false,
        "HiddenActivities": ["UiPath.Mail.Activities.Business.GmailApplicationCard","UiPath.Mail.Activities.Business.OutlookApplicationCard"]
}

Einstellung	Parameter	Wert
Ermöglicht Benutzern die Auswahl des Filters Entwickler anzeigen im Aktivitätenbereich in StudioX. Wenn False festgelegt ist, ist die Option nicht mehr verfügbar.	"AllowShowDeveloper"	Entweder true oder false.
Eine Liste der Aktivitäten, die im Aktivitätenbereich ausgeblendet werden sollen.	"HiddenActivities"	Geben Sie durch Kommas getrennte Aktivitätsnamen in das Array ein. Im folgenden Beispiel wurden die Aktivitäten Use Gmail und Use Desktop Outlook App ausgeblendet. "HiddenActivities": ["UiPath.Mail.Activities.Business.GmailApplicationCard", "UiPath.Mail.Activities.Business.OutlookApplicationCard"]

Source Control-Einstellungen

Mit den Einstellungen unter "SourceControl" können Sie die Verwendung zulässiger Repositorys bei der Arbeit mit GIT erzwingen und Änderungen vor der Veröffentlichung committen.

{
      "SourceControl": {
        "CheckInBeforePublishParam": {
          "AllowEdit": false,
          "Value": false
        },
       "RepositoriesConfigParam": {
          "AllowEdit": true,
          "Value": {
            "AllowSaveLocal": null,
            "AllowEditRepositories": null,
            "Repositories": [
              {
                "SourceControlType": 0,
                "Name": null,
                "Url": null,
                "DefaultFolder": null
              }
            ]
          }
       
}

Der Parameter "AllowEdit" gibt an, ob Benutzer die von der Governance-Datei konfigurierte Standardeinstellung ändern dürfen oder nicht.

Studio-Einstellung	Parameter	Wert
Check-In vor der Veröffentlichung erzwingen Hinweis: Diese Einstellung finden Sie unter Start > Einstellungen > Design.	"CheckInBeforePublishParam"	Entweder true oder false.
Mit den Parametern unter RepositoriesConfigParam können Sie die Verwendung von Source Control-Repositorys steuern. Dies gilt nur für GIT.	"RepositoriesConfigParam"	Keine Angabe
Ermöglichen Sie Benutzern das lokale Speichern von Projekten auf ihrer Maschine.	"AllowSaveLocal" 1	Entweder true oder false. Wenn der Wert null ist, wird der Parameter als true interpretiert. Wenn false festgelegt ist, können Benutzer beim Erstellen eines neuen Projekts in StudioX nicht Dieser PC als Speicherort auswählen. Das Projekt wird in einem Repository gespeichert.
Ermöglichen Sie Benutzern das Hinzufügen und Bearbeiten von Repositorys.	"AllowEditRepositories"	Entweder true oder false. Wenn der Wert null ist, wird der Parameter als true interpretiert. Wenn auf falsefestgelegt: In der StudioX Backstage-Ansicht sind die Optionen in Start > Team schreibgeschützt und Benutzer können keine Repositorys hinzufügen, bearbeiten oder entfernen. In Studio können Benutzer Repository-URLs im Fenster Ein Remote-GIT-Repository klonen hinzufügen, aber jede URL wird mit der Liste der zulässigen Repositorys abgeglichen.
Eine Liste der zulässigen GIT-Repositorys. Dieser Parameter akzeptiert ein JSON-Array von Repositorys.	"Repositories" Hinweis: Ein Repository, das bereits lokal von einem Benutzer ausgecheckt wurde, ist für beide Profile zulässig, auch wenn es nur für eines von ihnen auf der Zulassungsliste steht.	Geben Sie Repositorys in das Array ein, indem Sie den Namen, die URL und optional DefaultFolder (den Standardordner des Repositorys) hinzufügen. Beispiel für ein Repository: "Name": "%username%'s Repo", "Url": "https://github.com/uipath/%username%", "DefaultFolder": null Das Hinzufügen einer Basis-URL (z. B. https://github.com/MyOrg/) ermöglicht die Verwendung von Repositorys mit untergeordneten URLs (z. B. https://github.com/MyOrg/RPA). Alle Zeichenfolgen zwischen % im Namen und den URL-Parametern werden auf den Benutzermaschinen als Umgebungsvariablen interpretiert. Alle Leerzeichen im URL-Parameter werden durch Bindestriche (-) ersetzt.

1 – Änderungen werden nur im StudioX-Profil wirksam.

Studio-Einstellungen

Mit den folgenden Parametern können Sie Einstellungen konfigurieren, die sich unter Start (Studio Backstage-Ansicht) > Einstellungen befinden. Weitere Informationen finden Sie unter Konfigurieren von Studio-Einstellungen.

{
      "Workflow": {
        "DefaultProjectLanguageParam": {
          "Value": VisualBasic,
          "AllowEdit": false
        },
        "DefaultProjectFrameworkParam": {
          "Value": "Classic",
          "AllowEdit": true
        },          
        "AllowedProjectFrameworks": {
          "Classic": true,
          "Modern": true,
          "CrossPlatform": true
        },
        "DockedAnnotationsParam": {
          "AllowEdit": false,
          "Value": true
        },
        "IsCollapsedViewSlimParam": {
          "AllowEdit": false,
          "Value": false
        },
        "UseSmartFilePathsParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnableLineNumberingParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnableActivityOnlineRecommendationsParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnforceReleaseNotes": null,
        "AnalyzeOnPublishParam": {
          "AllowEdit": false,
          "Value": false
        },
        "AnalyzeOnRunParam": {
          "AllowEdit": false,
          "Value": false
        },
        "AnalyzeRpaXamlsOnlyParam": {
          "AllowEdit": false,
          "Value": false
        },
        "AdditionalAnalyzerRulePathParam": {
          "AllowEdit": false,
          "Value": null
        },
        "DefaultProjectFolderParam": {
          "AllowEdit": false,
          "Value": null
        },
        "DefaultProcessPublishUrlParam": {
          "AllowEdit": false,
          "Value": null
        },
        "DefaultLibraryPublishUrlParam": {
          "AllowEdit": false,
          "Value": null
        },
        "DefaultTemplatePublishUrlParam": {
          "AllowEdit": false,
          "Value": "C:\\Users\\username\\Documents\\UiPath\\.templates"
        },
        "ModernBehaviorParam": {
          "AllowEdit": false,
          "Value": false
        },
        "ObjectRepositoryEnforcedParam": {
          "AllowEdit": false,
          "Value": false
        },
        "UseConnectionServiceParam": {
          "AllowEdit": true,
          "Value": false
        }
      },
}

Für die meisten Optionen sind zwei Parameter verfügbar:

• „AllowEdit“: Gibt an, ob Benutzer die von der Governance-Datei konfigurierte Standardeinstellung ändern dürfen oder nicht (true: zulassen, false: verweigern).
• „Value“: Gibt die Standardeinstellung an, wie in den folgenden Tabellen beschrieben.

Unter „Workflow“:

Studio-Einstellung	Parameter	Wert
C#-Sprache verwenden	"DefaultProjectLanguageParam" 1	CSharp Wenn „AllowEdit“ auf false festgelegt ist – Nur C# zulassen. Wenn „AllowEdit“ gleich true – Standardsprache auf C# festlegen und zulassen, dass Benutzer die Standardsprache ändern. VisualBasic Wenn „AllowEdit“ auf false festgelegt ist – Nur VB zulassen. Wenn „AllowEdit“ gleich true – Standardsprache auf VB festlegen und zulassen, dass Benutzer die Standardsprache ändern.
Angedockte Anmerkungen erstellen	"DockedAnnotationsParam"	Entweder true oder false.
Standardmäßiges Projektzielframework	"DefaultProjectFrameworkParam" 1	"Classic" Wenn „AllowEdit“ auf false festgelegt ist – Nur Windows – Legacy zulassen (.NET Framework 4.6.1). Wenn "AllowEdit" auf true festgelegt ist – Legen Sie das Standardziel auf Windows – Legacy fest und erlauben Sie Benutzern, das Zielframework zu ändern. "Modern" Wenn „AllowEdit“ auf false festgelegt ist – Nur Windows (.NET 5.0) zulassen. Wenn "AllowEdit" auf true festgelegt ist – Legen Sie das Standardziel auf Windows (.NET 5.0) fest und erlauben Sie es Benutzern, das Zielframework zu ändern. "Cross-platform" Wenn „AllowEdit“ auf false festgelegt ist – Nur „Plattformübergreifend (.NET 5.0)“ zulassen. Wenn "AllowEdit" auf true festgelegt ist – Legen Sie das Standardziel auf „Plattformübergreifend (.NET 5.0)“ fest und ermöglichen Sie es Benutzern, das Zielframework zu ändern.
Die Parameter unter "AllowedProjectFrameworks" bestimmen die Zielframeworks, die beim Erstellen oder Öffnen eines Projekts im Studio-Profil zulässig sind. Um ein Framework zu aktivieren, legen Sie seinen Parameter auf true fest. Hinweis: Diese Einstellung kann nicht über die Studio-UI konfiguriert werden.	"AllowedProjectFrameworks" 1	Entweder true oder false. für jede der folgenden: „Classic“ (Windows – Legacy, .NET Framework 4.6.1) „Modern“ (Windows, .NET 5) „Cross-platform“ (plattformübergreifend, .NET 5)
Intelligente Dateipfade verwenden	"UseSmartFilePathsParam" 2	Entweder true oder false.
Zeilennummerierung aktivieren	"EnableLineNumberingParam" 2	Entweder true oder false.
KI-Aktivitätsvorschläge aktivieren	"EnableActivityOnlineRecommendationsParam"	Entweder true oder false.
Machen Sie das Feld "Versionshinweise" im Veröffentlichungsassistenten zu einem Pflichtfeld. Hinweis: Diese Einstellung kann nicht über die Studio-UI konfiguriert werden.	"EnforceReleaseNotes"	Entweder true oder false.
Schlanke Ansicht für reduzierte Aktivitäten	"IsCollapsedViewSlimParam"	Entweder true oder false.
Analyse vor Veröffentlichung erzwingen	"AnalyzeOnPublishParam"	Entweder true oder false.
Analyse vor Ausführung erzwingen	"AnalyzeOnRunParam"	Entweder true oder false.
Nur RPA-XAML-Dateien analysieren	"AnalyzeRpaXamlsOnlyParam"	Entweder true oder false.
Speicherort für Workflow-Analyseregeln	"AdditionalAnalyzerRulePathParam"	null: Standardspeicherort verwenden. Um den Speicherort zu ändern, geben Sie den Pfad zu dem Ordner, in dem die benutzerdefinierten Regeln gespeichert sind, in Anführungszeichen ein.
Projektpfad	DefaultProjectFolderParam	null: Standardspeicherort verwenden. Um den Speicherort zu ändern, geben Sie den Pfad zu dem Ordner, in dem die benutzerdefinierten Regeln gespeichert sind, in Anführungszeichen ein.
Prozess-URL veröffentlichen	"DefaultProcessPublishUrlParam"	null: Standardspeicherort verwenden. Zum Ändern des Speicherorts geben Sie den Pfad in Anführungszeichen ein.
Bibliotheks-URL veröffentlichen	"DefaultLibraryPublishUrlParam"	null: Standardspeicherort verwenden. Zum Ändern des Speicherorts geben Sie den Pfad in Anführungszeichen ein.
Projektvorlagen-URL veröffentlichen	"DefaultTemplatePublishUrlParam"	Zum Ändern des Speicherorts geben Sie den Pfad in Anführungszeichen ein.
„Modern“ für neue Projekte verwenden	"ModernBehaviorParam"	Entweder true oder false.
Objekt-Repository durchgesetzt	"ObjectRepositoryEnforcedParam"	Entweder true oder false.
Verwaltete Verbindungen sind Standard.	"UseConnectionServiceParam"	Entweder true oder false.

1 – Änderungen werden nur im Studio-Profil wirksam.

2 – Änderungen werden nur im StudioX-Profil wirksam.

Unter "ObjectBrowser":

Studio-Einstellung	Parameter	Wert
Anonyme UI-Deskriptoren senden	"SendUiDescriptors"	Entweder true oder false.

Senden von Studio-Nutzungsdaten an Ihre Organisation

Mit den Parametern unter „Telemetry“ können Sie das Senden von Studio-Nutzungsdaten an eine Application Insights-Ressource in Ihrem Azure-Portal aktivieren. Mit diesen Daten können Sie Benutzeraktivitäten in Studio nachverfolgen und analysieren. Um diese Funktion zu aktivieren, geben Sie den Instrumentierungsschlüssel der Application Insights-Instanz in den Parameter "instrumentation-keys" ein.

{
       "Telemetry": {
        "TelemetryOptions": {
          "TelemetryOptionsDictonary": {
            "instrumentation-keys": ""
        }
      }
   }
}

In der folgenden Tabelle finden Sie Informationen zu den Telemetriedaten, die an Application Insights gesendet werden.

Aktion	Ereignisname	Erfasste Daten
Studio wird gestartet	StudioStarted	Windows-Benutzer-ID Sitzungs-ID
Studio wird geschlossen	StudioClosed	Windows-Benutzer-ID Sitzungs-ID Sitzungsdauer
Projekt wird geöffnet	Projekt öffnen	Windows-Benutzer-ID Sitzungs-ID Projektname
Projekt wird erstellt	Neues Projekt	Windows-Benutzer-ID Sitzungs-ID Projektname
Projekt wird ausgeführt	RunProject1 StartDebug 2	Windows-Benutzer-ID Sitzungs-ID Projektname
Datei wird ausgeführt	RunDocument1 StartDebug 2	Windows-Benutzer-ID Sitzungs-ID Projektname
Projekt wird debuggt	DebugProject1 StartDebug 2	Windows-Benutzer-ID Sitzungs-ID Projektname
Datei wird debuggt	DebugDocument1 StartDebug 2	Windows-Benutzer-ID Sitzungs-ID Projektname
Bis zu dieser Aktivität ausführen wird ausgeführt	Designer_RunTo	Windows-Benutzer-ID Sitzungs-ID Projektname
Projekt wird veröffentlicht	Projekt veröffentlichen	Windows-Benutzer-ID Sitzungs-ID Projektname Orchestrator-URL Folder name Ort der Veröffentlichung (Feed)
Aktivitätspaket wird installiert	PackageAdded	Windows-Benutzer-ID Sitzungs-ID Paketname Paketversion Projektname
Aktivität wird zum Projekt hinzugefügt	S.Activities.ActivityAdded	Windows-Benutzer-ID Sitzungs-ID Aktivitätsname Paketname Paketversion
Ziel wird in UI-Automatisierungsaktivität angegeben	S.Activities.PropertyChanged	Windows-Benutzer-ID Sitzungs-ID

1 – Verfügbar ab Studio 2021.10.4.

2 - Das Ereignis „StartDebug“ verfolgt den Zielroboter, der den Vorgang ausgeführt hat – den lokalen Roboter (Lokal) oder einen Remote-Roboter (Orchestrator für die Unattended-Roboterverbindung, Remote für Remote-Maschinenverbindung).

Verwenden der Daten in Application Insights

Zusätzlich zu den in der offiziellen Microsoft-Dokumentation beschriebenen Anwendungsszenarien können Sie Abfragen mithilfe von Log Analytics im Azure Monitor Ihrer Azure Insights-Instanz testen und erstellen. Um alle möglichen Daten für ein Ereignis anzuzeigen, können Sie eine einfache Abfrage erstellen, die alle Vorkommnisse in einem vordefinierten Zeitbereich untersucht. Zum Beispiel:

customEvents
| where name == "StudioStarted"

Beispiele für Telemetrieabfragen und eine Beschreibung finden Sie in der folgenden Tabelle. Sie können auch die Liste der bekannten Probleme überprüfen.

Ereignis (Event)	Beispielabfrage	Beschreibung der Abfrage
StudioStarted Studio wird gestartet	customEvents | where name == "StudioStarted" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	Die Anzahl der täglichen Zugriffe auf Studio in den letzten 30 Tagen, mit Ausnahme des aktuellen Tages.
StudioClosed Studio wird geschlossen	customEvents | where name == "StudioClosed" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	Die Anzahl der Tage, an denen Studio in den letzten 30 Tagen geschlossen wurde, mit Ausnahme des aktuellen Tages.
StudioClosed Studio wird geschlossen	customEvents | where name == "StudioClosed" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend TotalSessionTimeInSeconds = tostring(customDimensions.TotalSessionTimeInSeconds) | extend SessionId = tostring(parse_json(tostring(customDimensions.Context)) .SessionId) | summarize AvgSessionTime_inMinutes = round(avg(todouble(TotalSessionTimeInSeconds))/60,2) by bin(timestamp, 1d) | order by timestamp desc	Die durchschnittliche tägliche Sitzungsdauer für die letzten 30 Tage, ohne den aktuellen Tag (in Minuten, auf zwei Dezimalstellen gerundet).
Projekt öffnen Projekt wird geöffnet	customEvents | where name == "OpenProject" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	Wie viele Male pro Tag ein Projekt in den letzten 30 Tagen geöffnet wurde, mit Ausnahme des aktuellen Tages.
Neues Projekt Projekt wird erstellt	customEvents | where name == "NewProject" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActionArgs = tostring(customDimensions .ActionArgs) | where ActionArgs != "" | summarize count(name) by ActionArgs, bin(timestamp, 1d) | order by timestamp desc	Die Anzahl und der Typ der Projekte, die in den letzten 30 Tagen erstellt wurden, ohne den aktuellen Tag.
StartDebug Projekt wird ausgeführt oder debuggt/Datei wird ausgeführt oder debuggt	customEvents | where name == "StartDebug" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend RunTarget = tostring(customDimensions .RunTarget) | summarize count(name) by RunTarget, bin(timestamp, 1d) | order by timestamp desc	Wie viele Ausführungen in den letzten 30 Tagen für welches Ziel gestartet wurden, ohne den aktuellen Tag.
Designer_RunTo „Bis zu dieser Aktivität ausführen“ wird ausgeführt	customEvents | where name == "Designer_RunTo" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	Wie oft „Bis zu dieser Aktivität ausführen“ in den letzten 30 Tagen ausgeführt wurde, ohne den aktuellen Tag.
Projekt veröffentlichen Projekt wird veröffentlicht	customEvents | where name == "PublishProject" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	Die Anzahl der Projekte, die in den letzten 30 Tagen veröffentlicht wurden, ohne den aktuellen Tag.
PackageAdded Aktivitätspaket wird installiert	customEvents | where name == "PackageAdded" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActionArgs = tostring(customDimensions. ActionArgs) | summarize count(name) by ActionArgs, bin(timestamp, 1d) | order by timestamp desc	Die Anzahl der Pakete und die Namen der Pakete, die in den letzten 30 Tagen installiert wurden, ohne den aktuellen Tag.
S.Activities.ActivityAdded Aktivität wird zum Projekt hinzugefügt	customEvents | where name == "S.Activities.ActivityAdded" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActivityType = tostring(customDimensions. ActivityType) | extend PackageName = tostring(customDimensions.PackageName) | extend PackageVersion = tostring(customDimensions.PackageVersion) | summarize count(name) by ActivityType, PackageName, PackageVersion, bin(timestamp, 1d) | order by timestamp desc	Die Anzahl der Aktivitäten, die in den letzten 30 Tagen hinzugefügt wurden, ohne den aktuellen Tag. Enthält den Namen und die Version des Pakets, aus dem jede Aktivität stammt. 3
S.Activities.PropertyChanged Ziel wird in UI-Automatisierungsaktivität angegeben	customEvents | where name == "S.Activities.PropertyChanged" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActivityType = tostring(customDimensions.ActivityType) | extend PropertyName = tostring(customDimensions.PropertyName) | summarize count(name) by ActivityType, PropertyName, bin(timestamp, 1d) | order by timestamp desc	Wie oft die Eigenschaften der verwendeten Aktivitäten in den letzten 30 Tagen geändert wurden, mit Ausnahme des aktuellen Tages. Enthält die Aktivitätsnamen und den Namen jeder Eigenschaft, die geändert wurde.

In der folgenden Tabelle sind zusätzliche Parameter aufgeführt, die standardmäßig in Ereignissen enthalten sind.

Parameter	Beschreibung	Darstellung in der Abfrage (für ein ausgewähltes Ereignis)
customDimensions	Eine detaillierte Sammlung von Daten und Parametern zu jedem Ereignis.	customEvents | where name == "StudioStarted" | extend customDimensions
Context	Ein Teil der customDimensions-Sammlung, der Details zum Projekt verarbeitet, einschließlich Profil, Benutzer-ID, Lizenztyp, Robotertyp, Sitzungs-ID.	customEvents | where name == "StudioStarted" | extend Context = parse_json(customDimensions.Context)
Umgebung	Ein Teil der customDimensions-Sammlung, der aus dem Maschinennamen, der Betriebssystemversion und dem Benutzernamen besteht.	customEvents | where name == "StudioStarted" | extend Environment = parse_json(customDimensions.Environment)

Mit Log Analytics können Sie jeden Datentyp explizit erweitern, der Teil der genannten Parameter ist, um als Filter zu dienen oder als zusätzliches zusammengefasstes Element verwendet zu werden. Klicken Sie dazu auf das Drei-Punkte-Symbol neben einem Datenelement im Protokoll und wählen Sie dann, ob Sie die Daten erweitern oder als Filter verwenden möchten.

In der folgenden Tabelle finden Sie Beispiele zum Erweitern oder Filtern von Daten.

Datenbeispiel	Darstellung in der Abfrage (für ein ausgewähltes Ereignis)
ApplicationName (erweitert)	customEvents | where name == "StudioStarted" | extend ApplicationName = tostring(customDimensions.ApplicationName)
LicenseType (erweitert)	customEvents | where name == "StudioStarted" | extend LicenseType = tostring(parse_json(tostring(customDimensions.Context)).LicenseType)
OSVersion (Filter enthalten)	customEvents | where name == "StudioStarted" | where parse_json(tostring(customDimensions.Environment)).OSVersion == "Microsoft Windows NT 10.0.19043.0"
CurrentLanguage (Filter enthalten)	customEvents | where name == "StudioStarted" | where parse_json(tostring(customDimensions.Context)).CurrentLanguage == "en"

Bekannte Probleme (Known Issues)

• Das Ereignis NewProject wird zweimal generiert: Zuerst, wenn der Benutzer auswählt, ein neues Projekt in der Studio Backstage-Ansicht zu erstellen, und erneut, wenn der Benutzer im neuen Projektdialogfeld auf die Schaltfläche Erstellen klickt. Um das Ereignis nicht zweimal zu zählen, muss ein nicht leerer ActionArgs-Parameter in den Abfragen aufgenommen werden, wie in der Abfrage aus der Beispieltabelle.
• Das Ereignis PublishProject zeigt nur Details für Projekte an, die im Orchestrator veröffentlicht wurden.
• Das Ereignis S.Activities.ActivityAdded zeigt eine falsche Paketversion an.

Workflow-Analyseregeln

Der Workflow Analyzer ist das Tool, mit dem Sie überprüfen können, ob Projekte Entwicklungsstandards erfüllen. Mithilfe der Governance-Datei können Organisationen zentral benutzerdefinierte Regeln für ihre Anforderungen in allen Projekten durchsetzen.

Bemerkungen

• Der benutzerdefinierte Regelsatz kann zuvor in einer separaten Datei vom Typ .json definiert und über eine externe DLL-Assembly oder ein benutzerdefiniertes Aktivitätspaket bereitgestellt werden. Lesen Sie mehr über das Erstellen von benutzerdefinierten Regeln für die Workflow-Analyse.
• Die Governance-Datei kann keine Anmeldeinformationen bereitstellen, was bedeutet, dass sichere Feeds nicht unterstützt werden.
• Wenn ein benutzerdefinierter Regelsatz erzwungen wird, können Benutzer keine Änderungen an Workflow-Analyseregeln vornehmen.
• Wenn auf einen benutzerdefinierten Regelsatz nicht verwiesen oder er nicht in die Governance-Datei eingebettet wurde, werden die Standardregeln für die Workflow-Analyse verwendet. Wenn der Abschnitt „Analyse“ nicht erwähnt wird, wird die Governance für die Workflow-Analyse nicht erzwungen. Wenn der Abschnitt erwähnt wird, auch wenn er leer ist, wird die Verwaltung von Regeln in Studio deaktiviert.
• Beim Erzwingen der Governance werden integrierte Studio- oder UiPath-Aktivitätspakete standardmäßig deaktiviert, sofern in der Governance-Datei oder dem benutzerdefinierten Regelsatz nichts anderes erwähnt wird.

Erzwingen von Regeln

Es gibt zwei Möglichkeiten, den benutzerdefinierten Regelsatz in der uipath.policies.config-Governance-Datei zu verwalten:

1. Zeigen Sie auf den Regelsatz, der sich unter einem der folgenden Pfade befindet:

   • auf der lokalen Maschine;
   • gemeinsam auf einem Netzwerkserver oder Computer, der durch den UNC-Pfad identifizierbar ist;
   • im freigegebenen Blobspeicher, der über den http(s)-Pfad identifizierbar ist.
2. Betten Sie den benutzerdefinierten Regelsatz ein, indem Sie Regeln aktivieren oder deaktivieren und dabei deren IDs, Parameter und Fehlerstufen erwähnen.

Alle benutzerdefinierten Regeln müssen im Abschnitt "Analyzer" referenziert oder hinzugefügt werden. Regeln und Zähler müssen in ihre eigenen Abschnitte unterteilt werden, wie unten dargestellt:

{
    "Analyzer": {
    "AllowEdit": false,
        "ReferencedRulesConfigFile": null,
        "EmbeddedRulesConfig": {
            "Rules": [
        {
                    "Id": "ST-NMG-001",
                    "IsEnabled": false,
                    "Parameters": [{
                        "Name": "Regex",
                        "Value": null
                    }],
                    "ErrorLevel": "Error"
                }
            ],
            "Counters": [{
                "Id": "ST-ANA-009",
                "IsEnabled": true,
                "Parameters": []
            }]
        }
    }
}

Parameter/Abschnitte	Values
AllowEdit	Wenn auf true festgelegt, werden Governance-Einstellungen als Standardeinstellungen übergeben, sodass der Benutzer Änderungen an Regeln vornehmen kann. Wenn auf false festgelegt, können keine Änderungen an Regeln vorgenommen werden. Wenn der Parameter nicht hinzugefügt wird, sind Bearbeitungsregeln standardmäßig für Benutzer eingeschränkt.
"ReferencedRulesConfigFile"	Pfad zum .json -Regelsatz Verwenden Sie null , um Regeln von "EmbeddedRulesConfig"zu erzwingen
"EmbeddedRulesConfig"	Hält "Rules" und "Counters"
Id	Regel-ID, z. B. ST-NMG-001
„IsEnabled“	Entweder true oder false.
„Parameter“	Enthält Name und Valuedes Regelparameters Verwenden Sie [] , wenn die Regel keine Parameter enthält.
„Name“	Der Name des Parameters in Anführungszeichen.
Value	Der zwischen Anführungszeichen geschriebene Wert des Parameters Kann null sein
"ErrorLevel"	Entweder Error, Warning, Info oder Verbose.
„Zähler“	Enthält Parameter für Zähler: „Id“, „IsEnabled“, „Parameters“ 1.

1 - Da Zähler keine Parameter haben, verwenden Sie [].

Wenn der Parameter „AllowEdit“ auf true festgelegt ist, kann der Benutzer die im Einstellungsfenster „Workflow-Analyse“ verfügbaren Regeln ändern. Wenn Änderungen vorgenommen werden, werden sie beim Neustart von Studio beibehalten.

Durchsetzung der Governance-Richtlinie

Verwenden einer lokalen Datei

Wenn die Governance-Datei lokal gespeichert ist, muss sie sich unter folgendem Pfad befinden: %AppData%\UiPath.

Verwenden einer externen Datei

Wenn extern gespeichert, muss der Pfad zur Richtliniendatei mithilfe der Windows-Registrierung oder eines Orchestrator-Assets definiert werden:

So definieren Sie den Dateipfad mithilfe der Windows-Registrierung:

1. Öffnen Sie den Registrierungs-Editor auf dem Computer, auf dem Studio installiert ist.
2. Suchen Sie den Registrierungsschlüssel Computer\HKEY_CURRENT_USER\Software\UiPath, und drücken Sie die Eingabetaste.
3. Klicken Sie im Registrierungs-Editor mit der rechten Maustaste, und wählen Sie Neu > Zeichenfolgenwert. Geben Sie den GovernanceSource-Namen für den neuen Wert ein. Verwenden Sie keinen anderen Namen für den Wert!
4. Doppelklicken Sie auf die zu bearbeitende GovernanceSource-Zeichenfolge. Fügen Sie im Feld Wertdaten den Pfad zur uipath.policies.config-Datei hinzu, und klicken Sie auf OK.
   • Wenn die Richtliniendatei lokal gespeichert ist, wäre ein Beispiel für dieses Feld C:\policies\uipath.policies.config.
   • Wenn die Richtliniendatei auf einem Server gespeichert ist, wäre ein Beispiel für dieses Feld 192.168.1.1\policies\uipath.policies.config.

Der Registrierungsschlüssel sollte wie folgt aussehen:

So definieren Sie den Dateipfad mithilfe eines Orchestrator-Assets:

1. Wählen Sie in Orchestrator Mandant > Ordner aus und fügen Sie einen neuen Ordner mit dem Namen uipath.settings.config hinzu.
2. Weisen Sie dem Ordner die Benutzer zu, für die die Governance-Richtlinie erzwungen werden soll.

3. Erstellen Sie im Ordner uipath.settings.config ein neues Asset und konfigurieren Sie es wie folgt:

   • Asset-Name –- uipath.studio.governancesource.
   • Typ – Text.

   • Globaler Wert – Wählen Sie diese Option aus und geben Sie den vollständigen Pfad zur Datei uipath.policies.config in das Textfeld ein.

     Optional können Sie verschiedene Richtlinien für verschiedene Benutzer anwenden, indem Sie den einzelnen Benutzern Werte mit Pfaden zu verschiedenen Dateien hinzufügen.
     

     
     

     

     
     

Verwenden eines Orchestrator-Assets

1. Wählen Sie in Orchestrator Mandant > Ordner aus und fügen Sie einen neuen Ordner mit dem Namen uipath.settings.config hinzu.
2. Weisen Sie dem Ordner die Benutzer zu, für die die Governance-Richtlinie erzwungen werden soll.

3. Erstellen Sie im Ordner uipath.settings.config ein neues Asset und konfigurieren Sie es wie folgt:

   • Asset-Name – uipath.studio.governancesource.
   • Typ – Text.

   • Globaler Wert – Wählen Sie diese Option aus und fügen Sie den vollständigen Inhalt der Datei uipath.policies.config in das Textfeld ein.

     Optional können Sie verschiedene Richtlinien für verschiedene Benutzer anwenden, indem Sie den einzelnen Benutzern Werte hinzufügen und unterschiedliche Parameter einfügen.

     Hinweis:

     • Das Erzwingen einer Governance-Richtlinie mithilfe eines Orchestrator-Assets, das auf den Dateipfad verweist oder den Inhalt der Datei enthält, ist ab Orchestrator v2020.10 oder höher mit modernen Ordnern verfügbar.
     • Benutzer müssen bei ihrem Konto in Studio angemeldet werden, um benutzerspezifische Richtlinien zu erhalten.
     
     

     

     
     

Anwenden und Rangordnung

Sobald eine Richtlinie definiert ist, wird sie nach dem Neustart von Studio angewendet.

Eine Meldung wird im Einstellungsfenster Workflow-Analyse, im Fenster Feedback senden, in der Registerkarte Einstellungen in der Backstage-Ansicht, sowie im Fenster Pakete verwalten angezeigt.

Studio wendet die Governance-Richtlinie mit der folgenden Rangfolge an: Automation Ops > uipath.studio.governancepolicy > uipath.studio.governancesource > Registrierungsschlüssel > Lokale Datei.

Wenn die Governance-Richtlinie für den Benutzer entfernt wird, werden Einstellungen, die über die Governance-Datei erzwungen wurden, als Standardeinstellungen beibehalten. Jetzt hat der Benutzer jedoch die Möglichkeit, Einstellungen zu ändern, die eingeschränkt wurden, als die Governance-Richtlinie vorhanden war.