Newer Version Available

This content describes an older version of this product. View Latest

ApptBundleAggrPolicy

Policy that defines how the property values of the bundle members are aggregated and assigned to the bundle. This object is available in API version 54.0 and later.

Supported Calls

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

Special Access Rules

  • Field Service must be enabled.
  • Bundling must be enabled in the Field Service Settings.
  • The Field Service Admin, Field Service Bundle for Dispatcher, and Field Service Integration permission sets must be enabled.

Fields

Field Details
AggregationAction
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The aggregation action to be performed.
Possible values are: All default and custom Service Appointment fields.
AggregationFieldType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The target field type in the bundle to which the aggregation is directed.
Possible values are:
  • Boolean
  • Date
  • Numeric
  • Picklist
  • Picklist-Multi
  • Skills
  • String
AggregationOrder
Type
int
Properties
Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The order the aggregation is triggered.
BundleFieldName
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Name of the target field in the bundle where the value is taken from the bundle member.
Possible values are: All default and custom Service Appointment fields.
BundleMemberAddiFieldName
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Name of an additional source field that is connected to the initial source field in the bundle member from which the value is taken.
Possible values are: All default and custom Service Appointment fields.
BundleMemberFieldName
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Name of the source field in the bundle member from which the value is taken.
Possible values are: All default and custom Service Appointment fields.
BundlePolicyId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the parent bundle policy.
This is a relationship field.
Relationship Name
BundlePolicy
Relationship Type
Lookup
Refers To
ApptBundlePolicy
ConstantValue
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The constant value that is used in the aggregation.
DateValue
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Represents how the date value will be determined.
Possible values are:
  • End of Day
  • Now
  • Null
  • Start of Day
DoesAllowDuplicateStrings
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if you want to allow the same string to appear more than once when using the 'Sum based on Bundle Members' action type.
DownscaleSortDirection
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Applies only if the Set Downscaled Duration action is set. The downscaling sorting direction of the bundle member service appointments, according to their duration.
Possible values are:
  • Ascending
  • Descending
FilterCriteriaId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The active recordset filter criteria used for aggregating the bundle members.
This is a relationship field.
Relationship Name
FilterCriteria
Relationship Type
Lookup
Refers To
RecordsetFilterCriteria
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
MaxBundleDuration
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The maximum bundle duration that can be accumulated from the bundle members (after downscaling).
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the appointment bundle aggregation policy.
ShouldUpdateOnCreationOnly
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates if you want to update the field in the bundle only when it is created.