--- schema_version: "1" id: 8a804a6f5b43aa60ab0874bbe1e43e6c29c9c4184f50ed1eab470ab2b19828cb title: "Flow Screen Component: Select Service Appointment Time" collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/platform/264-0-0/ls_flowscreencmp_select_srvc_appt_time.md canonical_url: https://help.salesforce.com/s/articleView?id=platform.ls_flowscreencmp_select_srvc_appt_time.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: 3bb6dd22b80957eb41bb2a62fd69015e214ce512f166c86ed09135e958177059 description: Enables users to select a service appointment time. products: - Scheduler - Salesforce Platform release: "264" --- # Flow Screen Component: Select Service Appointment Time Enables users to select a service appointment time. ### Required Editions
Available in: Lightning Experience.
Available in: Enterprise and Unlimited Editions
![Image of the screen that enables users to select a service appointment time.](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-platform-scheduler-264-0-0-production-enus/0530be2f-891f-4263-a0d7-96ddca56a717/scheduler/images/ls_flowscreencomponents_select_service_appointment_time.png)
Attribute Description Additional Information
API Name Use underscores and alphanumeric characters without spaces. Begin the name with a letter, don’t end the name with an underscore, and don’t use two consecutive underscores.
  • Type: Input
  • Data type: String
  • Used in: All outbound and inbound flows
Active

Indicates whether the appointment invitation is active.

This attribute can also be modified after the invitation URL is created.
  • Type: Input
  • Data type: Boolean
  • Used in: Generate Appointment Invitation and Book Appointment from Invitation flows
Anonymous Booking Selected

Indicates whether a user selected the Anonymous Booking option.

If the value is set to true, available time slots for service resources in the specified service territory are shown. When a user selects a time slot, one of the service resources available in the selected time slot is allocated randomly.

If the value is set to false, only time slots for the specified service resources and the specified service territory are shown.

Note
Note Anonymous booking isn’t supported in flows that modify appointments.
  • Type: Input
  • Data type: Boolean
  • Used in: All outbound, inbound, and guest flows
Appointment Invitation Details JSON string with field-value pairs that map to the flow user's input values for an invitation. This string is passed to an invocable action to create an appointment invitation.
  • Type: Output
  • Data type: String
  • Used in: Generate Appointment Invitation and Book Appointment from Invitation flows
Appointment Invitation ID Appointment invitation ID that's used to create an appointment booking.
  • Type: Input
  • Data type: String
  • Used in: Generate Appointment Invitation and Book Appointment from Invitation flows
Appointment Invitee Details JSON string with field-value pairs that map to the flow user's input values for an invitee. This string is passed to an invocable action to create an appointment invitee.
  • Type: Output
  • Data type: String
  • Used in: Generate Appointment Invitation and Book Appointment from Invitation flows
Change primary assigned resource

This attribute is used only if Multi-Resource Scheduling is enabled.

Indicates whether a user clicked the change button.

In predefined flows, when a user clicks the Change button, the value is set to true and the Triage screen is shown.

If a value isn't set, false—the default value—is used.

Example: {!$GlobalConstant.False}
  • Type: Input and Output
  • Data type: Boolean
  • Used in: All inbound and outbound flows
Correlation Id

The unique ID of the appointment scheduling data. Correlation ID is one of the parameters of the ServiceAppointmentRequestInfo class that’s passed to the ServiceResourceScheduleHandler Apex interface.

For example, use Correlation Id to identify the system that is calling the ServiceResourceScheduleHandler interface implementation. If a value isn’t set, a random identifier is passed.
  • Type: Input
  • Data type: String
  • Used in: Inbound, outbound, and guest flows
Default Time Zone

The time zone according to which the service resource's available time slots are shown. If a value isn't set, the time slots are shown according to the user's locale time zone.

Here’s the list of accepted time zone values.

Example: America/Los_Angeles
  • Type: Input
  • Data type: String
  • Used in: All outbound, inbound, and guest flows
Disable Multi-Resource Scheduling

Indicates whether multi-resource scheduling is disabled.

For guest, inbound, and mobile flows, always set this value to true, and then set Inbound Scheduling to true.

Example: {!$GlobalConstant.True}
  • Type: Input
  • Data type: Boolean
  • Used in: All outbound, inbound, and guest flows
