configTool

The properties and values on the Configuration page are stored in the Unica Platform system tables. You can use the configTool utility to import and export configuration settings to and from the system tables.

When to use configTool

You might want to use configTool for the following reasons.

  • To import partition and data source templates that are supplied with Unica Campaign, which you can then modify and duplicate by using the Configuration page.
  • To register (import configuration properties for) Unica products, if the product installer is unable to add the properties to the database automatically.
  • To export an XML version of configuration settings for backup or to import into a different installation of Unica.
  • To delete categories that do not have the Delete Category link. You do this by using configTool to export your configuration, then manually deleting the XML that creates the category and by using configTool to import the edited XML.
Important: This utility modifies the usm_configuration and usm_configuration_values tables in the Unica Platform system table database, which contains the configuration properties and their values. For best results, either create backup copies of these tables, or export your existing configurations by using configTool and back up the resulting file so you have a way to restore your configuration if you make an error when you use configTool to import.

Syntax

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

Commands

-d -p "elementPath" [o]

Delete configuration properties and their settings, specifying a path in the configuration property hierarchy.

The element path must use the internal names of categories and properties. You can obtain them by going to the Configuration page, selecting the wanted category or property, and looking at the path that is displayed in parentheses in the right pane. Delimit a path in the configuration property hierarchy by using the | character, and surround the path with double quotation marks.

Note the following.

  • Only categories and properties within an application can be deleted by using this command, not whole applications. Use the -u command to unregister a whole application.
  • To delete categories that do not have the Delete Category link on the Configuration page, use the -o option.

When you use -d with the -vp command, the configTool deletes any child nodes in the path you specify if those nodes are not included in the XML file you specify.

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

Import configuration properties and their settings from a specified XML file.

To import, you specify a path to the parent element under which you want to import your categories. The configTool utility imports properties under the category you specify in the path.

You can add categories at any level below the top level, but you cannot add a category at same level as the top category.

The parent element path must use the internal names of categories and properties. You can obtain them by going to the Configuration page, selecting the required category or property, and looking at the path that is displayed in parentheses in the right pane. Delimit a path in the configuration property hierarchy by using the | character and surround the path with double quotation marks.

You can specify an import file location relative to the tools/bin directory or you can specify a full directory path. If you specify a relative path or no path, configTool first looks for the file relative to the tools/bin directory.

By default, this command does not overwrite an existing category, but you can use the -o option to force an overwrite.

-x -p "elementPath" -f exportFile

Export configuration properties and their settings to an XML file with a specified name.

You can export all configuration properties or limit the export to a specific category by specifying a path in the configuration property hierarchy.

The element path must use the internal names of categories and properties, which you can obtain by going to the Configuration page, selecting the wanted category or property, and looking at the path that is displayed in parentheses in the right pane. Delimit a path in the configuration property hierarchy by using the | character and surround the path with double quotation marks.

You can specify an export file location relative to the current directory or you can specify a full directory path. If the file specification does not contain a separator (/ on UNIX™, / or \ on Windows™), configTool writes the file to the tools/bin directory under your Unica Platform installation. If you do not provide the xml extension, configTool adds it.

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

This command is used mainly in manual upgrades, to import configuration properties. If you applied a fix pack that contains a new configuration property, and you then upgrade, importing a configuration file as part of a manual upgrade process can override values that were set when the fix pack was applied. The -vp command ensures that the import does not override previously set configuration values.

Important: After you use the configTool utility with the -vp option, you must restart the web application server on which Unica Platform is deployed so the changes are applied.

When you use -d with the -vp command, the configTool deletes any child nodes in the path you specify if those nodes are not included in the XML file you specify.

-r productName -f registrationFile

Register the application. The registration file location can be relative to the tools/bin directory or can be a full path. By default, this command does not overwrite an existing configuration, but you can use the -o option to force an overwrite. The productName parameter must be one of those names that are listed above.

Note the following.

  • When you use the -r command, the registration file must have <application> as the first tag in the XML.

    Other files can be provided with your product that you can use to insert configuration properties into the Unica Platform database. For these files, use the -i command. Only the file that has the <application> tag as the first tag can be used with the -r command.

  • The registration file for the Unica Platform is named Manager_config.xml, and the first tag is <Suite>. To register this file on a new installation, use the populateDb utility, or rerun the Unica Platform installer as described in the Unica Platform Installation Guide.
  • After the initial installation, to re-register products other than the Unica Platform, use configTool with the -r command and -o to overwrite the existing properties.

The configTool utility uses product names as parameters with the commands that register and unregister products. With the 8.5.0 release of Unica, many product names changed. However, the names that are recognized by configTool did not change. The valid product names for use with configTool are listed below, along with the current names of the products.

Table 1. Product names for configTool registration and unregistration
Product name Name used in configTool
Unica Platform Manager
Unica Campaign Campaign
Unica Collaborate Collaborate
Unica Deliver Deliver
Unica Journey Journey
Unica Insights UnicaInsights
Unica Content Integration assetPicker
Unica Offer Offer
Unica Interact interact
Unica Optimize Optimize
Unica Plan Plan
Opportunity Detect Detect
IBM SPSS Modeler Advantage Enterprise Marketing Management Edition SPSS
Digital Analytics Coremetrics
-u productName

Unregister an application that is specified by productName. You do not have to include a path to the product category; the product name is sufficient, and it is required. The process removes all properties and configuration settings for the product.

Options

-o

When used with -i or -r, it overwrites an existing category or product registration (node).

When used with -d, you can delete a category (node) that does not have the Delete Category link on the Configuration page.

Examples

  • Import configuration settings from a file named Product_config.xml in the conf directory under the Unica Platform installation.

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

  • Import one of the supplied Unica Campaign data source templates into the default Unica Campaign partition, partition1. The example assumes that you placed the Oracle data source template, OracleTemplate.xml, in the tools/bin directory under the Unica Platform installation.

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

  • Export all configuration settings to a file named myConfig.xml in the D:\backups directory.

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

  • Export an existing Unica Campaign partition (complete with data source entries), save it to a file named partitionTemplate.xml, and store it in the default tools/bin directory under the Unica Platform installation.

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

  • Manually register an application named productName, by using a file named app_config.xml in the default tools/bin directory under the Unica Platform installation, and force it to overwrite an existing registration of this application.

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

  • Unregister an application named productName.

    configTool -u productName

  • Run the following command to enable encodeCSV feature:

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

  • Register Unica Interact Settings as configuration menu under AffiniumWebApps\Campaign\interact\conf\interact_setup_navigation.xml using

    configTool.bat -v -i -p "Affinium|suite|uiNavigation|settingsMenu" -f "interact_setup_navigation.xml"