ガバナンス

注: このページでは、Studio で使用できるファイルベースのガバナンス モデルについて説明します。Automation Ops からポリシーをデプロイする方法については『UiPath Automation Ops ガイド』をご覧ください。

Studio ユーザーが開発基準に準拠し、特定のルールを遵守するように、組織は Studio の機能をコントロールするガバナンス ポリシーを適用できます。

ガバナンス ポリシーは、次のいずれかの方法で適用できます。

• 使いやすい Web アプリケーションである Automation Ops からポリシーを作成してデプロイします。
• JSON ポリシー ファイルを作成し、ファイルをローカルまたは外部に、あるいは Orchestrator を介してデプロイする、ファイルベースのガバナンス モデルを使用します。

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

• Studio プロファイルごとに異なるポリシーを適用します。
• [パッケージを管理] ウィンドウおよび Backstage ビュー > [設定] > [ソースを管理] からの、パッケージ フィードの利用を制限します。
• ワークフロー アナライザーのルールを使用して、組織の開発基準を徹底します。
• デザインと場所の設定を適用し、Studio で行えないいくつかの設定を行います。
• Studio の使用状況データを組織に送信できるようにします。
• Git ソース管理に特定のリポジトリを使用できるようにします。

Studio で利用できるガバナンス機能の概要と、StudioX でのガバナンス機能の使用方法については、以下のビデオをご覧ください。

ガバナンス ポリシーを適用するには、はじめに Studio からガバナンス ファイルを生成してから、そのファイルに含まれるパラメーターを使用してファイルを設定し、次のいずれかの方法でポリシーを適用します。

• ローカル ファイルを使用する (テスト目的) - Studio がインストールされているマシンの Roaming フォルダーにガバナンス ファイルを配置します。
• 外部ファイルを使用する (大規模デプロイの場合) - Orchestrator のレジストリ キーまたはアセットのいずれかによって参照されるパス (HTTP/HTTPS サーバーなど) にガバナンス ファイルを配置します。
• Orchestrator でアセットを使用する - ガバナンス ファイルの内容を Orchestrator のアセットにコピーします。

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

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

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

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

注: 組織に対して Automation Ops が有効化されている場合、クラシック ポリシーとモダン ポリシーのどちらを生成するか選択するよう求められます。ファイルベースのガバナンス モデルの場合は、クラシック オプションを選択します。モダン オプションを選択するとポリシーが生成され、それを Automation Ops にインポートして、そのモデルに簡単に移行することができます。

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

サンプルをダウンロード

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

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

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

{
    "Metadata": {
        "Version": "1.0"
                "LastUpdatedUtc": "2021-08-25T07:49:26.3089368Z",
                "Availability": null
    },
    "Info": {
        "Name": "Sample Policy Registry Key"
    }
}

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

Studio プロファイル

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

{
    "Profiles": {
        "Development": {
            "Shell": {
                "IsFeedbackEnabled": true,
                "HideGettingStartedScreen": false
            },
            "PackageManager": {},
            "Analyzer": {}
        },
        "Business": {
            "Shell": {
                "IsFeedbackEnabled": true,
                "HideGettingStartedScreen": false
            },
            "PackageManager": {},
            "Analyzer": {}
        }
    }
}

パラメーター	値
"Profiles"	Studio の場合: Development StudioX の場合: Business (現在使用されていません) Studio Pro の場合: StudioPro 両方のプロファイルを同じファイルに追加できます。

ユーザーが Studio から構成できない設定

"Shell" パラメーターにより、変更のないプロジェクトをユーザーが実行できる回数の制限を設定し、StudioX からの運用環境での実行を禁止できます。

また、ユーザーがフィードバック フォームやウェルカム画面を使用できるようにするかを設定できます。

{
      "Shell": {
        "IsFeedbackEnabled": true,
        "HideGettingStartedScreen": false,
        "RequireUserPublish": {
          "PermittedConsecutiveRuns": 3,
          "DialogMessage": null,
          "LogToQueue": {
            "QueueName": "NameOfQueue",
            "QueueFolder": "NameOfQueueFolder"
          }
        }
      }
}

