ReminderPeriodJob

The Calendar application of eXo Collaboration can send 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 is applied in extension/webapp/src/main/webapp/WEB-INF/cs-extension/cs/cs-configuration.xml.




<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="+0"/>

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

    </properties-param>

  </init-params>

</component-plugin>

Details:

Name: RecordsJob - The name of a schedule job.
Set-method: addPeriodJob - The plugin which registers the method.
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:

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