ガバナンス

Studio には、組織レベルで適用可能なファイルベースのガバナンス モデルが付属しており、特定の機能に対する一定レベルの管理能力を提供します。

現在の機能は次のとおりです。

• Studio、Studio Pro、StudioX のいずれか、もしくはその任意の組み合わせごとに適用されます。
• 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.

Studio で利用できるガバナンス機能の概要と、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.

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

組織に開発基準を徹底させる最初の段階として、ガバナンス ファイルを Studio で生成するか、前述の機能のすべてまたは一部を含む同様のファイルを手動で作成します。

重要:

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

Studio の現在の設定からガバナンス ファイルを生成するには、Backstage ビュー > [ヘルプ] タブに移動して、[ガバナンス ファイルを生成] を選択します。エクスポートしたファイルは、チームで共有できます。

下記のボタンから、ワークフロー アナライザーのルールを含むサンプルをダウンロードできます。このサンプルを自分の組織のニーズに合わせて変更してください。

サンプルをダウンロード

UiPathStudioSetup.exe をインストールした場合、ローカル フィードへのパスを C:\Users\CurrentUser\AppData\Local\UiPath\app-Studio_version に変更する必要があることを忘れないでください。

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

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

ガバナンス ファイルには、異なるバージョンとカスタム名がある可能性があります。

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

パラメーター	値
"Metadata" > "Version"	二重引用符 ("") で囲んだ、メジャー.マイナーの形式のバージョン
"Info" > "Name"	二重引用符 ("") で囲んだ、ラベル Backstage > [ヘルプ] の [企業ポリシー] に表示されます。

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

ガバナンス ファイルには、Studio、Studio Pro と StudioX 用のユーザー向けポリシーを含めることができますが、それらのポリシーはプロファイルごとに構成する必要があります。次の例のように、Studio のポリシーを、StudioX のポリシーおよび Studio Pro のポリシーと分けてください。

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

パラメーター	値
"Profiles"	Studio の場合: Development StudioX の場合: Business Studio Pro の場合: StudioPro これら 3 つのすべてを同じファイルに含めることができます。
"Shell" > "IsFeedbackEnabled"、"HideGettingStartedScreen"	true または false のいずれか。

パッケージ ソースの使用

パッケージ ソースの利用、追加、削除を、ガバナンス ファイルを使用して Studio、StudioX、Studio Pro ごとに、またはこれら 3 つの任意の組み合わせごとに制限できます。

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

パラメーター		値
"Package Manager"	"AllowAddRemoveFeeds"		true または false のいずれか。
	"AllowEnableDisableFeeds"		true または false のいずれか。
	"AllowOrchestratorFeeds"		true または false のいずれか。
	"Feeds"	"Name"	二重引用符 ("") で囲んだ、ラベル [パッケージを管理] に表示されます。
		"Source"	二重引用符 ("") で囲んだ、フィード ソース。 [パッケージを管理] に表示されます。
		"IsEnabled"	true または false のいずれか。

パラメーター "AllowAddRemoveFeeds" と "AllowEnableDisableFeeds" を true に設定すると、ユーザーがパッケージ マネージャーで提供されるフィードを変更できるようになります。加えた変更は、Studio を再起動しても保持されます。

"AllowOrchestratorFeeds" パラメーターが true に設定され、ロボットが Orchestrator に接続されている場合、ユーザーは既定の Orchestrator フィードを無効化できません。

ガバナンス ファイルに定義されたフィードは、[パッケージを管理] ウィンドウの [既定のパッケージ ソース] セクションに追加され、ユーザーは [ユーザー定義のパッケージ ソース] セクションにカスタム フィードを追加できます (ガバナンス ファイル内で必要な権限を与えられている場合)。

Studio の設定

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

各オプションで以下の 2 つのパラメーターを利用可能です。

• "AllowEdit" - ガバナンス ファイルによる既定の設定 (true: 許可、false: 拒否) の変更をユーザーに許可するかどうかを指定します。
• "Value" - 以下の表に示すように、既定の設定を指定します。

"SourceControl" の内容:

Backstage の設定	パラメーター	値 (Value)
パブリッシュ直前にチェックインを強制実行	"CheckInBeforePublishParam"	true または false のいずれか。

"Workflow" の内容:

