Custom(カスタム)

概要

カスタムイベントおよびAPIワークフローをトリガー、スケジュール、キャンセルするためのアクションです。

この項目では、カスタムイベントをどのようにトリガーし、スケジュールし、キャンセルするかについて説明します。


Trigger a custom event(カスタムイベントをトリガーする)

このアクションは、カスタムイベントをトリガー(起動)します。
カスタムイベントはすでにページ上で定義されている必要があります。
これらのイベントは、ページ内の異なるワークフロー間でワークフロー/アクションを共有するための方法です。

Custom event(カスタムイベント)
トリガーするカスタムイベントを選択します。

Workflow parameters(ワークフローパラメータ)
カスタムイベントレベルで定義されたパラメータです。


Trigger a custom event when data changes(データが変更されたときにカスタムイベントをトリガー)

このアクションは以下を行います。

  • 特定のデータタイプのフィールドの変更を監視
  • その変更が発生したときに一度だけカスタムイベントをトリガー

このアクションは、「何かが変更されたときにトリガーされるカスタムイベント」で設定されたパラメータに基づいて、データタイプを定義します。
たとえば、カスタムイベントのパラメータが「User」タイプに設定されている場合、このアクションは特定のユーザーのデータが更新されたときに実行されます。

覚えておくべき点は下記です。

  • イベントはページが開いている間のみトリガーされ、ページを閉じた場合は再度呼び出す必要があります。
  • イベントは、各アクション呼び出しにつき一度だけトリガーされます。

Custom event(カスタムイベント)

変更が発生したときにトリガーされるカスタムイベントを選択します。

Parameter(パラメータ)

変更を監視する対象のデータを指定します。
これは、トリガーされるカスタムイベントのパラメータと同じタイプでなければなりません。
つまり、カスタムイベントが「User」を期待する場合、このフィールドも「User」である必要があります。
そのユーザーが変更されたときに、カスタムワークフローが実行されます。

Field(フィールド)

監視するフィールドを指定します。
たとえば、ワークフローの対象が「Current user」で、フィールドが「Name」である場合、
「Current user」の名前が「Bob」から「Barbara」に変更されると、カスタムイベントがトリガーされます。


Schedule a custom event(カスタムイベントをスケジュール)

このアクションは、選択したカスタムワークフローを未来の指定時刻に実行します。
ユーザーがワークフローの実行前にページを変更した場合、ワークフローは実行されません。
「Trigger a custom event」とは異なり、このアクションで実行されるワークフローは、それを開始したワークフローとは独立して、並行して実行される可能性があります。

Custom event(カスタムイベント)

トリガーされるイベントを指定します。

Workflow parameters(ワークフローパラメータ)

カスタムイベントレベルで定義されたパラメータです。

Delay(遅延時間)

カスタムワークフローを実行する前に待機する秒数を入力します。
小数点以下の値も使用可能です。


Trigger a custom event from a reusable element(リユーザブルエレメントからカスタムイベントをトリガー)

このアクションは、リユーザブルエレメント(Reusable element) に属するカスタムイベントをトリガーします。
これらのイベントは、アプリの異なるページや再利用可能な要素間でワークフロー/アクションを共有する方法です。
再利用可能な要素内で定義することで、ワークフローのライブラリを構築できます。

Reusable element(リユーザブルエレメント)

カスタムワークフローで使用する再利用可能な要素を選択します。

Custom event(カスタムイベント)

トリガーするカスタムイベントを選択します。
選択した再利用可能要素のカスタムイベントのみが表示されます。

Workflow parameters(ワークフローパラメータ)

カスタムイベントレベルで定義されたパラメータです。


Return data(データを返す)

このアクションにより、カスタムイベントワークフロー内で戻り値(Return values)を使用し、それをトリガー元のワークフローに返すことができます。

  • カスタムイベントの戻り値が必須である場合、条件のないReturn dataアクションを少なくとも1つ定義する必要があります。
  • Bubbleが有効なReturn dataアクションに到達した時点で、ワークフローは停止し、即座にその値を返します。

Return value(戻り値)

カスタムイベントに設定した戻り値に対して返す値を指定します。
この値は、戻り値の型と同じである必要があります。
返された値は、他のワークフローで「カスタムイベントの結果」として利用可能になります。


Schedule API Workflow(APIワークフローをスケジュール)

このアクションを使用すると、APIワークフローを任意の未来の時点にスケジュールできます。
実行するワークフローと時間を指定します。
すぐに実行したい場合は :current date/time 演算子を使用できます。

API Workflow(APIワークフロー)

