Webhook の AppSettings.json

appsetting.json ファイル (C:\Program Files (x86)\UiPath\Orchestrator\Webhooks) には Webhook サービスの設定が含まれています。そのままの設定で Webhook を使用できます。カスタム設定は appsetting.Production.json 内で行うことをお勧めします。このファイルによって、各インストール処理の後に appsetting.json 内の既存の設定が上書きされます。

注: これらのパラメーターの値は管理者のみが変更してください。

さらに、どのような状況でも appsetting.Production.json の設定を変更できるように、IIS サーバーを停止することをお勧めします。

このページに記載されていないパラメーターは、変更しないでください。

すべてのパラメーターは、大文字と小文字を区別します。

設定の優先度

設定は複数の場所で行えます。設定値を決定する際に Webhook サービスで使用される優先度を、高 (1) から低 (3) までで次に示します。

appsettings.Production.json ファイル内の値
appsettings.json ファイル内の値
コード内の既定値。特定の設定が appsettings.Production.json または appsettings.json に見つからない場合にのみ使用されます。

設定

appsettings.json ファイルはコンマで区切られた複数の json セクションで構成される内部構造を持っています。

Orchestrator SQL のクライアント設定

"OrchestratorSqlClientSettings": {
    "ConnectionString": "<OrchestratorConnectionString>",
    "Enabled": true
  },"OrchestratorSqlClientSettings": {
    "ConnectionString": "<OrchestratorConnectionString>",
    "Enabled": true
  },

`ConnectionString`

接続先の Orchestrator インスタンスによって生成される接続文字列です。

Webhook サービスの設定

"WebhookServiceConfig": {
    "MaxWorkerCount": 10,
    "HttpClientUserAgent": "UiPath-WebhookService/Webhooks",
    "RequestTimeout": "0.00:01:00",
    "RetryAfter": [
      "0.00:00:0",
      "0.00:00:45",
      "0.00:02:30",
      "0.00:05:00"
    ],
    "MaxRetryRequests": 2    
    "SubscriberCircuitBreakerExpirationSeconds": 600
  },"WebhookServiceConfig": {
    "MaxWorkerCount": 10,
    "HttpClientUserAgent": "UiPath-WebhookService/Webhooks",
    "RequestTimeout": "0.00:01:00",
    "RetryAfter": [
      "0.00:00:0",
      "0.00:00:45",
      "0.00:02:30",
      "0.00:05:00"
    ],
    "MaxRetryRequests": 2    
    "SubscriberCircuitBreakerExpirationSeconds": 600
  },

`RequestsTimeout`

各 HTTP 要求がキャンセルされるまでの時間です。タイムアウトした要求は、RetryAfter の値に従ってリトライされます。既定のタイムアウト時間は 1 分です。

`RetryAfter`

失敗した要求がリトライされるまでの時間 (秒) です。既定では、次のように 4 回のリトライが定義されています。

1 回目のリトライ要求は、最初の試行が失敗した直後に実行されます。
2 回目のリトライは、1 回目のリトライが失敗してから 45 秒後に実行されます。
3 回目のリトライは、2 回目のリトライが失敗してから 2 分と 30 秒後に実行されます。
4 回目のリトライは、3 回目のリトライが失敗してから 5 分後に実行されます。

エントリを少なくするか、または MaxRetryRequests の値を小さい値に設定すると、リトライの数を変更できます。最初のリトライは必ず 0 に設定し、リトライ間に 300 秒 (5 分) より長い時間は設定しないことをお勧めします。

`MaxRetryRequests`

要求が失敗した場合に実行されるリトライの最大数です。

`MaxWorkerCount`

テナントごとに有効化できる Webhook の最大数です。既定では 10 に設定されています。

`SubscriberCircuitBreakerExpirationSeconds`

失敗を報告したサブスクライバーへのメッセージの送信を Webhook が停止する時間 (秒単位) です。既定ではこの値は 600 に設定されています。パラメーターの値が 0 に設定されている場合、この機能は無効化され、失敗は無視されます。このパターンの動作について詳しくは、こちらをご覧ください。

Ledger の設定

"LedgerConfiguration": {
    "Enabled": true,
    "Subscribers": [
      {
        "LedgerComponentType": 0,
        "ComponentId": "WebhookSubscriber",
        "Topics": null,
        "ConnectionString": "<OrchestratorConnectionString>",
        "EstablishNewConnection": false,
        "LedgerSubscriberDeliveryType": 1,
        "LedgerSubscriberReliability": 1,
        "Enabled": true,
        "LedgerComponentClassType": 2,
        "Context": "{\"BatchSize\": 500, \"DeliveriesBatchSize\": 500}"
      }
    ]
  },"LedgerConfiguration": {
    "Enabled": true,
    "Subscribers": [
      {
        "LedgerComponentType": 0,
        "ComponentId": "WebhookSubscriber",
        "Topics": null,
        "ConnectionString": "<OrchestratorConnectionString>",
        "EstablishNewConnection": false,
        "LedgerSubscriberDeliveryType": 1,
        "LedgerSubscriberReliability": 1,
        "Enabled": true,
        "LedgerComponentClassType": 2,
        "Context": "{\"BatchSize\": 500, \"DeliveriesBatchSize\": 500}"
      }
    ]
  },

`ConnectionString`

接続先の Orchestrator インスタンスによって生成される接続文字列です。

"ApplicationInsights": {
    "InstrumentationKey": "<AI_InstrumentationKey>"
  },"ApplicationInsights": {
    "InstrumentationKey": "<AI_InstrumentationKey>"
  },