org.imixs.workflow.plugins
Class HistoryPlugin

java.lang.Object
  org.imixs.workflow.plugins.AbstractPlugin
      org.imixs.workflow.plugins.HistoryPlugin

All Implemented Interfaces:

Plugin

public class HistoryPlugin
extends AbstractPlugin

This Pluginmodul implements a Historyfunktion for Workflowactivitys. The Plugin generates a History Entry which will be appended to an existing workflowprotokoll. The Protocol will be stored in the Attributes o txtworkflowhistorylog (descending sort) o txtworkflowhistorylogrev (ascending sort) The Plugin generate a History Entry by a set of activityEntity attributes These attributes are: o rtfresultlog (String): HistoryLog text o keylogdateformat (String): Dateformat for Historyentry o keylogtimeformat (String): Timeformat for Historyentry Each entry will be Präfixed by a DateTime String representing the time the Entry was generated. The HistoryLog function pares the rtfresultlog for "attribute" tags and replaces these tags with the values of the corresponding attributes of the workitem. the Attribute numworkflowhistoryLength indicates the maximum number of entries. if <= 0 no limit is set. Otherwise older entries will be cut off.

Version:

1.2

Author:

Ralph Soika

See Also:

WorkflowManager

Field Summary

ItemCollection	documentActivity
ItemCollection	documentContext

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

ctx

Fields inherited from interface org.imixs.workflow.Plugin

PLUGIN_ERROR, PLUGIN_OK, PLUGIN_WARNING

Constructor Summary

HistoryPlugin()

Method Summary

void	close(int status) store history only if no error has occurred
int	run(ItemCollection adocumentContext, ItemCollection adocumentActivity)

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

formatItemValues, getAbbreviateName, getCommonName, init, replaceDynamicValues

Methods inherited from class java.lang.Object

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

Field Detail

documentContext

public ItemCollection documentContext

documentActivity

public ItemCollection documentActivity

Constructor Detail

HistoryPlugin

public HistoryPlugin()

Method Detail

run

public int run(ItemCollection adocumentContext,
               ItemCollection adocumentActivity)
        throws java.lang.Exception

Parameters:

adocumentContext - defines the document to be processed

adocumentActivity - defines the activity document which contains the workflowprocessing instructions

Returns:

the current status for this plugin

Throws:

java.lang.Exception

close

public void close(int status)

store history only if no error has occurred

Parameters:

status - gives the plugin information about the current status. this parameter is deliverd by the workflowKernel.