Everything about CronJobs in Hybris (Part 2)

In the first part of this article, we explored the basics of Cronjobs, Jobs and Triggers, and also the differences between them.

In this part of the article we are going to make a concrete example of a Cronjob, a HelloWorldCronJob.

HelloWorldCronJob will take a firstName as an input and print Hello firstName as an output.

1. CronJob

Create a new item type extends CronJob, with name HelloWorldCronJob and attribute firstName.

<itemtype code="HelloWorldCronJob" extends="CronJob" jaloclass="com.stackextend.training.core.jalo.HelloWorldCronJob">

	<attributes>
		
		<attribute qualifier="firstName" type="java.lang.String">
			<modifiers/>
			<persistence type="property"/>
		</attribute>
		
	</attributes>
</itemtype>

Run ant all command, then run update system from the HAC.

Note that you don’t need to create a new Cronjob if your Job does not require inputs.

2. Job

Create a Job where we are going to add our Logic (display Hello firstName) :

First create a class that extends from AbstractJobPerformable and implement the perform() method:

public class HelloWorldJob extends AbstractJobPerformable<HelloWorldCronJobModel> {

    @Override
    public PerformResult perform(HelloWorldCronJobModel cronJobModel) {
        try {
            // Retrieve firstName from the cronJob
            String firstName = cronJobModel.getFirstName();
            
            // Display Hello firstName
            System.out.println("Hello " + firstName);
            
            // In case of success return result: SUCCESS and status: FINISHED
            return new PerformResult(CronJobResult.SUCCESS, CronJobStatus.FINISHED);

        } catch(Exception e) {

            // In case of exception return result: ERROR and status: ABORTED
            return new PerformResult(CronJobResult.ERROR, CronJobStatus.ABORTED);

        }
    }
}

Register the HelloWorldJob class as a bean into Spring context.

<bean id="helloWorldJob" class="de.hybris.merchandise.core.job.HelloWorldJob"
	  parent="abstractJobPerformable" >

	<!-- Inject other beans here if it's needed -->

</bean>

Create an instance of the ServicelayerJob with springId as helloWorldJob.

INSERT_UPDATE ServicelayerJob	;code[unique=true]	;springId
								;helloWorldJob	;helloWorldJob

Create an instance of our HelloWorldCronJob, give it a firstName and the instance of ServicelayerJob that we have just created.

INSERT_UPDATE HelloWorldCronJob	;code[unique=true]	;job(code)		;firstName; sessionLanguage(isocode); sessionCurrency(isocode)
								;helloWorldCronJob	;helloWorldJob	;Mouad; en ;EUR

Our Cronjob is ready to be used now, we should be able to start it manually from HMC or Backoffice.

3. Trigger

Create a Trigger to run the Cronjob at specific period of time, every Sunday at 12:00 for example.

INSERT_UPDATE Trigger	;cronjob(code)[unique=true]	;cronExpression
						;helloWorldCronJob		;0 0 12 ? * SUN *

You can find the next activation time of our CronJob from HMC.

4. Conclusion

To Create a Cron job in Hybris, we need to :

• Create CronJob that hold all the inputs to be passed to the Job (it’s optional).
• Create Our JobPerformable, then implement the logic to be done inside it.
• Register the JobPerformable as a Spring bean with id.
• Create a new instance of ServicelayerJob, then inject the bean id in it.
• Create an instance CronJob model with this signle run configuration (inputs).
• Then Create a Trigger if it’s needed to schedule the CronJob in time.