フローの入力変数の設定

カスタム lightning-flow コンポーネントにフローを埋め込んだら、その変数を初期化して、フローにより多くのコンテキストを提供します。コンポーネントでフローを作成するには、lightning-flow コンポーネントの flow-api-name 属性に、使用するフローの API 名を設定します。

このコンポーネントを使用するには、その前に、Salesforce Flow Builder でフローを作成します。このコンポーネントには、戻る、次へ、一時停止、完了のナビゲーションボタンが含まれています。

フローに、カスタムの Lightning Web コンポーネントまたは Aura コンポーネントがある場合、Lightning Web Runtime を使用する Experience Cloud サイトで lightning-flow を使用することができません。

コンポーネントのサーバ側 Javascript ファイルで対応付けのリストを作成し、そのリストを flow-input-variables 属性に渡します。

変数を設定できるのはインタビューの開始時のみで、設定した変数で入力アクセスが許可されている必要があります。入力アクセスを許可しない変数を参照している場合、その変数を設定しようとしても無視されます。

設定した各変数の name、type、value を指定します。type には、フローデータ型の API 参照名を使用します。たとえば、レコード変数の場合は SObject を使用し、テキスト変数の場合は String を使用します。

この JavaScript ファイルのメソッドは、数値変数、日付コレクション変数、およびいくつかのレコード変数の値の配列を返します。Flow Builder の Record データ型は、ここでは SObject に対応します。

次に、Apex コントローラを介して取引先を取得するコンポーネントの例を示します。Apex コントローラは、JavaScript ファイルのワイヤを介してデータをフローのレコード変数に渡します。