この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

メタデータ API 開発者ガイド

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Flow

フローに関連付けられたメタデータを表します。フローを使用すると、ユーザが一連の画面を移動してデータベース内のレコードをクエリおよび更新するアプリケーションを作成できます。また、ユーザ入力に基づいてロジックを実行して分岐機能を提供し、動的なアプリケーションを構築できます。対応する UI ベースのフロー作成ツールについての詳細は、Salesforce ヘルプの「Flow Designer の概要」を参照してください。

ファイルベースのメタデータ API を使用してフローを操作する場合、次の点に留意してください。
  • 管理パッケー��からインストールされたフローへのアクセスには、メタデータ API を使用できません。
  • フローファイル名には空白を含めないでください。含めるとリリース時にエラーが発生します。先頭と末尾の空白は許可されますが、リリース時に削除されます。
  • メタデータ API を使用してフローをリリースするときには、有効なフローまたはかつて有効だったフローは上書きできません。
  • フローの新バージョンを作成するには、ファイルに新しいバージョン番号を指定してリリースします。

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

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

バージョン

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

Flow

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

項目名 データ型 説明
actionCalls FlowActionCall[] アクションへのコールを定義するノードの配列。この項目は API バージョン 31.0 以降で使用できます。
apexPluginCalls FlowApexPluginCall[] Apex プラグインへのコールを定義するノードの配列。
assignments FlowAssignment[] 割り当てノードの配列。
choices FlowChoice[] 静的選択オプションの配列。
constants FlowConstant[] 定数の配列。
decisions FlowDecision[] 決定ノードの配列。
description string フローの説明。
dynamicChoiceSets FlowDynamicChoiceSet[] データベースルックアップに基づく選択オプションのセットを構成する配列。
formulas FlowFormula[] 数式の配列。
fullName string 必須。Metadata コンポーネントから継承されます。メタデータ API 内のファイルの名前。
fullName は、ハイフンで区切られた 2 つの部分で構成されます。
  • アンダースコアと英数字のみで構成されるフローの一意の名前。組織全体で一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
  • フローのバージョン番号。

たとえば、「sampleFlow-3」は、一意の名前が sampleFlow であるフローのバージョン 3 であることを示します。
label string 必須。フローの表示ラベル。
loops FlowLoop[] コレクションを反復処理するためのノードの配列。この項目は API バージョン 30.0 以降で使用できます。
processMetadataValues FlowMetadataValue[] フローのメタデータ値。

この項目は API バージョン 31.0 以降で使用できます。
processType FlowProcessType (string 型の列挙) プロセス種別。有効な値は、次のとおりです。
  • AutoLaunchedFlow — 有効なバージョン (有効なバージョンがない場合は最新バージョン) がトリガ対応のフロー
  • Flow — 制限対象の要素またはリソースが 1 つ以上含まれるため、有効なバージョン (有効なバージョンがない場合は最新バージョン) がトリガ対応��はないフロー
  • Workflow — 将来の使用のために予約

バージョン間で processType を Flow から AutoLaunchedFlow (またはその逆) に変更できます。

この項目は API バージョン 31.0 以降で使用できます。
recordCreates FlowRecordCreate[] データベース内のレコードを作成するためのノードの配列。
recordDeletes FlowRecordDelete[] データベース内のレコードを削除するためのノードの配列。
recordLookups FlowRecordLookup[] データベース内のレコードを検索するためのノードの配列。
recordUpdates FlowRecordUpdate[] データベース内のレコードを更新するためのノードの配列。
screens FlowScreen[] 画面ノードの配列。
startElementReference string フローの開始点となるノードまたは要素を指定します。
steps FlowStep[] ステップノードの配列。
subflows FlowSubflow[] サブフローの配列です。この項目は API バージョン 25.0 以降で使用できます。
textTemplates FlowTextTemplate[] テキストテンプレートの配列。
variables FlowVariable[] 変数定義の配列。
waits FlowWait[] 待機ノードの配列。この項目は、API バージョン 32.0 以降で使用できます。

FlowActionCall

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

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

項目名 データ型 説明
actionName string 必須。アクションの名前。同じ actionType のアクション間で一意である必要があります。
actionType InvocableActionType (string 型の列挙) 必須。アクションの種別。有効な値は、次のとおりです。
  • chatterPost — Chatter に投稿します。
  • emailAlert — ワークフローメールアラートを参照してメールを送信します。
  • emailSimple — フローリソースを使用してメールを送信します。
  • flow — 今後の使用のために予約されています。
  • quickAction — QuickAction を呼び出します。
  • submit — レコードの承認を申請します。
