通知を受け取る

UiPath Orchestrator

UiPath Orchestrator ガイド

設定

[設定] ページでは、管理者が Orchestrator のテナント設定を調整できます。

[全般] タブ


FieldDescription
Application SettingsTime Zone - The time zone of the tenant. By default, this field is set to UTC.
Personal WorkspacesEnable Personal Workspace - Create personal workspaces for all users in a tenant that use a certain attended licensing profile, while also selecting the UI profile to be used for those users.

Note: This action cannot be reversed, once the Personal Workspaces feature is enabled it cannot be disabled.
Standard RolesCreate standard roles for modern folders. These roles allow you to leverage the benefits of user groups.

Click Create Role next to each of the roles you want create.
Client Binaries (Robot, Studio, Assistant) Auto-Update SettingsIgnore auto-update status for robot machines that were offline for more than ___ days - Exclude inactive machines from the update process and no longer take them into account when the update status is reported.
Modern FoldersEnable account-machine mappings - Enable the Account-Machine Mappings feature.
Classic FoldersActivate Classic Folders - Enable classic folders.
Note: Classic folders are deprecated. Enabling them is only recommended if you migrate from an on-premises Orchestrator deployment to Orchestrator in Automation Cloud.

実行設定セクション

Field / Default valueDescription
Triggers - Jobs count strategy
(Triggers.JobsCountStrategy)

Default value: Per Process
Choose the job count strategy for jobs launched through triggers.
Note that this doesn't take into account any arguments that may have been provided.

The following options are available:
Per Process - This is the default value. A trigger launches the required number of jobs taking into account any pending jobs for the specified process. For example, two triggers defined for the same process launch 3 and 5 jobs, respectively. If the first trigger launches 3 jobs at a given point in time, when the second trigger is set off, 2 jobs are launched so as to reach the 5 required jobs.
Per Trigger - A trigger launches the required number of jobs taking into account any existing jobs previously launched by that same trigger. For example, a trigger is defined to launch 5 jobs at a given point in time. If 3 jobs have been successfully completed by the time this trigger is set off again, Orchestrator launches another 2 jobs so as to reach the 5 required jobs.
Triggers - Queue triggers pending jobs strategy
(Features.QueueTriggers.PendingJobsStrategy)

Default value: True
Choose the computation method for the number of additional jobs to be triggered when new items are added to a queue. This is done by subtracting the number of jobs in a certain state from the maximum targeted number of jobs to be created.

The following options are available:
True - This is the default option. It is best suited for cases where you want Orchestrator to assume that all running jobs have already moved queue items out of the status New.
The number is computed as follows:
Maximum additional jobs to be created based on newly available queue items = the maximum number of pending and running jobs allowed simultaneously minus the number of jobs in a Pending state.
False - This option is best suited for cases where you want Orchestrator to assume all running jobs have yet to move queue items out of the status New.
The number is computed as follows:
Maximum additional jobs to be created based on newly available queue items = the maximum number of pending and running jobs allowed simultaneously minus the number of jobs in one of these states: Pending, Resumed, Running, Stopping, Terminating.
Triggers - Disable when failed count
(Triggers.DisableWhenFailedCount)

Default value: 10
Configure a trigger to get disabled automatically after a certain number of failed launches and no successful runs occurring in a specific number of days.

This option works in conjunction with Triggers - Disable when it keeps failing count (days), as follows: Triggers - Disable when failed count allows you to adjust the number of failed runs, whereas Triggers - Disable when it keeps failing count (days) enables you to change the number of days.
By default, the Triggers - Disable when failed count value is 10, and the Triggers - Disable when it keeps failing count (days) value is 1, which means that the trigger is disabled after 10 unsuccessful attempts to launch if there were no successful runs in the past day.

This option can be set within a range from 10 to 100, with 10 being the default value.
Triggers - Disable when it keeps failing count (days)
(Triggers.DisableWhenFailingSinceDays)

Default value: 1
Configure a trigger to get disabled automatically after a certain number of failed launches and no successful runs occurring in a specific number of days.

This option works in conjunction with Triggers - Disable when failed count, as detailed above.

It can be set within a range from 1 to 30, with 1 being the default value.
Queues - Abandon in progress queue items after threshold (hours)
(inProgressMaxNumberOfMinutes)

Default value: 24
Set the maximum amount of time, in hours, that queue items can have the In Progress status. After this time, the status of the queue items changes to Abandoned.
The default value is 24 hours, which means that queue items cannot be marked as Abandoned unless they have had the In Progress status for at least one day.

This is handled by a background job which runs once every hour. Hence, you can expect the transition to happen up to one hour after the selected value.
Jobs - Terminating timeout (hours)
(Jobs.TerminatingJobsTimeout)

