Nonprofit Cloud Developer Guide

Introduction to Nonprofit Cloud
Nonprofit Cloud Data Model
Fundraising
Program Management
Case Management
Outcome Management Standard Objects
Grantmaking
Volunteer Management Standard Objects
Volunteer Management Fields on Other Objects
Group Memberships and Households in Nonprofit Cloud
Record Rollup Definitions
NonProfit Cloud Associated Objects
StandardObjectNameShare
StandardObjectNameOwnerSharingRule
StandardObjectNameHistory
StandardObjectNameChangeEvent
StandardObjectNameFeed
PDF

StandardObjectNameOwnerSharingRule

StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.

The object name is variable and uses StandardObjectNameOwnerSharingRule syntax. For example, ChannelProgramOwnerSharingRule is a rule for sharing a channel program with users other than the channel program owner. We list the available associated owner sharing rule objects at the end of this topic. For specific version information, see the standard object documentation.

To enable access to this object, contact Salesforce customer support. But we recommend that you use Metadata API to programmatically update owner sharing rules instead because it triggers automatic sharing rule recalculation. The SharingRules Metadata API type is enabled for all orgs.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Special Access Rules

For specific special access rules, if any, see the documentation for the standard object. For example, for ChannelProgramOwnerSharingRule, see the special access rules for ChannelProgram.

Fields

Field Name Type Properties Description
AccessLevel picklist Create, Filter, Group, Restricted picklist, Sort, Update Determines the level of access users have to records. Values are Read (read only) or Edit (read/write).
Description textarea Create, Filter, Nillable, Sort, Update Description of the sharing rule. Maximum length is 1000 characters.
DeveloperName string Create, Filter, Group, Nillable, Sort, Update The unique name of the object in the API. This name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object's name in a managed package, and the changes are reflected in a subscriber's organization.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance can slow while Salesforce generates one for each record.
GroupId reference Create, Filter, Group, Sort ID of the source group. Records that are owned by users in the source group trigger the rule to give access.
Name string Create, Filter, Group, idLookup, Sort, Update Label of the sharing rule as it appears in the UI. Maximum length is 80 characters.
UserOrGroupId reference Create, Filter, Group, Sort ID of the user or group that you are granting access to.