通知を受け取る

UiPath Studio

UiPath Studio ガイド

ガバナンス

Studio comes with a file-based governance model that can be enforced at an organization level to exert a level of control over certain functionalities.

The current capabilities are:

  1. enforce per Studio, Studio Pro, or StudioX, and any combination thereof.
  2. [パッケージを管理] ウィンドウおよび Backstage ビュー > [設定] > [ソースを管理] により、パッケージ フィードの利用を制限します。
  3. ワークフロー アナライザーのルールを使用して、組織の開発基準を徹底します。
  4. [フィードバックを送る] 機能を無効にします。
  5. Backstage ビュー > [設定] > [デザイン] からの Studio の設定 - パブリッシュ前のアナライザーの実行、実行前のアナライザーの実行、パブリッシュ前のチェックインの実行、注釈のドッキングなどを設定できます。

The parameters pertaining to each capability must be part of a uipath.policies.config file, and available either:

  • locally (for quick testing purposes) inside the Roaming folder of the Studio's end-user machine, or
  • externally (for large deployments) at a path (including HTTP/HTTPS server) referenced by the registry key (Computer\HKEY_CURRENT_USER\Software\UiPath / GovernanceSource).

If the governance file is located at both locations, the Registry Key path is read first.

ガバナンス ファイルを生成する

The first step in enforcing development standards in your organization is to generate a governance file from Studio or manually create a similar file that would incorporate all or part of the capabilities we listed above.

🚧

重要!

ガバナンス ファイルは、名前が uipath.policies.config.config の種類である必要があります

To generate a governance file with your current configuration from Studio, go to the Backstage view > Help tab, and select Generate Governance File. The exported file can be shared across your team.

Use the button below to download the sample that includes all Workflow Analyzer rules. Modify the sample to fit your organization's needs.

Please bear in mind that if you have installed UiPathStudioSetup.exe, you need to change the path to the Local feed to C:\Users\CurrentUser\AppData\Local\UiPath\app-Studio_version.

ガバナンス ファイルを設定する

ファイル バージョンとファイル ラベル

Governance files may have different versions, a custom name in Studio or StudioX UI.

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

Parameters

Values

"Metadata" > "Version"

major.minor between quotation marks ""

"Info" > "Name"

Label written between quotation marks ""
visible in Backstage > Help, under Company Policy.

"Profiles"

For Studio: Development
For StudioX: Business
both are accepted in the same file.

"Shell" > "IsFeedbackEnabled"

Either true or false.

Studio のプロファイルとフィードバックの送信

The governance file may contain policies for both Studio and StudioX users, however, these must be structured per profile. Policies for Studio must be separated from those from StudioX, and from those for Studio Pro, as in the example below:

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

Parameters

Values

"Profiles"

For Studio: Development
For StudioX: Business
For Studio Pro: StudioPro
all three are accepted in the same file.

"Shell" > "IsFeedbackEnabled", "HideGettingStartedScreen"

Either true or false.

パッケージ ソースの使用

Accessing, adding or removing package sources may be restricted per Studio, StudioX, StudioPro or any combination of the three, using the governance file.

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

Parameters

Values

"Package Manager"

"AllowAddRemoveFeeds"

Either true or false.

"AllowEnableDisableFeeds"

Either true or false.

"AllowOrchestratorFeeds"

Either true or false.

"Feeds"

"Name"

Label written between quotation marks ""
visible in Manage Packages.

"Source"

Feed source written between quotation marks ""
visible in Manage Packages.

"IsEnabled"

Either true or false.

If the "AllowAddRemoveFeeds" and "AllowEnableDisableFeeds" parameters are set to true, the user may modify feeds available in the Package Manager. If any changes are made, they are persisted when Studio is restarted.

If the "AllowOrchestratorFeeds" parameter is set to true and the Robot is Connected to Orchestrator, users cannot disable the default Orchestrator feeds.

Feeds that are defined in the governance file are added to the Default package sources section in the Manage Packages window and the user can add the custom feeds (if provided with the required rights in the governance file) to the User defined package sources section.

デザイン設定

Configure settings found in Backstage > Settings > Design, as illustrated in the User Interface page.

{
      "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
        },
        "ModernBehaviorParam": {
          "AllowEdit": false,
          "Value": false
        },
        "ObjectRepositoryEnforcedParam": {
          "AllowEdit": false,
          "Value": false
        }
      },
}

Two parameters are available for each option:

  • "AllowEdit" - Indicate whether or not users are allowed to change the default setting configured by the governance file (true to allow, false to deny).
  • "Value" - Indicate the default setting, as described in the following tables.

Under "SourceControl":

Backstage Setting

Parameters

Value

Enforce Check-In before Publish

"CheckInBeforePublishParam"

Either true or false.

Under "Workflow":

Backstage Setting

Parameters

Value

Use C# Language

"DefaultProjectLanguageParam"

