Share via

3.2.1.3.1 File Screens

  • Article

For each file screen, a minimal set of configuration properties is maintained by the server. The configuration of a file screen consists of all of the information required to define the file screen. A file screen configuration is maintained only for objects with a path on a volume in the Volume List (section 3.2.1).

A File Screen is a type of FSRM Base Object (section 3.2.1.1) that has all the properties and state of a FSRM Base Object. The following configuration data is maintained for each file screen on the system.

File Screen.Folder path: The file screen configuration is associated with a particular folder on the server. If the folder is renamed, the file screen configuration continues to be associated with the renamed folder with the same configuration and state as before the rename.

Blocked file groups: The file screen configuration contains at least one file group that represents the files that the server will prevent from being saved under the folder path. See section 3.2.1.3.4 for details. A protocol client can perform the following management operations involving blocked file groups:

  • Get a list of all the blocked file groups. See section 3.2.4.2.26.1 for details.

  • Add a reference to a file group to the list of blocked file groups. See section 3.2.4.2.2.1 for details.

  • Remove a reference to a file group from the list of blocked file groups. See section 3.2.4.2.2.2 for details.

  • Set the list of blocked file groups. See section 3.2.4.2.26.2 for details.

Notifications (Actions): The file screen can be associated with between zero and four actions that apply if the file screen is violated. A file screen can be associated with at most one notification of each of the four distinct FSRM notification types. See section 3.2.1.4 for more information. A protocol client can perform the following management operations involving file screen notifications:

File screen mode: This property controls the behavior of the file screen when a prohibited file is detected. There are two modes available:

Hard screen: A hard screen will block file IO that violates the file screen, and cause the server to run any existing actions that are associated with the file screen.

Soft screen: A soft quota will not block file IO that violates the file screen, but it will cause the server to run any existing actions that are associated with the file screen.

Template id: If the file screen configuration was copied from a file screen template, this property is the ID of the file screen template the file screen configuration was copied from.

File Screen.Overwrite on commit: A Boolean value that specifies whether the existing file screen is overwritten with the imported file screen.

The FSRM protocol reports feature includes a report that enumerates a file screening audit history. This feature is available to protocol clients by configuring a report job appropriately to generate this File Screen Audit report. The presence of this feature adds an additional requirement to the protocol server. To generate this report, the file screen auditing feature MUST be enabled using the FSRM General Settings model. Each file screen violation, including soft file screen violations that did not prevent the prohibited file from being created, contains the following data:

  • Folder path

  • ID

  • Blocked file group name

  • File screen mode

  • Time stamp when the prohibited file violation occurred

  • The name of the process image that generated the prohibited I/O, if available

  • The SID of the user principal that issued the prohibited I/O, if available

  • The full path name of the prohibited file

  • The server name