ReportMagic

[CloudHealth.AvailableReportDimensions:]

Lists the available CloudHealth report dimensions for the specified organisation or client API ID.

Purpose

Lists the available CloudHealth report dimensions (or measures, or intervals, or everything) for the specified organisation or client API ID.

Compatibility

The macro can be used in all input document types and in Report Studio.

Usage

Returns a JArray in Normal Mode, or the string representation of a JArray in Legacy Mode. When 'reportType' is set to 'all', a JObject is returned.

Parameters (28)

Grouped View

Mandatory (2)

Parameter	Type	Purpose	Options	Default
reportId	String	The report ID (which is NOT a number!), such as 'history'.	N/A	N/A
reportType	String	The report type, such as 'cost', 'custom', or 'performance'.	N/A	N/A

Behaviour (6)

Parameter	Type	Presence	Purpose	Options	Default
hidden	Boolean	Optional	Whether to hide the macro output.	true false	false
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
redact	Boolean	Optional	Whether substituted variables are hidden from macro results (and the word 'REDACTED' will appear in progress screens and elsewhere in the web UI).	true false	false
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

Colours (3)

Parameter	Type	Presence	Purpose	Options	Default
colorTableCell	Boolean	Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
fontBackgroundColor	Color	Optional	The font background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontColor	Color	Optional	The font color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A

Formatting (2)

Parameter	Type	Presence	Purpose	Options	Default
fontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fontSize	Double	Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A

Output (5)

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
storeAs	String	Optional	The variable to store the result as.	N/A	N/A
storeAsHidden	String	Optional	The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'.	N/A	N/A
storeFormattedValueAs	String	Optional	The name of the STRING variable to store the result as and output (both will use the same format) into the report. Note that if you also use 'storeAsHidden' in the same macro, you should not expect the output to be hidden, as this parameter overrides that.	N/A	N/A

General (6)4 additional

Parameter	Type	Presence	Purpose	Options	Default
reportId	String	Mandatory	The report ID (which is NOT a number!), such as 'history'.	N/A	N/A
reportType	String	Mandatory	The report type, such as 'cost', 'custom', or 'performance'.	N/A	N/A
clientApiId	String	Conditional	The client API ID. Use either this or 'orgId', but not both.	N/A	N/A
orgId	String	Conditional	The organisation ID. Use either this or 'clientApiId', but not both.	N/A	N/A
connectionName	String	Optional	The name of the CloudHealth Connection.	N/A	N/A
tokenType	TokenType	Optional	Which item you want returned in the results.	Dimensions All Measures Intervals	Dimensions

Additional (4)

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
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 (2)

Parameter	Type	Preferred Parameter	Purpose	Options	Default
organisationId	String	orgId	The organisation ID. Use either this or 'clientApiId', but not both.	N/A	N/A
organizationId	String	orgId	The organisation ID. Use either this or 'clientApiId', but not both.	N/A	N/A

Examples (3)

Example 1Normal mode

[CloudHealth.OrganisationList: storeAsHidden=Organisations, mode=Normal]
[ForEach: values={=Organisations}, =>Org]
ID of the CloudHealth Org: [.:Org.id, storeAs=ID_1] 
Name of the CloudHealth Org: [.:Org.name, storeAs=NAME_1][CloudHealth.AvailableReportsList: orgId={ID_1}, storeAsHidden=Report_Names_{ID_1}, mode=Normal][ForEach: values={=Report_Names_{ID_1}}, =>ReportName, take=5]
The Report Options for [String: value={ReportName}] are:
[CloudHealth.AvailableReportOptions: orgId={ID_1}, reportType={ReportName}, storeAs=Report_Options_{ReportName}, mode=Normal][ForEach: values={=Report_Options_{ReportName}}, =>ReportOptions, take=5]

The Available Report Dimensions for "[String: value={ReportOptions}, find="{ReportName}/", replaceWith=, =>ReportOptions1]" are:
[CloudHealth.AvailableReportDimensions: orgId={ID_1}, reportType={ReportName}, reportId={ReportOptions1}, storeAs=Dimensions_{ID_1}_{ReportName}_{ReportOptions1}, failureText=No Dimensions]
[EndForEach:][EndForEach:][EndForEach:]

Example 2Normal mode

[CloudHealth.OrganisationList: storeAsHidden=Organisations, mode=Normal]
[ForEach: values={=Organisations}, =>Org]
ID of the CloudHealth Org: [.:Org.id, storeAs=ID_1] 
Name of the CloudHealth Org: [.:Org.name, storeAs=NAME_1][CloudHealth.AvailableReportsList: orgId={ID_1}, storeAsHidden=Report_Names_{ID_1}, mode=Normal][ForEach: values={=Report_Names_{ID_1}}, =>ReportName, take=5]
The Report Options for [String: value={ReportName}] are: 
[CloudHealth.AvailableReportOptions: orgId={ID_1}, reportType={ReportName}, storeAs=Report_Options_{ReportName}, mode=Normal][ForEach: values={=Report_Options_{ReportName}}, =>ReportOptions, take=5]

The Available Report Dimensions for "[String: value={ReportOptions}, find="{ReportName}/", replaceWith=, =>ReportOptions1]" are:
[CloudHealth.AvailableReportDimensions: orgId={ID_1}, reportType={ReportName}, reportId={ReportOptions1}, storeAs=Dimensions_{ID_1}_{ReportName}_{ReportOptions1}, failureText=No Dimensions, tokenType=All]
[EndForEach:][EndForEach:][EndForEach:]

Example 3Normal mode

[CloudHealth.OrganisationList: storeAsHidden=Organisations, mode=Normal]
[ForEach: values={=Organisations}, =>Org]
ID of the CloudHealth Org: [.:Org.id, storeAs=ID_1] 
Name of the CloudHealth Org: [.:Org.name, storeAs=NAME_1][CloudHealth.AvailableReportsList: orgId={ID_1}, storeAsHidden=Report_Names_{ID_1}, mode=Normal][ForEach: values={=Report_Names_{ID_1}}, =>ReportName, take=5]
The Report Options for [String: value={ReportName}] are: 
[CloudHealth.AvailableReportOptions: orgId={ID_1}, reportType={ReportName}, storeAs=Report_Options_{ReportName}, mode=Normal][ForEach: values={=Report_Options_{ReportName}}, =>ReportOptions, take=5]

The Available Report Dimensions for "[String: value={ReportOptions}, find="{ReportName}/", replaceWith=, =>ReportOptions1]" are:
[CloudHealth.AvailableReportDimensions: orgId={ID_1}, reportType={ReportName}, reportId={ReportOptions1}, storeAs=Dimensions_{ID_1}_{ReportName}_{ReportOptions1}, failureText=No Dimensions, tokenType=Measures]
[EndForEach:][EndForEach:][EndForEach:]