3.2.4.3.3 File Management Job Macros

This section specifies the macro variables that are used by notification actions for file management jobs (see the table later in this topic which lists the file management job macro variables). They are usable in the following methods:

• MailSubject (get) (section 3.2.4.2.5.11), MailSubject (put) (section 3.2.4.2.5.12)

• MessageText (get) (section 3.2.4.2.5.13), MessageText (put) (section 3.2.4.2.5.14)

• MessageText (get) (section 3.2.4.2.8.3), MessageText (put) (section 3.2.4.2.8.4)

• Arguments (get) (section 3.2.4.2.9.3), Arguments (put) (section 3.2.4.2.9.4)

As specified in section 3.2.1.7, when a file management job is executed that results in an action being performed on a file, the file for which the action is triggered is called the source file. The source file can have various attributes that are used to resolve file management job macros:

Source file paths: Paths that are formatted in various ways to be accessible from local and remote machines such as:

Drive path format: A drive path.

System path format: A path starting with a volume identifier. For more information, see volume GUID path in [MSDN-NV].

Remote path format: The remote path format is the remote path to the object in Universal Naming Convention (UNC) format.

Owner information for the source file path: The email address associated with the owner of the source file path. The owner is a specific user account associated with the object at the moment of creation. For more information, see [MSDN-ONO]. An owner of an object can be associated with one or more email addresses.

In addition to the source file path, the file management job can be configured with various attributes that are used to resolve file management job macros:

File management task name: The configured name for the file management job.

File management path: The configured path (namespace) on which the file management job is configured to execute. The files under this path are the files on which actions can be performed. As specified in the previously defined source file path attribute, the file management path could be formatted in various ways (directory path, remote path and system path).

Destination directory: The path to which a file management job configured to expire files, moves source files specified above. This path is stored and retrieved in the same format as configured.

Summary file paths: The drive paths to files that store lists of source files (specified above) on which the file management job resulted in actions. The file that contains all source file paths on which the action was performed successfully is called the result list file. The file that contains all source file paths on which the action resulted in errors is called the error list file. Both the result and error list files can be created and populated with contents by the file management job using file system functions.

Attributes: The following are attributes of the resulting file management action when the file management job is executed:

File management action date: The date on which the file management job resulted in an action on files (specified as source file above). This date can be queried from the operating system. For more details, see the material on notification period specified in section 3.2.1.7.1.

Number of files: The count of files on which the file management job resulted in an action being performed. This count is maintained by the file management job when it is executed. For more details see the material on notifications specified in section 3.2.1.7.1.

Days before file action: The estimate of how many days are left before the file management task performs an action on a file. This estimate is computed by the file management job when it is executed and is based on the configured conditions to be applied on the file. This can affect the date when the file could be acted on.

If any attributes could not be expanded while resolving a macro, the macro MUST be left unresolved.

Macro variables	Type of resolved macro value	Description
[Source File Path]	File path	The drive path format of the file management job source file path. See the preceding description of the source file path attribute of the file management job.
[Source File Remote Paths]	File path	Remote path format of the file management job source file path. See the preceding description of the source file path attribute of the file management.
[Source File Owner]	Owner of file path	Owner of the source file of the file management job. See the preceding description of the source file owner attribute of the file management job.
[Source File Owner Email]	Email address of owner of file path	Email address of the owner of the source file of the file management job. See the preceding description of the source file owner email address attribute of the file management job.
[Result List File]	File path	Path to the file that contains all the files with action applied during an execution of file management job. See the preceding description of the result list file attribute of the file management job.
[Error List File]	File path	Path to the file that contains all source file paths on which the action resulted in errors during an execution of a file management task. See the preceding description of the error list file attribute of the file management job.
[Destination Directory]	Expiration directory (section 3.2.1.7.1)	The directory to which files are expired. See the preceding description for destination directory attribute of the file management job.
[Task Name]	Task name (section 3.2.1.7.1)	The file management task name. See the preceding description of the task name attribute of the file management job.
[File Action Date]	Date	The date when a file management task applies an action to a source file. See the preceding description of the file action date attribute of the file management job.
[Days Before File Action]	Number indicating count of days	Number of days before a file management task applies an action to a source file. See the preceding description of the days before file action attribute of the file management job.
[Number Of Files Under Action]	Number indicating the count of files	Number of files with an action applied during an execution of a file management job. See the preceding description of the number of files under action attribute of the file management job.
[File Management Path]	File path	Drive path format of the file management job path. See the preceding description of the file management path attribute of the file management job.
[File Management Remote Paths]	File path	Remote path format of the file management job path. See the preceding description of the file management path attribute of the file management job.
[File Management System Path]	File path	System path format of the file management job path. See the preceding description of the file management path attribute of the file management job.