Marketing Platform utilities
This section provides an overview of the Marketing Platform utilities, including some details that apply to all of the utilities and which are not included in the individual utility descriptions.
Location of utilities
Marketing Platform utilities are located in the tools/bin directory under your Marketing Platform installation.
List and descriptions of utilities
The Marketing Platform provides the following utilities.
- alertConfigTool - registers alerts and configurations for IBM EMM products
- configTool - imports, exports, and deletes configuration settings, including product registrations
- datafilteringScriptTool - creates data filters
- encryptPasswords - encrypts and stores passwords
- partitionTool - creates database entries for partitions
- populateDb - populates the Marketing Platform database
- restoreAccess - restores a user with the platformAdminRole role
- scheduler_console_client - lists or starts IBM EMM Scheduler jobs that are configured to listen for a trigger.
Prerequisites for running Marketing Platform utilities
The following are prerequisites for running all Marketing Platform utilities.
- Run all utilities from the directory where they are located (by default, the tools/bin directory under your Marketing Platform installation).
- On UNIX™, the best practice is to run the utilities with the same user account that runs the application server on which Marketing Platform is deployed. If you run a utility with a different user account, adjust the permissions on the platform.log file to allow that user account to write to it. If you do not adjust permissions, the utility is not able to write to the log file and you might see some error messages, although the tool should still function correctly.
Troubleshooting connection issues
All of the Marketing Platform utilities except encryptPasswords interact with the Marketing Platform system tables. To connect to the system table database, these utilities use the following connection information, which is set by the installer using information provided when the Marketing Platform was installed. This information is stored in the jdbc.properties file, located in the tools/bin directory under your Marketing Platform installation.
- JDBC driver name
- JDBC connection URL (which includes the host, port, and database name)
- Data source login
- Data source password (encrypted)
In addition, these utilities rely on the JAVA_HOME environment variable, set either in the setenv script located in the tools/bin directory of your Marketing Platform installation, or on the command line. The Marketing Platform installer should have set this variable automatically in the setenv script, but it is a good practice to verify that the JAVA_HOME variable is set if you have a problem running a utility. The JDK must be the Sun version (not, for example, the JRockit JDK available with WebLogic).
Special characters
Characters that are designated as reserved characters in the operating system must be escaped. Consult your operating system documentation for a list of reserved characters and how to escape them.
Standard options in Marketing Platform utilities
The following options are available in all Marketing Platform utilities.
-l logLevel
Set the level of log information displayed in the console. Options are high, medium, and low. The default is low.
-L
Set the locale for console messages. The default locale is en_US. The available option values are determined by the languages into which the Marketing Platform has been translated. Specify the locale using the ICU locale ID according to ISO 639-1 and ISO 3166.
-h
Display a brief usage message in the console.
-m
Display the manual page for this utility in the console.
-v
Display more execution details in the console.