Studio の設定	パラメーター	値
Studio のタイトル バーからアクセスできる [フィードバックを送る] フォームを有効化または無効化します。	"IsFeedbackEnabled"	true または false のいずれか。
ユーザーが Studio を開いたときに表示される、UiPath アカデミー、紹介ビデオ、およびチュートリアルへのリンクを含むウェルカム画面を有効化または無効化にします。	"HideGettingStartedScreen"	true または false のいずれか。
"RequireUserPublish" パラメーターにより、変更がないプロジェクトを Studio からトリガーできる連続実行回数を制限し、制限を超えたイベントのログ記録の設定を行うことができます。 これにより、ユーザーが Studio から運用環境での実行をトリガーするのを防ぐことができます。ベスト プラクティスとして、運用環境での実行の準備が完了しているプロジェクトは、Orchestrator にパブリッシュして Assistant から実行するようにします。	"RequireUserPublish" 1	N/A
変更がないプロジェクトを連続して実行できる最大回数です。	"PermittedConsecutiveRuns" 1	許可されている回数を入力します。値が null または負の数値の場合、制限はありません。
許可された連続実行回数を超えたときに、ダイアログ ボックスでユーザーに表示するメッセージです。ダイアログ ボックスには、プロジェクトのパブリッシュまたは実行のキャンセルを求めるメッセージが表示されます。	"DialogMessage"	二重引用符 ("") で囲んで表示するカスタム メッセージを入力します。値が null の場合、「運用環境での実行をプロジェクトから直接行っているようです。あなたの組織では、プロジェクトを Orchestrator にパブリッシュして Assistant から実行する必要があります。」というメッセージが使用されます。
"LogToQueue" パラメーターにより、イベントをログする Orchestrator のキューを設定できます。イベントごとに、ユーザー名、プロジェクト名、main の XAML ファイルのハッシュ、ローカル マシンのタイムスタンプがログに記録されます。	"LogToQueue"	N/A
レコードの保存先の Orchestrator のキューです。	"QueueName"	キューの名前を二重引用符 ("") で囲んで入力します。値が null の場合、レコードは保存されません。
レコードの保存先のキューを含む Orchestrator のフォルダーです。	"QueueFolder"	Orchestrator のフォルダーの名前を二重引用符 ("") で囲んで入力します。値が null の場合、レコードは保存されません。

1 - 変更は、StudioX プロファイルでのみ有効です。

パッケージ ソースの使用

ガバナンス ファイルを使用して、Studio または StudioX ごとにパッケージ ソースのアクセス、追加、または削除を制限できます。

