トリガー

トリガーは、コネクタ プラットフォームからイベントを設定するための統一されたメカニズムです。この機能を使用することで、Orchestrator からオートメーションまたはプロセスを自動的に開始する柔軟性が得られます。

前提条件

トリガーを設定する前に、次の条件が満たされていることを確認してください。

• Integration Service はテナントに対して有効化され、プロビジョニングされている。
• [Integration Service] の画面内に [トリガー] タブが表示されている。
• Orchestrator インスタンスで Unattended または NonProduction ロボットが設定済みである。

• モダン フォルダーを使用している (クラシック フォルダー内のプロセスは、トリガーを定義するときに表示されない)

  注:

  トリガーはモダン フォルダーでのみサポートされています。 クラシック フォルダーは、モダン ユーザー ID のパラダイムをサポートしていません。そのため、コネクション全般やトリガーをサポートできません。

プロセスを作成する

通常どおりに UiPath® Studio でプロセスを作成します。 Integration Service を使用すると、あらゆるプロセスに対して任意のオートメーションをトリガーできます。

レコードの詳細を受け取る場合は、以下の手順に従います。

• ワークフローでプロセスを実際にトリガーした、コネクタ、イベント、レコードの種類、またはレコードを確認する場合は、プロセス内で以下の String 型の入力引数を定義します。

  Integration Service が、ジョブの開始時にこれらの引数を自動的に設定します。

  • UiPathEventConnector
  • UiPathEvent
  • UiPathEventObjectType
  • UiPathEventObjectId
    注: 引数の動作と管理方法の詳細については、こちらをご覧ください。
• ジョブの実行時に、トリガーが設定されたレコードを取得・操作するには、 UiPathEventObjectId 入力引数を使用してソース システムからレコードを取得します。

以下に、Integration Service がどのように入力引数値を渡しているか、例を示します。

プロセスをパブリッシュする

通常の手順に従って、プロセスを Orchestrator にパブリッシュします。プロセスは、[Shared] フォルダーまたは個人の [My Workspace] にパブリッシュできます。プロセスは、作成したパッケージから作成してください。

トリガーを設定する

トリガーを追加するには、次の手順に従います。

1. Automation Cloud^TM にアクセスします。
2. 左のメニューから [Integration Service] をクリックします。[Integration Service] の画面には、[コネクタ]、 [コネクション]、[トリガー] の 3 つのタブがあります。
3. [トリガー] タブを開き [トリガーを追加] ボタンをクリックします。
4. それぞれのドロップダウン メニューから、目的の コネクタ と コネクション を選択します。選択した特定のコネクタに対して構成されたコネクションが 1 つしかない場合は、そのコネクションが自動的に選択されます。

5. それぞれのドロップダウン メニューから、目的のイベントとレコードを選択します。

   注: イベントの種類はコネクタによって異なります。
6. 右側で、 実行するプロセスを選択します。

7. ドロップダウンからランタイム ライセンス (トリガーによって起動されるジョブの実行に使用されるランタイム) を選択します。利用可能なオプションは次の通りです。 NonProduction、Unattended、Headless、TestAutomation、AutomationCloud、Serverless、Development

   • 表示されるランタイムのリストは、Orchestrator から受け取った応答、すなわちそのフォルダーに対して「割り当てられた」ランタイム ライセンスに基づきます。選択したランタイムに対して、割り当てられているランタイムの数を示すメッセージが表示されます。
   • 詳細については、『UiPath Orchestrator ガイド』の「トリガーを管理する」ページと『概要ガイド』の「サービス ライセンス」ページの「ランタイム (ロボット ライセンス)」セクションをご覧ください。
8. [トリガーを追加] ボタンをクリックしてトリガーを作成し、アクティブ化します。

または、[コネクション] タブから新しいトリガーを作成できます。そのためには、次の手順に従います。

1. コネクションの [その他のアクション] ボタンをクリックします。
2. [トリガーを追加] オプションを選択します。
3. それぞれのドロップダウン メニューから、目的のイベントとレコードの種類を選択します。この場合、 コネクタ と コネクション は既に選択されており、変更できません。
4. 右側で、 [実行するプロセス]と、それぞれの [ランタイム ライセンス] を選択します。

5. [トリガーを追加] ボタンをクリックしてトリガーを作成し、アクティブ化します。

   注:

   現在、イベントの監視は 5 分ごとにポーリングするように設定されています。そのため、関連するプロセスが開始されるまでに最大で 5 分かかる場合があります。

   ジョブの詳細は、Orchestrator フォルダーの [ジョブ] タブで確認できます。Integration Service から開始したジョブの場合、[Integration Serviceトリガー] がソースとして表示されます。

イベント

コネクタはポーリング メカニズムを通じてイベントをサポートしています。コネクタ カタログ内のほとんどのコネクタにおいて同様にサポートされます。

Integration Service では、以下の 2 種類のイベントがサポートされています。

1. 作成、更新、削除などの一般的な操作を表します。一般イベントを選択する場合、監視するイベント レコードも定義する必要があります。たとえば、カレンダー/予定表レコード用の [新しいレコードの作成時] です。

   
   

   

   
   

