ShiftTemplate

Represents a template for creating shifts. This object is available in API version 65.0 and later.

Supported Calls

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

Special Access Rules

Consumer Goods Cloud must be enabled.

Fields

Field	Details
BackgroundColor	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Sets a background color when shifts are displayed in the UI. Use a 3- or 6-digit hexadecimal format, for example #FF00FF. Available in API version 54.0 and later.
Description	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Additional information about the shift like number of breaks or activities.
Duration	Type double Properties Create, Filter, Sort, Update Description How long the shift lasts. The unit of measurement for this field is determined by ShiftTemplateDurationType.
GeoFnLcTypeAtShftEnd	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the allowed location type for geofence validation at the end of the shift. Possible values are: `First Customer` `Home` `Warehouse` This field is reserved for future use.
GeoFnLcTypeAtShftStart	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the allowed location type for geofence validation at the start of the shift. Possible values are: `First Customer` `Home` `Warehouse` This field is reserved for future use.
GeoFnNotificationType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the notification type for geofence validation at the start and end of the shift. Possible values are: `Error` `Warning` This field is reserved for future use.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift is active or inactive.
IsGeoFnRqrAtShftEnd	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether geofencing was enabled at the end of the shift. The default value is `false`. This field is reserved for future use.
IsGeoFnRqrAtShftStart	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether geofencing was enabled at the start of the shift. The default value is `false`. This field is reserved for future use.
IsGeoLcRqrAtShftEnd	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether user's geolocation was captured at the end of the shift. The default value is `false`. This field is reserved for future use.
IsGeoLcRqrAtShftStart	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether user's geolocation was captured at the start of the shift. The default value is `false`. This field is reserved for future use.
IsNonStandard	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift is nonstandard, such as overtime or on-call shifts. The default value is false. Available in API version 54.0 and later.
JobProfileId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Job Profile record. This field is optional. This is a relationship field. Relationship Name JobProfile Relationship Type Lookup Refers To JobProfile
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date when the shift template 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 shift template was last viewed.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The shift template record name.
NotificationTypeAtShftEnd	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the notification type for open tours at the end of the shift. Possible values are: `Error` `Warning` This field is reserved for future use.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the shift template. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
RecordsetFilterCriteriaId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the recordset filter criteria selected for the shift template. Available in API version 53.0 and later. This is a relationship field. Relationship Name RecordsetFilterCriteria Relationship Type Lookup Refers To RecordsetFilterCriteria
ShiftTemplateDurationType	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The unit of measurement for the shift template duration. Possible values are: `H`—Hours `M`—Minutes The default value is `H`.
ShouldAutoEnd	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift was automatically ended when the tour was completed. The default value is `false`. This field is reserved for future use.
ShouldAutoStart	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift was automatically started when the tour began. The default value is `false`. This field is reserved for future use.
StartTime	Type time Properties Create, Filter, Sort, Update Description The time of day when the shift starts.
TimeSlotType	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The type of time slot. Possible values are: `Normal` `Extended` You can use `Extended` to represent overtime shifts. Available in API version 55.0 and later.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ShiftTemplateOwnerSharingRule: Sharing rules are available for the object.
ShiftTemplateShare: Sharing is available for the object.
ShiftTemplateChangeEvent: Change Data Capture events are available for the object. Available in API version 54.0 and later.

Consumer Goods Cloud Developer Guide

ShiftTemplate

Supported Calls

Special Access Rules

Fields

Associated Objects