Subscription Service Documentation

General Prerequisites

  • All Customer product units whose data should be uploaded to Instrumental must be uniquely identifiable with a serial number, and those serial numbers must be accessible based on the way that the data is collected or sent to Instrumental. For Instrumental stations taking inspections, serial numbers must be either manually typed in, scannable from a bar code, generate-able from other collected data, or acquirable from a shop floor system if a shop floor system integration is purchased. If the serial numbers should be scanned from a bar code and that bar code is not visible or readable in photos taken by every Instrumental Station, then Customer must produce a bar code scanner for each Instrumental station that converts that scan to keyboard input into Instrumental’s station software. The same serial number must be scannable at each Instrumental Station. For managed integrations (uploading data from non-Instrumental stations), the serial number as well as a date/time and station name must be reasonably parseable from provided data.

Prerequisites for Instrumental Stations

In order to correctly use the Instrumental Service, the following criteria must be met by the Customer:

  • Instrumental Stations must have access to bandwidth sufficient to transfer the captured images within a reasonable amount of time. That is, at minimum, the greater of 8 Mbps or (UPH * images/unit / 40) Mbps for a fully loaded assembly line with no data backlog. This bandwidth must be available for at least the same amount of time per day as the amount of time in which the stations are in use. The bandwidth must also be for an Internet connection that can be reasonably used to connect to a U.S.-based cloud server or regional Instrumental proxy
  • Two power outlets per Instrumental Station during the time the stations must be operating and five minutes before. For China deployments, one or both must be Type A – 120V at 60Hz and one may be type C or I – 220V at 50Hz. For U.S. deployments, both can be standard U.S. outlets.
  • Instrumental Station build parameters must not be changed except by Instrumental
  • For Instrumental to design nests for Instrumental Stations, Instrumental must be provided with a CAD model of Customer’s product and corresponding physical parts with enough lead time to design appropriate nests for the Instrumental Stations ordered by Customer
    • If Customer’s product does not fit in the nests when the Instrumental Stations are deployed, Instrumental will make commercially reasonable efforts to improve or replace such nests, but this may be at Customer’s cost
  • For Customers using Intercept, a service that can unilaterally fail units during the assembly/test process, a review of all tests run by Instrumental services must be conducted before enabling those tests. Customers must notify Instrumental in writing of major product variants (configs, SKUs, etc.) that are reasonably expected to be inspected by Instrumental Stations performing Intercept tests so that Instrumental can provide appropriate guidance. Intercept requires an Instrumental Station or In-Factory Server with Intercept enabled. Additionally Instrumental stations that have Intercept enabled must be calibrated upon setup, typically by Instrumental with support from the person setting up the station, and reasonably promptly thereafter if significant adjustments are made that affect the camera such as changing the height of the nest.

Customers acknowledge that legally importing Instrumental Stations through customs and into factory zones may cause unpredictable delays in deploying those Stations in the factory, and that Instrumental shall not be held liable for such delays. Instrumental requires a Factory contact as importer of record.

Prerequisites for Stream Integrations

To correctly import data that was created by non-Instrumental stations:

  • For self-service integrations, Customers must use the correct API keys provided by Instrumental
  • For self-service integrations, Customers must provide data in the correct fields and formats described in the relevant API documentation; for example, test names should be unique among different stations
  • Customers must provide data within the reasonable limits described in the Data Streams API Documentation, such as not sending an amount of data excessively beyond what the relevant Order Form allows
  • Customers must maintain a network connection between Instrumental and the location of the data sufficient to transfer the data within a reasonable amount of time. For a managed integration, Instrumental must be able to access the location of the data, while for a self-service integration, the Customer must be able to connect to Instrumental’s APIs.
  • For managed integrations, Customer must provide the data in an agreed-upon location, such as an SFTP server, and in an agreed-upon format that will not change. If the agreed-upon format changes, Instrumental reserves the right to charge additional fees to update the managed integration, and Instrumental will not be liable for downtime or disruption that occurs between when the format changes and when Instrumental updates the managed integration
  • For managed integrations, Customers must provide a name and contact information for someone who is able to assist with questions about connecting to and parsing the data source

Prerequisites for MES Integrations

In order for Instrumental to build an integration with a Manufacturing Execution System, Customer must:

  • Complete a provided MES Integration Worksheet which includes, at a minimum, API documentation describing all relevant endpoints and the request and response formats for those endpoints, information about how to test the system without affecting actual units, and any information required to connect, authenticate, and authorize to the MES.
  • Arrange for Instrumental stations to have access to a network where they can connect to the MES, in consultation with Instrumental
  • Not interrupt Instrumental stations’ access to the MES without reasonable advance notice, for example by changing the network configuration after setup or changing the MES API. Instrumental reserves the right to charge additional fees for changes and will not be held liable for downtime caused by inadequate notice to make changes
  • Provide a name and contact information for someone who is able to assist with questions about connecting to the MES

Other Service Prerequisites

  • For Customers using Instrumental Measure, image rectification and calibration is required. Accuracy of Measure results may depend on the specific measurement application, and therefore are not guaranteed. Customers may run a GR&R study to validate performance on a specific measurement application.
  • For customers using Instrumental Detect, Instrumental Monitor, or Instrumental Discover, these tools only operate on image types with at least 30 photos for each relevant SKU or group of SKUs.
  • The Instrumental web application works best with the latest desktop versions of Chrome, Firefox, Safari, and Edge. Other browsers, including iOS Safari, Android Chrome, and Internet Explorer 11 and below, are not supported at this time and may not be functional.

Service Availability

Instrumental Services are considered Available to a Customer if all Instrumental Stations deployed to that Customer are able to take inspections, if fully uploaded and valid inspections for that Customer can be viewed through the Instrumental web interface, and if ingest API endpoints used by the Customer can accept any requests over the public internet.

If all Prerequisites are met, the service is not Available, and Instrumental did not provide reasonable advance notice that the service would not be Available due to Planned Maintenance, then the Instrumental Services are defined to be experiencing Downtime. Monthly Customer Downtime is calculated as follows:

  • W = the number of minutes during the month during which fully uploaded and valid inspections for the Customer cannot be viewed through the Instrumental web interface, except minutes during Planned Maintenance windows
  • A = the number of minutes during the month during which ingest API endpoints used by the Customer cannot accept any requests over the public internet, except minutes during Planned Maintenance windows and minutes counted in W to avoid double counting
  • S = the number of minutes during the month during which any Instrumental Station on a particular assembly line is not able to take inspections, excluding minutes during Planned Maintenance windows and minutes counted in W or A to avoid double counting
  • M = the sum of all S across Customer assembly lines on which there are Instrumental Stations deployed
  • N = the number of Customer assembly lines on which there are Instrumental Stations deployed
  • Z = the number of minutes in the month
  • Monthly Customer Downtime = (W + A + (M / N)) / Z

Service Changes

Customers acknowledge that Instrumental is constantly developing the Services and that the Prerequisites and definitions above may change in order to accommodate these updates and new offerings or in order to add clarity. Instrumental will provide reasonable advance notice if any changes to Prerequisites significantly affect Customers or if any changes to Prerequisites or definitions significantly change the Services being provided to Customer.