The file containing the XML configuration should be specified when starting the JobScheduler.
The following shows a simple configuration file with a shell job:
<?xml version="1.0">
<spooler>
<config>
<jobs>
<job name="hello_world">
<script language="shell"><![CDATA[
echo hello world
]]></script>
<run_time repeat="10"/>
</job>
</jobs>
</config>
</spooler>
This example shows the configuration of the hello_world job, which the JobScheduler repeats every 10 seconds.
When this configuration is saved in the hello_world.xml file, the JobScheduler could be started as follows (for Windows):
…scheduler installation path…\bin\scheduler.exe -config=hello_world.xml
Note that if the JobScheduler has been started at the command line, it can be stopped using the "Ctrl-C" keys.
Alternatively you could create individual configuration files per job, job chain etc. that would contain exclusively the elements required by these objects:
<?xml version="1.0">
<job>
<script language="shell"><![CDATA[
echo hello world
]]></script>
<run_time repeat="10"/>
</job>
When this configuration is saved in a file
scheduler installation path/config/live/hello_world.job.xml,
then it would be automatically used by a running JobScheduler.
<?xml encoding="UTF-8"?> and
<?xml encoding="ISO-8859-1"?> are allowed.
Note that the JobScheduler only processes 8 bit Characters (ISO-8859-1).
The JobScheduler verifies the XML configuration according to the JobScheduler XML Schema (Is only shown correctly in IE).
Clicking on an XML element in the schema list below leads to a description of the element:
<spooler <config central_configuration_directory = "…" configuration_add_event = "…" configuration_delete_event = "…" configuration_directory = "…" configuration_update_event = "…" include_path = "…" ip_address = "…" log_dir = "…" mail_xslt_stylesheet = "…" param = "…" port = "4444" priority_max = "1000" spooler_id = "" supervisor = "…" tcp_port = "4444" udp_port = "4444"> time_zone = "..."> <base file="…"/> <params > <param name="…" value="…"/> </params> <security > <allowed_host name="…" level="…"/> … </security> <plugins> <plugin java_class="…"/> … </plugins> <cluster heart_beat_own_timeout = "…" heart_beat_timeout = "…" heart_beat_warn_timeout = "…"/> <process_classes ignore = "no"> <process_class max_processes = "…" name = "…" spooler_id = "…"> <remote_schedulers ignore = "no"> <remote_scheduler remote_scheduler = "…" http_heartbeat_period = "…" http_heartbeat_timeout = "…"> </remote_scheduler> </remote_schedulers> </process_class> … </process_classes> <schedules> <schedule name = "…" substitute = "…" valid_from = "…" valid_to = "…"/> … </schedules> <locks> <lock name= "…" …/> … </locks> <script com_class = "…" filename = "…" java_class = "…" language = "…" > <include file="…"/> <![CDATA[ program-code… ]]> </script> <http_server > <http.authentication scheme="basic"> <http.users > <http.user name="…" password_md5="…"/> … </http.users> </http.authentication> <http_directory path="…" url_path="…"/> <web_service job_chain="…" url_path="…" …> <params > <param name="…" value="…"/> … </params> </web_service> … </http_server> <holidays > <holiday date="…"/> <include file="…"/> <weekdays date="…"/> </holidays> <jobs> <job force_idle_timeout = "yes|no" idle_timeout = "…" ignore_signals = "…" java_options = "…" min_tasks = "…" name = "…" order = "no" priority = "…" process_class = "…" spooler_id = "…" stop_on_error = "yes" tasks = "1" temporary = "no" timeout = "…" title = "…" visible = "yes" > <description > … </description> <lock.use lock="…" …/> <environment > <variable name="…" value="…"/> … </environment> <params > <param name="…" value="…"/> … </params> <script com_class = "…" filename = "…" java_class = "…" language = "…" > <include file="…"/> <![CDATA[ program-code… ]]> </script> <monitor name = "…" ordering = "…"> <script language="…" …> …<script/> </monitor> <start_when_directory_changed directory="…" regex="…" /> <delay_after_error delay="…" error_count="…" /> <delay_order_after_setback delay="…" is_maximum="yes|no" setback_count="…" /> <run_time let_run="no"> <period begin = "00:00" end = "24:00" let_run = "…" repeat = "…" single_start = "…" when_holiday = "…" /> <date date="yyyy-mm-dd"/> … <weekdays > <day day="…"> <period …/> … </day> … </weekdays> <monthdays > <day day="…"> <period …/> … </day> <weekday weekday="…" which="…"> <period …/> … </weekday> … </monthdays> <ultimos > <day day="…"> <period …/> … </day> … </ultimos> <month month="…"> <period begin = "00:00" end = "24:00" let_run = "…" repeat = "…" single_start = "…" /> <weekdays > <day day="…"> <period …/> … </day> … </weekdays> <monthdays > <day day="…"> <period …/> … </day> <weekday weekday="…" which="…"> <period …/> … </weekday> … </monthdays> <ultimos > <day day="…"> <period …/> … </day> … </ultimos> … </month> <holidays > <holiday date="yyyy-mm-dd"/> <include file="…"/> … </holidays> <at at="yyyy-mm-dd HH:MM:SS"/> </run_time> <commands on_exit_code="…" <start_job job="…" …> <params> <param name="…" value="…"/> <copy_params from="task"/> <copy_params from="order"/> … </params> </start_job> <add_order job_chain="…" …> <params> <param name="…" value="…"/> <copy_params from="task"/> <copy_params from="order"/> … </params> </add_order> … </commands> </job> … </jobs> <job_chains > <job_chain distributed = "no" name = "…" orders_recoverable= "yes" title = "…" visible = "yes" > <file_order_source delay_after_error = "…" directory = "…" max = "…" next_state = "…" regex = "…" repeat = "…" /> … <job_chain_node delay = "…" error_state = "…" job = "…" next_state = "…" on_error = "suspend|resume" state = "…" > <on_return_codes > <on_return_code return_code = "…" > <add_order xmlns = "https://jobscheduler-plugins.sos-berlin.com/NodeOrderPlugin" job_chain = "…" id = "…" > <params> <param name="…" value="…"/> … </params> </add_order> … <to_state state="…" /> </on_return_code> … </on_return_codes> </job_chain_node> … <file_order_sink move_to = "…" remove = "yes" state = "…" /> … </job_chain> <job_chain name="…"> <job_chain_node.job_chain job_chain = "…" error_state = "…" next_state = "…" state = "…" /> … <job_chain_node.end state = "…" /> … </job_chain> … </job_chains> <commands > … </commands> </config> </spooler>