org.imixs.workflow.datev.services

Class DatevWorkflowService

java.lang.Object

org.imixs.workflow.datev.services.DatevWorkflowService

@DeclareRoles(value="org.imixs.ACCESSLEVEL.MANAGERACCESS")
 @RunAs(value="org.imixs.ACCESSLEVEL.MANAGERACCESS")
public class DatevWorkflowService
extends Object

This EJB provides methods to import data from a DATEV file and convert the objects into a workitem managed by the Imixs-Worklfow Engine.

The import file must contain 2 header rows. The 1st row contains the object type, the 2nd row contains the filed names. *

The EJB reads a configuration entity with information how to assign a new object to a workflow model

Author:

rsoika

See Also:

to import datev data without assigne the data to a workflow model.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_ERROR
static String	DATEV_CONFIGURATION
static int	EVENT_FAILED
static int	EVENT_START
static int	EVENT_SUCCESS
static String	FILE_NOT_FOUND
static String	INVOICE_UPDATE
static String	IO_ERROR
static String	ISO8601_FORMAT_DATE
static String	ISO8601_FORMAT_DATETIME
static String	ITEM_DATEV_CLIENT_ID
static String	ITEM_DATEV_CONSULTANT_ID
static String	ITEM_DATEV_FISCAL_START
static String	ITEM_INITIAL_TASK
static String	ITEM_MODEL_VERSION
static String	LINK_PROPERTY
static String	MODEL_ERROR
static String	PROCESSING_ERROR
static String	REPORT_ERROR
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
DatevWorkflowService()

Method Summary

Modifier and Type	Method and Description
List<org.imixs.workflow.ItemCollection>	findAllConfigurations() returns a list of all existing datev Configurations
org.imixs.workflow.ItemCollection	findWorkitemByName(String sKey) This method finds a workitem by the attribute 'txtName'
org.imixs.workflow.ItemCollection	importEntities(org.imixs.workflow.ItemCollection configuration, int start, int maxcount) This method imports all entities from a csv file.
void	init() initial setup the magento client implementation
org.imixs.workflow.ItemCollection	loadConfiguration(String id) This method loads a datev configuration.
static void	logMessage(String message, org.imixs.workflow.ItemCollection configuration, org.imixs.workflow.ItemCollection workitem) Creates a new log entry stored in the item _scheduler_log.
List<String>	parseFieldList(String data) This method parses a DATEV field description (first line of the csv file)
void	processInvoices(org.imixs.workflow.ItemCollection datevExport, List<org.imixs.workflow.ItemCollection> invoices, org.imixs.workflow.ItemCollection event, org.imixs.workflow.ItemCollection configuration) This method expects a list of Subprocess definitions.
void	processSingleWorkitem(org.imixs.workflow.ItemCollection aWorkitem) This method process a single workIten in a new transaction.
org.imixs.workflow.ItemCollection	readEntity(String data, List<String> fieldnames) This method creates a ItemCollection from a csv file data line

Methods inherited from class java.lang.Object

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

Field Detail

DATEV_CONFIGURATION

public static final String DATEV_CONFIGURATION

See Also:

Constant Field Values

EVENT_START

public static final int EVENT_START

See Also:

Constant Field Values

EVENT_SUCCESS

public static final int EVENT_SUCCESS

See Also:

Constant Field Values

EVENT_FAILED

public static final int EVENT_FAILED

See Also:

Constant Field Values

INVOICE_UPDATE

public static final String INVOICE_UPDATE

See Also:

Constant Field Values

LINK_PROPERTY

public static final String LINK_PROPERTY

See Also:

Constant Field Values

ITEM_MODEL_VERSION

public static final String ITEM_MODEL_VERSION

See Also:

Constant Field Values

ITEM_INITIAL_TASK

public static final String ITEM_INITIAL_TASK

See Also:

Constant Field Values

ITEM_DATEV_CLIENT_ID

public static final String ITEM_DATEV_CLIENT_ID

See Also:

Constant Field Values

ITEM_DATEV_CONSULTANT_ID

public static final String ITEM_DATEV_CONSULTANT_ID

See Also:

Constant Field Values

ITEM_DATEV_FISCAL_START

public static final String ITEM_DATEV_FISCAL_START

See Also:

Constant Field Values

REPORT_ERROR

public static final String REPORT_ERROR

See Also:

Constant Field Values

MODEL_ERROR

public static final String MODEL_ERROR

See Also:

Constant Field Values

PROCESSING_ERROR

public static final String PROCESSING_ERROR

See Also:

Constant Field Values

CONFIG_ERROR

public static final String CONFIG_ERROR

See Also:

Constant Field Values

