IBM Enterprise Records, バージョン 5.1.+            

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

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

概要

エクスポートされた XML ファイルを変更して、スケジュール継承、代替保存期間、廃棄トリガー、および動的保留 (条件付き保留) を含める方法の詳細については、http://www-01.ibm.com/support/docview.wss?rs=3247&uid=swg27010422 にある『ファイル・プラン・インポート/エクスポート・ツールの使用』セクションを参照してください。

制限

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

ツールの実行

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

ツールの構成

ツールをインポートまたはエクスポート・モードで実行する前に、ツールを構成しておく必要があります。ツールを構成するには、以下のようにします。
  1. ファイル・プラン・インポート/エクスポート・ツールがインストールされているフォルダーを選択します。
  2. 以下のいずれかのコマンド行を入力します。
    オペレーティング・システム コマンド
    Windows FilePlanTool -mode configure
    UNIX 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 出力ファイル名の指定の詳細については、ツールの構成を参照してください。

パラメーターは、以下のいずれかです。
  • 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

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』を参照してください。ほとんどの場合、インポート処理はエラー発生後に停止しますが、メッセージは表示されません。

必要な場合、インポート後に保留スイープを実行して、条件付き保留をエンティティーに適用します (条件保留はインポートされません)。制限を参照してください。

ファイル・プランの検証

XML ファイルを手動で作成したら、ファイル・プラン・インポート/エクスポート・ツールを使用して、XML ファイルにエラーや非適合の問題が含まれていないか検証します。インポート/エクスポート・ツールを検証モードで実行するには、次のコマンドを入力します。

FilePlanTool -mode validate -f XML ファイル名.xml

XML ファイル名は、検証するファイルの名前とパスです。コマンド行にファイル名を入力しない場合、ツールの構成ダイアログの「出力ファイル名」フィールドに指定されているデフォルト・ファイル名が使用されます。デフォルト XML 出力ファイル名の指定の詳細については、ツールの構成を参照してください。

再インポート・オプションの使用

再インポート・オプションは、ファイル・プランに既に存在するエンティティーをインポートするときのツールのデフォルト動作を指定するために使用します。再インポート・オプションには、以下の 3 種類のパラメーターがあります。 Skip オプションは、大きいファイル・プランのインポートに失敗した後に使用します。同じファイル・プランをもう一度インポートするときに、Skip オプションを使用することで正常にインポートされたエンティティーの再インポートを回避します。ただし、二度目のインポート時に最初にインポートされたエンティティーを変更する必要がある場合は、Replace オプションを使用します。以後のインポートで少数のエンティティーをわずかに変更する必要がある場合、元の XML ファイルを変更する代わりに、エンティティーに対し Action="Modify" (XML ファイルの RMEntityObjectType セクション内) を指定します。また、Update モードを使用すると、最初の完全なインポート以降の更新をより簡単に識別できます。ファイル・プランのインポート/更新を参照してください。


フィードバック

最終更新日: 2011 年 8 月


© Copyright IBM Corp. 2011.
このインフォメーション・センターでは Eclipse テクノロジーが採用されています。(http://www/eclipse.org)