ReportMagic

[File.SaveObject:]

Saves a JObject to a JSON file.

This macro is partially execute-restricted. Details in the Usage or Parameters section. See Connection Role Security and Restricted Macros.

Compatibility

The macro can be used in the highlighted input document types only. A greyed-out icon indicates not supported.

Usage

File conflict behaviour is handled by the optional 'fileConflict' parameter. This macro will fail if the destination folder (or existing file to overwrite) is read-only. The Schedule must be locked by an Admin to be able to run this macro.

Parameters (14)

Grouped View

Mandatory (2)

Parameter	Type	Purpose	Options	Default
fileName	String	The path and filename to write to, relative to your Tenant's root folder. The file extension must be .json or a macro error will occur. Filenames may not contain any of these characters: '\', '..', '~', '"', '*', ':', '<', '>', '?' or '\|'	N/A	N/A
jObject	JObject	The input JObject. This can be JSON-formatted string, or a previously created variable.	N/A	N/A

Behaviour (8)

Parameter	Type	Presence	Purpose	Options	Default
desiredExecutionResult	List<ExecutionResult>	Optional	If specified, asserts the expected execution result of the macro. Accepts a single value or a semicolon-separated list of acceptable values (e.g. 'Success;Warning'). The macro executes normally; if the actual result matches any of the desired values, 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' and 'Stopped'.	Cancelled Deferred MacroError NeverRun Paused Pending Running Stopped Success SystemError Warning WorkerStopped	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
expectedType	String	Optional	If 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	String	Optional	If 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
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 theObject, 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
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

Output (3)

Parameter	Type	Presence	Purpose	Options	Default
fileName	String	Mandatory	The path and filename to write to, relative to your Tenant's root folder. The file extension must be .json or a macro error will occur. Filenames may not contain any of these characters: '\', '..', '~', '"', '*', ':', '<', '>', '?' or '\|'	N/A	N/A
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
failureVariable	String	Optional	The 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

General (3)

Parameter	Type	Presence	Purpose	Options	Default
jObject	JObject	Mandatory	The input JObject. This can be JSON-formatted string, or a previously created variable.	N/A	N/A
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
fileConflict	ConflictResolutionType	Optional	The behaviour for file conflicts. If the file does not already exist, it will be created. If the file does already exist: 1) 'error' results in a macro error - the file is not overwritten. 2) 'skip' results in success - the file is not overwritten. 3) 'skipWithWarning' results in warning - the file is not overwritten. 4) 'replace' - overwrites the file, destroying the original contents. 4) 'merge' - adds the input JObject to the file: if the file contains one or more JObjects, or a JArray, the contents will be repackaged as a JArray and the input JObject will be appended to the end as the last element of the JArray.	Error Merge Replace Skip SkipWithWarning	Error

Examples (3)

Example 1

This basic example creates a JObject and saves it to a file:

// Create a JObject
[Object: value=`{ "I am Object 1" : [ true, false ] }`, =>TheObject1]

// Save it to a .json file
[File.SaveObject: fileName=Output/MyObject.json, jObject={=TheObject1}]

Example 2

This example example creates a JObject and saves it, only if "abcd" contains "a" (which it does):

// Create a JObject
[Object: value=`{ "I am Object 1" : [ true, false ] }`, =>TheObject1]

// Save it to a .json file, based on an NCalc condition
[File.SaveObject: fileName=Output/MyObject.json, jObject={=TheObject1}, if="contains('abcd', 'a')"]

Example 3

This example creates two JObjects and saves the first one to a file, then merges the second with it (using 'fileConflict=Merge'), resulting in a JArray containing both JObjects:

// Create two JObjects
[Object: value=`{ "I am Object 1" : "Hello" }`, =>TheObject1]
[Object: value=`{ "I am Object 2" : 123 }`, =>TheObject2]

// Save the first to a .json file
[File.SaveObject: fileName=Output/ManyObjects.json, jObject={=TheObject1}]

// Save the second to the same .json file - results in a merge and the file contents repackaged into a JArray containing both objects
[File.SaveObject: fileName=Output/ManyObjects.json, jObject={=TheObject2}, fileConflict=Merge]

Compatibility

Usage

Examples (3)

Example 1

Example 2

Example 3

Search

Reconnection

Reconnection

Reconnection