通知を受け取る

UiPath Studio

UiPath Studio ガイド

ガバナンス

📘

注:

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

ガバナンスについて

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

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

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

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

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 で生成するか、前述の機能のすべてまたは一部を含む同様のファイルを手動で作成します。

🚧

重要

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

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

344344

📘

注:

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

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

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

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

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

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

Parameters

Values

"Metadata" > "Version"

major.minor between quotation marks ""

"Info" > "Name"

Label written between quotation marks "", visible in Home > Help, under Company Policy.

Studio プロファイル

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

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

Parameters

Values

"Profiles"

For Studio: Development
For StudioX: Business
No longer in use For Studio Pro: StudioPro
You can add both profiles in the same file.

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

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

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

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

Studio Setting

Parameters

Values

Enables or disables the Send feedback form that can be accessed from the Studio title bar.

"IsFeedbackEnabled"

Either true or false.

Enables or disables the welcome screen with links to the UiPath Academy, an introduction video, and tutorials that is displayed when users open Studio

"HideGettingStartedScreen"

Either true or false.

The parameters under "RequireUserPublish" enable you to limit the number of consecutive runs that can be triggered from Studio for a project that has no changes, and to configure logging settings for events where the limit is exceeded.

This can be used to prevent users from triggering production runs from Studio. As a best practice, projects that are ready for production should be published to Orchestrator and executed from the Assistant.

"RequireUserPublish" 1

N/A

Maximum number of consecutive times a project without changes can be run from Studio.

"PermittedConsecutiveRuns"

Enter the allowed number of times. If the value is null or a negative number, no limit is set.

Message to display to the user in a dialog box when the allowed number of consecutive executions is exceeded. The dialog box prompts the user to either publish the project or cancel the execution.

"DialogMessage"

Enter a custom message to display between quotation marks "". If the value is null, the following message is used: It appears you are performing production runs directly from your project. Your organization requires you to publish your project to Orchestrator and run from your Assistant.

The parameters under "LogToQueue" give you the option to configure an Orchestrator queue where to log events. The following information is logged for each event: username, project name, hash of the main XAML file, and timestamp from the local machine.

"LogToQueue"

N/A

Orchestrator queue in which to save the records.

"QueueName"

Enter the name of the queue between quotation marks "". If the value is null, no records are saved.

Orchestrator folder containing the queue in which to save the records.

"QueueFolder"

Enter the name of the Orchestrator folder between quotation marks "". If the value is null, no records are saved.

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

Available Template Locations

You can prevent the Getting Started, Official, and Marketplace feeds from appearing in Home (Studio Backstage View) > Templates in the list of locations from which templates can be added. The feeds are enabled by default.

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

Parameters

Values

"TemplatesManager"

"Feeds"

"Name"

The template location (GettingStarted, Official, Marketplace) written between quotation marks.

"IsEnabled"

Either true or false.

パッケージ ソースの使用

ガバナンス ファイルを使用して、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://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.

If the "AllowOrchestratorFeeds" parameter is set to true and the Robot is Connected to Orchestrator, users cannot disable the default Orchestrator feeds.

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

Please note that the path to the Local feed for per-user installations is 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"]

}

Setting

Parameters

Value

Allows users to select the Show Developer filter in the activities panel in StudioX. If set to False, the option becomes unavailable.

"AllowShowDeveloper"

Either true or false.

A list of activities to be hidden from the activities panel.

"HiddenActivities"

Enter activity names in the array, separated by commas.

In the example below, the Use Gmail and Use Desktop Outlook App activities have been hidden.

"HiddenActivities": ["UiPath.Mail.Activities.Business.GmailApplicationCard",
"UiPath.Mail.Activities.Business.OutlookApplicationCard"]

ソース管理設定

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

Parameters

Value

Enforce Check-In before Publish
Note: This setting is available in Home > Settings > Design.

"CheckInBeforePublishParam"

Either true or false.

The parameters under RepositoriesConfigParam enable you to govern the use of source control repositories. This applies only for GIT.

"RepositoriesConfigParam"

N/A

Allow users to save projects locally on their machine.

"AllowSaveLocal" 1

Either true or false. If the value is null, the parameter is interpreted as true.

