Gouvernance

Studio est livré avec un modèle de gouvernance basé sur les fichiers pouvant être appliqué au niveau de l'organisation, afin d'exercer un niveau de contrôle sur certaines fonctionnalités.

Les capacités actuelles sont les suivantes :

• l'application par Studio, Studio Pro ou StudioX, et toute combinaison de ceux-ci.
• restreindre l’utilisation des flux de packages à partir de la fenêtre Gérer les packages et du Mode Backstage>Paramètres > Gérer les sources.
• appliquer les normes de développement organisationnel à l’aide des règles de l'analyseur de workflow.
• applique plusieurs paramètres de conception et de localisation.
• désactiver la fonctionnalité Envoyer des commentaires.

Regardez la vidéo suivante pour avoir un aperçu des capacités de gouvernance de Studio et obtenir une démo de la manière de les utiliser dans StudioX.

Pour appliquer une stratégie de gouvernance, commencez par générer un fichier de gouvernance à partir de Studio, puis configurez le fichier en utilisant les paramètres qu’il contient, et appliquez la stratégie de l’une des façons suivantes :

• Utilisation d’un fichier local (à des fins de test) - Placez le fichier de gouvernance dans le dossier Roaming sur la machine où Studio est installé.
• Utilisation d’un fichier externe (pour les déploiements importants) - Placez le fichier de gouvernance sur un chemin d'accès (par exemple, un serveur HTTP/HTTPS) référencé soit par une clé de registre, soit par une ressource dans Orchestrator.
• Utilisation d’une ressource dans Orchestrator - Copiez le contenu du fichier de gouvernance dans une ressource d’Orchestrator.

Générer le fichier de gouvernance

La première étape dans l’application des normes de développement dans votre organisation est de générer un fichier de gouvernance à partir de Studio ou de créer manuellement un fichier similaire qui intégrerait tout ou une partie des capacités que nous avons énumérées ci-dessus.

Important : Le fichier de gouvernance doit être de type .config avec le nom suivant uipath.policies.config.

Pour générer un fichier de gouvernance avec votre configuration actuelle à partir de Studio, rendez-vous dans le mode Backstage > onglet Aide et sélectionnez Générer un fichier de gouvernance. Le fichier exporté peut être partagé au sein de votre équipe.

Utilisez le bouton ci-dessous pour télécharger l'exemple qui inclut toutes les règles de l'analyseur de workflow. Modifiez l’exemple pour l'adapter aux besoins de votre organisation.

Télécharger l’exemple

Veuillez garder à l’esprit que si vous avez installé UiPathStudioSetup.exe, vous devez changer le chemin vers le flux local sur C:\Users\CurrentUser\AppData\Local\UiPath\app-Studio_version.

Configurer le fichier de gouvernance

Version du fichier et étiquette du fichier

Les fichiers de gouvernance peuvent avoir différentes versions et un nom personnalisé.

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

Paramètres	Values
"Metadata" > "Version"	major.minor entre guillemets «  » ("")
"Info" > "Name"	Libellé écrit entre guillemets «  » visible dans Backstage > Aide en vertu de la politique de l’entreprise.

Profils Studio et envoyer des commentaires

Le fichier de gouvernance peut contenir des politiques pour les utilisateurs de Studio, Studio Pro et StudioX, cependant, celles-ci doivent être structurées par profil. Les politiques de Studio doivent être séparées de celles de StudioX, et de celles de Studio Pro, comme dans l’exemple ci-dessous :

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

Paramètres	Values
"Profiles"	Pour Studio : Development Pour StudioX : Business Pour Studio Pro : StudioPro les trois sont acceptées dans le même fichier.
"Shell" > "IsFeedbackEnabled", "HideGettingStartedScreen"	Que ce soit true ou false.

Utilisation des sources de package

L’accès, l’ajout ou la suppression de sources de packages peuvent être limités par Studio, StudioX, Studio Pro ou toute combinaison des trois, en utilisant le fichier de gouvernance.

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

Paramètres		Values
"Package Manager"	"AllowAddRemoveFeeds"		Que ce soit true ou false.
	"AllowEnableDisableFeeds"		Que ce soit true ou false.
	"AllowOrchestratorFeeds"		Que ce soit true ou false.
	"Feeds"	« Nom »	Libellé écrit entre guillemets «  » visible dans Gérer les packages (Manage Packages).
		"Source"	Source du flux écrite entre guillemets « » visible dans Gérer les packages (Manage Packages).
		"IsEnabled"	Que ce soit true ou false.

