API Tasks のスケジュール設定方法

API Taskをスケジュール設定することで、Bot Runner のインフラストラクチャ (ユーザーおよびデバイス) に依存しないオートメーションを開始できます。Cloud上で API Tasksが実行されるため、個々のユーザー ライセンスが不要になり、コスト削減とオートメーション管理の簡素化が実現します。

利用可能な API Tasksをスケジュール設定して、特定の時間に実行できます。たとえば、毎週水曜日の午後 5 時に実行される .csv ファイルで、請求書のバッチを処理します。
注: Control Room で API Tasksをスケジュール設定するには、Enterprise Platform ライセンスが必要です。「Enterprise Platform」を参照してください。

前提条件

Control Room に管理者または次の権限を持つユーザーとしてログインしていることを確認します。
  • マイ Bot の実行をスケジュール
  • 特定の API Taskおよび依存関係のフォルダー レベルの [マイ フォルダーのすべてのスケジュール設定済みアクティビティをマネージ] 権限
  • 実行ユーザー API Tasks。

    詳細については、「API タスクの実行ユーザー (apitaskrunner)」を参照してください。

手順

  1. Control Room にログインします。
  2. 左パネルで以下のいずれかの方法を選択し、スケジュールを作成します。
    • [オートメーション] をクリックします。

      スケジュールを作成する API Taskの右側にあるアクション メニュー (縦の 3 点リーダー) をクリックし、[API タスクをスケジュール設定] をクリックします。

    • [管理] > [スケジュール] > [スケジュールの作成] をクリックします。
    [オートメーションと依存関係] 画面が表示されます。また、[選択] オプションをクリックして、特定の API Taskを見つけることもできます。
  3. スケジュール設定する API Taskを選択し、[選択] をクリックします。
    さまざまなタブがある [スケジュールを作成] 画面が表示されます。
  4. [オートメーションと依存関係] タブを使用して、以下のフィールドを確認して、更新します。
    • オートメーション ファイル: 選択した API Taskが表示されます。

      別の API Taskを選択する場合は、[選択] をクリックします。

    • 以下でオートメーションと依存関係を実行: 実行する API Taskのバージョンを、以下のいずれかから選択します。
      • 最新バージョン: 最新バージョンを使用して、選択した API Taskと依存関係をスケジュールします。
      • 本番環境ラベル: 製品バージョンを使用して、選択した API Taskと依存関係をスケジュールします。

      デフォルトでは、最新バージョンの API Task が選択されています。

    • 依存関係: 選択した API Task の依存関係のリスト。
  5. [次へ] をクリックします。
  6. API Taskにスケジュール設定の詳細を追加します。
    [スケジュール] フィールドで、以下のいずれかのオプションを選択します。
    • 繰り返しなし: 指定した日時に API Task を 1 回実行します。

      以下のオプションを使用して、[繰り返しなし] 設定を構成します。

      • 開始日: デフォルト値は現在の日です。
      • 開始時刻: デフォルト値は、次の 30 分に切り上げられます。
      • タイム ゾーン: ローカル デバイスのシステムのタイム ゾーン。
        注: [EST]、[HST]、[MST] のタイム ゾーンは非推奨です。「Upcoming feature deprecations」を参照してください。
    • 繰り返し実行: このオプションを使用して、特定の日の指定した時間に API Taskを実行するようにスケジュール設定します。

      以下のオプションを使用して、[繰り返し実行] 設定を構成します。

      • 開始日: API Task の実行の開始をスケジュール設定する場合に日付を入力します。

        日付は、YYYY-MM-DD 形式で手動入力するか、ポップアップ カレンダーを使用して入力します。[開始日] フィールドのデフォルト値は、ローカル デバイスで設定されている現在の日付です。

      • 終了日: 終了をスケジュール設定する場合に日付を入力します。

        [終了日] はデフォルトでは設定されません。

      • 開始時刻: ドロップダウンリストを使用して [開始時刻] を入力し、開始時刻をスケジュール設定します。

        このリストには、事前定義された時刻の値が 15 分間隔の 12 時間形式で表示されます。また、時刻の値を 12 時間形式で手動で設定することもできます。

      • タイム ゾーン: 開始時刻と終了時刻の両方で [タイム ゾーン] を選択します。

        デフォルト値は、システムの現在の場所に設定されます。スケジュールは、スケジュールの作成時または編集時に選択されたタイム ゾーンに基づいて実行されます。

      • 次の間隔で繰り返す: このオプションを選択すると、スケジュールが繰り返されます。
    • 頻度: スケジュールを実行する頻度として、以下のオプションのいずれかを選択します。
      • 日ごと: スケジュールを実行する日数を選択します。
      • 週ごと: スケジュールを実行する間隔の週数と特定の曜日を選択します。

        たとえば、2 週間ごとに月曜日と木曜日にスケジュールを実行する場合、[次の間隔で繰り返す] オプションの数字を 2 に増やし、[月曜日] と [木曜日] のチェックボックスを選択します。

      • 月ごと: 次のいずれかのオプションを選択します。
        • 日付指定: スケジュールを実行したい月の日付を選択します。
        • 週指定: スケジュールを実行したい月の特定の日を選択します。

          たとえば、1 月、5 月、9 月の第 2 木曜日にスケジュールを実行する場合、表示されたオプションから第 2 木曜日、1 月、5 月、9 月を選択します。

        注: サマータイムが有効で、[開始日] がスケジュール設定されている場合、開始日は、その開始日が属するタイム ゾーン (ユーザーの現在のタイム ゾーンではない) で表示されます。ただし、[次の出現] は、サマータイムに従ったタイム ゾーン (ユーザーのシステム タイム ゾーン) で表示されます。

        たとえば、GMT タイム ゾーンの 3 月 15 日に作成されたスケジュールの場合、[開始日] は GMT タイム ゾーンに属する「Mar-15th」と表示されます。その後、サマータイムが有効になり、BST タイム ゾーンの 8 月にこのスケジュールを編集または表示すると、[次の出現] が BST タイム ゾーンに属する 8 月で表示されます。

        タスクを 2023 年 11 月 23 日午前 9:00 から 2023 年 11 月 30 日午前 9:00 まで実行するようにスケジュールし、頻度を日ごとに設定した場合、タスクは 2023 年 11 月 23 日午前 9:00 から毎日実行され、最後のタスクは 2023 年 11 月 30 日午前 9:00 に実行されます。

    • [失敗したスケジュールの設定] セクションで、[スケジュールをもう一度再デプロイ] チェックボックスを選択して、Control Room のシャットダウンのために実行されなかったスケジュールを再デプロイします。

      [スケジュールをもう一度再デプロイ] オプションが選択されている場合、Control Room のシャットダウンのために実行されなかったスケジュールは、Control Room が再起動した後、自動的に再デプロイされます。監査ログ エントリもイベント タイプを表示する Schedule misfired として追加されます。

      注: デプロイを成功させるには、[スケジュールをもう一度再デプロイ] オプションを使用する場合、Control Room サービスを再起動する前にコンパイラー サービスを開始する必要があります。
  7. [次へ] をクリックします。
  8. 以下の場合、[実行ユーザー] タブを使用します。
    • [利用可能な実行ユーザー] テーブルのリストからユーザーを選択し、下矢印をクリックして選択内容を追加します。

      選択したユーザーは [選択済み] テーブルにリストされます。上矢印を使用して、選択したユーザーを削除できます。

      注: apitaskrunner というユーザーが生成され、AAE_API Task Runner ロールに関連付けられて、API Tasks の実行ユーザー コンテキストが確立します。
    • [使用する実行ユーザー数を定義する] フィールドで、以下のいずれかを選択します。
      • すべての実行ユーザー: API Task の実行中に、[選択済み] テーブルで利用可能なすべてのユーザーを実行ユーザーとして指定するには、このオプションを選択します。
      • 実行ユーザーの数をカスタマイズする: 特定の数のユーザーを [選択済み] テーブルから提供して実行ユーザーとして使用するには、このオプションを選択します。

        たとえば、[選択済み] テーブルに 5 人のユーザーがいて、そのうち 3 人だけを実行ユーザーとして使用する場合は、「3」と入力します。テーブルの上から 3 人のユーザーは、API Task 実行時に実行ユーザーとして使用されます。

  9. [次へ] をクリックします。
  10. オプション: [一般] タブを使用して、以下のオプションのデフォルト設定を変更します。
    • アクティビティ名: API Task を編集するか、名前を変更します。
    • オートメーションの優先度: ドロップダウン メニューをクリックして、オートメーションの優先度を設定します。

      [中] はデフォルトのオートメーションの優先度です。これは、オートメーションのデプロイの処理に応じて変更できます。

  11. [スケジュールを作成] をクリックします。
    API Taskのスケジュールが作成されます。スケジュールされた API Tasksのステータスは、[マネージ] > [スケジュール作成済み] ページで表示することができます。