The Job Scheduler reads its configuration from XML files, which can be created and edited using a text editor.
Alternatively, the XML configuration can be maintained using the Job Scheduler Editor. This editor provides a graphical user interface with forms for all elements of the Job Scheduler configuration. Further user support in the form of tool-tips and wizards is provided.
The Editor creates or modifies the XML elements in the Job Scheduler configuration, in accordance with the entries made in its forms. When the changes made are saved, the Job Scheduler configuration file - which is usually called scheduler.xml, is rewritten. The Editor validates all entries made with the current Job Scheduler XML schema - errors in entries will be detected immediately.
The Editor can also be used to document jobs for the Job Scheduler - it generates the documentation in an XML format, which can be shown with navigations elements in a web browser in HTML format, using an appropriate style sheet.
The Job Scheduler Editor belongs to the standard Job Scheduler installation. The Job Scheduler installation directory contains the bin/jobeditor.cmd file, which is used to start the Editor. Here, the INSTALL_PATH parameter should be set to the Job Scheduler installation directory path.
In order to create a new configuration,
the File/New/Configuration menu item should be selected:
The Editor then opens its main window containing a tree view showing a series of elements
such as Config, Jobs, Job Chains etc.
Tool-tips are available for all form fields and control elements of the Editor. In addition, the F1 button can be used to start the Job Scheduler XML documentation, which is contextual and will open at the relevant XML element that is currently being worked on.
For example:
When the job configuration form is opened:
F1 causes the documentation to open at the <job> XML element:
Existing Job Scheduler configuration files are opened using the File/Open menu items:
Example - the scheduler.xml file from the Job Scheduler installation, showing the base file configuration:
Enter the jobs the Job Scheduler should execute, together with the relevant job parameters in the Jobs form.
For each job entered, the Editor creates a new branch in the job tree view.
Each job has additional forms,
in which further properties such as executable program code and start times are entered.
A wizard is available for creating a job by copying a standard job.
Note: when jobs are defined in XML files which themselves are included using <base>
then the included XML file will be opened in the Editor together with the job definition.
When Jobs are to be executed within a job chain,
then the job chain should be entered using the Job Chains form.
Each node in a job chain must be specified individually and
a job allocated to each node.
Note: when job chains are to be defined in XML files, which are included using <base>,
then the XML file with the job chain definitions is to be opened.
Note that when order controlled jobs are to be used in job chains, then the way in which the orders are created must be specified:
Orders can be created using directory monitoring - this is done by specifying file orders in the Job Chains form.
Orders can also be directly created using the <add_order> command - this type of order is defined in the Orders form. Using the information entered in this form, the Editor generates an <add_order> element, which can be shown using the Commands form.
The Job Wizard is used to create a new job on the basis of an already documented Standard Job.
Existing job are available from a selection of documented standard jobs that are delivered with the Job Scheduler. These jobs can be found in the /jobs directory in the standard Job Scheduler installation directory.
The Job Wizard reads out this /jobs directory and makes all the jobs found there available for import. An imported job has all the features of the original, in particular the language. Job parameters are also be taken over but can be modified in the Editor. Further settings such as the number of tasks, the start times, time-out settings, can then be changed one after another. Each step in the Wizard is supported by explanatory text
To start the Job Wizard, Job Wizard is simply selected in the Jobs form as shown:
The following steps are followed in the wizard in creating a new job:
The Editor can be used to create a documentation for Job Scheduler jobs in a predefined format.
The documentation is generally written by the job developer and serves users/deployers configuring jobs for particular job implementations.
The Editor allows the XML job documentation file to be created using forms, without knowledge of the XML format. The scheduler_job_documentation.xsl XML style sheet allows users to view the documentation in HTML format using a standard web browser.
A documented job is saved in the Job Scheduler /jobs directory, and it can thereby be used by the Job Wizard as a prototype for further jobs.
Select the File/New/Documentation item:
A contextual help is available for each form of the Editor and can be opened using F1:
The Job Scheduler can open and save XML configuration files per FTP (File Transfer Protocol) and SFTP (Secure FTP). The FTP dialog can either be opened by way of the File -> FTP menu entries or by clicking on the FTP toolbar icon:
This opens the dialog in which the profile (i.e. FTP connection) to be opened is selected, followed by the file to be opened.
FTP connections that have already been configured can be selected from the drop-down list.
This text box is used to show the pre-selected directory on the FTP server. This directory will be opened in the dialog as soon as the connection with the FTP server is made. When navigating on the server, this text box is used to show the current directory open. It can also be used for direct navigation. After entering the desired address in this box and clicking on the "Change Directory" button, the FTP server will directly go to the desired folder.
Actualises all directory and file information from the FTP server.
Creates a new folder on the FTP server.
Deletes the file or folder selected from the FTP server.
If the FTP dialog has been opened using the "Open by FTP" menu entry, then the "Open" button will cause the XML configuration file selected to be downloaded from the FTP server and opened in the Job Scheduler Editor.
If the FTP dialog has been opened using the "Open Hot Folder by FTP" menu entry, then only directories will be shown in the dialog. Selection of a hot folder will then cause all the XML configuration files within that folder to be downloaded from the FTP server and opened in the Scheduler Editor.
Closes the FTP dialog.
Shows the protocol dialog. This contains all commands sent to the FTP server and its replies.
Shows all configured FTP connections. Allows new connections to be added or existing ones to be edited or deleted.
All FTP connections or profiles are saved in a configuration file
that can be found under the address scheduler_install_directory/config/factory.ini.
This file has the following section and entries for each profile:
[profile profilename]
host=
port=
user=
root=
localdirectory=
transfermode=
save_password=
protocol=SFTP
use_proxy=
proxy_server=
proxy_port=
auth_method=
auth_file=
The Job Scheduler can open and save XML configuration files per WebDAV. The WebDAV dialog can be opened using the File -> WebDAV menu entries
The WebDAV menu entry is only active,
when the libraries necessary to make WebDAV connections are available.
These libraries are not part of the Job Scheduler distribution because of licensing reasons but
can be downloaded from the Sourceforge webdavclient4j project under
https://sourceforge.net/projects/webdavclient4j/.
The following libraries should be available in the
scheduler_installation_directory/lib directory,
although variation in the library name and number may occur.
The Job Scheduler Editor is activated by a command file,
which is found under scheduler_installation_directory/bin.
The CLASSPATH in this file must be extended to include the above mentioned libraries.
The Editor command file opens a dialog in which the profile (i.e. WebDAV connection) to be opened is selected, followed by the file to be opened.
WebDAV connections that have already been configured can be selected from the drop-down list
This text box is used to show the pre-selected URL on the WebDAV server. This directory will be opened in the dialog as soon as the connection with the WebDAV server is made. When navigating on the server, this text box is used to show the current URL open. It can also be used for direct navigation. After entering the desired address in this box and clicking on the "Change Directory" button, the WebDAV server will directly go to the desired URL.
Actualises all directory and file information from the WebDAV server
Creates a new folder on the WebDAV server.
Deletes the file or folder selected from the WebDAV server.
If the WebDAV dialog has been opened using the "Open by WebDAV" menu entry, then the "Open" button will cause the XML configuration file selected to be downloaded from the WebDAV server and opened in the Job Scheduler Editor.
If the WebDAV dialog has been opened using the "Open Hot Folder by WebDAV" menu entry, then only directories will be shown in the dialog. Selection of a hot folder will then cause all the XML configuration files within the folder to be downloaded from the WebDAV server and opened in the Scheduler Editor.
Closes the WebDAV dialog
Shows the protocol dialog. This contains all commands sent to the WebDAV server and its replies.
Shows all configured WebDAV connections. Allows new connections to be added or existing ones to be edited or deleted.
All WebDAV connections or profiles are saved in a configuration file
that can be found under the address scheduler_install_directory/config/factory.ini.
This file has the following section and entries for each profile:
[webdav_profile profilename]
url =
user =
password =
localdirectory=
save_password=
use_proxy=
proxy_server=
proxy_port=
debug=