Si les paramètres « AllowAddRemoveFeeds » et « AllowEnableDisableFeeds » sont définis sur true, l'utilisateur peut modifier les flux disponibles dans le gestionnaire de paquets. Si des modifications sont apportées, elles sont conservées lorsque Studio est redémarré.

Si le paramètre "AllowOrchestratorFeeds" est défini sur true et que le Robot est connecté à Orchestrator, les utilisateurs ne peuvent pas désactiver les flux Orchestrator par défaut.

Les flux définis dans le fichier de gouvernance sont ajoutés à la section Sources de packages par défautdans la fenêtre Gérer les paquets et l’utilisateur peut ajouter les flux personnalisés (s’ils ont les droits requis dans le fichier de gouvernance) à la section Sources de packages définies par l’utilisateur.

Paramètres de Studio

Configurez les paramètres de Studio depuis Accueil (mode Backstage de Studio) > Paramètres(Settings). Pour plus d’informations, consultez Configurer les paramètres StudioX.

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

Pour chaque option, deux paramètres sont disponibles :

• "AllowEdit" : Indique si les utilisateurs sont autorisés ou non à modifier le paramètre par défaut configuré par le fichier de gouvernance (true pour autoriser, false pour refuser).
• "Value" - Indiquez le paramètre par défaut tel que décrit dans les tableaux suivants.

Sous "SourceControl" :

Paramètre backstage	Paramètres	Valeur (Value)
Appliquer l'archivage avant la publication	"CheckInBeforePublishParam"	Que ce soit true ou false.

Sous "Workflow" :

Paramètre backstage	Paramètres	Valeur (Value)
Utiliser le langage C#	"DefaultProjectLanguageParam" Remarque : Les modifications apportées à ce paramètre ne sont prises en compte que dans le profil Studio Pro.	CSharp Si "AllowEdit" est false : autorisez uniquement C#. Si « AllowEdit » est true : définit le langage par défaut sur C# et autorise les utilisateurs à modifier le langage par défaut. VisualBasic Si "AllowEdit" est false : autorisez uniquement VB. Si « AllowEdit » est true : Définit le langage par défaut sur VB et autorise les utilisateurs à modifier le langage par défaut.
Créer des annotations ancrées	"DockedAnnotationsParam"	Que ce soit true ou false.
Vue simplifiée des activités réduites	"IsCollapsedViewSlimParam"	Que ce soit true ou false.
Appliquer l'analyseur avant la publication	"AnalyzeOnPublishParam"	Que ce soit true ou false.
Appliquer l'analyseur avant l'exécution	"AnalyzeOnRunParam"	Que ce soit true ou false.
Analyser les fichiers RPA XAML uniquement	"AnalyzeRpaXamlsOnlyParam"	Que ce soit true ou false.
Emplacement des règles de l'analyseur de workflow	"AdditionalAnalyzerRulePathParam"	null - Utilise l’emplacement par défaut. Pour modifier l’emplacement, entrez le chemin vers le dossier où les règles personnalisées sont stockées entre guillemets.
Chemin d’accès au projet	DefaultProjectFolderParam	null - Utilise l’emplacement par défaut. Pour modifier l’emplacement, entrez le chemin vers le dossier où les règles personnalisées sont stockées entre guillemets.
Publier l’URL du Processus	"DefaultProcessPublishUrlParam"	null - Utilise l’emplacement par défaut. Pour modifier l’emplacement, entrez le chemin d’accès entre guillemets.
Publier l’URL de la Bibliothèque	"DefaultLibraryPublishUrlParam"	null - Utilise l’emplacement par défaut. Pour modifier l’emplacement, entrez le chemin d’accès entre guillemets.
Publier l’URL des Modèles de projet	"DefaultTemplatePublishUrlParam"	Pour modifier l’emplacement, entrez le chemin d’accès entre guillemets.
Utiliser Modern pour de nouveaux projets	"ModernBehaviorParam"	Que ce soit true ou false.
Référentiel d’objet appliqué	"ObjectRepositoryEnforcedParam"	Que ce soit true ou false.

Sous "ObjectBrowser" :

Paramètre backstage	Paramètres	Valeur (Value)
Envoyer des descripteurs d’IU anonymes	"SendUiDescriptors"	true ou false

