IBM OpenPages with Watson 環境の比較

「環境の比較」を使用して、2 つの環境構成 XML ファイルの差分を検出できます。ある環境の構成を別の環境にマイグレーションする前に、環境の比較を使用して、問題を特定して解決します。

環境の比較は、各環境で生成した XML ファイルを比較します。「設定のエクスポート」または ObjectManager を使用して XML ファイルを生成できます。環境の比較は、XML ファイルを調べ、ファイル内の差分を特定します。また、環境の比較は検証ルールを使用して、マイグレーション時に問題を引き起こす可能性がある変更やエラーがないか、XML ファイルを検査します。

図 1. ソースおよびターゲット環境内のプロファイルの比較
ソース・ファイルとターゲット・ファイルが選択された状態の「環境の比較」ページ
図 2. 比較の結果: 1 つのプロファイルがソース環境に存在していない
エクスポートされたスプレッドシートの「差分 (Differences)」タブ。

ソース・ファイルとターゲット・ファイルは、異なるバージョンの IBM OpenPages® with Watson™ を実行している環境からのものにすることができます。さらに、ソース環境とターゲット環境のいずれとも異なるバージョンを実行しているシステムで環境の比較を実行することもできます。

注: 環境の比較では、指定した XML ファイルのコンテンツのみが比較されます。 ソース環境とターゲット環境の他の側面は比較されません。

環境の比較は、大量のシステム・リソースを使用する可能性があります。これを使用する際には、以下のガイドラインに従ってください。

  • 実稼働環境では、環境の比較を実行しないでください。
  • 他のアクティビティーでビジーなサーバーで環境の比較を実行しないでください。
  • 比較する XML ファイルは、非常に大きいものにすることができます。その場合は、システムへのファイルのアップロードに数分以上かかることがあります。アップロード速度が遅い接続を使用する場合は、事前にこの要因について検討してください。

以下のプロセスを使用して環境を比較します。

  • 比較する対象を決定します。
  • ソース環境で XML ファイルを生成します。
  • ターゲット環境で XML ファイルを生成します。
  • 「環境の比較」ページのフィルターを使用して、比較する構成データでフィルターを掛けます。

    フィルターを使用することで、XML ファイルの比較にかかる時間を短縮できます。また、フィルターは、注意をそらす可能性がある情報を結果から削除することで、必要な結果に焦点を合わせられるようにもします。比較結果には、何十万行も含まれる可能性があります。

  • 比較を実行します。
  • 詳細な結果をダウンロードします。
  • 結果を分析します。
  • エラーが存在する場合は修正し、警告メッセージが存在する場合は確認します。

環境を比較する際には、以下の事項に留意してください。

  • 環境の比較は、参照点としてソース環境ファイルを使用します。ソース・ファイルとターゲット・ファイルを逆にした場合、異なる結果が得られますが、これは予期されるものです。
  • 環境の比較では、サポートされないデータは無視されます。
  • ソース環境、ターゲット環境、および環境の比較を実行する環境ではそれぞれ、異なるバージョンの OpenPages がインストールされていても構いません。
  • 通貨フィールドは、他のフィールドとは異なります。通貨フィールドの XML 構造は、他のタイプのフィールドと異なります。
    • 通貨フィールドは、(bundleType 要素を使用して) フィールド・グループのように XML で表されます。
    • 通貨フィールドは、通貨属性 (為替レート、基準額、現地金額、通貨コード、基準コードなど) を含むネストされたフィールド・グループを使用して実装されます。環境の比較で通貨フィールドの差分が検出された場合、通貨フィールド・レベルとネストされたフィールド・グループ・レベルの両方で変更がログに記録されます。
  • 環境の比較は、ソース・ファイルまたはターゲット・ファイルに存在しない要素を検出した場合、その要素のレベルでの差分のみをログに記録します。環境の比較は、要素の子の差分をログに記録しません。

    このルールには 1 つだけ例外があり、それは通貨フィールドの場合です。通貨フィールドが存在しない場合、環境の比較は、欠落しているフィールドとその子フィールド・グループをログに記録します。

  • 出力で表示される行番号は、XML ファイルに基づいて表示されると期待されるものと異なる可能性があります。出力で表示される行番号は、XML ファイルで終了タグがある場所の行番号です。1 つの要素が複数の行にまたがることがあります (例えば、要素の複数の属性が異なる行に存在している場合)。

    例えば、以下の Year フィールドに対して出力で報告される行番号は、83 (終了タグがある行) です。

    81     <includedField name="Year"
    82         readOnly="false"
    83         required="false">
  • OpenPages でカスタム・オブジェクト・タイプを追加した場合、XML ファイルのオブジェクト・タイプ定義に、少なくとも 2 つの contentTypeRelationship 要素 (添付と関連付け) が含まれます。これらのコンテンツ・タイプの関係は、デフォルトで追加されます。環境の比較は、これらの要素について報告します。

    例えば、ソース環境でカスタム・オブジェクト・タイプを追加したが、それがターゲット環境に存在していないものとします。カスタム・オブジェクト・タイプを定義したときに、親の関連付けをセットアップしました。XML ファイルを生成して比較すると、環境の比較により、オブジェクト・タイプの関連付けに関する 2 つの情報メッセージがログに記録されます。1 つは、追加した親オブジェクトの関連付けについてであり、もう 1 つは、デフォルトで追加された添付の関連付けについてです。

  • 特定のケースでは、「管理」ページを使用すると、デフォルトの構成要素がバックグラウンドで作成されます。このような変更は、そのとき、ユーザー・インターフェースでは分からないことがあります。

    例えば、初めてプロファイルの詳細を表示し、含められたオブジェクト・タイプ (SOXBusEntity など) を追加すると、概要ナビゲーション・ビューのデフォルト項目が自動的に追加されます。それ以上追加の変更を行わずにオブジェクト・プロファイルをエクスポートした場合、XML ファイルのオブジェクト・プロファイルに、概要ビューの追加要素が含まれます。

次の動画では、ある環境の構成を別の環境にマイグレーションする前に「環境の比較」を使用して問題の特定と解決を行う方法を紹介しています。