BuildForge Help

field

The <field> element can be used within either the <bom> or <section> elements to specify a field.

When used in a <bom> element, specify the name and text; the text attribute defines which variable is used to populate the field with data.

When used in a <bomformat> <section> element, specify the name and title. The name specifies the logical name, while the title is used for display. If there is more than one field in a <section>, include an order attribute.

<section name="changesets">
        <field order="1" name="Change" title="Change ID"/>
        <field order="2" name="Date" title="Date"/>
        <field order="3" name="Time" title="Time"/>
        <field order="4" name="User" title="User ID"/>
        <field order="5" name="Client" title="Client"/>
        <field order="6" name="Comment" title="Comment"/>
</section>

Use the conditional attribute to control whether the <field> element is written to the BOM report. The value of the conditional attribute is an expression that evaluates to true or false. If the expression evaluates to true, the information in the <field> element is written to the BOM; otherwise, it is not excluded.

Use the template attribute to define the text format for the field element. For example, if the text is a string, the template value might be "Hello $VALUE". When the field is written to the BOM report, $VALUE is replaced with the field text.