When set to false, users can't select This PC as the location when creating a new project in StudioX and will save the project to a repository.

Allow users to add and edit repositories.

"AllowEditRepositories"

Either true or false. If the value is null, the parameter is interpreted as true.

If set to false:
In StudioX backstage view, the options in Home > Team are read only and users are not able to add, edit or remove a repository.
In Studio, users can add repository URLs in the Clone a remote GIT repository window, but each URL is checked against the list of allowed repositories.

A list of allowed GIT repositories. This parameter accepts a JSON array of repositories.

"Repositories"

Note: A repository that is already checked out locally by a user is allowed for both profiles even if it is on the allowed list for only one of them.

Enter repositories in the array by adding the Name, Url, and optionally DefaultFolder (the default folder of the repository).

Example of a repository:
"Name": "%username%'s Repo",
"Url": "https://github.com/uipath/%username%",
"DefaultFolder": null

Adding a base URL (e.g. https://github.com/MyOrg/) allows the use of repositories with child URLs (e.g. https://github.com/MyOrg/RPA).
Any strings placed between % in the name and URL parameters are interpreted as environment variables on the user machines.
All spaces in the URL parameter are replaced with hypens (-).

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

Studio の設定

The following parameters enable you to configure settings found in Home (Studio Backstage View) > Settings. For more information, see Configuring Studio Settings.

{
      "Workflow": {
        "DefaultProjectLanguageParam": {
          "Value": VisualBasic,
          "AllowEdit": false
        },
        "DefaultProjectFrameworkParam": {
          "Value": "Classic",
          "AllowEdit": true
        },          
        "AllowedProjectFrameworks": {
          "Classic": true,
          "Modern": true,
          "CrossPlatform": true
        },
        "DockedAnnotationsParam": {
          "AllowEdit": false,
          "Value": true
        },
        "IsCollapsedViewSlimParam": {
          "AllowEdit": false,
          "Value": false
        },
        "UseSmartFilePathsParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnableLineNumberingParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnableActivityOnlineRecommendationsParam": {
          "AllowEdit": true,
          "Value": true
        },
        "EnforceReleaseNotes": null,
        "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"
        },
        "ModernBehaviorParam": {
          "AllowEdit": false,
          "Value": false
        },
        "ObjectRepositoryEnforcedParam": {
          "AllowEdit": false,
          "Value": false
        },
        "UseConnectionServiceParam": {
          "AllowEdit": true,
          "Value": false
        }
      },
}

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

  • "AllowEdit" - Indicate whether or not users are allowed to change the default setting configured by the governance file (true to allow, false to deny).
  • "Value" - 以下の表に示すように、既定の設定を指定します。

"Workflow" の内容:

Studio Setting

Parameters

Value

Use C# Language

"DefaultProjectLanguageParam" 1

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.

Default project target framework

"DefaultProjectFrameworkParam" 1

"Classic"
If "AllowEdit" is false - Allow only Windows - Legacy (.NET Framework 4.6.1).
If "AllowEdit" is true - Set the default target to Windows - Legacy and allow users to change the target framework.
"Modern"
If "AllowEdit" is false - Allow only Windows.
If "AllowEdit" is true - Set the default target to Windows and allow users to change the target framework.
"Cross-platform"
If "AllowEdit" is false - Allow only Cross-platform.
If "AllowEdit" is true - Set the default target to Cross-platform and allow users to change the target framework.

The parameters under "AllowedProjectFrameworks" determine the target frameworks allowed when creating or opening a project in the Studio profile. To enable a framework, set its parameter to true.
Note: This setting cannot be configured from the Studio UI

"AllowedProjectFrameworks" 1

Either true or false. for each of the following:
"Classic" (Windows - Legacy)
"Modern" (Windows)
"Cross-platform" (Cross-platform)

Use Smart File Paths

"UseSmartFilePathsParam" 2

Either true or false.

Enable line numbering

"EnableLineNumberingParam" 2

Either true or false.

Enable AI activity suggestions

"EnableActivityOnlineRecommendationsParam"

Either true or false.

Make the Release Notes field in the Publish wizard mandatory
Note: This setting cannot be configured from the Studio UI.

"EnforceReleaseNotes"

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 Push/Check-in

