Configure the ReportsScheduler job in the schedule.xml file

To configure the Reports notifications, configure the job in the schedule.xml file.

The ReportScheduler class is the IXIASOFT CCMS Scheduler job used to generate reports. When CCMS Scheduler runs, it retrieves all the relevant information about the scheduled reports and processes them according to their scheduled entries.

Consider an example where CCMS Scheduler job ReportScheduler is configured to run at 6 a.m. every day. Report A and Report B are scheduled to run at 7 a.m. and 10 a.m. respectively. When CCMS Scheduler runs at 6 a.m., it checks for any scheduled reports, retrieving all the required information from the Content Store. It then creates jobs according to the reports' scheduled times. Report A will be generated at 7 a.m. and Report B at 10 a.m. Both outputs will be sent by email to all the configured recipients. Any changes made to the report after CCMS Scheduler job runs—for example, changes made to Report A at 6:30 a.m.—are not applied to the reports.

You have two options to configure the connection to the Content Store:
  • Use the default connection settings configured in the <configuration> element.
  • Configure a Content Store that is specific to a Scheduler job. This option is recommended only if you want to run a Scheduler job using a Content Store other than the one defined in the <configuration> element. If the Content Store is the same you do not need to additionally configure the connection to the Content Store within a specific Scheduler job. The configuration will fall back to the default Content Store connection.

To configure the ReportsScheduler job:

  1. Open the %SchedulerDir%/conf/schedule.xml file.
  2. Look for the Report Scheduler default job; it looks as follows:
    <!-- The following job takes charge of scheduling user reports as independent items --> 
    <job useClass="com.ixiasoft.cms.postman.ReportsScheduler" enable="true">
    <!-- you can add the tag  <textml>, <dita.out>, or <smtp/> to override the default value -->
    	<schedule>
    		<when>57 */6 * * *</when>
    	</schedule>
    </job>
  3. Edit the <when> element to configure when the job will run.

    Use a crontab-like pattern, as shown below:

    <when>minute hour day month weekday</when>

    Where:

    • minute specifies the minutes (0-59) of the hour that the job will run; a value of * indicates that the job will run every minute
    • hour specifies the hours (0-23, 0=midnight) of the day that the job will run; a value of * indicates that the job will run every hour
    • day specifies the days (1-31) of the month that the job will run; a value of * indicates that the job will run every day
    • month specifies the months (1-12) of the year that the job will run; a value of * indicates that the job will run every month
    • weekday specifies the days (0-6, 0 = Sunday) of the week that the job will run; a value of * indicates that the job will run every day

    For example, to indicate that a job should run at midnight every day, enter the following:

    <when>0 0 * * *</when>

    To indicate that a job should run at 6:15 every day, enter the following:

    <when>15 6 * * *</when>

    There are other options that you can use. For example, to indicate that a job should run every 15 minutes, enter the following:

    <when>*/15 * * * *</when>

    For more information about all available Cron options, see the following URL:

    http://www.sauronsoftware.it/projects/cron4j/manual.php#p02

  4. When you are done, save and close the schedule.xml file.
  5. Restart the CCMS Scheduler service:
    • On Windows: Open the Services console, right-click Ixiasoft Scheduler and click Stop, and then right-click Ixiasoft Scheduler and click Start.
    • On Linux: Run the following commands:
      /sbin/service scheduler stop
      /sbin/service scheduler start