...
Key Term | Description |
---|---|
GraphQL API | Method of retrieving a customer’s data via a single endpoint. For more information, see “Introduction to the Scope GraphQL API”. |
DeepLinks | Method of launching the Scope Worklink WorkLink app via a structure URL. For more information, 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, see “Using Webhooks”. |
Scenarios | Sets of work instructions pertaining to a specific physical device, to be completed by a user while using the Scope Worklink WorkLink app. |
Scenario Sessions | Recordings of Scenarios performed and completed by a user while using the Scope Worklink WorkLink app. |
Scenario Catalogs | Mapping a customer’s internal system objects (like assets or training modules) to Scenario Sessions. |
...
Alternatively, you can use the built-in integration features of the Worklink WorkLink CMS. This eliminates the need for a custom middleware app and the Worklink WorkLink Integration scripts do that for you. See below for how that changes the data flow.
Lucidchart | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
The user visits a Deeplink dynamically generated by the system-of-record (see “configuration” above).
The WorkLink app launches and loads the Scenario or Catalog identified by the Deeplink’s
asset
query param.The user selects a Scenario and begins a Scenario Session (causing all additional query parameters passed by the Deeplink to be stored as key-value pairs in a JSON hash on the
ScenarioSession.externalData
attribute, including and notablywork_order_id
).The Worklink WorkLink integration receives Webhook event notifications from the Scope platform that there is new data that the application is interested in.
The Worklink WorkLink integration queries the Scope GraphQL API to retrieve the ScenarioSession data identified by the Webhook payload
resource_id
(see Scenario Session Data Sample Queries ).The Worklink WorkLink integration inspects the data retrieved for the value of
ScenarioSession.externalData.work_order_id
The Worklink WorkLink integration then associates the retrieved Scenario Session data with the work order in the customer’s system-of-record (using system-of-record APIs, or similar) using available APIs from the system-of-record.
...