主要な概念

Cronの設定について学ぶ前に、Catalyst Cronに関する特定の主要な概念と用語を理解しておくことが重要です。

タスクエンジン

タスクエンジンはCronのバックエンドロジックを処理し、定義されたスケジュール時刻に従ってCronジョブの実行を処理します。

スケジュールポイント

スケジュールポイントは、Cronジョブが実行された際にトリガーするエンティティを決定します。Cronは以下のいずれかをトリガーできます：

• Function: 必要な一回限りまたは定期的なルーチンジョブを実行するためにCron Functionをコーディングできます。必要に応じて、関数が呼び出されたときにこのターゲット関数にパラメータ値を動的に渡すことができます。パラメータにプレースホルダーを挿入することもできます。プレースホルダーは、渡される動的な値の代表変数です。実行時に値が生成されると、プレースホルダー変数が置き換えられます。

• サードパーティURL: Cronの実行がサードパーティURLを呼び出すと、指定したターゲットURLにHTTPリクエストを送信します。これにより、Catalystと指定されたターゲットURL間でデータ転送が行われ、Catalystが送信先サーバーからデータを読み取ったり、アプリケーションのデータをサーバーの対応するコンポーネントに入力したりできます。サードパーティURLへのリクエスト送信には以下のコンポーネントが関係します：

  • HTTPリクエストメソッド
    CronによるサードパーティURLの呼び出し時に、以下のHTTPリクエストメソッドがサポートされます：

    • POST: ターゲットURLに新しいリソースを作成します
    • GET: ターゲットURLからデータを取得します
    • PUT: ターゲットURLの既存のリソースを置き換えます
    • DELETE: ターゲットURLの既存のリソースを削除します

  • ヘッダー
    HTTPリクエストがターゲットURLに送信される際、リクエスト元のエンティティはリクエストに関する情報を提供するためにデフォルトヘッダーをリクエストに含めて送信します。デフォルトヘッダーの例としては、リクエストの発信元、接続タイプ、Content-Typeなどがあります。
    

    デフォルトヘッダーに加えて、HTTPリクエストにカスタムヘッダーを定義することもできます。例えば、使用する認証タイプを指定するヘッダー、許容されるエンコーディングのリスト、またはリクエストの発信日を含めることができます。
    

    注意: リクエストでHTTP POSTまたはPUTメソッドを使用する場合、ヘッダーで送信されるデータのcontent-typeを設定する必要があります。サポートされるcontent-typeは、TEXT (text/plain)、JSON (application/JSON)、JavaScript (application/javascript)、XML (application/xml)、XML (text/xml)、HTML (text/html)です。

  • URLパラメータ
    ユーザー定義形式のカスタムURLパラメータをHTTPリクエストとともに渡すことができ、その値はサードパーティURLが呼び出された際に動的に設定されます。パラメータ値をカスタマイズし、パラメータに渡す必要のある任意の項目を含めることができます。

  • リクエストボディ
    URLの呼び出し時にオプションのHTTPリクエストボディを含めることができ、フォームデータやその他のオプションデータを送信するために使用できます。フォームデータはオプションのメッセージボディ内でさまざまな形式で渡すことができます。

• Circuits: Circuitsコンポーネントを使用して自動化されたワークフローを作成し、一回限りまたは繰り返しでトリガーするようにCronジョブを設定できます。コンソールのServerlessセクションから、簡単なドラッグ＆ドロップまたはJSONでのワークフローのコーディングにより、Circuitを作成してスキーマを設計できます。その後、Cronの作成時にCircuitを関連付けることができます。関連するCircuitに渡す入力をJSON形式で設定する必要があります。Functionと同様に、JSON入力にプレースホルダー値を提供することもできます。Circuitsを使用すると、一連のタスクを並列または順次に実行し、タスク間でデータを渡すことができます。

スケジュールタイプ

スケジュールタイプは、Cronジョブの実行頻度を決定します。Cronは以下の2つの方法のいずれかで実行できます：

• 一回限り: Cronジョブは設定された日時に一度だけトリガーされます。
• 繰り返し: Cronジョブは、無効化または削除するまで、設定した頻度、日付、時刻に基づいて繰り返しトリガーされます。Cronがトリガーされる最小の繰り返し頻度は1時間です。

実行ID

各CronジョブにはCronの呼び出し時に一意の実行IDが割り当てられます。このIDを使用して、アプリケーションコード内または実行ログの表示時にCronジョブを参照できます。