WorkCapacityUsage | Object Reference for Salesforce and Lightning Platform

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update()

Special Access Rules

Field Service Lightning must be enabled.

For the Summer ’19 release, work capacity limits serve only as a suggestion, not a rule. Dispatchers can refer to the limits for guidance on how to structure the schedule. However, Field Service Lightning’s scheduling and optimization features don’t enforce the limits you create. Work capacity usage records also don’t update to reflect scheduled work, and there’s no way to review the appointments that count against each limit.

Important

Fields

Field Name	Details
DoesSyncHoursPerTimePeriod	Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the work capacity usage record’s Hours Per Time Period field auto-updates to match the work capacity limit’s Hours Per Time Period. If a user manually updates the Hours Per Time Period field on the usage record, this field is automatically deselected, and reselecting it doesn’t trigger a sync.
EndDate	Type date Properties Filter, Group, Sort Description The end date of the appointment or appointments related to the work capacity usage.
EstimatedUsageInHours	Type double Properties Filter, Nillable, Sort Description The EstimatedUsageInMinutes divided by 60.
EstimatedUsageInMinutes	Type double Properties Filter, Nillable, Sort Description The sum of the EstimatedUsageInMinutes values from all related service appointment capacity usage records.
HoursPerTimePeriod	Type double Properties Filter, Sort, Update Description The Hours Per Time Period listed on the work capacity limit. It specifies the number of hours of work that can be completed per day, week, or month. Unless DoesSyncHoursPerTimePeriod is deselected, this field reflects the changes made to the work capacity limit’s Hours Per Time Period.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the record was last modified. Its label in the user interface is Last Modified Date.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the record was last viewed by the current user.
MinutesPerTimePeriod	Type double Properties Filter, Nillable, Sort Description The HoursPerTimePeriod multiplied by 60.
RemainingCapacity	Type double Properties Filter, Nillable, Sort Description The number of hours left before the related work capacity limit is reached. For the Summer ’19 release, this field does not update to reflect scheduled hours. Important
ServiceTerritoryId	Type reference Properties Filter, Group, Nillable, Sort Description The service territory that the usage applies to. This value is inherited from the related work capacity limit.
StartDate	Type date Properties Filter, Group, Sort Description The start date of the appointment or appointments related to the work capacity usage.
TimePeriod	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The time period used to enforce a capacity limit. This value is inherited from the related work capacity limit record. Possible values are: `Day` `Month` `Week`
WorkCapacityLimitId	Type reference Properties Filter, Group, Sort Description The work capacity limit that the work counts against.
WorkCapacityUsageNumber	Type string Properties Autonumber, Defaulted on create, Filter, Sort Description Autogenerated number identifying the work capacity usage record. It uses the format WCU-####.
WorkTypeGroupId	Type reference Properties Filter, Group, Nillable, Sort Description The work type group that the work falls into.

Usage

One or more related work capacity usage records are generated when a work capacity limit is created—one usage record per time period. For example, if a work capacity limit’s time period is set to Week and the limit spans three weeks, the limit has three related work capacity usage records.