実行するAPIワークフローを選択します。
これらは「Application Menu」>「Backend workflows」で定義されたワークフローです。
ワークフローがパラメータを受け取る場合、それらはプロパティエディタに表示されます。

Scheduled date(スケジュール日時)

ワークフロー実行の日付を定義します。
式ビルダーを使用して動的な日時を指定可能です。

Ignore privacy rules when running the workflow(プライバシールールを無視して実行)

スケジュールされたワークフローは、スケジュール時点の「現在のユーザー」のコンテキストで実行されます。
そのため、すべてのプライバシールールが適用されます。
これを無視して「管理者(admin)」として全権限で実行する場合、このチェックを有効にします。
セキュリティ/プライバシー上の重要な設定であるため、慎重に使用してください。

Workflow parameters(ワークフローパラメータ)

APIワークフローレベルで定義されたパラメータです。


Schedule API Workflow on a list(リスト上でAPIワークフローをスケジュール)

このアクションにより、リスト内の各項目に対してAPIワークフローをスケジュールできます。
リストの各項目ごとにワークフローが実行され、各実行は1つのワークフロー実行としてカウントされます。

このアクションはおよそ最大100,000件のレコードに対応しています。

Type of things(対象のタイプ)

反復処理を行う「もの(thing)」のタイプを選択します。

List to run on(実行対象リスト)

繰り返し処理するリストを定義します。
検索結果やAPIコールの結果などを指定可能です。
※リストはスケジュール時に確定します。スケジュール後に条件が変わっても、当時の結果に基づいて実行されます。

API Workflow(APIワークフロー)

実行するAPIワークフローを選択します。
これらは「Backend workflows」ページで定義されています。

Scheduled date(スケジュール日時)

実行日時を定義します。

Interval(間隔・秒)

Bubbleがワークフローをスケジュールする間隔を設定します。

  • 空欄(デフォルト):軽い間隔でスケジュールされ、他のワークフローとの同時実行も考慮されます。
  • 0秒:全バッチ完了まで他のスケジュールワークフローをブロックします(推奨されません)。
  • 外部API制限:APIにレートリミットがある場合、適度な間隔を設定してHTTP 429エラーを防ぐことが可能です。
  • 並列実行:インターバルを設定しても完全な逐次実行は保証されません。逐次化したい場合は「再帰的ワークフロー(recursive workflows)」を検討してください。
  • 制限:スケジュール可能なリスト長には上限があります。

Ignore privacy rules when running the workflow(プライバシールールを無視して実行)

前述「Schedule API Workflow」と同様です。

Workflow parameters(ワークフローパラメータ)

APIワークフローレベルで定義されたパラメータです。


Cancel a scheduled API Workflow(スケジュールされたAPIワークフローをキャンセル)

このアクションは、スケジュールされたワークフローをキャンセルします。
ワークフローは、スケジューリング時に返された番号で識別されます。

Scheduled API ID(スケジュールAPI ID)

キャンセル対象のスケジュールワークフローのID(通常は動的式)を入力します。


Cancel a list of scheduled API Workflows(スケジュール済みAPIワークフローのリストをキャンセル)

このアクションは、スケジュールされたワークフローのリスト全体をキャンセルします。
これらのワークフローは、スケジュール時に返された番号で識別されます。

List of scheduled API IDs(スケジュールIDのリスト)

キャンセル対象のIDリストを返す動的式を定義します(テキストのリスト)。


Set/cancel a recurring event(定期的なイベントを設定/キャンセル)

このアクションは、特定のデータ項目(thing)に対して定期的に実行されるワークフローをスケジュールまたはキャンセルします。
これにより、毎日・毎月などの周期的な処理を実現できます。
1つのデータ項目につき、設定できる定期イベントは1つのみです。
頻度が「None(なし)」の場合は、定期イベントがキャンセルされます。

Recurring event(定期イベント)

定期的に実行またはキャンセルするイベントを選択します。
これらのイベントは「Application Menu」>「Backend workflows」で定義されます。

Workflow thing(ワークフロー対象のデータ)

各定期ワークフローに関連付けるデータ項目を指定します。
これは、定期イベントのタイプと同じでなければなりません。

Frequency(頻度)

定期ワークフローの頻度を選択します。
選択肢:NoneWeeklyMonthlyQuarterlyYearly
「None」を選択すると定期イベントはキャンセルされます。

定期ワークフローの実行頻度はアプリのプランによって異なります。

Start date(開始日)

定期イベントの開始日を選択します。
すでにスケジュールされている項目に対してこのアクションを実行する場合、
開始日は「次の実行日」より後である必要があります。
そうでない場合は、次の周期まで延期されます。