Invoke Report Builder functionality from Microsoft Excel functions
This ability further integrates Report Builder usage within the natural Excel workflow, without requiring you to access the Report Builder user interface.
For example, you may want to automatically refresh Report Builder requests whose input filter is based on data pulled in Excel from other sources. You can now do this using the string RefreshRequestsInCellsRange(..) function. All calls are asynchronous. They return immediately and do not wait for a call to fully execute.
You must have Report Builder 5.0 (or later) installed for this functionality to work.
Here is a table with the list of exposed functions:
Refreshes all Report Builder requests present in a workbook.
string AsyncRefreshRange(string rangeAddressInA1Format)
Refreshes all Report Builder requests present in the specified cell range address (a string expression representing a range of cell in A1 format, for example "Sheet1!A2:A10").
Refreshes all Report Builder requests present in the specified cell range that is passed through the Alternative Text of the Ms Form Control.
Refreshes all Report Builder requests present in the active worksheet.
string AsyncRefreshWorksheet(string worksheetName)
Refreshes all Report Builder requests present in the specified worksheet (the worksheet name as it appears on the tab.)
Refreshes all Report Builder requests present in the specific worksheet name that was passed through the Alternative Text of the Ms Form Control
Returns a string that describes the status of the last run.
To access these functions within report builder, go to Formulas > Insert Function. At the bottom of the list of categories, you will find Adobe.ReportBuilder.Bridge:
Use these functions in a formula
For example, the formula
says "If the value in cell P5 is text or is blank, refresh the range that is in cell P9."
Use Report Builder functions with format control
You can now assign a macro to a control you created and that control can be a function that refreshes a workbook request. For example, the function AsyncRefreshActiveWorksheet will refresh all requests in a worksheet. Sometimes, though, you may want to refresh only certain requests, not all.
- Set the macro parameter.
- Right-click the control and select Assign Macro .
- Enter the report builder function name (no parameters or parentheses.)
Pass parameters to Report Builder functions via format control
The two functions that take a parameter can be used with Format Control, but only via the Alt Text field:
- AsyncRefreshRange(string rangeAddressInA1Format)
- AsyncRefreshWorksheet(string worksheetName)
- Right-click the control and select Format Control .
- Click the Alt Text tab.
- Under Alternative text, enter the cell range that you want refreshed.
- Open the list of report builder parameters under Formulas > Insert Function> Adobe.ReportBuilder.Bridge.
- Pick one of the two functions that end with AltTextParam and click OK .