Description
ExcelDataWriter is a design found in *ExcelUtilities. This design is used to organize and output to a Microsoft Excel Worksheet.
*Note: ExcelUtilities is a shared project which is found in EI Utilities which is a shared folder.
Parameter Rules
inputArray: | This is a Data Array supplied in the child tab by the user. |
Example: | [["Order Tab:", "0001"], ["Customer:", "John Smith"]] |
newWorkbook: | This creates a Workbook from the ‘inputArray’ rule. |
Default Value: | var obj = this.createWorkbookFromArray(this.inputArray); |
return obj; |
outputFile: | This gets the output File from the outputFileName. |
(No user input needed). |
Example: | C:\cbc\k4outputs\78314150-169a-11ea-87c1-6d4a9895c99b\4c9489fc530a03ade11fed2caa21b68b\output.xlsx |
outputFileLink: | This produces an out put file link. |
(No user input needed). |
Example: | https://knowledgebridge.engineer:8443/78314150-169a-11ea-87c1-6d4a9895c99b//8fcc74ebf274e52c416d86c0bb0b0e93/output.xlsx |
outputFileName: | Enter desired output name. |
Example: | 'output.xlsx' |
writeNewWorkbookToFile: | This writes an Excel file. In your model while in Excel in the Model tab, Click on writeNewWorkbookToFile value. |
It will display ‘true’. This needs to happen before you can output a file link. |
Example: | true |
Mixins
BaseAssembly
RULE NAME |
TYPE |
DEFAULTS |
CATEGORY |
FLAGS |
---|---|---|---|---|
inputArray |
Array |
[[],[]] |
ExcelDataWriter |
Cached |
newWorkbook |
Any |
var obj = this.createWorkbookFrom Array (this.inputArray); return obj; |
ExcelDataWriter |
Cached |
outputFile |
String |
R.getOutputFile (this.outputFileName); |
ExcelDataWriter |
Cached |
outputFileLink |
String |
R.getOutputUrl (this.outputFile); |
ExcelDataWriter |
Cached |
outputFileName
|
String |
'output.xlsx' |
ExcelDataWriter |
Cached |
writeNewWorkbookToFile |
Any |
return this.writeExcelFile (this.newWorkbook, this.outputFile); |
ExcelDataWriter |
Cached |
Project Example:
In your kBridge Examples Projects folder open the project called ‘Table_KB_Inventor_Example’.
Reference Location:
"world.tableapplication1.drawingdocumenttable.drawingdocumenttable0.exceltable.exceltable0"
Link: https://knowledgebridge.engineer/projects
Note that ExcelDataWriter is used as the mixin for a design called ExcelUtilities and ExcelUtilities is a mixin of ExcelTable in this example.
See ‘Microsoft Excel Integration Exercise’ for more detailed information.