configTool

「構成」ページのプロパティーと値は、Marketing Platform システム・テーブルに保管されます。configTool ユーティリティーを 使用して、構成設定をシステム・テーブルにインポートしたり、システム・テーブルからエクスポートしたりできます。

configTool をいつ使用するか

configTool は、次のような目的で使用できます。

  • Campaign に備わっているパーティションおよびデータ・ソースのテンプレートをインポートする。その後、構成ページを使って、それの変更および複製を行うことができます。
  • 製品インストーラーがプロパティーをデータベースに自動的に追加できない場合に IBM® Marketing Software 製品を登録する (その構成プロパティーをインポートする)。
  • バックアップ用の構成設定の XML バージョンをエクスポートし、IBM Marketing Software の別のインストールにインポートする。
  • 「カテゴリーの削除」リンクを持たないカテゴリーを削除する。これを行うには、configTool を使用して構成をエクスポートし、カテゴリーを作成する XML を手動で削除し、configTool を使用して、編集された XML をインポートします。
重要: このユーティリティーは、Marketing Platform システム・テーブル・データベース (構成プロパティーとその値が含まれている) の usm_configuration テーブルと usm_configuration_values テーブルを変更します。最良の結果を得るために、それらのテーブルのバックアップ・コピーを作成するか、configTool を使って既存の構成をエクスポートし、生成されるファイルをバックアップしてください。 そうすることで、configTool を使ったインポートに失敗した場合に構成を復元することができます。

構文

configTool -d -p "elementPath" [-o]

configTool -i -p "parent ElementPath" -f importFile [-o]

configTool -x -p "elementPath" -f exportFile

configTool -vp -p "elementPath" -f importFile [-d]

configTool -r productName -f registrationFile [-o] configTool -u productName

コマンド

-d -p "elementPath" [o]

構成プロパティー階層内のパスを指定して、構成プロパティーとその設定を削除します。

エレメント・パスには、カテゴリーおよびプロパティーの内部名が 使用されている必要があります。それらを 得るには、「構成」ページの 目的のカテゴリーまたはプロパティーを選択して、右のペインに ある括弧内に示されているパスを確認します。| 文字を使って構成プロパティー階層のパスを区切り、パスを二重引用符で囲みます。

次のことに注意してください。

  • このコマンドで削除できるのは、アプリケーション内のカテゴリーおよびプロパティーのみで、アプリケーション全体は削除できません。アプリケーション全体を登録解除するには、-u コマンドを使用します。
  • 「構成」ページに「カテゴリーの削除」リンクがないカテゴリーを削除するには、-o オプションを使用します。

-vp コマンドで -d を使用すると、configTool は指定されたパスに含まれるどの子ノードも削除します (指定された XML ファイルにそれらのノードが含まれない場合)。

-i -p "parentElementPath" -f importFile [o]

指定された XML ファイルから構成プロパティーとその設定をインポートします。

インポートするには、カテゴリーのインポート先の親要素へのパスを指定します。configTool ユーティリティーは、パス内で指定するカテゴリーの下にプロパティーをインポートします。

カテゴリーは最上位の下のどのレベルにでも追加することができますが、最上位カテゴリーと同じレベルにカテゴリーを追加することはできません。

親エレメント・パスには、カテゴリーおよびプロパティーの内部名が 使用されている必要があります。これらの内部名は、「構成」ページに移動して、必要なカテゴリーまたはプロパティーを選択し、右側のペインの括弧内に表示されるパスを調べることによって得ることができます。| 文字を使って構成プロパティー階層のパスを区切り、パスを二重引用符で囲みます。

tools/bin ディレクトリーからの相対的なインポート・ファイル場所を指定するか、ディレクトリーの絶対パスを指定することができます。相対パスを指定した場合、またはパスを指定しない場合、configTooltools/bin ディレクトリーから相対的な場所にあるファイルを最初に探します。

デフォルトでこのコマンドは既存のカテゴリーを上書きしませんが、-o オプションを使用して上書きを強制することができます。

-x -p "elementPath" -f exportFile

指定された名前の XML ファイルに構成プロパティーとその設定をエクスポートします。

すべての構成プロパティーをエクスポートすることも、構成プロパティー階層内のパスを指定することによって特定のカテゴリーにエクスポートを制限することもできます。

要素パスにはカテゴリーおよびプロパティーの内部名を使用する必要があります。 これは、「構成」ページに移動し、必要なカテゴリーまたはプロパティーを選択して、右側のペインで括弧付きで表示されるパスを見ると分かります。| 文字を使って構成プロパティー階層のパスを区切り、パスを二重引用符で囲みます。

現行ディレクトリーからの相対的なエクスポート・ファイル場所を指定するか、ディレクトリーの絶対パスを指定することができます。ファイル指定に区切り記号 (UNIX の場合は /、 Windows の場合は / または \ ) が含まれていない場合、configTool はファイルを Marketing Platform インストール済み環境の tools/bin ディレクトリーの下に作成します。xml 拡張子を付けない場合、configTool によってそれが追加されます。

