Flow

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

対応する UI ベースのフロー作成ツールについての詳細は、Salesforce ヘルプの「Flow Builder」を参照してください。

メタデータ API を使用してフローを操作する場合、次の点に留意してください。

フローがテンプレートである場合を除き、管理パッケージからインストールされたフローへのアクセスには、メタデータ API を使用できません。
フローファイル名にスペースがあると、リリース時にエラーが発生する可能性があります。先頭と末尾の空白は許可されますが、リリース時に削除されます。
メタデータ API を使用する場合、特定の状況で有効なフローへの変更をリリースできます。
- 組織が本番組織でない。たとえば、スクラッチ組織や Sandbox である。有効なフローが最新バージョンになります。
- 組織がリリースプロセスおよびフローを有効な設定として有効化した本番組織である。有効なフローが最新バージョンになります。
有効なフローへの変更をリリースすると、フローの詳細ページに有効な新しいフローバージョンが表示されます。この新しいバージョンには変更が含まれています。たとえば、myflow のバージョン 3 が有効な最新バージョンだとします。バージョン 3 を変更してリリースすると、myflow の詳細ページに有効なバージョンとしてバージョン 4 が表示されます。
フローバージョンが有効でなく、一時停止中のインタビューがなければ削除できます。フローバージョンに一時停止中のインタビューがある場合は、これらのインタビューが再開または終了するまで待機するか、インタビューを削除します。

取得したプロセスビルダープロセス (processType が Workflow または InvocableProcess であるフローコンポーネント) のメタデータを編集しないでください。編集したプロセスメタデータをリリースした場合、対象組織でプロセスを開くことができない可能性があります。

警告

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

フローは、対応するパッケージディレクトリの Flow ディレクトリに保存されます。ファイル名はフローの一意の完全名と一致し、拡張子は .flow です。

バージョン

フローメタデータ API は、API バージョン 24.0 以降で使用できます。

このメタデータ型はフローの有効な定義を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

項目名	項目の型	説明
actionCalls	FlowActionCall[]	アクションへのコールを定義するノードの配列。この項目は、API バージョン 31.0 以降で使用できます。
apexPluginCalls	FlowApexPluginCall[]	Apex プラグインへのコールを定義するノードの配列。
assignments	FlowAssignment[]	割り当てノードの配列。
choices	FlowChoice[]	静的選択オプションの配列。
constants	FlowConstant[]	定数の配列。
decisions	FlowDecision[]	決定ノードの配列。
description	string	フローの説明。
dynamicChoiceSets	FlowDynamicChoiceSet[]	データベースルックアップに基づく選択オプションのセットを構成する配列。
環境	FlowEnvironment (string 型の列挙)	フローを実行できる環境。有効な値は、次のとおりです。 `Default` — フローは、オフラインで実行するか、または Visualforce コンポーネント、Lightning ページ、フローアクション、カスタム Aura コンポーネントから実行できます。 `Slack` — フローは Slack およびデフォルトの環境で実行できます。フローを保存するときに、Slack フロー環境を指定します。この項目は、API バージョン 55.0 以降で使用できます。
formulas	FlowFormula[]	数式の配列。
fullName	string	必須。Metadata コンポーネントから継承されます。メタデータ API 内のファイルの名前。アンダースコアと英数字のみで構成されるフローの一意の名前。組織全体で一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。バージョンをリリースまたは取得するには、バージョン番号を指定します。たとえば、`sampleFlow-3` は、一意の名前が sampleFlow であるフローのバージョン 3 であることを示します。バージョン番号を指定しない場合、フローは最新バージョンになります。 API バージョン 43.0 以前では、この項目にバージョン番号が含まれていましたが、API バージョン 44 以降では、この項目にバージョン番号が含まれなくなりました。
interviewLabel	string	インタビューの表示ラベル。この表示ラベルは、ユーザとシステム管理者が同じフローからのインタビューを区別するのに役立ちます。ユーザインターフェースでは、この表示ラベルは、ユーザの [ホーム] タブの [一時停止中のフローインタビュー] コンポーネント、および [設定] の一時停止中のフローインタビューのリストで表示されます。
isAdditionalPermissionRequiredToRun	boolean	デフォルト動作を上書きし、有効化されたプロファイルまたは権限セットにアクセスを制限するか (`true`)、否か (`false`) を示します。デフォルト値は、`false` です。API バージョン 47.0 以降で利用できます。
isTemplate	boolean	プロセスまたはフローがテンプレートであるかどうかを示します。管理パッケージからインストールされた場合、知的財産 (IP) の保護により、登録者はプロセスとフローの参照やコピーを行うことができません。ただし、プロセスやフローがテンプレートの場合、登録者はそれをビルダーで開いたり、コピーしたり、カスタマイズしたりできます。API バージョン 45.0 以降で利用できます。デフォルト: false
label	string	必須。フローの表示ラベル。
loops	FlowLoop[]	コレクションを反復処理するためのノードの配列。この項目は、API バージョン 30.0 以降で使用できます。
migratedFromWorkflowRuleName	string	フローの移行元であるワークフロールールの名前。API バージョン 54.0 以降で利用できます。
orchestratedStages	FlowOrchestratedStage[]	オーケストレーションのフェーズノードの配列。API バージョン 53.0 以降で利用できます。
processMetadataValues	FlowMetadataValue[]	フローのメタデータ値。この項目は、API バージョン 31.0 以降で使用できます。
processType	FlowProcessType (string 型の列挙)	フローの種別。フローの有効なバージョン (有効なバージョンがない場合は最新のバージョン) によって決まります。有効な値は、次のとおりです。 `ActionCadenceAutolaunchedFlow` — ユーザがケイデンスステップを完了したときに実行されるフロー。この値は API バージョン 56.0 以降で使用できます。 `ActionCadenceStepFlow` — ケイデンスステップとして使用される画面フロー。この値は API バージョン 56.0 以降で使用できます。 `Appointments` — Lightning Scheduler のフロー。この値は API バージョン 44.0 以降で使用できます。 `AutoLaunchedFlow` — ユーザ操作を必要としないフロー。 `CheckoutFlow` — ストアのチェックアウトを作成するために Lightning B2B Commerce で使用されるフロー。この値は API バージョン 48.0 以降で使用できます。 `ContactRequestFlow` — 顧客がカスタマーサポートに折り返し連絡を要求できるようにするフロー。このフローは、連絡要求レコードを作成するために使用します。この値は API バージョン 45.0 以降で使用できます。 `CustomerLifecycle` — アンケートの質問を顧客ライフサイクルのさまざまなフェーズに関連付けることができる Salesforce Surveys フロー。この値は API バージョン 49.0 以降で、Customer Lifecycle Designer ライセンスが有効な場合にのみ使用できます。 `CustomEvent` — プラットフォームイベントメッセージを受信すると呼び出されるプロセス。UI では、これはイベントプロセスです。この値は API バージョン 41.0 以降で使用できます。 `EvaluationFlow` — オーケストレーションにおけるカスタムのエントリ条件および終了条件を評価するフロー。`isOrchestrationConditionMet` 出力変数を使用し、他の出力変数から値を破棄します。API バージョン 54.0 以降で利用できます。 `FieldServiceMobile` — Field Service モバイルアプリケーションのフロー。この値は API バージョン 39.0 以降で使用できます。 `FieldServiceWeb` — 組み込みの予定の予約のフロー。UI 表示ラベルは [Field Service 組み込みフロー] です。この値は API バージョン 41.0 以降で使用できます。 `Flow` — 1 つ以上の画面、ローカルアクション、選択肢、または動的選択肢が含まれるため、ユーザ操作を必要とするフロー。UI および Salesforce ヘルプでは、これは画面フローです。画面フローは、UI (フローアクションを含む UI など)、Lightning ページ、または Web タブから起動できます。 `FSCLending` — Financial Services Cloud 住宅ローン向けフロー。この値は API バージョン 46.0 以降で使用できます。 `InvocableProcess` — 別のプロセスまたは REST API の Invocable Actions リソースから呼び出すことができるプロセス。この値は API バージョン 38.0 以降で使用できます。 `LoginFlow` — ログインのフロー。API バージョン 51.0 以降で利用できます。 `LoyaltyManagementFlow` — ロイヤルティ管理アプリケーションのフローであり、ロイヤルティプログラムプロセスから呼び出すことができます。この値は、API バージョン 54.0 以降で使用できます。 `Orchestrator` — フローを一連のフェーズに含まれるステップのグループに整理するオーケストレーション。API バージョン 53.0 以降で利用できます。 `RoutingFlow` — Salesforce オムニチャネルルーティングなどのビジネスロジックのフロー。この値は API バージョン 52.0 以降で使用できます。 `Survey` — Salesforce アンケートのフロー。UI から、この種別のフローはアンケートビルダーで作成します。この値は API バージョン 42.0 以降で使用できます。 `SurveyEnrich` — アンケートデータマッパーを使用する Salesforce Surveys フロー。この種別のフローは、UI のアンケートビルダーで作成し、関連付けられたアンケートフロー種別が必要です。この値は API バージョン 49.0 以降で、Customer Lifecycle Designer ライセンスが有効な場合にのみ使用できます。 `Workflow` — レコードを作成または編集するときに呼び出されるプロセス。UI および Salesforce ヘルプでは、これはレコード変更プロセスです。フローバージョン間では、種別を `Flow` から `AutoLaunchedFlow` (またはその逆) にのみ変更できます。フロー種別を変更する前に、新規フロー種別でサポートされる要素、リソース、機能のみがフローに含まれていることを確認します。これらの値は、��後の使用または Salesforce の内部使用のために予約されています。 `ActionCadenceFlow` `ActionPlan` `AppProcess` `CartAsyncFlow` `DigitalForm` `Journey` `JourneyBuilderIntegration` `LoginFlow` `ManagedContentFlow` `OrchestrationFlow` `RecommendationStrategy` `SalesEntryExperienceFlow` `TransactionSecurityFlow` `UserProvisioningFlow` この項目は、API バージョン 31.0 以降で使用できます。
recordCreates	FlowRecordCreate[]	データベース内のレコードを作成するためのノードの配列。
recordDeletes	FlowRecordDelete[]	データベース内のレコードを削除するためのノードの配列。
recordLookups	FlowRecordLookup[]	データベース内のレコードを検索するためのノードの配列。
recordRollbacks	FlowRecordRollback[]	画面フロー内のトランザクションをロールバックするためのノードの配列。API バージョン 52.0 以降で利用できます。
recordUpdates	FlowRecordUpdate[]	データベース内のレコードを更新するためのノードの配列。
runInMode	FlowRunInMode (string 型の列挙)	フローが実行されるコンテキスト。有効な値は次のとおりです。 `DefaultMode` — フローの起動方法によって、フローがユーザコンテキストまたはシステムコンテキストのどちらで実行されるかが決まります。UI で、この値は [ユーザまたはシステムコンテキスト — フローの起動方法に依存します] として表示されます。 `SystemModeWithSharing` — フローでは、組織のデフォルト設定、ロール階層、共有ルール、共有の直接設定、チーム、テリトリーが使用されます。ただし、実行ユーザのオブジェクト権限、項目レベルのアクセス権、その他の権限は適用されません。UI で、この値は [共有を含むシステムコンテキスト — レコードレベルのアクセス権を適用します] として表示されます。 `SystemModeWithoutSharing` — フローはすべてのデータにアクセスできます。UI で、この値は [システムコンテキスト共有なし — すべてのデータにアクセス] として表示されます。この値は API バージョン 49.0 以降で使用できます。この項目は、API バージョン 48.0 以降で使用できます。
screens	FlowScreen[]	画面ノードの配列。
segment	string	将来の使用のために予約されています。
stages	FlowStage[]	フロー全体で使用できるフェーズリソースの配列。この項目は、API バージョン 42.0 以降で使用できます。
start	FlowStart	フローを開始する方法やタイミングを指定するフローの開始要素を表します。この項目は、API バージョン 47.0 以降で使用できます。
startElementReference	string	フローの開始点となるノードまたは要素を指定します。この項目は、Winter '20 以降の Flow Builder で作成または保存されたフローでは使用されません。それらのフローでは、フローの開始方法を指定せずに start 項目を使用します。
status	FlowVersionStatus (string 型の列挙)	フローの有効化状況。有効な値は、次のとおりです。 `Active` `Draft` — UI で、この状況は `[無効]` として表示されます。 `Obsolete` — UI で、この状況は `[無効]` として表示されます。 `InvalidDraft` — UI で、この状況は `[ドラフト]` として表示されます。
steps	FlowStep[]	ステップノードの配列。
subflows	FlowSubflow[]	サブフローの配列です。この項目は、API バージョン 25.0 以降で使用できます。
textTemplates	FlowTextTemplate[]	テキストテンプレートの配列。
triggerOrder	int	レコードトリガフローの実行順序 (1 ～ 2000)。Salesforce ヘルプの「オブジェクトのレコードトリガフローの実行順序の定義に関するガイドライン」を参照してください。API バージョン 54.0 以降で利用できます。
variables	FlowVariable[]	変数定義の配列。
waits	FlowWait[]	待機ノードの配列。この項目は、API バージョン 32.0 以降で使用できます。

FlowActionCall

フローからアクションへのコールを定義します。FlowNode を拡張します。

API バージョン 31.0 以降で利用できます。

