メタデータ 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 ユーザインターフェースに表示されるブリーフケース名の表示ラベル。 |
| type | BriefcaseType[] | 将来の使用のために予約されています。 |
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 項目によって返されるレコードが決まります。 |
| relatedRules | BriefcaseRule[] | 現在のルールに関連付けられているルールのリスト。 |
| relationshipField | string | relatedRules で必要です。relatedRules 項目を別の relatedRules 項目またはネストされている BriefcaseDefinition メタデータ型の briefcaseRules 項目に関連付ける Salesforce オブジェクト項目を定義します。たとえば、取引先 ID オブジェクト項目を使用して取引先オブジェクトルールを取引先責任者オブジェクトに関連付けることができます。この例の場合、関連付けられているルールの relationshipField の値は AccountID です。 |
| relationshipType | BriefcaseRuleRelationshipType (string 型の列挙) |
relatedRules で必要です。relatedRules 項目と別の relatedRules 項目またはネストされている BriefcaseDefinition メタデータ型の briefcaseRules 項目間のリレーションを定義します。有効な値として次のものがあります。
|
| 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 などがあります。 OwnerId や CreatedById などのユーザ ID を受け入れる targetEntityField の値には、要求を行っているユーザの ID を渡すために「$User.Id」と入力します。 項目が空かどうかで targetEntityField を評価するには、filterValue を空白のままにして、filterOperator を e (equals) または n (not equals) に設定します。 |
| targetEntityField | string | 必須。絞り込みの条件となる項目の API 参照名。この項目は、BriefcaseRule の targetEntity から取得されます。複合項目はサポートされていません。確定的暗号化で暗号化された項目は、[次の文字列と一致する] および [次の文字列と一致しない] 演算子が含まれる検索条件で使用できます。 |
宣言的なメタデータの定義のサンプル
取引先レコードの BriefcaseDefinition コンポーネントの例を次に示します。
ブリーフケース定義の例を次に示します。ルール条件を含める場合、検索条件ロジックを含める必要があります。
1<?xml version="1.0" encoding="UTF-8"?>
2<BriefcaseDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3 <briefcaseRules>
4 <briefcaseRuleFilters>
5 <filterOperator>g</filterOperator>
6 <filterSeqNumber>1</filterSeqNumber>
7 <filterValue>50000.00</filterValue>
8 <targetEntityField>AnnualRevenue</targetEntityField>
9 </briefcaseRuleFilters>
10 <briefcaseRuleFilters>
11 <filterOperator>l</filterOperator>
12 <filterSeqNumber>2</filterSeqNumber>
13 <filterValue>50</filterValue>
14 <targetEntityField>NumberOfEmployees</targetEntityField>
15 </briefcaseRuleFilters>
16 <filterLogic>1 AND 2</filterLogic>
17 <isAscendingOrder>false</isAscendingOrder>
18 <orderBy>NumberOfEmployees</orderBy>
19 <queryScope>Everything</queryScope>
20 <recordLimit>1000</recordLimit>
21 <targetEntity>Account</targetEntity>
22 </briefcaseRules>
23 <description>Account Briefcase</description>
24 <isActive>true</isActive>
25 <masterLabel>Account With Standard Fields</masterLabel>
26</BriefcaseDefinition>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>AccountWithCustomFields</members>
5 <name>BriefcaseDefinition</name>
6 </types>
7 <version>49.0</version>
8</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。
使用方法
ブリーフケースオブジェクトは、ブリーフケースビルダーおよび Field Service が有効になっている組織で使用できます。