Magic Suite 3.10

Magic Suite 3.10 has been released with the following changes across all products.

ReportMagic

New Features

• Badges on the Profile -> Badges page now shine.
• This is a Test Ticket Thank You.
• The [ServiceNow.Create:] / [ServiceNow.Update:] / [ServiceNow.Delete:] macros are now execute-restricted and require an admin-locked Schedule to run.
• The Sql.Analysis macro now requires a Database Connection with Connection Role security setup, when using any of ADD, ALTER, APPEND, BACKUP, CREATE, DELETE, DROP, EXEC, INSERT, TRUNCATE, and UPDATE commands.
• Database.XXX macros now require an accessible Agent Connection and an admin-locked Schedule for ADD, ALTER, APPEND, BACKUP, CREATE, DELETE, DROP, EXEC, INSERT, TRUNCATE, and UPDATE commands.
• Agent.SqlXXX macros now require an accessible Agent Connection and an admin-locked Schedule for ADD, ALTER, APPEND, BACKUP, CREATE, DELETE, DROP, EXEC, INSERT, TRUNCATE, and UPDATE commands.
• The [Web.Query:] macro, when using POST / PUT / PATCH / DELETE methods, will now only run in an admin-locked Schedule, and where the Connection is accessible to the user
• Connection Roles now allow Tenant Admins and above to restrict Connection usage.
• Report Studio Open File dialog now has coloured folders/files
• In the Files browser, it is now possible to open a file (e.g. an RM script file) in Report Studio in a new browser tab.
• Details of changes/deletes/creations made to a variety of objects are now present in the Audit Logs
• Added the Admin -> Notifications page.
• The autosave feature of Report Studio now uses the local ReportMagic filesystem, rather than the browser's storage.
• It is now not possible to create multiple Schedules with the same name (for an individual Tenant), both via the ReportMagic API or using the ReportMagic UI.
• Implemented the ability for admins (Tenant, Super, Uber) to lock Schedules, which relates to the ability to run restricted macros.
• Added the [CloudHealth.Query:] macro.
• Added the [LogicMonitor.CollectorExecute:] macro which may only be executed via a report schedule that has ben locked by an administrator.
• Added the [CloudHealth.CustomerReportDetails:] macro.
• Added the [CloudHealth.AvailableReportOptions:] macro.
• Added the [CloudHealth.AvailableReportsList:] macro.
• Added the [CloudHealth.CustomerDetails:] macro.
• Added the [CloudHealth.AssetDetails:] macro.
• Added the [CloudHealth.AssetList:] macro.
• Added the [CloudHealth.CustomerStatementDetails:] macro.
• Added the [CloudHealth.CustomerList:] macro.
• Added the [CloudHealth.AwsAccountDetails:] macro.
• Added the [CloudHealth.AwsAccountsList:] macro.
• Added the [CloudHealth.OrganisationList:] macro.
• Added the [CloudHealth.OrganisationList:] macro.
• Signing into ReportMagic following an upgrade provides a link to the Release Notes page in a pop-up notification.
• The [LogicMonitor.EscalationChainDestinationList: ] and [LogicMonitor.EscalationChainDestinationProperty: ] macros are present and usable in both Normal and Legacy mode
• The [LogicMonitor.Query:] macro (POST method) is only permitted with a visible Connection and an admin-locked Schedule.
• Added the [File.LoadString:] macro, which lets you load a string from a file (not applicable in Report Studio) into a variable, which can then be used in further macros.

Improvements

