通知を受け取る

UiPath Studio

UiPath Studio ガイド

ガバナンス

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.
  • [フィードバックを送る] 機能を無効にします。

Watch the following video for an overview of the governance capabilities available in Studio and a demo of how to use them in 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"
    }
}

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

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.

パッケージ ソースの使用

パッケージ ソースの利用、追加、削除を、ガバナンス ファイルを使用して 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.

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

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

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

Studio Settings

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 Setting

Parameters

Value

Enforce Check-In before Publish

"CheckInBeforePublishParam"

Either true or false.

"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.

Project Path

DefaultProjectFolderParam

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

Publish Process URL

"DefaultProcessPublishUrlParam"

null - Use the default location.
To change the location, enter the path between quotation marks.

Publish Library URL

"DefaultLibraryPublishUrlParam"

null - Use the default location.
To change the location, enter the path between quotation marks.

Publish Project Templates URL

"DefaultTemplatePublishUrlParam"

To change the location, enter the path between quotation marks.

Use Modern for new projects

"ModernBehaviorParam"

Either true or false.

Object Repository enforced

"ObjectRepositoryEnforcedParam"

Either true or false.

Under "ObjectBrowser":

Backstage Setting

Parameters

Value

Send anonymous UI Descriptors

"SendUiDescriptors"

Either true or false

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

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

備考

  • カスタム ルールセットは、.json の別ファイルとしてあらかじめ定義でき、dll 外部アセンブリまたはカスタム アクティビティ パッケージを介して提供できます。ワークフロー アナライザーのカスタム ルールの作成について、詳細を確認してください。
  • ガバナンス ファイルは資格情報を提供できません。つまり、セキュリティを確保したフィードには対応していないということです。
  • カスタム ルールセットを適用した場合、ユーザーはワークフロー アナライザーのルールを一切変更できなくなります。
  • カスタム ルールセットがガバナンス ファイルで参照されていない場合、またはガバナンス ファイルに組み込まれていない場合、ワークフロー アナライザーの既定のルールが適用されます。"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": []
            }]
        }
    }
}

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 - カウンターにはパラメーターがないため、[] を使用します。

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

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

Using a Local File

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

外部ファイルを使用する

If stored externally, the path to the policy file must be defined using the Windows Registry or an Orchestrator asset:

To define the file path using the Windows Registry:

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

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

To define the file path using an Orchestrator asset:

  1. In Orchestrator, select Tenant > Folders and add a new folder named uipath.settings.config.
  2. Assign the users for which to enforce the governance policy to the folder.
  3. In the uipath.settings.config folder, create a new asset and configure it as follows:
    • Asset name - uipath.studio.governancesource.
    • Type - Text.
    • Global Value - Select this option and enter the full path to the uipath.policies.config file in the text box.
      Optionally, you can apply separate policies for different users by adding per-user values with paths to different files.

Orchestrator のアセットを使用する

  1. In Orchestrator, select Tenant > Folders and add a new folder named uipath.settings.config.
  2. Assign the users for which to enforce the governance policy to the folder.
  3. In the uipath.settings.config folder, create a new asset and configure it as follows:
    • Asset name - uipath.studio.governancepolicy.
    • Type - Text.
    • Global Value - Select this option and paste the entire contents of the uipath.policies.config file in the text box.
      Optionally, you can apply different policies for different users by adding per-user values and pasting different parameters.

Applying and Precedence

When a policy is defined, it is applied after Studio is restarted.

A message appears in the Workflow Analyzer settings window, Send Feedback window, in the Settings tab in Backstage View,, and in the Manage Packages window.

Studio applies the governance policy using the following order of precedence: uipath.policies.governancepolicy > uipath.policies.governancesource > Registry ley > local file.

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

2 日前に更新


ガバナンス


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

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