Learn about a number of ways to interact with the WorkLink platform and recommended orchestration techniques for common use cases.
In this article
Definitions
There are a number of systems, services and actors relevant when to interacting with in the WorkLink platform.
Interface | Description |
|---|---|
GraphQL | Flexible and efficient query-driven data-retrieval through an endpoint. For more information, please see “Introduction to the Scope GraphQL API”. |
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 in 2021 |
IoT Device | Pull data directly from devices. Coming in 2021 |
Use Case #1: System of Record Integration
Use Case
...
#1a: 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.
...
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 (or Deeplink) 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.
Use Case
...
#1b: Multiple 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.
...
Advanced visualization of WorkLink data, merged with customer system of record data.
Pull WorkLink system data to integrate with Security Information and Event Management systems. (Coming soon)
...
Orchestration
Customer system is configured to automatically query the GraphQL endpoint to receive the data fields necessary to perform any internal analysis.
Customers can transform JSON format into CSV to merge with System of Record data.
...