IBM® Enterprise
Records のデプロイでは、ファイル・プラン・インポート/エクスポート・ツールを使用して、外部ファイル・プランのインポートや、外部環境へのファイル・プランのエクスポートを実行することができます。このツールでは、XML ファイルを使用してインポートおよびエクスポート処理を実行します。
制限
ファイル・プラン・インポート/エクスポート・ツールはファイル・プランの移行を容易にします。ただし、このツールは以下をサポートしていません。
また、最初にカスタム・プロパティー (選択リストなど) とクラスを別の XML ファイルにエクスポートおよびインポートしてから、ファイル・プランの残りをインポートする必要があります。さらに、ファイル・プランをインポートしたら、
クローズや
廃棄の準備完了などのエンティティー状態は無効です。
ツールの実行
ファイル・プラン・インポート/エクスポート・ツールは、コマンド行 Java 実行ファイル、あるいは
FilePlanTool.bat または
FilePlanTool.sh のコマンド・ファイルから開始できます。このツールは、以下の 5 種類のモードのいずれかで実行できます。
- 構成 - 開かれるダイアログで、Content Engine (CE) サーバー名、オブジェクト・ストア名、管理者のユーザー名とパスワード、モード (インポートまたはエクスポート) などの必要な情報を指定します。
- エクスポート - 完全な互換性と適合性を備えた 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 出力ファイル名の指定の詳細については、ツールの構成を参照してください。
パラメーターは、以下のいずれかです。
- metadata - ファイル・プランにカスタム・クラスまたはプロパティーが含まれる場合、このパラメーターが必要です。metadata パラメーター・オプションでは、カスタム・クラスおよびプロパティー用の XML ファイルが別途作成されます。したがって、ファイル・プランにカスタム・クラスまたはプロパティーが含まれる場合、エクスポート/インポート処理ではそれぞれ 2 つのステップが必要です。
- カスタム・クラスおよびプロパティー用のステップ。
- 残りのファイル・プラン用のステップ。metadata パラメーターを使用しない場合、カスタム・プロパティーを除いたファイル・プランがエクスポートされます。
- includecategory "レコード・カテゴリー名" - このパラメーターは、特定のレコード・カテゴリーをエクスポートするために使用します。
includecategory を使用した場合、指定したレコード・カテゴリーに含まれるすべてのサブカテゴリーとサブフォルダーがエクスポートされます。レコード・カテゴリー名には IBM Enterprise
Records のフルパスを指定します。例えば、「Cat01」に「Cat02」が含まれていて、その中に含まれるレコード・カテゴリー「Cat03」内のすべての子をエクスポートするには、次のコマンドを入力します。
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』を参照してください。ほとんどの場合、インポート処理はエラー発生後に停止しますが、メッセージは表示されません。
必要な場合、インポート後に保留スイープを実行して、条件付き保留をエンティティーに適用します (条件保留はインポートされません)。制限を参照してください。
ファイル・プランの検証
XML ファイルを手動で作成したら、ファイル・プラン・インポート/エクスポート・ツールを使用して、XML ファイルにエラーや非適合の問題が含まれていないか検証します。インポート/エクスポート・ツールを検証モードで実行するには、次のコマンドを入力します。
FilePlanTool -mode validate -f XML ファイル名.xml
XML ファイル名は、検証するファイルの名前とパスです。コマンド行にファイル名を入力しない場合、ツールの構成ダイアログの「出力ファイル名」フィールドに指定されているデフォルト・ファイル名が使用されます。デフォルト XML 出力ファイル名の指定の詳細については、ツールの構成を参照してください。
再インポート・オプションの使用
再インポート・オプションは、ファイル・プランに既に存在するエンティティーをインポートするときのツールのデフォルト動作を指定するために使用します。再インポート・オプションには、以下の 3 種類のパラメーターがあります。
- None - エンティティーが既に存在する場合、ツールはエンティティーを追加するときに例外ログに警告をレポートし、エンティティーを追加せずに処理を続行します。
- Skip - エンティティーを追加するときに、ツールは既存のエンティティーをスキップして処理を続行し、スキップ・アクションをアクティビティー・ログにレポートします。
- Replace - エンティティーを追加するときに、ツールは既存のエンティティーを置き換えて処理を続行し、変更アクションをアクティビティー・ログにレポートします。
Skip オプションは、大きいファイル・プランのインポートに失敗した後に使用します。同じファイル・プランをもう一度インポートするときに、Skip オプションを使用することで正常にインポートされたエンティティーの再インポートを回避します。ただし、二度目のインポート時に最初にインポートされたエンティティーを変更する必要がある場合は、Replace オプションを使用します。以後のインポートで少数のエンティティーをわずかに変更する必要がある場合、元の XML ファイルを変更する代わりに、エンティティーに対し Action="Modify" (XML ファイルの RMEntityObjectType セクション内) を指定します。また、Update モードを使用すると、最初の完全なインポート以降の更新をより簡単に識別できます。
ファイル・プランのインポート/更新を参照してください。