{
    "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://uipath.pkgs.visualstudio.com/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json",
                "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 フィードを無効化できません。

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

ユーザー単位のインストールのローカル フィードへのパスは C:\Users\CurrentUser\AppData\Local\Programs\UiPath\Studio\Packages です。

アクティビティ パネルの設定 (StudioX のみ)

ActivitiesManager パラメーターでは、StudioX で特定のアクティビティを非表示にし、[開発者向けアクティビティを表示] フィルターの使用を強制できます。

"ActivitiesManager": {
        "AllowShowDeveloper": false,
        "HiddenActivities": ["UiPath.Mail.Activities.Business.GmailApplicationCard","UiPath.Mail.Activities.Business.OutlookApplicationCard"]
}

設定	パラメーター	値 (Value)
StudioX の [アクティビティ] パネルで [開発者向けアクティビティを表示] フィルターを選択できるようにします。False に設定すると、このオプションを利用できなくなります。	"AllowShowDeveloper"	true または false のいずれか。
[アクティビティ] パネルで非表示になるアクティビティのリストです。	"HiddenActivities"	配列にアクティビティ名をコンマで区切って入力します。 以下の例では、[Gmail を使用] アクティビティと [デスクトップ版 Outlook アプリを使用] アクティビティが非表示になっています。 "HiddenActivities": ["UiPath.Mail.Activities.Business.GmailApplicationCard", "UiPath.Mail.Activities.Business.OutlookApplicationCard"]

テンプレート フィード

TemplatesManager にある設定では、組織でどのテンプレート フィードを有効化または無効化するかを適用できます。

"TemplatesManager": {
        "Feeds": [
          {
            "Name": "GettingStarted",
            "IsEnabled": true
          },
          {
            "Name": "Official",
            "IsEnabled": true
          },
          {
            "Name": "Marketplace",
            "IsEnabled": true
          }
        ]

設定		パラメーター	値 (Value)
TemplatesManager	フィード	名前	二重引用符 ("") で囲んで記述したフィードの名前です。
		IsEnabled	true または false のいずれか。

ソース管理設定

"SourceControl" パラメーターでは、Git を使用するとき、および変更をパブリッシュ前にコミットするときに、許可されたリポジトリの使用を強制できます。

{
      "SourceControl": {
        "CheckInBeforePublishParam": {
          "AllowEdit": false,
          "Value": false
        },
       "RepositoriesConfigParam": {
          "AllowEdit": true,
          "Value": {
            "AllowSaveLocal": null,
            "AllowEditRepositories": null,
            "Repositories": [
              {
                "SourceControlType": 0,
                "Name": null,
                "Url": null,
                "DefaultFolder": null
              }
            ]
          }
       
}

"AllowEdit" パラメーターでは、ガバナンス ファイルによる既定の設定の変更をユーザーに許可するかどうかを指定します。

Studio の設定	パラメーター	値 (Value)
パブリッシュ直前にチェックインを強制実行 注: この設定は、[ホーム] > [設定] > [デザイン] で利用できます。	"CheckInBeforePublishParam"	true または false のいずれか。
RepositoriesConfigParam パラメーターにより、ソース管理リポジトリの使用を管理できます。これは、Git にのみ適用されます。	"RepositoriesConfigParam"	N/A
ユーザーがローカルのマシン上にプロジェクトを保存できます。	"AllowSaveLocal" 1	true または false のいずれか。値が null の場合、このパラメーターは true として解釈されます。 [False] に設定すると、StudioX で新しいプロジェクトを作成するときに保存先として [このコンピューター] を選択できず、プロジェクトはリポジトリに保存されます。
ユーザーがリポジトリを追加および編集できます。	"AllowEditRepositories"	true または false のいずれか。値が null の場合、このパラメーターは true として解釈されます。 false に設定した場合 StudioX の Backstage ビューで、[ホーム] > [チーム] のオプションが読み取り専用になり、ユーザーはリポジトリを追加、編集、削除できなくなります。 Studio では、[リモート Git リポジトリの複製] ウィンドウにリポジトリ URL を追加することはできますが、各 URL が許可されたリポジトリのリストと照合されます。
許可された Git リポジトリのリストです。このパラメーターは、リポジトリの JSON 配列を受け入れます。	"Repositories" 注: ユーザーがローカルで既にチェックアウトしたリポジトリは、どちらかのプロファイルの許可リストにのみ存在する場合でも、両方のプロファイルで許可されます。	Name、Url、および任意で DefaultFolder (リポジトリの既定のフォルダー) を追加して、配列にリポジトリを入力します。 リポジトリの例: "Name": "%username%'s Repo" "Url": "https://github.com/uipath/%username%" "DefaultFolder": null ベース URL (例: https://github.com/MyOrg/) を追加すると、子 URL を含むリポジトリ (例: https://github.com/MyOrg/RPA) を使用できます。 Name および URL パラメーターで % の間に配置した文字列は、ユーザー マシンで環境変数として解釈されます。 URL パラメーターのスペースはすべて、ハイフン (-) に置き換えられます。

1 - 変更は、StudioX プロファイルでのみ有効です。

Studio の設定

以下のパラメーターを使用すると、ホーム (Studio の Backstage ビュー) > [設定] から設定を行えます。詳細については、「StudioX の設定を構成する」をご覧ください。

{
      "Workflow": {
        "DefaultProjectLanguageParam": {
          "Value": VisualBasic,
          "AllowEdit": false
        },
        "DefaultProjectFrameworkParam": {
          "Value": "Classic",
          "AllowEdit": true
        },          
        "AllowedProjectFrameworks": {
          "Classic": true,
          "Modern": true,
          "CrossPlatform": true
        },
        "DockedAnnotationsParam": {
          "AllowEdit": false,
          "Value": true
        },
        "ShowDataManagerOnlyParam": {
          "AllowEdit": true,
          "Value": false
        },
        "IsCollapsedViewSlimParam": {
          "AllowEdit": false,
          "Value": false
        },
        "UseSmartFilePathsParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnableLineNumberingParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnableActivityOnlineRecommendationsParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnforceReleaseNotes": null,
        "DisplayLegacyFrameworkDeprecation": true,
        "AnalyzeOnPublishParam": {
          "AllowEdit": false,
          "Value": false
        },
        "AnalyzeOnPushParam": {
          "AllowEdit": true,
          "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"
        },
        "DefaultPipTypeParam": {
          "Value": "ChildSession",
          "AllowEdit": true
        },
        "ModernBehaviorParam": {
          "AllowEdit": false,
          "Value": false
        },
        "ObjectRepositoryEnforcedParam": {
          "AllowEdit": false,
          "Value": false
        },
        "UseConnectionServiceParam": {
          "AllowEdit": true,
          "Value": false
        },
        "PlatformAutoUpdateIntervalDaysParam": {
          "AllowEdit": true,
          "Value": 7
        },
        "HideSequencesParam": {
          "AllowEdit": true,
          "Value": true
        },
        "AllowedPublishFeeds": {
          "Custom": true,
          "PersonalWorkspace": true,
          "TenantPackages": true,
          "FolderPackages": true,
          "HostLibraries": true,
          "TenantLibraries": true,
          "Local": true
        }
      },
}

ほとんどのオプションで以下の 2 つのパラメーターを利用できます。

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

"Workflow" の内容:

Studio の設定	パラメーター	値 (Value)
C# 言語を使用	"DefaultProjectLanguageParam" 1	CSharp "AllowEdit" が false の場合 - C# のみを許可します。 "AllowEdit" が true の場合 - 既定の言語を C# に設定し、既定の言語の変更をユーザーに許可します。 VisualBasic "AllowEdit" が false の場合 - VB のみを許可します。 "AllowEdit" が true の場合 - 既定の言語を VB に設定し、既定の言語の変更をユーザーに許可します。
注釈をドッキング	"DockedAnnotationsParam"	true または false のいずれか。
[データ マネージャー] パネルのみを表示	"ShowDataManagerOnlyParam"	true または false のいずれか。
シーケンスの非表示	"HideSequencesParam"	true または false のいずれか。
プロジェクトの既定のターゲット フレームワーク	"DefaultProjectFrameworkParam" 1	"Classic" "AllowEdit" が false の場合 - Windows - レガシ (.NET Framework 4.6.1) のみを許可します。 "AllowEdit" が true の場合 - 既定のターゲットを Windows - レガシに設定し、ターゲット フレームワークの変更をユーザーに許可します。 "Modern" "AllowEdit" が false の場合 - Windows のみを許可します。 "AllowEdit" が true の場合 - 既定のターゲットを Windows に設定し、ターゲット フレームワークの変更をユーザーに許可します。 "Cross-platform" "AllowEdit" が false の場合 - クロスプラットフォームのみを許可します。 "AllowEdit" が true の場合 - 既定のターゲットをクロスプラットフォームに設定し、ターゲット フレームワークの変更をユーザーに許可します。
"AllowedProjectFrameworks" パラメーターでは、Studio プロファイルでプロジェクトを作成したり開いたりするときに許可されるターゲット フレームワークを指定します。フレームワークを有効化するには、パラメーターを true に設定します。 注: この設定は、Studio の UI からは設定できません。	"AllowedProjectFrameworks" 1	true または false のいずれか。(以下のそれぞれについて)。 "Classic" (Windows - レガシ) "Modern" (Windows) "Cross-platform" (クロスプラットフォーム)
スマート ファイル パスを使用	"UseSmartFilePathsParam" 2	true または false のいずれか。
行番号の使用を有効化	"EnableLineNumberingParam" 2	true または false のいずれか。
AI によるアクティビティの提案を有効化	"EnableActivityOnlineRecommendationsParam"	true または false のいずれか。
パブリッシュ ウィザードの [リリース ノート] フィールドを必須にします 注: この設定は、Studio の UI からは行えません。	"EnforceReleaseNotes"	true または false のいずれか。
Windows - レガシ プロジェクトを開いたときに表示されるメッセージの表示/非表示を設定します。 注: この設定は、Studio の UI からは行えません。	"DisplayLegacyFrameworkDeprecation"	true または false のいずれか。
折りたたまれたアクティビティのスリム ビュー	"IsCollapsedViewSlimParam"	true または false のいずれか。
パブリッシュ直前にアナライザーを強制実行	"AnalyzeOnPublishParam"	true または false のいずれか。
プッシュ/チェックイン直前にアナライザーを強制実行	"AnalyzeOnPushParam"	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 のいずれか。
管理されているコネクションを既定で使用	"UseConnectionServiceParam"	true または false のいずれか。
"AllowedPublishFeeds" パラメーターでは、ユーザーが利用可能な、パブリッシュする場所を指定します。パブリッシュする場所を有効化するには、パラメーターを true に設定します。 注: この設定は、Studio の UI からは設定できません。	"AllowedPublishFeeds"	true または false のいずれか。(以下のそれぞれについて)。"Custom"、"PersonalWorkspace"、"TenantPackages"、"FolderPackages"、"HostLibrglossary"、"TenantLibrglossary"、"Local"。
PiP の種類	"DefaultPipTypeParam"	ChildSession - 新しいセッションです。 SecondaryDesktop - 新しいデスクトップです。

1 - 変更は、Studio プロファイルでのみ有効です。

2 - 変更は、StudioX プロファイルでのみ有効です。

"ObjectBrowser" の下:

Studio の設定	パラメーター	値 (Value)
匿名の UI 記述子を送信	"SendUiDescriptors"	true または false です。

Studio の使用状況データを組織に送信する

"Telemetry" 下のパラメーターにより、Studio の使用状況のデータをお使いの Azure ポータルの Application Insights リソースに送信できます。このデータを使用して、ユーザーが Studio で何をしているかを監視して分析することができます。この機能を有効化するには、"instrumentation-keys" パラメーターにお使いの Application Insights インスタンスのインストルメンテーション キーを入力します。

{
       "Telemetry": {
        "TelemetryOptions": {
          "TelemetryOptionsDictonary": {
            "instrumentation-keys": ""
        }
      }
   }
}

Application Insights に送信されるテレメトリ データについては、以下の表をご覧ください。

操作	イベント名	収集されるデータ
Studio が起動された	StudioStarted	Windows ユーザー ID セッション ID
Studio が閉じられた	StudioClosed	Windows ユーザー ID セッション ID セッションの期間
プロジェクトが開かれた	OpenProject	Windows ユーザー ID セッション ID プロジェクト名
プロジェクトが作成された 1	NewProject NewProjectCreated	Windows ユーザー ID セッション ID プロジェクト名
プロジェクトが実行された	RunProject StartDebug 2	Windows ユーザー ID セッション ID プロジェクト名
ファイルが実行された	RunDocument StartDebug 2	Windows ユーザー ID セッション ID プロジェクト名
プロジェクトがデバッグされた	DebugProject StartDebug 2	Windows ユーザー ID セッション ID プロジェクト名
ファイルがデバッグされた	DebugDocument StartDebug 2	Windows ユーザー ID セッション ID プロジェクト名
[このアクティビティまで実行] が実行された	Designer_RunTo	Windows ユーザー ID セッション ID プロジェクト名
プロジェクトがパブリッシュされた	PublishProject	Windows ユーザー ID セッション ID プロジェクト名 Orchestrator URL フォルダー名 パブリッシュする場所 (フィード)
アクティビティ パッケージがインストールされた	PackageAdded	Windows ユーザー ID セッション ID パッケージ名 パッケージのバージョン プロジェクト名
アクティビティがプロジェクトに追加された	S.Activities.ActivityAdded	Windows ユーザー ID セッション ID アクティビティ名 パッケージ名 パッケージのバージョン
UI Automation アクティビティでターゲットが指定された	S.Activities.PropertyChanged	Windows ユーザー ID セッション ID

1 - プロジェクトの作成時、ユーザーが Studio の Backstage ビューで新しいプロジェクトの作成を選択すると NewProject が生成され、ユーザーが新しいプロジェクトの作成ダイアログで [作成] ボタンをクリックすると NewProjectCreated が生成されます。

2 - StartDebug イベントは、操作を実行した対象のロボットを追跡します。対象のロボットはローカル ロボット (Local) またはリモート ロボット (Unattended ロボット接続の場合は Orchestrator、リモート マシン接続の場合は Remote) です。

Application Insights のデータを使用する

Microsoft の公式ドキュメントに記載されているユース ケース シナリオに加え、お使いの Azure Insights インスタンスの Azure Monitor 内の Log Analytics を使用してクエリをテストおよび構築できます。イベントに対して考えられるすべてのデータを表示するには、あらかじめ定義した時間範囲に含まれるすべての発生を検索するシンプルなクエリを作成します。以下に例を示します。

customEvents
| where name == "StudioStarted"

テレメトリ クエリの例と各クエリの説明は、次の表をご覧ください。また、既知の問題のリストもあわせてご覧ください。

イベント	クエリの例	クエリの説明
StudioStarted Studio が起動された	customEvents | where name == "StudioStarted" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	過去 30 日間 (現在の日を除く) で Studio が開かれた回数
StudioClosed Studio が閉じられた	customEvents | where name == "StudioClosed" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	過去 30 日間 (現在の日を除く) で 1 日あたりに Studio が閉じられた回数
StudioClosed Studio が閉じられた	customEvents | where name == "StudioClosed" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend TotalSessionTimeInSeconds = tostring(customDimensions.TotalSessionTimeInSeconds) | extend SessionId = tostring(parse_json(tostring(customDimensions.Context)) .SessionId) | summarize AvgSessionTime_inMinutes = round(avg(todouble(TotalSessionTimeInSeconds))/60,2) by bin(timestamp, 1d) | order by timestamp desc	過去 30 日間 (現在の日を除く) の 1 日あたりの平均セッション期間 (小数点以下 2 桁に四捨五入した分単位)
OpenProject プロジェクトが開かれた	customEvents | where name == "OpenProject" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	過去 30 日間 (現在の日を除く) で 1 日あたりにプロジェクトが開かれた回数
NewProjectCreated プロジェクトが作成された	customEvents | where name == "NewProjectCreated" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActionArgs = tostring(customDimensions .ActionArgs) | where ActionArgs != "" | summarize count(name) by ActionArgs, bin(timestamp, 1d) | order by timestamp desc	過去 30 日間 (現在の日を除く) に作成されたプロジェクトの数と種類
StartDebug プロジェクトが実行またはデバッグされた/ファイルが実行またはデバッグされた	customEvents | where name == "StartDebug" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend RunTarget = tostring(customDimensions .RunTarget) | summarize count(name) by RunTarget, bin(timestamp, 1d) | order by timestamp desc	過去 30 日間 (現在の日を除く) で実行が開始された回数とそのターゲット
Designer_RunTo [このアクティビティまで実行] が実行された	customEvents | where name == "Designer_RunTo" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	過去 30 日間 (現在の日を除く) で [このアクティビティまで実行] が実行された回数
PublishProject プロジェクトがパブリッシュされた	customEvents | where name == "PublishProject" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | summarize count(name) by bin(timestamp, 1d) | order by timestamp desc	過去 30 日間 (現在の日を除く) にパブリッシュされたプロジェクトの数
PackageAdded アクティビティ パッケージがインストールされた	customEvents | where name == "PackageAdded" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActionArgs = tostring(customDimensions. ActionArgs) | summarize count(name) by ActionArgs, bin(timestamp, 1d) | order by timestamp desc	過去 30 日間 (現在の日を除く) にインストールされたパッケージの数と名前
S.Activities.ActivityAdded アクティビティがプロジェクトに追加された	customEvents | where name == "S.Activities.ActivityAdded" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActivityType = tostring(customDimensions. ActivityType) | extend PackageName = tostring(customDimensions.PackageName) | extend PackageVersion = tostring(customDimensions.PackageVersion) | summarize count(name) by ActivityType, PackageName, PackageVersion, bin(timestamp, 1d) | order by timestamp desc	過去 30 日間 (現在の日を除く) に追加されたアクティビティの数。各アクティビティが含まれるパッケージの名前とバージョンが含まれます。3
S.Activities.PropertyChanged UI Automation アクティビティでターゲットが指定された	customEvents | where name == "S.Activities.PropertyChanged" | where timestamp >= startofday(ago(30d)) and timestamp <= endofday(ago(1d)) | extend ActivityType = tostring(customDimensions.ActivityType) | extend PropertyName = tostring(customDimensions.PropertyName) | summarize count(name) by ActivityType, PropertyName, bin(timestamp, 1d) | order by timestamp desc	過去 30 日間 (現在の日を除く) で使用されているアクティビティのプロパティが変更された回数。変更されたアクティビティの名前と各プロパティの名前が含まれます。

以下の表には、イベントに既定で含まれるその他のパラメーターが記載されています。

パラメーター	説明	(選択したイベントに対する) クエリ内の表現
customDimensions	各イベントに関連するデータとパラメーターの詳細なコレクションです。	customEvents | where name == "StudioStarted" | extend customDimensions
Context	CustomDimensions コレクションの一部で、プロファイル、ユーザー ID、ライセンスの種類、ロボットの種類、セッション ID など、プロジェクトに関する詳細を処理します。	customEvents | where name == "StudioStarted" | extend Context = parse_json(customDimensions.Context)
環境	CustomDimensions コレクションの一部で、マシン名、OS のバージョン、ユーザー名で構成されます。	customEvents | where name == "StudioStarted" | extend Environment = parse_json(customDimensions.Environment)

Log Analytics では、前述のパラメーターの一部である各データ型を明示的に拡張して、フィルターとして使用したり、追加の要約要素として使用したりできます。これを行うには、ログ内のデータ要素の横にある 3 点リーダー メニューのアイコンをクリックし、データを拡張するかフィルターとして使用するかを選択します。

データの拡張またはフィルター処理の例は、次の表をご覧ください。

データの例	(選択したイベントに対する) クエリ内の表現
ApplicationName (拡張)	customEvents | where name == "StudioStarted" | extend ApplicationName = tostring(customDimensions.ApplicationName)
LicenseType (拡張)	customEvents | where name == "StudioStarted" | extend LicenseType = tostring(parse_json(tostring(customDimensions.Context)).LicenseType)
OSVersion (フィルターを含む)	customEvents | where name == "StudioStarted" | where parse_json(tostring(customDimensions.Environment)).OSVersion == "Microsoft Windows NT 10.0.19043.0"
CurrentLanguage (フィルターを含む)	customEvents | where name == "StudioStarted" | where parse_json(tostring(customDimensions.Context)).CurrentLanguage == "en"

既知の問題

• PublishProject イベントでは、Orchestrator にパブリッシュされたプロジェクトの詳細のみが表示されます。
• S.Activities.ActivityAdded イベントに誤ったパッケージ バージョンが表示されます。

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

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

備考

• カスタム ルールセットは、.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 を再起動しても保持されます。

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

注: Automation Ops を使用してポリシーを設定し、デプロイすることをお勧めします。Studio から生成されたガバナンス ファイルからポリシーを作成する方法について詳しくは、『Automation Ops ガイド』の「ガバナンス ポリシーを作成する」をご覧ください。

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

ローカルに保存する場合、ガバナンス ファイルはパス %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 アセットを使用してファイル パスを定義する

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

3. uipath.settings.config フォルダーで新しいアセットを作成し、次のように設定します。

   • アセット名 - uipath.studio.governancesource
   • 種類 - テキスト

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

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

     
     

     

     
     

Orchestrator のアセットを使用する

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

3. uipath.settings.config フォルダーで新しいアセットを作成し、次のように設定します。

   • アセット名 - uipath.studio.governancepolicy
   • 種類 - テキスト

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

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

     注:

     • ファイル パスを参照する、またはファイルの内容を保持する Orchestrator のアセットを使用してガバナンス ポリシーを適用するには、モダン フォルダーを使用する v2020.10 以降の Orchestrator が必要です。
     • ユーザーごとのポリシーが適用されるには、ユーザーは Studio で自分のアカウントにサインインする必要があります。
     
     

     

     
     

適用と優先順位

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

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

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

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