ForecastShare

Represents the sharing of a customizable forecast at a given role and territory.
Note

Note

This information applies to Customizable Forecasting and not Collaborative Forecasts.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

Customer Portal users can’t access this object.

Fields

The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields.

Field Details
AccessLevel
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
A value (Read, Edit, or All) that represents the type of sharing being allowed.
CanSubmit
Type
boolean
Properties
Filter, Group, Sort
Description
Indicates whether the user or group can submit forecasts (True) or not (False).
RowCause
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Reason that this sharing entry exists. You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings.
Valid values include:
  • Manual—The User or Group has access because a User has manually shared the forecast with them.
  • Owner—The User is the owner of the forecast.
UserOrGroupId
Type
reference
Properties
Filter, Group, Sort
Description
The ID representing the User or Group being granted access.
UserRoleId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the UserRole associated with this object.

Usage

This object allows you to determine which users and groups can view or submit forecasts owned by other users.