Quick StartThe ReportMagic MenuReport StudioFilesSchedulesBatch JobsReport JobsDashboardsProfileAdminAccount DetailsGetting StartedAbout ReportMagicRegistering and Logging InReport LibrarySearching 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 StudioAdvanced [Object.Graph:] MacroAPI 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.MetricsListAlertMagic.StatisticsAutoTaskAutoTask.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.QueryCodacyCodacy.ConnectionCodacy.ListConnectWiseManageConnectWiseManage.ConnectionConnectWiseManage.CountConnectWiseManage.DictionaryConnectWiseManage.ListConnectWiseManage.PropertyCoreArrayArray.CountBreakBreakpointCalculateColorCommentContinueConvertDeleteDeleteRowDocumentBookmarkDocumentBreakDocumentInsertSectionDocumentSectionEmailEmailFileEmailReportExecuteForEachFormatTableCellFormatTableRowIfIgnoreIncInsertTableCellImageIsSetLinearRegressionLinkMapObjectRandomRegexRepeatRowSearchAndReplaceSectionSettingsSleepStopStopwatchStringStringIndexSubstringSwitchThrowExceptionUnsetWarningWhileDatabaseDatabase.ConnectionDatabase.GraphDatabase.ListDatabase.TableDatabase.ValueDatabase.ValuesDataMagicDataMagic.SyncDictionaryDictionary.ItemDictionary.KeysDictionary.ValuesDocumentDocument.SetPropertiesDropBoxSignDropBoxSign.ConnectionFileFile.CopyFile.CopyOutputFilesFile.Csv.CellFile.Csv.RowFile.Csv.RowCountFile.Csv.TableFile.EmbedFile.ExecuteFile.ExistsFile.ImageFile.InsertFile.ListFile.LoadListFile.LoadObjectFile.LoadStringFile.LoadVariablesFile.SaveObjectFile.Xlsx.CellFile.Xlsx.RowFile.Xlsx.RowCountFile.Xlsx.TableFunctionFunction.CallFunction.DefineGoogleGoogle.ConnectionGoogle.TableGraphGraph.AddDataGraph.DeleteDataGraph.RenameDataGraph.UpdateGravatarGravatar.ImageHaloPsaHaloPsa.ConnectionHaloPsa.ListHighlightHighlight.BearerSummaryHighlight.BroadbandSummaryHighlight.CellularSummaryHighlight.ConnectionHighlight.FolderListHighlight.HttpServerPerformanceSummaryHighlight.IcmpTcpUdpPerformanceSummaryHighlight.MosPerformanceSummaryHighlight.PrecisionPerformanceSummaryHighlight.TunnelSummaryHighlight.WatchNodeListHighlight.WirelessAccessPointSummaryHubSpotHubSpot.ListHubSpot.PropertyHubSpot.QueryJarrayJarray.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.GraphSpecificationLogicMonitor.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.ApplyBrandMagicSuite.BadgeListMagicSuite.ConnectionMagicSuite.ConnectionListMagicSuite.ConnectionPropertyMagicSuite.ConnectionStatusPropertyMagicSuite.FeedbackListMagicSuite.FeedbackPropertyMagicSuite.GlobalSettingPropertyMagicSuite.MacroGroupListMagicSuite.MacroHelpMagicSuite.MacroListMagicSuite.ReportBatchJobCountMagicSuite.ReportBatchJobListMagicSuite.ReportBatchJobPropertyMagicSuite.ReportConnectionSummaryMagicSuite.ReportJobCountMagicSuite.ReportJobListMagicSuite.ReportJobPropertyMagicSuite.ReportMacroCountMagicSuite.ReportPropertyMagicSuite.ReportScheduleCountMagicSuite.ReportScheduleListMagicSuite.ReportSchedulePropertyMagicSuite.SetReportPropertyMagicSuite.SubscriptionListMagicSuite.SystemPropertyMagicSuite.TenantImageMagicSuite.TopicHelpMagicSuite.VersionMerakiMeraki.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.QueryObjectObject.ArrayCountObject.GraphObject.PropertyObject.TypeObject.UnpackObject.UnpackVariablesOpenAiOpenAi.AnswerOpenAi.CompleteOpenAi.ConnectionOpenAi.ImageQuickBooksQuickBooks.ConnectionQuickBooks.PropertySalesforceSalesforce.ConnectionSalesforce.ListSalesforce.PropertyServiceNowServiceNow.ConnectionServiceNow.CountServiceNow.CreateServiceNow.DeleteServiceNow.DictionaryServiceNow.ListServiceNow.PropertyServiceNow.UpdateShapeShape.AddShape.CloneShape.DeleteShape.FormatShape.HideShape.SetPropertyShape.SetTextSideroLabsOmniSideroLabsOmni.ConnectionSideroLabsOmni.ListSideroLabsOmni.ObjectSlackSlack.ConnectionSlack.MessageSlideSlide.DeleteSlide.DeleteSectionSlide.LinkSlide.MoveToSlide.RepeatSmtpSmtp.ConnectionSnmpSnmp.EnterprisePropertySolarWindsSolarWinds.ConnectionSolarWinds.SqlListSolarWinds.SqlTableSolarWindsServiceDeskSolarWindsServiceDesk.ConnectionSolarWindsServiceDesk.ListSolarWindsServiceDesk.PropertySqlSql.AnalysisTableTable.ColumnCountTable.DeleteTable.FormatTable.GraphTable.MergeCellsTable.MergeRowsTable.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
[List.SelectColumns:]

