IFsrmClassificationManager

ファイルの分類を管理します。このインターフェースを使用して、分類で使用するプロパティの定義、ファイルを分類するための分類ルールの追加、分類モジュールおよびストレージモジュールの定義、分類レポートの有効化を行います。(IFsrmClassificationManager)

このオブジェクトをスクリプトから作成するには、"Fsrm.FsrmClassificationManager" プログラム識別子を使用します。

分類機能を使用すると、ファイルを分類 (タグ付け) できます。そのためには、まずファイルに関連付けることができるプロパティを CreatePropertyDefinition で定義する必要があります。 プロパティを定義すると、 SetFileProperty などの API で値を設定したり、 GetFileProperty や EnumFileProperties で取得したり、 ClearFileProperty でクリアしたりできます。 ClassifyFiles は、これらの操作を複数のファイルに対して実行します。あるいは、ファイルを自動的に分類する一連のルールを作成することもできます。ルールがファイルに適用されると、そのルールはプロパティとプロパティ値をファイルに関連付けます。プロパティは、コンピューターで利用できるストレージモジュールに応じて、ファイルとは別に格納することも、ファイル内に格納することもできます。

組み込みの System Cache Storage Module は、代替データストリームストレージとセキュリティ記述子を使用して、プロパティをファイルの外部に格納します (Windows Server 2012 および Windows 8 のみ)。プロパティを別に格納した場合、ファイルを移動してもプロパティが一緒に移動しないことがあります。

Office Storage Module は、分類プロパティを Office ファイル自体の中に格納します。一方のパーサーは Office 97-2003 ファイル用、もう一方は Office 2007-2010 ファイル用です。分類プロパティをファイル内に保持している Office ファイルは、プロパティ名が SharePoint の列名と一致していれば、SharePoint 上でそのプロパティを表示できます。SharePoint で列の値を更新すると、ファイル内のプロパティも更新されます。なお、SharePoint はこれらの名前を大文字と小文字を区別して扱うため、FSRM で定義するプロパティ定義の名前は、SharePoint にアップロードする際に大文字と小文字が一致している必要があります。

用意されている分類プラグインおよびストレージプラグインを使用することも、独自の分類プラグインおよびストレージプラグインを実装することもできます。なお、組み込みの Content Classifier プラグインは、 IFilter インターフェースを使用してファイルの内容を検索します。

分類を実行すると、FSRM は各ファイルについて、そのファイルに適用でき (かつ FSRM にコミットされ)、有効になっているすべてのルールを評価します。レポートが有効になっている場合、FSRM は分類レポートも生成します。

例

C# および PowerShell の例については、 Accessing Classification Properties を参照してください。

分類レポートを生成する形式の一覧です。(Get)

分類レポートを生成する形式の一覧です。(Put)

分類ルールの実行時に行うログ記録の種類です。(Get)

FsrmClassificationLoggingFlags_ClassificationsInLogFile および FsrmClassificationLoggingFlags_ErrorsInLogFile のログオプションのログファイルは、 レポートディレクトリに格納されます。 FsrmClassificationLoggingFlags_ClassificationsInLogFile のログファイル名は "ClassifierName-FsrmServerName(FQDN)-TimeStamp.xml" です。 このログファイルには、特定のファイルへのプロパティ割り当てごとに 1 つのエントリが記録されます。各ログエントリには次の情報が含まれます。

• ファイル名 (フルパス)
• プロパティ
• 割り当てられた値
• 適用されたルール
• 結果 (分類が成功したかどうか)

• エラーコード
• ファイル名 (フルパス)
• プロパティ
• 適用されたルール

分類ルールの実行時に行うログ記録の種類です。(Put)

FsrmClassificationLoggingFlags_ClassificationsInLogFile および FsrmClassificationLoggingFlags_ErrorsInLogFile のログオプションのログファイルは、 レポートディレクトリに格納されます。 FsrmClassificationLoggingFlags_ClassificationsInLogFile のログファイル名は "ClassifierName-FsrmServerName(FQDN)-TimeStamp.xml" です。 このログファイルには、特定のファイルへのプロパティ割り当てごとに 1 つのエントリが記録されます。各ログエントリには次の情報が含まれます。

• ファイル名 (フルパス)
• プロパティ
• 割り当てられた値
• 適用されたルール
• 結果 (分類が成功したかどうか)

