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
[Cisco.SerialNumberProperty:]
Inserts a property for the given Cisco serial number(s).
Macro Compatibility
The macro can be used in all input document types and in Report Studio.
Parameter | Type | Deprecation Message | Preferred Parameter | Presence | Purpose | Options | Default |
---|---|---|---|---|---|---|---|
List<String> | Deprecated | serialNumbers | The serial number(s) containing the item. Use the character ; between items, or any character set using the delimiter parameter. | N/A | N/A | ||
List<String> | Use instead of:
| Mandatory | The serial number(s) containing the item. Use the character ; between items, or any character set using the delimiter parameter. | N/A | N/A | ||
String | Optional | Post processing formula. Use {value} for the macro output, e.g. {value}/1024. | N/A | N/A | |||
Boolean | Optional | Whether to color table cells if thresholds are breached, rather than color the text. |
|
true | |||
String | Optional | Add a comment to make your document template more readable. The comment is discarded in the output document. | N/A | N/A | |||
String | Optional | The name of the Cisco Connection. | N/A | N/A | |||
DateTimeOffset | Optional | The macro is considered 'critical' if the output is after this DateTime UTC. | N/A | N/A | |||
DateTimeOffset | Optional | The macro is considered 'critical' if the output is before this DateTime UTC. | N/A | N/A | |||
String | Optional | The macro is considered 'critical' if the output is equal to this value. | N/A | N/A | |||
Color | Optional | The critical font background color to use. If omitted, no change is made. |
|
N/A | |||
Boolean | Optional | Change the font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |||
Color | Optional | The critical font color to use. If omitted, no change is made. |
|
N/A | |||
Double | Optional | Change the critical font size in points. If omitted, no change is made. |
|
N/A | |||
String | Optional | The macro is considered 'critical' if the output is greater than or equal to this value. | N/A | N/A | |||
String | Optional | The macro is considered 'critical' if the output is greater than this value. | N/A | N/A | |||
String | Optional | The macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |||
String | Optional | The macro is considered 'critical' if the output is less than or equal to this value. | N/A | N/A | |||
String | Optional | The macro is considered 'critical' if the output is less than this value. | N/A | N/A | |||
String | Optional | The macro is considered 'critical' if the output is not equal to this value. | N/A | N/A | |||
Color | Optional | The critical table cell background color to use. |
|
N/A | |||
Char | Optional | The delimiter to use for any input parameters that allow multiple items (like properties). | N/A | ; | |||
DateTimeOffset | Optional | The macro is considered 'error' if the output is after this DateTime UTC. | N/A | N/A | |||
DateTimeOffset | Optional | The macro is considered 'error' if the output is before this DateTime UTC. | N/A | N/A | |||
String | Optional | The macro is considered 'error' if the output is equal to this value. | N/A | N/A | |||
Color | Optional | The error font background color to use. If omitted, no change is made. |
|
N/A | |||
Boolean | Optional | Change the error font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |||
Color | Optional | The error font color to use. If omitted, no change is made. |
|
N/A | |||
Double | Optional | Change the error font size in points. If omitted, no change is made. |
|
N/A | |||
String | Optional | The macro is considered 'error' if the output is greater than or equal to this value. | N/A | N/A | |||
String | Optional | The macro is considered 'error' if the output is greater than this value. | N/A | N/A | |||
String | Optional | The macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |||
Boolean | Optional | Whether to error if the requested property is missing. If set to false, whatever data has been received will be returned. |
|
true | |||
String | Optional | The macro is considered 'error' if the output is less than or equal to this value. | N/A | N/A | |||
String | Optional | The macro is considered 'error' if the output is less than this value. | N/A | N/A | |||
String | Optional | The macro is considered 'error' if the output is not equal to this value. | N/A | N/A | |||
Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |||
Color | Optional | The error table cell background color to use. |
|
N/A | |||
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 | |||
DateTimeOffset | Optional | The macro is considered 'fatal' if the output is after this DateTime UTC. | N/A | N/A | |||
DateTimeOffset | Optional | The macro is considered 'fatal' if the output is before this DateTime UTC. | N/A | N/A | |||
String | Optional | The macro is considered 'fatal' if the output is equal to this value. | N/A | N/A | |||
Color | Optional | The fatal font background color to use. If omitted, no change is made. |
|
N/A | |||
Boolean | Optional | Change the fatal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |||
Color | Optional | The fatal font color to use. If omitted, no change is made. |
|
N/A | |||
Double | Optional | Change the fatal font size in points. If omitted, no change is made. |
|
N/A | |||
String | Optional | The macro is considered 'fatal' if the output is greater than or equal to this value. | N/A | N/A | |||
String | Optional | The macro is considered 'fatal' if the output is greater than this value. | N/A | N/A | |||
String | Optional | The macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |||
String | Optional | The macro is considered 'fatal' if the output is less than or equal to this value. | N/A | N/A | |||
String | Optional | The macro is considered 'fatal' if the output is less than this value. | N/A | N/A | |||
String | Optional | The macro is considered 'fatal' if the output is not equal to this value. | N/A | N/A | |||
Color | Optional | The fatal table cell background color to use. |
|
N/A | |||
Color | Optional | The font background color to use. |
|
N/A | |||
Boolean | Optional | Change the font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |||
Color | Optional | The font color to use. |
|
N/A | |||
Double | Optional | Change the font size in points. If omitted, no change is made. |
|
N/A | |||
String | Optional | The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings. | N/A | N/A | |||
Boolean | Optional | Whether to hide the macro output. |
|
false | |||
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 | |||
DateTimeOffset | Optional | The macro is considered 'info' if the output is after this DateTime UTC. | N/A | N/A | |||
DateTimeOffset | Optional | The macro is considered 'info' if the output is before this DateTime UTC. | N/A | N/A | |||
String | Optional | The macro is considered 'info' if the output is equal to this value. | N/A | N/A | |||
Color | Optional | The info font background color to use. If omitted, no change is made. |
|
N/A | |||
Boolean | Optional | Change the info font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |||
Color | Optional | The info font color to use. If omitted, no change is made. |
|
N/A | |||
Double | Optional | Change the info font size in points. If omitted, no change is made. |
|
N/A | |||
String | Optional | The macro is considered 'info' if the output is greater than or equal to this value. | N/A | N/A | |||
String | Optional | The macro is considered 'info' if the output is greater than this value. | N/A | N/A | |||
String | Optional | The macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |||
String | Optional | The macro is considered 'info' if the output is less than or equal to this value. | N/A | N/A | |||
String | Optional | The macro is considered 'info' if the output is less than this value. | N/A | N/A | |||
String | Optional | The macro is considered 'info' if the output is not equal to this value. | N/A | N/A | |||
Color | Optional | The info table cell background color to use. |
|
N/A | |||
Char | Optional | The delimiter to use between each set of items in the output list. Each serial number results in a list item. | N/A | ; | |||
MacroMode | Optional | The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List |
|
Legacy | |||
Color | Optional | The normal font background color to use. If omitted, no change is made. |
|
N/A | |||
Boolean | Optional | Change the normal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |||
Color | Optional | The normal font color to use. If omitted, no change is made. |
|
N/A | |||
Double | Optional | Change the normal font size in points. If omitted, no change is made. |
|
N/A | |||
Color | Optional | The normal table cell background color to use. If omitted, no change is made. |
|
N/A | |||
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 | |||
Normal mode |
Boolean | Optional | Any macros that output lists can optionally (in Normal mode) output a jArray instead. |
|
true | ||
Int32 | Optional | For product info properties, there may be multiple entries. When this is set, the Nth item is returned. When this is not set, the LAST item is returned. |
|
N/A | |||
List<CiscoSerialNumberProperty> | Use instead of:
| Optional | The properties to list. Omit this parameter to include all properties in the default order. |
|
CoverageStatusIsCovered;CoverageStatusEndDate;CoverageStatusSerialNumber;CoverageSummaryContractSiteAddress1;CoverageSummaryContractSiteCity;CoverageSummaryContractSiteCountry;CoverageSummaryContractSiteCustomerName;CoverageSummaryContractSiteStateProvince;CoverageSummaryCoveredProductLineEndDate;CoverageSummaryId;CoverageSummaryIsCovered;CoverageSummaryParentSerialNumber;CoverageSummarySerialNumber;CoverageSummaryServiceContractNumber;CoverageSummaryServiceLineDescription;CoverageSummaryWarrantyEndDate;CoverageSummaryWarrantyType;CoverageSummaryWarrantyTypeDescription;CoverageSummaryBasePidList;ProductInformationCount;ProductInformationBasePid;ProductInformationFormFactor;ProductInformationId;ProductInformationOrderablePid;ProductInformationOrderableStatus;ProductInformationCategory;ProductInformationName;ProductInformationSeries;ProductInformationSerialNumber;ProductInformationSubcategory;ProductInformationSupportPage;ProductInformationType;ProductInformationReleaseDate;ProductInformationVisioStencilUrl;ProductInformationWeight;ProductInformationDimensionsFormat;ProductInformationDimensionsValue;ProductInformationLargeImageUrl;ProductInformationSmallImageUrl;EoxInformationEolProductId;EoxInformationInputType;EoxInformationInputValue;EoxInformationProductBulletinUrl;EoxInformationProductBulletinNumber;EoxInformationProductDescription;EoxInformationEndOfRoutineFailureAnalysisDate;EoxInformationEndOfSaleDate;EoxInformationEndOfSecurityVulnerabilitySupportDate;EoxInformationEndOfServiceContractRenewalDate;EoxInformationEndOfServiceAttachDate;EoxInformationEndOfSoftwareMaintenanceReleasesDate;EoxInformationEoxErrorDataType;EoxInformationEoxErrorDataValue;EoxInformationEoxErrorDescription;EoxInformationEoxExternalAnnouncementDate;EoxInformationLastSupportDate;EoxInformationUpdatedDate;EoxInformationMigrationInformation;EoxInformationMigrationOption;EoxInformationMigrationProductId;EoxInformationMigrationProductInfoUrl;EoxInformationMigrationProductName;EoxInformationMigrationStrategy;EoxInformationMigrationPidActiveFlag | ||
List<CiscoSerialNumberProperty> | Deprecated | properties | The properties to list. Omit this parameter to include all properties in the default order. |
|
CoverageStatusIsCovered;CoverageStatusEndDate;CoverageStatusSerialNumber;CoverageSummaryContractSiteAddress1;CoverageSummaryContractSiteCity;CoverageSummaryContractSiteCountry;CoverageSummaryContractSiteCustomerName;CoverageSummaryContractSiteStateProvince;CoverageSummaryCoveredProductLineEndDate;CoverageSummaryId;CoverageSummaryIsCovered;CoverageSummaryParentSerialNumber;CoverageSummarySerialNumber;CoverageSummaryServiceContractNumber;CoverageSummaryServiceLineDescription;CoverageSummaryWarrantyEndDate;CoverageSummaryWarrantyType;CoverageSummaryWarrantyTypeDescription;CoverageSummaryBasePidList;ProductInformationCount;ProductInformationBasePid;ProductInformationFormFactor;ProductInformationId;ProductInformationOrderablePid;ProductInformationOrderableStatus;ProductInformationCategory;ProductInformationName;ProductInformationSeries;ProductInformationSerialNumber;ProductInformationSubcategory;ProductInformationSupportPage;ProductInformationType;ProductInformationReleaseDate;ProductInformationVisioStencilUrl;ProductInformationWeight;ProductInformationDimensionsFormat;ProductInformationDimensionsValue;ProductInformationLargeImageUrl;ProductInformationSmallImageUrl;EoxInformationEolProductId;EoxInformationInputType;EoxInformationInputValue;EoxInformationProductBulletinUrl;EoxInformationProductBulletinNumber;EoxInformationProductDescription;EoxInformationEndOfRoutineFailureAnalysisDate;EoxInformationEndOfSaleDate;EoxInformationEndOfSecurityVulnerabilitySupportDate;EoxInformationEndOfServiceContractRenewalDate;EoxInformationEndOfServiceAttachDate;EoxInformationEndOfSoftwareMaintenanceReleasesDate;EoxInformationEoxErrorDataType;EoxInformationEoxErrorDataValue;EoxInformationEoxErrorDescription;EoxInformationEoxExternalAnnouncementDate;EoxInformationLastSupportDate;EoxInformationUpdatedDate;EoxInformationMigrationInformation;EoxInformationMigrationOption;EoxInformationMigrationProductId;EoxInformationMigrationProductInfoUrl;EoxInformationMigrationProductName;EoxInformationMigrationStrategy;EoxInformationMigrationPidActiveFlag | ||
Char | Optional | The delimiter to use between each property in the output. Properties for each serial number are delimited by this. | N/A | ^ | |||
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). |
|
false | |||
Normal mode |
Boolean | Optional | 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. |
|
false | ||
String | Optional | The variable to store the result as. | N/A | N/A | |||
String | Optional | The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'. | N/A | N/A | |||
Char | Optional | 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 | ; | |||
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 | |||
Char | Optional | The delimiter to use between each sub-list in the output. Any sub-lists (such as EoxInformationMigrationXXX) are delimited by this. | N/A | | | |||
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 | |||
DateTimeOffset | Optional | The macro is considered 'warning' if the output is after this DateTime UTC. | N/A | N/A | |||
DateTimeOffset | Optional | The macro is considered 'warning' if the output is before this DateTime UTC. | N/A | N/A | |||
String | Optional | The macro is considered 'warning' if the output is equal to this value. | N/A | N/A | |||
Color | Optional | The warning font background color to use. If omitted, no change is made. |
|
N/A | |||
Boolean | Optional | Change the warning font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |||
Color | Optional | The warning font color to use. If omitted, no change is made. |
|
N/A | |||
Double | Optional | Change the warning font size in points. If omitted, no change is made. |
|
N/A | |||
String | Optional | The macro is considered 'warning' if the output is greater than or equal to this value. | N/A | N/A | |||
String | Optional | The macro is considered 'warning' if the output is greater than this value. | N/A | N/A | |||
String | Optional | The macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |||
String | Optional | The macro is considered 'warning' if the output is less than or equal to this value. | N/A | N/A | |||
String | Optional | The macro is considered 'warning' if the output is less than this value. | N/A | N/A | |||
String | Optional | The macro is considered 'warning' if the output is not equal to this value. | N/A | N/A | |||
Color | Optional | The warning table cell background color to use. |
|
N/A |
Examples (1)
Example 1:
This example displays a serial number's product information release date:
[Cisco.SerialNumberProperty: serialNumbers=NWG12345678;NWG12345679;NWG12345680, properties=ProductInformationReleaseDate;ProductInformationSubcategory]