usage: wfcommand <pattern matching expression for workflow name> <'Workflow' | workflow service | agent> <instructions> ...

Debug

The command accepts wild cards, such as '*' and '?'. For further information see Textual Pattern Matches.

To turn the debug on for a workflow:

mzsh <username>/<password> wfcommand <workflow> Workflow debug on

To turn the debug for a workflow off:

mzsh <username>/<password> wfcommand <workflow> Workflow debug off

Supervision

By stating the Supervision service you can select to trigger and clear supervision actions with the wfcommand command.
If you want to use the wfcommand to trigger the Supervision service, you can append the following instructions:

manual which has the following syntax:
Usage: manual [-action actionName actionParameters]
Simply entering manual will deactivate the Supervision Service configurations and switch to manual mode, which means that no conditions will be evaluated and no actions will be executed.
When using the -action option, the syntax will be as follows:
Usage: manual -action overload ( <ratio> | -trigger | -clear ) [strategy]
automatic is used to revert to automatic Supervision configuration.

When switching from automatic to manual mode, all active overload protection will remain active. However, in the opposite direction, when switching from manual to automatic mode, all active overload protection will be reset and the appropriate overload protection will be set by the automatic rules.

Each time you switch between manual an automatic mode, an entry will be logged in the System Log for monitoring purposes.

Example.

To trigger overload protection for a workflow:

mzsh <username>/<password> wfcommand <workflow> "Supervision" manual -action overload -trigger

An event will then be sent out for monitoring purposes.

To clear overload protection for a workflow:

mzsh <username>/<password> wfcommand <workflow> "Supervision" manual -action overload -clear

To reject every fifth Diameter AbortSessionRequest in a workflow:

mzsh <username>/<password> wfcommand <workflow> "Supervision" manual -action overload 5 Diameter_AbortSessionRequest

To switch back to automatic mode:

mzsh <username>/<password> wfcommand <workflow> "Supervision" automatic

See the Desktop User's Guide for further information about Supervision Service, Diameter, Radius, and overload.

Aggregation and Diameter agents

The Aggregation and Diameter agents allows the user to interact with the flow of data via the wfcommand. For further information, see 9.3 Aggregation Agent and 9.17 Diameter Agents in the Desktop User's Guide.

GTP agent

The GTP agent allows the user to view the MIM counters via the wfcommand. For further information, see 9.36 GTP' Agent in the Desktop user's guide.

The request counters and the timestamp, which are published as MIM values are also possible to view from the commandline tool.

Syntax to run the wfcommand function in mzsh:
mzsh wfcommand <Workflow Name> <Agent Name> printcounters

Parameters:

`Workflow Name`	Name of the workflow which contains the GTP agent.
`Agent Name`	Name of the GTP agent in the workflow.

Example. Executing the wfcommand

$ mzsh mzadmin/dr wfcommand "Default.myWorkflow" "GTP_1" 
printcounters
Default.myWorkflow (3):
Data Record Count: 138
Cancel Data Count: 2
Message Error Count: 0
Possible Duplicate Count: 5
Release Data Count: 1
Out of Sequence Count: 0
Duplicate Message Count: 0
Redirect Count: 0
Last Request Timestamp: Thu Mar 07 14:38:12 CET 2013

Return Codes

Listed below are the different return codes for the wfcommand command:

Code	Description

Code	Description
1	Will be returned if command line arguments are missing.
2	Will be returned if no matching workflows can be found, or if the workflow is not running.
3	Will be returned if the target agent cannot be found, or if the agent is not accepting/supporting the command.