項目名	項目の型	説明
actionName	string	必須。アクションの名前。同じ actionType のアクション間で一意である必要があります。
actionType	InvocableActionType (string 型の列挙)	必須。アクションの種別。有効な値は、次のとおりです。 `activateSessionPermSet` — 実行ユーザのセッションベースの権限セットを有効化します。 `addMessageToChat` — 既存の Salesforce Anywhere チャットにメッセージを追加します。API バージョン 49.0 以降で利用できます。 `addMessageToQuipChat` — 既存のチャットルームに Quip メッセージを追加します。API バージョン 46.0 以降で利用できます。 `addMessageToQuipDocument` — 既存の Quip 文書、スプレッドシート、またはスライドに Quip メッセージを追加します。API バージョン 46.0 以降で利用できます。 `addQuipDocumentToFolder` — 既存のフォルダに既存の Quip 文書、スプレッドシート、またはスライドを追加します。API バージョン 46.0 以降で利��できます。 `addUsersToChat` — 既存の Salesforce Anywhere チャットにユーザを追加します。API バージョン 49.0 以降で利用できます。 `addUsersToQuipDocument` — 既存の Quip 文書、スプレッドシート、またはスライドにメールアドレスで識別されるユーザを追加します。API バージョン 46.0 以降で利用できます。 `addUsersToQuipChat` — 既存の Quip チャットルームにメールアドレスで識別されるユーザを追加します。API バージョン 46.0 以降で利用できます。 `attachQuipDocumentToRecord` — Salesforce レコードに Quip 文書、スプレッドシート、またはスライドを添付します。API バージョン 46.0 以降で利用できます。 `apex` — @invocableMethod アノテーションがある Apex メソッドを呼び出します。 `archiveKnowledgeArticles` — 公開ナレッジ記事のリストをアーカイブします。API バージョン 45.0 以降で利用できます。 `assignKnowledgeArticles` — 記事リストビューからナレッジ記事を一括割り当てます。API バージョン 44.0 以降で利用できます。 `chat` — Salesforce Anywhere チャットを作成します。API バージョン 49.0 以降で利用できます。 `chatterPost` — Chatter に投稿します。 `choosePricebook` — 価格表を選択します。 `contactRequestAction` — 連絡要求レコードを作成します。API バージョン 45.0 以降で利用できます。 `component` — `lightning:availableForFlowActions` インターフェースを実装し、actionName により参照される Lightning コンポーネントを呼び出します。API バージョン 43.0 以降で利用できます。 `contentWorkspaceEnableFolders` — ライブラリ内のフォルダを有効にします。 `copyQuipDocument` — 既存の Quip 文書、スプレッドシート、またはスライドのコピーを作成し、新しいタイトルを付けます。API バージョン 46.0 以降で利用できます。 `createDraftFromOnlineKnowledgeArticle` — 公開ナレッジ記事からドラフトを作成します。API バージョン 45.0 以降で利用できます。 `createInvoiceFromFulfillmentOrder` — 注文から請求書を作成します。B2B Commerce で利用可能です。API バージョン 49.0 以降で利用できます。 `createQuipChat` — Quip チャットルームを作成します。API バージョン 46.0 以降で利用できます。 `createQuipDocument` — Quip 文書、スプレッドシート、またはスライドを作成します。API バージョン 46.0 以降で利用できます。 `createQuipFolder` — Quip フォルダを作成します。API バージョン 46.0 以降で利用できます。 `customNotificationAction` — カスタム通知を送信します。API バージョン 46.0 以降で利用できます。 `deactivateSessionPermSet` — 実行ユーザのセッションベースの権限セットを無効にします。 `decisionStudioAction` — API バージョン 49.0 以降で使用できます。 `deleteKnowledgeArticle` — ドラフトバージョン (翻訳またはマスタ言語) またはアーカイブ済みナレッジ記事全体を削除します。API バージョン 46.0 以降で利用できます。 `editQuipDocument` — 既存の Quip 文書、スプレッドシート、またはスライドのコンテンツを変更します。API バージョン 46.0 以降で利用できます。 `emailAlert` — ワークフローメールアラートを参照してメールを送信します。 `emailSimple` — フローリソースを使用してメールを送信します。 `externalService` — 外部システムへ HTTP 要求を行う外部サービス操作を呼び出します。外部システムは、[設定] で登録された外部サービススキーマによって使用可能になります。API バージョン 46.0 以降で利用できます。 `flow` — 自動起動フローを呼び出します。このアクション種別は、processType が Flow または AutolaunchedFlow のフローには使用できません。これらの種別のいずかから自動起動フローを呼び出すには、FlowSubflow を使用します。API バージョン 32.0 以降で利用できます。 `limitRepetitions` — おすすめ戦略フローで同じおすすめや提案を一定の期間に同じレコードや同じユーザに表示する回数を制限します。API バージョン 55.0 以降で利用できます。 `marketingEmail` — API バージョン 49.0 以降で使用できます。 `massUpdateAccountForecast` — 売上予測を非同期で一括更新します。API バージョン 48.0 以降で利用できます。 `massUpdateSalesAgreement` — 販売計画を非同期で一括更新します。API バージョン 48.0 以降で利用できます。 `quickAction` — QuickAction を呼び出します。 `publishKnowledgeArticles` — 記事リストビューからナレッジ記事を一括公開します。API バージョン 44.0 以降で利用できます。 `publishPardotContent` — API バージョン 49.0 以降で使用できます。 `restoreKnowledgeArticleVersion` — ナレッジ記事のアーカイブバージョンを復元します。API バージョン 45.0 以降で利用できます。 `sendAlert` — Salesforce Anywhere アラートをユーザに送信します。API バージョン 49.0 以降で利用できます。 `sendNotification` — 使用可能な通知種別を送信します。API バージョン 54.0 以降で利用できます。 `sendSurveyInvitation` — 顧客がサポートケースを完了したときなど、アクションに基づいて組織のリード、取引先責任者、およびユーザにアンケートへの招待をメールで送信します。API バージョン 49.0 以降で利用できます。 `performSurveySentimentAnalysis` — アンケートのセンチメント分析を実行し、AI センチメント結果レコードを作成または更新します。API バージョン 55.0 以降で利用できます。 `skillsBasedRouting` — オムニチャネルのスキルベースのルーティング用に使用される PendingServiceRouting レコードを作成します。バージョン 44.0 以降で利用できます。 `slackArchiveChannel` — Slack ワークス��ースの Slack チャネルをアーカイブします。API バージョン 54.0 以降で利用できます。 `slackCheckUsersAreConnectedToSlack` — Salesforce ユーザのコレクションが特定の Slack アプリケーションに接続されているかどうかを示します。API バージョン 54.0 以降で利用できます。 `slackCreateChannel` — Slack ワークスペースの Slack チャネルを作成します。API バージョン 54.0 以降で利用できます。 `slackGetConversationInfo` — Slack チャネルまたはグループのダイレクトメッセージの名前を取得して、アーカイブされているかどうかを確認します。API バージョン 54.0 以降で利用できます。 `slackInviteUsersToChannel` — 特定の Slack アプリケーションに接続されているユーザを Slack チャネルまたはグループのダイレクトメッセージに追加します。API バージョン 54.0 以降で利用できます。 `slackPinMessage` — Slack チャネルまたはグループのダイレクトメッセージにメッセージを固定または固定解除します。API バージョン 54.0 以降で利用できます。 `slackPostMessage` — Slack チャネルまたはグループのダイレクトメッセージにメッセージを送信します。API バージョン 54.0 以降で利用できます。 `slackUpdateMessage` — Slack チャネルまたはグループのダイレクトメッセージに以前送信されたメッセージを編集します。API バージョン 54.0 以降で利用できます。 `storeReplyRecommendationsFeedback` — API バージョン 49.0 以降で使用できます。 `submitKnowledgeArticleForTranslation` — 翻訳のために公開済みまたはドラフトのナレッジ記事を送信します。API バージョン 46.0 以降で利用できます。 `submit` — レコードの承認を申請します。この値はオムニチャネル在庫で使用できます。バージョンを指定していない場合、この値は API バージョン 51.0 以降で使用できます。 `ociCreateReservation` — ロケーションまたはロケーショングループで 1 つ以上の在庫予約を作成します。 `ociFulfillReservation` — ロケーションで 1 つ以上の在庫予約を履行します。 `ociGetAvailability` — 1 つ以上の在庫ロケーションまたはロケーショングループで 1 つ以上の商品の在庫状況データを取得します。 `ociReleaseReservation` — 1 つ以上の在庫予約をリリースします。 `ociTransferReservation` — ロケーションまたはロケーショングループ間で 1 つ以上の在庫予約を移行します。これらの値は、B2B Commerce チェックアウトフローで使用されます。バージョンを指定していない場合、この値は API バージョン 47.0 以降で使用できます。 `updateCheckoutSessionStateAction` — チェックアウトフローのチェックアウトセッションの次の状態を更新します。API バージョン 49.0 以降で利用できます。 `priceCart` — B2B Commerce のチェックアウト時にカート内のすべての品目の価格を要求します。API バージョン 47.0 以降で利用できます。 `checkoutSessionAction` — チェックアウトフローの既存のチェックアウトセッションを開始または取得します。B2B Commerce で利用可能です。API バージョン 49.0 以降で利用できます。 `cancelCartAsyncOperation` — WebCart の非同期操作をキャンセルします。B2B Commerce で利用可能です。API バージョン 49.0 以降で利用できます。 `calcCartPromotionsAction` — Web カート内の該当するすべての品目の完全なカートプロモーション計算を要求します。B2B Commerce で利用可能です。API バージョン 52.0 以降で利用できます。 `checkCartInventoryAction` — B2B Commerce のチェックアウト時に Web カート内のすべての品目の在庫を要求します。API バージョン 47.0 以降で利用できます。 `calcCartShipmentAction` — B2B Commerce のチェックアウト時に Web カート内のすべての品目の送料を計算します。API バージョン 47.0 以降で利用できます。 `cartToOrderAction` — ドラフトモードで Salesforce 標準注文を作成します。API バージョン 47.0 以降で利用できます。 `activateOrderAction` — ドラフト注文を有効化します。これにより、注文概要が作成されます。API バージョン 47.0 以降で利用できます。これらの値は、Commerce チェックアウトフローで使用されます。バージョンを指定していない場合、この値は API バージョン 55.0 以降で使用できます。 `addCartItem` — Commerce のチェックアウト時に品目をカートに追加します。 `createCart` — Commerce のチェックアウト時にカートを作成します。 `deleteCart` — Commerce のチェックアウト時にカートを削除します。この値は注文管理で使用できます。バージョンを指定していない場合、この値は API バージョン 48.0 以降で使用できます。 `addOrderItemSummarySubmit` — 注文品目概要を注文概要に追加します。API バージョン 54.0 以降で利用できます。 `adjustOrderItemSummariesPreview` — 実際に適用することなく、注文概要から注文品目概要の価格調整を適用した場合に予想される結果がプレビュー表示されます。API バージョン 49.0 以降で利用できます。 `adjustOrderItemSummariesSubmit` — 注文概要から注文品目概要に価格調整を適用します。API バージョン 49.0 以降で利用できます。 `authorizePayment` — カード支払を承認します。API バージョン 55.0 以降で利用できます。 `cancelFulfillmentOrderItem` — 履行注文から品目を削除します。 `cancelOrderItemSummariesPreview` — 実際にキャンセルすることなく、注文概要から注文品目概要をキャンセルした場合に予想される結果がプレビュー表示されます。 `cancelOrderItemSummariesSubmit` — 注文概要から注文品目概要をキャンセルします。 `confirmHeldFulfillmentOrderCapacity` — 保持されている履行注文容量を確認します。API バージョン 55.0 以降で利用できます。 `createCreditMemoOrderSummary` — 注文概要のクレジットメモを作成します。 `createFulfillmentOrder` — 受取人と配送方法を定義する注文配送グループ概要に対して 1 つ以上の履行注文と履行注文商品を作成します。 `createFulfillmentOrders` — 複数の注文配送グループ概要に対して履行注文と履行注文商品を作成し、概要ごとに受取人と配送方法を定義します。API バージョン 51.0 以降で利用できます。 `createInvoiceFromChangeOrders` — 1 つ以上の変更注文の請求書を作成します。API バージョン 56.0 以降で利用できます。 `createInvoiceFromFulfillmentOrder` — 履行注文の請求書を作成します。 `createOrderPaymentSummary` — 注文概要に属する承認または支払の注文支払概要を作成します。 `createOrderSummary` — 注文の注文概要を作成します。 `createReturnOrder` — 注文に対する返品注文および返品注文品目を作成します。 `ensureFundsOrderSummaryAsync` — 非同期のバックグラウンドプロセスをトリガして、注文概要に含まれる請求書の決済プロバイダによって資金を確認します。 `ensureRefundsOrderSummaryAsync` — 非同期のバックグラウンドプロセスをトリガして、注文概要に含まれる請求書の決済プロバイダによって返金を確認します。 `getFulfillmentOrderCapacityValues` — 履行注文容量情報を取得します。API バージョン 55.0 以降で利用できます。 `holdFulfillmentOrderCapacity` — 履行注文容量を保持します。API バージョン 55.0 以降で利用できます。 `orderRoutingFindRoutesWithFewestSplits` — 注文された商品数量を在庫と比較し、注文を履行できる最小限のロケーションの組み合わせを決定します。API バージョン 51.0 以降で利用できます。 `orderRoutingFindRoutesWithFewestSplitsUsingOCI` — 注文された商品数量を、指定されたロケーショングループおよびロケーションの在庫と比較し、注文を履行できる最小限のロケーションの組み合わせを決定します。API バージョン 54.0 以降で利用できます。 `orderRoutingRankByAverageDistance` — 在庫ロケーションのセットから注文受取人までの平均距離を計算し、その平均距離順に並び替えたセットを返します。API バージョン 51.0 以降で利用できます。 `releaseHeldFulfillmentOrderCapacity` — 保持されている履行注文容量をリリースします。API バージョン 55.0 以降で利用できます。 `returnOrderItemSummariesPreview` — 実際に返品することなく、注文概要から注文品目概要を返品した場合に予想される結果がプレビュー表示されます。 `returnOrderItemSummariesSubmit` — 注文概要から注文品目概要を返品します。 `returnReturnOrderItems` — 返品注文品目を処理します。 `storeReplyRecommendationsFeedback` — 顧客の提案とフィードバックに対する店舗の標準的な返信を開始します。API バージョン 49.0 以降で利用できます。 `storeReplyRecommendationsFeedback` — 購入者のチェックアウトセッションの現在の状況を更新します。API バージョン 49.0 以降で利用できます。 Financial Services Cloud で使用される値は、次のとおりです。 `createFinancialRecords` — 住宅ローン申請から個人取引先、取引先責任者、金融口座、不動産、資産、負債を作成します。API バージョン 49.0 以降で利用できます。 Manufacturing Cloud で使用される値については、「Manufacturing Cloud のフロー」を参照してください。この値は払い戻し管理で使用できます。 `addRebateMemberList` — メンバーのリストをリベートプログラムに追加します。API バージョン 51.0 以降で利用できます。 `calculateProjectedRebateAmount` — 指定されたトランザクション ID に関連付けられたリベート種別の推定リベート金額を計算します。API バージョン 54.0 以降で利用できます。 `calculateRebateAmountAndUpsertPayout` — 指定された集計レコードの払い戻し金額を計算し、払い戻し支払を更新/挿入します。API バージョン 51.0 以降で利用できます。 `getBenefitAndCalculateRebateAmount` — 指定された集計レコードの利益の詳細を取得して、必要に応じて払い戻し金額を計算します。API バージョン 51.0 以降で利用できます。 `getEligibleProgramRebateTypes` — 対応付けられたオブジェクトの対象プログラムリベート種別を取得します。API バージョン 52.0 以降で利用できます。 `generateRebatePayoutPeriods` — プログラムで指定された頻度に基づいてリベートプログラムの支払期間を生成します。API バージョン 51.0 以降で利用できます。 `processRebatesBatchCalculationJob` — データ処理エンジンから払い戻し一括計算ジョブを処理します。API バージョン 51.0 以降で利用できます。 `processProgramRebateTypeProducts` — プログラムリベート種別商品オブジェクトにレコードを挿入または削除します。API バージョン 53.0 以降で利用できます。 `rebatesProcessCSV` — Bulk API 2.0 を使用してアップロードされた CSV ファイルを処理し、ファイルのデータを対象オブジェクトのレコードに変換します。API バージョン 51.0 以降で利用できます。 `upsertCustomRebatePayout` — 指定された集計レコードのカスタム計算済み払い戻し支払を更新/挿入します。API バージョン 51.0 以降で利用できます。この値はロイヤルティ管理で使用できます。 `adjustPoints` — 指定したプログラムメンバーまたは仕訳取引のロイヤルティポイントを調整します。API バージョン 51.0 以降で利用できます。 `assignTierBenefits` — 利点アクションに関連付けられた利点に対するメンバーの階層にメンバーの利点を割り当てます。API バージョン 51.0 以降で利用できます。 `cancelAccrual` — 特定の獲得取引セットをキャンセルします。 `creditPoints` — 指定したプログラムメンバーの残数にロイヤルティポイントをクレジット処理します。API バージョン 51.0 以降で利用できます。 `cancelRedemption` — 特定の受け取り取引セットを取り消します。API バージョン 51.0 以降で利用できます。 `changeTier` — 指定したプログラムメンバーの階層を変更します。API バージョン 51.0 以降で利用できます。 `changeTierWhenNoErrors` — すべての入力パラメータが条件を満たした場合にのみ指定したロイヤルティプログラムメンバーの階層を変更します。API バージョン 51.0 以降で利用できます。 `debitPoints` — 指定したプログラムメンバーの残数からロイヤルティポイントをデビット処理します。API バージョン 51.0 以降で利用できます。 `executeMemberBenefit` — ロイヤルティプログラムメンバーに割り当てられている利点に関連付けられた利点アクションを処理します。API バージョン 51.0 以降で利用できます。 `getMemberActiveSegments` — ロイヤルティプログラムメンバーが属している有効なカスタマーデータプラットフォーム市場区分を取得します。 `getTier` — 指定したプログラムメンバーの現在の階層を取得します。API バージョン 51.0 以降で利用できます。 `getPointsBalance` — 指定したプログラムメンバーのロイヤルティポイント残数を取得します。API バージョン 51.0 以降で利用できます。 `getLoyaltyPromotion` — 取引記録に基づく有効なロイヤルティプロモーションを取得します。API バージョン 53.0 以降で利用できます。 `getLoyaltyPromotionBasedOnSalesforceCDP` — メンバーが属する市場区分に基づいてメンバーのプロモーションを取得します。API バージョン 53.0 以降で利用できます。 `issueVoucher` — メンバーまたは契約のバウチャーを発行します。API バージョン 51.0 以降で利用できます。 `mergeLoyaltyProgramMembership` — 同じロイヤルティプログラムに属する 2 つの有効なロイヤルティプログラムメンバーレコードをマージします。API バージョン 56.0 以降で利用できます。 `transferMemberPointsToGroups` — 個人メンバーまたは法人メンバーからメンバーの関連付けられたグループにポイントを移行します。API バージョン 53.0 以降で利用できます。 `updateProgressForCumulativePromotionUsage` — 累積種別プロモーションの達成に向けたメンバーの進行状況を更新します。API バージョン 53.0 以降で利用できます。 `unmergeLoyaltyProgramMembership` — [マージ済み] 状況のロイヤルティプログラムメンバーレコードをマージ解除します。このアクションは、以前マージされたメンバーシップから [マージ済み] 状況のメンバーシップをマージ解除します。API バージョン 56.0 以降で利用できます。 `runProgramProcess` — 有効なロイヤルティプログラム設定アクションをトリガします。API バージョン 56.0 以降で利用できます。決定テーブルの値は次のとおりです。 `decisionTableAction` — 有効な決定テーブル定義を実行します。API バージョン 51.0 以降で利用できます。 `refreshDecisionTable` — 決定テーブルのキャッシュを更新します。API バージョン 51.0 以降で利用できます。一括管理ジョブの値は次のとおりです。 `batchJobAction` — 一括管理ジョブ定義を実行します。API バージョン 51.0 以降で利用できます。 `submitFailedRecordsBatchJob` — 処理に失敗したレコードを含む既存の一括処理ジョブを再送信します。API バージョン 52.0 以降で利用できます。データ処理エンジンの値は次のとおりです。 `dataProcessingEngineAction` — データ処理エンジン定義を実行します。API バージョン 51.0 以降で利用できます。この値は、Einstein 訪問のおすすめで使用されます。 `saveRecommendationDecision` — 訪問および ToDo のおすすめ決定を保存します。API バージョン 51.0 以降で利用できます。これらの値は、今後の使用のために予約されています。 `thanks` `metricRefresh` `exportSurveyResponses` `sendSurveyInvitation` これらの値は、Field Service で使用されます。バージョンを指定していない場合、この値は API バージョン 52.0 以降で使用できます。 `addWorkPlans` — 作業プランライブラリから作業プランおよび作業ステップオブジェクトを作成します。 `addWorkSteps` — 作業プランから作業ステップオブジェクトを作成します。 `deleteWorkPlans` — 作業指示または作業指示品目に関連付けられたすべての作業プランと作業ステップを削除します。 `generateWorkPlans` — 作業プランライブラリに定義されているルールに基づいて作業プランを生成します。
connector	FlowConnector	このアクションコールの後に実行するノードを指定します。
dataTypeMappings	FlowDataTypeMapping[]	汎用 sObject データ型を持つ入力値と出力値のデータ型を対応付ける配列。この項目は、API バージョン 48.0 以降で使用できます。
faultConnector	FlowConnector	アクションコールの結果がエラーの場合に実行するノードを指定します。
inputParameters	FlowActionCallInputParameter[]	フローからアクションへの入力パラメータの配列。
outputParameters	FlowActionCallOutputParameter[]	アクションからフローへの出力パラメータの配列。
storeOutputAutomatically	boolean	アクションの出力パラメータが変数を作成せずに自動的にフローで使用可能になるかどうかを示します。値が `true` の場合、フローでアクション要素の API 名を指定することで、出力パラメータを参照できます。デフォルト値は、`false` です。値が `false` の場合、アクションからの出力値を保存する変数を手動で作成します。この項目は、API バージョン 48.0 以降で使用できます。

