REST Objects Scheduler Provider

5.0.0

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

Configuration > Providers > Scheduler Provider

A Scheduler Provider object is used within the context of a REST Objects Providers (itself part of an REST Objects Configuration) to represent the details of how ServiceBroker is to be integrated with ServiceScheduling for the relevant tenant.

On this page:

Related pages:

Scheduler Provider Object Format

JSON Format

{
	"BCS": {
		"EnableRealTimeDispatch": true,
		"RealTimeDispRetryInterval": 10000
	},
	"DbUser": "",
	"Enabled": true,
	"ExtId": "",
	"Host": "",
	"GanttRouter": "",
	"Id": "",
	"Password": "",
	"User": "",
	"Version": "",
	"EmpExtObjectName": "",
	"Job": {
		"UseMoreNotesForJobInfo": true
	}
}

Scheduler Provider Object Properties

Property		Type	Required?	Description
`BCS`		`object`	Yes	See below.
	`EnableRealTimeDispatch`	`boolean`	Yes	When `true`, use the ServiceBroker REST Notification Changed Items to periodically poll for changes to Work Items in ServiceScheduling.
	`RealTimeDispRetryInterval`	`int`	Yes	When enabled via the `EnableRealTimeDispatch` setting, how often the ServiceBroker REST Notification Changed Items should be called to check for changes to Work Items, in milliseconds.
`DbUser`		string	Yes	The username to use when connecting to the ServiceScheduling SOAP API endpoint.
`Enabled`		`boolean`	Yes	Should integration with ServiceScheduling be used?
`ExtId`		`string`	Yes	The external ID
`Host`		`string`	Yes	The ServiceScheduling SOAP API endpoint to use for the ServiceScheduling integration, consisting of: The protocol i.e. `http://` or `https://` The hostname or IP address A colon The port number. For example: `https://example.com:46502`
`GanttRouter`		`string`	Yes	The ServiceScheduling ServiceGANTT interface to use for the ServiceScheduling integration, consisting of: The hostname or IP address A colon The port number. For example: `example.com:46502`
`Id`		`string`	Yes	A human-readable identifier to be used in ServiceBroker logs when producing information about this integration, to assist with global debugging of the potentially many different ServiceScheduling system integrations (as every tenant in ServiceBroker could be integrated with a different ServiceScheduling installation).
`Password`		`string`	Yes	The password to use when connecting to the ServiceScheduling SOAP API endpoint.
`User`		`string`	Yes	The designed user of the customer.
`Version`		`string`	Yes	The full version of ServiceScheduling that is being integrated with. For versions of ServiceScheduling prior to version 10.0.0, this is a number in 4 parts (e.g. 9.4.0.1); For versions of ServiceScheduling including and after version 10.0.0, this is a number in 3 parts.
`EmpExtObjectName`		`string`	No	The name of the object that contains additional information about employees in ServiceMobility, when integration with ServiceMobility is also enabled.
`Job`		`object`	Yes	The job being scheduled.
	`UseMoreNotesForJobInfo`	`boolean`	Yes	When `true`, parse ServiceScheduling's specific "extended" `moreNotes` XML format when possible, and transform the information into FlexView Objects.
	`EnableTechPhoto`	`boolean`
	`ConvertOrderTypes`	`boolean`
	`MapMoreNotesToFlexViews`	`boolean`