Scoping Rules Developer Guide

About This Guide
Scoping Rules
Quick Start: Display Records by Branch Location
Considerations for Scoping Rules
Example Scenarios
Display a Branch Location’s Records by Default
Display a Department’s Records by Default
Display a Division’s Tasks by Default
Scope Records Using Multiple String or ID Values in Record Criteria
Tooling API Reference
Metadata API Reference
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Scope Records Using Multiple String or ID Values in Record Criteria

This scoping rule allows active users to scope the records they see to records whose Name__c field matches the rule’s record criteria value. The record criteria contains strings separated by a comma. ID values are also supported. Double-quotes specify that the value inside the quotes isn’t considered a delimiter.
Available in: Lightning Experience in Performance,Unlimited, and Developer editions.

This rule uses a custom object called Agent__c with a text field called Name__c.

Tooling API

1{
2    "FullName":"Agent records matching name field",
3    "Metadata": {
4        "active":true,
5        "description":"Show Records Matching Name__c field",
6        "enforcementType":"Scoping",
7        "masterLabel":"Records Matching Name__c field",
8        "recordFilter":"Name__c='Tom, Anita, “Torres, Jia”'",
9        "targetEntity":"Agent__c",
10        "userCriteria":"$User.IsActive=true", 
11        "version":1 
12    }
13}

Metadata API

1<?xml version="1.0" encoding="UTF-8"?>
2<RestrictionRule xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>true</active>
4    <description>Show Records Matching Name__c field</description>
5    <enforcementType>Scoping</enforcementType>
6    <masterLabel>Records Matching Name__c field</masterLabel>
7    <recordFilter>Name__c='Tom, Anita, “Torres, Jia”</recordFilter>
8    <targetEntity>Agent__c</targetEntity>
9    <userCriteria>$User.IsActive=true</userCriteria>
10    <version>1</version>
11</RestrictionRule>

This scoping rule allows active users to see records owned by two different managers. In this example, the rule’s record criteria contains IDs separated by a comma.

Tooling API

1{
2    "FullName":"Records Owned By Managers",
3    "Metadata": {
4        "active":true,
5        "description":"Displays records owned by two department managers",
6        "enforcementType":"Scoping",
7        "masterLabel":"RR for manager records",
8        "recordFilter":"Agent__c.Owner:User.ManagerId=001xx000003HNy7, 001xx000003HNut",
9        "targetEntity":"Agent__c",
10        "userCriteria":"$User.IsActive=true", 
11        "version":1 
12    }
13}

Metadata API

1<?xml version="1.0" encoding="UTF-8"?>
2<RestrictionRule xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>true</active>
4    <description>Displays records owned by two department managers</description>
5    <enforcementType>Scoping</enforcementType>
6    <masterLabel>RR for manager records</masterLabel>
7    <recordFilter>Agent__c.Owner:User.ManagerId=001xx000003HNy7, 001xx000003HNut</recordFilter>
8    <targetEntity>Agent__c</targetEntity>
9    <userCriteria>$User.IsActive=true</userCriteria>
10    <version>1</version>
11</RestrictionRule>