Quick StartThe ReportMagic MenuSchedulesBatch JobsReport StudioFilesProfileAdminAccount DetailsMeraki WebHooksGetting StartedAbout ReportMagicRegistering and Logging InSearching ReportMagicConnections and AgentsWriting ReportsStarting Out With Report StudioCreating Report TemplatesRMScriptMacro ShorthandReporting on Different Periods of TimeSetting Macro Parameter DefaultsStoring Input and Output FilesReport VariablesUsing Variable ParametersSpecifying How Graphs LookStep-by-Step LogicMonitor Graph ExamplesStep-by-Step Jira Graph ExamplesSpecifying How Tables LookChanging Fonts and ColorsUsing Macros in PowerPoint TemplatesRestricted MacrosGenerating Reports Using SchedulesUsing HTML Forms in SchedulesSeeing How Reports RanViewing ReportsCached ValuesUsing AggregationsAdvanced Report StudioAPI AccessREST APIREST API - FilesAdvancedRole-Based Access Control (RBAC)SecurityMiscellaneousBadgesCertificationsTips, Tricks and Shortcut KeysMacrosAgentAgent.ConnectionAgent.ExecuteAgent.MonitorMagicNodeListAgent.MonitorMagicNodeMeasurementListAgent.MonitorMagicNodeMeasurementSummaryAgent.MonitorMagicNodePropertyListAgent.MonitorMagicNodeTypeListAgent.PropertyAgent.SqlAnalysisAgent.SqlGraphAgent.SqlListAgent.SqlTableAgent.SqlValueAgent.SqlValuesAgent.WebQueryAlertMagicAlertMagic.MetricsGraphAlertMagic.MetricsListAutoTaskAutoTask.AccountListAutoTask.AccountPropertyAutoTask.ConnectionAutoTask.CountAutoTask.FieldListAutoTask.FieldPropertyAutoTask.ListAutoTask.PropertyAutoTask.SummaryValueAutoTask.TicketListAutoTask.TicketPropertyAzureAzure.ConnectionAzure.LogAnalyticsGraphAzure.LogAnalyticsQueryAzure.LogAnalyticsScalarAzure.LogAnalyticsTableAzure.ResourceGroupListAzure.ResourceListAzure.ResourcePropertiesAzure.SentinelAlertRuleListAzure.SentinelConnectorListAzure.SentinelIncidentListAzure.SentinelThreatIndicatorListAzure.SentinelThreatIndicatorMetricListAzure.SubscriptionListBloggerBlogger.BlogPropertyBlogger.ConnectionBlogger.PageBlogger.PageListBlogger.PagePropertyBlogger.PostBlogger.PostListBlogger.PostPropertyCacheCache.ExpiresCache.GetCache.IsSetCache.SetCache.UnsetCertifyCertify.ConnectionCertify.DepartmentListCertify.DepartmentPropertyCherwellCherwell.BusinessObjectDefinitionListCherwell.BusinessObjectListCherwell.BusinessObjectSchemaCherwell.BusinessObjectSummaryCherwell.ConnectionCiscoCisco.ConnectionCisco.FirmwareVersionPropertyCisco.SecurityAdvisoryListCisco.SerialNumberPropertyCisco.SoftwareSuggestionListCiscoDnaCenterCiscoDnaCenter.ConnectionCiscoDnaCenter.SiteListCiscoDnaCenter.SitePropertyCloudHealthCloudHealth.AssetDetailsCloudHealth.AssetListCloudHealth.AvailableReportDimensionsCloudHealth.AvailableReportOptionsCloudHealth.AvailableReportsListCloudHealth.AwsAccountDetailsCloudHealth.AwsAccountsListCloudHealth.ConnectionCloudHealth.CustomerDetailsCloudHealth.CustomerListCloudHealth.CustomerReportDetailsCloudHealth.CustomerStatementDetailsCloudHealth.OrganisationAccountsListCloudHealth.OrganisationListCloudHealth.QueryConnectWiseManageConnectWiseManage.ConnectionConnectWiseManage.CountConnectWiseManage.DictionaryConnectWiseManage.ListConnectWiseManage.PropertyCoreArrayArray.CountBreakBreakpointCalculateColorCommentContinueConvertDeleteDeleteRowDocumentBookmarkDocumentBreakDocumentInsertSectionDocumentSectionEmailEmailFileEmailReportExecuteForEachFormatTableCellFormatTableRowIfIgnoreIncInsertTableCellImageIsSetLinearRegressionLinkMapObjectRandomRegexRepeatRowSearchAndReplaceSectionSettingsSleepStopStopwatchStringStringIndexSubstringSwitchThrowExceptionUnsetWarningDatabaseDatabase.ConnectionDatabase.GraphDatabase.ListDatabase.TableDatabase.ValueDatabase.ValuesDataMagicDataMagic.SyncDictionaryDictionary.ItemDictionary.KeysDictionary.ValuesDocumentDocument.SetPropertiesFileFile.CopyFile.CopyOutputFilesFile.Csv.CellFile.Csv.RowFile.Csv.RowCountFile.Csv.TableFile.EmbedFile.ExecuteFile.ExistsFile.ImageFile.InsertFile.ListFile.LoadListFile.LoadObjectFile.LoadStringFile.LoadVariablesFile.Xlsx.CellFile.Xlsx.RowFile.Xlsx.RowCountFile.Xlsx.TableFunctionFunction.CallFunction.DefineGoogleGoogle.ConnectionGoogle.TableGraphGraph.AddDataGraph.DeleteDataGraph.RenameDataGraph.UpdateGravatarGravatar.ImageHighlightHighlight.BearerSummaryHighlight.BroadbandSummaryHighlight.CellularSummaryHighlight.ConnectionHighlight.FolderListHighlight.HttpServerPerformanceSummaryHighlight.IcmpTcpUdpPerformanceSummaryHighlight.MosPerformanceSummaryHighlight.PrecisionPerformanceSummaryHighlight.TunnelSummaryHighlight.WatchNodeListHighlight.WirelessAccessPointSummaryHubSpotHubSpot.ListJarrayJarray.TableJiraJira.AttachmentImageJira.AttachmentListJira.AttachmentPropertyJira.ConnectionJira.GraphJira.InsertMarkupJira.IssueAnalysisJira.IssueCommentListJira.IssueCommentPropertyJira.IssueLastCommentPropertyJira.IssueListJira.IssuePropertyJira.IssueResponseTimeJira.LastImageJira.StatusListJira.TableJira.TimeInStateJira.UserListJira.UserPropertyJsonJson.ItemJson.ListKrokiKroki.ImageListList.AddList.AnalysisList.ComplementList.CountList.DequeueList.DuplicatesList.FirstList.GraphList.GroupByList.IndicesOfList.IntersectionList.ItemList.RangeList.SelectList.SelectColumnsList.SortList.SummaryValueList.TableList.UnionList.WhereLogicMonitorLogicMonitor.AccountPropertyLogicMonitor.AlertAnalysisLogicMonitor.AlertCalendarLogicMonitor.AlertCountLogicMonitor.AlertListLogicMonitor.AlertMapLogicMonitor.AlertPropertyLogicMonitor.AlertRuleListLogicMonitor.AlertRulePropertyLogicMonitor.AlertStatusLogicMonitor.AlertTableLogicMonitor.AppliesToFunctionListLogicMonitor.AppliesToFunctionPropertyLogicMonitor.AppliesToListLogicMonitor.AuditEventAnalysisLogicMonitor.BigNumberWidgetValuesLogicMonitor.ClearCacheLogicMonitor.CollectorExecuteLogicMonitor.CollectorGroupListLogicMonitor.CollectorGroupPropertyLogicMonitor.CollectorListLogicMonitor.CollectorPropertyLogicMonitor.CollectorVersionListLogicMonitor.CollectorVersionPropertyLogicMonitor.ConfigCheckListLogicMonitor.ConfigCheckPropertyLogicMonitor.ConfigSourceGroupListLogicMonitor.ConfigSourceListLogicMonitor.ConfigSourcePropertyLogicMonitor.ConfigSourceXmlLogicMonitor.ConnectionLogicMonitor.ConnectionApiTokenLogicMonitor.ConvertToLiveWidgetLogicMonitor.DashboardLogicMonitor.DashboardGroupListLogicMonitor.DashboardGroupPropertyLogicMonitor.DashboardListLogicMonitor.DashboardPropertyLogicMonitor.DashboardWidgetListLogicMonitor.DatamartSyncLogicMonitor.DataPointListLogicMonitor.DataPointPropertyLogicMonitor.DataSourceGraphListLogicMonitor.DataSourceGraphPropertyLogicMonitor.DataSourceGroupListLogicMonitor.DataSourceListLogicMonitor.DataSourcePropertyLogicMonitor.DataSourceXmlLogicMonitor.DeviceConfigSourceFileLogicMonitor.DeviceConfigSourceInstanceListLogicMonitor.DeviceConfigSourceListLogicMonitor.DeviceConfigSourcePropertyLogicMonitor.DeviceCountLogicMonitor.DeviceDataSourceListLogicMonitor.DeviceDataSourcePropertyLogicMonitor.DeviceGroupListLogicMonitor.DeviceGroupPropertyLogicMonitor.DeviceListLogicMonitor.DevicePropertyLogicMonitor.DeviceSlaWidgetPropertyLogicMonitor.DeviceTableLogicMonitor.EscalationChainDestinationListLogicMonitor.EscalationChainDestinationPropertyLogicMonitor.EscalationChainListLogicMonitor.EscalationChainPropertyLogicMonitor.EventSourceFilterListLogicMonitor.EventSourceFilterPropertyLogicMonitor.EventSourceGroupListLogicMonitor.EventSourceListLogicMonitor.EventSourcePropertyLogicMonitor.EventSourceXmlLogicMonitor.FinancialInformationLogicMonitor.ForecastLogicMonitor.GraphLogicMonitor.HistoricSdtListLogicMonitor.ImageLogicMonitor.InstanceAnalysisLogicMonitor.InstanceCountLogicMonitor.InstanceDetailsTableLogicMonitor.InstanceGroupCountLogicMonitor.InstanceGroupListLogicMonitor.InstanceListLogicMonitor.InstancePropertyLogicMonitor.IntegrationListLogicMonitor.IntegrationPropertyLogicMonitor.JobMonitorListLogicMonitor.JobMonitorPropertyLogicMonitor.LastMeasurementLogicMonitor.LogAnalysisLogicMonitor.LogicModuleMetadataPropertyLogicMonitor.LogicModuleUpdateListLogicMonitor.LogicModuleUpdatePropertyLogicMonitor.LogItemListLogicMonitor.NetscanGroupListLogicMonitor.NetscanGroupPropertyLogicMonitor.NetscanListLogicMonitor.NetscanPropertyLogicMonitor.NewUserMessagePropertyLogicMonitor.PaymentInformationLogicMonitor.PercentageAvailabilityLogicMonitor.PortalVersionLogicMonitor.PropertySourceGroupListLogicMonitor.PropertySourceJsonLogicMonitor.PropertySourceListLogicMonitor.PropertySourcePropertyLogicMonitor.QueryLogicMonitor.RecipientGroupListLogicMonitor.RecipientGroupPropertyLogicMonitor.RecycleBinItemListLogicMonitor.RecycleBinItemPropertyLogicMonitor.ReportGroupListLogicMonitor.ReportGroupPropertyLogicMonitor.ReportListLogicMonitor.ReportPropertyLogicMonitor.ResourceAnalysisLogicMonitor.ResourceGroupAnalysisLogicMonitor.RoleListLogicMonitor.RolePropertyLogicMonitor.SdtListLogicMonitor.SdtPercentageLogicMonitor.SdtPropertyLogicMonitor.SingleSignOnPropertyLogicMonitor.SlaWidgetValuesLogicMonitor.SnmpSysOidMapListLogicMonitor.SnmpSysOidMapPropertyLogicMonitor.SummaryValueLogicMonitor.SummaryValueListLogicMonitor.ThresholdLogicMonitor.TrafficTableLogicMonitor.UnmonitoredDeviceListLogicMonitor.UnmonitoredDevicePropertyLogicMonitor.UserApiTokenListLogicMonitor.UserApiTokenPropertyLogicMonitor.UserListLogicMonitor.UserPropertyLogicMonitor.WebsiteCheckpointDataListLogicMonitor.WebsiteCountLogicMonitor.WebsiteGroupAnalysisLogicMonitor.WebsiteGroupCountLogicMonitor.WebsiteGroupListLogicMonitor.WebsiteGroupPropertyLogicMonitor.WebsiteListLogicMonitor.WebsitePropertyLogicMonitor.WidgetStatusMagicSuiteMagicSuite.SubscriptionListMerakiMeraki.CameraImageMeraki.ConfigurationChangeListMeraki.ConnectionMeraki.DevicePropertyMeraki.DeviceUplinkPropertyMeraki.EndOfLifeMeraki.NetworkClientListMeraki.NetworkDeviceListMeraki.NetworkEventListMeraki.NetworkListMeraki.NetworkPropertyMeraki.NetworkSwitchPortsListMeraki.NetworkSwitchStackListMeraki.OrganizationDeviceLicenseListMeraki.OrganizationDeviceLicensePropertyMeraki.OrganizationDeviceListMeraki.OrganizationDeviceListStatusPropertyMeraki.OrganizationInventoryListMeraki.OrganizationLicenseStatePropertyMeraki.OrganizationListMeraki.OrganizationPropertyMeraki.OrganizationUplinkUsageMeraki.WirelessNetworkClientConnectionStatsPropertyMeraki.WirelessNetworkClientLatencyListMeraki.WirelessNetworkClientsConnectionStatsListMeraki.WirelessNetworkClientsLatencyListMeraki.WirelessNetworkConnectionStatsPropertyMeraki.WirelessNetworkDeviceConnectionStatsPropertyMeraki.WirelessNetworkDeviceLatencyListMeraki.WirelessNetworkDevicesConnectionStatsListMeraki.WirelessNetworkDevicesLatencyListMeraki.WirelessNetworkLatencyListMicrosoftDataverseMicrosoftDataverse.ConnectionMicrosoftDataverse.CountMicrosoftDataverse.EntityDefinitionsListMicrosoftDataverse.EntityListMicrosoftDataverse.EntityPropertyListMicrosoftDataverse.ListMicrosoftDataverse.PropertyMicrosoftGraphMicrosoftGraph.ConnectionMicrosoftGraph.MicrosoftDataverseConnectionMicrosoftGraph.QueryObjectObject.ArrayCountObject.PropertyObject.TypeObject.UnpackObject.UnpackVariablesOpenAiOpenAi.AnswerOpenAi.CompleteOpenAi.ConnectionOpenAi.ImageQuickBooksQuickBooks.ConnectionQuickBooks.PropertyReportMagicReportMagic.ApplyBrandReportMagic.BadgeListReportMagic.ConnectionListReportMagic.ConnectionPropertyReportMagic.ConnectionStatusPropertyReportMagic.FeedbackListReportMagic.FeedbackPropertyReportMagic.MacroGroupListReportMagic.MacroHelpReportMagic.MacroListReportMagic.ReportBatchJobCountReportMagic.ReportBatchJobListReportMagic.ReportBatchJobPropertyReportMagic.ReportConnectionSummaryReportMagic.ReportJobCountReportMagic.ReportJobListReportMagic.ReportJobPropertyReportMagic.ReportMacroCountReportMagic.ReportPropertyReportMagic.ReportScheduleCountReportMagic.ReportScheduleListReportMagic.ReportSchedulePropertyReportMagic.SetReportPropertyReportMagic.SystemPropertyReportMagic.TenantImageReportMagic.TopicHelpReportMagic.VersionSalesforceSalesforce.ConnectionSalesforce.ListSalesforce.PropertyServiceNowServiceNow.ConnectionServiceNow.CountServiceNow.CreateServiceNow.DeleteServiceNow.DictionaryServiceNow.ListServiceNow.PropertyServiceNow.UpdateShapeShape.AddShape.CloneShape.DeleteShape.FormatShape.HideShape.SetPropertyShape.SetTextSlackSlack.ConnectionSlack.MessageSlideSlide.DeleteSlide.DeleteSectionSlide.LinkSlide.MoveToSlide.RepeatSmtpSmtp.ConnectionSnmpSnmp.EnterprisePropertySolarWindsSolarWinds.ConnectionSolarWinds.SqlListSolarWinds.SqlTableSqlSql.AnalysisTableTable.ColumnCountTable.DeleteTable.FormatTable.GraphTable.MergeCellsTable.RowCountTable.SaveTable.SortTable.WorldMapTimeCalendarCronHumanReadableCronRunDateDateRangeDateTimeDateTime.IsInWorkHoursDateTime.WorkHoursDurationTimeSpanTogglToggl.ClientListToggl.ClientPropertyToggl.ConnectionToggl.ProjectListToggl.ProjectPropertyToggl.ProjectReportPropertyToggl.TimeEntryListToggl.TimeEntryPropertyToggl.UserListToggl.UserPropertyToggl.WorkspaceListToggl.WorkspacePropertyTwilioTwilio.ConnectionTwilio.SmsUkParliamentUkParliament.PetitionCountUkParliament.PetitionListUkParliament.PetitionPropertyVariableVariable.ImageVariable.ListVariable.PropertyWebWeb.ConnectionWeb.HtmlWeb.ImageWeb.QueryWeb.ScreenshotWeb.TableWeb.TextXlsxXlsx.AddAnalysisXlsx.EmbedZendeskZendesk.ConnectionZendesk.ListZendesk.PropertyZoho.DeskZoho.Desk.ZohoListZoho.Desk.ZohoProperty