Default value: 24
Set the time elapsed, in hours, until Terminating jobs become fit to be marked as Failed.
The default value is 24, which means that jobs cannot be marked as Failed unless they have been in a Terminating state for at least one day.

This is handled by a background job which runs once every hour. Hence, you can expect the transition to happen up to one hour after the selected value.

[デプロイ] タブ


Enables you to configure and secure feeds for packages and libraries. You can manage the feeds for all tenants from a centralized location using Automation Ops. For more information, see feeds management in the Automation Ops guide.

ここでの設定は、テナント フィードにのみ影響します。フォルダー フィードと個人用ワークスペース フィードは常に内部フィードであり、各フォルダーまたは個人用ワークスペースのコンテキストでのみ使用できます。

パッケージ

オートメーション パッケージを維持できる内部フィードまたは外部フィードを設定できます。既定では、内部フィードが使用されます。基本認証の資格情報を定義するか、API キーを使用して、フィードのセキュリティを保護できます。

FieldDescription
InternalUse an internal feed. The feed can be secured either with the Secure Deployment option or by using an API key:
Secure Deployment - Ensures that your automation packages are downloaded through a secure NuGet feed.
API Key - The key used to secure your feed against write operations such as delete or upload.
ExternalUse an external feed. The feed can be secured either by using an API key or basic authentication credentials:
API Key - The key used to secure your feed against write operations such as delete or upload.
Authentication - Enables you to specify the credentials for your basic authenticated feed.
Please keep in mind that both the username and the password used with the API Key option should be used in this case as well.

When External is selected, the Deployment URL field is displayed where you need to fill in the address where the NuGet feed is located.

ライブラリ

ライブラリおよびアクティビティ パッケージに使用されるフィードを設定できます。

FieldDescription
Only host feedLibraries are stored in the host feed and are available to all tenants which use it. The Libraries page is the same for one Orchestrator instance, meaning libraries are not isolated at the tenant level: each tenant has access to the other tenants' activity.
🛈 You cannot upload libraries from Orchestrator if this option is selected.
🛈 This option gives robot access to the host feed only.
Only tenant feedLibraries are isolated at the tenant level, meaning data is separated across tenants. You may set an internal or an external feed in which libraries are maintained. By default, an internal feed is used.
🛈 This option gives robot access to the tenant feed only.
Both host and tenant feedsLibraries are isolated at the tenant level, meaning data is separated across tenants. You may set an internal or an external feed in which libraries are maintained. By default, an internal feed is used.
🛈 This option gives robot access to both the host and tenant feeds.
InternalDisplayed when Only tenant feed or Both host and tenant feeds is selected.
Use an internal feed for your libraries. The feed can be secured either with the Secure Deployment option or by using an API key:
Secure Deployment - Ensures that your automation packages are downloaded through a secure NuGet feed.
API Key - The key used to secure your feed against write operations such as delete or upload.
ExternalDisplayed when Only tenant feed or Both host and tenant feeds is selected.
Use an external feed for your libraries. The feed can be secured either by using an API key or basic authentication credentials:
API Key - The key used to secure your feed against write operations such as delete or upload.
Authentication - Enables you to specify the credentials for your basic authenticated feed.
Please keep in mind that both the username and the password used with the API Key option should be used in this case as well.

When External is selected, the Deployment URL field is displayed where you need to fill in the address where the NuGet feed is located.

プロキシサーバー経由で外部フィードを使用する場合の前提条件

Windows 上でプロキシサーバーを設定した状態で外部フィードを使用する場合は、あらかじめ次の手順を行っておく必要があります。

  • Orchestrator のアプリケーション プール ([インターネット インフォメーション サービス] > [アプリケーション プール][ユーザー プロファイルの読み込み]) オプションを True に設定します。
436
  • アプリケーション プール ID アカウント (NuGet.config) に関連付けられた C:\Users\[YourAppPoolIdentityAccountName]\AppData\Roaming\NuGet\NuGet.Config ファイルに使用したプロキシ設定を追加します。
<config>
<add key="http_proxy" value="http://ipaddress:port" />
</config>

📘

以下の設定は、Robot サービスがサーバーに接続するときにのみ読み込まれます。設定を変更した場合は、変更を有効化するために UiRobotSvc サービスを再起動する必要があります。

[メール] タブ


メール アドレスが設定されたユーザーにメール アラートを送信するためのメール設定が行えます。

Email Setup fieldDescription
Enable alerts emailWhen selected, email alerts are sent to users that have a valid email address and the Alerts - View permission.
Use default credentialsIf selected, your custom email settings are reverted to default.
The default settings are integrations of the SendGrid server.

Note: You can set the Default From Display Name to easily identify the alert mails in your inbox.
Use custom settingsIf selected, you can set up your own SMTP server to receive alert emails from.