Engagement Channel Type The engagement channel type related to the service resources that the component shows the time slots for.
  • Type: Input and Output
  • Data type: String
  • Used in: All outbound, inbound, and guest flows
Filter By Resource IDs

This attribute is used only for anonymous booking.

A comma-separated list of resource IDs that are used to filter the time slots. If a value is set, the component shows time slots for only these resources.

Example: 0Hnxx0000004DdpCAE, 0Hnxx0000004DscCAE
  • Type: Input
  • Data type: String
  • Used in: All outbound, inbound, and guest flows
Inbound Scheduling

Indicates whether the component is used in inbound scheduling flow.

If the component is used for an outbound scheduling flow, set the value to false.

This attribute doesn’t change any elements on the screen. Only when this value is set to true, the Disable Multi-Resource Scheduling attribute value is considered.

Example: {!$GlobalConstant.True}
  • Type: Input
  • Data type: Boolean
  • Used in: All outbound, inbound, and guest flows
Invitation Flow Type

Type of flow in which the component is used. Valid values are:

  • InvitationGeneration - the Generate Appointment Invitation flow
  • InvitationBooking - the Book Appointment from Invitation flow.
  • Type: Input
  • Data type: String
  • Used in: Generate Appointment Invitation and Book Appointment from Invitation flows
Invitation URL Expiration Date

Date on which the invitation expires.

This attribute can also be modified after the invitation URL is created.
  • Type: Input
  • Data type: Date
  • Used in: Generate Appointment Invitation and Book Appointment from Invitation flows
Invitation URL Prefix Prefix of the appointment invitation URL. The prefix can either be of a community or of a website.
  • Type: Input
  • Data type: String
  • Used in: Generate Appointment Invitation and Book Appointment from Invitation flows
Is Hide Skip

Indicates whether the Skip Time Slot Selection link is hidden. If this value is set to true, the Skip Time Slot Selection link doesn’t appear.

For anonymous bookings, time slot selection can’t be skipped. So, when Anonymous Booking Selected is set to true, the Skip Time Slot Selection link isn’t shown even if this attribute is set to false.
  • Type: Input
  • Data type: Boolean
  • Used in: All outbound, inbound, and guest flows
Number of Resources to Show (Appointment Distribution) The maximum number of resources that users can choose from when appointment distribution is enabled.
  • Type: Input
  • Data type: Integer
  • Used in: All outbound, inbound, and guest flows
Parent Record ID

The ID of the parent record that the appointment is being scheduled for. Supported values are account ID, case ID, opportunity ID, and lead ID.

Example: 001xx000003GZQFAA4
  • Type: Input
  • Data type: String
  • Used in: All outbound and inbound flows
Resource Availability End Date

Date after which a service resource can’t be booked for appointments by using the invitation URL.

This attribute can also be modified after the invitation URL is created.
  • Type: Input
  • Data type: Date
  • Used in: Generate Appointment Invitation and Book Appointment from Invitation flows
Resource Availability Start Date

Date on which a service resource becomes available to book appointments by using the invitation URL.

This attribute can also be modified after the invitation URL is created.
  • Type: Input
  • Data type: Date
  • Used in: Generate Appointment Invitation and Book Appointment from Invitation flows
Scheduling Policy

The developer name of the scheduling policy that is used by the schedule optimizer.

Note
Note This field doesn’t support Salesforce ID.

Example: default_appointment_scheduling_policy
  • Type: Input
  • Data type: String
  • Used in: All outbound, inbound, and guest flows
Selected End Time

The end time of the timeslot.

If a value is set, a timeslot that ends at this time is selected by default.

When a user selects a timeslot on the screen, the value is updated based on the selected timeslot.

Format: MM/DD/YYYY, hh:mm AM/PM

Example: 6/8/2021, 7:30 PM
  • Type: Input and Output
  • Data type: DateTime
  • Used in: All outbound, inbound, and guest flows
Selected Start Time

The start time of the timeslot. If a value is set, a timeslot that starts at this time is selected by default.

When a user selects a time slot on the screen, the value is updated based on the selected timeslot.

Format: MM/DD/YYYY, hh:mm AM/PM

Example: 6/8/2021, 7:00 PM
  • Type: Input and Output
  • Data type: DateTime
  • Used in: All outbound, inbound, and guest flows
Selected Time Zone

The time zone selected by the user.

Here’s the list of accepted Timezone values.

