42Q-MES0159 Multimedia API Whitepaper

Multimedia API

The demand for capturing more sophisticated data is increasing. One such demand is storing media evidence as related data associated with a manufacturing process to provide higher product quality control. 

With 42Q’s Multimedia features and API, factories can upload media items and require associated metadata.

This whitepaper provides details on how to use 42Q API endpoints to store, retrieve, and delete Multimedia items from local or 42Q repositories using one of 42Q’s newest features: Multimedia API. 

 

 

 

What is a Multimedia API?

Multimedia Application Programming Interface is a set of endpoints that allow client applications to safely talk to 42Q media repositories. It is a collection of high-level APIs that support flexible application development. It is the same engine used by standard 42Q Clients such as PWB (Production Workbench) to capture, store, and link media to manufacturing processes as they happen.

The Multimedia API ecosystem provides what it’s needed by a customer to integrate their local applications with 42Q unleashing all the power, scalability, and elastic storage provided by a true cloud-based manufacturing execution system.   Multimedia API is used by several 42Q modules to store any kind of media such as documents, images, videos, etc. It contains a map/link system that keeps track of which media elements were loaded and where they are stored.

 

Simplified Point-of-View

A good example of an API is when you use an application on your phone, the application connects to the Internet and sends data to a server. The server then retrieves that data, interprets it, performs the necessary actions, and sends it back to your phone. The application then interprets that data and presents you with the information you wanted in a readable way.   To explain this better, let us take a look at a familiar example. Imagine you’re sitting at a table in a restaurant with a menu of choices to order from. The kitchen is part of the “system” that will prepare your order. What is missing is the critical link to communicate your order to the kitchen and deliver your food back to your table. That’s where the waiter or API comes in. The waiter is the messenger – or API – that takes your request or order and tells the kitchen – the system – what to do. Then the waiter delivers the response back to you; in this case, it is the food.

 

Multimedia API Example

 

 

What is the Multimedia API used for in 42Q?

Multimedia API in 42Q provides a common API for loading and receiving multimedia elements. It also provides different options of storage.   

Some of 42Q common API’s are as follows:  

• Save Media
• Get Media 
• Delete Media 
• Restore Media

Multimedia API can perform HTTP(S) requests for loading media items and required associated metadata, retrieving an identifier for the given data, and delete media items based on the media identifier. All requests to the API require a customer to identify who is accessing the API, and a Palindrome authorization header.

 

 

What Are The Benefits Of Using a Multimedia API in 42Q?

Multimedia API is used to provide better and universal Multimedia storage and retrieval services so that each module can easily and conveniently integrate with a common platform for storage. This will be widely used for modules and 42Q applications. It provides a common API for loading and retrieving Multimedia elements.

 
Below is a list of beneficial things that Multimedia API provides :  

• Provides a common repository for multimedia elements collected both from client endpoints and internal applications securely. 
• Ensures evidence such as documents, pictures and videos can be seamlessly collected and reported attending the various customers demanding this kind of evidence for tracking/audit/certification purposes.
• Assures accuracy of PASS/FAIL to log among CRITICAL PROCESSES as solicited by many customers requiring imaging verification and tracking at 42Q MES.
• Data Segregation and security as a design principle as all media elements are  stored in tenant specific cloud buckets at the customer, plant, or site levels.

 

Examples of GET, POST, DELETE for HTTP/HTTPS

GET	to download/retrieve the media.
POST	to save/restore media (content itself or a URL.)
DELETE	to delete the media item based on its unique identifier.

 

 

Conduit and Production Workbench Services

Example : 

Manipulating the device history record of a serial number in 42Q involves communication with the Conduit service and/or the Production Workbench client application. The following operations are currently provided by the Conduit service :  

Record Media :

Permanently associate a previously acquired media identifier (from the Multimedia service) with the scanned unit serial number’s device history record creating a brand new activity.  

Ex. 42Q might render a certificate of compliance (CoC) for the production unit and store that generated documentation using the Multimedia API. The resultant media reference can then be supplied to Record Media to permanently associate that certificate with the unit serial number. 

Link Media :

Permanently associate a previously acquired media identifier (from the Multimedia service) with a previously recorded action (Defect, Component, Repair, etc.) on the unit serial number  

Ex. A good example of this would be taking a picture of a defective unit. That image would then be stored using the Multimedia API to then take the media identifier that is given and call RecordMedia or LinkMedia commands, depending on if you want a general unit association or a link to an existing activity on that unit associated.

StoreMedia :

Conduit based example of consuming the Multimedia API

Note: While storing media through Conduit is possible, it is generally more efficient for clients to communicate with the Multimedia API directly.

 

 

 

Document Revision History

Date	Author	Title	Version	Change Reference	Approved by
08/3/20	Tiana Hollingsworth	Technical Writer	A1	First version of the Multimedia API Whitepaper.	Gustavo Velasquez