-vp -p "elementPath" -f importFile [-d]

このコマンドは 、主に手動アップグレードにおける構成プロパティーのインポートに使用されます。新しい構成プロパティーが含まれるフィックスパックを適用した後にアップグレードする場合、手動アップグレード・プロセスの一部として構成ファイルをインポートすることにより、フィックスパックが適用されたときに設定された値をオーバーライドできます。-vp コマンドは、既に設定されている構成値がインポートによってオーバーライドされないようにします。

重要: configTool ユーティリティーを -vp オプションを指定して使用したら、変更が適用されるように、Marketing Platform がデプロイされている Web アプリケーション・サーバーを再始動する必要があります。

-vp コマンドで -d を使用すると、configTool は指定されたパスに含まれるどの子ノードも削除します (指定された XML ファイルにそれらのノードが含まれない場合)。

-r productName -f registrationFile

アプリケーションを登録します。tools/bin ディレクトリーに相対する登録ファイルの場所を指定することも、絶対パスを指定することもできます。デフォルトでこのコマンドは既存の構成を上書きしませんが、-o オプションを使用して上書きを強制することができます。productName パラメーターは、上記にリストされている名前のいずれかでなければなりません。

次のことに注意してください。

  • -r コマンドを使用する際、登録ファイルには XML 内の最初のタグとして <application> を指定する必要があります。

    Marketing Platform データベースに構成プロパティーを 挿入するために使用できる他のファイルが、製品と一緒に提供されることがあります。それらのファイルについては、-i コマンドを使用します。最初のタグとして <application> タグがあるファイルだけを -r コマンドと共に使用できます。

  • Marketing Platform の登録ファイルの名前は Manager_config.xml で、最初のタグは <Suite> です。新規インストールでこのファイルを登録するには、populateDb ユーティリティーを使用するか、「IBM Marketing Platform インストール・ガイド」にある説明に従って Marketing Platform インストーラーを再実行します。
  • 最初のインストールの後、Marketing Platform 以外の製品を再登録するには、configTool-r コマンドおよび -o を指定して実行して、既存のプロパティーを上書きします。

configTool ユーティリティーは、製品の登録または登録解除を行うコマンドのパラメーターとして製品名を使用します。IBM Marketing Software 8.5.0 リリースでは、多くの製品名が変更されました。ただし、configTool によって認識される名前は変更されていません。configTool で使用できる有効な製品名を、現在の製品名とともに以下にリストします。

表 1. configTool 登録および登録解除で使用する製品名
製品名 configTool で使用する名前
Marketing Platform 管理者
Campaign キャンペーン
Distributed Marketing Collaborate
eMessage emessage
Interact interact
Contact Optimization 最適化
Marketing Operations 計画
Opportunity Detect Detect
IBM SPSS® Modeler Advantage Enterprise Marketing Management Edition SPSS
Digital Analytics Coremetrics
-uproductName

productName によって指定されたアプリケーションを登録解除します。製品カテゴリーにパスを含める必要はありません。製品名は必須で、それのみで十分です。このプロセスで、製品のすべてのプロパティーと構成設定が削除されます。

オプション

-o

-i または -r と 共に使用すると、既存のカテゴリーまたは製品登録 (ノード) を上書きします。

-d と共に使用すると、「構成」ページ に「カテゴリーの削除」リンクがないカテゴリー (ノード) を削除することができます。

  • Marketing Platform インストール済み環境の下の conf ディレクトリーの Product_config.xml という名前のファイルから構成設定をインポートします。

    configTool -i -p "Affinium" -f Product_config.xml

  • 提供されている Campaign データ・ソース・テンプレートの 1 つをデフォルトの Campaign パーティションである partition1 にインポートします。この例では、Oracle データ・ソース・テンプレート OracleTemplate.xmlMarketing Platform インストールの tools/bin ディレクトリーにあることを前提としています。

    configTool -i -p "Affinium|Campaign|partitions|partition1|dataSources" -f OracleTemplate.xml

  • すべての構成設定を D:\backups ディレクトリーの myConfig.xml という名前のファイルに エクスポートします。

    configTool -x -f D:\backups\myConfig.xml

  • 既存の Campaign パーティション (データ・ソース・エントリーが完備されている) をエクスポートし、それを partitionTemplate.xml という名前のファイルに保存し、Marketing Platform インストールのデフォルトの tools/bin ディレクトリーに保管します。

    configTool -x -p "Affinium|Campaign|partitions|partition1" -f partitionTemplate.xml

  • Marketing Platform インストール済み環境の下のデフォルトの tools/bin ディレクトリーにある app_config.xml という名前のファイルを使用して、productName という名前のアプリケーションを手動で登録して、このアプリケーションの既存の登録を上書きするように強制します。

    configTool -r product Name -f app_config.xml -o

  • productName という名前のアプリケーションを登録解除します。

    configTool -u productName

  • 次のコマンドを実行して、encodeCSV 機能を有効にします。

    configTool -vp -p "Affinium|Plan|umoConfiguration" -f MarketingOperations_Home\conf\Plan_encodeProperty_11.1.xml