Learn about the available ways to interact with the WorkLink platform with sample use cases and orchestration approaches.

Interface Summary

There are a few primary methods for interfacing with WorkLink system.

Interface	Description
GraphQL	Flexible and efficient query-driven data-retrieval through an endpoint. For more information, please see https://graphql.org/
DeepLinks	Method for launching app and passing parameters through to the platform through a structure URL. “Deferred Deep” linking automatically prompts for app download
Resource Catalogs	Method for mapping a customer’s internal system objects (like assets or training modules) to sets of work instructions.
User Creation/Provisioning	Directory integration for automatic user creation. Coming Soon
IoT Device	Pull data directly from devices. Coming in 2021

Example Use Cases

System of Record Integration

Single Session

As an administrator, I want a work order in my system-of-record updated with activity executed through 3D work instructions, so that i have a single source of truth for job completion.

Application

Get data from a work instruction session and attach it to a particular job ID in the customer’s system of record.

Functional Summary

Clicking a URL in the system of record user interface (in a work order or a training module) launches the WorkLink app and loads the relevant work instructions.

A Work Instruction Session is completed and session data is sent to the CMS

Through a webhook, the system-of-record is notified data is available for the specific record id. System of record queries the GraphQL API to retrieve the data (Sample):

      email
      startedAt
      finishedAt
      duration
      idleDuration
      numberOfStepsPossible
      numberOfStepsViewed
      percentOfStepsViewed

Scope GraphQL API > Integration with other systems > image-20201125-001708.png

Orchestration

Through the Resource Catalog interface in the CMS, IDs (for asset models) are mapped to sets of Work Instructions
The system of record is configured to generate a dynamic URL with the Asset Model ID and a Work/Job Order ID
The URLs are added to the relevant UI screens in the system or record
Customers configure a “webhook receiver” app to get webhook alerts
Customer system is configured to automatically query the GraphQL endpoint to receive the data based on webhook alerts for the Work/Job Order ID.

All Sessions

Summary

As an administrator, I want aggregate data for Work Instruction Sessions so that I can merge it with data from my system of record to calculate KPI and ROI metrics.

Call Integration (Coming Soon)

As an expert, I want an easy way to launch a call from our service desk application so that it’s associated with

Scope GraphQL API > Integration with other systems > image-20201125-175847.png

Upcoming Changes

Additional data sets including Scenario Session details
Better filtering of data