• The Admin => Connections => Connection Roles table edit/create dialog now has some legal warning text.
• Clearer warning message for graph-based macros that use dynamicYAxisVariancePercent when dynamicYAxis is not set.
• User "_AutoSaves_" folder is now not visible in the Files browser under "My Files".
• Information added to help relating to the different user levels
• Updated the Connection Role Security help (and related) pages.
• In the help for a macro, the Parameters section now includes a count in parentheses of the number of parameters.
• The Batch Progress Page now has the ability to filter reports (in the "Reports" section) by the execution result (warning, macro error, system error, etc.).
• Restore / auto-save supports multiple items. Configured number of days by global settings auto save max days. Files are stored in the _users/id/_AutoSaves_ folder.
• When saving a file in Report Studio, the file is now added to the top of the recently-opened files list.
• In Report Studio, the recently-opened files pop-up now presents a preview area, which shows the file contents when the user clicks on a row in the recents table.
• The selected auto-saved file (accessible from File > Restore) is now highlighted in blue when the row is selected, making it easier to see which file you are previewing.
• To switch between Normal Mode and Legacy Mode in Report Studio, there is a new keyboard shortcut (CTRL + ALT + M). The tooltip on the Mode button in the UI indicates this.
• Added a 'run' button to the restore and recents pop-ups in Report Studio, so that you can restore and run in one action (rather than just restore then need to hit the run button).
• The [Cisco.SerialNumberProperty:] macro now supports multiple properties for one serial number.
• When storing lists and tables in Legacy Mode, the stored string variable now uses the relevant delimiter characters (rather than just the OUTPUT using them).
• PowerPoint now supports the [RepeatRow:] macro, so you can add more rows to tables using the macro.
• PowerPoint now supports the FormatTableCell macro to format a cell's background colour.
• The Admin => Macro Parameter Defaults table now uses the new filterable table. These allow the user to customise the columns, filter, sort, and download to an Excel spreadsheet, etc.
• The Admin => Connections table now uses the new filterable table. These allow the user to customise the columns, filter, sort, and download to an Excel spreadsheet, etc.
• List.SummaryValue macro now honours the calculate parameter in NORMAL mode.
• Cisco.SerialNumberProperty macro now returns (in legacy mode) ALL the product informations for a serial number, joined by the sublistDelimiter character.
• The Cisco.SerialNumberProperty macro now supports the "errorIfPropertyMissing" parameter.
• The [FormatTableRow:] macro is now supported in PowerPoint input document templates, and can set the row's background colour.
• Users tables (e.g. Admin => Users) now allow ID filtering in the URL, for example "/admin/users/5" would only show the user with an ID of 5. This is used by the Search Anything search results, when clicking on a user that was found as a result of the search.
• A pop-up now informs the user when a manually-created DataMagic Sync Exectution has been created, when they area viewing the DataMagic Sync Executions page, so they have the option to refresh the table to see the latest executions.

Bug Fixes

