Add BOM list to WATS

We have introduced a standard format for BOM (Bill of Materials) named WATS Standard BOM Format (WSBF) which is based on XML. This format enables easier integration for 3rd party systems to add BOM lists to WATS, for use during Repair (UUR) / Rework.

1. Format definition

The structure of the format is based on two XML elements named BOM (Header) and Component (List).

BOM element

Field Description
Partnumber Product Part Number (Required)
Revision Product Revision (Required)
Desc Product Description

Component element

Field Description
Number Component Part Number (Required)
Rev Component Revision (Required)
Desc Component Description
FunctionBlock Mapping to function block on article
Qty Quantity of component references
Ref Component references (Required) - references must be seperated by semicolon

The components might be added in two different ways

  • Unique components (Number/Rev)
  • Non-unique components (same Number/Rev) with unique component references

An XML example and the XSD schema is found at the bottom of this article. You may use Microsoft .NET framework to build the BOM lists using our class definition WATS WSBF.cs, and for an example on how to build, please see WATS WSBF Example.cs.

2. Upload using WATS Rest API

In order to use the API, you must authenticate all requests (please see Authentication). As an example using Postman, you will need to send the XML in the body using a PUT request.

 Note that the PUT request will fail if one of the following criteria's are met:

  • XML was not sent in the request body
  • BOM element is missing part number and/or revision
  • BOM element does not contain any components
  • BOM element contains components without Number

After a successful response, a product and product revision is inserted (unless they already exist) in the database, based on the Part Number and Revision specified in the BOM. Inserted products/revisions can be seen using the Product Manager. Uploading a BOM will overwrite if there's already an existing one for the product revision.

3. Use BOM during UUR (Repair) / Rework

After the BOM is uploaded, the Repair processes might need some adjustments based on your requirements. By default a Repair process has the BOM binding to Optional. This means that the operator can skip using the BOM list and provide a custom component reference as long as it matches the CompRef mask on the process.  

After necessary process adjustments have been made, component references from the BOM list can be used if the BOM binding is set to Optional or Required.


Have more questions? Submit a request


Please sign in to leave a comment.