Versions Compared

Version Old Version 10 New Version Current
Changes made by

Mickey Bushman

Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SBUD and version 5

Status
colourGreen
title5.0.0

Info

The ApptBook object is part of the overall ServiceBroker Configuration object, in the following location:

An ApptBook object is used within the context of a REST Objects Modules (itself part of an REST Objects Configuration) to represent how ServiceBroker should handle the booking of appointments through the configured Providers, for the relevant tenant.

Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel3

Related pages:

ApptBook Object Format

Include Page
_ApptBook Object Format
_ApptBook Object Format

ApptBook Object Properties


PropertyTypeRequired?Description
AllowRebookbooleanYes

When booking an appointment, should ServiceBroker send the AllowRebook flag to the Provider, where supported? (Both ServiceDispatch and ServiceScheduling support the AllowRebook flag.)

Setting this flag to true informs the Provider sub-system that, for the relevant tenant, if the booking is being made in that if a Job ID is provided as part of the booking request, and that ID is already present in the sub-system, then the existing booking should be updated with the new details - in essence, allowing an existing job to be re-booked to a new time.

When this flag is set to false, then re-booking will not be permitted for bookings made via ServiceBroker for the relevant tenant.

UseLocalStorebooleanYes

When true, Work Item objects that are created via ServiceBroker's REST Work Item Appointment Book are stored locally. (See the Configuration > Transactions object for details on configuring how long Work Items should be stored for.)

When a ServiceBroker tenant is configured with multiple sub-systems, this value must be changed from the default value of false, to true.

Storing Work Item objects locally will ensure that when a Work Item is created via ServiceBroker, all of the fields required for the configured sub-systems will always be available to be passed to the relevant sub-system, when required.

As an example, if UseLocalStore was not set to true for a tenant, and the primary sub-system for the tenant was ServiceScheduling, then an update to a Work Item in ServiceScheduling would mean that any fields that are not be stored in ServiceScheduling would not be present in ServiceBroker, and so updates made to the other sub-systems (e.g. ServiceMobility, ServiceDispatch) may lack important fields, and cause issues these non-primary sub-systems.

Note

Reminder: This setting applies to Work Item objects created via the REST Work Item Appointment Book.

For the same setting, but for Work Item objects create via the REST Work Item APIs, see the REST Objects WorkItem.

EnableWINbooleanYesWhen true, a notification message will be sent via the Broker Notification Service to any configured, active BNS endpoints, whenever a Work Item object is created via ServiceBroker's REST Work Item Appointment Book.

UseSrcSysResult

booleanYes

When true, calls to ServiceBroker's REST Work Item Appointment Book will have the REST Integration Standard Response Object modified, such that the Message property will no longer be a string, but the following object:

Code Block
{
	AckMsg: "MESSAGE",
	Id: "ID"
}

Where:

  • AckMsg value will be the response message from the provider in which the booking was made; and
  • Id will be the ID of the work item created in the provider in which the booking was made.
TransformInobjectNo

When present, the object defined (static per tenant) will be added to all Work Item objects that are created via ServiceBroker's REST Work Item Appointment Book.

Note that it is also possible to configure the same static addition of an object to Work Items at the ServiceMobility sub-system level. See the Configuration > Providers > Mobility Provider object.