FlowActionCallInputParameter

フローからアクションへの入力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン 31.0 以降で利用できます。

項目名	項目の型	説明
name	string	必須。入力パラメータの一意の名前。
value	FlowElementReferenceOrValue	入力パラメータの値を定義します。

FlowActionCallOutputParameter

アクションからフローへの出力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン 31.0 以降で利用できます。

項目名	項目の型	説明
assignToReference	string	必須。出力パラメータ値を割り当てる変数を指定します。
name	string	必須。出力パラメータの一意の名前。

FlowApexPluginCall

フローから Apex プラグインへのコールを定義します。FlowNode を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
apexClass	string	必須。Apex クラスの名前。
connector	FlowConnector	この Apex プラグインコールの後に実行するノードを指定します。
faultConnector	FlowConnector	Apex プラグインコールの結果がエラーの場合に実行するノードを指定します。
inputParameters	FlowApexPluginCallInputParameter[]	フローから Apex プラグインへの入力パラメータの配列。
outputParameters	FlowApexPluginCallOutputParameter[]	Apex プラグインからフローへの出力パラメータの配列。

FlowApexPluginCallInputParameter

フローから Apex プラグインへの入力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
name	string	必須。入力パラメータの一意の名前。
value	FlowElementReferenceOrValue	入力パラメータの値を定義します。

FlowApexPluginCallOutputParameter

Apex プラグインからフローへの出力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
assignToReference	string	必須。出力パラメータ値を割り当てる変数を指定します。
name	string	必須。出力パラメータの一意の名前。

FlowAssignment

フロー内の変数の値を動的に変更できる割り当てノードを定義します。FlowNode を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
assignmentItems	FlowAssignmentItem[]	インデックス 0 から開始して特定の順序で実行される、割り当て操作の配列。
connector	FlowConnector	この割り当てノードの後に実行するノードを指定します。

FlowAssignmentItem

変数に適用する操作を定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
assignToReference	string	必須。指定した演算子を適用する変数への参照。
operator	FlowAssignmentOperator (string 型の列挙)	必須。assignToReference 項目での変数参照に適用する操作。有効な値については、「FlowAssignmentOperator」を参照してください。
value	FlowElementReferenceOrValue	演算子で assignToReference 項目の変数参照に適用する値を定義します。

FlowAssignmentOperator

assignToReference 項目の変数に適用する操作を指定する string 型の列挙です。Salesforce ヘルプの「割り当て要素のフロー演算子」を参照してください。

有効な値は、次のとおりです。

列挙値	説明
`Add`	assignToReference 項目が number または currency 型の変数の場合、この演算子は value を変数に加算します。 assignToReference 項目が date 型の変数の場合、この演算子は日単位の value を変数に加算します。 assignToReference 項目が string 型の変数の場合、この演算子は value を文字列の末尾に追加します。 assignToReference 項目が picklist 型の変数の場合、この演算子は value を選択リストの最後の項目の末尾に追加します。 assignToReference 項目が multipicklist 型の変数の場合、この演算子は value を複数選択リストの最後の項目の末尾に追加します。項目を複数選択リストの末尾に追加する場合は、`AddItem` 演算子を使用します。 assignToReference 項目が $Flow.ActiveStages グローバル変数の場合、この演算子は、value を新規項目として $Flow.ActiveStages の末尾に追加します。 assignToReference 項目がコレクション変数の場合、この演算子は value をコレクションの末尾に追加します。API バージョン 43.0 以降では、value としてコレクション変数がサポートされますが、メタデータ API を使用する必要があります。Flow Builder からは、`Add` 演算子の [値] 列に、コレクション変数を含む割り当て要素を保存できません。 assignToReference 項目が boolean、dateTime、または sObject 型の変数の場合、`Add` 演算子はサポートされません。
`AddAtStart`	assignToReference 項目がコレクション変数または $Flow.ActiveStages グローバル変数の場合にのみサポートされます。value を新規項目としてコレクションの先頭に追加します。value がコレクション変数の場合、この演算子はすべての項目をコレクションの先頭に追加します。この演算子は、API バージョン 43.0 以降で使用できます。
`AddItem`	assignToReference 項目が multipicklist 型の変数の場合にのみサポートされます。セミコロンを含め、value を選択リストに追加します。セミコロンは value を個別の項目としてマークするために必要です。この演算子は、API バージョン 34.0 以降で使用できます。
`Assign`	value を assignToReference 項目の変数に割り当てます。
`AssignCount`	value がコレクション変数または $Flow.ActiveStages グローバル変数の場合にのみサポートされます。コレクション内のフェーズまたは項目の数を数え、その数を assignToReference 項目の変数に割り当てます。ユーザインターフェースの [次の数と一致する] に対応します。この演算子は、API バージョン 43.0 以降で使用できます。
`RemoveAfterFirst`	assignToReference 項目がコレクション変数または $Flow.ActiveStages グローバル変数の場合にのみサポートされます。assignToReference 項目の変数内で value の最初のインスタンスを見つけます。この最初のインスタンスより後のすべてを変数から削除します。この演算子は、API バージョン 43.0 以降で使用できます。
`RemoveAll`	assignToReference 項目がコレクション変数または $Flow.ActiveStages グローバル変数の場合にのみサポートされます。assignToReference 項目の変数から value のすべてのインスタンスを削除します。value がコレクション変数の場合、この演算子は各項目のすべてのインスタンスを assignToReference 項目の変数から削除します。この演算子は、API バージョン 43.0 以降で使用できます。
`RemoveBeforeFirst`	assignToReference 項目がコレクション変数または $Flow.ActiveStages グローバル変数の場合にのみサポートされます。assignToReference 項目の変数内で value の最初のインスタンスを見つけます。この最初のインスタンスより前のすべてを変数から削除します。この演算子は、API バージョン 43.0 以降で使用できます。
`RemoveFirst`	assignToReference 項目がコレクション変数または $Flow.ActiveStages グローバル変数の場合にのみサポートされます。assignToReference 項目の変数から value の最初のインスタンスを削除します。この演算子は、API バージョン 43.0 以降で使用できます。
`RemovePosition`	assignToReference 項目がコレクション変数または $Flow.ActiveStages グローバル変数の場合にのみサポートされます。指定された位置にある項目またを削除します。たとえば、コレクションに Red、Green、Blue の 3 つの項目が含まれていて、value が 2 の場合、2 番目の項目 (Green) がコレクション変数から削除されます。この演算子は、API バージョン 43.0 以降で使用できます。 value が実行時にコレクション変数の項目数の範囲に収まる正の整数になることを確認します。
`RemoveUncommon`	assignToReference と value の両方がコレクション変数の場合にのみサポートされます。両方のコレクションに含まれる項目を保持し、残りを assignToReference 項目のコレクション変数から削除します。この演算子は、API バージョン 43.0 以降で使用できます。
`Subtract`	assignToReference 項目が currency、date、または number 型の変数の場合にのみサポートされます。 assignToReference 項目が number または currency 型の変数の場合、この演算子は value を変数から減算します。 assignToReference 項目が date 型の変数の場合、この演算子は日単位の value を変数から減算します。

