org.imixs.workflow.magento

Class MagentoSchedulerService

java.lang.Object

org.imixs.workflow.magento.MagentoSchedulerService

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

Magento - Scheduler This is the implementation of a scheduler service. The EJB implementation can be used as a Timer Service to process scheduled activities. The TimerService can be started using the method start(). The Methods findTimerDescription and findAllTimerDescriptions are used to lookup enabled and running service instances. Each Method expects or generates a TimerDescription Object. This object is an instance of a ItemCollection. To create a new timer the ItemCollection should contain the following attributes: datstart - Date Object datstop - Date Object numInterval - Integer Object (interval in seconds) id - String - unique identifier for the schedule Service. $modelversion - String - identifies the model which schould be managed by the service the following additional attributes are generated by the finder methods and can be used by an application to verfiy the status of a running instance: nextTimeout - Next Timeout - pint of time when the service will be scheduled timeRemaining - Timeout in milliseconds statusmessage - text message Magento Import ************************************* The timer service starte the processImport method. this method is repsonsible for the import of orders from magento. To map the status defined in magento with the status defined in process modelel the two properties 'txtModelVersion' are defined. 'txtOrderStatusMapping' txtModelVersion - defines the $modelversion to be defined for a new imported workitem. txtOrderStatusMapping - holds a map of magento status keywords and the corresponding ProcessID in the Imixs Model. e.g. pending=1010 processing=1050 This example defines the a new order with the magento status 'pending' should be mapped to a ProcessID 1010 in the imixs workflow model. All new imported Workitems will be automatically processed with the ActivityID 800. If for a magento order an imixs workitem still exits but the item is not equal then the Service will update the magento data and process the workiem with also the ActivityID CTIVITY_MAGENTO_UPDATE=800. NOTE: It is important that in every workflow state defined by the txtOrderStatusMapping the ActiviyEntity ACTIVITY_MAGENTO_UPDATE=800. If not a WorkflowException will be thrown during the import process. The Magento ID will be stored in the proeprty 'txtName'. As this property need to be unique the method. createMagentoID of the MagentoPlugin will be used to generate an unique id.

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	IMPORT_ERROR

Constructor Summary

Constructors

Constructor and Description
MagentoSchedulerService()

Method Summary

Modifier and Type	Method and Description
List<org.imixs.workflow.ItemCollection>	findAllConfigurations() retruns a list of all existing Magento Shop Configurations
void	importOrders(org.imixs.workflow.ItemCollection configuration) This method imports all orders or update existing workitems.
void	processImport(javax.ejb.Timer timer) This is the method which processes the timeout event depending on the running timer settings.
void	processSingleWorkitem(org.imixs.workflow.ItemCollection aWorkitem) This method process a single workIten in a new transaction.
org.imixs.workflow.ItemCollection	saveConfiguration(org.imixs.workflow.ItemCollection configItemCollection) This method saves the timer configuration.
List<org.imixs.workflow.ItemCollection>	searchArtikel(String searchPhrase) Liefert die trefferliste nach einem Suchbegriff für Artikel zurück Wenn der suchbegriff eine zahl ist, dann wird das ERgebnis nach der ID sortiert.
org.imixs.workflow.ItemCollection	start(org.imixs.workflow.ItemCollection configItemCollection) This Method starts the TimerService.
org.imixs.workflow.ItemCollection	stop(org.imixs.workflow.ItemCollection config) Cancels a running timer instance.
org.imixs.workflow.ItemCollection	updateTimerDetails(org.imixs.workflow.ItemCollection configuration, boolean reload) Update the timer details of a running timer service.

Methods inherited from class java.lang.Object

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

Field Detail

IMPORT_ERROR

public static final String IMPORT_ERROR

See Also:

Constant Field Values

Constructor Detail

MagentoSchedulerService

public MagentoSchedulerService()

Method Detail

findAllConfigurations

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

retruns a list of all existing Magento Shop Configurations

Returns:

saveConfiguration

public org.imixs.workflow.ItemCollection saveConfiguration(org.imixs.workflow.ItemCollection configItemCollection)
                                                    throws org.imixs.workflow.exceptions.AccessDeniedException

This method saves the timer configuration. The method ensures that the following properties are set to default.

• type
• txtName
• $writeAccess
• $readAccess

The method also updates the timer details of a running timer.

Returns:

Throws:

org.imixs.workflow.exceptions.AccessDeniedException

start

public org.imixs.workflow.ItemCollection start(org.imixs.workflow.ItemCollection configItemCollection)
                                        throws org.imixs.workflow.exceptions.AccessDeniedException,
                                               ParseException

This Method starts the TimerService. The Timer can be started based on a Calendar setting stored in the property txtConfiguration, or by interval based on the properties datStart, datStop, numIntervall. The method loads the configuration entity and evaluates the timer configuration. THe $UniqueID of the configuration entity is the id of the timer to be controlled. $uniqueid - String - identifier for the Timer Service. txtConfiguration - calendarBasedTimer configuration datstart - Date Object datstop - Date Object numInterval - Integer Object (interval in seconds) The method throws an exception if the configuration entity contains invalid attributes or values. After the timer was started the configuration is updated with the latest statusmessage The method returns the current configuration

Throws:

org.imixs.workflow.exceptions.AccessDeniedException

ParseException

stop

public org.imixs.workflow.ItemCollection stop(org.imixs.workflow.ItemCollection config)
                                       throws Exception

Cancels a running timer instance. After cancel a timer the corresponding timerDescripton (ItemCollection) is no longer valid

Throws:

Exception

updateTimerDetails

public org.imixs.workflow.ItemCollection updateTimerDetails(org.imixs.workflow.ItemCollection configuration,
                                                            boolean reload)

Update the timer details of a running timer service. The method updates the properties netxtTimeout and timeRemaining and store them into the timer configuration.

Parameters:

configuration -

reload - - if true the confiugration will be reloaded from the database

processImport

public void processImport(javax.ejb.Timer timer)

This is the method which processes the timeout event depending on the running timer settings. For each defined Shop Configuration the method imports all orders. The method also makes a flush on the MagentoCache EJB.

Parameters:

timer -

searchArtikel

public List<org.imixs.workflow.ItemCollection> searchArtikel(String searchPhrase)

Liefert die trefferliste nach einem Suchbegriff für Artikel zurück Wenn der suchbegriff eine zahl ist, dann wird das ERgebnis nach der ID sortiert. Annderfalls alphabetisch nach dem namen.

Parameters:

searchPhrase -

Returns:

importOrders

public void importOrders(org.imixs.workflow.ItemCollection configuration)
                  throws MagentoException

This method imports all orders or update existing workitems. The method imports orders for all states defined in the configuration property 'txtOrderStatusMapping' If no workitem exits the method will create a new one with the $ModelVersion defined by the configruation property 'txtModelVersion'. The new Workitem will be process with the ActivityID 800. The method also stores the property txtMagentoConfiguration with the id of the configuration entity If the workitem still exits but the state did not match the $ProcessID of the workitem will be changed and th workitem will be processed withe ActivityID 801. The method implements a paging mechanism because magento returns maximum 100 order per request.

Parameters:

configuration - - the configuration entity for the magento shop system

Throws:

org.imixs.workflow.exceptions.PluginException

MagentoException

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