2. 特定のオブジェクトに対する特定のアクションを表す定義済みの操作です。たとえば、[カレンダーの予定の作成時]/[予定表イベント作成時] です。

   
   

   

   
   

イベントの詳細については、各コネクタのページをご覧ください。

データ フィルター

トリガーのイベントを定義する際は、さらに細かくフィルター処理設定を追加できます。

[データ フィルター] を使用すると、特定のデータ パターンに一致するトリガーを設定できます。つまり、ロボットの起動回数が減るとともに、オートメーション内に追加のフィルター処理を適用する必要がなくなります。

ポーリング間隔

新しいコネクションを作成し、そのコネクションにイベント トリガーを設定すると、ポーリング間隔は既定で 5 分に設定されます。

この間隔は、ポーリング間隔を調整する機能を使用してカスタマイズできます。これにより、イベント トリガーが新しいオブジェクト イベントを確認する間隔を選択できます。

重要: コネクションには複数のトリガーを設定できますが、コネクションごとに設定できるポーリング間隔は 1 つのみです。ポーリング間隔を変更すると、コネクションに関連するすべてのトリガーに影響が出ます。

ポーリングは、選択した間隔でコネクションに実行されます。データが取得されると、そのコネクションに対するアクティブなトリガーはすべてデータ セットに適用されます。ポーリング間隔の変更時にポーリングが実行されている場合は、サービスは既存のポーリングが終了するまで待機してから、新しいポーリングを開始します。

ポーリング間隔を変更する

ポーリング間隔は、特定のコネクタのページまたは [ 接続 ] タブから変更できます。

1. Automation Cloud^TM で Integration Service にアクセスします。
2. [コネクタ] ページに移動し、コネクタを選択します。
3. コネクタのページでコネクションを選択して、コネクションの詳細ページを開きます。

4. コネクション名の下に表示される間隔をクリックします (以下を参照)。ポーリング間隔は、トリガーが追加されたコネクションに対してのみ表示されます。

   
   

   

   
   

あるいは、[コネクション] タブからポーリング間隔を設定できます。

1. Integration Service で [コネクション] タブに移動します。
2. 特定のコネクションを選択して、コネクションの詳細ページを開きます。
3. コネクション名の下に表示される間隔をクリックします。
4. [ポーリング間隔を更新] ウィンドウが表示されます。

5. 利用可能なオプションの 1 つを選択するか、 カスタム 間隔 (分単位または時間単位) を設定できます。 ポーリング間隔は 1 分を超え、24 時間または 1440 分以下である必要があります。

   
   

   

   
   

   誤った値を入力すると、「ポーリング間隔は 1 から 1440 分または 24 時間の自然数でなければなりません」という警告メッセージが表示されます。

6. [ 更新間隔] を選択します。

トリガーの実行履歴

トリガーの実行履歴は、[トリガー] タブでトリガーをクリックするだけで確認できます。新しいページでは、画面の下部に [試行の履歴]が表示されます。

この履歴には、Integration Service が受信したイベントと、プロセスが正常に開始されたかどうかが表示されます。正常に開始した場合、[ステート] 列に [成功] と表示されます。

注: [成功] ステートは、ジョブが正常に起動されたことを示します。ジョブが最後まで正常に実行されたかどうかを反映するものではありません。

重要: ジョブの開始に失敗した場合、[ステート] には [失敗] と表示されます。[失敗] ステートの上にマウス カーソルを置くと、エラー メッセージが表示されます。

ジョブが正常に実行されたかどうかを確認するには、[ジョブのログを表示] ボタンをクリックします。Orchestrator にリダイレクトされ、ジョブの実行に関する必要な情報がすべて表示されます。

トリガーを削除する

[Integration Service] 画面の [トリガー] タブに移動します。対象のトリガーに対応する [その他のアクション] ボタンをクリックし、[削除] を選択します。

トリガーの詳細表示

トリガーをクリックすると、詳細が表示されます。

トリガーをアクティブ化/非アクティブ化する

トリガーをアクティブ化または無効化するには、まずトリガーをクリックして詳細を表示する必要があります。次に、ウィンドウの左上隅にあるスイッチをクリックします。

失敗時にトリガーを自動的に無効化する

1 つのイベントに対して 11 回 (約 34 時間) 試行してもジョブが開始できない場合、または過去 100 回のイベントでジョブが開始されなかった場合、トリガーは無効化され、ステートがエラーに設定されます。

イベントごとに行われる 10 回のリトライは、エクスポネンシャル バックオフ方法を使用します後続のリトライは、前回の試行の 2 倍の時間待機した後に実行されます。

トリガーの名前を変更する

トリガーの名前を変更するには、以下の手順を実行します。

1. [トリガー] タブを開きます。

2. 変更するトリガーの名前にカーソルを合わせると、[編集] ボタンが表示されます。

   注: または、リストからトリガーを選択して詳細を表示することもできます。[編集] ボタンはトリガー名の右側にあります。
3. [編集] ボタンをクリックして、トリガーの新しい名前を指定します。

制限事項

現在、Integration Service の API は Swagger 経由では公開されていません。