Versions Compared

Version Old Version 50 New Version 51
Changes made by

Precious Omolori

Mike Piska

Saved on

Key

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

...

In This Article

Table of Contents

Further use cases are described here:

Child pages (Children Display)

Glossary

There are a number of key terms relevant to the use cases described in this document.

...

I will use a GraphQL client to retrieve Scenario Session data from the Scope GraphQL API which is not otherwise available in the Scope CMS user interface.

Procedure

...

  1. The GraphiQL client application is installed and configured to communicate with the Scope GraphQL API (see “Exploring the Graph”)

  2. The following query is executed:

    Code Block
    query {
  node(id: "INSERT_ID_OF_SCENARIO") {
    ... on Scenario {
      sessions {
        nodes {
          id
          state
          user {
            id
            name
          }
        }
      }
    }
  }
}

  3. The JSON response is reformatted to CSV (using any relevant tool) for merge with system-of-record data and/or reporting.

Use Case #2: Scheduled Data Import/Analytics

...

To view a live demo of a “custom internal application”, complete with source code, see https://api-demo-ruby.scopear.com. Alternatively, view a video presentation demonstrating the sample application here.

Configuration

  1. For each physical device (aka the “Asset”) that work orders might pertain to in the system-of-record (.e.g. “Generator Model #1234”):

    1. The administrator creates at least one Scenario for the Asset using the Scope Create 2 application.

    2. The administrator creates a Scenario Catalog for the Asset using the Scope CMS web interface.

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

  3. The administrator creates a custom internal application designed to receive Scope Webhooks.

  4. The administrator contacts Scope support to configure the customer’s Scope account to send Webhooks to said application.

Scope Deeplinks are highly extensible and accept any number of external data parameters, not just work_order_id.

For more information, see “Using Webhooks”, “Using Deeplinks”, and “ServiceMax Configuration Guide”.

Procedure

...

  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 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 customer’s custom application receives Webhook event notifications from the Scope platform.

  5. The customer’s custom application queries the Scope GraphQL API to retrieve ScenarioSession data identified by the Webhook payload resource_id (see Sample Queries).

  6. The customer’s custom application inspects the data retrieved for the value of ScenarioSession.externalData.work_order_id

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

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.

...

  • Simplified calling

  • Closed loop service desk SLA metrics.

...

Orchestration

  1. Users are assigned call IDs that can be integrated with a system-of-record (like a service desk tool’s contact list)

  2. Experts can click on a Deeplink to launch application and call a specific contact from the system or record.