Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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
pageCount1
autoUpdatefalse
alignleft
typerich
alignleft
autoSize1
macroId6c341bfa-6e8c-40f3-abd0-f49275193f52
pagesinstanceId2149b9b2-bda4-39ed-b4ff-29bc62652edc
pages
width700documentId438ffc73-192e-4ee7-9a3e-3cdf40636e8a
documentTokenv2_141a8d4f13b8abd15b21d28b4bdc15ae91366f4271af3ec064e1b77d0542f349-a=133426130&c=2149b9b2-bda4-39ed-b4ff-29bc62652edc&d=438ffc73-192e-4ee7-9a3e-3cdf40636e8a&p=1270382728
documentId438ffc73-192e-4ee7-9a3e-3cdf40636e8a
updated1701208588986
height500

...

  1. The user visits a Deeplink dynamically generated by the system-of-record (see “configuration” above).

  2. The WorkLink app launches and loads the Scenario or Catalog identified by the Deeplink’s asset query param.

  3. 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 notably work_order_id).

  4. The Worklink WorkLink integration receives Webhook event notifications from the Scope platform that there is new data that the application is interested in.

  5. 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 ).

  6. The Worklink WorkLink integration inspects the data retrieved for the value of ScenarioSession.externalData.work_order_id

  7. 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.

...