FlowChoice

選択肢リソースは、フロー全体で参照または再利用できるスタンドアロンの選択オプションです。FlowElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
choiceText	string	必須。画面に表示する選択肢の表示ラベル。
dataType	FlowDataType (string 型の列挙)	必須。有効な値は、次のとおりです。 `Currency` `Date` `Number` `String` `Boolean`
userInput	FlowChoiceUserInput	選択肢が選択されたときに選択肢でユーザ入力を許可できるようにします。複数選択肢項目ではサポートされません。
value	FlowElementReferenceOrValue	割り当て、Apex プラグインへのコール、レコード要素など、フロー実行時に使用される実際の値。null の場合、この選択肢の値は常に null になります。

FlowChoiceUserInput

ユーザが選択肢を選択したときに表示されるユーザ入力項目を、選択肢に含められるようにします。ユーザ入力は複数選択肢項目ではサポートされません。FlowBaseElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
isRequired	boolean	ユーザが選択肢を選択したときに、ユーザに項目への入力を要求するかどうかを示します。
promptText	string	実行時にユーザに入力を要求するために表示されるテキスト。差し込み項目がサポートされます。
validationRule	FlowInputValidationRule	実行時にユーザ入力の検証に使用されるルール。

FlowCondition

ルールの条件を定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
leftValueReference	string	必須。条件式の左側として機能する要素の一意の名前。
operator	FlowComparisonOperator (string 型の列挙)	必須。有効な値は、次のとおりです。 `EqualTo` `NotEqualTo` `GreaterThan` `LessThan` `GreaterThanOrEqualTo` `LessThanOrEqualTo` `StartsWith` `EndsWith` `Contains` `IsNull` `WasSet` — この値は、API バージョン 30.0 以降で使用できます。 `WasSelected` — 左側に選択肢が必要です。 `WasVisited` — 左側にノードが必要です。 `In` — この値は API バージョン 56.0 以降で使用できます。 `NotIn` — この値は API バージョン 56.0 以降で使用できます。
rightValue	FlowElementReferenceOrValue	条件式の右側の要素の一意の名前または実際の値 (テキストや数値など)。

FlowConnector

コネクタは、フローのノードの実行順序を決定します。コネクタは、後続ノードを定義してそれにリンクします。FlowBaseElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
targetReference	string	必須。現在のノードの完了後に実行するノード。

FlowDataTypeMapping

このデータ型の対応付けは、汎用 sObject データ型を持つ入力値と出力値に特定の sObject データ型を定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン 48.0 以降で利用できます。

項目名	項目の型	説明
typeName	string	必須。入力または出力変数の API 名。入力変数には、`T__` プレフィックスが必要です。出力変数には、`U__` プレフィックスが必要です。たとえば、`T__inputCollection` は入力変数の `inputCollection` の API 名を表します。
typeValue	string	必須。この値を対応付ける特定の sObject データ型の API 名。たとえば、`Account` などです。

FlowConstant

定数リソースは、フロー全体で使用できる固定値を定義します。FlowElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
dataType	FlowDataType (string 型の列挙)	必須。有効な値は、次のとおりです。 `Currency` `Date` `Number` `String` `Boolean`
value	FlowElementReferenceOrValue	定数のデフォルト値。この項目には、差し込み項目を設定できません。また、$GlobalConstant.EmptyString を除き、別のリソースを参照することもできません。

FlowDecision

一連のルールを評価し、最初に true と評価されたルールに基づいてフロー実行を転送する決定ノード。FlowNode を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
defaultConnector	FlowConnector	true と評価されたルールがない場合に実行するノードを指定します。
defaultConnectorLabel	string	デフォルトコネクタの表示ラベル。
rules	FlowRule[]	決定用のルールの配列。ルールはリストされた順序で評価され、最初に true となったルールのコネクタが使用されます。true のルールがない場合、デフォルトのコネクタが使用されます。Flow Builder では、ルールは決定結果と呼ばれます。

FlowDynamicChoiceSet

実行時にオブジェクトからデータまたはメタデータを検索して動的に選択肢のセットを生成します。FlowElement を拡張し、その項目のすべてを継承します。設定された項目に応じて、この要素はレコード選択肢または選択リスト選択肢を表します。

レコード選択肢は、指定された検索条件を満たすレコードに基づいて選択肢を動的に生成します。動的選択肢に picklistField および picklistObject パラメータが設定されていない場合はレコード選択肢となり、Picklist または Multipicklist のデータ型を指定することはできません。
選択リスト選択肢は、選択リストまたは複数選択リスト項目で使用できる値に基づいて選択肢を動的に生成します。動的選択肢に picklistField および picklistObject パラメータが設定されている場合は選択リスト選択肢となり、Picklist または Multipicklist のデータ型を指定する必要があります。

項目名	項目の型	説明
collectionReference	string	選択肢の生成に使用するコレクション。API バージョン 54.0 以降で利用できます。
dataType	FlowDataType (string 型の列挙)	必須。有効な値は、次のとおりです。 `Boolean` `Currency` `Date` `Multipicklist` — 選択リスト選択肢のみ `Number` `Picklist` — 選択リスト選択肢のみ `Record` `String` Picklist および Multipicklist は、API バージョン 35.0 以降で使用できます。Record は、API バージョン 54.0 以降で使用できます。
displayField	string	レコード選択肢で必須。オブジェクト項目を指定します。オブジェクト項目の値は、レコードを選択するための選択肢表示ラベルとしてユーザに表示されます。たとえば、取引先では、動的に生成される選択肢をデータベースから取得したレコードの取引先名として表示する場合、displayField の `Name` を指定します。選択リスト選択肢ではサポートされていません。選択リスト選択肢では、取得された選択リスト値の表示ラベルが常に表示されます。
filters	FlowRecordFilter[]	データベースから取得したレコードに適用する検索条件の配列。たとえば、過去 3 か月に作成された取引先のみを含めるように取引先を絞り込みます。選択リスト選択肢ではサポートされていません。
limit	int	生成される選択肢のセットに含まれる選択肢の最大数です。最大数とデフォルトの数は 200 です。 sortField と sortOrder も指定されている場合、レコードは、limit が適用される前に並び替えられます。この項目は、API バージョン 25.0 以降で使用できます。この項目は API バージョン 45.0 以降で null にすることができます。
object	string	レコード選択肢で必須。データベースから項目を取得して、選択肢のセットの生成に使用するオブジェクト。たとえば、データベースの取引先レコードの情報から選択肢を動的に生成するには、"Account" を使用します。選択リスト選択肢ではサポートされていません。
outputAssignments	FlowOutputFieldAssignment[]	ユーザが選択したレコードの項目をフローの他の場所で使用できる変数に割り当てる配列。たとえば、ユーザが動的に生成された選択オプションのリストから取引先名を選択した場合、outputAssignments はユーザが選択した取引先からの ID と AnnualRevenue を指定した変数に割り当てることができます。選択リスト選択肢ではサポートされていません。
picklistField	string	選択リスト選択肢で必須。使用可能な値をデータベースから取得して選択リストの選択肢の生成に使用する項目。たとえば、[業種] 選択リスト項目で使用可能な値ごとに 1 つの選択肢を動的に生成するには、「業種」を使用します。レコード選択肢ではサポートされていません。この項目は、API バージョン 35.0 以降で使用できます。
picklistObject	string	選択リスト選択肢で必須。項目メタデータをデータベースから取得して選択リストの選択肢の生成に使用するオブジェクト。たとえば、Account オブジェクトの選択リスト項目から選択肢を動的に生成するには、「Account」を使用します。レコード選択肢ではサポートされていません。この項目は、API バージョン 35.0 以降で使用できます。
sortField	string	検索条件を満たすレコードを並び替えるために使用される項目。この項目が指定されていない場合、返されるレコードは並び替えられません。 SOAP API に明記されているとおり、[並び替え] API 項目プロパティを持つ項目でのみ、レコードを並び替えることができます。選択リスト選択肢ではサポートされていません。この項目は、API バージョン 25.0 以降で使用できます。
sortOrder	SortOrder (string 型の列挙)	レコードの並び替え順です。この項目が指定されていない場合、結果は並び替えられません。有効な値は、次のとおりです。 `Asc` — 昇順 `Desc` — 降順選択リスト選択肢ではサポートされていません。この項目は、API バージョン 25.0 以降で使用できます。
valueField	string	選択肢の保存値。ユーザに選択オプションとして表示される値 (displayField) とは異なる場合があります。たとえば、displayField が取引先の "Name" で、valueField が取引先の "Id" になる場合があります。選択リスト選択肢ではサポートされていません。選択リスト選択肢では、取得された選択リスト値の API 値が常に保存されます。

FlowElement

すべてのフロー要素の基本クラス。これは抽象クラスです。FlowBaseElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
description	string	フロー要素の説明。
name	string	フロー要素の一意の名前。

FlowBaseElement

メタデータ値のコンテキスト情報を必要とするすべてのフロー要素の基本クラス。これは抽象クラスです。FlowBaseElement は、API バージョン 32.0 以降で使用できます。

項目名	項目の型	説明
processMetadataValues	FlowMetadataValue[]	要素のコンテキスト情報。

FlowMetadataValue

フローの要素間で渡されるコンテキスト情報を定義します。フローのメタデータ値は、フローを生成または消費するアプリケーションで使用できます。FlowMetadataValue は、API バージョン 31.0 以降で使用できます。

項目名	項目の型	説明
name	string	必須。メタデータ値の名前。この名前は要素全体で一意である必要はありません。
value	FlowElementReferenceOrValue	メタデータ値の参照または値。

FlowElementReferenceOrValue

既存の要素または指定した特定の値への参照を定義します。必ずいずれか 1 つの項目のみを指定してください。

項目名	項目の型	説明
booleanValue	boolean	boolean 値を指定するにはこの項目を使用します。異なるデータ型または要素参照を指定する場合は、この項目を使用しないでください。
dateTimeValue	dateTime	dateTime 値を指定するにはこの項目を使用します。異なるデータ型または要素参照を指定する場合は、この項目を使用しないでください。この項目は、API バージョン 30.0 以降で使用できます。
dateValue	date	date 値を指定するにはこの項目を使用します。異なるデータ型または要素参照を指定する場合は、この項目を使用しないでください。
elementReference	string	既存の要素の名前を指定するにはこの項目を使用します。要素参照の代わりに値を指定する場合は、この項目を使用しないでください。
numberValue	double	double 値を指定するにはこの項目を使用します。異なるデータ型または要素参照を指定する場合は、この項目を使用しないでください。
stringValue	string	string 値を指定するにはこの項目を使用します。異なるデータ型または要素参照を指定する場合は、この項目を使用しないでください。

FlowFormula

フローの関数と要素を使用して値を計算します。FlowElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
dataType	FlowDataType (string 型の列挙)	数式のデータ型。有効な値は、次のとおりです。 `Boolean` `Currency` `Date` `DateTime` `Number` `String` dataType は、数式で定義されていない場合、デフォルトの `Number` になります。この項目は、API バージョン 31.0 以降で使用できます。
expression	string	必須。Salesforce の数式。返される値は、データ型が��じである必要があります。API バージョン 30.0 以前では、返される値は数値である必要があります。
scale	int	返される値のスケール。特に、小数点以下の桁数。データ型が数値または通貨の場合にのみ使用できます。Flow Builder の [小数点の位置] 項目に対応します。

項目名

項目の型

説明

dataType

FlowDataType (string 型の列挙)

数式のデータ型。有効な値は、次のとおりです。

Boolean
Currency
Date
DateTime
Number
String

dataType は、数式で定義されていない場合、デフォルトの Number になります。

この項目は、API バージョン 31.0 以降で使用できます。

expression

string

必須。Salesforce の数式。返される値は、データ型が��じである必要があります。API バージョン 30.0 以前では、返される値は数値である必要があります。

scale

int

返される値のスケール。特に、小数点以下の桁数。データ型が数値または通貨の場合にのみ使用できます。Flow Builder の [小数点の位置] 項目に対応します。

FlowInputFieldAssignment

リソースまたは静的値に基づいてレコード項目の値を割り当てます。FlowBaseElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
field	string	必須。レコードの作成または更新中に値が割り当てられる項目の名前。
value	FlowElementReferenceOrValue	項目に割り当てられる値。

FlowInputValidationRule

入力規則は、ユーザが入力したデータが指定された要件を満たすことを検証します。入力規則の評価が false の場合、指定されたエラーメッセージが表示されます。

項目名	項目の型	説明
errorMessage	string	必須。formulaExpression が false と評価されたときに表示するエラーメッセージ。
formulaExpression	string	必須。ユーザ入力の検証に使用される boolean 数式。