Selects one or more columns from a list.


Compatibility

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


Parameters (121)
Mandatory (1)1 additional
Parameter TypePurpose Options Default
columnIndices
List<Int32>The zero-indexed columns to select, separated by a semi-colon e.g. 1;2;3. N/A N/A
Additional (1)
Parameter TypePurpose Options Default
values
List<Object>The list of input values. In Legacy Mode, they should be split by the delimiter character. N/A N/A
Behaviour (10)
Parameter TypePresencePurpose Options Default
calculate
StringOptionalPost processing formula. Use {value} for the macro output, e.g. {value}/1024. N/A N/A
errorOnOverflow
BooleanOptionalShould NCalc expression evaluation throw error on Overflow
  • true
  • false
true
fatalIf
StringOptionalThe macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
hidden
BooleanOptionalWhether to hide the macro output.
  • true
  • false
false
if
StringOptionalThe 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
MacroModeOptionalThe 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
ObfuscationTypeOptionalObfuscation 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
BooleanOptionalWhether 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
trimWhitespace
BooleanOptionalWhether to trim leading and trailing whitespace on input items. The trim operation is done BEFORE other operators such as selecting distinct items or sorting.
  • true
  • false
false
warning
StringOptionalIf 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 (6)
Parameter TypePresencePurpose Options Default
colorTableCell
BooleanOptionalWhether to color table cells if thresholds are breached, rather than color the text.
  • true
  • false
