ApptBundlePolicy

Policy that defines how the bundling of service appointments should be handled.

Introduced in API version 51.0.

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

    • 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.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: If IsTimeCalcByBundleDurationField is true, this field represents the name of the field used for entering the end time of the bundle.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: If IsTimeCalcByBundleDurationField is true, this field represents the name of the field used for entering the start time of the bundle.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: This field is reserved for future use.
  • Default value: false
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: If IsTimeCalcByBundleDurationField is true, this field represents the total time of the bundle as a preset constant value.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    The active recordset filter criteria used for the bundle members. Only service appointments that meet the criteria can be bundled.

    This is a relationship field.

  • Relationship name: FilterCriteria

  • Relationship type: relationship

  • Refers to: RecordsetFilterCriteria

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates if the policy is relevant for automatic bundling.
  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Description:

    Indicates if the policy is relevant for manual bundling.

    The default value is ‘false’.

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Description:

    Indicates if the bundle’s duration is validated. If true, the bundle’s start time is subtracted from the bundle’s end time. If the result is a negative value, it uses ConstantTimeValue as the bundle’s duration.

    The default value is ‘false’.

  • Type: int
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Description: The maximum number of bundle members that can be included in a bundle.
  • Default value: 50
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The maximum duration of a bundle.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the bundle policy.
  • Type: int
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The priority level that this bundle policy should be given when the bundle policies are analyzed using the automatic mode.

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.