StepProcessorSample

This sample demonstrates how to retrieve a step element from a queue, set the comments on the step element, display the step information, and complete the step. Run the sample by entering a command similar to the following:

    java LockReportSample username password server_name:port_number/connectionPoint_name 
        output_filename

Refer to the comments in the sample source for further information. The samples are located on the P8 Documentation CD or ESD image in:

   ecm_help\developer_help\process_java_api\Developer Files\samples\api

See also Running the API Samples.

Methods

General descriptions of the StepProcessorSample methods follow:

main()

The main method uses common techniques for validating and defaulting argument values. The default value for the log output file is StepProcessorSample.out. The main method constructs and passes VWSession and Logger objects to the sample constructor. Main() handles the login and logoff for the session with the login() and logoff() methods of the sample SessionHelper class, and provides workflow logging with an instance of the sample Logger class. The main method passes the session, the logger, the user name, and the queue name to the constructor.

StepProcessorSample()

The constructor StepProcessorSample() creates an instance of the local sample QueueHelper class, create the object for the requested queue, performs common exception handling, and retrieves a step element from a queue with the sample method QueueHelper.getQueue. It demonstrates setting the comments on the step element, displaying the step information, and dispatching the step with VWStepElement methods.