FsrmClassificationManagerClass Class

Article
10/10/2016

Manages file classification. Use this interface to define properties to use in classification, add classification rules for classifying files, define classification and storage modules, and enable classification reporting.

Namespace: Microsoft.Storage
Assembly: srmlib (in srmlib.dll)

Inheritance Hierarchy

System.Object
Microsoft.Storage.FsrmClassificationManagerClass

Syntax

[ClassInterfaceAttribute(0)]
[GuidAttribute("B15C0E47-C391-45B9-95C8-EB596C853F3A")]
public class FsrmClassificationManagerClass : IFsrmClassificationManager2, 
    FsrmClassificationManager, DIFsrmClassificationEvents_Event

[ClassInterfaceAttribute(0)]
[GuidAttribute("B15C0E47-C391-45B9-95C8-EB596C853F3A")]
public ref class FsrmClassificationManagerClass : IFsrmClassificationManager2, 
    FsrmClassificationManager, DIFsrmClassificationEvents_Event

[<ClassInterfaceAttribute(0)>]
[<GuidAttribute("B15C0E47-C391-45B9-95C8-EB596C853F3A")>]
type FsrmClassificationManagerClass = 
    class
        interface IFsrmClassificationManager2
        interface FsrmClassificationManager
        interface DIFsrmClassificationEvents_Event
    end

<ClassInterfaceAttribute(0)>
<GuidAttribute("B15C0E47-C391-45B9-95C8-EB596C853F3A")>
Public Class FsrmClassificationManagerClass
    Implements IFsrmClassificationManager2, FsrmClassificationManager,
    DIFsrmClassificationEvents_Event

Constructors

	Name	Description
	FsrmClassificationManagerClass()	Creates a new instance of the FsrmClassificationManagerClass object.

Properties

	Name	Description
	ClassificationLastError	The error message from the last time that classification was run.
	ClassificationLastReportPathWithoutExtension	Gets the local directory path where the reports were stored the last time that classification ran.
	ClassificationReportEnabled	Determines whether classification reporting is enabled or not.
	ClassificationReportFormats	Retrieves or sets the list of formats in which to generate the classification reports.
	ClassificationReportMailTo	Retrieves or sets the email address to which to send the classification reports, if any.
	ClassificationRunningStatus	Retrieves the running status of the classification.
	Logging	Gets the types of logging to perform when running the classification rules.

Methods

	Name	Description
	add_OnFile(DIFsrmClassificationEvents_OnFileEventHandler)	Adds an OnFile event handler.
	CancelClassification()	Cancels classification if it is running.
	ClassifyFiles(Object[], Object[], Object[], _FsrmGetFilePropertyOptions)	Retrieves or modifies the properties of one or more files/folders.
	ClearFileProperty(String, String)	Attempts to remove the specified property from the file or folder.
	CreateModuleDefinition(_FsrmPipelineModuleType)	Creates a module definition of the specified type.
	CreatePropertyDefinition()	Creates a property definition.
	CreateRule(_FsrmRuleType)	Creates a rule of the specified type.
	EnumFileProperties(String, _FsrmGetFilePropertyOptions)	Enumerates the properties of the specified file.
	EnumModuleDefinitions(_FsrmPipelineModuleType, _FsrmEnumOptions)	Enumerates the module definitions of the specified type.
	EnumPropertyDefinitions(_FsrmEnumOptions)	Enumerates the property definitions.
	EnumRules(_FsrmRuleType, _FsrmEnumOptions)	Enumerates the rules of the specified type.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetFileProperty(String, String, _FsrmGetFilePropertyOptions)	Retrieves the specified property from the file or folder.Windows Server 2008 R2: Only files are supported until Windows Server 2012.
	GetHashCode()	(Inherited from Object.)
	GetModuleDefinition(String, _FsrmPipelineModuleType)	Retrieves the specified module definition.
	GetPropertyDefinition(String)	Retrieves the specified property definition.
	GetRule(String, _FsrmRuleType)	Retrieves the specified rule.
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	remove_OnFile(DIFsrmClassificationEvents_OnFileEventHandler)	Removes an OnFile event handler
	RunClassification(_FsrmReportGenerationContext, String)	Runs classification rules and generates the classification report.
	SetFileProperty(String, String, String)	Sets the value of the specified property in the file or folder.
	ToString()	(Inherited from Object.)
	WaitForClassificationCompletion(Int32)	Waits for the specified period of time or until classification has finished running.

Events

	Name	Description
	OnFile	Represents a file classification event. The event receives properties of files that are processed by the ClassifyFiles method.

Remarks

To create this object from a script, use the "Fsrm.FsrmClassificationManager" program identifier.

The classification feature lets you classify (tag) files. To do this the properties that can be associated with a file must first be defined using CreatePropertyDefinition. Once a property is defined it may be set using APIs such as SetFileProperty, retrieved using ClassifyFilesor EnumFileProperties, or cleared using ClearFileProperty. ClassifyFiles performs these actions on multiple files. Alternatively a series of rules to automatically classify files can be created. If a rule applies to the file, the rule associates a property and property value with the file. The property can be stored separately from the file or stored in the file depending on the storage module available on the computer.

The built-in System Cache Storage Module stores the properties outside of the file using alternate data stream storage and the security descriptor (Windows Server 2012 and Windows 8 only). Storing the properties separately may result in them not moving when the file is moved.

The Office Storage Modules store the classification properties in the Office files themselves. One parser is for Office 97-2003 files, and the other is for Office 2007-2010 files. Office files that contain the classification properties in the file can have the properties displayed in SharePoint if the property names match the SharePoint column names. Updating the column values in SharePoint updates the properties in the file. Note that SharePoint treats these names as case-sensitive, therefore the property definition's name defined in FSRM must have the same case when uploading to SharePoint.

You can use the classification and storage plugins or you can implement your own classification and storage plugins. Note that the built-in Content Classifier plugin uses the IFilter interface to search the content of the file.

When you run classification, FSRM evaluates a files for any rule that is applicable to that file (and committed to FSRM) and enabled. If reporting is enabled, FSRM also generates the classification reports.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.