メタデータ API 開発者ガイド
jFlowSettings
パッケージマニフェストでは、Settings の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は、「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
FlowSettings の値は、settings ディレクトリの Flow.settings ファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定��ァイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
FlowSettings コンポーネントは、API バージョン 47.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| canDebugFlowAsAnotherUser | boolean | フローを別のユーザとしてデバッグできるか (true)、否か (false) を示します。[設定] の [プロセスの自動化設定] ページの [システム管理者が他のユーザとしてフローをデバッグできるようにする] 項目に対応します。API バージョン 50.0 以降で利用できます。 |
| doesFormulaEnforceDataAccess | boolean | フローの数式リソースと数式項目で、レコードレベルセキュリティが適用されるか (true)、否か (false) を示します。 重要な更新のフロー数式でのデータアクセス権の適用に対応します。API バージョン 48.0 以降で利用できます。 |
| doesFormulaGenerateHtmlOutput | boolean | HTML を生成する BR()、IMAGE()、HYPERLINK() などのフロー数式関数にエンコードマーカー (__BR_ENCODED__) を含めるか (true)、否か (false) を示します。API バージョン 48.0 以降で利用できます。 |
| enableFlowBREncodedFixEnabled | boolean | フロー数式およびプロセス数式内の BR() 関数で、改行するか (true)、リテラル値として _BR_ENCODED_ に解決するか (false) を示します。 重要な更新「フローとプロセスでの BR() 関数の使用」に対応します。 |
| enableFlowCustomPropertyEditor | boolean | 組織が Flow Builder でアクションや画面項目用のカスタムプロパティエディタを有効にしているか (true)、否か (false) を示します。 この項目は、API バージョン 48.0 から 50.0 で使用できます。この項目は API バージョン 50.0 以降では廃止されました。Flow Builder を使用しているすべての組織では、アクションや画面項目用のカスタムプロパティエディタがサポートされます。 |
| enableFlowDeployAsActiveEnabled | boolean | 変更セットまたはメタデータ API を介してプロセスおよびフローを有効としてリリースできるかどうかを示します。値が false の場合、すべてのプロセスとフローが無効としてリリースされます。値が true の場合、有効なプロセスまたはフローを本番組織にリリースすると、Apex テストが実行されます。Apex テストで起動された有効なプロセスおよび自動起動フローが、組織の必要なパーセンテージに満たない場合、リリースはロールバックされます。 本番組織のデフォルト値は false、本番以外の組織 (スクラッチ組織、Sandbox 組織、開発者組織など) のデフォルト値は true です。 [設定] の [プロセスの自動化設定] ページの [プロセスとフローを有効としてリリース] 項目に対応します。この項目は本番組織のユーザインターフェースにのみ表示されます。 |
| enableFlowFieldFilterEnabled | boolean | レコードの作成要素とレコードの更新要素で更新する項目に対して実行ユーザが編集アクセス権を持たない場合、フローでそれらの要素を正常に実行できるかどうかを示します。デフォルト (false) では、レコードの作成要素またはレコードの更新要素は失敗し、障害パスが実行されます (ある場合)。値が true の場合、この要素は、実行ユーザが編集できる項目のみを設定します。更新されない項目があっても通知は送信されません。 [設定] の [プロセスの自動化設定] ページの [フロー要求のアクセスできない項目を絞り込む] 項目に対応します。 |
| enableFlowFormulasFixEnabled | boolean | 計算に null のレコード変数または null の参照関係項目が含まれているときに、プロセスおよびフロー数式で null 値を返すかどうかを示します。値が true の場合、この数式は実行時に null 値を返します。値が false の場合、この数式は実行時に未処理の例外を返します。 重要な更新「プロセスおよびフロー数式での null のレコード変数または参照関係項目の null 値の確認」に対応します。 |
| enableFlowInterviewSharingEnabled | boolean | ユーザが編集アクセス権のある一時停止中のフローインタビューを再開できるかどうかを示します。デフォルト (true) では、ユーザは共有されているインタビューを直接またはロール階層を介して再開できます。値が false の場合、インタビュー所有者か、インタビューへの参照アクセス権のあるフロー管理者のみが一時停止中の各インタビューを再開できます。 [設定] の [プロセスの自動化設定] ページの [共有されているフローインタビューの再開をユーザに許可] 項目に対応します。 |
| enableFlowNullPreviousValueFix | boolean | 各プロセスが常にプロセスの開始元のレコード項目値を使用して条件を評価するかどうかを示します。値が true の場合、[レコードを更新] アクションと複数の条件ノードを持つ各プロセスは、常にレコードの元の項目値を使用して条件を評価します。値が false の場合、プロセスは、プロセスの開始時に null であったレコード項目の更新された値を評価します。 重要な更新「プロセスビルダーで元のレコード値に基づく条件を評価」に対応します。 |
| enableFlowPauseEnabled | boolean | フローインタビューをユーザが一時停止できるように画面に [一時停止] ボタンを表示できるかどうかを示します。デフォルトでは、値は false です。 [設定] の [プロセスの自動化設定] ページの [フローの一時停止をユーザに許可] 項目に対応します。 |
| enableFlowUseApexExceptionEmail | boolean | プロセスおよびフローのエラーメールの送信先を示します。
デフォルトでは、値は false です。[設定] の [プロセスの自動化設定] ページの [プロセスまたはフローのエラーメールの送信先] 項目に対応します。 |
| enableFlowViaRestUsesUserCtxt | boolean | REST API を介して実行されるフローが、実行ユーザのプロファイルおよび権限セットを使用して、フローのオブジェクト権限および項目レベルのアクセス権を決定するかどうかを示します。 [REST API を介してフローをユーザコンテキストで実行します] の重要な更新に対応します。API バージョン 54.0 以降で利用できます。 |
| enableInvocableFlowFixEnabled | boolean | API バージョン 50.0 以降では削除されています。 すべての自動起動フローインタビューが、プロセスから、または REST API の Invocable Actions リソースから呼び出された場合、実行されるか (true)、否か (false) を示します。値が false の場合、同一の入力パラメータを持つフローインタビューは実行されません。 「一括で呼び出されたときにすべての自動起動フローインタビューを実行」 (重要な更新) に対応します。 |
| enableLightningRuntimeEnabled | boolean | URL または [設定] から起動されたフローが Lightning ランタイム環境を使用するか (true)、Classic ランタイム環境を使用するか (false) を示します。デフォルトでは、値は true です。 [設定] の [プロセスの自動化設定] ページの [フローの Lightning ランタイムを有効化] 項目に対応します。 |
| isAccessToInvokedApexRequired | boolean | 実行ユーザのプロファイルまたは権限セットに、フローで呼び出される Apex クラスへのアクセス権が含まれる場合にのみ、フローで Apex クラスを呼び出すことができるかどうかを示します。値が false の場合、Apex クラスのセキュリティはフローに適用されません。 重要な更新「フローから呼び出された Apex クラスへのユーザアクセスを要求」に対応します。 |
| isApexPluginAccessModifierRespected | boolean | 従来の Apex アクションの公開アクセス修飾子がフローで考慮されるかどうかを示します。値が true の場合、次のように処理されます。
「フローでの従来の Apex アクションのアクセス修飾子の考慮」 (重要な更新) に対応します。API バージョン 48.0 以降で利用できます。 |
| isEnhancedFlowListViewVisible | boolean | Lightning Experience の拡張された [フロー] リストビューで Classic の [フロー] リストビューを置き換えるか (true)、否か (false) を示します。デフォルト値は true です。この項目が false に設定されている場合、Classic の [フロー] リストビューが拡張リストビューで置き換えられます。 |
| isFlowApexContextRetired | boolean | Apex クラスへの明示的なアクセスを強制するルールを無効にするか (true)、否か (false) を示します。ほとんどの Salesforce 組織では、デフォルト値が true です。 [Apex クラスへの明示的なアクセス権を適用するルールの無効化] のリリース更新に対応します。API バージョン 49.0 以降で利用できます。 |
| isFlowBlockAccessToSessionIDEnabled | boolean | API.SessionID で有効なセッション ID を返すか (false)、否か (true) を示します。デフォルト値は false です。値が true の場合、セッション ID 変数にアクセスしたフローは、有効なセッション ID の代わりにプレースホルダ文字列を受け取ります。 |
| isManageFlowRequiredForAutomationCharts | boolean | オートメーションホーム (ベータ) のすべてのグラフを表示するのに「フローの管理」権限が必要か (true)、否か (false) を示します。デフォルト値は false です。「設定・定義を参照する」権限を持っているすべてのユーザは、オートメーションホームのすべてのグラフを表示できます。この項目が true, に設定されている場合、「設定・定義を参照する」権限を持っているユーザは、[開始した自動化の総数 (プロセス種別ごと)] グラフのみを表示できます。すべてのグラフを表示するには、「フローの管理」権限が必要です。 |
パッケージマニフェストの例
前の定義を参照する package.xml の例を次に示します。
マニフェストファイル内のワイルドカードのサポート
package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) は、機能設定のメタデータ型には適用されません。ワイルドカードは、個々の設定ではなくすべての設定を取得するときにのみ適用されます。詳細は、「設定」を参照してください。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。