IBM Enterprise Records バージョン 5.1.2    

ファイル・プラン・インポート/エクスポート・ツールの使用

IBM® Enterprise Records のデプロイでは、ファイル・プラン・インポート/エクスポート・ツールを使用して、外部ファイル・プランのインポートや、外部環境へのファイル・プランのエクスポートを実行します。 このツールでは、XML ファイルを使用してインポートおよびエクスポート処理を実行します。

概要

エクスポートされた XML ファイルを変更して、スケジュール継承、代替保存期間、廃棄トリガー、および動的保留を含める方法の詳細については、『ファイル・プラン・インポート/エクスポート・ツールのトラブルシューティング』トピックを参照してください。

制限

ファイル・プラン・インポート/エクスポート・ツールを使用して、ファイル・プランを移行します。 ただし、このツールは以下のシナリオをサポートしていません。 最初に選択リストなどのカスタム・プロパティーとクラスを個別の XML ファイルにエクスポートおよびインポートしてから、ファイル・プランの残りをインポートします。 さらに、ファイル・プランをインポートしたら、クローズ廃棄の準備完了などのエンティティー状態は無効です。

ツールの実行

ファイル・プラン・インポート/エクスポート・ツールは、コマンド行 Java 実行可能プログラムから実行できます。 あるいは FilePlanTool.bat または FilePlanTool.sh のコマンド・ファイルからツールを開始できます。 このツールは、以下の 5 種類のモードのいずれかで実行できます。

ツールの構成

ツールをインポートまたはエクスポート・モードで実行する前に、ツールを構成しておく必要があります。 ツールを構成するには、以下のようにします。
  1. ファイル・プラン・インポート/エクスポート・ツールがインストールされているフォルダーを選択します。
  2. 以下のいずれかのコマンド行を入力します。
    オペレーティング・システム コマンド
    Windows FilePlanTool -mode configure
    AIX、HP-UX、Linux、および Solaris FilePlanTool.sh -mode configure
    ファイル・プラン・ツール・ダイアログ・ボックスに、以下の情報を入力します。

ファイル・プランのエクスポート

エクスポートするファイル・プランに次のいずれかのアイテムが含まれている場合は、別の手順が必要となります。 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

FilePlanTool.bat -mode export -scope includecategories file01.txt -o export01.xml

File01.txt の内容は次の通りです。

/categoryB /CategoryC/SubcategoryC2 /CatogoryA/SubcategoryA1

カテゴリー名は行ごとにフルパス名と 1 つのレコード・カテゴリーで表現します。

ファイル・プランのインポート/更新

ファイル・プラン、またはその一部をインポートするには、ツールをインポート・モードで実行します。 このツールによりエクスポート・モードで作成された 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 種類のパラメーターがあります。 Skip オプションは、大きいファイル・プランのインポートに失敗した後に使用します。 同じファイル・プランをもう一度インポートするときに、Skip オプションを使用することで正常にインポートされたエンティティーの再インポートを回避します。 ただし、2 回目のインポート時に、初回で正常にインポートされたエンティティーに若干の変更を加える必要がある場合は、Replace オプションを使用します。 以後のインポートで少数のエンティティーをわずかに変更する必要がある場合、エンティティーに対し Action="Modify" (XML ファイルの RMEntityObjectType セクション内) を指定します。 元の XML ファイルを変更する代わりに、これらのエンティティーを変更します。 また、Update モードを使用すると、最初の完全なインポート以降の更新をより簡単に識別できます。 ファイル・プランのインポート/更新を参照してください。


フィードバック

最終更新: 2013 年 11 月
fileplan_import_export.htm

© Copyright IBM Corp. 2013