通知を受け取る

UiPath Studio

UiPath Studio ガイド

ガバナンス

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

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

  1. Studio または StudioX (あるいは、両方) によって適用できます。
  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:

  • ローカル (簡易テスト目的) - Studio エンド ユーザーのマシンの Roaming フォルダー内
  • externally (for large deployments) at a path (including HTTP/HTTPS server) referenced by the registry key (Computer\HKEY_CURRENT_USER\Software\UiPath / GovernanceSource など)。

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

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

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

🚧

重要

The governance file must be of type .config with the following name uipath.policies.config です。

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

344344

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

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 です。

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

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

ガバナンス ファイルには、Studio または 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.

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

Parameters

Values

"Profiles"

For Studio: Development
For StudioX: Business
For Studio Pro: StudioPro (also applies to Community license)
all three are accepted in the same file.

"Shell" > "IsFeedbackEnabled", "HideGettingStartedScreen"

Either true or 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
            }
        ]
    }
}

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.

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

デザイン設定

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

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

"SourceControl" セクションの内容

Backstage Setting

Parameters

Value

Enforce Check-In before Publish

"CheckInBeforePublish"

Either true or false.

"workflow" セクションの内容

Backstage Setting

Parameters

Value

Enforce Analyzer before Run

"AnalyzeOnRun"

Either true or false.

Enforce Analyzer before Publish

"AnalyzeOnPublish"

Either true or false.

Create docked annotations

"DockedAnnotations"

Either true or false.

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

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

備考

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

ルールの適用

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

  1. 以下のパスのいずれか 1 つに置かれたルールセットを参照します。
  • ローカル マシン
  • ネットワーク サーバーまたはマシンの共有パス - UNC パスで識別可能
  • 共有 BLOB ストレージ - http(s) パスで識別可能
  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.

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

★削除★ 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. Locate the following registry key: Computer\HKEY_CURRENT_USER\Software\UiPath and hit Enter.
  3. In the Registry Editor, right-click and select New > String Value. Type in the GovernanceSource name for the new value. Do not use another name for the value!
  4. Double-click the GovernanceSource string to edit. In the Value data field add the path to the uipath.policies.config file, and click OK.

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

10521052

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

10141014

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

10141014

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

2 年前に更新

ガバナンス


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

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