Règles de l’analyseur de workflow

L' analyseur de workflow est l'outil permettant de vérifier si les projets répondent aux normes de développement. À l'aide du fichier de gouvernance, les organisations peuvent appliquer des règles personnalisées relatives à leurs besoins dans tous les projets, de manière centralisée.

Remarques

• L'ensemble de règles personnalisé peut être défini à l’avance dans un fichier distinct de type .json, et livré par un assemblage externe dll ou un module d’activités personnalisé. En savoir plus sur la création de règles personnalisées pour l’analyseur de workflow.
• Le fichier de gouvernance ne peut pas fournir d’informations d’identification, ce qui signifie que les flux sécurisés ne sont pas pris en charge.
• Si un ensemble de règles personnalisé est appliqué, les utilisateurs ne peuvent pas apporter de modifications aux règles de l'analyseur de workflow.
• Si un jeu de règles personnalisé n’a pas été référencé ou intégré dans le fichier de gouvernance, les règles par défaut de l'analyseur de workflow sont utilisées. Si la section « Analyseur » n’est pas mentionnée, la gouvernance de l'analyseur de workflow n’est pas appliquée. Si la section est mentionnée, même si elle est vide, la gestion des règles est désactivée dans Studio.
• Lors de l’application de la gouvernance, les packages d’activité Studio ou UiPath intégrés aux règles sont désactivés par défaut, sauf indication contraire dans le fichier de gouvernance ou l'ensemble de règles personnalisé.

Enforcing Rules

Il existe deux façons de gérer l'ensemble de règles personnalisé dans le fichier de gouvernance uipath.policies.config :

1. Pointer vers l'ensemble de règles situé à l’un des chemins suivants :

   • sur la machine locale;
   • partagé sur un serveur réseau ou une machine, identifiable par le chemin UNC;
   • dans le stockage blob partagé, identifiable via le chemin http(s).
2. Intégrer l'ensemble de règles personnalisé en activant ou en désactivant les règles, en mentionnant leurs ID, paramètres, niveaux d’erreur.

Toutes les règles personnalisées doivent être référencées ou ajoutées dans la section "Analyzer". Les règles et les compteurs doivent être divisés en leurs propres sections, comme illustré ci-dessous :

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

Paramètres/sections	Values
"AllowEdit"	S’ils sont configurés sur true, les paramètres de gouvernance sont adoptés par défaut, ce qui permet à l’utilisateur d’apporter des modifications aux règles. S'ils sont configurés sur false, aucune modification ne peut être apportée à des règles. Si le paramètre n’est pas ajouté, par défaut, les utilisateurs sont limités aux règles d’édition.
"ReferencedRulesConfigFile"	Chemin d'accès à l'ensemble de règles .json Utilisez null pour appliquer les règles de "EmbeddedRulesConfig"
"EmbeddedRulesConfig"	Détient "Rules" et "Counters"
"Id"	ID de règle, ex. ST-NMG-001
"IsEnabled"	true ou false
"Parameters"	Contient les paramètres de règle Name et Value Utilisez [] si la règle n'a pas de paramètres.
"Name"	Le nom du paramètre écrit entre guillemets.
"Value"	La valeur du paramètre écrite entre guillemets Peut être null
"ErrorLevel"	Soit Error, Warning, Info ou Verbose.
"Counters"	Détient des paramètres pour les compteurs : « Id », « IsEnabled », « Parameters » 1.

1 - Puisque les compteurs n’ont pas de paramètres, utilisez [].

Si le paramètre « AllowEdit » est défini sur true, l'utilisateur peut modifier les règles disponibles dans la fenêtre des paramètres de l'analyseur de workflow. Si des modifications sont apportées, elles sont conservées lorsque Studio est redémarré.

Appliquer la politique de gouvernance

Utilisation d’un fichier local

S’il est stocké localement, le fichier de gouvernance doit être situé sur le chemin suivant : %AppData%\UiPath.

Utilisation d’un Fichier externe

S’il est stocké en externe, le chemin d'accès vers le fichier de stratégie doit être défini à l’aide du registre Windows ou d’une ressource Orchestrator :

Pour définir le chemin d'accès du fichier à l’aide du registre Windows :

