LabVIEW Help

This page provides support resources to help when using the Andon App API for LabView.  Click on the sections below to access links for each topic

Still have questions?  We are here to help - contact us


Getting Started -- Use Case

back to top

Andon App API for LabVIEW is used by companies who want to integrate Andon App's features to report production output and workstation status seamlessly with their existing LabVIEW test platform. This add-on allows users to integrate Andon App's production monitoring capabilities into existing LabVIEW or TestStand automation by leveraging Andon App's public API to record production results and station status

Getting Started-- Prerequisites

back to top

Before using Andon App API for LabVIEW you need create an account and organization within Andon App and generate an API token to authenticate calls.

Follow these instructions to create an account in Andon App, and Follow these instructions to create an org.  If you haven't already, you'll need to sign up for our trial using the trial form.  As part of these steps you will generate the below 3 items used in the Andon App API for LabVIEW - be sure to record these for later use:

Demo Form.png

Then follow these instructions to generate an API token to authenticate calls made from Andon App API for LabVIEW.  Store this token securely as it will only be shown once and will be needed later in LabVIEW.

Getting Started -- Install Andon App API for LabVIEW

back to top

 

Application Software Requirements: LabVIEW Development System 2016 or later
Compatibility Requirements: Andon App API is tested and supported on Windows 10

The LabVIEW Add-on for Andon App can be downloaded from the LabVIEW Tools Network using this link.  Instructions on how to install LabVIEW Add-ons using VI Package Manager can be found here on the NI website.


LabVIEW Example -- Entering Org Info

back to top

After the prerequisites have been completed and the add-on installed, open up the example in LabVIEW to test the functionality of the add-on.  When the example is opened you will see the below screen:

LabVIEW - entering org info.PNG

The first thing you need to do is to enter the org info captured in the prerequisites:

  1. Enter the Organization Name used in Andon App
  2. Enter the Authorization Token generated by Andon App to authenticate your calls to the API
  3. Open Client - push this button to open the client connection to Andon App
  4. Close Client - after you are finished using the example, push this button to close the client connection to Andon App

LabVIEW Example -- Report Production Results

back to top

With a client connection opened to Andon App you can now report production results to Andon App by completing the below steps:

LabVIEW - record production results.PNG
  1. Enter the name of the line you are reporting production results for.  The line name can be any name that you entered when completing the prerequisites.  
  2. Enter the name of the station you are reporting production results for.  The station name can be any name that you entered when completing the prerequisites.  If you are not sure which stations are associated with which lines for your org, review in the Line and Station Settings in Andon App using this guide.
  3. Select the production result you wish to report (pass or fail)
  4. Enter the process time (in seconds) that you wish to report for how long it took the workstation to complete production of the unit under test (start to finish).  This must be greater than or equal to 1 second
  5. If the production result was 'fail' in step 3 you are required to enter the fail reason.  The default fail reasons after completing the prerequisites are Assembly failure and Test failure.  For 'fail' results in step 3 you must enter a valid fail reason.  Review your current fail reasons in Andon App using this guide
  6. If the production result was 'fail' in step 3 you can enter fail notes here to add further details.  This field may or may not be required to be populated based on your org settings.  As a default for new orgs in Andon App this field is required to be populated when 'fail' is entered in step 3.  Check your current org settings for whether or not a failure comment is required using this guide

After the above items are populated, push the button Record Production Result to report the information to Andon App.  The 'Status' window will show whether or not the API call was successful.  Details behind 'fail' responses can be further reviewed in the 'Error' window.

A 'success' response reflects that the production results have been recorded in Andon App and are now reported in Andon App's production status page:

LabVIEW - andon metrics page.png

If a 'pass' result was reported the quantity (QTY) will be incremented by 1 for the associated line/station.  If a 'fail' result was reported the yield will drop accordingly for the associated line/station.  More details behind Andon App's production status page are available in this guide.  Note that if there are multiple stations for a line the QTY reported at the 'line level' view will be only the quantity produced at the last station in the line - you will need to drill down into the 'station level' view to see the QTY for each station

LabVIEW Example -- Report Station Status

back to top

With a client connection opened to Andon App you can also report station status (red/yellow/green) to Andon App by completing the below steps:

LabVIEW - report station status.PNG
  1. Enter the name of the line you are reporting production results for.  The line name can be any name that you entered when completing the prerequisites.  
  2. Enter the name of the station you are reporting production results for.  The station name can be any name that you entered when completing the prerequisites.  If you are not sure which stations are associated with which lines for your org, review in the Line and Station Settings in Andon App using this guide.
  3. Select the station status color - red, yellow, or green
  4. If the status color was 'yellow' or 'red' in step 3 you are required to enter the status reason.  The default status reasons after completing the prerequisites are Equipment down, Missing parts, or Quality issue.  For 'yellow' or 'red' status' in step 3 you must enter a valid status reason.  Review your current status reasons in Andon App using this guide
  5. This field may or may not be required to be populated based on your org settings.  As a default for new orgs in Andon App this field is required to be populated when 'green', 'yellow', or 'red' station status is entered in step 3.  Check your current org settings for whether or not a red/yellow/green light comment is required using this guide

After the above items are populated, push the button Update Station Status to report the information to Andon App.  The 'Status' window will show whether or not the API call was successful.  Details behind 'fail' responses can be further reviewed in the 'Error' window.

A 'success' response reflects that the station status has been recorded in Andon App and is now reported in Andon App's production status page where the background color of the line/station will reflect the current status:

