IBOM::Export

Use this method to export the BOM report to various formats.

Compatibility

Cimatron 2026 or later

Syntax

void Export(string iFilePath, interop.CimMdlrAPI.BOMTemplateType iType, interop.CimMdlrAPI.BOMExportOptions iExportOption, string iTemplateName, interop.CimMdlrAPI.BOMReportFormat iReportFormat, interop.CimMdlrAPI.ComponentsFilterOption iFilteringType, string[] iFolderNames);

def Export(iFilePath : string, iType : interop.CimMdlrAPI.BOMTemplateType, iExportOption : interop.CimMdlrAPI.BOMExportOptions, iTemplateName : string, iReportFormat : interop.CimMdlrAPI.BOMReportFormat, iFilteringType : interop.CimMdlrAPI.ComponentsFilterOption, iFolderNames : string[]) -> None

Return Type

Return: int

oIsWire

TRUE(= 1)—wire frame body
FALSE(=0)—non wire frame body

Input Type

Input: string	iFilePath - Full Path of the File without extension
Input: interop.CimMdlrAPI.BOMTemplateType	iType - Type of the template. cmXlsx Excel Files, cmXlsm Excel Files with Macro, cmRepx Multi Format,cmCSV CSV Files
Input: interop.CimMdlrAPI.BOMExportOptions	iExportOption - Choose Export option. Use can set Multiple option.
Input: string	iTemplateName - Name of the Template.
Input: interop.CimMdlrAPI.BOMReportFormat	Input: iReportFormat - Report Format Option. This option is useful when the template type is multi format. For other format set this option to cmNotReq.
Input: interop.CimMdlrAPI.ComponentsFilterOption	iFilteringType - This is filtering option to export the bom. cmNoFiltering = All entities are exported to Bom, cmVisibleOnly = Only visible Entities will be exported to Bom, cmByFolderorSubAssembly = Only Folder component will be export. Give names of the folder in the string array.
Input: string[]	iFolderNames - Varient that contains array of string of name of the folder

Remarks

None

Example

