Functions
Auto-generation
The ArupCompute Excel plugin automatically generates unique Excel functions for each ArupCompute endpoint based upon which libraries you have enabled.
The functions are generated each time you restart Excel meaning that you instantly have access to new and updated functions.
Because the library of functions is always growing we cannot list them all here, however they all follow the same format, are used the same way, and provide all relevant information as tooltips within Excel.
The general format of the functions are =<LibraryName>.<FolderName>.<SubFolderName1>..<SubfolderNameN>.<CalculationName>_<AutoGeneratedDistinguisher>(...
For instance for the SampleLibrary calculation 'BasicCalc':
- LibraryName = SampleLibrary
- FolderName = Examples
- SubFolderName1 = BasicUse
- No further subfolders
- CalculationName = BasicCalc
- AutoGeneratedDistinguisher = 3b4bb
And so to use the calculation we can just type =SampleLibrary.Examples.BasicUse.BasicCalc_3b4bb(...
Excel searches through all the available functions based on what you type, so instead of typing out the full thing you could just start typing BasicCalc and then choose from the proposed list with the arrow keys and tab to select.
Reference
| Argument | Type | Description |
|---|---|---|
| autogenerated | many | Auto-generated inputs for the chosen function. Refer to tooltips. |
| EWR cell | text | (Optional) If a cell reference (e.g. "B2") is provided error, warning or remark messages will be printed to the indicated cell instead of overwriting the current cell. Refer to this guidance for further details. |
| Output | text | (Optional) When there are many results, enter which you are interested in returning here. Alternatively enter 'report' to get the plain text report, 'report_HTML' to get the HTML version of the report, or 'JSON' to get the API response in JSON format |
| Filepath | filepath | (Optional) When 'report_HTML' or 'JSON' chosen as the Output option this argument must specify a filepath to save the data to. |
The EWR cell must be provided as text. If a cell is clicked on it is the content of the cell that will be used, rather than the address of the cell.