LabVIEW - andon metrics page red.png

Additionally, red light status will trigger an alert to be generated by Andon App, which can be sent to the appropriate support staff via email:

phone6.png

For more details on Andon App's alert notifications reference this guide


TestStand Example -- Entering Org Info

back to top

After the prerequisites have been completed and the add-on installed, open up the example in TestStand to test the functionality of the add-on.  When the example is opened you will see the below screen:

opening image.PNG

Prior to executing the demo all of the variables in the Variables section must be populated.  First enter the org info captured in the prerequisites:

org info.PNG
  1. Enter the Organization Name used in Andon App
  2. Enter the Authorization Token generated by Andon App to authenticate your calls to the API

TestStand Example -- Report Production Results

back to top

Then continue to populate the Variables section with the production results:

report prod.PNG
  1. Enter the name of the line you are reporting production results for.  The line name can be any name that you entered when completing the prerequisites.  
  2. Enter the name of the station you are reporting production results for.  The station name can be any name that you entered when completing the prerequisites.  If you are not sure which stations are associated with which lines for your org, review in the Line and Station Settings in Andon App using this guide.
  3. Select the production result you wish to report (pass or fail)
  4. Enter the process time (in seconds) that you wish to report for how long it took the workstation to complete production of the unit under test (start to finish).  This must be greater than or equal to 1 second
  5. If the production result was 'fail' in step 3 you are required to enter the fail reason.  The default fail reasons after completing the prerequisites are Assembly failure and Test failure.  For 'fail' results in step 3 you must enter a valid fail reason.  Review your current fail reasons in Andon App using this guide
  6. If the production result was 'fail' in step 3 you can enter fail notes here to add further details.  This field may or may not be required to be populated based on your org settings.  As a default for new orgs in Andon App this field is required to be populated when 'fail' is entered in step 3.  Check your current org settings for whether or not a failure comment is required using this guide

After the above items are populated, the Record Production Results portion of the demo can be executed to report the information to Andon App.  After execution TestStand will report whether or not the API call was successful.  A 'success' response reflects that the production results have been recorded in Andon App and are now reported in Andon App's production status page:

LabVIEW - andon metrics page.png

If a 'pass' result was reported the quantity (QTY) will be incremented by 1 for the associated line/station.  If a 'fail' result was reported the yield will drop accordingly for the associated line/station.  More details behind Andon App's production status page are available in this guide.  Note that if there are multiple stations for a line the QTY reported at the 'line level' view will be only the quantity produced at the last station in the line - you will need to drill down into the 'station level' view to see the QTY for each station

TestStand Example -- Report Station Status

back to top

You can also report station status (red/yellow/green) to Andon App by populating the Variables section using the below steps:

report status.PNG
  1. Enter the name of the line you are reporting production results for.  The line name can be any name that you entered when completing the prerequisites.  
  2. Enter the name of the station you are reporting production results for.  The station name can be any name that you entered when completing the prerequisites.  If you are not sure which stations are associated with which lines for your org, review in the Line and Station Settings in Andon App using this guide.
  3. Select the station status color - red, yellow, or green
  4. If the status color was 'yellow' or 'red' in step 3 you are required to enter the status reason.  The default status reasons after completing the prerequisites are Equipment down, Missing parts, or Quality issue.  For 'yellow' or 'red' status' in step 3 you must enter a valid status reason.  Review your current status reasons in Andon App using this guide
  5. This field may or may not be required to be populated based on your org settings.  As a default for new orgs in Andon App this field is required to be populated when 'green', 'yellow', or 'red' station status is entered in step 3.  Check your current org settings for whether or not a red/yellow/green light comment is required using this guide

After the above items are populated, the Update Station Status portion of the demo can be executed to report the information to Andon App.  After execution TestStand will report whether or not the API call was successful.  A 'success' response reflects that the station status has been recorded in Andon App and is now reported in Andon App's production status page where the background color of the line/station will reflect the current status:

LabVIEW - andon metrics page red.png

Additionally, red light status will trigger an alert to be generated by Andon App, which can be sent to the appropriate support staff via email:

phone6.png

For more details on Andon App's alert notifications reference this guide


API Response -- Success

back to top

After updating the station status or reporting production results using Andon App's API the API will respond to indicate whether the call was a 'success' or 'fail'.  A 'success' response will be indicated with http status code 200.  The Andon App API for LabVIEW is set up to automatically interpret the response and indicate the result in the 'Status' window (LabVIEW example shown below - there is a comparable status output in TestStand):

status.PNG

API Response -- Fail

back to top

After updating the station status or reporting production results using Andon App's API the API will respond to indicate whether the call was a 'success' or 'fail'.  A 'fail' response will generally be indicated with http status codes 4xx/5xx.  Typically a fail response will be formatted as shown below (with example values for errorType and errorMessage):

  • {"errorType":"INVALID_REQUEST","errorMessage":"'RED2' is not a valid status color."}
  • {"errorType":"UNAUTHORIZED_REQUEST","errorMessage":"You do not have permission to use org 'OrgNameHere'."} 

The current range of values for errorType is:

  • BAD_REQUEST
  • INVALID_REQUEST
  • RESOURCE_NOT_FOUND
  • UNAUTHORIZED_REQUEST
  • INTERNAL_ERROR

In the add-on examples the 'Error' page will automatically parse error responses and provide the response status along with the 'fail' reasons to the user (LabVIEW example shown below - there is a comparable status output in TestStand):

For additional details on the API response reference this guide