REST Objects SysType v5

5.0.0

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

Configuration > Modules > SysType

A SysType object is used within the context of a REST Objects Modules (itself part of an REST Objects Configuration) to represent non-transactional master data sets that are required by ServiceBroker to successfully integrate with the configured Providers, for the relevant tenant. (The master data sets defined then have their values managed by the REST Tenant System Type v5, for the relevant tenant.)

To successfully integrate with other systems, certain non-transactional master data sets may be required - for example, ServiceBroker may need to understand what type of "jobs" the other system has defined.

The SysType object defines the types of master data sets that are required for integrations, for the relevant tenant - while the REST Tenant System Type v5 then define the values of those master data sets.

On this page:

Related pages:

SysType Object Format

JSON Format

{
	"Types": [
		"Mfg",
		"ProdLine",
		"JobType",
		"SAType",
		"SubStatus"
	],
	"UseDefaultTypesProvider": true,
	"Lang": "en_US",
    "IndustryCode": ""
}

SysType Object Properties

Property	Type	Required?	Description
`Types`	`array`	Yes	An array of strings defining the SysType master data sets for the relevant tenant. By default, ServiceBroker has the following `Types` defined for each tenant: `Mfg` - ServiceDispatch Manufacturer master data set; `ProductLine` - ServiceDispatch Product Line master data set; `JobType` - ServiceDispatchJob Type master data set; `SAType` - ServiceScheduling Standard Activity master data set; `SubStatus` - ServiceDispatch Sub-Status master data set. Although ServiceBroker defines these common 5 SysType master data set `Types` by default, ServiceBroker does not include any values for these master data sets by default. If required for system integrations, the values for these master data sets will either need to be defined via the REST Tenant System Type v5, or by using the `UseDefaultTypesProvider` value (below), where supported.
`UseDefaultTypesProvider`	`boolean`	Yes	When set to `true`, ServiceBroker will automatically obtain the master data set values from the integrated ServiceDispatch system for the relevant tenant, for the following supported `Types`: `Mfg`; `ProductLine`; `JobType`; and `SubStatus`. When set to `true` for a given tenant, it is important to not use the REST Tenant System Type v5 to update the master data set values for the above supported `Types`. Default value is `false`.
`Lang`	`string`	No	When the `UseDefaultTypesProvider` value has been set to `true`, ServiceBroker will filter the list of master data sets obtained from the integrated ServiceDispatch system for the relevant tenant, so that the master data set values set only match the language string provided. This filtering is only supported for the `Mfg` and `ProductLine Types`.
`IndustryCode`	`string`	No	When the `UseDefaultTypesProvider` value has been set to `true`, ServiceBroker will filter the list of master data sets obtained from the integrated ServiceDispatch system for the relevant tenant, so that the master data set values set only match the industry code string provided. This filtering is only supported for the `Mfg` and `ProductLine Types`.