diff --git a/docs/report/build.md b/docs/report/build.md index 2e86672..b642b53 100644 --- a/docs/report/build.md +++ b/docs/report/build.md @@ -19,8 +19,89 @@ In addition to the default report context variables, the following context varia | --- | --- | | build | The [Build](./context_variables.md#build) object the report is being generated against | | part | The [Part](./context_variables.md#part) object that the build references | -| reference | The build order reference string | +| reference | The build order reference string. This is just the string that follows BO... | +| title | The full name of the build including the BO | | quantity | Build order quantity | +| build.title | The description of the build | +| build.status | The status of the build. 20 means 'Production' | +| build.bom_items | A query set with all bom items for the build | +bom_items that can be looped. Each bom_item line has further context variables. +| Variable | Description | +| --- | --- | +| line.reference | The reference designator of the component | +| line.sub_part | The part at this position | +| line.quantity | The number of components | +| line.sub_part.build_order_allocations | ... | +A very simple example wihtout any html formatting: + +{% raw %} +```html +reference: {{reference }} +
+quantity: {{ quantity }} +
+title: {{ title }} +
+part: {{ part }} +
+build: {{ build }} +
+
+build.reference: {{ build.reference }} +
+build.title: {{ build.title }} +
+build.status: {{ build.status }} +
+------- +
+{% for line in build.bom_items %} +reference:: {{ line.reference }} +
+quantity:: {{ line.quantity }} +
+sub_part: {{ line.sub_part }} +
+sub_part.IPN: {{ line.sub_part.IPN }} +
+sub_part.name: {{ line.sub_part.name }} +
+sub_part.build_order_allocations: {{ line.sub_part.build_order_allocations }} +
+........ +
+{% endfor %} +``` + +This will result in: + +```text +reference: 0001 +quantity: 10 +title: BO0001 +part: POP-000001-001 | Converter - A to B +build: BO0001 + +build.reference: 0001 +build.title: Description of the build +build.status: 20 +------- +reference:: U002 +quantity:: 1.00000 +sub_part: ANA-000001-001 | op701 - operation amplifier +sub_part.IPN: ANA-000001-001 +sub_part.name: op701 +sub_part.build_order_allocations: ]> +........ +reference:: U001 +quantity:: 2.00000 +sub_part: ANA-000002-001 | L7805 - LDO +sub_part.IPN: ANA-000002-001 +sub_part.name: L7805 +sub_part.build_order_allocations: ]> +........ +``` +{% endraw %}