Example 1 - Export To CSV Format without filteringExample 1 - Export To CSV Format without filtering
interop.CimAppAccess.AppAccess aAppAccess = new interop.CimAppAccess.AppAccess();
interop.CimatronE.IApplication CimApp = (interop.CimatronE.IApplication)aAppAccess.GetActiveApplication();
interop.CimBaseAPI.ICimDocument aDoc = (interop.CimBaseAPI.ICimDocument)CimApp.GetActiveDoc();
interop.CimMdlrAPI.IModelContainer aContainer = (interop.CimMdlrAPI.IModelContainer)aDoc;
interop.CimMdlrAPI.IAssemblyModel aAssemblyModel = (interop.CimMdlrAPI.IAssemblyModel)aContainer.Model;
interop.CimBaseAPI.IModel aModel = (interop.CimBaseAPI.IModel)aAssemblyModel;
interop.CimMdlrAPI.IBOM aBOM = aAssemblyModel.GetBomManager();
string aPathWithFileName = @"C:\temp\BOM\CSV\Report";
aExportCheckBoxOptions = interop.CimMdlrAPI.BOMExportOptions.cmAddPictureToPartsOnReports
interop.CimMdlrAPI.BOMExportOptions.cmAddTimeStampToReportFileName;
aBOM.Export(aPathWithFileName, interop.CimMdlrAPI.BOMTemplateType.cmCSV, aExportCheckBoxOptions, "", interop.CimMdlrAPI.BOMReportFormat.cmNotReq, interop.CimMdlrAPI.ComponentsFilterOption.cmNoFiltering);
Example 2 - Export to Excel file includeing catalog componentsExample 2 - Export to Excel file includeing catalog components
interop.CimAppAccess.AppAccess aAppAccess = new interop.CimAppAccess.AppAccess();
interop.CimatronE.IApplication CimApp = (interop.CimatronE.IApplication)aAppAccess.GetActiveApplication();
interop.CimBaseAPI.ICimDocument aDoc = (interop.CimBaseAPI.ICimDocument)CimApp.GetActiveDoc();
interop.CimMdlrAPI.IModelContainer aContainer = (interop.CimMdlrAPI.IModelContainer)aDoc;
interop.CimMdlrAPI.IAssemblyModel aAssemblyModel = (interop.CimMdlrAPI.IAssemblyModel)aContainer.Model;
interop.CimBaseAPI.IModel aModel = (interop.CimBaseAPI.IModel)aAssemblyModel;
interop.CimMdlrAPI.IBOM aBOM = aAssemblyModel.GetBomManager();
string aPathWithFileName = @"C:\temp\BOM\ExcelFormat\Report_Bom_Standard";
string aTemplateName = "Bom_Standard";
interop.CimMdlrAPI.BOMExportOptions aExportCheckBoxOptions = interop.CimMdlrAPI.BOMExportOptions.cmAddPictureToPartsOnReports | interop.CimMdlrAPI.BOMExportOptions.cmIncludeCatalogComponents;
aBOM.Export(aPathWithFileName, interop.CimMdlrAPI.BOMTemplateType.cmXlsx, aExportCheckBoxOptions, aTemplateName, interop.CimMdlrAPI.BOMReportFormat.cmDocx);
Example 3 - Export Bom By Folder NamesExample 3 - Export Bom By Folder Names
interop.CimAppAccess.AppAccess aAppAccess = new interop.CimAppAccess.AppAccess();
interop.CimatronE.IApplication CimApp = (interop.CimatronE.IApplication)aAppAccess.GetActiveApplication();
interop.CimBaseAPI.ICimDocument aDoc = (interop.CimBaseAPI.ICimDocument)CimApp.GetActiveDoc();
interop.CimMdlrAPI.IModelContainer aContainer = (interop.CimMdlrAPI.IModelContainer)aDoc;
interop.CimMdlrAPI.IAssemblyModel aAssemblyModel = (interop.CimMdlrAPI.IAssemblyModel)aContainer.Model;
interop.CimBaseAPI.IModel aModel = (interop.CimBaseAPI.IModel)aAssemblyModel;
interop.CimMdlrAPI.IBOM aBOM = aAssemblyModel.GetBomManager();
string aPathWithFileName = @"C:\temp\BOM\MultiFormat\BOM_Template";
interop.CimMdlrAPI.BOMExportOptions aExportCheckBoxOptions = interop.CimMdlrAPI.BOMExportOptions.cmAddPictureToPartsOnReports;
List<string> aFolderNameList = new List<string>();
aFolderNameList.Add("Folder");
aFolderNameList.Add("Folder2");
string aTemplateName = "BOM_Template";
aBOM.Export(aPathWithFileName, interop.CimMdlrAPI.BOMTemplateType.cmRepx, aExportCheckBoxOptions, aTemplateName, interop.CimMdlrAPI.BOMReportFormat.cmPdf, interop.CimMdlrAPI.ComponentsFilterOption.cmByFolderorSubAssembly, aFolderNameList.ToArray());