Note: Changes to this parameter take effect only in the Studio Pro profile.

  • CSharp
    If "AllowEdit" is false - Allow only C#.
    If "AllowEdit" is true - Set the default language to C# and allow users to change the default language.
  • VisualBasic
    If "AllowEdit" is false - Allow only VB.
    If "AllowEdit" is true - Set the default language to VB and allow users to change the default language.

Create docked annotations

"DockedAnnotationsParam"

Either true or false.

Slim View for Collapsed Activities

"IsCollapsedViewSlimParam"

Either true or false.

Enforce Analyzer before Publish

"AnalyzeOnPublishParam"

Either true or false.

Enforce Analyzer before Run

"AnalyzeOnRunParam"

Either true or false.

Analyze RPA XAML Files Only

AnalyzeRpaXamlsOnlyParam

Either true or false.

Workflow Analyzer Rules Location

"AdditionalAnalyzerRulePathParam"

null - Use the default location.
To change the location, enter the path to the folder where custom rules are stored between quotation marks.

Use Modern for new projects

"ModernBehaviorParam"

Either true or false.

Object Repository enforced

"ObjectRepositoryEnforcedParam"

Either true or false.

ワークフロー アナライザーのルール

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.

備考

  • 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.
  • The governance file can't deliver credentials, which means secure feeds aren't supported.
  • If a custom ruleset is enforced, then users cannot make any changes to Workflow Analyzer rules in Studio or StudioX.
  • If a custom ruleset was not referenced or embedded in the governance file, the Workflow Analyzer default rules are used. If the "Analyzer" section is not mentioned, governance for Workflow Analyzer is not enforced. If the section is mentioned, even if it's empty, then the management of rules is disabled in Studio.
  • When enforcing governance, rules built-in Studio or UiPath activity packages are disabled by default unless otherwise mentioned in the governance file or custom ruleset.

ルールの適用

There are two ways to manage the custom ruleset in the uipath.policies.config governance file:

  1. 以下のパスのいずれか 1 つに置かれたルールセットを参照します。
  • on the local machine;
  • shared on a network server or machine, identifiable by the UNC path;
  • in shared blob storage, identifiable via the http(s) path.
  1. カスタム ルールセットを埋め込みます。ルールを有効化または無効化し、それらの ID、パラメーター、エラー レベルを記述します。

All custom rules must be referenced or added in the "Analyzer" section. Rules and counters must be split into their own sections, as illustrated below:

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

Parameters/Sections

Values

"AllowEdit"

If set to true, governance settings are passed as defaults allowing the user to make changes to rules.
If set to false, no changes can be made to any rules.
If the parameter is not added, by default, users are restricted from editing rules.

"ReferencedRulesConfigFile"

Path to .json ruleset
Use null to enforce rules from "EmbeddedRulesConfig"

"EmbeddedRulesConfig"

Holds "Rules" and "Counters"

"Id"

Rule ID, ex. ST-NMG-001

"IsEnabled"

Either true or false

"Parameters"

Holds the rule parameter's **Name** and **Value**
Use [] if the rule doesn't have parameters.

"Name"

The parameter's name written between quotation marks.

"Value"

The parameter's value written between quotation marks
Can be null

"ErrorLevel"

Either Error, Warning, Info or Verbose.

"Counters"

Holds parameters for counters: "Id", "IsEnabled", "Parameters" 1.

1 - Since counters don't have parameters, use [].

If the "AllowEdit" parameter is set to true, the user may modify rules available in the Workflow Analyzer settings window. If any changes are made, they are persisted when Studio is restarted.

ガバナンス ポリシーの適用

The uipath.policies.config may be located locally and/or externally. Please take into consideration that Studio or StudioX checks the Registry Key path first.

If stored locally, the governance file must be located at the following path: %AppData%\UiPath.

If stored externally, follow the steps below to add the uipath.policies.config to the Registry Editor:

  1. Studio がインストールされているコンピューターでレジストリ エディターを開きます。
  2. 次のレジストリ キーを検索し、Enter キーを押します。Computer\HKEY_CURRENT_USER\Software\UiPath
  3. レジストリ エディターで右クリックして、[新規] > [文字列値] を選択します。新しい [値の名前] として GovernanceSource を入力します。他の名前は使用しないでください。
  4. 編集するために GovernanceSource という文字列をダブルクリックします。[値のデータ] フィールドに uipath.policies.config ファイルへのパスを入力して、[OK] をクリックします。

The registry key should look like this:

The policies from the uipath.policies.config are enforced after Studio is restarted.

If company policies are enforced, a message appears in the Workflow Analyzer settings window, Send Feedback window, Manage Sources in Backstage view > Settings, and Manage Packages:

If the governance policy is removed for the user, settings that were enforced through the governance file are persisted as defaults. However, now the user has the option to modify settings that were restricted when the governance policy was in place.

17 日前に更新


ガバナンス


改善の提案は、API 参照ページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。