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 ユーティリティーでは、製品を登録および登録抹消するコマンドのパラメーターとして製品名を使用します。IBM® EMM のリリース 8.0.0 では、多くの製品名が変更されています。ただし、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 オプションを使用してください。-r オプションで使用できるのは、最初のタグとして <application> タグが入っているファイルだけです。

Marketing Platform の登録ファイルは Manager_config.xml という名前で、最初のタグは <Suite> です。このファイルを新しいインストールで登録するには、populateDb ユーティリティーを使用するか、「IBM® Marketing Platform インストール・ガイド」で説明されているように Marketing Platform インストーラーを再実行します。

最初のインストール後に Marketing Platform 以外の製品を登録するには、configTool で -r オプションと -o オプションを指定して使用し、既存のプロパティーを上書きします。

-u productName

productName で指定されているアプリケーションを登録抹消します。製品カテゴリーへのパスを含める必要はありません。製品名で十分です。productName パラメーターは、上記にリストされているうちのいずれかでなければなりません。これは、製品のすべてのプロパティーおよび構成設定を削除します。

オプション

-o

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

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

例

Marketing Platform のインストール先の conf ディレクトリーにある Product_config.xml という名前のファイルから構成設定をインポートします。

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

提供されている Campaign データ・ソース・テンプレートのいずれかを、デフォルトの 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

Marketing Platform のインストール先の既存の Campaign パーティション (データ・ソース・エントリーを含む全体) をエクスポートし、partitionTemplate.xml という名前のファイルに保存して、デフォルトの 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