IO_ERROR

public static final String IO_ERROR

See Also:

Constant Field Values

FILE_NOT_FOUND

public static final String FILE_NOT_FOUND

See Also:

Constant Field Values

ISO8601_FORMAT_DATETIME

public static final String ISO8601_FORMAT_DATETIME

See Also:

Constant Field Values

ISO8601_FORMAT_DATE

public static final String ISO8601_FORMAT_DATE

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

DatevWorkflowService

public DatevWorkflowService()

Method Detail

init

@PostConstruct
public void init()

initial setup the magento client implementation

findAllConfigurations

public List<org.imixs.workflow.ItemCollection> findAllConfigurations()

returns a list of all existing datev Configurations

Returns:

loadConfiguration

public org.imixs.workflow.ItemCollection loadConfiguration(String id)

This method loads a datev configuration. If no configuration entity yet exists the method returns an empty ItemCollection. The method updates the timer details netxtTimeout and timeRemaining of a running timer service. The method uses a caching mechanism to store still loaded conigurations.

Returns:

configuration ItemCollection

findWorkitemByName

public org.imixs.workflow.ItemCollection findWorkitemByName(String sKey)

This method finds a workitem by the attribute 'txtName'

Returns:

workitem or null if no workitem exits

importEntities

public org.imixs.workflow.ItemCollection importEntities(org.imixs.workflow.ItemCollection configuration,
                                                        int start,
                                                        int maxcount)
                                                 throws DatevException

This method imports all entities from a csv file. The method runs in a new transaction so processing exceptions can be caught and stored in the DATEV configuration entity The parameter start and count can be used to import only a part of the file.

Parameters:

configuration - - the configuration entity for the DATEV import

start - - optional start position

count - - optional count (default =-1)

Throws:

org.imixs.workflow.exceptions.PluginException

DatevException

parseFieldList

public List<String> parseFieldList(String data)

This method parses a DATEV field description (first line of the csv file)

Returns:

list of fieldnames

readEntity

public org.imixs.workflow.ItemCollection readEntity(String data,
                                                    List<String> fieldnames)

This method creates a ItemCollection from a csv file data line

Parameters:

data -

fieldnames -

Returns:

processSingleWorkitem

public void processSingleWorkitem(org.imixs.workflow.ItemCollection aWorkitem)
                           throws org.imixs.workflow.exceptions.AccessDeniedException,
                                  org.imixs.workflow.exceptions.ProcessingErrorException,
                                  org.imixs.workflow.exceptions.PluginException,
                                  org.imixs.workflow.exceptions.ModelException

This method process a single workIten in a new transaction. The method is called by processWorklist()

Parameters:

aWorkitem -

Throws:

org.imixs.workflow.exceptions.PluginException

org.imixs.workflow.exceptions.ProcessingErrorException

org.imixs.workflow.exceptions.AccessDeniedException

org.imixs.workflow.exceptions.ModelException

processInvoices

public void processInvoices(org.imixs.workflow.ItemCollection datevExport,
                            List<org.imixs.workflow.ItemCollection> invoices,
                            org.imixs.workflow.ItemCollection event,
                            org.imixs.workflow.ItemCollection configuration)
                     throws org.imixs.workflow.exceptions.AccessDeniedException,
                            org.imixs.workflow.exceptions.ProcessingErrorException,
                            org.imixs.workflow.exceptions.PluginException,
                            org.imixs.workflow.exceptions.ModelException

This method expects a list of Subprocess definitions. The method updates and processes each existing invoice.

The definition is expected in the following format (were regular expressions are allowed)

 
 <item name="invoice_update">
    <modelversion>1.0.0</modelversion>
    <task>100</task>
    <event>20</event>
 </item>
 
 

The method runs wit TransactionAttributeType.REQUIRES_NEW so that in case than one of the invoices could not be processed all updates are rolled back. This is important to avoid inconsistency during a DATEV export

Parameters:

datevExport - - datev export workitem

invoices - - list of invoices

event - - current datev export event containing the invoice_update definition.

Throws:

org.imixs.workflow.exceptions.AccessDeniedException

org.imixs.workflow.exceptions.ProcessingErrorException

org.imixs.workflow.exceptions.PluginException

org.imixs.workflow.exceptions.ModelException

See Also:

org.imixs.workflow.engine.plugins.SplitAndJoinPlugin.java

logMessage

public static void logMessage(String message,
                              org.imixs.workflow.ItemCollection configuration,
                              org.imixs.workflow.ItemCollection workitem)

Creates a new log entry stored in the item _scheduler_log. The log can be writen optional to the configuraiton and the workitem

Parameters:

message -

configuration -