[Agent.SqlAnalysis:]UPDATED
Adds an SQL Analysis tab to the XLSX output document.
This macro is partially execute-restricted. Details in the Usage or Parameters section. See Connection Role Security and Restricted Macros.
Purpose
Adds an SQL Analysis tab to the XLSX output document. The query is executed via an Agent Connection.
Compatibility
The macro can be used in the highlighted input document types only. A greyed-out icon indicates not supported.
Usage
Does not work in Report Studio. Note that you need to enable XLSX output on the Schedule in order to generate the output file. Queries that contains the following commands (case-insensitive) are execute-restricted - in this case ask your Tenant Admin to make the Schedule admin-locked, and ensure an Admin has made the Connection accessible to you. The restricted commands are: ADD, ALTER, APPEND, BACKUP, CREATE, DELETE, DROP, EXEC, INSERT, TRUNCATE, and UPDATE.
Updates
v4.6One month ago · August 2026
A pivot table value field that cannot be understood is now reported as a warning rather than being ignored in silence. Reports still run and their output is unchanged; the macro is flagged with a warning naming the field, so a mistyped field can be seen rather than having to be noticed as a missing column.
History (2)
v4.5One month ago · August 2026
A pivot table field name that does not match any column in the data now produces a warning naming it and the available columns, instead of being silently ignored.
One year ago · February 2025
The analysis pivot table can now be customised (column, filter, row and value fields).
Parameters
(30)
Mandatory (2)
| Parameter | Type | Purpose | Options | Default |
| String | The SQL connection string (an SQL endpoint). | N/A | N/A | |
| String | The SQL to execute. Queries that contains the following commands (case-insensitive) are execute-restricted - in this case ask your Tenant Admin to make the Schedule admin-locked, and ensure an Admin has made the Connection accessible to you. The restricted commands are: ADD, ALTER, APPEND, BACKUP, CREATE, DELETE, DROP, EXEC, INSERT, TRUNCATE, and UPDATE. | N/A | N/A |
Behaviour (2)8 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | Whether to remove newline characters in the SQL before sending. |
|
false | |
| Int32 | Optional | The timeout in milliseconds. |
|
60000 |
Additional (8)
| Parameter | Type | Presence | Purpose | Options | Default |
| List<ExecutionResult> | Optional | If specified, asserts the expected execution result of the macro. Accepts a single value or a semicolon-separated list of acceptable values (e.g. 'Success;Warning'). The macro executes normally; if the actual result matches any of the desired values, the result is converted to Success. If the actual result does not match, the result is converted to MacroError with a descriptive message. This is primarily used for testing and diagnostic purposes. Valid values are: 'Unknown', 'Success', 'MacroError', 'WorkerStopped', 'Running', 'Warning', 'NeverRun', 'Cancelled', 'Pending', 'Paused', 'SystemError', 'Deferred' and 'Stopped'. |
|
N/A | |
| Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
| String | Optional | If specified, asserts the expected output type of the macro result. The macro executes normally; if the actual type does not match, a macro error is generated. Requires 'storeAs', 'storeAsHidden', or 'storeFormattedValueAs' to be set for typed validation. Valid types include CLR names (e.g. Int32, Int64, Single, Double, Boolean, String, JArray, JObject) and C# keyword aliases (e.g. int, long, float, double, bool, string, uint, ulong, short, ushort, byte, sbyte, decimal, char, object). The special value 'Number' matches any numeric type. | N/A | N/A | |
| String | Optional | If specified, asserts the expected output value of the macro result. The macro executes normally; if the actual value does not match, a macro error is generated. When 'storeAs' or 'storeAsHidden' is set, the stored variable value is compared. Otherwise, the document output text is compared. | N/A | N/A | |
| String | Optional | The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z')". | N/A | true | |
| MacroMode | Optional | The mode in which variables are stored. In legacy mode (default for Schedules), the variable created is a string and formatted. In normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a JArray etc., rather than a formatted string. |
|
Legacy | |
| ObfuscationType | Optional | Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen. |
|
None | |
| String | Optional | If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression. | N/A | N/A |
Filtering & Sorting (2)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Mandatory | The SQL to execute. Queries that contains the following commands (case-insensitive) are execute-restricted - in this case ask your Tenant Admin to make the Schedule admin-locked, and ensure an Admin has made the Connection accessible to you. The restricted commands are: ADD, ALTER, APPEND, BACKUP, CREATE, DELETE, DROP, EXEC, INSERT, TRUNCATE, and UPDATE. | N/A | N/A | |
| List<String> | Optional | The pivot table filter fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Filters' section. These should be from the header row e.g. from A^B^C;1^2^3;4^5^6, this may be A;B. | N/A | N/A |
Output (1)2 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | The name to use for the analytics worksheet (which will contain the pivot table and chart). The data worksheet (which will contain the 'fact table') uses this name plus the suffix ' Data'. If a worksheet by this name already exists, the new name will have a number appended, e.g. Analytics1, Analytics2, etc. Excel does not allow blank names, names above 31 characters, and the following characters: :, /, \, ?, *, [, ]. | N/A | SQL Analytics |
Additional (2)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message. | N/A | N/A | |
| String | Optional | The name of a variable to create should the macro fail to execute. The variable will be a text variable, and will contain either the failure text (only if the failureText parameter is set), otherwise it will contain the exception / failure message. | N/A | N/A |
General (8)2 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Mandatory | The SQL connection string (an SQL endpoint). | N/A | N/A | |
| Boolean | Optional | Whether to add a title to the Analytics worksheet. |
|
false | |
| Boolean | Optional | Whether to add column grand totals to the pivot table. |
|
false | |
| List<String> | Optional | The pivot table column fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Columns' section. These should be from the header row e.g. from A^B^C;1^2^3;4^5^6, this may be A;B. | N/A | N/A | |
| List<String> | Optional | The pivot table row fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Rows' section. These should be from the header row e.g. from A^B^C;1^2^3;4^5^6, this may be A;B. | N/A | N/A | |
| List<String> | Optional | The pivot table value fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Values' section. For each column name, you can specify the aggregation to use via the ^ character e.g. column1^Sum. Omit this to use the default Count aggregation. Valid aggregation values are: 'Average', 'Count', 'CountNumbers', 'Max', 'Min', 'Product', 'StdDev', 'StdDevP', 'Sum', 'Var' or 'VarP'. For each column name, if and only if you have specified an aggregation, you can also specify the number format to use in the pivot table and chart. To do this, use an additional caret separator and specify the number format. For example: column1^Sum^0.00 would use 2 decimal places for the format. These should be from the header row e.g. from A^B^C;1^2^3;4^5^6, this may be B;C. | N/A | N/A | |
| Boolean | Optional | Whether to add row grand totals to the pivot table. |
|
false | |
| ServerType | Optional | The type of server. |
|
Mssql |
Deprecated (4)
| Parameter | Type | Preferred Parameter | Purpose | Options | Default |
| List<String> | pivotTableColumnFields | The pivot table column fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Columns' section. These should be from the header row e.g. from A^B^C;1^2^3;4^5^6, this may be A;B. | N/A | N/A | |
| List<String> | pivotTableFilterFields | The pivot table filter fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Filters' section. These should be from the header row e.g. from A^B^C;1^2^3;4^5^6, this may be A;B. | N/A | N/A | |
| List<String> | pivotTableRowFields | The pivot table row fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Rows' section. These should be from the header row e.g. from A^B^C;1^2^3;4^5^6, this may be A;B. | N/A | N/A | |
| List<String> | pivotTableValueFields | The pivot table value fields. In Excel's PivotTable Fields UI, these correspond to the items in the 'Values' section. For each column name, you can specify the aggregation to use via the ^ character e.g. column1^Sum. Omit this to use the default Count aggregation. Valid aggregation values are: 'Average', 'Count', 'CountNumbers', 'Max', 'Min', 'Product', 'StdDev', 'StdDevP', 'Sum', 'Var' or 'VarP'. For each column name, if and only if you have specified an aggregation, you can also specify the number format to use in the pivot table and chart. To do this, use an additional caret separator and specify the number format. For example: column1^Sum^0.00 would use 2 decimal places for the format. These should be from the header row e.g. from A^B^C;1^2^3;4^5^6, this may be B;C. | N/A | N/A |
Examples (1)
Example 1
Set a connection string, then use it in the macro:
[String:value="Username=XXXXXX;Password=XXXXXX;Host=XXXXXX.com;Database=XXXXXX", storeAsHidden=myconnection][Agent.SqlAnalysis: sql=`SELECT * FROM "People"`, worksheetName=worksheet1,connectionString={myconnection}]