connector FlowConnector このアクションコールの後に実行するノードを指定します。
faultConnector FlowConnector アクションコールの結果がエラーの場合に実行するノードを指定します。
inputParameters FlowActionCallInputParameter[] フローからアクションへの入力パラメータの配列。
outputParameters FlowActionCallOutputParameter[] アクションからフローへの出力パラメータの配列。

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 項目での変数参照に適用する操作。有効な値は、次のとおりです。
  • Assign – assignToReference 項目の変数に指定値を割り当てます。
  • Add – assignToReference 項目の変数に指定値を追加します。
  • Subtract – assignToReference 項目の変数から指定値を減算します。
value FlowElementReferenceOrValue assignToReference 項目の変数参照に演算子で適用する値を定義します。

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 — 左側にノードが必要です。
rightValue FlowElementReferenceOrValue 条件式の右側の要素の一意の名前または実際の値 (テキストや数値など)。

FlowConnector

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

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

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 のルールがない場合、デフォルトのコネクタが使用されます。Cloud Flow Designer では、ルールは「結果」と呼ばれます。

FlowDynamicChoiceSet

実行時に sObject からデータを検索して動的に選択肢のセットを生成します。FlowElement を拡張し、その項目のすべてを継承します。

フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

メモ

項目名 データ型 説明
dataType FlowDataType (string 型の列挙) 必須。有効な値は、次のとおりです。
  • Currency
  • Date
  • Number
  • String
  • Boolean
displayField string 必須。ユーザに選択肢表示ラベルとして表示する sObject の項目。

たとえば、取引先では、動的に生成される選択肢をデータベースから取得したレコードの取引先名として表示する場合、DisplayField "Name" を使用します。
filters FlowRecordFilter[] データベースから取得したレコードに適用する検索条件の配列。たとえば、指定日以降に作成された取引先のみを含めるように取引先を絞り込む場合などがあります。
limit int 生成される選択肢のセットに含まれる選択肢の最大数です。最大数とデフォルトの数は 200 です。

sortField と sortOrder も指定されている場合、レコードは、limit が適用される前に並び替えられます。

この項目は API バージョン 25.0 以降で使用できます。
object string 必須。データベースから項目情報を取得して、生成された選択肢のセットに使用する sObject。たとえば、データベースの取引先レコードの情報から選択肢を動的に生成するには、"Account" を使用します。
outputAssignments FlowOutputFieldAssignment[] ユーザが選択したレコードの項目をフローの他の場所で使用できる変数に割り当てる配列。たとえば、ユーザが動的に生成された選択オプションのリストから取引先名を選択した場合、outputAssignments はユーザが選択した取引先からの ID と AnnualRevenue を指定した変数に割り当てることができます。
sortField string 検索条件を満たすレコードを並び替えるために使用される項目です。この項目が指定されていない場合、返されるレコードは並び替えられません。

SOAP API に明記されているとおり、Sort API 項目プロパティを持つ項目でのみ、レコードを並び替えることができます。

この項目は API バージョン 25.0 以降で使用できます。
sortOrder SortOrder (string 型の列挙) レコードの並び替え順です。この項目が指定されていない場合、結果は並び替えられません。
有効な値は、次のとおりです。
  • Asc — 昇順
  • Desc — 降順

この項目は API バージョン 25.0 以降で使用できます。
valueField string 選択肢の保存値。ユーザに選択オプションとして表示される値 (DisplayField) とは異なる場合があります。たとえば、DisplayField が取引先の "Name" で、valueField が取引先の "Id" になる場合があります。

FlowElement

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

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

FlowBaseElement

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

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

FlowMetadataValue

フローの要素間で渡されるコンテキスト情報を定義します。フローのメタデータ値は、フローを生成または消費するアプリケーションで使用できます。FlowMetadataValue は、API バージョン 32.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 の数式。返される値は数値である必要があります。Salesforce ヘルプの「フロー数式の概要」を参照してください。
scale int 返される値のスケール。特に、小数点以下の桁数。

FlowInputFieldAssignment

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

フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

メモ

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

FlowInputValidationRule

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

