(🚧公開予定)定期実行

定期実行

定期実行は、アクションを指定したスケジュールで自動的に繰り返し実行する機能です。

毎日の定時レポート生成や、定期的なデータ同期など、繰り返し行なう業務を自動化できます。

前提条件

定期実行を作成するには、実行対象のアクションを事前に作成しておく必要があります。

必要なロール

定期実行の作成・管理には、以下のいずれかのロールが必要です。

  • プロジェクト管理者
  • 開発責任者
  • 開発者
  • アクション運用責任者

定期実行の一覧表示や実行履歴の閲覧は、すべてのプロジェクトメンバーが行なえます。

定期実行を作成する

  1. メニューバーで「定期実行の一覧」を選択して、定期実行の一覧画面に移動します。

  2. 「定期実行の追加」を選択します。

定期実行の追加フォーム。名前入力欄(例:日次レポート送信)、cron式切り替えトグル付きのスケジュール設定、曜日指定(日〜土の全曜日が選択済み)、実行時刻の指定(時刻指定モードで9時0分、追加ボタンあり)、アクション選択ドロップダウン、「この定期実行は現在選択中の環境『開発環境』に設定されます」という案内メッセージ、保存ボタンで構成されたUI。
  1. 以下の項目を入力します。

    • 名前: 定期実行の名前を入力します。1文字以上128文字以内で設定できます。
    • スケジュール: 実行スケジュールを設定します。詳しくはスケジュールの設定形式をご覧ください。
    • アクション: 実行するアクションを選択します。
    • パラメーター: 選択したアクションにパラメーターがある場合、実行時の値を設定します。
  2. 「保存」を選択して定期実行の作成は完了です。

定期実行は、現在選択中の環境に対して設定されます。アクションは定期実行の設定者として実行されます。

スケジュールの設定形式

画面上の入力フォームからスケジュールを設定します。実行日と実行時刻の組み合わせで指定します。

実行日

指定方法説明
曜日で指定特定の曜日に実行する毎週月曜日と金曜日
日にちで指定毎月特定の日に実行する毎月1日と15日

実行時刻

指定方法説明
時刻指定指定した時刻に実行する毎日9:00と18:00
毎時毎時、指定した分に実行する毎時0分と30分
一定間隔一定間隔で実行する5分ごと、2時間ごと

「一定間隔」を選択した場合、指定した値の倍数の時刻に実行されます。たとえば5分ごとの場合、毎時0分、5分、10分、…に実行されます。

スケジュールの時刻は日本標準時(JST)で設定されます。

cron式で入力

「cron式で入力」トグルを有効にすると、cron式を直接入力してスケジュールを設定できます。UI形式では表現できない複雑なスケジュールを設定したい場合に使用します。

定期実行を管理する

定期実行の一覧

定期実行の一覧画面では、以下の情報を確認できます。

項目説明
名前定期実行の名前
アクション実行するアクション名
スケジュール設定されたスケジュール
稼働状態現在の稼働状態
設定者定期実行を作成したユーザー名

一覧から定期実行を選択すると、詳細ページに移動します。

詳細ページ

定期実行の詳細ページでは、以下の情報を確認できます。

項目説明
名前定期実行の名前
アクション実行するアクション名
スケジュール設定されたスケジュール
次回の実行予定日時スケジュールに基づく次回の実行予定日時
次次回の実行予定日時スケジュールに基づく次次回の実行予定日時
パラメーターアクションに設定されたパラメーターの値

名前、スケジュール、アクションはそれぞれ詳細ページから編集できます。

稼働状態

定期実行の稼働状態は以下の通りです。

稼働状態説明
稼働中スケジュールに従って定期的に実行されている状態
停止中スケジュールの実行が一時的に停止されている状態

停止と再開

定期実行を一時的に停止できます。停止中はスケジュールに従った自動実行は行なわれません。

  1. 定期実行の詳細ページを開きます。
  2. 「停止」を選択すると、定期実行が停止されます。

停止した定期実行は、「再開」を選択することでスケジュールに従った自動実行を再開できます。

スケジュールの変更

  1. 定期実行の詳細ページを開きます。
  2. スケジュールの横にある編集ボタンを選択します。
  3. 新しいスケジュールを入力し、「保存」を選択します。

名前の変更

  1. 定期実行の詳細ページを開きます。
  2. 名前の横にある編集ボタンを選択します。
  3. 新しい名前を入力し、「保存」を選択します。

アクションの変更

  1. 定期実行の詳細ページを開きます。
  2. アクションの横にある編集ボタンを選択します。
  3. 新しいアクションを選択し、必要に応じてパラメーターを設定して「保存」を選択します。

削除

不要になった定期実行は削除できます。

  1. 定期実行の詳細ページを開きます。
  2. 「削除」を選択します。
  3. 確認画面で削除を確定します。
⚠️

削除した定期実行は元に戻せません。再度同じスケジュールで実行したい場合は、新しく定期実行を作成してください。

実行履歴を確認する

定期実行の詳細ページでは、過去の実行履歴を確認できます。ステータスやスケジュール日時の範囲で絞り込み検索もできます。

実行履歴では、以下の情報を確認できます。

項目説明
スケジュールスケジュールされた実行日時
試行回数実行の試行回数
実行ステータス実行の結果
実行日時実際に実行された日時

実行ステータスは以下の通りです。

ステータス説明
待機中まだ実行されていない状態
実行中実行中の状態
実行完了実行が正常に完了した状態
キャンセルキャンセルされた状態
エラー実行時にエラーが発生した状態

再試行する

過去の実行履歴から、特定のスケジュール日時の実行を手動で再試行できます。

  1. 実行履歴から再試行したい実行を選択します。
  2. 「再試行」を選択します。

実行が失敗した場合や、結果を再度取得したい場合に活用できます。