1. Ouvrez l’éditeur de registre sur la machine où Studio est installé.
2. Localisez la clé de registre suivante : Computer\HKEY_CURRENT_USER\Software\UiPath et appuyez sur Entrée.
3. Dans l’éditeur du registre, faites un clic droit et sélectionnez Nouveau > Valeur de chaîne. Entrez le nom GovernanceSource de la nouvelle valeur. Ne donnez pas un autre nom à la valeur !
4. Double-cliquez sur la chaîne GovernanceSource à modifier. Dans le champ Données de la valeur , ajoutez le chemin d'accès au fichier uipath.policies.config et cliquez sur OK.
   • Si le fichier de stratégie est stocké localement, un exemple pour ce champ serait C:\policies\uipath.policies.config.
   • Si le fichier de stratégie est stocké sur un serveur, un exemple pour ce champ serait 192.168.1.1\policies\uipath.policies.config.

La clé du registre devrait ressembler à ceci :

Pour définir le chemin d'accès du fichier à l’aide d’une ressource Orchestrator :

Remarque : l’application d’une stratégie de gouvernance à l’aide d’une ressource Orchestrator qui fait référence au chemin d'accès au fichier ou détient le contenu du fichier est disponible à partir de Studio v2020.10.4. Cette fonctionnalité nécessite Orchestrator v2020.10 ou une version supérieure.

1. Dans Orchestrator, sélectionnez Locataire > Dossiers, puis ajoutez un nouveau dossier nommé uipath.settings.config.
2. Assignez les utilisateurs auxquels appliquer la stratégie de gouvernance du dossier.

3. Dans le dossier uipath.settings.config, créez une nouvelle ressource et configurez-la comme suit :

   • Nom de la ressource - uipath.studio.governancesource.
   • Type - Texte.

   • Valeur globale - Sélectionnez cette option et entrez le chemin complet vers le fichier uipath.policies.config dans la zone de texte.

     Vous avez également la possibilité d'appliquer des stratégies distinctes pour différents utilisateurs en ajoutant des valeurs par utilisateur associées à des chemins vers différents fichiers.

     Remarque : L'application de stratégies par utilisateur fonctionne dans Studio v2020.10.8 et versions ultérieures pour Automation Cloud Orchestrator, et Studio v2020.10.9 et versions ultérieures pour On-Premises Orchestrator.

     

Utilisation d’une ressource Orchestrator

Remarque : l’application d’une stratégie de gouvernance à l’aide d’une ressource Orchestrator qui fait référence au chemin d'accès au fichier ou détient le contenu du fichier est disponible à partir de Studio v2020.10.4. Cette fonctionnalité nécessite Orchestrator v2020.10 ou une version supérieure.

1. Dans Orchestrator, sélectionnez Locataire > Dossiers, puis ajoutez un nouveau dossier nommé uipath.settings.config.
2. Assignez les utilisateurs auxquels appliquer la stratégie de gouvernance du dossier.

3. Dans le dossier uipath.settings.config, créez une nouvelle ressource et configurez-la comme suit :

   • Nom de la ressource - uipath.studio.governancepolicy.
   • Type - Texte.

   • Valeur globale - Sélectionnez cette option, puis collez l’intégralité du contenu du fichier uipath.policies.config dans la zone de texte.

     Vous avez également la possibilité d’appliquer différentes stratégies pour différents utilisateurs en ajoutant des valeurs par utilisateur et en y collant différents paramètres.

     Remarque : L'application de stratégies par utilisateur fonctionne dans Studio v2020.10.8 et versions ultérieures pour Automation Cloud Orchestrator, et Studio v2020.10.9 et versions ultérieures pour On-Premises Orchestrator.

     

Application et Précédence

Lorsqu’une stratégie est définie, elle est appliquée après le redémarrage de Studio.

Un message apparaît dans la fenêtre de paramètres de l'Analyseur de workflow, la fenêtre Envoyer des commentaires, dans l'onglet Paramètres du mode Backstage et dans la fenêtre Gérer les packages.

Studio applique la stratégie de gouvernance en utilisant l’ordre de priorité suivant : uipath.studio.governancepolicy > uipath.studio.governancesource > Clé de registre > Fichier local.

Si la stratégie de gouvernance est supprimée pour l’utilisateur, les paramètres qui ont été appliqués par le biais du fichier de gouvernance sont maintenus par défaut. Toutefois, l’utilisateur a maintenant la possibilité de modifier les paramètres qui ont été restreints lorsque la politique de gouvernance était en place.