---

Purpose

Adds an SQL Analysis tab to the XLSX output document. The query is executed via an Agent Connection.

---

Macro Compatibility

---

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.

---

Parameter	Type	Deprecation Message	Preferred Parameter	Presence	Purpose	Options	Default
connectionString	String			Mandatory	The SQL connection string (an SQL endpoint).	N/A	N/A
sql	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
addChart	Boolean			Optional	Whether to add a chart to the Analytics worksheet.	true false	false
addTitle	Boolean			Optional	Whether to add a title to the Analytics worksheet.	true false	false
columnFields	List<String>	Deprecated	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
columnGrandTotals	Boolean			Optional	Whether to add column grand totals to the pivot table.	true false	false
comment	String			Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
connectionName	String			Optional	The name of the Connection.	N/A	N/A
errorOnOverflow	Boolean			Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
failureText	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
filterFields	List<String>	Deprecated	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
if	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
mode	MacroMode			Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
obfuscation	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 UkTown DeviceName Company IpAddress PrivateIpAddress	None
pivotTableColumnFields	List<String>	Use instead of: columnFields		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
pivotTableFilterFields	List<String>	Use instead of: filterFields		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
pivotTableRowFields	List<String>	Use instead of: rowFields		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
pivotTableValueFields	List<String>	Use instead of: valueFields		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
removeNewlineCharacters	Boolean			Optional	Whether to remove newline characters in the SQL before sending.	true false	false
rowFields	List<String>	Deprecated	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
rowGrandTotals	Boolean			Optional	Whether to add row grand totals to the pivot table.	true false	false
serverType	SystemAccess.ServerType			Optional	The type of server.	Mssql None Postgres	Mssql
timeoutMs	Int32			Optional	The timeout in milliseconds.	From 1000 to 2147483647	60000
valueFields	List<String>	Deprecated	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
warning	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
worksheetName	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

---

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}]