AppointmentAssignmentPolicy

Represents the information about a resource assignment rule.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

AppointmentAssignmentPolicy components have the suffix .policy and are stored in the appointmentAssignmentPolicies folder.

Version 

Introduced in API version 53.0.

Fields 

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. The label for the appointment assignment policy.

policyApplicableDuration 

  • Type: PolicyApplicableDuration (enumeration of type string)
  • Required: Yes
  • Description: Required. The frequency at which the utilization of service resources is calculated.
  • Possible values:
    • Monthly
    • ParameterBased
    • Weekly

policyType 

  • Type: AssignmentPolicyType (enumeration of type string)
  • Required: Yes
  • Description: Required. The type of appointment assignment policy. Valid value is:
  • Possible values:
    • loadBalancing

utilizationFactor 

  • Type: UtilizationFactor (enumeration of type string)
  • Required: Yes
  • Description: Required. Specifies the count type for the resource utilization.
  • Possible values:
    • NumberOfAppointments
    • TotalAppointmentDuration

Declarative Metadata Sample Definition 

The following is an example of an appointmentAssignmentPolicy component.

1<?xml version="1.0" encoding="UTF-8"?>
2<AppointmentAssignmentPolicy xmlns="http://soap.sforce.com/2006/04/metadata">
3   <masterLabel>loadBalancing Assignment Policy</masterLabel>
4   <policyType>loadBalancing</policyType>
5   <policyApplicableDuration>Weekly</policyApplicableDuration>
6   <utilizationFactor>TotalAppointmentDuration</utilizationFactor>
7</AppointmentAssignmentPolicy>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2 <Package xmlns="http://soap.sforce.com/2006/04/metadata">
3   <types>
4     <members>sample</members>
5     <name>AppointmentAssignmentPolicy</name>
6   </types>
7   <version>53.0</version>
8 </Package>

Wildcard Support in the Manifest File 

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.