FlowLoop

コレクションを反復処理するためのコンストラクタ。FlowNode を拡張し、その項目のすべてを継承します。FlowLoop は、API バージョン 30.0 以降で使用できます。

項目名	項目の型	説明
assignNextValueToReference	string	nextValueConnector の対象に移動する前に、コレクション内の現在の値が割り当てられる変数。
collectionReference	string	必須。ループ対象のコレクション。
iterationOrder	iterationOrder (string 型の列挙)	有効な値は、次のとおりです。 `Asc` — 値がリストされている順序で (最初から最後へ)、コレクションを反復処理します。 `Desc` — 値がリストされている順序と逆に (最後から最初へ)、コレクションを反復処理します。
nextValueConnector	FlowConnector	コレクション内のエントリごとにフローの移動先となる要素を指し示します。フローはコレクション内の次の値を処理するためにここに移動します。
noMoreValuesConnector	FlowConnector	コレクションのすべてのエントリのループが終了したときに移動先となる要素を指し示します。

FlowNode

ノードは、フローダイアグラムに表示される要素の種別です。FlowElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
elementSubtype	FlowElementSubtype (string 型の列挙)	内部使用のために予約されています。
label	string	ノードの名前。この一意ではない表示ラベルは、FlowElement から継承される、ノードの一意の名前とは異なります。
locationX	int	必須。ノードの水平位置 (左からのピクセル数)。
locationY	int	必須。ノードの垂直位置 (上からのピクセル数)。

FlowOrchestratedStage

オーケストレーションのステップを含むフェーズノード。FlowNode を拡張し、その項目のすべてを継承します。API バージョン 53.0 以降で利用できます。

項目名	項目の型	説明
connector	FlowConnector	このフェーズの後に実行するノードを指定します。
exitActionInputParameters	FlowStageStepExitActionInputParameter[]	フェーズから、フェーズの終了条件として使用される評価フローへの入力パラメータの配列。
exitActionName	string	フェーズの終了条件として使用される評価フローの名前。有効な値は、次のとおりです。 `isOrchestrationConditionMet`
exitActionOutputParameters	FlowStageStepExitActionOutputParameter[]	評価フローから、フェーズの終了条件として使用されるフェーズへの出力パラメータの配列。
exitActionType	InvocableActionType (string 型の列挙)	カスタム終了条件の評価フローの種別。有効な値は、次のとおりです。 `EvaluationFlow`
exitConditionLogic	string	内部使用のために予約されています。
exitConditions	FlowCondition[]	フェーズを終了する場合に満たすべき条件の配列。
faultConnector	FlowConnector	将来の使用のために予約されています。
stageSteps	FlowStageStep[]	フェーズステップリソースの配列。

FlowOutputFieldAssignment

レコード項目の値を、レコードからフローの他の場所で使用できる変数に割り当てます。レコードは、レコードの検索で選択される場合と、ユーザが選択肢を選択することで選択される場合があります。FlowBaseElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
assignToReference	string	必須。レコード項目の値を保存する変数への参照。
field	string	必須。レコードの検索の後に値が割り当てられる項目の名前。

FlowRecordCreate

フローからの値を使用してデータベース内に新しいレコードを作成します。FlowNode を拡張し、そのプロパティのすべてを継承します。

フローレコードの作成、ルックアップ、更新、および削除操作は、CRUD ベースのメタデータコールである create()、retrieve()、update()、および delete() とは異なります。フローレコードメソッドは、フロー内からレコード操作に適用されるため、CRUD 設定エンティティへのメタデータコールの実行とは異なります。

メモ

項目名	項目の型	説明
assignRecordIdToReference	string	レコードの作成後に ID を保存する変数への参照。
connector	FlowConnector	レコードの作成後に実行するノードを指定します。
faultConnector	FlowConnector	レコードを作成しようとしてエラーになった場合に実行するノードを指定します。
inputAssignments	FlowInputFieldAssignment[]	作成中のレコードの指定された項目に値を割り当てる配列。
inputReference	string	項目値が新しいレコードの項目への入力に使用されるレコード変数を指定します。
object	string	必須。この要素によって作成されるレコードのオブジェクト
storeOutputAutomatically	boolean	変数を作成することなく自動的にフローでレコード ID が使用可能になるかどうかを示します。値が `true` の場合、フローでレコードの作成要素の API 名を指定することで、レコード ID を参照できます。デフォルト値は、`false` です。値が `false` の場合、レコード ID を保存する変数を作成します。この項目は、API バージョン 48.0 以降で使用できます。

FlowRecordDelete

データベース内の 1 つ以上のレコードを削除します。FlowNode を拡張し、その項目のすべてを継承します。

フローレコードの作成、ルックアップ、更新、および削除操作は、CRUD ベースのメタデータコールである create()、retrieve()、update()、および delete() とは異なります。フローレコードメソッドは、フロー内からレコード操作に適用されるため、CRUD 設定エンティティへのメタデータコールの実行とは異なります。

メモ

項目名	項目の型	説明
connector	FlowConnector	レコードの削除後に実行するノードを指定します。
faultConnector	FlowConnector	レコードを削除しようとしてエラーになった場合に実行するノードを指定します。
filters	FlowRecordFilter[]	データベースから削除されるレコードの選択に使用される条件を指定する配列。たとえば、指定日以降に活動のない取引先を削除します。
inputReference	string	レコード ID がデータベース内で削除するレコードの識別に使用されるレコード変数を指定します。
object	string	必須。レコードが削除されるオブジェクトの名前。

FlowRecordFilter

データベースのレコードを検索する条件を設定します。FlowBaseElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
field	string	必須。レコードの絞り込みに使用される項目。
operator	FlowRecordFilterOperator (string 型の列挙)	必須。有効な値は、次のとおりです。 `EqualTo` `NotEqualTo` `GreaterThan` `LessThan` `GreaterThanOrEqualTo` `LessThanOrEqualTo` `StartsWith` `EndsWith` `Contains` `IsNull`
value	FlowElementReferenceOrValue	レコードを絞り込むために、項目および演算子と一緒に使用される参照または値。

FlowRecordLookup

フローでデータベース内のレコードを検索し、それらの項目値を保存します。Flow Builder のレコード取得要素に対応します。FlowNode を拡張し、その項目のすべてを継承します。

フローレコードの作成、ルックアップ、更新、および削除操作は、CRUD ベースのメタデータコールである create()、retrieve()、update()、および delete() とは異なります。フローレコードメソッドは、フロー内からレコード操作に適用されるため、CRUD 設定エンティティへのメタデータコールの実行とは異なります。

メモ

項目名	項目の型	説明
assignNullValuesIfNoRecordFound	boolean	レコードが見つからない場合にすべての値を `null` に設定することを指定します。storeOutputAutomatically が `false` の場合にのみサポートされます。この項目は、API バージョン 30.0 以降で使用できます。
connector	FlowConnector	データベースのレコードの取得後に実行するノードを指定します。
faultConnector	FlowConnector	レコード結果を取得しようとしてエラーになった場合に実行するノードを指定します。
filters	FlowRecordFilter[]	データベースからのレコードの選択に使用する条件を指定する配列。検索条件で複数のレコードが返された場合、指定された sortField と sortOrder に基づいて並び替えられます。outputReference で非コレクションレコード変数が指定されている場合、または getFirstRecordOnly が `true` の場合、並び替えられたリストの最初のレコードのみが選択されます。 sortField または sortOrder が指定されていない場合、レコードは特定の順序で返されません。outputReference で非コレクションレコード変数が指定されている場合、または getFirstRecordOnly が `true` の場合、並び替えられていないリストの最初のレコードのみが選択されます。
getFirstRecordOnly	boolean	検索条件を満たすレコードが複数あっても 1 つのレコードの項目値のみを保存するかどうかを示します。storeOutputAutomatically が `true` の場合にのみサポートされます。storeOutputAutomatically が `false` の場合、1 つのレコードが保存されるのか、複数のコードが保存されるのかは、outputReference でレコード変数が指定されるのか、レコードコレクション変数が指定されるのかによって決まります。この項目は、API バージョン 47.0 以降で使用できます。
limit	int	返すレコードの最大数。受信するデータ量を制限します。この項目は、API バージョン 30.0 以降で使用できます。
object	string	必須。レコードの選択元となるオブジェクトの名前。
outputAssignments	FlowOutputFieldAssignment[]	選択されたレコードの項目を、フローの他の場所で使用できる変数に割り当てる配列。storeOutputAutomatically が `false` の場合にのみサポートされます。
outputReference	string	照会された項目の値が保存されるレコード変数またはレコードコレクション変数を指定します。storeOutputAutomatically が `false` の場合にのみサポートされます。
queriedFields	string[]	選択されたレコードから指定されたレコード変数に保存される項目を指定する配列。
sortField	string	検索条件を満たすレコードを並び替えるために使用される項目。この項目が指定されていない場合、返されるレコードは並び替えられません。 SOAP API に明記されているとおり、[並び替え] API 項目プロパティを持つ項目でのみ、レコードを並び替えることができます。この項目は、API バージョン 25.0 以降で使用できます。
sortOrder	SortOrder (string 型の列挙)	レコードの並び替え順です。この項目が指定されていない場合、結果は並び替えられません。有効な値は、次のとおりです。 `Asc` — 昇順 `Desc` — 降順この項目は、API バージョン 25.0 以降で使用できます。
storeOutputAutomatically	boolean	返されるレコードの項目値が変数を作成せずに自動的にフローで使用可能になるかどうかを示します。値が `true` の場合、レコード取得要素の name や `Get_Contacts.AccountId` などのレコード項目を指定してフローで項目を参照できます。processType が `Flow` または `AutoLaunchedFlow` の場合にのみサポートされます。この項目は、API バージョン 47.0 以降で使用できます。

FlowRecordRollback

現在のトランザクションをロールバックし、保留中のレコード変更をキャンセルします。Flow Builder のロールバックレコード要素に対応します。画面フローでのみ使用できます。

FlowRecordRollback は FlowNode を拡張し、そのすべての項目を継承します。API バージョン 52.0 以降で利用できます。

項目名	項目の型	説明
connector	FlowConnector	現在のトランザクションをロールバックした後に実行するノードを指定します。

FlowRecordUpdate

データベース内のレコードを検索し、フローからの値で更新します。FlowNode を拡張し、その項目のすべてを継承します。

フローレコードの作成、ルックアップ、更新、および削除操作は、CRUD ベースのメタデータコールである create()、retrieve()、update()、および delete() とは異なります。フローレコードメソッドは、フロー内からレコード操作に適用されるため、CRUD 設定エンティティへのメタデータコールの実行とは異なります。

メモ

項目名	項目の型	説明
connector	FlowConnector	レコード更新の完了後に実行するノードを指定します。
faultConnector	FlowConnector	レコードを更新しようとしてエラーになった場合に実行するノードを指定します。
filters	FlowRecordFilter[]	データベース内で更新するレコードの選択に使用される条件を指定する配列。
inputAssignments	FlowInputFieldAssignment[]	更新されるレコードの指定項目に値を割り当てる配列。
inputReference	string	項目値がレコードの項目の更新に使用されるレコード変数を指定します。
object	string	必須。レコードが更新されるオブジェクトの名前。

FlowRule

ルールが true と評価できる条件とロジックを定義します。FlowElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
conditionLogic	string	条件のロジックを指定します。次の値を指定できます。 `and` — すべての条件が true に評価された場合にのみ `true` に評価されます。 `or` — いずれかの条件が true に評価された場合に `true` に評価されます。高度なロジック (`1 AND (2 OR 3)` など) — 最初の条件が true で、2 つ目または 3 つ目の条件が true の場合に true と評価されます。高度なロジックを使用する場合、文字列は 1,000 文字以内にする必要があります。
conditions	FlowCondition[]	ルールの条件の配列。
connector	FlowConnector	決定でこのルールが最初に true と評価されたルールである場合に実行するノードを指定します。
doesRequireRecordChangedToMeetCriteria	boolean	`true` に設定されている場合、条件が `true` に評価されるのは、レコードが更新のトリガ前は必要な条件を満たしていなかったが、更新後は条件を満たすようになった場合のみです。API バージョン 50.0 以降で利用できます。
label	string	必須。コネクタの表示ラベル。

FlowScreen

画面は、ユーザから情報を収集してユーザに情報を表示します。FlowNode を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
allowBack	boolean	実行時に [前へ] ボタンを画面に表示するか (`true`)、非表示にするか (`false`) を示します。true の場合、[前へ] ボタンは、ユーザがフローパスで前の画面にアクセスしており、画面の showFooter が true に設定されている場合にのみ表示されます。クレジットカードトランザクションなど、前の画面に再アクセスした場合に繰り返されてはならないアクションが起動されてしまう場合は、この項目を false に設定します。この項目は、API バージョン 26.0 以降で使用できます。デフォルト: `true` allowBack と allowFinish のいずれかを false に設定できますが、両方を設定することはできません。
allowFinish	boolean	実行時に [完了] ボタンを画面に表示するか (true)、非表示にするか (false) を示します。true の場合、[完了] ボタンは、画面要素がフローパスの最後であり、画面の showFooter が true に設定されている場合にのみ表示されます。ユーザが前の画面に戻ってフローを続行または完了させる必要がある場合は、これを false に設定します。たとえば、ユーザに前の画面に戻って修正するように指示する画面に [完了] ボタンは含めません。この項目は、API バージョン 26.0 以降で使用できます。デフォルト: true allowBack と allowFinish のいずれかを false に設定できますが、両方を設定することはできません。
allowPause	boolean	実行時に [一時停止] ボタンを画面に表示するか (true)、非表示にするか (false) を示します。デフォルト値は true です。次のすべての条件が true の場合、フロー画面に [一時停止] ボタンが表示されます。組織のプロセス自動化設定で、[フローの一時停止をユーザに許可] が有効化されている。画面の allowPause が true に設定されている。フローが Visualforce ページに埋め込まれている場合、<flow:interview> コンポーネントの showAllowPause 属性が true に設定されている。画面の showFooter 項目が true に設定されている。この項目は、API バージョン 33.0 以降で使用できます。
backButtonLabel	string
connector	FlowConnector	画面ノードの後に実行するノードを指定します。
fields	FlowScreenField[]	画面に表示する項目の配列。
helpText	string	エンドユーザがヘルプテキストのリンクをクリックした場合に表示されるテキスト。 API バージョン 26.0 以降で差し込み項目をサポートします。
nextOrFinishButtonLabel	string
pauseButtonLabel	string
pausedText	string	エンドユーザが [一時停止] をクリックすると表示される確認メッセージ。この項目は、API バージョン 33.0 以降で使用できます。
rules	FlowScreenRule[]	将来の使用のために予約されています。
showFooter	boolean	Lightning ランタイムで画面のフッターを表示するか (true)、非表示にするか (false) を示します。Classic ランタイムはサポートされません。デフォルト値は true です。フッターには画面のナビゲーションアクションが含まれます。showFooter を非表示にした場合、画面の Lightning コンポーネントを使用してナビゲーションアクションを表示します。この項目は、API バージョン 42.0 以降で使用できます。
showHeader	boolean	Lightning ランタイムで画面のヘッダーを表示するか (true)、非表示にするか (false) を示します。Classic ランタイムはサポートされません。デフォルト値は true です。ヘッダーには画面のヘルプテキストへのアクセスが含まれます。showHeader を非表示にした場合、画面の Lightning コンポーネントを使用してヘルプテキストを表示します。この項目は、API バージョン 42.0 以降で使用できます。