true
fontBackgroundColor
ColorOptionalThe font background color to use. N/A
fontColor
ColorOptionalThe font color to use. N/A
normalFontBackgroundColor
ColorOptionalThe normal font background color to use. If omitted, no change is made. N/A
normalFontColor
ColorOptionalThe normal font color to use. If omitted, no change is made. N/A
normalTableCellBackgroundColor
ColorOptionalThe normal table cell background color to use. If omitted, no change is made. N/A
Formatting (5)
Parameter TypePresencePurpose Options Default
fontBold
BooleanOptionalChange the font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
fontSize
DoubleOptionalChange the font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
format
StringOptionalThe formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings. N/A N/A
normalFontBold
BooleanOptionalChange the normal font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
normalFontSize
DoubleOptionalChange the normal font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
Conditional Formatting (69)
Parameter TypePresencePurpose Options Default
criticalAfter
DateTimeOffsetOptionalThe macro is considered 'critical' if the output is after this DateTime UTC. N/A N/A
criticalBefore
DateTimeOffsetOptionalThe macro is considered 'critical' if the output is before this DateTime UTC. N/A N/A
criticalEq
StringOptionalThe macro is considered 'critical' if the output is equal to this value. N/A N/A
criticalFontBackgroundColor
ColorOptionalThe critical font background color to use. If omitted, no change is made. N/A
criticalFontBold
BooleanOptionalChange the font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
criticalFontColor
ColorOptionalThe critical font color to use. If omitted, no change is made. N/A
criticalFontSize
DoubleOptionalChange the critical font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
criticalGe
StringOptionalThe macro is considered 'critical' if the output is greater than or equal to this value. N/A N/A
criticalGt
StringOptionalThe macro is considered 'critical' if the output is greater than this value. N/A N/A
criticalIf
StringOptionalThe macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
criticalLe
StringOptionalThe macro is considered 'critical' if the output is less than or equal to this value. N/A N/A
criticalLt
StringOptionalThe macro is considered 'critical' if the output is less than this value. N/A N/A
criticalNe
StringOptionalThe macro is considered 'critical' if the output is not equal to this value. N/A N/A
criticalTableCellBackgroundColor
ColorOptionalThe critical table cell background color to use. N/A
errorAfter
DateTimeOffsetOptionalThe macro is considered 'error' if the output is after this DateTime UTC. N/A N/A
errorBefore
DateTimeOffsetOptionalThe macro is considered 'error' if the output is before this DateTime UTC. N/A N/A
errorEq
StringOptionalThe macro is considered 'error' if the output is equal to this value. N/A N/A
errorFontBackgroundColor
ColorOptionalThe error font background color to use. If omitted, no change is made. N/A
errorFontBold
BooleanOptionalChange the error font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
errorFontColor
ColorOptionalThe error font color to use. If omitted, no change is made. N/A
errorFontSize
DoubleOptionalChange the error font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
errorGe
StringOptionalThe macro is considered 'error' if the output is greater than or equal to this value. N/A N/A
errorGt
StringOptionalThe macro is considered 'error' if the output is greater than this value. N/A N/A
errorIf
StringOptionalThe macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
errorLe
StringOptionalThe macro is considered 'error' if the output is less than or equal to this value. N/A N/A
errorLt
StringOptionalThe macro is considered 'error' if the output is less than this value. N/A N/A
errorNe
StringOptionalThe macro is considered 'error' if the output is not equal to this value. N/A N/A
errorTableCellBackgroundColor
ColorOptionalThe error table cell background color to use. N/A
fatalAfter
DateTimeOffsetOptionalThe macro is considered 'fatal' if the output is after this DateTime UTC. N/A N/A
fatalBefore
DateTimeOffsetOptionalThe macro is considered 'fatal' if the output is before this DateTime UTC. N/A N/A
fatalEq
StringOptionalThe macro is considered 'fatal' if the output is equal to this value. N/A N/A
fatalFontBackgroundColor
ColorOptionalThe fatal font background color to use. If omitted, no change is made. N/A
fatalFontBold
BooleanOptionalChange the fatal font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
fatalFontColor
ColorOptionalThe fatal font color to use. If omitted, no change is made. N/A
fatalFontSize
DoubleOptionalChange the fatal font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
fatalGe
StringOptionalThe macro is considered 'fatal' if the output is greater than or equal to this value. N/A N/A
fatalGt
StringOptionalThe macro is considered 'fatal' if the output is greater than this value. N/A N/A
fatalLe
StringOptionalThe macro is considered 'fatal' if the output is less than or equal to this value. N/A N/A
fatalLt
StringOptionalThe macro is considered 'fatal' if the output is less than this value. N/A N/A
fatalNe
StringOptionalThe macro is considered 'fatal' if the output is not equal to this value. N/A N/A
fatalTableCellBackgroundColor
ColorOptionalThe fatal table cell background color to use. N/A
infoAfter
DateTimeOffsetOptionalThe macro is considered 'info' if the output is after this DateTime UTC. N/A N/A
infoBefore
DateTimeOffsetOptionalThe macro is considered 'info' if the output is before this DateTime UTC. N/A N/A
infoEq
StringOptionalThe macro is considered 'info' if the output is equal to this value. N/A N/A
infoFontBackgroundColor
ColorOptionalThe info font background color to use. If omitted, no change is made. N/A
infoFontBold
BooleanOptionalChange the info font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
infoFontColor
ColorOptionalThe info font color to use. If omitted, no change is made. N/A
infoFontSize
DoubleOptionalChange the info font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
infoGe
StringOptionalThe macro is considered 'info' if the output is greater than or equal to this value. N/A N/A
infoGt
StringOptionalThe macro is considered 'info' if the output is greater than this value. N/A N/A
infoIf
StringOptionalThe macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
infoLe
StringOptionalThe macro is considered 'info' if the output is less than or equal to this value. N/A N/A
infoLt
StringOptionalThe macro is considered 'info' if the output is less than this value. N/A N/A
infoNe
StringOptionalThe macro is considered 'info' if the output is not equal to this value. N/A N/A
infoTableCellBackgroundColor
ColorOptionalThe info table cell background color to use. N/A
warningAfter
DateTimeOffsetOptionalThe macro is considered 'warning' if the output is after this DateTime UTC. N/A N/A
warningBefore
DateTimeOffsetOptionalThe macro is considered 'warning' if the output is before this DateTime UTC. N/A N/A
warningEq
StringOptionalThe macro is considered 'warning' if the output is equal to this value. N/A N/A
warningFontBackgroundColor
ColorOptionalThe warning font background color to use. If omitted, no change is made. N/A
warningFontBold
BooleanOptionalChange the warning font weight (true=strong, false=normal). If omitted, no change is made.
  • true
  • false