• エラーコード
• ファイル名 (フルパス)
• プロパティ
• 適用されたルール

分類レポートの送信先メールアドレスです (指定する場合)。(Get)

このプロパティは省略可能です。

メールメッセージは、分類が正常に完了した場合にのみ送信されます。 FsrmReportType_ExportReport のレポートタイプではメールは送信されません。レポートはメールメッセージに添付されます。[Admin Email] を指定すると、管理者に通知を送信できます ( IFsrmSetting::AdminEmail プロパティが設定されている場合)。 件名は "<ReportType>: <ReportName>" です。メールメッセージの本文は空です。

分類レポートの送信先メールアドレスです (指定する場合)。(Put)

このプロパティは省略可能です。

メールメッセージは、分類が正常に完了した場合にのみ送信されます。 FsrmReportType_ExportReport のレポートタイプではメールは送信されません。レポートはメールメッセージに添付されます。[Admin Email] を指定すると、管理者に通知を送信できます ( IFsrmSetting::AdminEmail プロパティが設定されている場合)。 件名は "<ReportType>: <ReportName>" です。メールメッセージの本文は空です。

分類レポートが有効かどうかを決定します。(Get)

分類がスケジュール実行された場合 (タスクスケジューラを使用) でも、オンデマンドで実行された場合 ( IFsrmClassificationManager::RunClassification を使用) でも、レポートの生成を制御します。

分類レポートが有効かどうかを決定します。(Put)

分類がスケジュール実行された場合 (タスクスケジューラを使用) でも、オンデマンドで実行された場合 ( IFsrmClassificationManager::RunClassification を使用) でも、レポートの生成を制御します。

前回分類を実行したときにレポートが格納されたローカルディレクトリのパスです。

レポートの生成に失敗した場合は、レポートが格納されるはずだったパスになります。このディレクトリには、失敗が発生する前に正常に完了したレポートが含まれていることがあります。パスは、 IFsrmReportManager::SetOutputDirectory に渡された値 (指定した場合) と、レポートのコンテキストによって決まります。

前回分類を実行したときのエラーメッセージです。

このプロパティは、 IFsrmClassificationManager::RunClassification を使用して手動で分類を実行した後、またはタスクスケジューラによってスケジュール実行された後に設定されます。

分類の実行状態です。

分類がスケジュール実行された場合 (タスクスケジューラを使用) でも、オンデマンドで実行された場合 ( IFsrmClassificationManager::RunClassification を使用) でも使用されます。

プロパティ定義を列挙します。

このメソッドは次の値を返します。

プロパティ定義を作成します。

このメソッドは次の値を返します。

ファイルの分類に使用するプロパティを定義するために、プロパティ定義を作成します。1 つ以上の分類ルールでそのプロパティを指定できます。FSRM サーバーでは、プロパティ定義の数は 100 個に制限されています。

ルールまたはレポートジョブから参照されているプロパティは削除できません。

指定されたプロパティ定義を取得します。

このメソッドは次の値を返します。

指定された種類のルールを列挙します。

このメソッドは次の値を返します。

指定された種類のルールを作成します。

このメソッドは次の値を返します。

作成できるルールの数に制限はありません。 IFsrmRule.ModuleDefinitionName プロパティを使用して、ルールを分類モジュールに関連付けます。

FSRM は、ルールが実行される順序を保証しません。

指定されたルールを取得します。

このメソッドは次の値を返します。

指定された種類のモジュール定義を列挙します。

このメソッドは次の値を返します。

指定された種類のモジュール定義を作成します。

このメソッドは次の値を返します。

定義できるモジュールの数に制限はありません。

FSRM でモジュールを定義するだけでなく、そのクラスを COM に登録する必要もあります。この登録は、モジュールの種類に応じて IFsrmClassifierModuleImplementation または IFsrmStorageModuleImplementation を実装する COM クラスの登録である必要があります。

FSRM には、次の組み込みの分類モジュールが用意されています。Folder Classifier と Content Classifier です。Folder Classifier は、ファイルが格納されているフォルダーに基づいてファイルを分類します。Content Classifier は、Windows のテキスト抽出機能を使用してファイル内の文字列や正規表現を検索することで分類します。

FSRM には、次の 3 つの組み込みストレージモジュールが用意されています。

