REST Objects Mobility Provider

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

Configuration > Providers > Mobility Provider

A Mobility 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 ServiceMobility for the relevant tenant.

On this page:

Related pages:

Mobility Provider Object Format

JSON Format

{
	"Enabled": true,  
	"AllowClosedJobOverride": false,
	"UseLocalStoreToDispatch": false,
	"SS": {
		"LineItems": {
			"Enabled": false,
			"ProdAttrs": {
				"Enabled": true,
				"IsInvCtrl": true,
				"IsSerialized": false,
				"IsBatch": false,
				"ProdType": ""
			}
		},
		"Inventory": {
			"Enabled": false
		},
		"TransformIn": {
			"CanReject": false
		},
		"UseArrivalTime": false
	},
	"DisableMobileUpdate": false
}

Mobility Provider Object Properties

Property				Type	Required?	Description
`Enabled`				`boolean`	Yes	Should integration with ServiceMobility be used?
`AllowClosedJobOverride`				`boolean`	Yes	Reserved field not in use; setting does not affect ServiceBroker behavior.
`UseLocalStoreToDispatch`				`boolean`	Yes	An option that sets the job to be dispatched to a store local to the job location.
SS				`object`	No	Object is required when the tenant is also integrated with ServiceScheduling.
	`LineItems`			`object`	Yes	An object that defines how spare parts in ServiceScheduling should be mapped to line items in ServiceMobllity, if required.
		`Enabled`		`boolean`	Yes	When `true`, spare parts in ServiceScheduling Work Items will be mapped to line items in ServiceMobility.
		`ProdAttrs`		`object`	Yes	An object that defines if product attributes need to be considered when mapping ServiceScheduling spare parts into ServiceMobility line items.
			`Enabled`	`boolean`	Yes	When `true`, product attributes do need to be considered.
			`IsInvCtrl`	`boolean`	Yes	Set the ServiceMobility ItemObject's `ProdAttrs IsInvCtrl` value as either `true` or `false` when mapping ServiceScheduling spare parts into ServiceMobility line items.
			`IsSerialized`	`boolean`	Yes	Set the ServiceMobility ItemObject's `ProdAttrs IsSerialized` value as either `true` or `false` when mapping ServiceScheduling spare parts into ServiceMobility line items.
			`IsBatch`	`boolean`	Yes	Set the ServiceMobility ItemObject's `ProdAttrs IsBatch` value as either `true` or `false` when mapping ServiceScheduling spare parts into ServiceMobility line items.
			`ProdType`	`string`	Yes	Set the ServiceMobility ItemObject's `ProdAttrs ProdType` value to this value when mapping ServiceScheduling spare parts into ServiceMobility line items.
	`Inventory`			`object`	Yes	See below.
		`Enabled`		`boolean`	Yes	When `true`, synchronize the inventory information from ServiceMobility back to ServiceScheduling. That is: when ServiceMobility updates the provisioned inventory for a vehicle, send that information to ServiceScheduling; and when ServiceMobility marks a Work Item as completed, send the used parts information to ServiceScheduling.
	`TransformIn`			`object`	No	When present, the object defined (static per tenant) will be added to all Work Item objects when being sent to ServiceMobility. Note that it is also possible to configure the same static addition of an object to all Work Items at a global level. See the Configuration > Modules > ApptBook object.
		`CanReject`		`boolean`	No	Specifies if mobile worker can reject the work order. Sets the ServiceMobility WorkOrder Object's `CanReject` property value to either `true` or `false`
	`UseArrivalTime`			`boolean`	No	When `true`, sets the ServiceMobility WorkOrder Object's `PlannedStartTime` to `Earmarked Job's Dispatch Request` field `ETA` in ServiceScheduling. WorkOrder Object's `PlannedStartTime` will be mapped to `Earmark Job's Dispatch Request` object's field `ExpectedStart` in ServiceScheduling when the value is false. Default value is false.
`DisableMobileUpdate`				`boolean`	Yes	When the tenant is also integrated with ServiceScheduling, set to `false` to prevent Work Items being updated in ServiceScheduling when updates are made in ServiceMobility.

ServiceBroker 5

REST Objects Mobility Provider

Analytics

Mobility Provider Object Format

Mobility Provider Object Properties

Related content