Querying and replaying failed messages, using administrative commands

Use the administrative commands to determine whether there are any failed messages for business processes or human tasks, and, if there are, to retry processing them.

Before you begin

Before you begin this procedure, the following conditions must be met:
  • The application server on which the messages are to be queried or replayed must be running. That is, the -conntype none option of the wsadmin script cannot be used, because a server connection is required.
  • When security is enabled, you must have operator authority.

Why and when to perform this task

When a problem occurs while processing an internal message, this message ends up on the retention queue or hold queue. To determine whether any failed messages exist, and to send those messages to the internal queue again:

Steps for this task

  1. Change to the Business Process Choreographer subdirectory where the administration scripts are located.
    On Windows® systems, enter:
    cd install_root\ProcessChoreographer\admin
    On Linux® and UNIX® systems, enter:
    cd install_root/ProcessChoreographer/admin
  2. Query the number of failed messages on both the retention and hold queues.
    On Windows systems, enter one of the following commands. The differences between the commands are emphasized:
    install_root\bin\wsadmin –lang jython -f queryNumberOfFailedMessages.py 
                                -cluster clusterName
                                [ -bfm | -htm ]
                                [-profileName profileName]
    
    install_root\bin\wsadmin –lang jython -f queryNumberOfFailedMessages.py 
                                -node nodeName 
                                -server serverName
                                [ -bfm | -htm ]
                                [-profileName profileName]
    On UNIX and Linux system, enter one of the following commands. The differences between the commands are emphasized:
    install_root/bin/wsadmin.sh –lang jython -f queryNumberOfFailedMessages.py 
                                -cluster clusterName
                                [ -bfm | -htm ]
                                [-profileName profileName]
    
    install_root/bin/wsadmin.sh –lang jython -f queryNumberOfFailedMessages.py 
                                -node nodeName 
                                -server serverName
                                [ -bfm | -htm ]
                                [-profileName profileName]

    Where:

    cluster clusterName
    The name of the cluster. Required if the business process container is configured for a WebSphere® cluster.
    node nodeName
    Optional when specifying the server name. This name identifies the node. The default is the local node.
    server serverName
    The name of the server. Required if the cluster name is not specified.
    bfm|htm
    These keywords are optional. The default, if neither option is specified is to display all failed messages for both business processes and human tasks. If you only want to display the number of messages in the business process container hold and retention queues, specify the -bfm option. If you only want to display the number of messages in the human task container hold queue, specify the -htm option.
    profileName profileName
    The name of a user-defined profile. Specify this option if you are not working with the default profile.

    If you want to check for a server on the local node, enter:

    wsadmin –lang jython -f queryNumberOfFailedMessages.py -server serverName
  3. Replay all failed messages on the hold queue, retention queue, or both queues.

    On Windows systems, enter one of the following commands. The differences between the commands are emphasized:

    install_root\bin\wsadmin –lang jython -f replayFailedMessages.py 
                             -cluster clusterName 
                             -queue replayQueue
                             [ -bfm | -htm ]
                             [-profileName profileName]
    
    install_root\bin\wsadmin –lang jython -f replayFailedMessages.py 
                             -node nodeName 
                             -server serverName 
                             -queue replayQueue
                             [ -bfm | -htm ]
                             [-profileName profileName]
    
    install_root\bin\wsadmin –lang jython -f replayFailedMessages.py 
                             -server serverName 
                             -queue replayQueue
                             [ -bfm | -htm ]
                             [-profileName profileName]

    On UNIX and Linux systems, enter one of the following commands. The differences between the commands are emphasized:

    install_root/bin/wsadmin.sh –lang jython -f replayFailedMessages.py 
                             -cluster clusterName 
                             -queue replayQueue
                             [ -bfm | -htm ]
                             [-profileName profileName]
    
    install_root/bin/wsadmin.sh –lang jython -f replayFailedMessages.py 
                             -node nodeName 
                             -server serverName 
                             -queue replayQueue
                             [ -bfm | -htm ]
                             [-profileName profileName]
    
    install_root/bin/wsadmin.sh –lang jython -f replayFailedMessages.py 
                             -server serverName 
                             -queue replayQueue
                             [ -bfm | -htm ]
                             [-profileName profileName]

    Where:

    queue replayQueue
    Optionally specifies the queue to replay. replayQueue can have one of the following values:
    • holdQueue (this is the default value)
    • retentionQueue (only valid when the -bfm option is specified)
    • both (only valid when the -bfm option is specified)
    cluster clusterName
    The name of the cluster. Required if the business process container is configured for a WebSphere cluster.
    node nodeName
    Optional when specifying the server name. This name identifies the node. The default is the local node.
    server serverName
    The name of the server. Required if the cluster name is not specified.
    bfm|htm
    These keywords are optional and mutually exclusive. The default, if neither option is specified is to replay failed messages for both business processes and human tasks. If you only want to replay the messages for business processes, specify the -bfm option. If you only want to replay messages for human tasks, specify the -htm option.
    profileName profileName
    The name of a user-defined profile. Specify this option if you are not working with the default profile.

Example

Note: The jacl version of the cleanup unused staff query script, replayFailedMessages.jacl, is deprecated. It is available in the util subdirectory of the ProcessChoreographer directory and it takes the same parameters as described here, but the –lang jython option must be omitted.

(c) Copyright IBM Corporation 2005, 2006.
This information center is powered by Eclipse technology (http://www.eclipse.org)