メタデータ API 開発者ガイド
jBriefcaseDefinition
ブリーフケース定義を表します。ブリーフケースを使用すると、特定のユーザおよびグループが iOS および Android 用の Salesforce Field Service モバイルアプリケーションでオフラインになったときに、選択したレコードを表示できるようになります。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
BriefcaseDefinition コンポーネントのサフィックスは .briefcaseDefinition で、briefcaseDefinitions フォルダに保存されます。
バージョン
BriefcaseDefinition コンポーネントは、API バージョン 50.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| briefcaseRules | BriefcaseRule[] | ブリーフケースに含まれるレコードを指定するルールのリスト。 |
| description | string | ブリーフケースの説明。 |
| isActive | boolean | 必須。ブリーフケースがデフォルトで有効か (true)、無効か (false) を示します。選択したレコードを割り当て先が使用できるようにするには、ブリーフケースを有効化します。 |
| masterLabel | string | 必須。Salesforce ユーザインターフェースに表示されるブリーフケース名の表示ラベル。 |
BriefcaseRule
BriefcaseDefinition に含まれるレコードを指定するルールを表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| briefcaseRuleFilters | BriefcaseRuleFilter[] | ルールの検索条件のリスト。 |
| filterLogic | string | レコードを選択するための検索条件ロジック。たとえば、1 AND 2 の場合、1 および 2 は、検索条件 1 および検索条件 2 に対応します。検索条件ロジックの演算子には、AND および OR が含まれます。 |
| isAscendingOrder | boolean | レコードを昇順 (true) に並び替えるか、降順 (false) に並び替えるかを示します。 |
| orderBy | string | レコードを並び替える基準となる項目。これにより、レコードを並び替える方法が決定されます。たとえば、[取引先名] や [作成者] などです。 |
| queryScope | FilterScope (string 型の列挙) | このルールの範囲を制限するレコードのグループ。使用できる値は次のとおりです。
AssignedToMe 範囲は、ServiceAppointment オブジェクトでのみサポートされます。 |
| recordLimit | int | ブリーフケースルールのオブジェクトの最大レコード数。条件に一致する最大レコード数は 2000 件です。条件に一致するレコード数が制限を超える場合、orderBy 項目によって返されるレコードが決まります。 |
| targetEntity | string | 必須。ブリーフケースルールで評価する標準またはカスタムオブジェクトの API 参照名��� |
BriefcaseRuleFilter
BriefcaseRule の検索条件を指定します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| filterOperator | BriefcaseFilterOperator (string 型の列挙) | 必須。このルール条件の比較演算子。日付検索条件の演算子では、大文字と小文字が考慮されます。日付リテラルは、必ず大文字で指定します。有効な日付リテラルには、TODAY、YESTERDAY、TOMORROW などがあります。 使用できる値は次のとおりです。
|
| filterSeqNumber | int | 必須。検索条件番号。複数の検索条件を適用する場合、検索条件には、1、2、3... のように連続的に番号が付けられます。 |
| filterValue | string | 必須。項目と条件で評価する値。たとえば、条件または検索条件の演算子が Equals である Boolean 項目の true または false です。 日付リテラルは、必ず大文字で指定します。有効な日付リテラルには、TODAY、YESTERDAY、TOMORROW などがあります。 |
| targetEntityField | string | 必須。絞り込みの条件となる項目の API 参照名。この項目は、BriefcaseRule の targetEntity から取得されます。複合項目はサポートされていません。確定的暗号化で暗号化された項目は、[次の文字列と一致する] および [次の文字列と一致しない] 演算子が含まれる検索条件で使用できます。 |
宣言的なメタデータの定義のサンプル
取引先レコードの BriefcaseDefinition コンポーネントの例を次に示します。
ブリーフケース定義の例を次に示します。ルール条件を含める場合、検索条件ロジックを含める必要があります。
前の定義を参照する package.xml の例を次に示します。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。
使用方法
ブリーフケースオブジェクトは、ブリーフケースビルダーおよび Field Service が有効になっている組織で使用できます。