schedule (Domino DTD)

Represents a schedule that triggers the execution of agent code.

Containment Hierarchy

Contained by: <trigger>

Contains: <starttime>, <endtime> , <startdate>, <enddate>

Syntax

<!ELEMENT schedule ( starttime?, endtime?, startdate?, enddate? )>

Content

starttime?, endtime?, startdate?, enddate?

An optional <starttime> element, followed by optional <endtime>, <startdate>, and <enddate> elements.

Attributes

<!ATTLIST schedule


type	(%schedule.types;)	#REQUIRED
hours	%integer;	#IMPLIED
minutes	%integer;	#IMPLIED
onweekends	%boolean;	"true"
runlocation	(%schedule.runlocations;)	#IMPLIED
runserver	%string;	#IMPLIED
dayofweek	(%day.names;)	#IMPLIED
dateinmonth	%integer;	#IMPLIED

dateinmonth

Date in month on which agent code executes. Must be specified for scheduled agents that run monthly.

dayofweek

Day of the week on which agent code executes. Must be specified for scheduled agents that run weekly.

hours

When the type attribute equals frequently, specifies the frequency (in number of hours) with which the agent should run, i.e., Run once every N hours.

minutes

When the type attribute equals frequently, specifies the frequency (in number of minutes) with which the agent should run, i.e., Run once every M minutes.

onweekends

Indicates if a scheduled agent can run on the weekends. This attribute is not applicable to scheduled agents that run weekly or monthly.

runlocation

Indicates which host system the agent should run on, as defined by the %schedule.runlocations; entity.

runserver

Name of the server when the runlocation attribute equals server.

type

Type of schedule selected, in units of time, as defined by the Defined entities for <schedule> element entity.

Defined entities for <schedule> element

The %day.names; entity lists the days of the week that you can specify when scheduling an agent to run once a week.

Syntax:

<!ENTITY % day.names "sunday | monday | tuesday | wednesday | thursday | friday | saturday ">

The %schedule.types; entity lists the choices for units of time that trigger a scheduled agent.

Syntax:

<!ENTITY % schedule.types "automatic | byminutes | daily | weekly | monthly | never ">

automatic

Schedule is determined elsewhere. For example, if an agent has a trigger type of docupdate, this schedules the agent to run if documents have been updated.

byminutes

Schedules an agent to run more than once a day. You indicate the frequency in minutes or hours using the minutes and/or hours attributes of <schedule>.

The %schedule.runlocations; entity lists the choices for the host system on which an agent runs.

Syntax:

<!ENTITY % schedule.runlocations "local | any | choose | server ">

any

Runs the agent on any server system that the agent is available on.

choose

Prompts users to select a server when the agent is enabled.

local

Runs the agent on the local system.

server

Runs the agent only on the specified server.