Package org.imixs.workflow.engine.plugins

Class ReportPlugin

java.lang.Object

org.imixs.workflow.engine.plugins.AbstractPlugin

org.imixs.workflow.engine.plugins.ReportPlugin

All Implemented Interfaces:

Plugin

public class ReportPlugin
extends AbstractPlugin

This plug-in executes a Imixs Report definition and stores the result either into the current workitem ($file) or into the file system. The corresponding BPMN event provide the following properties:

• txtReportName=Name of the Report to be processed
• txtReportFilePath= optional filename or file path the result will be saved
• txtReportTarget = where the result is saved (0=workitem, 2= disk)

CHANGES V 2.0

In the current version 2.0, only the processed document will be used as the xml input source for the XSL transformation. A search query will currently not be evaluated.

Version:

2.0

Author:

Ralph Soika

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVALID_CONTEXT
static final String	INVALID_REPORT_DEFINITION
static final String	REPORT_UNDEFINED

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

INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Constructor Summary

Constructors

Constructor	Description
ReportPlugin()

Method Summary

Modifier and Type	Method	Description
void	close(int status)
ItemCollection	run(ItemCollection adocumentContext, ItemCollection adocumentActivity)	Executes a report defined defined by the event in the attribute 'txtReportName'.

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_CONTEXT

public static final String INVALID_CONTEXT

See Also:

• Constant Field Values

REPORT_UNDEFINED

public static final String REPORT_UNDEFINED

See Also:

• Constant Field Values

INVALID_REPORT_DEFINITION

public static final String INVALID_REPORT_DEFINITION

See Also:

• Constant Field Values

Constructor Details

ReportPlugin

public ReportPlugin()

Method Details

run

public ItemCollection run(ItemCollection adocumentContext,
 ItemCollection adocumentActivity)
                   throws PluginException

Executes a report defined defined by the event in the attribute 'txtReportName'.

The XML Source used by this method is the XML representation of the current document. The Query Statement will not be evaluated

Parameters:

adocumentContext - the workitem to be processed

adocumentActivity - the workflow event containing the processing instructions

Returns:

updated workitem for further processing

Throws:

PluginException

close

public void close(int status)
           throws PluginException

Throws:

PluginException