N/A
warningFontColor
ColorOptionalThe warning font color to use. If omitted, no change is made. N/A
warningFontSize
DoubleOptionalChange the warning font size in points. If omitted, no change is made.
  • From 2 to 200
N/A
warningGe
StringOptionalThe macro is considered 'warning' if the output is greater than or equal to this value. N/A N/A
warningGt
StringOptionalThe macro is considered 'warning' if the output is greater than this value. N/A N/A
warningIf
StringOptionalThe macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression. N/A N/A
warningLe
StringOptionalThe macro is considered 'warning' if the output is less than or equal to this value. N/A N/A
warningLt
StringOptionalThe macro is considered 'warning' if the output is less than this value. N/A N/A
warningNe
StringOptionalThe macro is considered 'warning' if the output is not equal to this value. N/A N/A
warningTableCellBackgroundColor
ColorOptionalThe warning table cell background color to use. N/A
Filtering & Sorting (8)2 additional
Parameter TypePresencePurpose Options Default
comparisons
List<String>OptionalIn 'normal' mode only, the comparisons that are jsonPaths. For multiple items, separate by a semi-colon e.g. property1;property2;... N/A N/A
condition
StringOptionalThe condition that must be true, using 'value'. N/A N/A
orderByIndices
List<Int32>OptionalThe semicolon-separated ordered list of columns to order by. The first is 0. e.g. 0;2;1 N/A N/A
orderDirection
List<String>OptionalThe semicolon-separated order directions. Each must be one of: Ascending, Asc, Descending or Desc. N/A None
skip
Int32OptionalThe number of items AFTER the sort to skip. N/A 0
sortTypes
List<String>OptionalThe semicolon-separated sort types. Each must be one of Alphanumeric, Numeric or Auto. The default (Auto) will attempt a numeric sort if all the values are numeric, otherwise falls back to alphanumeric. N/A Auto
stringListSortType
StringListSortTypeOptionalThe sort method to use. This can be used to adjust the sort order used by the system.
  • OrdinalIgnoreCase
  • Ordinal
  • InvariantCulture
  • InvariantCultureIgnoreCase
OrdinalIgnoreCase
take
Int32OptionalThe number of items AFTER the sort to take. N/A 2147483647
Additional (2)
Parameter TypePresencePurpose Options Default
includeWhitespaceItems
BooleanOptionalWhether to include whitespace items.
  • true
  • false
true
selectDistinct
BooleanOptionalWhether to exclude duplicates.
  • true
  • false
false
Output (1)9 additional
Parameter TypePresencePurpose Options Default
indexDelimiter
CharOptionalThe index delimiter. N/A ^
Additional (9)
Parameter TypePresencePurpose Options Default
delimiter
CharOptionalThe delimiter character to delimit text-based input lists (e.g. 1;2;3;4). When this parameter is set and 'listDelimiter' is NOT set, this acts as both the input and output list delimiter. N/A ;
failureText
StringOptionalThe 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
StringOptionalThe 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
listDelimiter
CharOptionalIn Legacy Mode, the delimiter to use between multiple items in the output (in the variable and in the report). In Normal Mode, the delimiter has no effect on the variable, just the output to the report. N/A ;
outputListsAsJarray
Normal mode
BooleanOptionalAny macros that output lists can optionally (in Normal mode) output a jArray instead.
  • true
  • false
