Linking Jobs to Custom Documentation Sources

This page is WORK IN PROGRESS ...

Inserting Documentation Links in Job Titles

Links can be built into job titles.
These are mainly intended to be used to provide a convenient link to job documentation.
The links can be added in JOE (JobScheduler Object Editor) as shown in the screenshot below, which shows a simple HTTP link:

In JOC (JobScheduler Operations Center) this link will then look like:

The following conditions have to be met before a title containing an URL will be shown in JOC:

• The URL has to start with "http://", "https://" or "www.".
• The URL has to end with a space or the title itself has to end with the URL.
• Punctuation marks are allowed after an URL.
• More than one link is possible.

Links can also be placed in "a" tags as shown in the following examples:

Example 1

Open JOE and type the following text in the title field of a job. (See also the screenshot to the right):

 See &lt;a href="<nowiki>http://sourceforge.net/apps/mediawiki/jobscheduler/index.php</nowiki>"&gt;here&lt;/a&gt; for more information and also www.sos-berlin.com.

JOC will now show the following title for the job:
"See here for more information and also www.sos-berlin.com."

Example 2 - Links to documentation within the scheduler_data directory

JOC knows a virtual directory ./scheduler_data which points to the working directory of the JobScheduler.
This is the directory which contains the config, jobs, logs, etc. directories.
So, when a link in the job title is defined with ./jobs/CCTS/test1.html, JOC will look for the file at the address ./scheduler_data/jobs/CCTS/test1.html. In a standard JobScheduler installation on Windows systems this would be C://

Example:

 <?xml version="1.0" encoding="ISO-8859-1"?>
    <job title="test &lt;a href=&quot;./scheduler_data/jobs/CCTS/test1.html&quot;&gt;docu&lt;/a&gt;" stop_on_error="yes" order="no">
    <script language="shell"><![CDATA[
         env # "Print the environment"
    ]]></script>
 </job>