ReportMagic

[File.Copy:]

Copies a file or list of files to the specified file system destination.

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

Purpose

Copies a file or list of files, with the root folder being the user's top-level directory visible in the Files page.

Compatibility

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

Usage

If the destination folder does not exist, it is created. Copying folders between systems are copied file by file. Conflict resolution is determined by optional parameters: Error -> Stops executing with an error. Skip -> Does not copy. SkipWithWarning -> Does not copy and also adds a warning to the macro. Replace (Local file system) -> Deletes the file or folder first. Replace (Between systems) -> Performs same as Merge. Merge -> Folders only, adds the missing files to existing folders. will fail with SFTP and SharePoint destination file systems that are read-only, and cannot be run unless the Schedule is locked by an Admin ("admin-locked").

Parameters (15)

Grouped View

Mandatory (2)

Parameter	Type	Purpose	Options	Default
destination	String	The destination folder where the files will be copied to.	N/A	N/A
source	List<String>	The source folder where the files will be copied from.	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 (2)

Parameter	Type	Presence	Purpose	Options	Default
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 (5)

Parameter	Type	Presence	Purpose	Options	Default
destination	String	Mandatory	The destination folder where the files will be copied to.	N/A	N/A
source	List<String>	Mandatory	The source folder where the files will be copied from.	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 resolution for file conflicts.	Error Merge Replace Skip SkipWithWarning	Error
folderConflict	ConflictResolutionType	Optional	The resolution for folder conflicts.	Error Merge Replace Skip SkipWithWarning	Error

Examples (5)

Example 1

Copies the files folder to the output folder.

[File.Copy: source=/Input/files, destination=/output/]

Example 2

Copies the file.png file but renames when saving.

[File.Copy: source=/Input/file.png, destination=/output/file2.png]

Example 3

Copies the file.png file to the output folder.

[File.Copy: source=/Input/file.png, destination=/output]

Example 4

Copies the 2 files to the output folder.

[File.Copy: source=/Input/file1.png;/Input/file2.png, destination=/output]

Example 5

Copies the 2 files to the output folder, skips if exist in destination folder.

[File.Copy: source=/Input/file1.png;/Input/file2.png, destination=/output, folderConflict=Skip]

Purpose

Compatibility

Usage

Examples (5)

Example 1

Example 2

Example 3

Example 4

Example 5

Search

Reconnection

Reconnection

Reconnection