FlowScreenField

画面コンポーネントを表します。FlowScreenField は FlowElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
choiceReferences	string[]	FlowChoices または FlowDynamicChoiceSets への参照の配列。作成される選択オプションは、この配列で指定した順序で表示されます。インデックス 0 の要素が最上位の選択オプションになります。次の型の画面コンポーネントでサポートされます。 RadioButtons DropdownBox MultiSelectCheckboxes MultiSelectPicklist 複数選択チェックボックスおよび複数選択リスト項目は、API バージョン 26.0 以降で使用できます。
dataType	FlowDataType (string 型の列挙)	画面コンポーネントのデータ型。InputField、RadioButtons、および DropdownBox 型の画面コンポーネントでのみサポートされます。有効なデータ型は、次のとおりです。 `Boolean` `Currency` `Date` `DateTime` `Number` `String` 実行時にチェックボックス項目として表示される Boolean 入力項目は、API バージョン 26.0 以降で使用できます。複数選択チェックボックスおよび複数選択リスト項目では、string データ型のみがサポートされます。複数選択項目は、API バージョン 26.0 以降で使用できます。日付/時間型の入力項目は、API バージョン 43.0 以降で使用できます。
dataTypeMappings	FlowDataTypeMapping[]	将来の使用のために予約されています。
defaultSelectedChoiceReference	string	画面コンポーネントのデフォルト値として使用される FlowChoice 要素の名前。次の型の画面コンポーネントでサポートされます。 RadioButtons DropdownBox MultiSelectCheckboxes MultiSelectPicklist DropDownBox データ型についてのみ、defaultSelectedChoiceReference が空か null の場合、choiceReferences のインデックス 0 での参照がデフォルト値として使用されます。複数選択チェックボックスおよび複数選択リスト項目では、デフォルト値として FlowChoice 要素を 1 つのみ指定できます。複数選択項目は、API バージョン 26.0 以降で使用できます。
defaultValue	FlowElementReferenceOrValue	画面コンポーネントがユーザに入力を要求したときにデフォルトで使用される値。InputField、LargeTextArea、および PasswordField でのみサポートされます。
extensionName	string	表示する Lightning コンポーネントの名前。この項目は、API バージョン 42.0 以降で使用できます。
fieldText	string	画面に表示される項目の表示ラベル。差し込み項目がサポートされます。
fieldType	FlowScreenFieldType (string 型の列挙)	必須。有効な値は、次のとおりです。 `DisplayText` `InputField` `LargeTextArea` `PasswordField` `RadioButtons` `DropdownBox` `MultiSelectCheckboxes` – API バージョン 26.0 以降で使用可能 `MultiSelectPicklist` – API バージョン 26.0 以降で使用可能 `ComponentInstance` – API バージョン 42.0 以降で使用可能 `ComponentChoice` および `ComponentInput` – API バージョン 48.0 以降で、`Survey` processType にのみ使用できます。実行時、各複数選択項目には、その項目値がユーザが選択した選択肢の値をセミコロンで区切った結合値として保存されます。選択した選択肢の値内のセミコロンは、複数選択項目値に追加されるときに削除されます。
helpText	string	エンドユーザが画面コンポーネントのヘルプアイコン () をクリックした場合に表示されるテキスト。 API バージョン 26.0 以降で差し込み項目をサポートします。
inputParameters	FlowScreenFieldInputParameter[]	入力パラメータの配列。`fieldType` が `ComponentInstance` の場合にのみサポートされます。この項目は、API バージョン 42.0 以降で使用できます。
isRequired	boolean	ユーザが選択肢を選択する必要があるか、または入力する必要があるかを示します。DisplayText または boolean の inputField ではサポートされません。
isVisible	boolean	将来の使用のために予約されています。
outputParameters	FlowScreenFieldOutputParameter[]	出力パラメータの配列。fieldType が `ComponentInstance` の場合や、storeOutputAutomatically が `false` の場合にのみサポートされます。この項目は、API バージョン 42.0 以降で使用できます。
regionContainerType	FlowRegionContainerType (string 型の列挙)	セクションコンポーネントのヘッダーに関する情報を保存します。可能な値には次のものがあります。 `SectionWithHeader` `SectionWithoutHeader` コンポーネントの種類が `Section` の場合にのみ使用できます。API バージョン 55.0 以降で利用できます。
scale	int	小数点以下の桁数 (最大 17 桁) を制御します。この項目を空白にした場合、または 0 に設定した場合は、フローの実行時に整数のみが表示されます。データ型が数値または通貨の場合にのみ使用できます。Flow Builder の [小数点の位置] 項目に対応します。
storeOutputAutomatically	boolean	画面コンポーネントの出力パラメータが変数を作成せずに自動的にフローで使用可能になるかどうかを示します。値が `true` の場合、画面コンポーネントの name や `Mailing_Address.City` などの出力パラメータを指定して出力パラメータを参照できます。 fieldType が `ComponentInstance` の場合にのみサポートされます。この項目は、API バージョン 47.0 以降で使用できます。
validationRule	FlowInputValidationRule	画面コンポーネントが InputField、LargeTextArea、または PasswordField 型の場合、ユーザ入力の検証に使用されるルール。
visibilityRule	FlowVisibilityRule	画面コンポーネントを表示または非表示にするために使用される、条件に基づくルール。この項目は、API バージョン 47.0 以降で使用できます。

FlowScreenFieldInputParameter

フローから拡張への入力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。FlowScreenFieldInputParameter は API バージョン 42.0 で使用できます。

項目名	項目の型	説明
name	string	必須。入力パラメータの一意の名前。
value	string	入力パラメータの値を定義します。

FlowScreenFieldOutputParameter

拡張からフローへの出力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。FlowScreenFieldOutputParameter は API バージョン 42.0 で使用できます。

項目名	項目の型	説明
assignToReference	string	必須。出力パラメータ値を割り当てる変数を指定します。
name	string	必須。出力パラメータの一意の名前。

FlowStage

UI でブレッドクラムなどを使用して表すことができるフローのセクション。FlowElement を拡張し、その項目のすべてを継承します。

インタビューが開始されると、isActive が true になっているすべてのフェーズが、$Flow.ActiveStages グローバル変数に追加されます。この変数はフェーズのコレクションを保持します。各フェーズの stageOrder によって、フェーズの追加順序が決まります。最も低い stageOrder を持つフェーズは $Flow.CurrentStage グローバル変数に割り当てられます。

項目名	項目の型	説明
isActive	boolean	フェーズがデフォルトで有効かどうかを示します。
label	string	このフェーズのわかりやすい表示ラベル。
stageOrder	int	他のステージに対してこのステージをどのように順序付けるかを示します。stageOrder 値はフロー内で一意である必要があります。

FlowStageStep

ステップリソースは、フェーズノード内のステップを定義します。API バージョン 53.0 以降で利用できます。

項目名	項目の型	説明
actionName	string	必須。ステップに関連付けられたフローの名前。
actionType	InvocableActionType (string 型の列挙)	必須。ステップの種別。有効な値は、次のとおりです。 `stepBackground` `stepInteractive`
assignees	FlowStageStepAssignee[]	対話型ステップを完了するために割り当てられたユーザ、グループ、またはキューの配列。
entryActionInputParameters	FlowStageStepEntryActionInputParameter[]	ステップから、ステップのエントリ条件として使用される評価フローへの入力パラメータの配列。
entryActionName	string	ステップのエントリ条件として使用される評価フローの名前。
entryActionOutputParameters	FlowStageStepEntryActionOutputParameter[]	評価フローから、ステップを開始できるかどうかの判断に使用されるステップへの出力パラメータの配列。
entryActionType	InvocableActionType (string 型の列挙)	ステップのカスタムエントリ条件として使用される評価フローの種別。有効な値は、次のとおりです。 `EvaluationFlow`
entryConditionLogic	string	内部使用のために予約されています。
entryConditions	FlowCondition[]	ステップを開始する場合に満たすべき条件の配列。
exitActionInputParameters	FlowStageStepExitActionInputParameter[]	ステップから、ステップの終了条件として使用される評価フローへの入力パラメータの配列。
exitActionName	string	ステップの終了条件として使用される評価フローの名前。
exitActionOutputParameters	FlowStageStepExitActionOutputParameter[]	評価フローから、ステップが終了条件を満たすかどうかの判断に使用されるステップへの出力パラメータの配列。
exitActionType	InvocableActionType (string 型の列挙)	ステップのカスタム終了条件として使用される評価フローの種別。有効な値は、次のとおりです。 `EvaluationFlow`
inputParameters	FlowStageStepInputParameter[]	ステップからそれに関連するフローへの入力パラメータの配列。
label	string	必須。ステップの表示ラベル。
outputParameters	FlowStageStepOutputParameter[]	フローからそれに関連するステップへの出力パラメータの配列。
requiresAsyncProcessing	boolean	バックグラウンドステップが非同期で処理されるかどうかを示します。

FlowStageStepAssignee

対話型ステップに関連付けられた割り当て先。対話型ステップの場合にのみ該当します。API バージョン 53.0 以降で利用できます。

項目名	項目の型	説明
assignee	FlowElementReferenceOrValue	必須。対話型ステップに割り当てられるユーザ、グループ、またはキューの名前。
assigneeType	FlowStageStepAssigneeType (string 型の列挙)	必須。対話型ステップに関連付けられた割り当て先の種別。有効な値は、次のとおりです。 `Group` `Queue` `User`

FlowStageStepEntryActionInputParameter

ステップからそれに関連する評価フローへの入力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン 53.0 以降で利用できます。

項目名	項目の型	説明
name	string	必須。ステップでエントリ条件として使用される評価フローの入力パラメータの一意の名前。
value	FlowElementReferenceOrValue	ステップでエントリ条件として使用される評価フローの入力パラメータの値を定義します。

FlowStageStepEntryActionOutputParameter

ステップがエントリ条件を満たすかどうかの判断に使用される評価フローからの出力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン 53.0 以降で利用できます。

項目名	項目の型	説明
assignToReference	string	将来の使用のために予約されています。
name	string	必須。ステップでエントリ条件として使用される評価フローの出力パラメータの一意の名前。有効な値は、次のとおりです。 `isOrchestrationConditionMet`

FlowStageStepExitActionInputParameter

フェーズまたはステップからそれに関連する評価フローへの入力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン 53.0 以降で利用できます。

項目名	項目の型	説明
name	string	必須。フェーズまたはステップで終了条件として使用される評価フローの入力パラメータの一意の名前。
value	FlowElementReferenceOrValue	フェーズまたはステップで終了条件として使用される評価フローの入力パラメータの値を定義します。

FlowStageStepExitActionOutputParameter

フェーズまたはステップが終了条件を満たすかどうかの判断に使用される評価フローからの出力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン 53.0 以降で利用できます。

項目名	項目の型	説明
assignToReference	string	将来の使用のために予約されています。
name	string	必須。フェーズまたはステップで終了条件として使用される評価フローの出力パラメータの一意の名前。有効な値は、次のとおりです。 `isOrchestrationConditionMet`

FlowStageStepInputParameter

ステップからフローへの入力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン 53.0 以降で利用できます。

項目名	項目の型	説明
name	string	必須。ステップに関連付けられたフローの入��パラメータの一意の名前。
value	FlowElementReferenceOrValue	ステップに関連付けられたフローの入力パラメータの値を定義します。

FlowStageStepOutputParameter

ステップからフローへの出力パラメータを定義します。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン 53.0 以降で利用できます。

項目名	項目の型	説明
assignToReference	string	将来の使用のために予約されています。
name	string	必須。ステップに関連付けられたフローの出力パラメータの一意の名前。

FlowStart

フローを開始する方法を指定するフローの開始要素を表します。自動起動フローでは、フローを実行するタイミングや頻度、および検索条件を満たす一連のレコードのフローを実行するかどうかを開始要素で定義することもできます。

FlowStart は FlowNode を拡張し、name と label 以外のすべての項目を継承します。API バージョン 47.0 以降で利用できます。

