2.2.5.4. Reminder Period Job

Warning

You are looking at documentation for an older release. Not what you want? See the current release documentation.

The Calendar application of eXo Platform sends event reminders by using the email reminder plugin configuration. You will probably need to adjust this configuration to meet your own needs. The feature is based on a periodic poll of the stored reminders.

You must use the following target component to use the plugin in this configuration:


<target-component>org.exoplatform.services.scheduler.JobSchedulerService</target-component>

The configuration can be found here.


<component-plugin>

      <name>RecordsJob</name>

      <set-method>addPeriodJob</set-method>

      <type>org.exoplatform.calendar.service.ReminderPeriodJob</type>

      <description>add e-mail reminder job to the JobSchedulerService</description>

      <init-params>

        <properties-param>

          <name>job.info</name>

          <description>save the monitor data  periodically</description>

          <property name="jobName" value="ReminderJob"/>

          <property name="groupName" value="CollaborationSuite"/>

          <property name="job" value="org.exoplatform.calendar.service.ReminderJob"/>

          <property name="repeatCount" value="0"/>

          <property name="period" value="180000"/>

          <property name="startTime" value="+60000"/>

          <property name="endTime" value=""/>

        </properties-param>

      </init-params>

    </component-plugin>

Details:

Name: RecordsJob - The name of a schedule job.
Type: org.exoplatform.calendar.service.ReminderPeriodJob - A class that executes to transfer data into database of Job Scheduler.
Description: Add email reminder job to the JobSchedulerService.

See details about the init-params of the component in the following table:

Property names	Possible values	Default value	Description
`jobName`	`String`	`ReminderJob`	The name of job
`groupName`	`String`	`CollaborationSuite`	The name of group job.
`job`	`Class path`	`org.exoplatform.calendar.service.ReminderJob`	The name of actual job class.
`repeatCount`	`Long`	`0, ( use '0' which means 'run forever'.)`	How many times to run this job.
`period`	`Long`	`180000`	The time interval between job executions.
`startTime`	`Integer`	`+60000`	The time when the job starts running.
`endTime`	`Integer`	`none`	The time when the job ends running.