項目名 データ型 説明
errorMessage string 必須。formulaExpression が false と評価されたときに表示するエラーメッセージ。
formulaExpression string 必須。ユーザ入力の検証に使用される boolean 数式。Salesforce ヘルプの「フロー数式の概要」を参照してください。

FlowLoop

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

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

FlowNode

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

項目名 データ型 説明
label string 必須。ノードの名前。この一意ではない表示ラベルは、FlowElement から継承される、ノードの一意の名前とは異なります。
locationX int 必須。ノードの水平位置 (左からのピクセル数)。
locationY int 必須。ノードの垂直位置 (上からのピクセル数)。

FlowOutputFieldAssignment

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

フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割��当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

メモ

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

FlowRecordCreate

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

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

フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

メモ

項目名 データ型 説明
assignRecordIdToReference string レコードの作成後に ID を保存する変数への参照。
connector FlowConnector レコードの作成後に実行するノードを指定します。
faultConnector FlowConnector レコードを作成しようとしてエラーになった場合に実行するノードを指定します。
inputAssignments FlowInputFieldAssignment[] 作成中のレコードの指定された項目に値を割り当てる配列。
object string 必須。この要素によって作成されるレコードの sObject
inputReference string 項目値が新しいレコードの項目への入力に使用される sObject 変数を指定します。

FlowRecordDelete

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

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

フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

メモ

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

FlowRecordFilter

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

フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

メモ

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

FlowRecordLookup

データベース内のレコードを検索し、その項目の値をフローで使用または保存します。FlowNode を拡張し、その項目のすべてを継承します。

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

フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

メモ

項目名 データ型 説明
assignNullValuesIfNoRecordFound boolean レコードが見つからない場合にすべての値を null に設定することを指定します。この項目は API バージョン 30.0 以降で使用できます。
connector FlowConnector レコードルックアップの完了後に実行するノードを指定します。
faultConnector FlowConnector レコードを検索しようとしてエラーになった場合に実行するノードを指定します。
filters FlowRecordFilter[] データベースからのレコードの選択に使用する条件を指定する配列。

検索条件で複数のレコードが返された場合、指定された sortField と sortOrder に基づいて並び替えられます。その後で、並び替えられたリストの最初のレコードが選択されます。

sortField または sortOrder が指定されていない場合、最初に返されたレコードが選択されます。ただし、レコードが返される順序は決まっていません。
limit int 返すレコードの最大数。受信するデータ量を制限します。この項目は API バージョン 30.0 以降で使用できます。
object string 必須。レコードの選択元となる sObject の名前。
outputAssignments FlowOutputFieldAssignment[] 選択されたレコードの項目を、フローの他の場所で使用できる変数に割り当てる配列。
outputReference string クエリされた項目の値が保存される sObject 変数を指定します。
queriedFields string[] 選択されたレコードから指定された sObject 変数に保存される項目を指定する配列。
sortField string 検索条件を満たすレコードを並び替えるために使用される項目です。この項目が指定されていない場合、返されるレコードは並び替えられません。

SOAP API に明記されているとおり、Sort API 項目プロパティを持つ項目でのみ、レコードを並び替えることができます。

この項目は API バージョン 25.0 以降で使用できます。
sortOrder SortOrder (string 型の列挙) レコードの並び替え順です。この項目が指定されていない場合、結果は並び替えられません。
有効な値は、次のとおりです。
  • Asc — 昇順
  • Desc — 降順

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

FlowRecordUpdate

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

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

フロー内で Geolocation 型の sObject カスタム項目を参照することはできません。たとえば、レコード検索条件内、入力または出力項目の割り当て内で、または動的選択肢の表示項目、値項目、並び替え項目として Geolocation 項目を使用することはできません。

メモ

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

FlowRule

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

項目名 データ型 説明
conditionLogic string "and" または "or" のいずれかの値にできます。"and" に設定すると、ルールの条件がすべて true と評価された場合にのみルールが true と評価されます。"or" に設定した場合、ルールの条件のいずれかが true と評価された場合にルールが true と評価されます。
conditions FlowCondition[] ルールの条件の配列。
connector FlowConnector 決定でこのルールが最初に true と評価されたルールである場合に実行するノードを指定します。
label string 必須。コネクタの表示ラベル。

FlowScreen

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

