3.2.4.3.2 File Screen Macros

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

As specified in section 3.2.7.4, I/O operations happening on a path with a file screen, can trigger a file screen event if the file name of the I/O is included in the set of file names defined by the file name patterns in the file groups blocked by the file screen. The file path on which the file screen event was triggered is called the source file path. The source file path can have various attributes that are used to resolve file screen macros:

A source file path: Source file paths can be formatted in various ways to be accessible from local and remote machines, including the following:

The owner information of the object that is represented by the source file path: The owner is a specific user account associated with the object at the moment of its creation. For more information, see the description of owner in [MSDN-ONO].

One or more email addresses can be associated with the owner of the object represented by the source file path.

The identifier for the process: A process identifier (PID) identifies the process that accessed the object represented by the source file path.

The name of process image of the process that accessed the object represented by the source file path: The process image name is a string representing the command line associated with the process.

The file screen settings configured on the file path: File screen settings contain details of file groups and notifications that were configured on the parent directories under which the file represented by the path was accessed that fired the event. See File Screen Model (section 3.2.1.3) for details of file screen settings. File screen parent directory paths could be formatted in various ways like the source file path described in the preceding section (directory paths, system paths and remote paths).

The owner attributes of the I/O incurred on the path: The owner represents the user account under which the application incurring the I/O was accessing the source file path. This user account might be associated with one or more email addresses.

If any attributes of a source file path could not be expanded while resolving a macro for the source path, the macro MUST be left unresolved.

Macro variables

Type of resolved macro value

Description

[File Screen Path]

File Screen.Folder path (section 3.2.1.3.1)

The directory path of the file screen.

[File Screen System Path]

File Screen.Folder path (section 3.2.1.3.1)

The remote paths of the file screen.

[Violated File Group]

Blocked file groups (section 3.2.1.3.1)

The file screen event source file group.

[Source File Path]

File path

The drive path format of the file screen source file path. For more details, see the description for the path attribute of the source file path of a file screen notification earlier in this section.

[Source File Remote Paths]

File path

The remote paths in remote path format of the file screen source file path. For more details, see the description for the path attribute of the source file path of a file screen notification earlier in this section.

[Source File Owner]

Owner of file path

The owner of the source file of the file screen event. For more details, see the description for the owner attribute of the source file path of a file screen notification earlier in this section.

[Source File Owner Email]

The email address of owner of file path.

The owner email of the source file path of the file screen event. For more details, see the description for the owner email address attribute of the source file path of a file screen notification earlier in this section.

[Source Process Id]

Process ID

The process identifier of the source file of the file screen event. For more details, see the description for the process identifier attribute of the source file path of a file screen notification earlier in this section.

[Source Process Image]

Process Image Name

The process image name of the source file of the file screen event. For more details, see the description for the process image name attribute of the source file path of a file screen notification earlier in this section.

[Source Io Owner]

User account that incurred the I/O.

The owner of the I/O incurred on the source path of the file screen event. For more details, see the description for the owner attributes for I/O incurred in the source file path of a file screen notification earlier in this section.

[Source Io Owner Email]

The email address of user account that incurred the I/O.

The owner email address of the I/O incurred on the source path of the file screen event. For more details, see the description for the owner attributes for I/O incurred in the source file path of a file screen notification earlier in this section.