[Calculate:]

Performs a calculation.


Purpose

This is used to calculate a result based on other macros and calculations.


Macro Compatibility

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


Usage

NCalc is used for expression evaluation (see https://github.com/pitermarx/NCalc-Edge/wiki for documentation). Note: Because ReportMagic uses commas to delimit parameters, either surround the condition with quotes or use backticks(`) instead of commas where needed. For example:

[Calculate:value="if(1<=2, 'AAA', 'BBB')"]
Note that you can use the shorthand for this macro i.e. '[=:' instead of '[Calculate:'. The following additional functions may be used:
  • capitalise(<expression>): returns the string with the first letter of the first word capitalised (see examples, below)
  • contains('haystack containing needle', 'needle'): returns 'True' or 'False'
  • count('string'): returns the count of characters in the string
  • countBy('list', 'predicate', 'NCalc expression'): counts the number of items, grouped by a calculation.
  • endsWith('haystack containing needle', 'needle'): returns 'True' or 'False'
  • humanize(value, '<timeUnit>'): humanizes the expression (see examples, below)
  • in('needle', 'straw', 'straw', 'straw', 'needle', 'straw', ): returns 'True' if the searched-for item is present in the list of items.
  • indexOf('haystack containing needle', 'needle'): returns the integer offset of the first instance of the needle within the haystack, or -1 if not present
  • isNaN(<expression>): returns 'True' or 'False' (see examples, below)
  • isInfinite(<expression>): returns 'True' or 'False' (see examples, below)
  • JArray(items): generates a JArray.
  • JObject(items): generates a JObject. You can also include more JObjects inside to generate complex objects
  • lastIndexOf('haystack containing needle', 'needle'): returns the integer offset of the last instance of the needle within the haystack, or -1 if not present
  • list(items): generates a list or jArray. You can also put more lists inside to generate tables, effectively
  • length('the string'): returns the integer length of the string
  • startsWith('haystack containing needle', 'needle'): returns 'True' or 'False'
  • round(value, decimal places): returns the rounded value, which can be stored in a variable and/or displayed. For DISPLAY purposes, you MUST use the format parameter, else the value will be output to 2 decimal places.
  • timeSpan('<fromDate>', '<toDate>', '<timeUnit>'): returns the amount of time between fromDate and toDate. Time should be specified like so: '1975-02-17' or '1975-02-17 06:00'. Supported time units are: Milliseconds, Seconds, Minutes, Hours, Days, Weeks, and Years. Can be negative. (see examples, below)
  • toLower(<expression>): returns the string in lower case (see examples, below)
  • toUpper(<expression>): returns the string in upper case (see examples, below)

Note: The value will be stored in output variables (e.g. using storeAs, storeAsHidden or the '=>' shorthand) as the original type and at full precision. For example, if you output a DateTime, the full precision will be stored, including hours, minutes and seconds. For an integer of 12345, the integer value will be stored. However, the value output into the document must formatted as a string. The conversion from original output to string is achieved using the format parameter and the way in which this happens will depend on the type of the output. For example, the output of a DateTime written to the document might be '2023-02-17'. The integer may be formatted as '12,345'. If you would like to additionally store the formatted string to a variable, use the storeFormattedValueAs parameter.


Parameter TypePresence Purpose Options Default
value
StringMandatory An expression to calculate. May use variables previously calculated and stored using storeAs / storeAsHidden. All functions supported by NCalc are supported, as well as some additional functions (see below). N/A N/A
calculate
StringOptional Post processing formula. Use {value} for the macro output, e.g. {value}/1024. N/A N/A
colorTableCell
BooleanOptional Whether to color table cells if thresholds are breached, rather than color the text.
  • true
  • false
true
comment
StringOptional Add a comment to make your document template more readable. The comment is discarded in the output document. N/A N/A
criticalAfter
DateTimeOffsetOptional The macro is considered 'critical' if the output is after this DateTime UTC. N/A N/A
criticalBefore
DateTimeOffsetOptional The macro is considered 'critical' if the output is before this DateTime UTC. N/A N/A
criticalEq
StringOptional The macro is considered 'critical' if the output is equal to this value. N/A N/A
criticalFontBackgroundColor
ColorOptional The critical font background color to use. If omitted, no change is made. N/A
criticalFontBold
BooleanOptional Change the font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
criticalFontColor
ColorOptional The critical font color to use. If omitted, no change is made. N/A
criticalFontSize
DoubleOptional Change the critical font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
criticalGe
StringOptional The macro is considered 'critical' if the output is greater than or equal to this value. N/A N/A
criticalGt
StringOptional The macro is considered 'critical' if the output is greater than this value. N/A N/A
criticalIf
StringOptional The macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
criticalLe
StringOptional The macro is considered 'critical' if the output is less than or equal to this value. N/A N/A
criticalLt
StringOptional The macro is considered 'critical' if the output is less than this value. N/A N/A
criticalNe
StringOptional The macro is considered 'critical' if the output is not equal to this value. N/A N/A
criticalTableCellBackgroundColor
ColorOptional The critical table cell background color to use. N/A
errorAfter
DateTimeOffsetOptional The macro is considered 'error' if the output is after this DateTime UTC. N/A N/A
errorBefore
DateTimeOffsetOptional The macro is considered 'error' if the output is before this DateTime UTC. N/A N/A
errorEq
StringOptional The macro is considered 'error' if the output is equal to this value. N/A N/A
errorFontBackgroundColor
ColorOptional The error font background color to use. If omitted, no change is made. N/A
errorFontBold
BooleanOptional Change the error font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
errorFontColor
ColorOptional The error font color to use. If omitted, no change is made. N/A
errorFontSize
DoubleOptional Change the error font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
errorGe
StringOptional The macro is considered 'error' if the output is greater than or equal to this value. N/A N/A
errorGt
StringOptional The macro is considered 'error' if the output is greater than this value. N/A N/A
errorIf
StringOptional The macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
errorLe
StringOptional The macro is considered 'error' if the output is less than or equal to this value. N/A N/A
errorLt
StringOptional The macro is considered 'error' if the output is less than this value. N/A N/A
errorNe
StringOptional The macro is considered 'error' if the output is not equal to this value. N/A N/A
errorOnOverflow
BooleanOptional Should NCalc expression evaluation throw error on Overflow
  • true
  • false
true
errorTableCellBackgroundColor
ColorOptional The error table cell background color to use. N/A
failureText
StringOptional 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
fatalAfter
DateTimeOffsetOptional The macro is considered 'fatal' if the output is after this DateTime UTC. N/A N/A
fatalBefore
DateTimeOffsetOptional The macro is considered 'fatal' if the output is before this DateTime UTC. N/A N/A
fatalEq
StringOptional The macro is considered 'fatal' if the output is equal to this value. N/A N/A
fatalFontBackgroundColor
ColorOptional The fatal font background color to use. If omitted, no change is made. N/A
fatalFontBold
BooleanOptional Change the fatal font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
fatalFontColor
ColorOptional The fatal font color to use. If omitted, no change is made. N/A
fatalFontSize
DoubleOptional Change the fatal font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
fatalGe
StringOptional The macro is considered 'fatal' if the output is greater than or equal to this value. N/A N/A
fatalGt
StringOptional The macro is considered 'fatal' if the output is greater than this value. N/A N/A
fatalIf
StringOptional The macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
fatalLe
StringOptional The macro is considered 'fatal' if the output is less than or equal to this value. N/A N/A
fatalLt
StringOptional The macro is considered 'fatal' if the output is less than this value. N/A N/A
fatalNe
StringOptional The macro is considered 'fatal' if the output is not equal to this value. N/A N/A
fatalTableCellBackgroundColor
ColorOptional The fatal table cell background color to use. N/A
fontBackgroundColor
ColorOptional The font background color to use. N/A
fontBold
BooleanOptional Change the font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
fontColor
ColorOptional The font color to use. N/A
fontSize
DoubleOptional Change the font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
format
StringOptional The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings. N/A N/A
hidden
BooleanOptional Whether to hide the macro output.
  • true
  • false
false
if
StringOptional 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
infoAfter
DateTimeOffsetOptional The macro is considered 'info' if the output is after this DateTime UTC. N/A N/A
infoBefore
DateTimeOffsetOptional The macro is considered 'info' if the output is before this DateTime UTC. N/A N/A
infoEq
StringOptional The macro is considered 'info' if the output is equal to this value. N/A N/A
infoFontBackgroundColor
ColorOptional The info font background color to use. If omitted, no change is made. N/A
infoFontBold
BooleanOptional Change the info font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
infoFontColor
ColorOptional The info font color to use. If omitted, no change is made. N/A
infoFontSize
DoubleOptional Change the info font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
infoGe
StringOptional The macro is considered 'info' if the output is greater than or equal to this value. N/A N/A
infoGt
StringOptional The macro is considered 'info' if the output is greater than this value. N/A N/A
infoIf
StringOptional The macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
infoLe
StringOptional The macro is considered 'info' if the output is less than or equal to this value. N/A N/A
infoLt
StringOptional The macro is considered 'info' if the output is less than this value. N/A N/A
infoNe
StringOptional The macro is considered 'info' if the output is not equal to this value. N/A N/A
infoTableCellBackgroundColor
ColorOptional The info table cell background color to use. N/A
mode
MacroModeOptional 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
normalFontBackgroundColor
ColorOptional The normal font background color to use. If omitted, no change is made. N/A
normalFontBold
BooleanOptional Change the normal font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
normalFontColor
ColorOptional The normal font color to use. If omitted, no change is made. N/A
normalFontSize
DoubleOptional Change the normal font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
normalTableCellBackgroundColor
ColorOptional The normal table cell background color to use. If omitted, no change is made. N/A
obfuscation
ObfuscationTypeOptional 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
outputListsAsJarray
Normal mode
BooleanOptional Any macros that output lists can optionally (in Normal mode) output a jArray instead.
  • true
  • false
true
redact
BooleanOptional 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
singleValueList
Normal mode
BooleanOptional In Normal Mode and for macros that output JArrays only, whether to convert a JArray of single-property jObjects into a flat JArray of values.
  • true
  • false
false
storeAs
StringOptional The variable to store the result as. N/A N/A
storeAsHidden
StringOptional The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'. N/A N/A
storeAsVariableDelimiter
CharOptional The delimiter used by storeAs to split the input (Legacy mode only), when there are multiple stored variables. For example, in this macro, we indicate that the value to be stored should be split by the asterisk when being stored: [String:value=a*b*c*d, storeAs=var1;var2;var3;var4, storeAsVariableDelimiter=*] N/A ;
storeFormattedValueAs
StringOptional 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
warning
StringOptional 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
warningAfter
DateTimeOffsetOptional The macro is considered 'warning' if the output is after this DateTime UTC. N/A N/A
warningBefore
DateTimeOffsetOptional The macro is considered 'warning' if the output is before this DateTime UTC. N/A N/A
warningEq
StringOptional The macro is considered 'warning' if the output is equal to this value. N/A N/A
warningFontBackgroundColor
ColorOptional The warning font background color to use. If omitted, no change is made. N/A
warningFontBold
BooleanOptional Change the warning font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
warningFontColor
ColorOptional The warning font color to use. If omitted, no change is made. N/A
warningFontSize
DoubleOptional Change the warning font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
warningGe
StringOptional The macro is considered 'warning' if the output is greater than or equal to this value. N/A N/A
warningGt
StringOptional The macro is considered 'warning' if the output is greater than this value. N/A N/A
warningIf
StringOptional The macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
warningLe
StringOptional The macro is considered 'warning' if the output is less than or equal to this value. N/A N/A
warningLt
StringOptional The macro is considered 'warning' if the output is less than this value. N/A N/A
warningNe
StringOptional The macro is considered 'warning' if the output is not equal to this value. N/A N/A
warningTableCellBackgroundColor
ColorOptional The warning table cell background color to use. N/A

Examples (44)

Example 1:
[Calculate: value=1, storeAs=a]

Outputs:

1
Example 2:
[Calculate: value=2, storeAs=b][Calculate: value=3, storeAs=c]

Outputs:

23
Example 3:
[Calculate: value=3+5, storeAs=c]

Outputs:

8
Example 4:
[Calculate: value=1, storeAsHidden=a]
[Calculate: value=2, storeAsHidden=b]
[Calculate: value=3, storeAsHidden=c]
[Calculate: value=({a}+{b})/{c}, errorGe=0.01, format=N2]

Example 5:
[Calculate: value=1, storeAsHidden=a]
[Calculate: value=2, storeAsHidden=b]
[Calculate: value=3, storeAsHidden=c]
[Calculate: value="if({a}={b},1,2)", errorGe=0.01, format=N2]

Example 6:
[Calculate: value=1, storeAsHidden=a]
[Calculate: value=2, storeAsHidden=b]
[Calculate: value=3, storeAsHidden=c]
[Calculate: value="if({b}>{a},'OK','Not OK')"]

Example 7:
[Calculate: value=5+3, storeAsHidden=Result]
[Calculate: value={Result}, warningGe=2, warningFontColor=Orange, warningFontBackgroundColor=#ddd, warningFontBold=True, warningFontSize=20, errorGe=4, errorFontColor=Blue, errorFontBackgroundColor=Yellow, errorFontBold=True, errorFontSize=50]

Example 8:
[Calculate: value="contains('haystack containing needle', 'needle')"]

Outputs:

True
Example 9:
[Calculate: value="startsWith('haystack containing needle', 'needle')"]

Outputs:

False
Example 10:
[Calculate: value="endsWith('haystack containing needle', 'needle')"]

Outputs:

True
Example 11:
[Calculate: value="indexOf('haystack containing a needle and another needle', 'needle')"]

Outputs:

22
Example 12:
[Calculate: value="lastIndexOf('haystack containing a needle and another needle', 'needle')"]

Outputs:

41
Example 13:
[Calculate: value="lastIndexOf('haystack containing no sharp pointy things', 'needle')"]

Outputs:

-1
Example 14:
[Calculate: value="length('haystack containing needle')"]

Outputs:

26
Example 15:
[Calculate: value="in(1, 1, 2, 3)"]

Outputs:

True
Example 16:
[Calculate: value="in(99, 1, 2, 3)"]

Outputs:

False
Example 17:
[Calculate: value="isNaN(1/2)"]

Outputs:

False
Example 18:
[Calculate: value="isNaN(1/0)"]

Outputs:

False
Example 19:
[Calculate: value="isInfinite(1/2)"]

Outputs:

False
Example 20:
[Calculate: value="isInfinite(1/0)"]

Outputs:

True
Example 21:
[Calculate: value="isInfinite(-1/0)"]

Outputs:

True
Example 22:
[Calculate: value="if(in(1, 1, 2, 3), 'Passed', 'Failed')"]

Outputs:

Passed
Example 23:
[Calculate: value="timeSpan('1975-02-17', '2017-02-17', 'Days')"]

Outputs:

15341
Example 24:
[Calculate: value="timeSpan('1975-02-17 16:00', '2017-02-17 17:00', 'Hours')"]

Outputs:

368185
Example 25:
[Calculate: value="toUpper('aBc def')"]

Outputs:

ABC DEF
Example 26:
[Calculate: value="toLower('aBc def')"]

Outputs:

abc def
Example 27:
[Calculate: value="capitalise('aBc def')"]

Outputs:

Abc def
Example 28:
[Calculate: value="if(2.368475785867E-16 < 0`'-ve'`if(2.368475785867E-16 < 0.01`'<0.01'`2.368475785867E-16))"]

Outputs:

<0.01
Example 29:
[Calculate: value="Round(12.34, 0)", format=F0]

Outputs:

12
Example 30:
[Calculate: value="Round(12.34, 1)", format=F1]

Outputs:

12.3
Example 31:

Calculate and store the value 12.34 into a variable (at 1 decimal place precision), and DISPLAY at 1 decimal place too by using the 'format' parameter:

[Calculate: value="Round(12.34, 1)", format=F1, storeAs=Output]

Outputs:

12.3
Example 32:

Calculate and store the value 12.34 into a variable (at 1 decimal place precision), but DISPLAY at 1 decimal place (by omitting the 'format' parameter):

[Calculate: value="Round(12.34, 1)", storeAs=Output]

Outputs:

12.30
Example 33:
[Calculate: value="humanize(0.25, 'days')"]

Outputs:

6 hours
Example 34:
[Calculate: value="humanize(24, 'hours')"]

Outputs:

1 day
Example 35:

Stores what you can see in ReportStudio (to 2 decimal places) as the variable B and stores the hidden output (to 0 decimal places) in A.

[Calculate: value="Round(12.34, 0)", storeAs=A, storeFormattedValueAs=B]<br/>A is '[String: value={A}]' and B is '[String: value ={B}]'

Outputs:

12:00
A is '12' and B is '12.00'

Example 36:

You can create JObjects directly and access the values using the [.:] shorthand. Note this example uses the Calculate macro shorthand i.e. starts with '[=:' instead of '[Calculate:]' :

[=:`jObject('v', null, 'w', 'Some text', 'y', jObject('z', 1))`, =>x][.:x.y.z]

Outputs:

1
Example 37:

This example creates a jArray:

[=:`list(1, 2, 3, 4, 5)`, =>MyList]

Example 38:

This example creates a jArray:

[=:`jArray(jObject('a', 1, 'b', null), jObject('a', 2, 'b', #2024-06-21#))`, =>jArray]

Outputs:

[ { "a" : 1, "b" : null }, { "a" : 2, "b" : "2024-06-21T00:00:00" } ]
Example 39:

This example creates a string URL and uses the Calculate macro shorthand i.e. starts with '[=:' instead of '[Calculate:]' :

[=:'https://en.wikipedia.org/wiki/Alphabet', =>CustomerUrl1]

Outputs:

https://en.wikipedia.org/wiki/Alphabet
Example 40:

This example creates a string URL and uses the Calculate macro shorthand i.e. starts with '[=:' instead of '[Calculate:]' :

[=:'http://www.google.com/', =>CustomerUrl2]

Outputs:

http://www.google.com/
Example 41:

Counts the number of characters in a string

[Calculate: value="count('Report Magic')"]

Outputs:

12
Example 42:

Counts the number of characters in a string

[Calculate: value="count('ReportMagic')"]

Outputs:

11
Example 43:

Counts by how many of each number there are in a list, i.e. grouped by the values themselves, and stores the results as a new JObject (dictionary) variable:

[Calculate: value="countBy(list(1, 1, 1, 1, 1, 2, 2, 3, 3, 3, 4), 'n', 'toString(n)')", =>Count]

Outputs:

{ "1" : 5, "2" : 2, "3" : 3, "4" : 1 }
Example 44: Normal mode

This Normal Mode example counts 'Tickets' grouped by their name and stores the result as a new jObject (dictionary) variable:

// First create a list of JObjects:

[Calculate: value="list(
	jObject('name', 'A', 'description', 'yaaay'),
	jObject('name', 'B', 'description', 'houpla'),
	jObject('name', 'C', 'description', 'woowoo'),
	jObject('name', 'C', 'description', 'yay'),
	jObject('name', 'B', 'description', 'woo'),
	jObject('name', 'B', 'description', 'blah')
)", mode=Normal, =>Tickets]

// Now calculate how many there are for each of the name properties, i.e how many are called 'A', 'B', and so on:

[Calculate: value="countBy(Tickets, 'n', 'getProperty(n, \'name\')')", mode=Normal, =>Output]

Outputs:

{ "A" : 1, "B" : 3, "C": 2 }
An unhandled error has occurred. Reload 🗙