Utilitaire configTool

Les propriétés et les valeurs de la page Configuration sont enregistrées dans les tables système. L'utilitaire configTool importe et exporte les paramètres de configuration vers et à partir des tables système.

Quand utiliser configTool

Vous voudrez peut-être exécuter l'utilitaire configTool pour les raisons suivantes.

Pour importer des modèles de source de données et de partition fournis avec Campaign, que vous pouvez ensuite modifier et dupliquer dans la page Configuration.

Pour enregistrer (importer les propriétés de configuration) des produits IBM® EMM si le programme d'installation du produit n'est pas en mesure d'ajouter automatiquement les propriétés à la base de données.

Pour exporter une version XML des paramètres de communication à des fins de sauvegarde ou d'importation vers une autre installation d'IBM® EMM.

Pour supprimer les catégories ne disposant pas du lien Supprimer catégorie. Pour ce faire, utilisez configTool pour exporter votre configuration, supprimez manuellement le XML qui crée la catégorie, puis utilisez configTool pour importer le XML édité.

Cet utilitaire modifie les tables usm_configuration et usm_configuration_values de la base de données de la table système de Marketing Platform, qui contient les propriétés de configuration et leurs valeurs. Pour de meilleurs résultats, créez des copies de sauvegarde de ces tables ou exportez vos configurations existantes à l'aide de configTool, puis sauvegardez le fichier obtenu afin de disposer d'un moyen de rétablir votre modification en cas d'erreur d'importation à l'aide de configTool.

Syntaxe

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

Commandes

-d -p "elementPath" [o]

Supprimez les propriétés de configuration et leurs paramètres, tout en spécifiant un chemin pour leur hiérarchie.

Le chemin d'élément doit utiliser les noms internes des catégories et des propriétés. Vous pouvez les obtenir sur la page de Configuration, en sélectionnant la catégorie ou propriété souhaitée, et en consultant le chemin affiché entre parenthèses dans le panneau de droite. Délimitez un chemin dans la hiérarchie des propriétés de configuration à l'aide du caractère | et placez le chemin entre guillemets doubles.

Gardez à l'esprit les points suivants :

Seules les catégories et propriétés d'une application, et non les applications entières, peuvent être supprimées à l'aide de cette commande. Utilisez la commande -u pour annuler l'enregistrement d'une application entière.

Pour supprimer les catégories qui ne disposent pas du lien Supprimer catégorie dans la page de Configuration, utilisez l'option -o..

Lorsque vous utilisez la commande -d -vp, la commande configTool supprime les noeuds enfant dans le chemin que vous indiquez si ces noeuds ne sont pas inclus dans le fichier XML indiqué.

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

Importe les propriétés de configuration et leurs paramètres d'un fichier XML spécifié.

Pour effectuer l'importation, spécifiez un chemin vers l'élément parent sous lequel vous souhaitez importer vos catégories. L'utilitaire configTool importe les propriétés sous la catégorie spécifiée dans le chemin.

Vous pouvez ajouter des catégories à tout niveau situé sous le niveau supérieur. Toutefois, vous ne pouvez pas ajouter une catégorie au même niveau que le niveau supérieur.

Vous pouvez spécifier l'emplacement du fichier d'importation par rapport à votre répertoire tools/bin ou choisir un chemin d'accès complet. Si vous spécifiez un chemin relatif, voire aucun chemin, configTool recherche d'abord le fichier relatif dans le répertoire tools/bin.

Par défaut, cette commande n'écrase pas une catégorie existante, mais vous pouvez utiliser l'option -o pour forcer l'écrasement.

-x -p "elementPath" -f exportFile

Exporte les propriétés de configuration et leurs paramètres dans un fichier XML spécifié.

Vous pouvez exporter toutes les propriétés de configuration ou limiter l'exportation à une catégorie spécifique. Pour ce faire, spécifiez un chemin dans la hiérarchie des propriétés de configuration.

Le chemin d'élément doit utiliser les noms internes de catégories et de propriétés, que vous pouvez obtenir sur la page de Configuration, en sélectionnant la catégorie ou propriété souhaitée, et en consultant le chemin affiché entre parenthèses dans le panneau de droite. Délimitez un chemin dans la hiérarchie des propriétés de configuration à l'aide du caractère | et placez le chemin entre guillemets doubles.

Vous pouvez spécifier l'emplacement d'un fichier d'exportation dans le répertoire actuel ou un chemin de répertoire complet. Si le fichier spécifié ne contient pas de séparateur (/ sous UNIX™, / ou \ sous Windows™), configTool enregistre le fichier dans le répertoire tools/bin de votre installation Marketing Platform. Si vous n'indiquez pas l'extension xml, configTool l'ajoute.

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