true
storeAs
StringOptionalThe variable to store the result as. N/A N/A
storeAsHidden
StringOptionalThe variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'. N/A N/A
storeAsVariableDelimiter
CharOptionalThe 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
StringOptionalThe 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 (1)6 additional
Parameter TypePresencePurpose Options Default
columnIndices
List<Int32>MandatoryThe zero-indexed columns to select, separated by a semi-colon e.g. 1;2;3. N/A N/A
Additional (6)
Parameter TypePresencePurpose Options Default
values
List<Object>MandatoryThe list of input values. In Legacy Mode, they should be split by the delimiter character. N/A N/A
comment
StringOptionalAdd a comment to make your document template more readable. The comment is discarded in the output document. N/A N/A
desiredExecutionResult
ExecutionResultOptionalIf 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
StringOptionalIf 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
StringOptionalIf 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
singleValueList
Normal mode
BooleanOptionalIn 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
Deprecated (4)
Parameter TypePreferred ParameterPurpose Options Default
comparison
List<String>comparisonsIn 'normal' mode only, the comparisons that are jsonPaths. For multiple items, separate by a semi-colon e.g. property1;property2;... N/A N/A
order
List<String>orderDirectionThe semicolon-separated order directions. Each must be one of: Ascending, Asc, Descending or Desc. N/A None
orderByIndex
List<Int32>orderByIndicesThe semicolon-separated ordered list of columns to order by. The first is 0. e.g. 0;2;1 N/A N/A
sortType
List<String>sortTypesThe semicolon-separated sort types. Each must be one of Alphanumeric, Numeric or Auto. The default (Auto) will attempt a numeric sort if all the values are numeric, otherwise falls back to alphanumeric. N/A Auto

Examples (12)

Example 1Normal mode

This Normal Mode example selects the 2nd, 3rd and 4th items in a list (indexed by 1, 2, 3):

// Example 1 - This Normal Mode example selects the 2nd, 3rd and 4th items in a list (indexed by 1, 2, 3): // First create a Normal Mode style list using the Calculate macro shorthand [=: `list('item1-to-skip', 'item2-to-keep', 'item3-to-keep', 'item4-to-keep')`, =>List1] // Select the required items [List.SelectColumns: values={=List1}, columnIndices=1;2;3, mode=Normal, storeAs=Selected]
Outputs: Output to screen: item2-to-keep;item3-to-keep;item4-to-keep. Output to variable: [ "item2-to-keep", "item3-to-keep", "item4-to-keep" ]

Example 2Normal mode

This Normal Mode example selects the 2nd, 3rd and 4th items in a 'table' (list of lists), indexed by 1, 2, 3:

// Example 2 - This Normal Mode example selects the 2nd, 3rd and 4th items in a 'table' (list of lists), indexed by 1, 2, 3: // First create a Normal Mode style table (list of lists) using the Calculate macro shorthand [=: `list(list('item1-to-skip', 0), list('item2-to-keep', 1), list('item3-to-keep', 2), list('item4-to-keep', 3), list('item1-to-skip', 5))`, =>Table] // Select the required items [List.SelectColumns: values={=Table}, columnIndices=1;2;3, mode=Normal, storeAs=Selected]
Outputs: Output to screen: item2-to-keep^1;item3-to-keep^2;item4-to-keep^3. Output to variable: [ [ "item2-to-keep", 1 ], [ "item3-to-keep", 2], [ "item4-to-keep", 3] ]

Example 3Normal mode

This Normal Mode example selects the 2nd, 3rd and 4th items in a 'table' (list of lists), indexed by 1, 2, 3:

// Example 3 - This Normal Mode example selects the 2nd, 3rd and 4th items in a 'table' (list of lists), indexed by 1, 2, 3: // First create an array / list of JObjects (a JObject contains one or more pairs of property names and values) [Array:     value=`[         {"Item":"item1-to-skip","Index":0},         {"Item":"item2-to-keep","Index":1},         {"Item":"item3-to-keep","Index":2},         {"Item":"item4-to-keep","Index":3},         {"Item":"item5-to-skip","Index":4}     ]`,     =>TheArray] // Select the required items [List.SelectColumns: values={=TheArray}, columnIndices=1;2;3, mode=Normal, storeAs=Selected]
Outputs: Output to screen: { "Item" : "item2-to-keep", "Index" : 1 };{ "Item" : "item3-to-keep", "Index" : 2 };{ "Item" : "item4-to-keep", "Index" : 3 }. Output to variable: [ { "Item" : "item2-to-keep", "Index" : 1 }, { "Item" : "item3-to-keep", "Index" : 2 }, { "Item" : "item4-to-keep", "Index" : 3 } ]

Example 4

Select the 2nd, 3rd and 4th item in a list (indexed by 1, 2, 3):

