Export Rule Dialog Box

Use the Export Rule dialog box to configure rules that export data to XML files.

An export rule runs when the Export data to XML transition action is triggered for a file or BOM passing the transition.
  • Export of the CAD BOM and Computed BOM data is triggered when a parent file containing the BOM passes the transition.
  • Export of item BOM data is triggered when the parent item passes the transition.
  • The Named BOM data export is triggered only when the named BOM passes the transition, not when the file that the named BOM is derived from passes.

To display this dialog box:

Expand Vault > Data Import/Export, right-click Export Rules, and select New Export Rule.

Rule name  
Output XML-files to folder Name of folder in which to export files. Click Browse (...) to navigate to the folder, then click OK.

The folder must be accessible from the computer running the database server service. Use a UNC path (\\computer\disk\folders ) if the output folder is a network location.
Output XML-file name Name of export file. Can combine pathname components and variable components available when you click >. For example, File_name_Year (2)_Counter-02 could generate a file named ASM_09_38.xml. The system generates unique file names, appending a counter (001, 002, and so on) to the file name, if necessary.

Do not include the .xml extension with the filename component. The system adds the extension to the exported file.
Type of data to export Type of BOM to export:
CAD BOM

Generates an XML file for drawing or assembly files that contain a CAD BOM. The BOM layout, not the export rule, determines the variables, configurations and references to include or exclude in the XML data.

The export transition action must use the Run for files option.
Computed BOM

Exports data from the computed BOM. Generates an XML file for all files, provided a BOM is defined.

The export transition action must use the Run for files option

To export item BOMs, select Computed BOM and select an item BOM template from Bill of materials to export. The export transition action must use the Run for items option.
Named BOM

Exports data from a saved named BOM. The named BOM layout, not the export rule, determines the variables, configurations and references to include or exclude in the XML data.

The export transition action must use the Run for named bill of materials option.
Export bill of materials in table format Formats the XML data in a flat table structure matching the columns and rows in the BOM.

If cleared, formats the data hierarchically, following the assembly structure. The export must include contains information.

CAD BOMs and Named BOMs are always formatted in tables.
Only export activated BOMs Triggers the export rule if a CAD BOM or Computed BOM is marked activated in the BOM viewer for the file. This option does not apply to item BOMs.

Variables

Use this tab to specify the type of variables to export for a computed BOM or item BOM. This tab is unavailable for CAD BOMs and Named BOMs.

Bill of materials to export BOM column definition to use when the Computed BOM or item BOM is exported. The BOM does not have to be activated or visible to the user who is performing the transition.
Variable used to identify a file

Variable value that identifies each file in the exported XML data. If a data card variable is selected and has a value, an id is included in the XML data with that value. An idattribute and idcfgname display the variable name and configuration that the value is retrieved from.

For example, use this option if a unique part number is assigned to the file data card and the application processing the exported XML data uses that part number instead of the file name to identify the file.

Alias set to use in XML-file

Alias set to use when this export rule is run. The generated XML file uses the alias name instead of the data card variables defined in the alias set.

Configurations

Use this tab to specify the configuration information to export for a computed BOM. This setting does not apply to item BOMs. This tab is unavailable for CAD BOMs and Named BOMs.

Export all configurations Exports all configurations in the file that triggers the export rule. For SOLIDWORKS drawings, exports all sheets.

If file references are included, contains information for each configuration is exported, grouped under separate configuration entries. The @ configuration for SOLIDWORKS files is not exported unless specified in the Export configurations with the following name option.

For files not supporting configurations, exports the normal data card information.
Export active configurations Exports the active (last saved) configuration in the file that triggers the export rule. For SOLIDWORKS drawings, exports the active sheet.

For files not supporting configurations, exports the normal data card information.
Export configurations with the following name Exports configurations matching the specified name. Use an asterisk (*) as a wildcard character. To export several named configurations, create multiple export rules and export actions.

Ignores files that do not support configurations.

File References

Use this tab to specify the reference information to export for a computed BOM or item BOM. This tab is unavailable for CAD BOMs and Named BOMs.

Output selected file Includes information about the file or item that triggers the export rule in the export file. This option is equivalent to using the show selected option when viewing a computed BOM in the BOM viewer.

For example, if exporting a drawing BOM with this option enabled, the export includes information about the drawing as well as the assembly or part references.

For files or items without references, this option must be enabled for the export file to be created. It is not possible to clear this option if Export all configurations is enabled.
Output "where used" information (parent references) Includes information about which parent each file or item entry in the exported data belongs to.

This option is ignored when exporting in a table format.
Output "contains" information (child references) Includes BOM reference information for the file or item triggering the export rule.

For example, if an assembly triggers the export rule, the export file contains all subassemblies and parts that the assembly references, as referenced by each configuration included in the export.

For files not supporting configurations, all references are included. User-defined references are included if they have been marked as show in Bill Of Material at creation.

This option is ignored when exporting in a table format.
Top level only Includes BOM references from the first level only.

Equivalent to using the BOM viewer.
Include quantity Includes the BOM quantity in the export file. Does not need a quantity column defined in the BOM column definition.

This option is ignored when exporting in a table format.
Versions as built Includes the as-built BOM reference information for the file or item triggering the export rule, that is, the attached version of referenced files to the version of the file triggering the export.
Latest version of parts Includes the latest version of BOM references that are referenced by the file or item triggering the export rule, regardless of the as-built version.