• System Cache Storage Module — プロパティを NTFS の代替データストリームのキャッシュに格納します。
• Office 97 - 2003 In-File Storage Module — プロパティを Microsoft Office 97 - 2003 のファイル内に格納します。
• Office 2007 In-File Storage Module — プロパティを Microsoft Office 2007 以降のファイル内に格納します。

指定されたモジュール定義を取得します。

このメソッドは次の値を返します。

分類ルールを実行し、分類レポートを生成します。

このメソッドは次の値を返します。

分類を実行するには、少なくとも 1 つのプロパティが定義されており、定義済みプロパティのいずれかを参照するルールが少なくとも 1 つ存在し、分類モジュールが登録されている必要があります。

このメソッドを呼び出したときに分類が既にキューに入っているか実行中の場合、このメソッドはエラーを返します。分類が実行中かどうかを確認するには、 IFsrmClassificationManager.ClassificationRunningStatus プロパティを参照します。分類が成功したかどうかを確認するには、 ClassificationLastError プロパティを参照します。

分類レポートは、レポートが有効になっている場合にのみ生成されます ( IFsrmClassificationManager.ClassificationReportEnabled プロパティを参照)。

分類をスケジュール実行するには、タスクスケジューラを使用します。バージョン 1.0 のタスクを作成してください。実行するコマンドは C:\Windows\System32\StorRept.exe です。StorRept.exe の引数には "classification run" を指定します。StorRept.exe は FsrmReportGenerationContext_ScheduledReport のレポートコンテキストを使用します。

ルール、ファイル、キャッシュが有効で変更されていない場合、FSRM は分類ルールを適用しません。

指定した時間が経過するまで、または分類の実行が完了するまで待機します。

このメソッドは次の値を返します。

分類を実行するには、 IFsrmClassificationManager::RunClassification メソッドを呼び出します。

WaitForClassificationCompletion から制御が返された後、 IFsrmClassificationManager.ClassificationLastError プロパティを参照して、レポートが正常に完了したかどうかを確認します。

分類が実行中の場合、それをキャンセルします。

このメソッドは次の値を返します。

IFsrmClassificationManager::RunClassification メソッドを使用して手動で開始された分類、またはスケジュールによって開始された分類をキャンセルします (スケジュールによる分類の実行の詳細については、 RunClassification を参照してください)。

指定されたファイルのプロパティを列挙します。

このメソッドは次の値を返します。

FSRM は、指定されたストレージモジュール (options パラメーターを参照) に対して、それぞれが担当するファイルのすべてのプロパティを返すよう要求します。プロパティをファイルに埋め込むストレージモジュールの場合、この一覧にはファイルに埋め込まれているすべてのプロパティ (FSRM で定義されたものだけではありません) が含まれます。

options パラメーターに FsrmGetFilePropertyOptions_None を指定した場合、FSRM は正しい値が返されるようにファイルの分類を再実行します。

例

C# および PowerShell の例については、 Accessing Classification Properties を参照してください。

ファイルまたはフォルダーから指定されたプロパティを取得します。

このメソッドは次の値を返します。

FSRM は、指定されたストレージモジュール (options パラメーターを参照) に対して、ファイルからプロパティを取得するよう要求します。options パラメーターに FsrmGetFilePropertyOptions_None を指定した場合、FSRM は正しい値が返されるようにファイルの分類を再実行します。

例

C# および PowerShell の例については、 Accessing Classification Properties を参照してください。

ファイルまたはフォルダー内の指定されたプロパティの値を設定します。

このメソッドは次の値を返します。

このメソッドは、プロパティ値がそのプロパティの型として有効かどうかを検証します。たとえば、順序付きリストや複数選択リストの場合は値がリストのメンバーであること、Boolean プロパティの場合は値が文字列 "0" または "1" であること、日付の場合は値が文字列として表現された 64 ビットの 10 進値であることを確認します。

SetFileProperty は、 AppliesTo プロパティに FsrmPropertyDefinitionAppliesTo_Files (1) ビットが設定されている、サーバー上で利用可能なプロパティ定義のみをサポートします。

例

C# および PowerShell の例については、 Accessing Classification Properties を参照してください。

指定されたプロパティをファイルまたはフォルダーから削除しようとします。

このメソッドは次の値を返します。

ストレージモジュールがプロパティを削除できる場合、プロパティはファイルから削除されます。削除できない場合は、次の表の値を使用してプロパティの値がクリアされます。