BriefcaseDefinition

Represents a briefcase definition. A briefcase makes selected records available for specific users and groups to view when they’re offline in the Salesforce Field Service mobile app for iOS and Android. This type extends the Metadata metadata type and inherits its fullName field.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

File Suffix and Directory Location

BriefcaseDefinition components have the suffix .briefcaseDefinition and are stored in the briefcaseDefinitions folder.

Version

BriefcaseDefinition components are available in API version 50.0 and later.

Fields

Field Name	Field Type	Description
briefcaseRules	BriefcaseRule[]	A list of rules that specify which records are included in the briefcase.
description	string	Description of the briefcase.
isActive	boolean	Required. Indicates whether the briefcase is active by default (`true`) or inactive (`false`). Activate a briefcase to make the selected records available to assignees.
masterLabel	string	Required. Label for the briefcase name that appears in the Salesforce user interface.

BriefcaseRule

Represents a rule that specifies records to be included in the BriefcaseDefinition.

Field Name	Field Type	Description
briefcaseRuleFilters	BriefcaseRuleFilter[]	A list of filters on a rule.
filterLogic	string	The filter logic for record selection, for example, `1 AND 2` where 1 and 2 correspond to filter 1 and filter 2. Filter logic operators include `AND` and `OR`.
isAscendingOrder	boolean	Indicates whether the records should be sorted in ascending order (`true`) or descending order (`false`).
orderBy	string	The field to order the records by, which determines how the records can be sorted. For example, Account Name or Created By.
queryScope	`FilterScope` (enumeration of type string)	A group of records to restrict the scope of this rule. Valid values include: `Everything` `AssignedToMe` The `AssignedToMe` scope is supported for the ServiceAppointment object only.
recordLimit	int	The maximum number of records for an object on the briefcase rule. The maximum is 2000 records that meet the criteria. If there are more records that match the criteria than the record limit allows, the orderBy field determines which records are returned.
relatedRules	BriefcaseRule[]	Reserved for future use.
relationshipField	string	Reserved for future use.

relationshipType	BriefcaseRuleRelationshipType[]	Reserved for future use.

targetEntity	string	Required. The API name of the standard or custom object that the briefcase rule evaluates.

BriefcaseRuleFilter

Specifies filter criteria for a BriefcaseRule.

Field Name	Field Type	Description
filterOperator	`BriefcaseFilterOperator` (enumeration of type string)	Required. The comparison operator for this rule filter. Capitalization matters with date filter operators. Be sure to specify date literals in uppercase. Some valid date literals include TODAY, YESTERDAY and TOMORROW. Valid values include: `d`—Ends with `e`��Equals `g`—Greater than `h`—Greater than or equal `l`—Less than `m`—Less than or equal `s`—Starts with
filterSeqNumber	int	Required. The filter number. When you apply multiple filters, the filters are numbered sequentially, 1, 2, 3, and so on.
filterValue	string	Required. The value that the field and criteria evaluate. For example, `true` or `false` for a boolean field whose criteria or filter operator is Equals. Be sure to specify date literals in uppercase. Some valid date literals include TODAY, YESTERDAY and TOMORROW.
targetEntityField	string	Required. The API name of the field to filter by. This field is from the targetEntity on BriefcaseRule. Compound fields aren't supported. Fields encrypted with deterministic encryption can be used in filters with equals and not equals operators.

Declarative Metadata Sample Definition

The following is an example of a BriefcaseDefinition component for account records.

The following is an example definition of a briefcase definition. If you include a rule filter, you must include a filter logic.

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>

The following is an example package.xml that references the previous definition.

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>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Usage

Briefcase objects are available in orgs that have Briefcase Builder and Field Service enabled.

Metadata API Developer Guide