Example: America/Los_Angeles
  • Type: Input and Output
  • Data type: String
  • Used in: All outbound, inbound, and guest flows
Service Appointment

This value is used only if the Select Service Appointment Time is used to modify an existing service appointment.

The ID of the service appointment.

The Select Service Appointment Time component fetches the service resources present in the service appointment and shows them if the Service Territory, Service Appointment, and Work Type values exist.
  • Type: Input
  • Data type: String
  • Used in: Outbound Modify Appointment and Inbound Modify Appointment flows
Service Resource

This attribute is used only if multi-resource scheduling is disabled.

The ID of the selected service resource for which time slots are shown.
  • Type: Input
  • Data type: String
  • Used in: Outbound Modify Appointment and Inbound Modify Appointment flows
Service Resources

This attribute is used only if multi-resource scheduling is enabled.

The details of the service resources selected in the Select Service Appointment Time component. This value is auto-populated when service resources are selected.

  • Type: Input and Output
  • Data type: String
  • Used in: All outbound flows
Service Territory

The service territory for which time slots appear.

Example: 0Hhxx0000004DUuCAM
  • Type: Input and Output
  • Data type: String
  • Used in: All outbound, inbound, and guest flows
Show Time Zone Pick List

Indicates whether the time zone pick list appears.

If a value isn't set, false—the default value—is used.

Example: {!$GlobalConstant.False}
  • Type: Input
  • Data type: Boolean
  • Used in: All outbound, inbound, and guest flows
Start Date

The date for which time slots appear.

If the value is empty or set to a date in the past, time slots for the current date appear. If the value is set to a future date, time slots for the specified date appear.

If the screen can show time slots for 7 days, then time slots appear for the start of the week to the end of the week for the specified date. For example, if the date passed is 2021-06-08T19:30:00Z, which is a Tuesday, time slots appear for 6 June 2021 (Sunday) to 12 June 2021 (Saturday).

If the screen can only show time slots for one day, time slots appear only for the specified date.

Format: YYYY-MM-DDThh:mm:ssZ

Example: 2021-06-08T19:30:00Z
  • Type: Input and Output
  • Data type: String
  • Used in: All outbound, inbound, and guest flows
Start date for the selected service resources’ skills that are required by the work type.

The start date for skills of the service resource.

Use this attribute to reduce the number of server calls. It's useful when a service resource isn’t available for a long time.

Time slots appear based on the maximum value of this attribute value, Start Date, and the current date.

Format: MM/DD/YYYY, hh:mm AM/PM

Example: 6/8/2021, 7:30 PM
  • Type: Input
  • Data type: DateTime
  • Used in: All outbound flows
Time Slot is Changed

Indicates whether the user selected a time slot.

If a value isn't set, false—the default value—is used.

Example: {!$GlobalConstant.False}
  • Type: Output
  • Data type: Boolean
  • Used in: All outbound, inbound, and guest flows
Time Slot Preload Multiplier

A multiplier that is used to determine the number of days for which time slots are fetched by each server call. Supported values are 1 and 2.

Example, if the screen can show time slots for 7 days and if this value is 2, time slots for 14 days (7x2) are fetched by each server call.

Tip
Tip If your users generally look at time slots beyond the default dates that appear, set the value to 2 to reduce the number of server calls.

Example: 1
  • Type: Input
  • Data type: Integer
  • Used in: All outbound, inbound, and guest flows
Validations

The error messages in the Select Service Appointment Time component.

This value is auto-populated. For example, the attribute stores the error message that’s generated when a user tries to navigate to the next screen without selecting a time slot.
  • Type: Input and Output
  • Data type: String
  • Used in: All outbound, inbound, and guest flows
Work Type

The work type for which you want to show time slots. Always set a value for this attribute if you want to use this component in flows that modify appointments.

When both Work Type and Work Type Group are specified, time slots for the specified work type appear.

To populate this field:

  1. Create a work type record with these values:
    • Resource type: Variable
    • Data type: Record
    • Object: WorkType
  2. Add a getRecord action, and then use the response to populate this value.
  • Type: Input and Output
  • Data type: WorkType
  • Used in: Outbound Modify Appointment and Inbound Modify Appointment flows
Work Type Group

The work type group for which you want to show time slots.

Example: 0VSxx0000004D0GGAU
  • Type: Input and Output
  • Data type: String
  • Used in: All outbound, inbound, and guest flows