configTool ユーティリティー

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

configTool をいつ使用するか

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

Campaign に付属のパーティションおよびデータ・ソース・テンプレートをインポートする場合、このテンプレートは、「構成」ページを使用して変更したり複製したりできます。

製品インストーラーがプロパティーをデータベースに自動的に追加できない場合に IBM® EMM 製品を登録する (その構成プロパティーをインポートする)。

バックアップ用の構成設定の XML バージョンをエクスポートし、IBM® EMM の別のインストールにインポートする。

「カテゴリーの削除」リンクのないカテゴリーを削除する。これを行うには、configTool を使用して構成をエクスポートし、カテゴリーを作成する XML を手動で削除し、configTool を使用して、編集された XML をインポートします。

このユーティリティーは、Marketing Platform システム・テーブル・データベース (構成プロパティーとその値が含まれている) の usm_configuration テーブルと usm_configuration_values テーブルを変更します。最良の結果を得るために、それらのテーブルのバックアップ・コピーを作成するか、configTool を使って既存の構成をエクスポートし、生成されるファイルをバックアップしてください。そうすることで、configTool を使ったインポートに失敗した場合に構成を復元することができます。

有効な製品名

configTool ユーティリティーは、このセクションの後半で説明するように、製品を登録および登録解除するコマンドのパラメーターとして製品名を使用します。 8.0.0 リリースの IBM® EMM では、多くの製品名が変更されています。しかし、configTool によって認識される名前は変更されていません。 configTool で使用できる有効な製品名を、現在の製品名とともに以下にリストします。

製品名	configTool で使用する名前
Marketing Platform	Manager
Campaign	Campaign
Distributed Marketing	Collaborate
eMessage	emessage
Interact	interact
Contact Optimization	Optimize
Marketing Operations	Plan
CustomerInsight	Insight
Digital Analytics for On Premises	NetInsight
PredictiveInsight	Model
Leads	Leads

構文

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

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

configTool -x -p "elementPath" -f exportFile

configTool -r productName -f registrationFile [-o]

configTool -u productName

コマンド

-d -p "elementPath"

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

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

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

このコマンドは、アプリケーション全体ではなく、アプリケーション内のカテゴリーとプロパティーだけを削除することができます。アプリケーション全体を登録解除するには、-u コマンドを使用します。

「構成」ページに「カテゴリーの削除」リンクがないカテゴリーを削除するには、-o オプションを使用します。

-i -p "parentElementPath" -f importFile

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

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

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

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

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

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

-x -p "elementPath" -f exportFile

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

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

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

-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 以外の製品を登録するには、-r オプションと -o とともに configTool を使用して、既存のプロパティーを上書きします。

-u productName

productName によって指定されたアプリケーションを登録解除します。製品カテゴリーへのパスを含める必要はありません。製品名だけで十分です。 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.xml が Marketing 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