Example 1 - Export Bom To CSV FormatExample 1 - Export Bom To CSV Format
import clr
clr.AddReference("interop.CimAppAccess")
clr.AddReference("interop.CimatronE")
clr.AddReference("interop.CimServicesAPI")
clr.AddReference("interop.CimBaseAPI")
clr.AddReference("interop.CimMdlrAPI")
clr.AddReference("interop.CimNcAPI")
import interop.CimAppAccess
import interop.CimatronE
import interop.CimServicesAPI
import interop.CimBaseAPI
import interop.CimMdlrAPI
import interop.CimNcAPI
import System
aAppAcc = interop.CimAppAccess.AppAccess()
aCimApp = interop.CimatronE.IApplication(aAppAcc.GetApplication())
aDOC = aCimApp.GetActiveDoc()
aContainer = interop.CimMdlrAPI.IModelContainer(aDOC)
aAssemblyModel = interop.CimMdlrAPI.IAssemblyModel(aContainer.Model)
aBOM = aAssemblyModel.GetBomManager()
aPathWithFileName = "C:\\temp\\BOM\\CSV\\Report"
aExportCheckBoxOptions = interop.CimMdlrAPI.BOMExportOptions.cmAddPictureToPartsOnReports
interop.CimMdlrAPI.BOMExportOptions.cmAddTimeStampToReportFileName
aBOM.Export(aPathWithFileName, interop.CimMdlrAPI.BOMTemplateType.cmCSV, aExportCheckBoxOptions, "", interop.CimMdlrAPI.BOMReportFormat.cmNotReq, interop.CimMdlrAPI.ComponentsFilterOption.cmNoFiltering)
Example 2 - Export Bom to HtmlExample 2 - Export Bom to Html
import clr
clr.AddReference("interop.CimAppAccess")
clr.AddReference("interop.CimatronE")
clr.AddReference("interop.CimServicesAPI")
clr.AddReference("interop.CimBaseAPI")
clr.AddReference("interop.CimMdlrAPI")
clr.AddReference("interop.CimNcAPI")
import interop.CimAppAccess
import interop.CimatronE
import interop.CimServicesAPI
import interop.CimBaseAPI
import interop.CimMdlrAPI
import interop.CimNcAPI
import System
aAppAcc = interop.CimAppAccess.AppAccess()
aCimApp = interop.CimatronE.IApplication(aAppAcc.GetApplication())
aDOC = aCimApp.GetActiveDoc()
aContainer = interop.CimMdlrAPI.IModelContainer(aDOC)
aAssemblyModel = interop.CimMdlrAPI.IAssemblyModel(aContainer.Model)
aBOM = aAssemblyModel.GetBomManager()
aPathWithFileName = "C:\\temp\\BOM\\ExcelFormat\\Report_Bom_Standard"
aTemplateName = "BOM_Template"
aExportCheckBoxOptions = interop.CimMdlrAPI.BOMExportOptions.cmAddPictureToPartsOnReports | interop.CimMdlrAPI.BOMExportOptions.cmIncludeCatalogComponents
aBOM.Export(aPathWithFileName, interop.CimMdlrAPI.BOMTemplateType.cmRepx, aExportCheckBoxOptions, aTemplateName, interop.CimMdlrAPI.BOMReportFormat.cmHtml);
Example 3 - Export Bom for Visible Components onlyExample 3 - Export Bom for Visible Components only
import clr
clr.AddReference("interop.CimAppAccess")
clr.AddReference("interop.CimatronE")
clr.AddReference("interop.CimServicesAPI")
clr.AddReference("interop.CimBaseAPI")
clr.AddReference("interop.CimMdlrAPI")
clr.AddReference("interop.CimNcAPI")
import interop.CimAppAccess
import interop.CimatronE
import interop.CimServicesAPI
import interop.CimBaseAPI
import interop.CimMdlrAPI
import interop.CimNcAPI
import System
aAppAcc = interop.CimAppAccess.AppAccess()
aCimApp = interop.CimatronE.IApplication(aAppAcc.GetApplication())
aDOC = aCimApp.GetActiveDoc()
aContainer = interop.CimMdlrAPI.IModelContainer(aDOC)
aAssemblyModel = interop.CimMdlrAPI.IAssemblyModel(aContainer.Model)
aBOM = aAssemblyModel.GetBomManager()
aPathWithFileName = "C:\\temp\\BOM\\MultiFormat\\BOM_Template"
aTemplateName = "BOM_Template"
aExportCheckBoxOptions = interop.CimMdlrAPI.BOMExportOptions.cmAddPictureToPartsOnReports | interop.CimMdlrAPI.BOMExportOptions.cmAddTimeStampToReportFileName;
aBOM.Export(aPathWithFileName, interop.CimMdlrAPI.BOMTemplateType.cmRepx, aExportCheckBoxOptions ,aTemplateName, interop.CimMdlrAPI.BOMReportFormat.cmPdf, interop.CimMdlrAPI.ComponentsFilterOption.cmVisibleOnly);