項目名	項目の型	説明
connector	FlowConnector	最初に実行する要素を指定します。
doesRequireRecordChangedToMeetCriteria	boolean	`true` に設定されている場合、条件が `true` に評価されるのは、レコードが更新のトリガ前は必要な条件を満たしていなかったが、��新後は条件を満たすようになった場合のみです。API バージョン 50.0 以降で利用できます。
filterFormula	string	保存時にフローを実行するレコードを絞り込むために使用される数式。レコードトリガフローでのみ使用できます。API バージョン 55.0 以降で利用できます。
filterLogic	string	検索条件の要件に適用される検索条件ロジック。すべての条件を要求するには、`AND` を使用します。いずれかの条件を要求するには、`OR` を使用します。カスタム条件ロジックの場合は、`1 AND 2 OR (3 AND 4)` のように論理文字列全体を入力します。API バージョン 50.0 以降で利用できます。
filters	FlowRecordFilter[]	データベースからレコードを取得するときに適用する検索条件の配列。たとえば、過去 4 週間に更新されていないレコードのみが含まれるように取引先を絞り込みます。
object	string	レコードをデータベースから取得するオブジェクト。検索条件を満たすレコードごとにフローインタビューが開始されます。
recordTriggerType	RecordTriggerType (string 型の列挙)	フローを開始できるレコード変更の種別を指定します。可能な値は次のとおりです。 `Create` — レコードの作成時。 `Update` — レコードの更新時、 `CreateAndUpdate` — レコードの作成時と更新時。 `Delete` — レコードの削除時。API バージョン 50.0 以降で利用できます。 triggerType が `RecordBeforeSave` の場合にのみ使用できます。この項目は、API バージョン 48.0 以降で使用できます。
schedule	FlowSchedule	triggerType が `Scheduled` である場合は必須です。フローを実行するタイミングや頻度を指定します。
scheduledPaths	FlowScheduledPath[]	フローのスケジュール済みパスを指定します。API バージョン 51.0 以降で利用できます。
TimeZoneSidKey	string	将来の使用のために予約されています。
triggerType	FlowTriggerType (string 型の列挙)	フローを実行するトリガを指定します。この項目を除外すると、フローのトリガがなくなり、ユーザまたはアプリケーションがこのフローを起動した場合にしか開始されなくなります。可能な値は次のとおりです。 `EventDrivenJourney` — 内部使用のために予約されています。 `PlatformEvent` — フローは、プラットフォームイベントメッセージを受信すると開始されます。この値は API バージョン 49.0 以降で使用できます。 `RecordAfterSave` — フローは、レコードの保存後に開始されます。この値は API バージョン 49.0 以降で使用できます。 `RecordBeforeSave` — レコードの作成または更新により自動起動フローをトリガし、その他の更新をレコードに加えてからレコードをデータベースに保存します。この値は API バージョン 48.0 以降で使用できます。 `RecordBeforeDelete` — データベースからレコードが削除される前、レコードを削除しようとすると自動起動フローがトリガされます。この値は、API バージョン 50.0 以降で使用できます。 `Scheduled` — スケジュールされた時刻にフローが開始されます。この値は API バージョン 47.0 以降で使用できます。 `ScheduledJourney` — ジャーニーはスケジュールされた時間および頻度でのみ開始されます。この値は API バージョン 49.0 以降で使用できます。 processType が `AutoLaunchedFlow` の場合にのみ使用できます。この項目は、API バージョン 47.0 以降で使用できます。

FlowSchedule

フローを実行するタイミングや頻度を指定します。API バージョン 47.0 以降で利用できます。

項目名	項目の型	説明
frequency	FlowStartFrequency (string 型の列挙)	フローを実行する頻度を指定します。有効な値は、次のとおりです。 `Once` `Daily` `Weekly` `OnActivate` — この値は API バージョン 49.0 以降で使用できます。
startDate	date	フローを実行する日付、またはフローの実行スケジュールの繰り返しを開始する日付。
startTime	time	組織のデフォルトのタイムゾーンに基づく、フローを実行する時刻。

FlowScheduledPath

スケジュール済みパスを定義します。FlowElement を拡張し、その項目のすべてを継承します。API バージョン 51.0 以降で利用できます。

項目名	項目の型	説明
connector	FlowConnector	このスケジュール済みパスの後に実行するノードを指定します。
label	string	スケジュール済みパスの表示ラベル。
maxBatchSize	int	1 つのバッチで実行されるスケジュール済みパスインタビューの最大数 (`1` ～ `200`)。デフォルトは、`200` です。
offsetNumber	int	スケジュール済みパスの実行時間をオフセットするための月数、日数、時間数、または分数。負の値を設定すると、実行時間が指定の時間だけ前にオフセットされます。正の値を設定すると、実行時間が指定の時間だけ後にオフセットされます。
offsetUnit	FlowScheduledPathOffsetUnit (string 型の列挙)	スケジュール済みパスの実行時間をオフセットするために使用する時間単位を指定します。可能な値は次のとおりです。 `Months` — この値は API バージョン 56.0 以降で使用できます。 `Days` `Hours` `Minutes`
pathType	FlowScheduledPathType (string 型の列挙)	スケジュール済みパスの種別。`null` はタイムトリガおよびレコードトリガパスで使用されます。デフォルト値は `null` です。 `AsyncAfterCommit` — スケジュール済みパスは保存後に非同期で実行されます。
recordField	string	スケジュール済みパスの実行時間を決定するために使用する項目。項目のオブジェクトは「FlowStart」で定義されています。
timeSource	FlowScheduledPathTimeSource (string 型の列挙)	スケジュール済みパスの実行時間を決定する際項目とイベントのどちらを使用するかを指定します。可能な値は次のとおりです。 `RecordField` `RecordTriggerEvent`

FlowStep

フローの作成時にプレースホルダとして機能するステップ。FlowNode を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
connectors	FlowConnector[]	ステップノードの後に実行するノードを指定します。

FlowSubflow

サブフロー要素は、実行時にコールする別のフローを参照します。サブフロー要素を含むフローは、マスタフローとして参照されます。FlowSubflow は、FlowNode を拡張し、その項目のすべてを継承します。API バージョン 25.0 以降で使用できます。

項目名	項目の型	説明
connector	FlowConnector	サブフローの後に実行するノードを指定します。
flowName	string	実行時にコールするフローを参照します。値はフローの API 参照名である必要があり、ハイフンやバージョン番号を付記することはできません。
inputAssignments	FlowSubflowInputAssignment[]	参照されるフローの開始時に設定される入力変数割り当ての配列。
outputAssignments	FlowSubflowOutputAssignment[]	参照されるフローの終了時に設定される出力変数割り当ての配列。
storeOutputAutomatically	boolean	変数を作成することなくサブフローの出力パラメータが自動的にフローで使用可能になるかどうかを示します。値が `true` の場合、フローでサブフローの API 参照名を指定することで、出力パラメータを参照できます。値が `false` の場合、サブフローからの出力値を保存する変数を手動で作成します。デフォルト値は、`false` です。この項目は、API バージョン 49.0 以降で使用できます。

FlowSubflowInputAssignment

参照されるフローの変数にマスタフローの要素または値を割り当てます。入力割り当ては、参照されるフローをサブフローがコールするときに行われます。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン 25.0 以降で使用できます。

項目名	項目の型	説明
name	string	必須。参照されるフロー内の変数の一意の名前。
value	FlowElementReferenceOrValue	変数に割り当てる値を定義します。

FlowSubflowOutputAssignment

参照されるフローの変数の値をマスタフローの変数に割り当てます。出力割り当ては、参照されるフローの実行が終了するときに行われます。FlowBaseElement を拡張し、その項目のすべてを継承します。API バージョン 25.0 以降で使用できます。

項目名	項目の型	説明
assignToReference	string	必須。マスタフローの変数の一意の名前。
name	string	必須。参照されるフロー内の変数の一意の名前。

FlowTextTemplate

フロー全体で使用できるテキストテンプレートを定義します。FlowElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
isViewedAsPlainText	boolean	`true` に設定されている場合、フローリソースの保存後に、テキストテンプレートで使用された [プレーンテキストとして表示] 設定がフローリソースに記憶されます。`false` に設定されている場合、フローリソースでは [リッチテキストとして表示] 設定が使用されます。デフォルト値は `false` です。
text	string	テンプレートの実際のテキスト。差し込み項目がサポートされます。

FlowVariable

フロー内で使用する更新可能な値を作成できるようにする変数。FlowVariable は FlowElement を拡張し、その項目のすべてを継承します。

項目名	項目の型	説明
apexClass	string	データ型が `Apex` の場合は、この変数の Apex クラス。API バージョン 46.0 以降で利用できます。
dataType	FlowDataType (string 型の列挙)	必須。有効な値は、次のとおりです。 `Apex` — この値は、API バージョン 46.0 以降で使用できます。 `Boolean` `Currency` `Date` `DateTime` — この値は、API バージョン 30.0 以降で使用できます。 `Number` `Multipicklist` — この値は、API バージョン 34.0 以降で使用できます。 `Picklist` — この値は、API バージョン 34.0 以降で使用できます。 `String` `sObject` — この値はレコード変数に対応します。
isCollection	boolean	変数が値のコレクションかどうかを示します。この項目は、API バージョン 30.0 以降で使用できます。API バージョン 32.0 以降では、コレクション変数を任意のデータ型にできます。デフォルト値は `False` です。
isInput	boolean	URL パラメータ、Visualforce コントローラ、またはサブフロー入力を使用して、フローの開始時に変数を設定できるかを示します。この項目は、API バージョン 25.0 以降で使用できます。デフォルト値は次のとおりです。 `False`: API バージョン 25.0 以降または Summer '12 以降の Flow Builder で作成された変数の場合。 `True`: API バージョン 24.0 または Spring '12 以前の Flow Builder で作成された変数の場合。既存の変数の入力または出力アクセスを無効にすると、フローをコールして変数にアクセスする��プリケーションやページの機能が停止する可能性があります。たとえば、URL パラメータ、プロセス、その他のフローから変数にアクセスできます。警告
isOutput	boolean	Visualforce コントローラやその他のフローから変数の値にアクセスできるかどうかを示します。この項目は、API バージョン 25.0 以降で使用できます。デフォルト値は次のとおりです。 `False`: API バージョン 25.0 以降または Summer '12 以降の Flow Builder で作成された変数の場合。 `True`: API バージョン 24.0 または Spring '12 以前の Flow Builder で作成された変数の場合。既存の変数の入力または出力アクセスを無効にすると、フローをコールして変数にアクセスするアプリケーションやページの機能が停止する可能性があります。たとえば、URL パラメータ、プロセス、その他のフローから変数にアクセスできます。警告
objectType	string	データ型が `sObject` の場合のこの変数のオブジェクト種別。
scale	int	小数点以下の桁数 (最大 17 桁) を制御します。この項目を空白にした場合、または 0 に設定した場合は、フローの実行時に整数のみが表示されます。 Flow Builder の [小数点の位置] 項目に対応します。
value	FlowElementReferenceOrValue	この変数のデフォルト値。変数のデータ型が `Picklist` または `Multipicklist` の場合、デフォルト値はサポートされません。

FlowVisibilityRule

表示ルールは、表示ルールの条件を満たしている場合にフロー画面コンポーネントを表示します。表示ルールの条件を満たしていない場合、フロー画面コンポーネントは非表示になります。API バージョン 47.0 以降で利用できます。

項目名	項目の型	説明
conditionLogic	string	条件のロジックを指定します。次の値を指定できます。 `and` — すべての条件が true に評価された場合にのみ `true` に評価されます。 `or` — いずれかの条件が true に評価された場合に `true` に評価されます。高度なロジック (`1 AND (2 OR 3)` など) — 最初の条件が true で、2 つ目または 3 つ目の条件が true の場合に `true` と評価されます。高度なロジックを使用する場合、文字列は 1,000 文字以内にする必要があります。
conditions	FlowCondition[]	フローがこのイベントを待機するために true である必要がある条件の配列。

FlowWait

1 つ以上の定義済みイベントが発生するまで待機します。FlowWait は、FlowNode を拡張し、その項目のすべてを継承します。FlowWait は、API バージョン 32.0 以降で使用できます。

項目名	項目の型	説明
defaultConnector	FlowConnector	待機要素の各イベントの条件が false の場合に実行するノードを指定します。
defaultConnectorLabel	string	デフォルトコネクタの表示ラベル。
faultConnector	FlowConnector	待機しようとしてエラーが発生した場合に実行するノードを指定します。いずれかの待機イベントに失敗すると、フローは障害コネクタを使用します。
timeZoneId	string	将来の使用のために予約されています。
waitEvents	FlowWaitEvent[]	待機要素が待機しているイベントの配列。各イベントの状況が `false` と評価されると、defaultConnector が使用されます。
waitType	string	将来の使用のために予約されています。

FlowWaitEvent

FlowWait 要素が待機しているイベント。FlowWaitEvent は、FlowElement を拡張し、その項目のすべてを継承します。FlowWaitEvent は、API バージョン 32.0 以降で使用できます。

項目名	項目の型	説明
conditionLogic	string	条件のロジックを指定します。次の値を指定できます。 `and` — すべての条件が true に評価された場合にのみ `true` に評価されます。 `or` — いずれかの条件が true に評価された場合に `true` に評価されます。高度なロジック (`1 AND (2 OR 3)` など) — 最初の条件が true で、2 つ目または 3 つ目の条件が true の場合に true と評価されます。高度なロジックを使用する場合、文字列は 1,000 文字以内にする必要があります。
conditions	FlowCondition[]	フローがこのイベントを待機するために `true` である必要がある条件の配列。
connector	FlowConnector	これが最初に発生したイベントである場合に実行するノードを指定します。
duration	int	将来の使用のために予約されています。
durationUnit	FlowScheduledPathOffsetUnit (string 型の列挙)	将来の使用のために予約されています。
eventType	string	必須。イベントの種別。この種別によって、このイベントの定義に使用できる入力パラメータが決まります。有効な値は、次のとおりです。 AlarmEvent — このイベントは、絶対日付/時間値に基づくアラームです。 DateRefAlarmEvent — このイベントは、レコードの日付/時間項目に基づくアラームです。
extendUntil	Time	将来の使用のために予約されています。
inputParameters	FlowWaitEventInputParameter[]	イベントの入力パラメータの配列。パラメータ値は、フローからの値を使用して設定されます。
label	string	必須。待機イベントの表示ラベル。
outputParameters	FlowWaitEventOutputParameter[]	イベントの出力パラメータの配列。パラメータ値は、フロー内でイベントから変数に割り当てられます。

