Learn about recommended orchestration techniques for several common use cases.
| Table of Contents |
|---|
...
...
Use Case #1: system-of-record Integration
...
...
In This Article
| Table of Contents |
|---|
Glossary
There are a number of key services and objects relevant the use cases described in this document.
Key Term | Description | ||
|---|---|---|---|
GraphQL API | Method of retrieving a customer’s data via a single endpoint. For more information, please see “Introduction to the Scope GraphQL API”. | ||
DeepLinks | Method of launching the Scope Worklink app via a structure URL. For more information, please see “Using Deeplinks”. | ||
Webhooks | Method of notifying a customer’s internal systems about key events that take place in the Scope platform. For more information, please see “Using Webhooks”. | ||
Scenarios | Sets of work instructions pertaining to a specific physical device, to completed by a user while using the Scope Worklink app. For more information, please “Scenario” in the reference docs. | ||
Scenario Sessions | Recordings of Scenarios performed and completed by a user while using the Scope Worklink app. For more information, please “ScenarioSession” in the reference docs. | ||
Scenario Catalogs | Method of mapping a customer’s internal system objects (like assets or training modules) to Scenario Sessions. For more information, please “ScenarioCatalog” in the reference docs. | ||
SSO Integration | Method of syncing Scope users with a customer’s directory.
|
...
The user visits the Deeplink preconfigured in the system-of-record.
The WorkLink app launches and loads the Scenario Catalog identified by the Deeplink
asset_idquery param.The user selects a Scenario and begins a Scenario Session (causing all query parameters passed by the Deeplink to be stored as a JSON hash in the
externalDataattribute, including and especially thework_order_id).The customer’s custom application receives Webhook event notifications pertaining to the creation (and later update) of the Scenario Session.
The customer’s custom application queries the Scope GraphQL API and retrieves the data identified by the Webhook
resource_idandresource_type(see Sample Queries).The customer’s custom application inspects the data retrieved decides whether to act based on the value of
ScenarioSession.externalData.work_order_idThe customer’s custom application then associates the retrieved Scenario Session data with the work order in the customer’s system-of-record (using the system-of-record APIs).
...