REST Glossary of Terms
- Andrew Hill (Deactivated)
- Jason Andrew
- Mickey Bushman
| ServiceBroker Term | Meaning | Common Alternate Terms |
|---|---|---|
| Common Data Model (CDM) | The Common Data Model is the term ServicePower use to refer to the integration through Broker where we centralize and rationalize our data fields. | |
| Dispatch | A Work Item has been Dispatched when it has been successfully sent to the Sub-system(s) which are responsible for informing the Worker about the Work Item. | Earmarked |
| Primary Sub-system | The Sub-system which is the "system of record" for the relevant information; generally, the Sub-system in which the information was initially created. | |
| Sub-system | A software application that has configured, via the relevant Tenant's ServiceBroker configuration, to be integrated with ServiceBroker. Therefore, a Sub-system is a software application which ServiceBroker will initiate a connection to, rather than a software application which calls the ServiceBroker APIs. (Compare with System, below.) However, note that a single software application could be both a Sub-system, and a System, if so configured. | |
| System | A software application that has been integrated with ServiceBroker via the pathway of that application calling (using) the ServiceBroker APIs. Therefore, a System is a software application which calls the APIs provided by ServiceBroker, rather than a software application which ServiceBroker initiates connections to. (Compare with Sub-system, above.) However, note that a single software application could be both a System, and a Sub-system, if so configured. | |
| System Access Token | A string (token) which not validates that a call to a ServiceBroker APIs is permitted, but which also Tenant the API call is associated with (and therefore which Tenant configuration is to be used when executing the API call). | JWT, Token |
| Tenant | ServiceBroker is a multi-tenant software application, allowing for multiple, independently operated and configured accounts to exist. These accounts are called Tenants in ServiceBroker. | Entity, Account |
| Worker | An individual person who can perform Work Items. | Employee, Staff Member, Technician |
| Work Center | A grouping of Workers (e.g. a team, a service group, etc.) | FRU |
| Work Item | A unit of activity that is to be / has been performed. | Break, Job, Standard Activity, Task |