Process API Samples Overview

The API samples are useful for understanding how to develop Java™ applications using the Process API. These are supplied on the FileNet® P8 Documentation CD or ESD image in:

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

For more information, see Configuring the Process Development Environment.

See Running the API Samples to compile and run MainSample (a simple workflow processing application).

The supplied sample files are as follows:

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

A 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.
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 A 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 A 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 A 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 A 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 A 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, sets 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 A 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.