"AnalyzeOnPushParam"

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.

Default to managed connections

"UseConnectionServiceParam"

Either true or false.

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

"ObjectBrowser" の下:

Studio Setting

Parameters

Value

Send anonymous UI Descriptors

"SendUiDescriptors"

Either true or false

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

The parameters under "Telemetry" allow you to enable sending Studio usage data to an Application Insights resource in your Azure portal. This data allows you to monitor and analyze what users are doing in Studio. To enable this feature, enter the instrumentation key of your Application Insights instance in the "instrumentation-keys" parameter.

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

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

Action

Event Name

Data Collected

Studio is started

StudioStarted

Windows user ID
Session ID

Studio is closed

StudioClosed

Windows user ID
Session ID
Session duration

Project is opened

OpenProject

Windows user ID
Session ID
Project name

Project is created 1

NewProject
NewProjectCreated

Windows user ID
Session ID
Project name

Project is run

RunProject
StartDebug 2

Windows user ID
Session ID
Project name

File is run

RunDocument
StartDebug 2

Windows user ID
Session ID
Project name

Project is debugged

DebugProject
StartDebug 2

Windows user ID
Session ID
Project name

File is debugged

DebugDocument
StartDebug 2

Windows user ID
Session ID
Project name

Run to this Activity is executed

Designer_RunTo

Windows user ID
Session ID
Project name

Project is published

PublishProject

Windows user ID
Session ID
Project name
Orchestrator URL
Folder name
Publish location (feed)

Activity package is installed

PackageAdded

Windows user ID
Session ID
Package name
Package version
Project name

Activity is added to a project

S.Activities.ActivityAdded

Windows user ID
Session ID
Activity name
Package name
Package version

Target is indicated in UI Automation activity

S.Activities.PropertyChanged

Windows user ID
Session ID

1 - プロジェクトの作成時、ユーザーが Studio の Backstage ビューで新しいプロジェクトの作成を選択すると NewProject が生成され、ユーザーが新しいプロジェクトの作成ダイアログで [作成] ボタンをクリックすると NewProjectCreated が生成されます。
2 - The StartDebug event tracks the target robot that executed the operation - the local robot (Local) or a remote robot (Orchestrator for unattended robot connection, Remote for remote machine connection).

Using the Data in Application Insights

In addition to the use case scenarios described in the official Microsoft documentation, you can test and build queries using Log Analytics in the Azure Monitor of your Azure Insights instance. To see all possible data for an event, you can build a simple query that will explore all its occurrences in the predefined time range. For example:

customEvents
| where name == "StudioStarted"

See the following table for examples of telemetry queries and a description for each one. You can also check the list of known issues.

Event

Example Query

Query Description

StudioStarted
Studio is started

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

How many times per day Studio was opened in the last 30 days, excluding the current day.

StudioClosed
Studio is closed

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

How many times per day Studio was closed in the last 30 days, excluding the current day.

StudioClosed
Studio is closed

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

The average daily session duration for the last 30 days, excluding the current day (in minutes rounded to two decimal points).

OpenProject
Project is opened

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

How many times per day a project was opened in the last 30 days, excluding the current day.

NewProjectCreated
Project is created

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

How many projects and of what type were created in the last 30 days, excluding the current day.

StartDebug
Project is run or debugged / File is run or debugged

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

How many runs were started and for what target in the last 30 days, excluding the current day.

Designer_RunTo
Run to this Activity is executed

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

How many times Run to this Activity was executed in the last 30 days, excluding the current day.

PublishProject
Project is published

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

How many projects were published in the last 30 days, excluding the current day.

PackageAdded
Activity package is installed

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

How many packages and the names of the packages that were installed in the last 30 days, excluding the current day.

S.Activities.ActivityAdded
Activity is added to a project

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

How many activities were added in the last 30 days, excluding the current day. Includes the name and version of the package each activity comes from. 3

S.Activities.PropertyChanged
Target is indicated in UI Automation activity

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

How many times properties of used activities were changed in the last 30 days, excluding the current day. Includes the activity names and the name of each property that was changed.

The following table lists additional parameters that are included by default in events.

Parameter

Description

In-Query Representation (on a selected event)

customDimensions