• Users are no longer notified of each others' Badges (only their own, as expected).
• Fixed an issue where Connection Roles would not show for the correct Tenant.
• Fixed an issue where the Connection Roles behaviour did not work as expected.
• Fixed an issue where it was not possible to save edits to an Agent Connection (accessible only by Admins via the Admin => Connections menu).
• Added the Connection Role Security help page, at help/connection_role_security
• Fixed an issue where it was not possible to create an non-Agent / non-Web Connection due to incorrect error message saying that the url / username must be empty.
• When a Schedule uses a form, AND also uses the fileName parameter(s) in the Schedule's Batch Variable field, the Schedule will run as expected and there are no system errors.
• Fixed an issue where, when a Schedule uses PowerPoint input files, and XLSX is checked on the Schedule, the report jobs would fail with a system error.
• Fixed an issue where feedback would not work when the summary was was more than 255 characters (it should be properly truncated).
• Non-logged-in users can now raise feedback again.
• Copy / Paste within the same folder no longer prompts the user to resolve the file conflict with skip/rename/cancel. It now creates a copy of the file without any further user interaction required.
• Fixed an issue with authentication tokens which caused file download to fail.
• Read-only SharePoint connections are now supported by ReportMagic. This means you can set a SharePoint Connection in the UI to be read only and you will not be able to write to it in the Files browser / UI, or when outputting report output.
• It is now possible to upload empty (0 bytes) text (.txt) files to the ReportMagic file system.
• The SearchAndReplace macro now uses 'if' in the examples. In the help, 'condition' is deprecated in favour of 'if'.
• The File.Execute macro now works with the 'if' and 'condition' parameters, as expected.
• Removed the "outputListsAsJarray" parameter from the help for the [LogicMonitor.SdtPercentage:] macro.
• Updated the help for the [LogicMonitor.SdtPercentage:] macro to make it clear that device / deviceId is required when setting dataSourceInstanceId/dataSourceId/dataSourceName parameters.
• The help page for the [LogicMonitor.SdtPercentage:] macro now correctly shows the "graphName" parameter.
• Fixed an incorrect help example for the [LogicMonitor.SdtPercentage:] macro.
• The Restricted Macro help page link, which is on the Connection Role help page, is now present and works correctly.
• Added a help example to show how to use POST in the [LogicMonitor.Query:] macro.
• Fixed broken example #5 of the [SearchAndReplace:] macro.
• The [File.LoadString:] macro now does not show 'outputListsAsJarray' and 'storeAsVariableDelimiter' parameters in its help, as they are not relevant.
• ReportMagic_ReleaseNotesCountShown set to Public to allow Help to be loaded when user not logged in.
• The [Jira.IssueProperty:] macro does now not error in Normal mode when using custom properties (custom:xyz). HOWEVER, these are ignored and normal mode will (by default if no properties are set) include ALL custom fields in the output jObject. To obtain just the custom fields in normal mode use properties=CustomFields.
• Help => Quick Start Tutorials page now loads correctly every time.
• Fixed broken link in API tokens help page.
• Removed the "POST method is disabled" message in the [LogicMonitor.Query:] macro.
• Removed empty bullet in the Connecting to Report Magic help page.
• Updated LogicMonitor HealthCheck document to 3.14 to use correct 'recurseDeviceGroups' parameter (instead of 'recurseDevices') for LogicMonitor.DeviceList macros.
• LogicMonitor Health Check report template has been updated to v3.14. This fixes issues with variable naming.
• Updated LogicMonitor HealthCheck to 3.13.
• Fixed a missing dll issue with the Windows Agent installer.
• Through the API when creating a ReportBatchJob the CreatedBy user should always be the authenticated user (i.e. the owner of the API token when doing this via Postman)
• Report Studio now works as expected again.
• The [LogicMonitor.DeviceDataSourceList;] macro now outputs to the document the text values as expected rather than "System.Linq.Enumerable+DistinctIterator`1[System.String]"
• The [Toggl.ProjectProperty:] macro now accepts the "CreatedOnDateTime" and "UpdatedOnDateTime" properties in Normal Mode.
• [LogicMonitor.InstanceDetailsTable:] macro now does not query every Device Group when the column parameter is set to device.DeviceGroups / device.Groups. This also massively speeds up the macro execution time.
• The cancel button on a schedule / Report Studio etc. now cancels the report within 5 seconds.
• Fixed an issue where it would take a long time for the progress page to load.
• Fixed an issue where the Report Jobs filter by results (on progress page) did not work, and was also obscured when open.
• When a Schedule is set to suppress warnings in the UI, the 'warnings' toggle button in the report jobs table, in the progress page, is now green rather than orange. Filter still works as expected.
• Fixed an issue where it was not possible to view Report Studio output for regular users unless they had certain RBAC permissions.
• RBAC: the correct schedules are now executable matching the Read/Write/Execute permissions specified in the Folder type Role Permission
• The default role is assigned to a user upon approval by an administrator.
• Fixed an issue where, when using the recent files pop-up in Report Studio, and attempting to preview a Word (.docx) file, if the file has since been deleted (but remains in the recents list), then it would fail (as expected) but there would remain on-screen a pop-up saying that the file was being converted to HTML and the UI would then be unusable.
• Fixed an issue with LogicMonitor.SummaryValue where SDTs applied to "All" would be excluded incorrectly.
• The LogicMonitor.HistoricSdtList macro now returns all results as expected.
• Fixed an issue where [LogicMonitor.SummaryValue:] and [LogicMonitor.Graph:] did not accurately assess Active SDT periods when parameter excludeSDT=true was set.
• An entire cancelled batch job does now not attempt to generate output documents for the individual reports, which could lead to long delays / issues if DocMagic (the rendering engine) was unresponsive.
• Fixed an issue where the device/devices parameter was not working as expected for LogicMonitor.Graph macros.
• Fixed an issue with various [LogicMonitor.InstanceGroupList], [LogicMonitor.InstanceGroupCount:] macros only returning 50 items.
• Schedule name uniqueness is now case-insensitive.
• Fixed an issue where various connection-based macros would not work properly for Panoramic Data users switching Tenants while they have a schedule executing.
• Fixed an issue where the LogicMonitor.InstanceGroupList macro would throw an untrapped error message when the connection was not valid / unathorized, when it should have shown a macro error and reason.
• Fixed an issue where using excludeSdt=true in the [LogicMonitor.SummaryValue:] macro with a website ID (where the website name contained strange characters) would cause an error.
• Fixed incorrect aggregation values for the [LogicMonitor.SummaryValueList:] macro.
• Fixed incorrect aggregation values for the [LogicMonitor.SummaryValueList:] macro.
• Debugger commands in HTML / Report Studio do not now result in macro errors.
• Fixed an issue where the [Jira.IssueList:] macro did not return the results as expected.
• Fixed an issue where the [LogicMonitor.SdtList:] macro was not displaying dates.
• Fixed an issue where the [LogicMonitor.SummaryValue:] macro could fail when excludeSdt=true and outputDateTimes=true.
• Fixed an issue where the [Cisco.SerialNumberProperty:] macro did not work as expected in Legacy Mode.
• Fixed an issue where LogicMonitor.SlaWidgetValues macro might fail when parsing properties (when property includes Value) that were not doubles.
• Fixed an issue where the [LogicMonitor.SummaryValueList:] macro would complain that a parameter was missing, when it was not.
• Macros that de-serialize into JObjects now are able to handle the left double quotation character ( “ )
• Fixed a legacy mode issue where macros could be broken when the storeAs / storeAsHidden etc is at the end of a line and the closing macro square bracket is on the next line.
• Deferred macros are now properly updated once the report has run. For example, Email and EmailReport macros.
• Input and Output paths in the Schedule edit / create dialog can now only be selected by using the file picker dialog, to avoid issues with path validation.
• Fixed an issue where, in Report Studio, a regular user would always see an Api Exception message when attempting to run restricted macros (now a macro error is reported).
• Fixed an issue where a user who did not have permissions to run a schedule in the UI, could still run a previously-ran one by going to the batch jobs or progress page where the run button was NOT disabled.
• Fixed an issue where the [LogicMonitor.SummaryValue:] macro might fail only when the difference in hours between the start date and end date parameters was not exactly divisible by 8.
• The [LogicMonitor.InstanceDetailsTable:] macro now fails with a Macro Error if the columns parameter specifices a datapoint that does not exist.
• Fixed the [List.SummaryValue:] macro when handling list of lists in Normal Mode.
• Fixed an issue where batch jobs and report jobs should have been set to worker stopped, but were deleted instead.
• A report schedule must have an email address specified when the Error Handling method is set to anything other than 'Do not stop' before being able to save it.
• LARGE output text and variables on a macro result, or huge variables on a report job, do not now cause an error (incorrect macro counts, failure to process macros, and possibly a worker crash) when sending the macro results to the API. This could occur noticeably when dealing with very large (over 10 MB) json variables, or for report jobs that have a very large number of large variables.
• Cisco.SerialNumberProperty macro can now cope with more than 70 serial numbers.
• Fixed several incorrect macro names in the /help pages (and the Report Studio help popup).
• Fixed an issue where [LogicMonitor.SdtPercentage:] macro might cause an incorrect error saying that an existing Device does not exist when it did actually exist.
• the [LogicMonitor.SdtPercentage:] macro, when erroring, now does not show 'websiteName', 'serviceName' or 'serviceNames'
• Fixed an issue where a system error (rather than a macro error) might occur for the [LogicMonitor.SdtPercentage:] macro, when using a website ID that does not exist.
• The "calculate" parameter now has the correct effect on the output when used with the [LogicMonitor.SdtPercentage:] macro.
• Fixed the [Meraki.NetworkClientList:] macro where, when returning all properties (i.e. properties parameter is not set), would output a "System.Collections.Generic.List" string for the ClientVpnConnections property. This property is excluded as it was never intended to be used.
• Variable.Property macro is now correctly showing value of variable of list types
• [Toggl.ClientList:] and [Toggl.ClientProperty:] now output the IDs in the correct type
• Fixed an issue with the [DateTime:] macro where day/year/other parameters could be outside of valid ranges and cause a system error / stack trace. A macro error is now reported instead.
• The API and UI now prevent the creation of a duplicate user.
• Fixed an issue with the [Email:] macro where it was not possible to have commas in the body.
• Fixed broken property "DeviceDataSourceName" for the LogicMonitor.SdtList macro.
• The [LogicMonitor.InstanceGroupList:] macro now allows you to store the output as a variable as expected, e.g. with "storeAs=MyVar"
• Fixed an issue where is was not possible to create a new Subscription when one has expired for the Tenant who is attempting to create a new one.
• Fixed an issue where [Cisco.SerialNumberProperty:] macro would not work as expected when upper-case was used.
• Fixed an issue where the [Cisco.SerialNumberProperty:] macro would not work as expected when there are multiple serial numbers used and eoxXXX properties are requested.
• On the Admin -> Account page, when accepting the terms of service, the subscribe button is then greyed out / disabled and a spinner is shown, to improve the user experience.
• [Cisco.SerialNumberProperty:] macro now retries when it received a 403 / temporary issue from the API.
• Fixed an issue where, on the Schedule edit/create dialogs, it was not possible to change the clean-up options properly, when saving.
• Fixed the [LogicMonitor.NetscanProperty:] macro in Legacy Mode which was no longer working with the Ddr property. Now both Ddr and DiscoveredDeviceRule properties are supported, as are three additional properties: version, includeNetworkAndBroadcast and IgnoreSystemIpsDuplicates.
• Fixed an issue where lists/tables (normal mode) would ignore any output delimiters in the stored variable representation and just use ; and ^.
• Two Tenants can have the same domain only when the Tenant names are different. Applies in Create / Edit (UI) and POST / PATH (API).
• Deferred email macros that fail now will never generate a system error, but a macro error.
• Fixed an issue where, in Legacy Mode, 'deferred' macros, such as the [Email:] macro, could cause incorrect counts shown in the Progress Page.
• The Cisco.SerialNumberProperty macro now does not error or present blank values in the output, when more than 5 serial numbers are used for productInformationXXX properties.
• Fixed an issue where square brackets in macro output (e.g. visible in the macro results table and in the progress page's macro details "output" row) would appear as black and white lovehearts.
• Shape.Delete macro now respects the Condition parameter.
• Fixed an issue where the [ReportMagic.ConnectionProperty:] macro did not always work as expected, and would generate a System Error.
• Null characters ("\u0000") in [Json.xxx:] macros do not now cause a system error.
• Fixed an issue where it was not possible to re-size 'repeated rows' properly in PowerPoint due to duplicate row IDs.
• Updated the help for the [Toggl.ProjectList:] and [Toggl.ProjectProperty:] macros to make the behaviour of the "parseFromUsDateTimeFormat" parameter clearer (as it already functions as designed).
• The [LogicMonitor.SummaryValue:] macro will now cause a macro error when using the outputDateTimes parameter (only when true) in a multi-instance scenario.
• Fixed an issue whereby [Function:] macros were not being executed in Report Studio when using the Code view.
• Fixed broken Cisco.SerialNumberProperty macro for any CoverageSummaryXXX properties.
• The File => Open dialog in Report Studio now only lists .htm, .html, .txt, and .rmscript files and not other unsupported ones like .pptx and .docx which cannot be opened in Report Studio.
• Graph macros run in rmscript now do not error, but still produce not output except in XLSX files.
• Fixed an issue where the UI could show up to 3 error pop-ups at the same time e.g. if a schedule failed to be created.
• The "monthsToReport" parameter now works as expected when used with the [LogicMonitor.HistoricSdtList:] macro.
• The UI will prevent Notify being set to anything other than None whilst the email address is empty/blank/whitespace. i.e. when it's not "None" then a value must be provided.
• Jira.Issue property now returns all custom properties by default in normal and legacy mode.
• On the Batch Jobs page, the search function now works as expected, whether typing in the search text and pressing enter, or using the button itself to commence the search.
• Fixed an issue where the Run pop-up menu could appear obscured by the "Reports" title bar on the Progress Page.
• The [Jira.IssueAnalysis:] macro now correctly orders rows in the XLSX output. The incorrect ordering was caused by the use of a "parallel foreach" rather than a regular foreach in the macro's code.
• Fixed an issue where the "execution message" on a report job (as shown on the progress page) would show an error message (despite completing successfully) that "sequence contains more than one matching element".
• Fixed an issue where any macro that used the if parameter, where it failed, could cause a system error rather than a macro error.
• ReportStudio now correctly processes all the [Jira.InsertMarkup:] macros in the editor.
• Connections page now shows correct browser table title.
• When the [DateTime:] macro errors with invalid dates, the error message is worded more correctly.
• A poorly-configured Cisco Connection will now be indicated by a red cross on the Connections page.
• Help page "Connecting to reportmagic" now includes the correct url

DataMagic

New Features

• A DataMagicSync can now be triggered by a CRON job.
• It is now possible for a DataMagic Sync to trigger another DataMagic Sync.
• DataMagicSyncs can now run a Schedule upon completion. Choose a Schedule in the UI, hit Run Now. Once it has completed, the Schedule will start and the batch variable will be set accordingly.

Improvements

• On the DataMagic Sync Executions table, any running/pending jobs in the table are automatically updated in real-time i.e. the result, duration etc.

Bug Fixes

• Fixed an issue where data magic sync executions that were created for a Tenant, as a result of running a data magic sync, would show up in the table for all other Tenants.
• Failed DataMagicSyncExecutions are now updated to "Worker Stopped" when the Scheduler restarts, and not left as "Pending" or "Running".
• The TriggeredBy column on the DataMagic Sync Executions table indicates the username who triggered it, when done manually (and a robot icon otherwise).