3.2.1.5.2 Reports

The server maintains reports (section 3.2.1.5.1) associated with each report job and for each report maintains a minimal set of configuration properties. The configuration of a report consists of all the information to define the report. There is no state to track for a report. The actual data backing these abstractions is owned and encapsulated by the report job abstraction model. The configuration of a report is saved concurrent with the configuration data of the report job that encapsulates the report.

The management operations that a protocol client can perform involving reports are specified in section 3.2.1.5.1.

The following configuration data is maintained for each report on the system:

Report.Type: This property is a numeric value that identifies the report. The File Server Resource Manager Protocol defines a set of available report types. See section 2.2.1.2.10 for details.

Report.Name: This property is a unique, case-insensitive, Unicode string for the report.

Report.Description: This property is a Unicode text description of the report.

Last generated file name prefix: This property maintains a Unicode string that corresponds to the file name prefix used for naming the files which constitute the generated report instance when the report job was last run. The client can use this prefix as a means to identify the collection of files that make up the generated report instance by examining the names of the files found in the report job last generated in directory property. The prefix string uniquely identifies a particular set of files that constitute a single instance of the generated report. The exact format of the string is implementation-specific but could embed information such as the report Name, Type, and a time stamp corresponding to when the report was generated.

Filters: A filter is a mechanism by which entries, files, or groups of files are included or excluded from the generated report. The File Server Resource Manager Protocol defines a set of available filters, and each report type supports a specific set of filters. A filter is identified by the numeric ID defined in section 2.2.1.2.16 and the value of the filter is defined by a value or an array of values.

The following state data is maintained for each report on the system:

Report.Deprecated: This Boolean property indicates whether the report job is valid.<24>

The filters a report configuration supports depend on the report type as follows:

Minimum size: This filter is defined by a single 64-bit integer value that specifies the minimum file size for a file to be included in the report. This filter applies only to the Large Files report type. When a report that supports this filter is generated, all files that are smaller than the value specified in the filter are excluded from the report.

Minimum age: This filter is defined by a single 32-bit integer value that specifies the minimum file age, in days, for a file to be included in the report. This filter applies to the Least Recently Accessed and File Screen Audit report types. When a report that supports this filter is generated, all files that are younger than the value specified in the filter are excluded from the report.

Maximum age: This filter is defined by a single 32-bit integer value that specifies the maximum file age, in days, for a file to be included in the report. This filter applies only to the Most Recently Accessed report type. When a report that supports this filter is generated, all files that are older than the value specified in the filter are excluded from the report.

Minimum quota usage: This filter is defined by a single 32-bit integer value that specifies the minimum quota usage, expressed as a percentage of the quota limit, for a quota record to be included in the report. This filter applies only to the Quota Usage report type. When a report that supports this filter is generated, all quotas whose percentage quota used is smaller than the value specified in the filter are excluded from the report.

File groups: This filter is defined by an array of Unicode strings. These strings specify the set of file groups to be included in the report. This filter applies only to the Files By Type report type. When a report that supports this filter is generated, all files that are not members of any of the file groups specified in the filter are excluded from the report.

Owners: This filter is defined by an array of Unicode strings that specifies the set of owners whose files are to be included in the report. The format of the Unicode string can be either the user principal name (UPN) or a SID in string format. This filter applies only to the Files By Owner report type. When a report that supports this filter is generated, all files that are not owned by any of the user principals specified in the filter are excluded from the report.

Name pattern: This filter is defined by a Unicode string value that specifies the pattern for files to be included in the report. This filter applies to all report types except for Quota Usage and Export types. When a report that supports this filter is generated, all files that do not match the pattern specified in the filter are excluded from the report.

Property: This filter is defined by a Unicode string value that specifies the name of the property definition (section 3.2.1.6.1) that will be inspected for each file in the report. This filter applies only to File by Property and Folder by Property report types. This filter does not cause files to be excluded from the report but limits what property value is displayed in the report for each file.