...
Interface Summary
There are 3 3a 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 | Map internal system | 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
...
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):
| Code Block |
|---|
email
startedAt
finishedAt
duration
idleDuration
numberOfStepsPossible
numberOfStepsViewed
percentOfStepsViewed |
...
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
Data Analytics
...
Summary
As an administrator, I want aggregate data for Work Instruction Sessions
Call Integration (Coming Soon)
...
Upcoming Changes
Additional data sets including Scenario Session details
Better filtering of data