Cette commande est principalement utilisée dans les mises à niveau manuelles, pour importer des propriétés de configuration. Si vous avez appliqué un groupe de correctifs contenant une nouvelle propriété de configuration, puis effectuez ensuite une mise à niveau, l'importation d'un fichier de configuration dans le cadre d'une mise à niveau manuelle peut remplacer les valeurs qui ont été définies lorsque de l'application du groupe de correctifs. La commande -vp évite que l'importation remplace les valeurs de configuration déjà définies.

Après avoir utilisé l'utilitaire configTool avec l'option -vp, vous devez redémarrer le serveur d'application Web sur lequel Marketing Platform est déployé afin que les modifications soient appliquées.

Lorsque vous utilisez la commande -d -vp, la commande configTool supprime les noeuds enfant dans le chemin que vous indiquez si ces noeuds ne sont pas inclus dans le fichier XML indiqué.

-r productName -f registrationFile

Enregistre l'application. L'emplacement du fichier d'enregistrement peut être relatif au répertoire tools/bin ou peut être un chemin d'accès complet. Par défaut, cette commande n'écrase pas une configuration existante, mais vous pouvez utiliser l'option -o pour forcer l'écrasement. Le paramètre productName peut être l'un de ceux répertoriés ci-après.

Prenez connaissance des informations suivantes.

Lorsque vous utilisez l'option -r, le fichier d'enregistrement doit posséder <application> en tant que première balise dans le XML.

D'autres fichiers peuvent être fournis avec votre produit, que vous pouvez utiliser pour insérer des propriétés de configuration dans la base de données de Marketing Platform. Pour ces fichiers, utilisez la commande -i. Seul le fichier qui possède la balise <application> comme première balise peut être utilisé avec la commande -r.

Le fichier d'enregistrement pour Marketing Platform est nommé Manager_config.xml et la première balise est <Suite>. Pour enregistrer ce fichier sur une nouvelle installation, faites appel à l'utilitaire populateDb, ou exécutez à nouveau le programme d'installation de Marketing Platform comme décrit dans le Guide d'installation d'IBM® Marketing Platform.

Après l'installation initiale, pour réenregistrer d'autres produits que Marketing Platform, utilisez configTool avec la commande -r et -o pour écraser les propriétés existantes.

L'utilitaire configTool utilise des noms de produits en tant que paramètres avec les commandes permettant d'enregistrer et de désactiver les produits. Dans la révision 8.5.0 d'IBM® EMM, de nombreux produits ont changé de nom. Toutefois, les noms reconnus par configTool n'ont pas changé. Les noms de produits utilisables avec configTool sont répertoriés ci-après avec les noms actuels des produits.

Noms de produits pour l'enregistrement et la désactivation dans configTool
Nom du produit	Nom utilisé dans 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
Opportunity Detection	Détecter
Leads	Opportunités commerciales
Interaction History	InteractionHistory
Attribution Modeler	AttributionModeler
IBM® SPSS® Modeler Advantage Enterprise Marketing Management Edition	SPSS
Digital Analytics	Coremetrics

-u productName

Annule l'enregistrement d'une application spécifiée par productName.. Il n'est pas nécessaire d'inclure un chemin à la catégorie du produit. Le nom du produit, obligatoire, suffit. Ce processus supprime toutes les propriétés et tous les paramètres de configuration du produit.

Options

-o

Lorsqu'elle est utilisée avec -i ou -r, cette option écrase une catégorie ou un enregistrement de produit (noeud) existant.

Utilisée avec -d, cette option vous permet de supprimer une catégorie (noeud) qui ne dispose pas du lien Supprimer catégorie dans la page Configuration.

Exemples

Importez les paramètres de configuration à partir du fichier Product_config.xml situé dans le répertoire conf de l'installation de Marketing Platform.

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

Importez l'un des modèles de source de données Campaign fournis dans la partition Campaign par défaut, partition1. L'exemple suppose que vous avez placé le modèle de source de données Oracle, OracleTemplate.xml, dans le répertoire tools/bin de l'installation de Marketing Platform.

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

Exportez tous les paramètres de configuration dans le fichier myConfig.xml situé dans le répertoire D:\backups.

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

Exportez une partition de Campaign existante (complète avec entrées de source de données), enregistrez-la dans un fichier partitionTemplate.xml, situé dans le répertoire par défaut tools/bin de l'installation de Marketing Platform.

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

Enregistrez manuellement une application nommée productName à l'aide d'un fichier app_config.xml situé dans le répertoire par défaut tools/bin de l'installation de Marketing Platform, puis forcez l'écrasement d'un enregistrement existant de cette application.

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

Annulez l'enregistrement d'une application productName.

configTool -u productName