The Process API samples provided with your installation are a useful starting place for understanding how to develop applications using these APIs. In general, these samples demonstrate a basic approach to developing workflow processing applications (such as Step Processors, Work Performers, etc.) that make efficient use of the APIs.
The API samples are documented in detail in this guide; however, this guide assumes that you are also looking at the source code of the samples for context. In addition to including topics explaining how the samples operate, the Run the unmodified samples topic details how to compile and run the MainSample sample, which is a simple workflow processing application. Many of the remaining topics include information on running samples from the command line.
The following table lists, in alphabetical order, the Java sample files and provides a brief description for each:
Sample file name |
Description |
---|---|
LaunchSample.java | Demonstrates how to open and transfer a workflow definition file. |
LockReportSample.java | Demonstrates how to log the work object number and user information for locked work objects. |
Logger.java (helper class) |
Provides reusable logging functions for the other sample files. |
LogSample.java | Illustrates how to write the VWLog record information to a file. |
LogViewer.java | Demonstrates how to create a log-viewing tool with "Select Log", "Create new log index", "Query Log", and "List Exposed Log Fields" options. |
MainSample.java | Demonstrates how to develop a simple application in a modular fashion. This is a top-level application that calls main functions in the other sample files. These sample files create and launch a workflow definition, complete the steps, and write the history information to a log file. |
MilestoneHelper.java (helper class) | Provides reusable milestone display-related methods that are referenced by some of the sample classes. |
MilestoneSample.java | Reports milestone definitions in various workflows of a queue. |
OperationsHelper.java (helper class) | Provides reusable methods for creating and reporting on operations on a queue. |
OperationsSample.java | Creates operations on a queue and reports configuration information for all operations defined on a queue. |
ProcessSample.java | Illustrates how to log process information. |
QueueHelper.java (helper class) | Provides reusable queue-specific methods which are referenced by some of the sample classes. |
QueueSample.java | Displays contents of workflow queues. |
RosterHelper.java (helper class) | Provides reusable roster-specific methods which are referenced by some of the sample classes. |
RosterSample.java | Demonstrates how to write the contents of a roster to a log file. |
SessionHelper.java (helper class) | Provides reusable session-specific logon and logoff session methods that are referenced by some of the sample classes. |
StepProcessorSample.java | Retrieves a step element from a queue, set the comments, displays the step information, and completes the step. |
SysConfigSample.java | Illustrates how to create a queue, exposed field, and an index. |
SystemStepHelper.java (helper class) | Provides reusable methods for building workflows with system steps. |
SystemStepSample.java | Creates and launches a workflow with system steps. |
UserInfoSample.java | Demonstrates how to retrieve and display user information. |
WFDefinitionSample.java | Demonstrates how to create and save a workflow definition file. |
WorkPerformerSample | Illustrates how to create a custom workflow processing application (also called a work performer) that polls a queue and dispatches work items. |