---

Macro Compatibility

---

Parameter	Type	Presence	Purpose	Options	Default
id	Int32	Conditional	The ID of the DataMagicSync to execute.	N/A	N/A
name	String	Conditional	The name of the DataMagicSync to execute.	N/A	N/A
await	Boolean	Optional	Whether to wait for the DataMagicSyncExecution to complete before proceeding.	true false	true
comment	String	Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
failureText	String	Optional	The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message.	N/A	N/A
if	String	Optional	The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z').	N/A	true
mode	MacroMode	Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed object, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
obfuscation	ObfuscationType	Optional	Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen.	None UkTown DeviceName Company IpAddress PrivateIpAddress	None
syncDimensions	Boolean	Optional	Whether to sync dimension data.	true false	true
syncEvents	Boolean	Optional	Whether to sync alert data.	true false	true
syncLogs	Boolean	Optional	Whether to sync log data.	true false	true
syncTimeSeriesData	Boolean	Optional	Whether to sync time series data.	true false	true
syncToDatabase	Boolean	Optional	Whether to sync to database.	true false	true
syncToFile	Boolean	Optional	Whether to sync to file.	true false	true
types	List<DataMagic.Config.BackupType>	Optional	The types of data to back up.	AlertRule AppliesToFunction Collector CollectorGroup ConfigSource Dashboard DashboardGroup DataSource Device DeviceDataSourceInstance DeviceGroup EscalationChain EventSource ExternalAlertDestination JobMonitor Netscan NetscanGroup OpsNotes PropertySource ReportBase ReportGroup Role RoleGroup ScheduledDownTimes SnmpSysOidMap Topology TopologyGroup TopologySource User UserGroup Website WebsiteGroup	Collector;​Device;​Role;​User;​Website;​DeviceGroup;​WebsiteGroup;​CollectorGroup;​UserGroup;​RoleGroup;​ReportGroup;​ReportBase;​EscalationChain;​Dashboard;​DashboardGroup;​AppliesToFunction;​AlertRule;​ConfigSource;​DataSource;​EventSource;​ExternalAlertDestination;​JobMonitor;​Netscan;​NetscanGroup;​OpsNotes;​PropertySource;​ScheduledDownTimes;​SnmpSysOidMap;​Topology;​TopologyGroup;​TopologySource;​DeviceDataSourceInstance
warning	String	Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A

---

Examples (6)

Example 1:

[DataMagic.Sync: name=LogicMonitor]

Outputs:

Immediately returns the created DataMagicSyncExecution for DataMagic Sync with Name=LogicMonitor, not waiting for it to complete.

---

Example 2:

[DataMagic.Sync: id=9]

Outputs:

Immediately returns the created DataMagicSyncExecution for DataMagic Sync with ID=9, not waiting for it to complete.

---

Example 3:

[DataMagic.Sync: name=LogicMonitor, await=true]

Outputs:

Immediately returns the created DataMagicSyncExecution, waiting for it to complete.

---

Example 4:

[DataMagic.Sync: name=LogicMonitor, await=true, types=CollectorGroups;Collectors]

Outputs:

Backs up just collector groups and collectors. Will take about 10 seconds for a typical LogicMonitor portal.

---

Example 5:

[DataMagic.Sync: name=LogicMonitor, await=true, types=CollectorGroups;Collectors, syncToFile=false,  syncToDatabase=true

Outputs:

Backs up just collector groups and collectors. Will take about 10 seconds for a typical LogicMonitor portal.

---

Example 6:

[DataMagic.Sync: name=LogicMonitor, await=true, syncToFile=false,  syncToDatabase=true, syncDimensions=true, syncEvents=false, syncLogs=false, syncTimeSeriesData=true

Outputs:

Backs up just dimensions and time series data.