StepProcessorSample

This sample demonstrates how to perform step processor activities.

Specifically, the following activities are shown here:
  • Retrieve a step element from a queue
  • Set the comments on the step element
  • Display the step information
  • Complete the step
Run the sample by entering a command similar to the following example:

    java LockReportSample username password server_name:port_number/connectionPoint_name 
        output_filename

For more information, see the comments in the sample source. The samples are supplied in the Developer samples section of the IBM® FileNet P8 Platform publication library.

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. It also 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() performs the following actions:
  • Creates an instance of the local sample QueueHelper class
  • Creates the object for the requested queue
  • Performs common exception handling
  • 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.