messaging_tools command options

You can use any of the following options with the messaging_tools command. You must always supply the -password option.

-account accountID
Use to specify the account ID (accountID) of the account to re-synchronize. See -resync.
-config destinationID
Returns the configuration for a message destination.
-password password
Password (password) to use to connect to the server. PolicyCenter requires the password.
-purge date
Deletes completed messages that are older than a specified date. The purge tool deletes messages in Acked, ErrorCleared, Skipped or ErrorRetried state with send time before the specified date. The date format is mm/dd/YYYY.
If the purge tool succeeds in removing these messages without error, it reports the following message:
  • Message table purged
As the number and size of messages can be very large, periodically use this command option to purge old messages to avoid the database from growing unnecessarily.
-restart destinationID -wait wait -retries retries -initial initial -backoff backoff -poll poll -threads threads -chunk chunk
Restarts the messaging destination with new configuration settings:
  • destinationID – The destination ID of the destination to restart.
  • wait – the number of seconds to wait for the shutdown before forcing it.
  • retries – The number of automatic retries to attempt before suspending the messaging destination.
  • initial – The amount of time in milliseconds after a retryable error to retry sending a message.
  • backoff – The amount to increase the time between retries, specified as a multiplier of the time previously attempted. For example, if the last retry time attempted was 5 minutes, and backoff is set to 2, PolicyCenter attempts the next retry in 10 minutes.
  • poll – Each messaging destination pulls messages from the database (from the send queue) in batches of messages on the batch server. The application does not query again until pollinterval amount of time passes. After the current round of sending, the messaging destination sleeps for the reminder of the poll interval. If the current round of sending takes longer than the poll interval, then the thread does not sleep at all and continues to the next round of querying and sending. If your performance issues primarily relate to many messages for each primary object for each destination, then the polling interval is the most important messaging performance setting.
  • threads – To send messages associated with a primary object, PolicyCenter can create multiple sender threads for each messaging destination to distribute the workload. These are threads that actually call the messaging plugins to send the messages. Use the -threads option to configure the number of sender threads for safe-ordered messages. PolicyCenter ignores this setting for non-safe-ordered messages, as PolicyCenter uses one thread for each destination for these types of messages. If your performance issues primarily relate to many messages but few messages per claim for each destination, then this is the most important messaging performance setting.
  • chunk – number of messages to read in a chunk.
-resume destinationID
Resumes the operation of the specified message destination.
-resync -destination destinationID -account accountID
Re-synchronizes an account with specified ID against a specific message destination. Use -destination and -account to specify the destination and policy.
-retry messageID
Attempts to resend a message that failed. The message must be a candidate for retrying. A message is a candidate for retry if the error at the destination system is temporary and the message destination does not have an automatic retry mechanism. For instance, the message is a candidate for retry if the destination contains a locked record and refuses the update.
-retrydest destinationID
Retries all retryable messages for a message destination.
-server url
Specifies the PolicyCenter host server URL. Include the port number and web application name, for example:
  • http://serverName:8180/pc
-skip messageID
Skips a message with the specified ID. If you mark a message as skipped, then PolicyCenter stops trying to resend the message. After you skip a message, you cannot retry it.
-statistics destinationID
Prints the statistics for the specified destination.
-suspend destinationID
Suspends a message destination. Use this command option if the destination system is going to be shut down or to halt sending while PolicyCenter processes a daily batch file.
-user user
User (user) to use to run this process.