Package org.imixs.workflow.engine.plugins

Class AnalysisPlugin

java.lang.Object

org.imixs.workflow.engine.plugins.AbstractPlugin

org.imixs.workflow.engine.plugins.AnalysisPlugin

All Implemented Interfaces:

Plugin

public class AnalysisPlugin
extends AbstractPlugin

This plugin can be used to measure the time of any phase during a workflow. The plugin can be configured by the activity result : Example: M1 defines a start point named 'M1' M2 definens a end point named 'M1' The result will be stored into the txtWorkflowActivityLog (comments) and also the Plugin will create the following fields: - datMeasurePointStart_M1 : contains the start time points (list latest entry on top!) - datMeasurePointEnd_M1 : contains the end time points (list) - numMeasurePoint_M1: contains the total time in milis. With this logic we can measure any time aspact of a process instance

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVALID_FORMAT

Fields inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin

INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Constructor Summary

Constructors

Constructor	Description
AnalysisPlugin()

Method Summary

Modifier and Type	Method	Description
List<org.imixs.workflow.engine.plugins.AnalysisPlugin.MeasurePoint>	evaluate(String aString, ItemCollection documentContext)	This method parses the a string for xml tag xxx.
ItemCollection	run(ItemCollection documentContext, ItemCollection documentActivity)

Methods inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin

close, getCtx, getWorkflowService, init, mergeFieldList, uniqueList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INVALID_FORMAT

public static final String INVALID_FORMAT

See Also:

• Constant Field Values

Constructor Details

AnalysisPlugin

public AnalysisPlugin()

Method Details

run

public ItemCollection run(ItemCollection documentContext,
 ItemCollection documentActivity)
                   throws PluginException

Parameters:

documentContext - the workitem to be processed

documentActivity - the workflow event containing the processing instructions

Returns:

updated workitem for further processing

Throws:

PluginException

evaluate

public List<org.imixs.workflow.engine.plugins.AnalysisPlugin.MeasurePoint> evaluate(String aString,
 ItemCollection documentContext)
                                                                             throws PluginException

This method parses the a string for xml tag xxx. Those tags will result in MeasurePoint M1

Returns:

- a list of measure points

Throws:

PluginException