Governance

Studio verfügt über ein dateibasiertes Governance-Modell, das auf Organisationsebene erzwungen werden kann, um eine gewisse Kontrolle über bestimmte Funktionen auszuüben.

Die aktuellen Funktionen sind:

• pro Studio, Studio Pro oder StudioX und einer beliebigen Kombination davon erzwingen.
• restrict usage of package feeds from the Manage Packages window and Backstage View>Settings > Manage Sources.
• enforce organizational development standards using Workflow Analyzer rules.
• enforce several design and location settings.
• disable Send Feedback functionality.

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

To enforce a governance policy, start by generating a governance file from Studio, then configure the file using the parameters it contains, and apply the policy in one of the following ways:

• Using a local file (for testing purposes) - Place the governance file in the Roaming folder on the machine where Studio is installed.
• Using an external file (for large deployments) - Place the governance file at a path (for example, an HTTP/HTTPS server) referenced by either a registry key or an asset in Orchestrator.
• Using an asset in Orchestrator- Copy the contents of the governance file to an 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.

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

Bitte beachten Sie, dass Sie, wenn Sie UiPathStudioSetup.exe installiert haben, den Pfad zum lokalen Feed in C:\Users\CurrentUser\AppData\Local\UiPath\app-Studio_version ändern müssen.

Governance-Datei konfigurieren

Dateiversion und Dateibeschriftung

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

{
    "Metadata": {
        "Version": "1.0"
    },
    "Info": {
        "Name": "Sample Policy Registry Key"
    }
}

Parameter	Values
„Metadaten“ > „Version“	major.minor between quotation marks ""
„Info“ > „Name“	Etikett zwischen Anführungszeichen „“ visible in Backstage > Help, under Company Policy.

Studio-Profile und Feedback senden

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

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

Parameter	Values
„Profile“	Für Studio: Development Für StudioX: Business Für Studio Pro: StudioPro alle drei werden in derselben Datei akzeptiert.
"Shell" > "IsFeedbackEnabled", "HideGettingStartedScreen"	Entweder true oder false.

Verwendung von Paketquellen

Der Zugriff, das Hinzufügen oder das Entfernen von Paketquellen kann für Studio, StudioX, Studio Pro oder eine beliebige Kombination daraus mithilfe der Governance-Datei eingeschränkt werden.

{
    "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“	Etikett zwischen Anführungszeichen „“ visible in Manage Packages.
		Quelle	Feedquelle zwischen Anführungszeichen „“ visible in Manage Packages.
		„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.

Studio-Einstellungen

Configure settings found in Home (Studio Backstage View) > Settings. For more information, see Configuring Studio Settings.

{
      "SourceControl": {
        "CheckInBeforePublishParam": {
          "AllowEdit": false,
          "Value": false
        }
      },
      "Workflow": {
        "DefaultProjectLanguageParam": {
          "Value": VisualBasic,
          "AllowEdit": false
        },
        "DockedAnnotationsParam": {
          "AllowEdit": false,
          "Value": true
        },
        "IsCollapsedViewSlimParam": {
          "AllowEdit": false,
          "Value": false
        },
        "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
        }
      },
}

Für jede Option 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 „SourceControl“:

Backstage-Einstellung	Parameter	Wert
Check-In vor der Veröffentlichung erzwingen	"CheckInBeforePublishParam"	Entweder true oder false.

Unter „Workflow“:

Backstage-Einstellung	Parameter	Wert
C#-Sprache verwenden	"DefaultProjectLanguageParam" Changes to this parameter take effect only in the Studio Pro profile.	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.
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.

Unter "ObjectBrowser":

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

Workflow-Analyseregeln

The Workflow Analyzer is the tool for verifying if projects meet development standards. Using the governance file, organizations can enforce custom rules pertaining to their needs across all projects, in a centralized manner.

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 aus. 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:

Hinweis:

Das Erzwingen einer Governance-Richtlinie mithilfe eines Orchestrator-Assets, das auf den Dateipfad verweist oder den Inhalt der Datei enthält, ist ab Studio v2020.10.4 verfügbar. Diese Funktion erfordert Orchestrator v2020.10 oder höher.

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.
     

     Hinweis:

     • Die Durchsetzung von Richtlinien pro Benutzer funktioniert in Studio v2020.10.8 und höher für Automation Cloud Orchestrator und Studio v2020.10.9 und höher für On-Premises
     • Benutzer müssen bei ihrem Konto in Studio angemeldet werden, um benutzerspezifische Richtlinien zu erhalten.

     Orchestrator.

     

Verwenden eines Orchestrator-Assets

Hinweis:

Das Erzwingen einer Governance-Richtlinie mithilfe eines Orchestrator-Assets, das auf den Dateipfad verweist oder den Inhalt der Datei enthält, ist ab Studio v2020.10.4 verfügbar. Diese Funktion erfordert Orchestrator v2020.10 oder höher.

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 Benutzerwerte hinzufügen und unterschiedliche Parameter einfügen.

     Hinweis:

     Enforcing policies per user works in Studio v2020.10.8 and later for Automation Cloud Orchestrator, and Studio v2020.10.9 and later for On-Premises Orchestrator.

     

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