...
Key Term | Description |
|---|---|
GraphQL API | Method of retrieving a customer’s data via a single endpoint. For more information, see “Introduction to the Scope AR GraphQL API”. |
DeepLinks | Method of launching the Scope Worklink AR 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 AR 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 AR WorkLink app. |
Scenario Sessions | Recordings of Scenarios performed and completed by a user while using the Scope Worklink AR WorkLink app. |
Scenario Catalogs | Mapping a customer’s internal system objects (like assets or training modules) to Scenario Sessions. |
...
As an administrator, I want to associate Scope AR Scenario Session data with work orders in my system-of-record (e.g. Salesforce), in real-time, as my users interact with the Scope AR platform.
Solution
I will use a custom internal application, Deeplinks, Scenario Catalogs, Webhooks, and the Scope GraphL AR GraphQL API to retrieve Scenario Session data, as the data becomes available, and associate said data with work orders in my system-of-record.
...
For each physical device (aka the “Asset”) that work orders might pertain to in the system-of-record (.e.g. “Generator Model #1234”):
The administrator creates at least one Scenario for the Asset using the Scope AR Create 2 application.
The administrator creates a Scenario Catalog for the Asset using the Scope AR CMS web interface.
The administrator configures the system-of-record to present a dynamically generated link whenever system-of-record users view work orders (aka the “Deeplink”). The link passes both the asset identifier and work order identifier as parameters:
Code Block worklink://resource?action=fetch_catalog&asset=INSERT_ASSET_ID_HERE&work_order_id=INSERT_WORK_ORDER_ID_HERE
See Using Deeplinks for more details on this.
The administrator creates a custom internal application designed to receive Scope AR Webhooks.
A company administrator then creates a webhook that will trigger this application when the pertinent information in the Scope AR system is added or updated.
See Using WebHooks for more details on how to do this.
Scope AR Deeplinks are highly extensible and accept any number of external data parameters, not just work_order_id.
Integration Workflow with Middleware App
To integrate your system of record that is triggering the execution of work instructions and then recording the results of that execution the data workflow would be as follows.
...
The user visits a Deeplink dynamically generated by the system-of-record (see “configuration” above).
The WorkLink app launches and loads the Scenario Catalog identified by the Deeplink’s
assetquery 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.externalDataattribute, including and notablywork_order_id).The customer’s custom application receives Webhook event notifications from the Scope AR platform that there is new data that the application is interested in.
The customer’s custom application queries the Scope AR GraphQL API to retrieve the ScenarioSession data identified by the Webhook payload
resource_id(see Scenario Session Data Sample Queries ).The customer’s custom application inspects the data retrieved for 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 system-of-record APIs, or similar) using available APIs from the system-of-record.
The customer’s custom application receives ALL Webhook notifications, not just create and update events pertaining to ScenarioSessions. The application should inspect the Webhook’s payload event and data.resource_type values in order to determine the proper action to take.
Integration Workflow with Built-in Integrations
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 steps of this flow entail:
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
assetquery 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.externalDataattribute, including and notablywork_order_id).The Worklink WorkLink integration receives Webhook event notifications from the Scope AR platform that there is new data that the application is interested in.
The Worklink WorkLink integration queries the Scope AR 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_idThe 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.
...
As an analyst, I want to import data from the Scope AR platform on a regular basis so I can visualize the data with my internal BI tools.
...
I will use a custom internal application and the Scope AR GraphL API to retrieve Scenario Session data and store in a Data Store that my BI tools can read.
...
Customer creates a custom application that:
Queries the Scope AR GraphL API on a regular basis.
Translates the JSON response into a Schema most compatible with customer’s needs.
Stores the translated data to customer’s Data Stores.
...