2.2.5.5. Popup Reminder Period Job

Warning

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

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>PopupRecordsJob</name>

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

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

      <description>add popup 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="PopupReminderJob"/>

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

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

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

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

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

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

        </properties-param>

        <properties-param>

          <name>popupreminder.info</name>

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

          <property name="portalName" value="portal"/>

        </properties-param>

      </init-params>

  </component-plugin>

Details:

Name: PopupRecordsJob - The name of the job.
Type: org.exoplatform.calendar.service.PopupReminderPeriodJob - The class which executes to transfer the data into database of Job Scheduler.
Description: Adds popup reminder job to the JobSchedulerService.
Properties-param: job.info. This param saves the monitor data periodically and includes the following sub-params:

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