項目名 データ型 説明
allowBack boolean 実行時に [前へ] ボタンを画面に表示するか (true)、非表示にするか (false) を示します。true の場合、[前へ] ボタンは、ユーザがフローパスで前の画面にアクセスした場合にのみ表示されます。クレジットカードトランザクションなど、前の画面に再アクセスした場合に繰り返してはいけないアクションが起動されてしまう場合は、false に設定します。

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

デフォルトは true です。

allowBack と allowFinish のいずれかを false に設定できますが、両方を設定することはできません。
allowFinish boolean 実行時に [完了] ボタンを画面に表示するか (true)、非表示にするか (false) を示します。true の場合、[完了] ボタンは、画面要素がフローパスの最後である場合にのみ表示されます。ユーザが前の画面に戻ってフローを続行または完了させる必要がある場合は、これを false に設定します。たとえば、ユーザに前の画面に戻って修正するように指示する画面に [完了] ボタンは表示しません。

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

デフォルトは true です。

allowBack と allowFinish のいずれかを false に設定できますが、両方を設定することはできません。
connector FlowConnector 画面ノードの後に実行するノードを指定します。
fields FlowScreenField[] 画面に表示する項目の配列。
helpText string エンドユーザが [このフォームのヘルプ] リンクをクリックした場合に表示されるテキスト。

API バージョン 26.0 以降で差し込み項目をサポートします。

FlowScreenField

画面上の設定可能な項目。FlowElement を拡張し、その項目のすべてを継承します。

項目名 データ型 説明
choiceReferences string[] FlowChoices または FlowDynamicChoiceSets への参照の配列。作成される選択オプションは、この配列で指定した���序で表示されます。インデックス 0 の要素が最上位の選択オプションになります。次の型の画面項目でサポートされています。
  • RadioButtons
  • DropdownBox
  • MultiSelectCheckboxes
  • MultiSelectPicklist

複数選択チェックボックスおよび複数選択リスト項目は、API バージョン 26.0 以降で使用できます。
dataType FlowDataType (string 型の列挙) 必須。この画面項目のデータ型。InputField、RadioButtons、および DropdownBox 型の画面項目でのみサポートされます。有効な値は、次のとおりです。
  • Currency
  • Date
  • Number
  • String
  • Boolean

boolean の InputField は、実行時にチェックボックス項目として表示されます。チェックボックス入力項目は、API バージョン 26.0 以降で使用できます。

複数選択チェックボックスおよび複数選択リスト項目では、string データ型のみがサポートされます。複数選択項目は、API バージョン 26.0 以降で使用できます。
defaultSelectedChoiceReference string 画面項目のデフォルト値として使用される FlowChoice 要素の名前。次の型の画面項目でサポートされています。
  • RadioButtons
  • DropdownBox
  • MultiSelectCheckboxes
  • MultiSelectPicklist

DropDownBox データ型についてのみ、defaultSelectedChoiceReference が空か null の場合、choiceReferences のインデックス 0 での参照がデフォルト値として使用されます。

複数選択チェックボックスおよび複数選択リスト項目では、デフォルト値として FlowChoice 要素を 1 つのみ指定できます。複数選択項目は、API バージョン 26.0 以降で使用できます。
defaultValue FlowElementReferenceOrValue この画面項目がユーザに入力を要求したときにデフォルトで使用される値。InputField、LargeTextArea、および PasswordField でのみサポートされます。
fieldText string 画面に表示される項目の表示ラベル。差し込み項目がサポートされます。
fieldType FlowScreenFieldType (string 型の列挙) 必須。有効な値は、次のとおりです。
  • DisplayText
  • InputField
  • LargeTextArea
  • PasswordField
  • RadioButtons
  • DropdownBox
  • MultiSelectCheckboxes
  • MultiSelectPicklist

実行時、各複数選択項目には、その項目値がユーザが選択した選択肢の値をセミコロンで区切った結合値として保存されます。選択した選択肢の値内のセミコロンは、複数選択項目値に追加されるときに削除されます。

複数選択チェックボックスおよび複数選択リスト項目は、API バージョン 26.0 以降で使用できます。
helpText string 必須。エンドユーザが画面項目のヘルプアイコン (情報) をクリックした場合に表示されるテキスト。

API バージョン 26.0 以降で差し込み項目をサポートします。
isRequired boolean ユーザが選択肢を選択する必要があるか、または入力する必要があるかを示します。DisplayText または boolean の inputField ではサポートされません。
scale int データ型が number または currency の場合のこの画面項目のスケール。スケールは、小数点以下の桁数を設定します。
validationRule FlowInputValidationRule この画面項目が InputField、LargeTextArea、または PasswordField 型の場合、ユーザ入力の検証に使用されるルール。

