📘

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.

Über Governance

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 UiPath 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
• 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 design and location settings, and configure several settings that are not available Studio.
• enable sending Studio usage data to your organization.
• enforce the use of specific repositories for GIT source control.

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.

📘

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"
    }
}

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": {}
        }
    }
}

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"
          }
        }
      }
}

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

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://uipath.pkgs.visualstudio.com/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json",
                "IsEnabled": true
            }
        ]
    }
}

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"]

}

Vorlagenfeeds

Mit den Einstellungen unter TemplatesManager können Sie erzwingen, welche Vorlagenfeeds für Ihre Organisation aktiviert oder deaktiviert sind.

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

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.

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

Studio-Einstellungen

The following parameters enable you to configure settings found in Home (Studio Backstage View) > Settings. For more information, see Configuring Studio Settings.

{
      "Workflow": {
        "DefaultProjectLanguageParam": {
          "Value": VisualBasic,
          "AllowEdit": false
        },
        "DefaultProjectFrameworkParam": {
          "Value": "Classic",
          "AllowEdit": true
        },          
        "AllowedProjectFrameworks": {
          "Classic": true,
          "Modern": true,
          "CrossPlatform": true
        },
        "DockedAnnotationsParam": {
          "AllowEdit": false,
          "Value": true
        },
        "ShowDataManagerOnlyParam": {
          "AllowEdit": true,
          "Value": false
        },
        "IsCollapsedViewSlimParam": {
          "AllowEdit": false,
          "Value": false
        },
        "UseSmartFilePathsParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnableLineNumberingParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnableActivityOnlineRecommendationsParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnforceReleaseNotes": null,
        "DisplayLegacyFrameworkDeprecation": true,
        "AnalyzeOnPublishParam": {
          "AllowEdit": false,
          "Value": false
        },
        "AnalyzeOnPushParam": {
          "AllowEdit": true,
          "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"
        },
        "DefaultPipTypeParam": {
          "Value": "ChildSession",
          "AllowEdit": true
        },
        "ModernBehaviorParam": {
          "AllowEdit": false,
          "Value": false
        },
        "ObjectRepositoryEnforcedParam": {
          "AllowEdit": false,
          "Value": false
        },
        "UseConnectionServiceParam": {
          "AllowEdit": true,
          "Value": false
        },
        "PlatformAutoUpdateIntervalDaysParam": {
          "AllowEdit": true,
          "Value": 7
        },
        "HideSequencesParam": {
          "AllowEdit": true,
          "Value": true
        },
        "AllowedPublishFeeds": {
          "Custom": true,
          "PersonalWorkspace": true,
          "TenantPackages": true,
          "FolderPackages": true,
          "HostLibraries": true,
          "TenantLibraries": true,
          "Local": true
        }
      },
}

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

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

Unter "ObjectBrowser":

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.

1 – Beim Erstellen eines Projekts wird NewProject generiert, wenn der Benutzer ein neues Projekt in der Studio Backstage-Ansicht erstellt, während NewProjectCreated generiert wird, wenn der Benutzer im Dialogfeld „Neues Projekt“ auf die Schaltfläche Erstellen klickt.
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

In addition to the use case scenarios described in the official Microsoft documentation, you can test and build queries using Log Analytics in the Azure Monitor of your Azure Insights instance. To see all possible data for an event, you can build a simple query that will explore all its occurrences in the predefined time range. For example:

customEvents
| where name == "StudioStarted"

See the following table for examples of telemetry queries and a description for each one. You can also check the list of known issues.

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

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.

Bekannte Probleme (Known Issues)

• 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

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

• The custom ruleset can be defined beforehand in a separate file of type .json, and delivered through a dll external assembly or custom activity pack. Read more about Building Custom Rules for Workflow Analyzer.
• 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": []
            }]
        }
    }
}

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

📘

Hinweis:

Wir empfehlen, Richtlinien mithilfe von Automation Ops zu konfigurieren und bereitzustellen. Weitere Informationen zum Erstellen von Richtlinien aus Governance-Dateien, die von Studio generiert wurden, finden Sie unter Erstellen einer Governance-Richtlinie im Handbuch zu Automation Ops.

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.
   • If the policy file is stored locally, an example for this field would be C:\policies\uipath.policies.config.
   • If the policy file is stored on a server, an example for this field would be 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.

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.