IBM® Enterprise
Records のデプロイでは、ファイル・プラン・インポート/エクスポート・ツールを使用して、外部ファイル・プランのインポートや、外部環境へのファイル・プランのエクスポートを実行します。 このツールでは、XML ファイルを使用してインポートおよびエクスポート処理を実行します。
概要
エクスポートされた XML ファイルを変更して、スケジュール継承、代替保存期間、廃棄トリガー、および動的保留を含める方法の詳細については、『ファイル・プラン・インポート/エクスポート・ツールのトラブルシューティング』トピックを参照してください。
制限
ファイル・プラン・インポート/エクスポート・ツールを使用して、ファイル・プランを移行します。 ただし、このツールは以下のシナリオをサポートしていません。
- データ・モデルのクロス・エクスポート/インポート。 例えば、PRO データ・モデル・オブジェクト・ストアからエクスポートする場合、DoD データ・モデル・オブジェクト・ストアにインポートすることはできません。
- レコード・オブジェクト、ボリューム、ドキュメント・オブジェクト、セキュリティー情報、セキュリティー・マーキングのエクスポートまたはインポート。
- ロールバック・メカニズム。
- NULL 値を持つプロパティーのエクスポート。 例えば、保存期間がない廃棄スケジュールのフェーズをエクスポートするとします。 その廃棄スケジュールを別のオブジェクト・ストアにインポートしても、保存期間は NULL に更新されません。 ただし、XML ファイルを手動で更新して保存期間を更新できます。 詳しくは、『ファイル・プラン・インポート/エクスポート・ツールのトラブルシューティング』トピックを参照してください。
最初に選択リストなどのカスタム・プロパティーとクラスを個別の XML ファイルにエクスポートおよびインポートしてから、ファイル・プランの残りをインポートします。 さらに、ファイル・プランをインポートしたら、
クローズや
廃棄の準備完了などのエンティティー状態は無効です。
ツールの実行
ファイル・プラン・インポート/エクスポート・ツールは、コマンド行 Java 実行可能プログラムから実行できます。 あるいは
FilePlanTool.bat または
FilePlanTool.sh のコマンド・ファイルからツールを開始できます。
このツールは、以下の 5 種類のモードのいずれかで実行できます。
- Configure: ダイアログが開き、必要な情報を指定します。 必要な情報とは、Content Platform Engine サーバー名、オブジェクト・ストア名、管理者のユーザー名とパスワード、モード (インポートまたはエクスポート) です。
- エクスポート: 完全な互換性と適合性を備えた XML ファイルを作成します。このファイルは、後で別の環境にインポートできます。
- インポート/更新: 指定された XML ファイルを環境にインポートします。
- 検証: XML ファイルを読み取って互換性と適合性を検証します。
ファイル・プランのエクスポート
エクスポートするファイル・プランに次のいずれかのアイテムが含まれている場合は、別の手順が必要となります。
- カスタム・クラスまたはプロパティー
- 30 万個を超えるフォルダー
- 1 万 5000 個を超えるフォルダーを含むレコード・カテゴリー
scope オプションでのファイル・プランのエクスポートを参照してください。
ツールの構成が済んだら、ツールを使用してファイル・プランをエクスポートできます。
ファイル・プランをエクスポートするには、次のコマンドを入力します。
FilePlanTool -mode export -fileplan file
plan name -o XML filename.xml ここで、ファイル・プラン名 はエクスポートするファイル・プランの名前で、入力は必須です。 ファイル・プラン名にスペースまたは特殊文字が含まれている場合、ファイル・プラン名 を引用符で囲みます。
XML ファイル名は、作成するファイルの名前とパスです。 コマンド行にファイル名を入力しない場合、ツールでは「出力ファイル名」フィールドに指定されているデフォルト・ファイル名が使用されます。
このフィールドは、構成ダイアログ・ボックスにあります。 デフォルト XML 出力ファイル名の指定の詳細については、ツールの構成を参照してください。
scope オプションでのファイル・プランのエクスポート
大規模なファイル・プラン、またはカスタム・クラス/プロパティーが含まれているファイル・プランをエクスポートする場合は、scope オプションを使用します。 scope オプションを使用してファイル・プランをエクスポートするには、次のコマンドを入力します。
FilePlanTool -mode export -fileplan file
plan name -o XML filename.xml -scope parameter
ここで、ファイル・プラン名 はエクスポートするファイル・プランの名前で、入力は必須です。 ファイル・プラン名にスペースまたは特殊文字が含まれている場合、ファイル・プラン名 を引用符で囲みます。
XML ファイル名は、作成するファイルの名前とパスです。
コマンド行にファイル名を入力しない場合、ツールでは「出力ファイル名」フィールドに指定されているデフォルト・ファイル名が使用されます。
このフィールドは、構成ダイアログ・ボックスにあります。 scope オプションでツールを使用する場合、ファイル・プランの部分ごとに XML ファイルが作成されます。 このため、ツールをエクスポート・モードで使用するたびに異なる XML ファイル名を指定する必要があります。 デフォルト XML 出力ファイル名の指定の詳細については、ツールの構成を参照してください。
parameter には、以下のいずれかの項目を指定できます。
- metadata: ファイル・プランにカスタム・クラスまたはプロパティーが含まれる場合、このパラメーターが必要です。 metadata パラメーター・オプションでは、カスタム・クラスおよびプロパティー用の XML ファイルが別途作成されます。
したがって、ファイル・プランにカスタム・クラスまたはプロパティーが含まれる場合、エクスポート/インポート処理ではそれぞれ 2 つのステップが必要です。
- カスタム・クラスおよびプロパティー用のステップ
- 残りのファイル・プラン用のステップ。 metadata パラメーターを使用しない場合、カスタム・プロパティーを除いたファイル・プランがエクスポートされます。
- includecategory "レコード・カテゴリー名": このパラメーターは、特定のレコード・カテゴリーをエクスポートするために使用します。
includecategory を使用した場合、指定したレコード・カテゴリーに含まれるすべてのサブカテゴリーとサブフォルダーがエクスポートされます。 レコード・カテゴリー名には IBM Enterprise
Records のフルパスを指定します。
例えば、レコード・カテゴリー Cat03 内のすべての子をエクスポートするには、次のコマンドを入力します。 Cat03 は Cat02 に含まれ、それが Cat01 に含まれます。
FilePlanTool.bat -mode export -scope includecategory
"/Cat01/Cat02/Cat03" -o expfile.xml
- includecategories ファイル 01: このパラメーターを使用すると、入力テキスト・ファイル ファイル 01 に指定されたレコード・カテゴリーとその子だけがエクスポートされます。
includecategories パラメーターは、コマンド行に各レコード・カテゴリー名を指定せずに多数のレコード・カテゴリーを同じファイルにエクスポートするために使用します。 このパラメーターを使用するには、次のコマンド・ラインを入力します。
FilePlanTool.bat -mode export -scope includecategories file01.txt -o export01.xml
File01.txt の内容は次の通りです。
/categoryB /CategoryC/SubcategoryC2 /CatogoryA/SubcategoryA1
カテゴリー名は行ごとにフルパス名と 1 つのレコード・カテゴリーで表現します。
- excludecategory「除外されるレコード・カテゴリー名」: このパラメーターを使用すると、特定のレコード・カテゴリーとその子が除外されます。 例えば、excluded
record category name が「Cat01/Cat02/Catlarge」である場合、ファイル・プランのすべてのレコード・カテゴリーとレコード・フォルダーがツールによってエクスポートされます。ただし、例外があります。 例外は、「Cat01/Cat02/CatLarge」ノード内にあるレコード・カテゴリーとレコード・フォルダーです。 このパラメーターは、includecategory とほぼ同じように機能します。
- excludecategories ファイル 02: このパラメーターを使用すると、ファイル 02 テキスト・ファイルに指定されたルート名のサブツリーが除外されます。 このパラメーターは、includecategories とほぼ同じように機能します。
ファイル・プランのインポート/更新
ファイル・プラン、またはその一部をインポートするには、ツールをインポート・モードで実行します。 このツールによりエクスポート・モードで作成された XML ファイルを指定します。 ファイル・プランにカスタム・クラスまたはプロパティーが含まれる場合、インポート処理では 2 つのステップが必要です。 最初のステップではファイル・プランのカスタム・クラスおよびプロパティーをインポートします。 次のステップではファイル・プランの残りをインポートします。 カスタム・クラスおよびプロパティーを最初にインポートします。
カスタム・クラスおよびプロパティー・メタデータがメモリーにキャッシュされるため、少なくとも 5 分待ってからファイル・プランをインポートします。 キャッシュの生存期間 (TTL) は 5 分で、その後キャッシュはクリアされます。
ファイル・プランをインポート/更新するには、次のコマンドを入力します。
FilePlanTool -mode import -f XML
filename.xml -reimportoption option
FilePlanTool -mode update -f XML
filename.xml -reimportoption option
XML ファイル名は、インポートするファイルの名前とパスです。
ファイル名を指定しない場合、ツールでは、構成ダイアログの「出力ファイル名」フィールドに指定されているデフォルト・ファイル名が使用されます。 デフォルト XML 出力ファイル名の指定の詳細については、ツールの構成を参照してください。
再インポート・オプションでは、ファイル・プランに存在するエンティティーをインポートするときのツールのデフォルト動作を指定します。 再インポート・オプションについて詳しくは、再インポート・オプションの使用を参照してください。
インポート・モードでは、ツールは scope オプションは使用しませんが、XML タグを参照してインポート対象を決定します。 メタデータ (カスタム・クラスおよびプロパティー) とファイル・プラン用の異なる XML ファイル名を指定する必要があります。
重要: XML ファイルの ClassificationScheme タグは、ファイル・プランの名前を指定します。
ツールを更新モードで実行し、ファイル・プランの最初のインポート後にわずかな変更を加えます。 最初にインポートした XML ファイルとそれ以降の更新を区別します。 update は、XML ファイルの FilePlan タグの InputMode 属性として指定します。 更新モードを使用してカスタム・プロパティー (選択リストなど) を変更することはできません。
エラー・メッセージが表示された場合やインポート処理が停止した場合は、インフォメーション・センターのトラブルシューティングとサポートのノード、または製品資料の「IBM FileNet P8 Troubleshooting Guide」の FileNet® P8
Platform のページを参照してください。 ほとんどのケースで、インポート処理はエラー発生後に停止しますが、メッセージは表示されません。
必要な場合、インポート後に保留スイープを実行して、条件付き保留をエンティティーに適用します (条件保留はインポートされません)。 制限を参照してください。
ファイル・プランの検証
XML ファイルを手動で作成したら、XML ファイルにエラーや非適合の問題が含まれていないか検証します。 ファイル・プラン・インポート/エクスポート・ツールを使用してファイルを検証できます。 インポート/エクスポート・ツールを検証モードで実行するには、次のコマンドを入力します。
FilePlanTool -mode validate -f XML ファイル名.xml
XML ファイル名は、検証するファイルの名前とパスです。 ファイル名を指定しない場合、ツールでは、構成ダイアログの「出力ファイル名」フィールドに指定されているデフォルト・ファイル名が使用されます。 デフォルト XML 出力ファイル名の指定の詳細については、ツールの構成を参照してください。
再インポート・オプションの使用
再インポート・オプションは、ファイル・プランに存在するエンティティーをインポートするときのツールのデフォルト動作を指定するために使用します。 再インポート・オプションには、以下の 3 種類のパラメーターがあります。
- None: エンティティーが存在する場合、ツールはエンティティーを追加するときに例外ログに警告をレポートし、エンティティーを追加せずに処理を続行します。
- Skip: エンティティーを追加するときに、ツールは既存のエンティティーをスキップして処理を続行し、スキップ・アクションをアクティビティー・ログにレポートします。
- Replace: エンティティーを追加するときに、ツールは既存のエンティティーを置き換えて処理を続行し、変更アクションをアクティビティー・ログにレポートします。
Skip オプションは、大きいファイル・プランのインポートに失敗した後に使用します。 同じファイル・プランをもう一度インポートするときに、Skip オプションを使用することで正常にインポートされたエンティティーの再インポートを回避します。 ただし、2 回目のインポート時に、初回で正常にインポートされたエンティティーに若干の変更を加える必要がある場合は、
Replace オプションを使用します。 以後のインポートで少数のエンティティーをわずかに変更する必要がある場合、エンティティーに対し
Action="Modify" (XML ファイルの RMEntityObjectType セクション内) を指定します。
元の XML ファイルを変更する代わりに、これらのエンティティーを変更します。 また、Update モードを使用すると、最初の完全なインポート以降の更新をより簡単に識別できます。
ファイル・プランのインポート/更新を参照してください。