Note: The following SMTP fields become available for configuration:
Enable SSLIf selected, the connection is secured. Depending on your SMTP server, an SSL or TLS certificate may be required for the SMTP domain, otherwise emails are not sent.
If cleared, the connection is not secured.
SMTP HostThe IP or domain of your SMTP server.
SMTP DomainThe SMTP domain for the username. This will be concatenated with the SMTP username, if the SMTP server requires authentication.
SMTP PortThe SMTP port. For example, if you are using a Gmail account to send mail messages and Enable SSL is not selected, the port should be 587. If Enable SSL is selected, the port should be 465.
SMTP UsernameThe username of the SMTP server, if it requires authentication. For example, if you are using Gmail, fill in this field with the email address to be used to send messages.
SMTP PasswordThe email account password.
Default From AddressThe email address from which to send alert mail messages.
Default From Display NameA custom display name for the email address from which you send alerts.
Test Mail SettingsValidates the email settings.

For more information, see Setting Up Email Alerts.

ロボットのセキュリティ タブ


セキュリティ

FieldDescription
Total hours a robot can run offline without license verificationSpecify the number of hours a Robot can run offline, without Orchestrator checking its license. By default, it is set to 0. The maximum accepted value is 168 hours.

ロボットの認証

FieldDescription

Attended robot authentication
Interactive Sign-in SSO (Recommended) - This option only allows for robot connections with tokens that expire. Users can authenticate their robots only by signing-in with their credentials in the Assistant.
Note: User sign in is required to run attended robots, make Orchestrator HTTP requests, or view processes in the Assistant. When using interactive sing-in, there is no need to create machine objects in Orchestrator.

Hybrid - This option allows for both connections with tokens that don't expire (machine key) and connections with tokens that expire (interactive sign-in or client credentials). Users have the option to sign-in with their credentials to authenticate their robots, which in turn allows them to connect Studio and the Assistant to Orchestrator, however it is not mandatory.
Unattended robot authenticationClient credentials (Recommended) - This option only allows for connections with tokens that expire. It uses the OAuth 2.0 framework as the basis for the authentication protocol, meaning unattended robots can connect to Orchestrator with a client ID - client secret pair generated via machine template objects. The client ID - client secret pair generates a token that authorizes the connection between the robot and Orchestrator and provides the robot with access to Orchestrator resources.

Hybrid - This option allows for both connections with tokens that don't expire (machine key) and connections with tokens that expire (client credentials).

[拡張性] タブ


Robot サービスが Orchestrator の SignalR チャネルをサブスクライブするかどうかを指定したり、最適なトランスポート プロトコルを設定したりします。

1570

SignalR (Robot)

FieldDescription
EnabledThis toggle specifies if the Robot service subscribes to Orchestrator's SignalR channels or not. By default, this setting is enabled, and all available channels are selected:
WebSocket
Server-Sent Events (SSE)
Long Polling

When all transport channels are enabled, the best available transport is automatically selected, in the following priority order: WebSocket > Server-Sent Events > Long Polling. If the first protocol is not available for any reason, the next in line (if enabled) is used to facilitate the communication between Orchestrator and Robot.
WebSocketWhen selected, enables the WebSocket transport protocol to be used to connect the Robot to Orchestrator's SignalR channels. This is the highest protocol used in the order of priority due to its performance and support for simultaneous communication in both directions - from the Robot service to Orchestrator and vice versa.

If the SignalR (Robots) feature is not enabled, WebSocket becomes the only available transport protocol.
Server-Sent Events (SSE)When selected, enables the Server-Sent Events (SSE) push technology to be used to connect the Robot to Orchestrator's SignalR channels. This is the first backup in case WebSockets is not available for any reason.

This option cannot be used if the SignalR (Robots) feature is not enabled.
Long PollingWhen selected, enables the long polling transport protocol to be used to connect the Robot to Orchestrator's SignalR channels. This protocol is used in case the WebSockets and SSE ones are not available.

This option cannot be used if the SignalR (Robots) feature is not enabled.

[非稼働日] タブ


トリガーの実行を制限する、非稼働日のリストをテナントごとに定義できます。つまり、祝日や土日など、通常の業務がない日には、長期スケジュールがトリガーされないように設定できます。定義された非稼働日を過ぎると、通常どおりにトリガーされるようになります。

これらの制約をトリガーに適用するには、トリガー設定時に非稼働日カレンダーを選択する必要があります。[非稼働日] タブで加えたすべての変更は、そのカレンダーを使用するすべてのトリガーに影響を与えます。

非稼働日の管理方法の詳細については、こちらをご覧ください。

クラウド接続


This tabs allows you to configure integrations with third-party cloud service providers (CSPs) which are used for elastic robot orchestration.

Cloud ロボットのイメージ


This tab lists captured images of customized machines that are used for Cloud Robot - VM.
カスタム イメージを管理する

1 日前に更新


設定


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

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