通知を受け取る

UiPath Studio

UiPath Studio ガイド

ガバナンス

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

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

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

各機能に関連するパラメーターを uipath.policies.config ファイルに含め、以下の場所に提供する必要があります。

  • ローカル (簡易テスト目的) - Studio エンド ユーザーのコンピューターの Roaming フォルダー内
  • 外部 (大規模デプロイ目的) - レジストリ キー (Computer\HKEY_CURRENT_USER\Software\UiPath / GovernanceSource) によって参照されるパス上 (HTTP/HTTPS サーバーを含む)

ガバナンス ファイルが上記の場所の両方に存在する場合、レジストリ キーのパスが最初に読み取られます。

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

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

🚧

重要

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

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

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

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

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

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

ガバナンス ファイルには、Studio または StudioX の UI で異なるバージョンやカスタム名を持たせることができます。

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

パラメーター

"Metadata" > "Version"

二重引用符 ("") で囲んだ、メジャー.マイナーの形式のバージョン

"Info" > "Name"

二重引用符 ("") で囲んだラベルです。
Backstage ビュー > [ヘルプ] > [企業ポリシー] 下に表示されます。

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

ガバナンス ファイルには、Studio と 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 (Community ライセンスにも適用)
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 を再起動しても保持されます。

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

デザイン設定

Backstage > [設定] > [デザイン] に移動し、「ユーザー インターフェイス」のページの説明に従って設定します。

{
  "SourceControl":{
    "CheckInBeforePublish":true
  },
  "Workflow":{
    "AnalyzeOnRun":true,
    "AnalyzeOnPublish":true,
    "DockedAnnotations":true
  }
}

"SourceControl" セクションの内容

バックステージの設定

パラメーター

パブリッシュ前にチェックインを実行

"CheckInBeforePublish"

true または false のいずれか。

"workflow" セクションの内容

バックステージの設定

パラメーター

実行前にアナライザーを実行

"AnalyzeOnRun"

true または false のいずれか。

パブリッシュ前にアナライザーを実行

"AnalyzeOnPublish"

true または false のいずれか。

注釈をドッキング

"DockedAnnotations"

true または false のいずれか。

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

ワークフロー アナライザーは、プロジェクトが開発基準を満たしているかどうかを検証するツールです。組織はガバナンス ファイルを使用することで、ニーズに沿ったカスタム ルールをすべてのプロジェクトに一元的に適用できます。

備考

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

ルールの適用

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

  1. 以下のパスのいずれか 1 つに置かれたルールセットを参照します。
  • ローカル コンピューター
  • ネットワーク サーバーまたはコンピューターの共有パス - UNC パスで識別可能
  • 共有 BLOB ストレージ - http(s) パスで識別可能
  1. カスタム ルールセットを埋め込みます。ルールを有効化または無効化し、それらの 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"

ErrorWarningInfo、または Verbose です。

"Counters"

カウンターのパラメーター、"Id""IsEnabled""Parameters" を含みます1

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

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

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

uipath.policies.config は、ローカルまたは外部 (あるいは、両方) に配置できます。Studio または StudioX は、レジストリ キーのパスを最初に確認することに配慮してください。

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

外部に保存する場合は、以下の手順に従い uipath.policies.config をレジストリ エディターで追加します。

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

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

Studio の再起動後、uipath.policies.config のポリシーが適用されます。

企業のポリシーを適用すると、[ワークフロー アナライザー] の設定ウィンドウ、[フィードバックを送る] ウィンドウ、Backstage ビュー > [設定] の [ソースを管理] および [パッケージを管理] ウィンドウにメッセージが表示されます。

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

1 年前に更新

ガバナンス


改善の提案は、API リファレンスのページでは制限されています

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