# Clear To Build

**Clear To Build** reports indicate whether the piece-parts that make up an assembly are available. This provides valuable insight into build readiness during production planning.

<figure><img src="https://2091741164-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvrraExym8pNEUvBDoima%2Fuploads%2FAYLekumljayBsFSgQwRw%2Fimage.png?alt=media&#x26;token=b9d52a2d-bf08-4f71-a8bf-d4d5e09d006d" alt="" width="563"><figcaption></figcaption></figure>

### Getting started

Access this feature from **Reports** in the navigation panel. Click <mark style="color:purple;">**+ REPORT**</mark> then select **Clear To Build.**

<figure><img src="https://2091741164-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvrraExym8pNEUvBDoima%2Fuploads%2FntgnXiO054cvbU4zdTjQ%2FScreenshot%202025-03-24%20at%2012.46.49%E2%80%AFPM.png?alt=media&#x26;token=d1945f0a-f72c-4f0a-b99d-d6d512ba6794" alt="" width="563"><figcaption></figcaption></figure>

Begin by searching for a part by name or number in the input field. The dropdown will automatically suggest matching entities - click on the desired part to populate the report.

*Note: this report is intended for assemblies - only parts with a BOM will be selectable.*

<figure><img src="https://2091741164-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvrraExym8pNEUvBDoima%2Fuploads%2FTphtrAnBqs7DWEIxm6Gq%2FScreenshot%202025-04-04%20at%204.10.17%E2%80%AFPM.png?alt=media&#x26;token=0a96d5a8-b1d5-48df-97fa-4dca9d322b67" alt="" width="563"><figcaption></figcaption></figure>

### Understanding the report

The following information will be populated for each line in the assembly:

* `Procurement Type` is the method of procurement defined for that part.
* `Qty Line` is the quantity required for that *line* in the assembly.
* `Qty Available` is the *total* quantity of that part available in inventory.
* `Qty Needed` indicates any additional quantity needed for that *line*.&#x20;
* Last, the `OK to Build?` status indicates whether the line item is ready to build based on the inventory status of its sub-components.&#x20;

Navigate through the report by expanding each sub-assembly to track its build readiness as well.

### How does it work?

The `OK to Build?` status is determined according to the following logic:

* For lines where `Procurement Type` is *Buy***:**
  * `OK to Build` for that line, and for each of its child lines, will be **N/A**
* For lines where `Procurement Type` is *Make***:**
  * If `Qty Needed` for all child parts is **0**, `OK to Build` will be **Yes**
  * If `Qty Needed` for any child part is greater than zero, and/or the `Ok to Build` for any child part is **Unknown**, `OK to Build` will be **No**
  * If there are no sub-components, `OK to Build` will be **Unknown**
* For lines where `Procurement Type` is *empty*:
  * `OK to Build` will be **Unknown**

<figure><img src="https://2091741164-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvrraExym8pNEUvBDoima%2Fuploads%2FVdFUs0YO8R67LfIWYYE0%2Fimage.png?alt=media&#x26;token=47a29b5a-4e6f-4c5d-bd2b-2a293a633aa8" alt="" width="563"><figcaption><p>Example Clear To Build Report for our Magic Toaster</p></figcaption></figure>

You can choose whether or not to treat part revisions as interchangeable by clicking on the three dots just above the top right corner of the report. If part revisions are interchangeable the report will reflect `Qty Available` values for all revisions of each part. If part revisions are not interchangeable, the report will reflect `Qty Available` values for only the most recent revision of each part. By default, part revisions are treated as not interchangeable.

<figure><img src="https://2091741164-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvrraExym8pNEUvBDoima%2Fuploads%2FhJuJu5Qs8Zz7gszHT9FI%2Fimage.png?alt=media&#x26;token=e76ab8db-0fd2-48b2-a6ff-7d3441e69806" alt=""><figcaption></figcaption></figure>

Once you've developed a report for your assembly, you can save it for future reference.&#x20;

Your report will automatically update with any changes to the BOM, the Procurement Type, or the inventory status of a part.

Reports can also be exported in .csv format for offline use.

<figure><img src="https://2091741164-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvrraExym8pNEUvBDoima%2Fuploads%2FCxcrIc0prYB3S33k9aT2%2FScreenshot%202025-04-04%20at%203.50.43%E2%80%AFPM%20copy.png?alt=media&#x26;token=965fb7ec-b42b-433e-80f9-8472a3d4d39d" alt="" width="563"><figcaption></figcaption></figure>

#### Where does Violet get the data for a Clear To Build Report?

Violet populates the assembly information as well as `Name` and  `Qty Line` from the part you select. This will generally come from the PLM you've connected to Violet, such as [teamcenter](https://docs.violetlabs.com/apps/t/teamcenter "mention"), [duro](https://docs.violetlabs.com/apps/d/duro "mention"), [solidworks-pdm](https://docs.violetlabs.com/apps/s/solidworks-pdm "mention") or [windchill](https://docs.violetlabs.com/apps/w/windchill "mention").

The `Qty Available` and `Procurement type` are typically populated from the MES you've connected in Violet, for example [generate-api-credentials-in-ion](https://docs.violetlabs.com/apps/i/ion/generate-api-credentials-in-ion "mention"), [boltline](https://docs.violetlabs.com/apps/b/boltline "mention") or [manufacturo](https://docs.violetlabs.com/apps/m/manufacturo "mention"). If those fields are empty, Violet will attempt to populate them based on data from your PLM.

The `Name`, `Qty Line`, `Qty Available`, and `Procurement Type` columns will display a logo based on the app used to populate the column.

Last, Violet calculates `Qty Needed` and the `OK to Build` based on the logic described above.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.violetlabs.com/features/reports/clear-to-build.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.