// Example 4 - Select the 2nd, 3rd and 4th item in a list (indexed by 1, 2, 3): [List.SelectColumns: values=item1-to-skip;item2-to-keep;item3-to-keep;item4-to-keep, columnIndices=1;2;3, =>Specs]
Outputs: item2-to-keep;item3-to-keep;item4-to-keep

Example 5Normal mode

Demonstrates the use of the 'condition' parameter:

// Example 5 - Demonstrates the use of the 'condition' parameter: // Select the required items filtered by the condition that the values must begin with a b [List.SelectColumns: values=red;green;blue;black, columnIndices=1;2;3, mode=Normal, storeAs=Selected, condition="startsWith(value, 'b')"]
Outputs: Output to screen: blue;black Output to variable: [ "blue", "black" ]

Example 6

Select the 2nd, 3rd and 4th item in a list (indexed by 1, 2, 3):

// Example 6 - Select the 2nd, 3rd and 4th item in a list (indexed by 1, 2, 3): [List.SelectColumns: values=item1-to-skip;item2-to-keep;item3-to-keep;item4-to-keep, columnIndices=1;2;3, =>Specs]
Outputs: item2-to-keep;item3-to-keep;item4-to-keep

Example 7

Select the 2nd and 4th items in a list, but only if the value contains the word 'keep':

// Example 7 - Select the 2nd and 4th items in a list, but only if the value contains the word 'keep': [=: `list('item1-to-skip', 'item2-to-keep', 'item3-to-skip', 'item4-to-keep')`, =>List1] [List.SelectColumns: values={=List1}, columnIndices=1;3, condition="contains(value, 'keep')", mode=Normal, storeAs=Selected]
Outputs: item2-to-keep;item4-to-keep

Example 8

Select the 1st and 3rd items in a list and divide each value by 1024:

// Example 8 - Select the 1st and 3rd items in a list and divide each value by 1024: [=: `list(2048, 4096, 8192, 16384)`, =>List1] [List.SelectColumns: values={=List1}, columnIndices=0;2, calculate="value/1024", mode=Normal, storeAs=Selected]
Outputs: 2;8

Example 9

Select the 1st and 2nd items in a list and color the table cells if the value is greater than 1000:

// Example 9 - Select the 1st and 2nd items in a list and color the table cells if the value is greater than 1000: [=: `list(500, 1500, 2500, 3500)`, =>List1] [List.SelectColumns: values={=List1}, columnIndices=0;1, colorTableCell=true, condition="value > 1000", mode=Normal, storeAs=Selected]
Outputs: 1500 (with 1500 cell coloured)

Example 10

Select the 1st and 3rd items from a nested list (list of lists):

// Example 10 - Select the 1st and 3rd items from a nested list (list of lists): [=: `list(list('item1-to-keep', 100), list('item2-to-skip', 200), list('item3-to-keep', 300), list('item4-to-skip', 400))`, =>NestedList] [List.SelectColumns: values={=NestedList}, columnIndices=0;2, mode=Normal, storeAs=Selected]
Outputs: item1-to-keep^100;item3-to-keep^300

Example 11

Select the required items from a list of colors where the value starts with 'b':

// Example 11 - Select the required items from a list of colors where the value starts with 'b': [=: `list('red', 'green', 'blue', 'black')`, =>ColorsList] [List.SelectColumns: values={=ColorsList}, columnIndices=0;1;2;3, condition="startsWith(value, 'b')", mode=Normal, storeAs=Selected1]
Outputs: blue;black

Example 12

Select the required items from an array of JObjects where the 'Item' contains 'keep':

// Example 12 - Select the required items from an array of JObjects where the 'Item' contains 'keep': [Array:     value=`[         {"Item":"item1-to-skip","Index":0},         {"Item":"item2-to-keep","Index":1},         {"Item":"item3-to-keep","Index":2},         {"Item":"item4-to-keep","Index":3},         {"Item":"item5-to-skip","Index":4}     ]`,     =>TheArray] // Select the required items [List.SelectColumns: values={=TheArray}, columnIndices=0;1;2;3;4, condition="contains(jPath(value, 'Item'), 'keep')", mode=Normal, storeAs=Selected]
Outputs: {"Item":"item2-to-keep","Index":1};{"Item":"item3-to-keep","Index":2};{"Item":"item4-to-keep","Index":3}
An unhandled error has occurred. Reload 🗙