Platform Explorer / CMF 1.8

Extension point schedule

Documentation

Extension allowing the registration of schedules. This is similar to a cron job sending events. Note that contrary to UNIX cron there is an additional "seconds" field in the cron expression.

A scheduler definition contains information about what event is sent, when, and under what identity.

For instance :

    <schedule id="mySchedule">
        <username>Administrator</username>
        <event>myEvent</event>
        <eventCategory>default</eventCategory>
        <!-- Every first of the month at 3am -->
        <cronExpression>0 0 3 1 * ?</cronExpression>
    </schedule>

@see org.quartz.CronTrigger @see http://www.quartz-scheduler.org/docs/api/1.8.1/org/quartz/CronExpression.html @see http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html

Contribution Descriptors

  • Class: org.nuxeo.ecm.platform.scheduler.core.service.ScheduleImpl

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

  • nuxeo-runtime-5.4.2-HF05.jar
    <extension point="schedule" target="org.nuxeo.ecm.platform.scheduler.core.service.SchedulerRegistryService">
    
        <schedule id="mailReceivedSchedule">
          <username>Administrator</username>
          <password>********</password>
          <eventId>MailReceivedEvent</eventId>
          <eventCategory>default</eventCategory>
          <!-- every half hour of every day -->
          <cronExpression>0 0/30 * * * ?</cronExpression>
        </schedule>
    
      </extension>
  • nuxeo-runtime-5.4.2-HF05.jar
    <extension point="schedule" target="org.nuxeo.ecm.platform.scheduler.core.service.SchedulerRegistryService">
    
        <schedule id="correspEmailInjectionSchedule">
          <username>Administrator</username>
          <password>********</password>
          <eventId>CaseManagementEmailInjectionEvent</eventId>
          <eventCategory>default</eventCategory>
          <!-- every five minutes -->
          <cronExpression>0 0/5 * * * ?</cronExpression>
        </schedule>
    
      </extension>
  • nuxeo-runtime-5.4.2-HF05.jar
    <extension point="schedule" target="org.nuxeo.ecm.platform.scheduler.core.service.SchedulerRegistryService">
    
        <documentation>
          Every day at 01:00 fecth all ActionCaseLink with automatic validation and
          date passed and not done to validate them.
        </documentation>
    
        <schedule id="validateCaseLink">
          <username>Administrator</username>
          <password>********</password>
          <eventId>validateCaseLink</eventId>
          <eventCategory>cmf</eventCategory>
          <cronExpression>0 0 1 * * ?</cronExpression>
        </schedule>
    
      </extension>
  • nuxeo-runtime-5.4.2-HF05.jar
    <extension point="schedule" target="org.nuxeo.ecm.platform.scheduler.core.service.SchedulerRegistryService">
    
        <documentation>
          Every day at 01:00 create new mailboxes and update existing ones
        </documentation>
    
        <schedule id="syncMailbox">
          <username>Administrator</username>
          <password>********</password>
          <eventId>syncMailbox</eventId>
          <eventCategory>cmSync</eventCategory>
          <cronExpression>0 0 1 * * ?</cronExpression>
        </schedule>
    
      </extension>