FlowWaitEventInputParameter

FlowWaitEvent の入力パラメータ。パラメータの値は、フローからの値を使用して設定されます。FlowBaseElement を拡張し、その項目のすべてを継承します。FlowWaitEventInputParameter は API バージョン 32.0 以降で使用できます。

項目名	項目の型	説明
name	string	必須。入力パラメータの一意の名前。
value	FlowElementReferenceOrValue	入力パラメータの値を定義します。

FlowWaitEventOutputParameter

FlowWaitEvent の出力パラメータ。このパラメータの値がフローの変数に割り当てられ、フローの他の部分で参照可能になります。FlowBaseElement を拡張し、その項目のすべてを継承します。FlowWaitEventOutputParameter は、API バージョン 32.0 以降で使用できます。

項目名	項目の型	説明
assignToReference	string	必須。出力パラメータ値を割り当てる変数を指定します。
name	string	必須。出力パラメータの一意の名前。

フローファイルの API バージョン 44.0 以降へのアップグレード

API バージョン 43.0 以前では、フローオブジェクトの fullName 項目にフローのバージョン番号が含まれていました。API バージョン 44 以降では、この項目にバージョン番号が含まれなくなりました。メタデータ API または Salesforce CLI 経由で API バージョン 44.0 を使用してリリースする前に、次の点を確認してください。

flows ディレクトリに未使用のフローバージョンが含まれていない。
有効な各フローで status 項目が Active になっている。status 値のないフローは Draft の status 値でリリースまたは取得されます。
flowDefinitions ディレクトリが空である。

メタデータ API の場合のみ。

package.xml ファイルが API バージョン 44.0 に設定されている。
各フローの最新バージョンで、ファイル名にバージョン番号が含まれていない。たとえば、myflow-3.flow を myflow.flow に変更します。

Salesforce CLI の場合のみ。

sfdx-project.json ファイルが "sourceApiVersion": "44.0" に設定されている。
各フローの最新バージョンで、ファイル名にバージョン番号が含まれていない。たとえば、myflow-1.flow-meta.xml を myflow.flow-meta.xml に変更します。

このアップグレードの一環として、メタデータ API を介してリリースまたは取得するときにフロー定義は不要になりました。フロー定義を使用してリリースする場合、フロー定義内の有効なバージョン番号でフローの status 項目が上書きされます。たとえば、フロー定義内の有効なバージョン番号がバージョン 3 で、フローの最新バージョンはバージョン 4 が status 項目で Active になっているとします。フローをリリースすると、有効なバージョンはバージョン 3 になります。

このアップグレードを完了したら、フローファイル名の変更を気にすることなくバージョン管理システムを統合できます。リリースの問題を回避するため、ソースコードをスクラッチ組織にリリースするときに、既存のスクラッチ組織を再利用しないでください。

宣言的なメタデータの定義のサンプル

次に、フローの XML 定義のサンプルを示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
3    <actionCalls>
4        <name>Post_to_Contact_s_Feed</name>
5        <label>Post to Contact&apos;s Feed</label>
6        <locationX>269</locationX>
7        <locationY>396</locationY>
8        <actionName>chatterPost</actionName>
9        <actionType>chatterPost</actionType>
10        <connector>
11            <targetReference>Confirm</targetReference>
12        </connector>
13        <inputParameters>
14            <name>text</name>
15            <value>
16                <elementReference>chatterMessage</elementReference>
17            </value>
18        </inputParameters>
19        <inputParameters>
20            <name>subjectNameOrId</name>
21            <value>
22                <elementReference>contact.Id</elementReference>
23            </value>
24        </inputParameters>
25        <storeOutputAutomatically>true</storeOutputAutomatically>
26    </actionCalls>
27    <actionCalls>
28        <name>Get_Info</name>
29        <label>Get Info</label>
30        <locationX>372</locationX>
31        <locationY>354</locationY>
32        <actionName>GetFirstFromCollection</actionName>
33        <actionType>apex</actionType>
34        <dataTypeMappings>
35            <typeName>T__inputCollection</typeName>
36            <typeValue>Account</typeValue>
37        </dataTypeMappings>
38        <dataTypeMappings>
39            <typeName>U__outputMember</typeName>
40            <typeValue>Account</typeValue>
41        </dataTypeMappings>
42        <inputParameters>
43            <name>inputCollection</name>
44            <value>
45                <elementReference>accts</elementReference>
46            </value>
47        </inputParameters>
48        <storeOutputAutomatically>true</storeOutputAutomatically>
49    <assignments>
50        <name>Set_Contact_ID</name>
51        <label>Set Contact ID</label>
52        <locationX>568</locationX>
53        <locationY>396</locationY>
54        <assignmentItems>
55            <assignToReference>contact.Id</assignToReference>
56            <operator>Assign</operator>
57            <value>
58                <elementReference>existingId</elementReference>
59            </value>
60        </assignmentItems>
61        <connector>
62            <targetReference>Update_Contact</targetReference>
63        </connector>
64    </assignments>
65    <decisions>
66        <name>Update_If_Existing</name>
67        <label>Update If Existing?</label>
68        <locationX>260</locationX>
69        <locationY>52</locationY>
70        <defaultConnector>
71            <targetReference>Create_Contact</targetReference>
72        </defaultConnector>
73        <defaultConnectorLabel>No</defaultConnectorLabel>
74        <rules>
75            <name>Update_Yes</name>
76            <conditionLogic>and</conditionLogic>
77            <conditions>
78                <leftValueReference>updateExisting</leftValueReference>
79                <operator>EqualTo</operator>
80                <rightValue>
81                    <booleanValue>true</booleanValue>
82                </rightValue>
83            </conditions>
84            <connector>
85                <targetReference>Find_a_Match</targetReference>
86            </connector>
87            <label>Yes</label>
88        </rules>
89    </decisions>
90    <decisions>
91        <name>Update_or_Create</name>
92        <label>Update or Create?</label>
93        <locationX>447</locationX>
94        <locationY>239</locationY>
95        <defaultConnector>
96            <targetReference>Create_Contact</targetReference>
97        </defaultConnector>
98        <defaultConnectorLabel>Create New</defaultConnectorLabel>
99        <rules>
100            <name>Update_Existing</name>
101            <conditionLogic>and</conditionLogic>
102            <conditions>
103                <leftValueReference>existingId</leftValueReference>
104                <operator>IsNull</operator>
105                <rightValue>
106                    <booleanValue>false</booleanValue>
107                </rightValue>
108            </conditions>
109            <connector>
110                <targetReference>Set_Contact_ID</targetReference>
111            </connector>
112            <label>Update Existing</label>
113        </rules>
114    </decisions>
115    <dynamicChoiceSets>
116        <name>accounts</name>
117        <dataType>String</dataType>
118        <displayField>Name</displayField>
119        <object>Account</object>
120        <outputAssignments>
121            <assignToReference>contact.AccountId</assignToReference>
122            <field>Id</field>
123        </outputAssignments>
124        <valueField>Id</valueField>
125    </dynamicChoiceSets>
126    <formulas>
127        <name>created_or_updated</name>
128        <dataType>String</dataType>
129        <expression>IF({!Create_Contact}, &quot;created&quot;, &quot;updated&quot;)</expression>
130    </formulas>
131    <interviewLabel>New Contact {!$Flow.CurrentDateTime}</interviewLabel>
132    <isAdditionalPermissionRequiredToRun>true</isAdditionalPermissionRequiredToRun>
133    <isTemplate>true</isTemplate>
134    <label>New Contact</label>
135    <processMetadataValues>
136        <name>BuilderType</name>
137        <value>
138            <stringValue>LightningFlowBuilder</stringValue>
139        </value>
140    </processMetadataValues>
141    <processMetadataValues>
142        <name>OriginBuilderType</name>
143        <value>
144            <stringValue>LightningFlowBuilder</stringValue>
145        </value>
146    </processMetadataValues>
147    <processType>Flow</processType>
148    <recordCreates>
149        <name>Create_Contact</name>
150        <label>Create Contact</label>
151        <locationX>269</locationX>
152        <locationY>241</locationY>
153        <connector>
154            <targetReference>Post_to_Contact_s_Feed</targetReference>
155        </connector>
156        <inputReference>contact</inputReference>
157        <storeOutputAutomatically>true</storeOutputAutomatically>
158    </recordCreates>
159    <recordLookups>
160        <name>Find_a_Match</name>
161        <label>Find a Match</label>
162        <locationX>456</locationX>
163        <locationY>53</locationY>
164        <assignNullValuesIfNoRecordsFound>true</assignNullValuesIfNoRecordsFound>
165        <connector>
166            <targetReference>Update_or_Create</targetReference>
167        </connector>
168        <filters>
169            <field>FirstName</field>
170            <operator>EqualTo</operator>
171            <value>
172                <elementReference>contact.FirstName</elementReference>
173            </value>
174        </filters>
175        <filters>
176            <field>LastName</field>
177            <operator>EqualTo</operator>
178            <value>
179                <elementReference>contact.LastName</elementReference>
180            </value>
181        </filters>
182        <object>Contact</object>
183        <outputAssignments>
184            <assignToReference>existingId</assignToReference>
185            <field>Id</field>
186        </outputAssignments>
187        <storeOutputAutomatically>false</storeOutputAutomatically>
188    </recordLookups>
189    <recordUpdates>
190        <name>Update_Contact</name>
191        <label>Update Contact</label>
192        <locationX>456</locationX>
193        <locationY>396</locationY>
194        <connector>
195            <targetReference>Post_to_Contact_s_Feed</targetReference>
196        </connector>
197        <inputReference>contact</inputReference>
198    </recordUpdates>
199    <screens>
200        <name>Confirm</name>
201        <label>Confirm</label>
202        <locationX>270</locationX>
203        <locationY>519</locationY>
204        <allowBack>false</allowBack>
205        <allowFinish>true</allowFinish>
206        <allowPause>true</allowPause>
207        <fields>
208            <name>confirmation_message</name>
209            <fieldText>Thanks! &lt;a href=&quot;/{!contact.Id}&quot;&gt;The contact&lt;/a&gt; was {!created_or_updated}.</fieldText>
210            <fieldType>DisplayText</fieldType>
211        </fields>
212        <showFooter>true</showFooter>
213        <showHeader>true</showHeader>
214    </screens>
215    <screens>
216        <name>Contact_Info</name>
217        <label>Contact Info</label>
218        <locationX>160</locationX>
219        <locationY>50</locationY>
220        <allowBack>true</allowBack>
221        <allowFinish>true</allowFinish>
222        <allowPause>true</allowPause>
223        <connector>
224            <targetReference>Update_If_Existing</targetReference>
225        </connector>
226        <fields>
227            <name>contactName</name>
228            <extensionName>flowruntime:name</extensionName>
229            <fieldType>ComponentInstance</fieldType>
230            <isRequired>true</isRequired>
231            <outputParameters>
232                <assignToReference>contact.FirstName</assignToReference>
233                <name>firstName</name>
234            </outputParameters>
235            <outputParameters>
236                <assignToReference>contact.LastName</assignToReference>
237                <name>lastName</name>
238            </outputParameters>
239        </fields>
240        <fields>
241            <name>Account</name>
242            <choiceReferences>accounts</choiceReferences>
243            <dataType>String</dataType>
244            <fieldText>Account</fieldText>
245            <fieldType>DropdownBox</fieldType>
246            <isRequired>true</isRequired>
247        </fields>
248        <fields>
249            <name>update_toggle</name>
250            <extensionName>flowruntime:toggle</extensionName>
251            <fieldType>ComponentInstance</fieldType>
252            <inputParameters>
253                <name>label</name>
254                <value>
255                    <stringValue>If this contact already exists, update the existing record.</stringValue>
256                </value>
257            </inputParameters>
258            <inputParameters>
259                <name>messageToggleActive</name>
260                <value>
261                    <stringValue>Update existing</stringValue>
262                </value>
263            </inputParameters>
264            <inputParameters>
265                <name>messageToggleInactive</name>
266                <value>
267                    <stringValue>Create other contact</stringValue>
268                </value>
269            </inputParameters>
270            <isRequired>true</isRequired>
271            <outputParameters>
272                <assignToReference>updateExisting</assignToReference>
273                <name>value</name>
274            </outputParameters>
275        </fields>
276        <showFooter>true</showFooter>
277        <showHeader>true</showHeader>
278    </screens>
279    <start>
280        <locationX>50</locationX>
281        <locationY>50</locationY>
282        <connector>
283            <targetReference>Contact_Info</targetReference>
284        </connector>
285    </start>
286    <status>Draft</status>
287    <textTemplates>
288        <name>chatterMessage</name>
289        <text>The contact was {!created_or_updated}.</text>
290    </textTemplates>
291    <variables>
292        <name>contact</name>
293        <dataType>SObject</dataType>
294        <isCollection>false</isCollection>
295        <isInput>false</isInput>
296        <isOutput>false</isOutput>
297        <objectType>Contact</objectType>
298    </variables>
299    <variables>
300        <name>existingId</name>
301        <dataType>String</dataType>
302        <isCollection>false</isCollection>
303        <isInput>false</isInput>
304        <isOutput>false</isOutput>
305    </variables>
306    <variables>
307        <name>updateExisting</name>
308        <dataType>Boolean</dataType>
309        <isCollection>false</isCollection>
310        <isInput>false</isInput>
311        <isOutput>false</isOutput>
312    </variables>
313</Flow>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。