To simplify integration to other 3rd party systems, we introduce WATS Standard JSON Format (WSJF).
You can GET WSJF files directly from the server using the REST API.
You can POST WSJF files directly to the server using the REST API. For more information, see https://virinco.zendesk.com/hc/en-us/articles/360014879119
When you install the WATS Client, a folder named “WatsStandardJsonFormat” is created at C:\ProgramData\Virinco\WATS. If a file using the WSJF Format is saved to the directory, the WATS Client will automatically read and import the file into WATS.
WSJF supports two report types: Test report (UUT), and Repair report (UUR).
NOTE: The validation rules and required fields for using the built-in WATS Client WSJF converter are different from the requirements for submitting a WSJF report with the rest API. See the PDF below for the converter requirements, and see the article linked above for the rest API requirements.
Documentation
Please see the attached documentation documents and example files below.
Comments
13 comments
Does the step status also include "D" for done? Character (P, F, E, T, S, D) ?
Is there a difference between step types like (NumericLimitTest, ET_NLT), (StringValueTest, ET_SVT) or (PassFailTest, ET_PFT) or are they two names for the same thing?
Is there a list of all step types? the list doesn't include "AdditionalResults", "Statement" or "GenericStep"
for string evaluation, is there a difference between EQ and CASESENSIT? aren't these the same?
We want to stop using Done and instead use Passed, so no.
stepType decides which icon the step will have in WATS, and isn't used for anything else. The values listed are the ones WATS recognizes. With other values WATS will guess which icon it should be. There is no difference between these icons: NumericLimitTest and ET_NLT, StringValueTest and ET_SVT, PassFailTest and ET_PFT.
You can have NumericLimitTest stepType on a step with string value measurements, but the step will have the wrong icon. If the step does not have measurements, Action is probably a good choice.
EQ and CASESENSIT are the same for string value measurements. Do note that the POST WJSF rest API does not compare your value against your limit to check you have the right status. Use the one that makes sense when you are reading the report later.
Thanks. really appreciate the response.
What does the ET in ET_NLT stand for? evaluation test?
ET_NLT was what we named our custom version of the numeric limit test step in TestStand. ET is an abbreviation for the customer that we originally made the TestStand integration for, which eventually became the WATS Client TestStand add-on.
So it essentially stands for nothing.
Hi,
On page 4 of the documentation, in the report header description, sub-units are named "subunits" instead of "subUnits". Since the converter seems to be case-sensitive, all reported sub-units are silently discarded on upload if one copies the string from the doc.
Hi Zawadi,
Thanks for bringing this to our attention. The WSJF converter is indeed case-sensitive and will ignore subunits and include subUnits.
The PDF linked in this article says subUnits, but the article says subunits. I will correct that so they both say subUnits.
What is the best/easiest way to verify a WSJF file? I'm developing a new client that would send data directly to the API and don't want to interfere with the production system/data.
Hi Tamas,
you can use a dedicated test operation, such as "SW Debug" to separate your tests from production. You can also change the part-numbers when testing to achieve this, or if you are on an Enterprise account we offer a separate sandbox server for testing.
Hi,
It would be helpful to note that even though it is not strictly required, the processName is case-sensitive.
Just fyi.
Is the partType a freeform field (example: I can name the part type anything, like pcba, assembly, CPU, etc), or does it relate to a field that is defined in the ProductManager?
Hi Kenny,
partType is freeform, and is typically used for things like PCBA, etc, or the product name. The partType field is not actually in use by anything in WATS.
Please sign in to leave a comment.