ブロックリファレンス

BLOCKS Reference

基本

フローの開始

概要

このブロックは、フローの開始を表します。

このブロックでは、フロー実行に関する以下の設定ができます。

  • フローの定期実行の設定
    フローを定期的に自動実行する時刻を設定します。
  • フロー終了時の通知設定
    フロー成功時や失敗時の通知先(メール・Slack・ワークスペースメッセージ・PagerDuty)を設定します。
  • フロー実行時のログの保存期間
    フロー実行時の成功ログ・失敗ログの保存期間を日単位で設定します。

「フローの終了」ブロックと対で使用します。フローは、ひとつながりのブロックを「フローの開始」と「フローの終了」で挟むことにより、実行可能となります(下図参照)。

フローの開始ブロックの利用例

プロパティ

プロパティ名 説明
ID

IDが設定されているときのみ、表示されます。IDは、フローに付ける名前です。外部アプリケーションからフローを呼び出すときに使用します。

鉛筆ボタンをクリックすると、フローリストでIDの変更ができます。

IDは、フローリストで設定します。IDの規則は、以下のとおりです。

  • 使用できる文字の種類:
    • 英数字(a - zA - Z0 - 9
    • ハイフン(-
    • アンダースコア(_
  • 最大長: 64文字
ブロック名

編集パネルに配置した当該ブロックの表示名が変更できます。

ブロックリストパネル中のブロック名は変更されません。

開始時間

フローを定期実行するときの開始時刻です。

開始時刻の設定は、「cron形式で入力」と「簡単設定」から選べます。どちらを選ぶかは、下図のように操作します(初期状態は「cron形式で入力」)。

  • cron形式で入力

    フローを定期実行するスケジュールを10 0 * * 1のような形式できめ細かく設定できます。

    指定する形式は、Unix系OSのcrontabコマンドのスケジュール形式と同じです。

    左から「分・時・日・月・曜日」の順に数値で指定します(各項目間は空白で切る)。指定できる数値は以下のとおりです。

    • 分: 0 - 59
    • 時: 0 - 23
    • 日: 1 - 31
    • 月: 1 - 12
    • 曜日: 0 - 7
      0(日) / 1(月) / 2(火) / 3(水) / 4(木) / 5(金) / 6(土) / 7(日)

    指定可能な数値には、アスタリスク(*)も指定できます。これは、そのフィールドで取りうるすべての値を表します。例えば、「」のフィールドで、*を指定すると、「毎時」という意味になります。

    例えば、10 0 * * 1と指定した場合は、毎週月曜日のAM 0:10にフローが実行されます。

  • 簡単設定

    フローを定期実行するスケジュールを簡単に設定できます。よりきめ細かなスケジュールを設定したい場合は、「cron形式で入力」をお使いください。

    • 繰り返し:スケジュールの繰り返し方法を選択します。
      • 毎日:毎日繰り返すスケジュールです。繰り返し間隔で、繰り返しの間隔を日単位で調整できます。
      • 毎週:毎週繰り返すスケジュールです。毎週どの曜日で繰り返すかを調整できます。
      • 平日(月-金):平日のみ繰り返すスケジュールです。標準では、月曜日から金曜日が平日となっていますが、曜日は自由に変更できます。
      • 毎月1日:毎月1日を繰り返すスケジュールです。
      • 毎月:月単位で繰り返すスケジュールです。日・時・分の調整ができます。繰り返しの間隔は、月単位で調整できます(2か月ごとや3か月ごとなど)。
    • 繰り返し間隔:繰り返しが「毎日」もしくは「毎月」の繰り返し間隔を選択します。
      • 繰り返しが「毎日」の場合は、日単位で繰り返し間隔を選択します。
      • 繰り返しが「毎月」の場合は、月単位で繰り返し間隔を選択します。また、何日にスケジュールするかも選択します。
    • 曜日:繰り返しが「毎週」もしくは「平日(月〜金)」の曜日を選択します。
    • 時/分:スケジュールする時刻を選択します。
開始時間を有効にする フローの定期実行の有効・無効を切り替えます。有効にすると、「開始時間」プロパティで指定された時間にフローが実行されます。
成功通知

フローの実行が成功したことを知らせる通知先を選択します。通知先は、フローデザイナーの「設定」の「通知」で事前に設定しておきます。

通知先は、複数選択が可能です。

(画像をクリックすると拡大表示されます。)
announcement 重要

フローの実行時に、_job_name変数が定義されていれば、フロー名を出力する際にその値を組み合わせて出力します。フロー名と_job_nameの値は、ハイフンとスペースで区切られます。

たとえば、フロー名が「サンプルフロー」で、_job_nameが「ジョブA」の場合、出力は「サンプルフロー - ジョブA」となります。

warning_amber 警告

通知設定の設定ミスや通知サービスの障害などにより、成功通知が届かないことがあります(成功通知の失敗)。その場合でもフローのステータスは、「成功」のまま変わりません。

失敗通知

フローの実行が失敗したことを知らせる通知先を選択します。通知先は、フローデザイナーの「設定」の「通知」で事前に設定しておきます。

通知先は、複数選択が可能です。

(画像をクリックすると拡大表示されます。)
announcement 重要

フローの実行時に、_job_name変数が定義されていれば、フロー名を出力する際にその値を組み合わせて出力します。フロー名と_job_nameの値は、ハイフンとスペースで区切られます。

たとえば、フロー名が「サンプルフロー」で、_job_nameが「ジョブA」の場合、出力は「サンプルフロー - ジョブA」となります。

ブロックメモ このブロックに関するメモが記載できます。このブロックの処理に影響しません。
失敗ログの保存期間 フローの実行が失敗したログの保存期間を指定します。単位は、日です。
成功ログの保存期間 フローの実行が成功したログの保存期間を指定します。単位は、日です。
エラー時に起動するフローのID

ジョブがエラーで終了した場合に自動的に起動するフローのIDを指定します。指定されたフローには、以下の情報が引き継がれます。

情報 変数名
フローの実行予定日時 _target_time_unix_seconds
_target_time_iso8601
_target_time_iso8601_localtime
_target_time_iso8601_utc
グループID _group_id
ジョブ名 _job_name
実行ユーザーの情報 _execute_user_id
_execute_user_name

エラー終了時点での元のジョブの全ての変数も引き継がれます。

この機能により、エラー発生時に特定の処理(例:途中段階のファイル出力、カスタムエラー通知など)を実行できます。

この情報は役に立ちましたか?