Backstage の設定	パラメーター	値 (Value)
C# 言語を使用	"DefaultProjectLanguageParam" Changes to this parameter take effect only in the Studio Pro profile.	CSharp "AllowEdit" がfalseの場合 - C# のみを許可します。 "AllowEdit" がtrueの場合 - 既定の言語を C# に設定し、ユーザーが既定の言語を変更できるようにします。 VisualBasic [AllowEdit] がfalseの場合 - VB のみを許可します。 「AllowEdit」がtrueの場合 - 既定の言語を VB に設定し、ユーザーが既定の言語を変更できるようにします。
注釈をドッキング	"DockedAnnotationsParam"	true または false のいずれか。
折りたたまれたアクティビティのスリム ビュー	"IsCollapsedViewSlimParam"	true または false のいずれか。
パブリッシュ直前にアナライザーを強制実行	"AnalyzeOnPublishParam"	true または false のいずれか。
実行直前にアナライザーを強制実行	"AnalyzeOnRunParam"	true または false のいずれか。
RPA XAML ファイルのみを分析	"AnalyzeRpaXamlsOnlyParam"	true または false のいずれか。
ワークフロー アナライザー ルールの場所	"AdditionalAnalyzerRulePathParam"	null - 既定の場所を使用します。 場所を変更するには、カスタム ルールが格納されているフォルダーへのパスを引用符で囲んで入力します。
プロジェクト パス	DefaultProjectFolderParam	null - 既定の場所を使用します。 場所を変更するには、カスタム ルールが格納されているフォルダーへのパスを引用符で囲んで入力します。
プロセスのパブリッシュ先 URL	"DefaultProcessPublishUrlParam"	null - 既定の場所を使用します。 場所を変更するには、パスを引用符で囲んで入力します。
ライブラリのパブリッシュ先 URL	"DefaultLibraryPublishUrlParam"	null - 既定の場所を使用します。 場所を変更するには、パスを引用符で囲んで入力します。
プロジェクト テンプレートのパブリッシュ先 URL	"DefaultTemplatePublishUrlParam"	場所を変更するには、パスを引用符で囲んで入力します。
新しいプロジェクトでモダンを使用	"ModernBehaviorParam"	true または false のいずれか。
オブジェクト リポジトリの使用を強制します。	"ObjectRepositoryEnforcedParam"	true または false のいずれか。

"ObjectBrowser" の下:

Backstage の設定	パラメーター	値 (Value)
匿名の UI 記述子を送信	"SendUiDescriptors"	true または 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.

備考

• カスタム ルールセットは、.json の種類の別ファイルとしてあらかじめ定義でき、dll 外部アセンブリまたはカスタム アクティビティ パッケージを介して提供できます。ワークフロー アナライザーのカスタム ルールの作成について詳しくは、こちらをご覧ください。
• ガバナンス ファイルは資格情報を提供できません。つまり、セキュリティを確保したフィードには対応していないということです。
• カスタム ルールセットを適用した場合、ユーザーはワークフロー アナライザーのルールを一切変更できなくなります。
• カスタム ルールセットがガバナンス ファイルで参照されていない場合、またはガバナンス ファイルに組み込まれていない場合、ワークフロー アナライザーの既定のルールが適用されます。"Analyzer" セクションの記述が存在しない場合、ワークフロー アナライザー向けのガバナンスは適用されません。このセクションが記述されている場合は、中身が空でも、Studio でのルール管理が無効化されます。
• ガバナンスを適用すると、Studio または UiPath アクティビティ パッケージの組み込みルールは、ガバナンス ファイルまたはカスタム ルールセットに特に記述のないかぎり、既定で無効になります。

ルールの適用

uipath.policies.config ガバナンス ファイルのカスタム ルールセットを管理する方法には、次の 2 種類があります。

1. 以下のパスのいずれか 1 つに置かれたルールセットを参照します。
   • ローカル マシン
   • ネットワーク サーバーまたはマシンの共有パス - UNC パスで識別可能
   • 共有 BLOB ストレージ - http(s) パスで識別可能
2. カスタム ルールセットを埋め込みます。ルールを有効化または無効化し、それらの ID、パラメーター、エラー レベルを記述します。

すべてのカスタム ルールを "Analyzer" セクションで参照するか、同セクションに追加する必要があります。また、下図のようにルールとカウンターは、それぞれのセクションに分けて記述しなければなりません。

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