FlowStep

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

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

FlowSubflow

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

項目名 データ型 説明
connector FlowConnector サブフローの後に実行するノードを指定します。
flowName string 実行時にコールするフローを参照します。値はフローの一意の名前である必要があり、ハイフンやバージョン番号を付記することはできません。参照されるフローは、Cloud Flow Designer で作成されたものである必要があります。
inputAssignments FlowSubflowInputAssignment[] 参照されるフローの開始時に設定される入力変数割り当ての配列。
outputAssignments FlowSubflowOutputAssignment[] 参照されるフローの終了時に設定される出力変数割り当ての配列。

FlowSubflowInputAssignment

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

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

FlowSubflowOutputAssignment

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

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

FlowTextTemplate

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

項目名 データ型 説明
text string テンプレートの実際のテキスト。差し込み項目がサポートされます。

FlowVariable

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

項目名 データ型 説明
dataType FlowDataType (string 型の列挙) 必須。有効な値は、次のとおりです。
  • Currency
  • Date
  • Number
  • String
  • Boolean
  • sObject
  • DateTime — このデータ型は、API バージョン 30.0 以降で使用できます。
isCollection boolean 変数が値のコレクションかどうかを示します。この項目は、API バージョン 30.0 以降で使用できます。API バージョン 32.0 以降では、コレクション変数を任意のデータ型にできます。

デフォルト値は False です。
isInput boolean URL パラメータ、Visualforce コントローラ、またはサブフロー入力を使用して、フローの開始時に変数を設定できるかを示します。この項目は API バージョン 25.0 以降で使用できます。
デフォルト値は次のとおりです。
  • False: API バージョン 25.0 以降または Cloud Flow Designer の Summer '12 以降で作成された変数の場合
  • True: API バージョン 24.0 または Cloud Flow Designer の Summer '12 より前のバージョンで作成された変数の場合

既存の変数の入力または出力アクセスを無効にすると、URL パラメータ、Visualforce コントローラ、およびサブフローによってフローをコールし、変数にアクセスするアプリケーションとページの機能に影響する可能性があります。

警告
isOutput boolean Visualforce コントローラやその他のフローから変数の値にアクセスできるかどうかを示します。この項目は API バージョン 25.0 以降で使用できます。
デフォルト値は次のとおりです。
  • False: API バージョン 25.0 以降または Cloud Flow Designer の Summer '12 以降で作成された変数の場合
  • True: API バージョン 24.0 または Cloud Flow Designer の Summer '12 より前のバージョンで作成された変数の場合

既存の変数の入力または出力アクセスを無効にすると、URL パラメータ、Visualforce コントローラ、およびサブフローによってフローをコールし、変数にアクセスするアプリケーションとページの機能に影響する可能性があります。

警告
objectType string データ型が sObject の場合のこの変数のオブジェクト種別。
scale int データ型が Number または Currency の場合のこの変数のスケール。
value FlowElementReferenceOrValue この変数のデフォルト値。

FlowWait

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

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

各イベントの状況が false と評価されると、defaultConnector が使用されます。

FlowWaitEvent

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

項目名 データ型 説明
conditionLogic string and と or のいずれかの値を使用できます。and に設定した場合は、条件がすべて true と評価された場合にのみイベントの条件が満たされます。or に設定した場合は、いずれかの条件が true と評価された場合にイベントの条件が満たされます。
conditions FlowCondition フローがこのイベントを待機するために true である必要がある条件の配列。
connector FlowConnector これが最初に発生したイベントである場合に実行するノードを指定します。
eventType string 必須。イベントの種別。この種別によって、このイベントの定義に使用できる入力パラメータが決まります。有効な値は、次のとおりです。
  • AlarmEvent — このイベントは、絶対日付/時間値のアラームベースのオフ設定です。
  • DateRefAlarmEvent — このイベントは、レコードの日付/時間項目のアラームベースのオフ設定です。
inputParameters FlowWaitEventInputParameter[] イベントの入力パラメータの配列。パラメータ値は、フローからの値を使用して設定されます。
label string 必須。待機イベントの表示ラベル。
outputParameters FlowWaitEventOutputParameter[] 将来の使用のために予約されています。

FlowWaitEventInputParameter

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

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

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

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