A detailed collection of data and parameters related to every event.

customEvents
| where name == "StudioStarted"
| extend customDimensions

Context

A part of the customDimensions collection that handles details about the project, including profile, user ID, license type, robot type, session ID.

customEvents
| where name == "StudioStarted"
| extend Context = parse_json(customDimensions.Context)

Environment

A part of the customDimensions collection that consists of the machine name, OS version, and username.

customEvents
| where name == "StudioStarted"
| extend Environment = parse_json(customDimensions.Environment)

Log Analytics gives you the option to explicitly extend each data type that is part of the mentioned parameters to serve as a filter or to be used as an additional summarize element. To do this, click the three-dot icon next to a data element in the log, and then choose to either extend data or use it as a filter.

280280

See the following table for examples of extending or filtering data.

Data Example

In-Query Representation (on a selected event)

ApplicationName (extend)

customEvents
| where name == "StudioStarted"
| extend ApplicationName = tostring(customDimensions.ApplicationName)

LicenseType (extend)

customEvents
| where name == "StudioStarted"
| extend LicenseType = tostring(parse_json(tostring(customDimensions.Context)).LicenseType)

OSVersion (filter included)

customEvents
| where name == "StudioStarted"
| where parse_json(tostring(customDimensions.Environment)).OSVersion == "Microsoft Windows NT 10.0.19043.0"

CurrentLanguage (filter included)

customEvents
| where name == "StudioStarted"
| where parse_json(tostring(customDimensions.Context)).CurrentLanguage == "en"

既知の問題

  • The PublishProject event only displays details for projects published to Orchestrator.
  • The S.Activities.ActivityAdded event displays an incorrect package version.

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

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

備考

  • 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.
  • ガバナンス ファイルは資格情報を提供できません。つまり、セキュリティを確保したフィードには対応していないということです。
  • カスタム ルールセットを適用した場合、ユーザーはワークフロー アナライザーのルールを一切変更できなくなります。
  • カスタム ルールセットがガバナンス ファイルで参照されていない場合、またはガバナンス ファイルに組み込まれていない場合、ワークフロー アナライザーの既定のルールが適用されます。"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.

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

📘

注:

We recommend configuring and deploying policies using Automation Ops. For more information on how to create policies from governance files generated from Studio, see Create a Governance Policy in the Automation Ops Guide.

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

If stored locally, the governance file must be located at the following path: %AppData%\UiPath です。

外部ファイルを使用する

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

To define the file path using the Windows Registry:

  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

To define the file path using an Orchestrator asset:

  1. Orchestrator で [テナント] > [フォルダー] を選択し、uipath.settings.config という名前の新しいフォルダーを追加します。
  2. ガバナンス ポリシーを適用するユーザーをフォルダーに割り当てます。
  3. uipath.settings.config フォルダーで新しいアセットを作成し、次のように設定します。
    • アセット名 - uipath.studio.governancesource
    • 種類 - テキスト
    • グローバル値 - このオプションを選択し、uipath.policies.config ファイルへのフル パスをテキスト ボックスに入力します。
      必要に応じて、ユーザー単位で異なるファイル パスを含む値を追加して、ユーザーごとに別々のポリシーを適用できます。
796796

Orchestrator のアセットを使用する

  1. Orchestrator で [テナント] > [フォルダー] を選択し、uipath.settings.config という名前の新しいフォルダーを追加します。
  2. ガバナンス ポリシーを適用するユーザーをフォルダーに割り当てます。
  3. uipath.settings.config フォルダーで新しいアセットを作成し、次のように設定します。
    • アセット名 - uipath.studio.governancepolicy
    • 種類 - テキスト
    • グローバル値 - このオプションを選択し、uipath.policies.config ファイルの内容全体をテキスト ボックスに貼り付けます。
      必要に応じて、ユーザー単位の値を追加し、さまざまなパラメーターを貼り付けて、ユーザーごとに別々のポリシーを適用できます。

📘

注:

Enforcing a governance policy using an Orchestrator asset that references the file path or holds the contents of the file requires Orchestrator v2020.10 or later with modern folders.

794794

適用と優先順位

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

10141014

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

10141014

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

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

約 1 か月前に更新

ガバナンス


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

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