Glossary

A-Z glossary of PageSeeder concepts

Scheduled jobs

Publish Script can be scheduled to run at set times using the Scheduler.

Scheduled publish events are configured in an XML file which must be located in a certain location. For a specific project, this location is:

/template/[project]/Publish/scheduleConfig.xml

The configuration file must follow the Schedule Config DTD located at /template/default/Publish/schedule-config-1.0.dtd. The schedule config file should have the Doctype Declaration as the top:

<!DOCTYPE schedule PUBLIC "-//PageSeeder//DTD::Schedule Config//EN"
"../../default/Publish/schedule-config-1.0.dtd">


Here is a simple example of configuration file:

<schedule>
  <event>
    <start datetime="2010-07-15T07:00:00+10:00" />
    <repeat minutes="4" until="2010-07-15T10:00:00+10:00" />
    <name>Create Comments</name>
    <type>ant</type>
    <script>scheduler/build.xml</script>
    <target>create-comment</target>
    <inputs>
      <input message="Folder Name" value="my-folder" />
    </inputs>
  </event>
  <event>
    <start datetime="2010-07-14T00:00:00+10:00" />
    <repeat days="1" until="2010-08-14T00:00:00+10:00" />
    <name>Produce Daily Summary</name>
    <type>ant</type>
    <script>scheduler/summary.xml</script>
    <target>generate-summary</target>
  </event>
</schedule>

In the example above, two events are added to the scheduler. When these events are run, the project corresponding to the configuration file is published. That is to say, there is no document being published, only the group parameters are sent to the ANT script (see PageSeeder's Publish parameters for more information).

A publish event must have a name, a start date/time, a type (only ant is currently supported), a script (the path from the /template/[project/Publish folder), and a target to run. Optional fields of the events are: a repeat frequency and a list of inputs.

Repeat frequency is defined by a repeat interval unit (three are allowed: minutes, hours and days) and the value of the interval. An optional attribute is the end date/time for the repeat field. Here are examples of repeat frequencies:

<repeat days="7" />
<repeat hours="24" until="2010-12-31T00:00:00+10:00" />
<repeat minutes="15" />

Inputs are the parameters sent to the ANT script, there could be as many as needed.

Created on , last edited on