Utilitaire configTool

Les propriétés et valeurs de la page Configuration sont stockées dans les tables système. Vous pouvez utiliser l'utilitaire configTool pour importer et exporter les paramètres de la configuration dans les 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 afin de les modifier et de les 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, vous utilisez configTool pour exporter votre configuration, puis vous supprimez manuellement le XML qui crée la catégorie et vous importez le XML modifié à l'aide de configTool.

Cet utilitaire modifie les tables usm_configuration et usm_configuration_values dans la base de données de tables système Marketing Platform, qui contient les propriétés de configuration et leurs valeurs. Pour obtenir les meilleurs résultats, créez des copies de sauvegarde de ces tables ou exportez vos configurations existantes à l'aide de configTool et sauvegardez le fichier obtenu afin de disposer d'un moyen de restaurer votre configuration si vous avez fait une erreur lors de l'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 de catégories et propriétés. Vous pouvez les obtenir en accédant à la page Configuration, en sélectionnant la catégorie ou la propriété de votre choix et en observant le chemin qui est 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.

Prenez connaissance des informations suivantes.

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

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

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

-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 que vous spécifiez 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.

Le chemin d'élément parent doit utiliser les noms internes de catégories et propriétés. Vous pouvez les obtenir en accédant à la page Configuration, en sélectionnant la catégorie ou la propriété nécessaire et en observant le chemin qui est 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 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 de l'élément doit utiliser les noms internes des catégories et des propriétés. Pour les obtenir, accédez à la page Configuration, sélectionnez la catégorie ou propriété souhaitée, puis consultez 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 la spécification de fichier ne contient pas de séparateur (/ sous UNIX™, / ou \ sous Windows™), configTool écrit le fichier dans le répertoire tools/bin sous votre installation de 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 qui contient une nouvelle propriété de configuration, puis que vous mettez à niveau, l'importation d'un fichier de configuration dans le cadre d'un processus de mise à niveau manuelle peut remplacer des valeurs qui ont été définies lorsque le groupe de correctifs a été appliqué. La commande -Vp garantit que l'importation ne remplace pas les valeurs de configuration précédemment définies.

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

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

-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 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 la commande -r, le fichier d'enregistrement doit avoir <application> en tant que première balise dans le code 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 Marketing Platform. Pour ces fichiers, utilisez la commande -i. Seule le fichier qui contient la balise <application> en tant que 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 dans une nouvelle installation, utilisez l'utilitaire populateDb ou exécutez à nouveau le programme d'installation de Marketing Platform comme décrit dans le guide IBM® Marketing Platform Installation Guide.

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

L'utilitaire configTool utilise des noms de produits en tant que paramètres avec les commandes pour enregistrer et désenregistrer les produits. Avec la version 8.5.0 d'IBM® EMM, de nombreux noms de produits ont été modifiés. Cependant, les noms reconnus par configTool n'ont pas changé. Les noms de produits utilisables avec configTool sont répertoriés ci-dessous avec les noms actuels des produits.

Noms de produit pour l'enregistrement et l'annulation de l'enregistrement de configTool
Nom de 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	Detect
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 vers la catégorie du produit. Le nom du produit est suffisant et il est obligatoire. Ce processus supprime toutes les propriétés et tous les paramètres de configuration pour le produit.

Options

-o

Utilisée avec -i ou -r, cette option remplace une catégorie existante ou un enregistrement de produit existant (noeud).

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

Exemples

Importer des paramètres de configuration à partir d'un fichier nommé Product_config.xml situé dans le répertoire conf sous 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

Exporter tous les paramètres de configuration vers un fichier nommé 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

Enregistrer manuellement une application nommée productName, à l'aide d'un fichier nommé app_config.xml situé dans le répertoire tools/bin par défaut sous l'installation de Marketing Platform et forcer le remplacement 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