ReportMagic

[Sql.Analysis:]

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 a Database 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 must enable XLSX output on the Schedule in order to generate the output file. This macro cannot be run unless the Schedule is locked by an Admin ("admin-locked"). This also means that in Report Studio, only Admins can run this macro.

Parameters (31)

Grouped View

Mandatory (1)

Parameter	Type	Purpose	Options	Default
sql	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 (5)5 additional

Parameter	Type	Presence	Purpose	Options	Default
maxAttempts	Int32	Optional	The maximum number of attempts when requesting data.	From 1 to 100	1
maxTotalTimeoutMs	Int32	Optional	The maximum total time in milliseconds across all attempts. If not set, no total time cap is applied. The maximum value is 86400000 (1 day).	From 1 to 86400000	N/A
removeNewlineCharacters	Boolean	Optional	Whether to remove newline characters in the SQL before sending.	true false	false
retryIntervalSeconds	Double	Optional	The number of seconds to wait between retry attempts. The maximum value is 3600 (1 hour).	From 0 to 3600	1
timeoutMs	Int32	Optional	The timeout in milliseconds. Overrides the Connection's 'timeoutMs' parameter, if set.	N/A	N/A

Additional (5)

Parameter	Type	Presence	Purpose	Options	Default
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
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 theObject, 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
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

Chart (1)

Parameter	Type	Presence	Purpose	Options	Default
addChart	Boolean	Optional	Whether to add a chart to the Analytics worksheet.	true false	false

Filtering & Sorting (2)

Parameter	Type	Presence	Purpose	Options	Default
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
pivotTableFilterFields	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 (2)

Parameter	Type	Presence	Purpose	Options	Default
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
failureVariable	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 (7)5 additional

Parameter	Type	Presence	Purpose	Options	Default
addTitle	Boolean	Optional	Whether to add a title to the Analytics worksheet.	true false	false
columnGrandTotals	Boolean	Optional	Whether to add column grand totals to the pivot table.	true false	false
pivotTableColumnFields	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
pivotTableRowFields	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
pivotTableValueFields	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
rowGrandTotals	Boolean	Optional	Whether to add row grand totals to the pivot table.	true false	false
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

Additional (5)

Parameter	Type	Presence	Purpose	Options	Default
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
desiredExecutionResult	ExecutionResult	Optional	If specified, asserts the expected execution result of the macro. The macro executes normally; if the actual result matches the desired value, 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, Stopped.	Cancelled Deferred MacroError NeverRun Paused Pending Running Stopped Success SystemError Warning WorkerStopped	N/A
expectedType	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
expectedValue	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

Deprecated (4)

Parameter	Type	Preferred Parameter	Purpose	Options	Default
columnFields	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
filterFields	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
rowFields	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
valueFields	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

[Sql.Analysis: sql = `SELECT * FROM "People"`worksheetName=worksheet1]

Purpose

Compatibility

Usage

Examples (1)

Example 1

Search