パラメーター/セクション	値
"AllowEdit"	true に設定すると、ガバナンスの設定が既定として渡され、ユーザーがルールを変更できるようになります。 false に設定すると、すべてのルールを一切変更できなくなります。 パラメーターを追加しないと、既定では、ユーザーはルールの編集を制限されます。
"ReferencedRulesConfigFile"	.json ルールセットへのパス。 "EmbeddedRulesConfig" のルールを適用する場合は、null を使用します。
"EmbeddedRulesConfig"	"Rules" と "Counters" を含みます。
"Id"	ルール IDです。例: ST-NMG-001
"IsEnabled"	true または false です。
"Parameters"	ルールのパラメーター Name と Value を含みます。 ルールにパラメーターがない場合は [] を使用します。
"Name"	引用符で囲まれたパラメーターの名前です。
"Value"	引用符で囲まれたパラメーターの値です。 null にできます。
"ErrorLevel"	Error、Warning、Info、または Verbose です。
"Counters"	カウンターのパラメーター、"Id"、"IsEnabled"、"Parameters" を含みます1。

1 - カウンターにはパラメーターがないため、[] を使用します。

"AllowEdit" パラメーターを true に設定した場合、ユーザーは、[ワークフロー アナライザーの設定] ウィンドウに表示されるルールを変更できます。加えた変更は、Studio を再起動しても保持されます。

ガバナンス ポリシーを適用する

ローカル ファイルを使用する

ローカルに保存する場合、ガバナンス ファイルはパス %AppData%\UiPath に置く必要があります。

外部ファイルを使用する

外部に保存する場合、ポリシー ファイルへのパスは、Windows レジストリまたは Orchestrator のアセットを使用して定義する必要があります。

Windows レジストリを使用してファイル パスを定義する

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

レジストリ キーは次のようになるはずです。

Orchestrator アセットを使用してファイル パスを定義する

注:

ファイル パスを参照する、またはファイルのコンテンツを保持する Orchestrator のアセットを使用したガバナンス ポリシーの適用は、Studio v2020.10.4 以降で行えます。この機能を使用するには、v2020.10 以降の Orchestrator が必要です。

1. Orchestrator で [テナント] > [フォルダー] を選択し、uipath.settings.config という名前の新しいフォルダーを追加します。
2. ガバナンス ポリシーを適用するユーザーをフォルダーに割り当てます。
3. uipath.settings.config フォルダーで新しいアセットを作成し、次のように設定します。

   • アセット名 - uipath.studio.governancesource

   • 種類 - テキスト

   • グローバル値 - このオプションを選択し、uipath.policies.config ファイルへのフル パスをテキスト ボックスに入力します。

     必要に応じて、ユーザー単位で異なるファイル パスを含む値を追加して、ユーザーごとに別々のポリシーを適用できます。

     注:

     • ユーザー単位でのポリシーの適用は、Automation Cloud Orchestrator 対応の Studio v2020.10.8 以降、および On-Premises Orchestrator 対応の Studio v2020.10.9 以降でのみ機能します
     • ユーザーごとのポリシーが適用されるには、ユーザーは Studio で自分のアカウントにサインインする必要があります。

     。

     

Orchestrator のアセットを使用する

注:

ファイル パスを参照する、またはファイルのコンテンツを保持する Orchestrator のアセットを使用したガバナンス ポリシーの適用は、Studio v2020.10.4 以降で行えます。この機能を使用するには、v2020.10 以降の Orchestrator が必要です。

1. Orchestrator で [テナント] > [フォルダー] を選択し、uipath.settings.config という名前の新しいフォルダーを追加します。
2. ガバナンス ポリシーを適用するユーザーをフォルダーに割り当てます。
3. uipath.settings.config フォルダーで新しいアセットを作成し、次のように設定します。

   • アセット名 - uipath.studio.governancepolicy

   • 種類 - テキスト

   • グローバル値 - このオプションを選択し、uipath.policies.config ファイルの内容全体をテキスト ボックスに貼り付けます。

     必要に応じて、ユーザーごとの値を追加し、さまざまなパラメーターを貼り付けて、各ユーザーに個別のポリシーを適用できます。

     注:

     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.

     

適用と優先順位

ポリシーを定義すると、Studio を再起動した後に適用されます。

メッセージが、[ワークフロー アナライザー] の設定ウィンドウ、[フィードバックを送る] ウィンドウ、Backstage ビューの [設定] タブ、および [パッケージを管理] ウィンドウに表示されます。

Studio は、次の優先順位を使用してガバナンス ポリシーを適用します。
uipath.studio.governancepolicy > uipath.studio.governancesource > レジストリ キー > ローカル ファイル

ユーザーに対してガバナンス ポリシーが削除された場合、ガバナンス ファイルによって適用されていた設定は、既定として保持されます。ただし、ユーザーは、ガバナンス ポリシーが設定されていたときには制限されていた設定を変更できるようになります。