Macro Attributes

Attribute

Description

Applicable Host Types

[DestFileName]

The filename of the most recent destination file, not including any directory names. For example: "report12.txt". This is used primarily in per-file Next Actions- Send Email or Run Task.

All

[DestFolderPath]

The folder path, including all folder components but not the filename, of the most recent destination file. For example: /pub/reports . This is used primarily in per-file Next Actions- Send Email or Run Task.

All

[ErrorCodeFile]

The last error code encountered for the current file, or 0 if no error. For an example of how to use this macro to report errors, see Next Actions- Send Email or Run Task.

All

[ErrorDescriptionFile]

The last error description encountered for the current file, or empty if no error. For an example of how to use this macro to report errors, see Next Actions- Send Email or Run Task.

All

[ErrorCodeTask]

The last error code encountered for this task, or 0 if no error. For an example of how to use this macro to report errors, see Next Actions- Send Email or Run Task.

All

[ErrorDescriptionTask]

The last error description encountered for this task, or empty if no error. For an example of how to use this macro to report errors, see Next Actions- Send Email or Run Task.

All

[FileDateStamp]

The date stamp of the file as recorded by the source, in the form YYYY-MM-DD HH:MM:SS. Not all sources provide date stamps.

When using this macro in a destination filename or folder name, you usually combine it with macro string functions. For example, [LEFT([FileDateStamp],10)] yields the YYYY-MM-DD date part and [MID([FileDateStamp],12,2)] will yields the hour from the date and time information of the original source file..

File System, FTP (most), MOVEit Transfer, SSH

[FileSize]

The size of the file, in bytes, as recorded by the source. Note: some unusual FTP servers do not provide the file size; in these cases, a size of 0 is used.

File System, FTP (most), MOVEit Transfer, SSH

[FolderID]

Unique number identifying a MOVEit folder. For example: 1236518 .

MOVEit Transfer

[FolderName]

Name of remote folder. This macro returns only the last part of the path. Example: Given a full remote path of frog\dog\cat , this macro returns cat .

File System, FTP, MOVEit Transfer, SSH

[FullPath]

The full path of the file as it was on the source, including all directories and the filename.

File System, FTP, MOVEit Transfer, SSH

[ID]

Unique number identifying a MOVEit file. For example: 251660214 .

MOVEit Transfer

[NominalStart]

The time this task was officially started in YYYY-MM-DD HH:MM:SS:MS format (for example, 2006-07-18 11:33:16:03). This value combined with the TaskID yields a key that uniquely identifies a single task run, for example, in the "stats" database table.

All

[OrigComment]

The upload comment that was specified when the file was uploaded. (This is often blank.)

MOVEit Transfer

[OrigName]

Original name of this file. Example: Example.txt

File System, FTP, MOVEit Transfer, SSH

[OrigUser]

The username of the user who uploaded the file.

MOVEit Transfer

[OrigUserEmail]

The email address of the user who uploaded the file.

MOVEit Transfer, POP3

[OrigUserFull]

The full name of the user who uploaded the file.

MOVEit Transfer

[OrigUserID]

The UserID of the user who uploaded the file, if the MOVEit Transfer host is version 5.5 or later. If the MOVEit Transfer host is an earlier version, this will be the empty string. (The UserID is typically a long string starting with the username; a typical UserID might be "fred9zyupmuxa6dk".)

MOVEit Transfer

[OnlyName]

The original filename minus the extension and the period. Example: Given "frog.txt", this macro returns "frog".

File System, FTP, MOVEit Transfer, SSH

[OnlyExt]

The original filename extension. Example: Given "frog.txt", this macro returns "txt".

File System, FTP, MOVEit Transfer, SSH

[Parm:ParmName]

Returns the task parameter named ParmName. If there is no such parameter, the empty string is returned.

All

[ParmDisplay:ParameterName]

Masks the value if a parameter is secure. It returns a secure parameter's value placeholder ("(suppressed)") or returns an unsecured parameter's value.

[RelativePath]

The pathname of the directory for this file, relative to the originally specified source path. This applies only when Include Subdirectories is selected, and cannot be used for source paths. For example, if the source path is C:\outgoing and the file in question is C:\outgoing\reports\Fred.txt , then when used in a destination path, [RelativePath] is reports .

File System, FTP, MOVEit Transfer, SSH

[Rnd]

A random decimal number. Use the format [Rnd:len] where len is the desired number of digits. The random number generator is of cryptographic quality.

All

[SyncReport()]

Synchronization tasks can use a [SyncReport()] macro that allows a complete report of all synchronization actions to be sent in a Next Action email notification.

For more information, see Macro - Sending Sync Actions in Next Action Email

Next Actions Following Sync Tasks

[TaskID]

The ID of the task that is running. This number is used internally in the configuration files and the database to identify tasks. A typical value would be a nine-digit number such as 618116254 .

All

[TaskName]

The name of the task that is running

All

[TaskStatus]

The status of the task that is running. Values:

• Success - the task encountered no errors and processed at least one file or ran at least one script
• Failure - the task encountered one or more errors
• No xfers - the task encountered no errors but did not process any files or run any scripts.

All

[Date specification] (see below)

Current date and time. Example: Given a time of 10:06 and a macro of [HH][TT] , the macro returns 1006 .

File System, FTP, MOVEit Transfer, SSH

[Macro function](see below)

Returns the results of a string operation

All