Altova EBA Add-in for Excel, Version 2023r2 Enterprise Edition

IAutomationAPI

The IAutomationAPI interface is the main automation interface of the EBA Add-in. This interface is the starting point for doing any further operations with the add-in. This interface allows you to create, import and export reports, read and write data. For information about creating an instance of this interface, see Accessing the API.

Methods

The IAutomationAPI interface allows you to use the following methods:

Use this method to insert a new report of the respective taxonomy entry point.

Signature

InsertNewReport(in entryPointUrl:String) -> Microsoft.Office.Interop.Excel.Workbook

Parameters

Name	Type	Description
entryPointUrl	String	The URI of the taxonomy a report should be created for. Use the GetEntryPointTree method to get the available entry points.

Imports an XBRL report. Returns the Excel workbook that contains the imported XBRL report.

Signature

ImportXBRL(in inputFile:String) -> Microsoft.Office.Interop.Excel.Workbook

Parameters

Name	Type	Description
inputFile	String	The path to the XBRL report which should be imported.

Exports the report from the respective Excel workbook to XBRL and also validates it. To get the validation results, call GetValidationReport after calling this method. You can get the file name by using the GetReportBaseName method.

Signature

ExportXBRL(workbook as Microsoft.Office.Interop.Excel.Workbook, outputFile as String) -> Void

Parameters

Name	Type	Description
workbook	Microsoft.Office.Interop.Excel.Workbook	The Excel workbook to be exported.
outputFile	String	The path to the output XBRL file.

Exports the report from the respective Excel workbook to the XBRL-CSV report package and validates it. To get the validation results, call GetValidationReport after calling this method.

Signature

ExportXBRL_CSV(in workbook:Microsoft.Office.Interop.Excel.Workbook, in outputFile:String) -> Void

Parameters

Name	Type	Description
workbook	Microsoft.Office.Interop.Excel.Workbook	The Excel workbook to be exported.
outputFile	String	The path to the output XBRL-CSV report package file.

Validates the current report. To get the validation results, call GetValidationReport after calling this method.

Signature

Validate(in workbook:Microsoft.Office.Interop.Excel.Workbook) -> Void

Parameters

Name	Type	Description
workbook	Microsoft.Office.Interop.Excel.Workbook	The Excel workbook to be validated.

Returns an IValidationReport object representing the validation report currently shown in the validation report pane.

Signature

GetValidationReport(in workbook:Microsoft.Office.Interop.Excel.Workbook) -> IValidationReport

Parameters

Name	Type	Description
workbook	Microsoft.Office.Interop.Excel.Workbook	The Excel workbook from which to get the validation report.

Returns an ITableTree object representing the tree of the available tables in the report opened in the specified Excel workbook.

Signature

GetTableTree(in workbook:Microsoft.Office.Interop.Excel.Workbook) -> ITableTree

Parameters

Name	Type	Description
workbook	Microsoft.Office.Interop.Excel.Workbook	The Excel workbook containing the XBRL report.

Returns an IReportProperties object providing the properties of the XBRL report.

Signature

GetReportProperties(in workbook:Microsoft.Office.Interop.Excel.Workbook) -> IReportProperties

Parameters

Name	Type	Description
workbook	Microsoft.Office.Interop.Excel.Workbook	The workbook containing the XBRL report.

Returns an IFormProperties object providing the properties of the XBRL form in the specified Excel worksheet.

Signature

GetFormProperties(in worksheet:Microsoft.Office.Interop.Excel.Worksheet) -> IFormProperties

Parameters

Name	Type	Description
worksheet	Microsoft.Office.Interop.Excel.Worksheet	An Excel worksheet containing an XBRL form.

Returns an ICellProperties object providing the properties of the fact in the specified Excel range.

Signature

GetCellProperties(in cell:Microsoft.Office.Interop.Excel.Range) -> ICellProperties

Parameters

Name	Type	Description
cell	Microsoft.Office.Interop.Excel.Range	An Excel cell containing an XBRL fact (must be within the data range of a form).

Returns the file name that Excel provides automatically when you export an XBRL file (via the ExportXBRL method) from an Excel workbook.

Signature

GetReportBaseName(workbook as Excel.Workbook) -> String

Parameters

Name	Type	Description
workbook	Excel.Workbook	The name of the XBRL file exported via the ExportXBRL method.