Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: WIP-Notice removed

Table of Contents
outlinh1. true
outlinh1. true
1printablefalse
2stylh1. none
3indent20px

This page is WORK IN PROGRESS ...

Inserting Documentation Links in Job Titles

This feature is available since JobScheduler release <span style="color:forestgreen">1.3.12.1296</span>

Adding documentation links to job titles

Links can be added to job titles.
These are mainly intended to be used to provide a convenient link to job documentation.

Such links can be added in (JOE - JobScheduler Object Editor) HTTP addresses can be added to job titles in JOE as shown in the screenshot below, which shows a simple HTTP link:

Image Removed

These addresses will then be repeated in JOC as active HTTP links as shown in the next screenshot:

Image Removed

Under the following conditions JOC (JobScheduler Operations Center) finds an URL in the title:

Image Added

 

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

Image Added

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

  • The URL has to The URL must start with "http://", "https://" or "www.".
  • The URL must ends has to end with a space or the title ends itself has to end with the URL.
  • Punctuations at the ends 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 (JobScheduler Object Editor) and type the following text in the title field of a job:

Code Block

 - see &lt;athe <a href="<nowiki>httphttps://sourceforge.net/apps/mediawiki/jobscheduler/index.php</nowiki>"&gt;here&lt;/a&gt; for more information and also www.sos-berlin.com.
kb.sos-berlin.com/display/PKB/Locks">Locks</a> article

 

JOC will now show the following title for the job:Image Added

Example 2: Links to documentation within the SCHEDULER_DATA directory

JOC knows a virtual directory ./scheduler_data/jobs, which points to the jobs folder in the JobScheduler's working directory. JOC will automatically link to files in this folder.

  1. Custom Documentation Files
    JOC will link to custom documentation files in a sub-directory the jobs folder.
    The following example shows the XML code to link to a test1.html file in a my_job_descriptions subfolder.

    Code Block
    languagexml
    <?xml version="1.0" encoding="ISO-8859-1"?>
       <job title="test <a href="./scheduler_data/jobs/my_job_descriptions/test1.html">docu</a>" stop_on_error="yes" order="no">
       <script language="shell"><![CDATA[
            env # "Print the environment"
       ]]></script>
    </job>
    
  2. JITL Job Documentation Files
    Copies of the documentation of all JITL jobs are provided in the ./scheduler_data/jobs, and the following code will link to the documentation of the JobSchedulerCheckRunHistory job:

    Code Block
    languagexml
    <?xml version="1.0" encoding="ISO-8859-1"?>
       <job title="test <a href="./scheduler_data/jobs/JobSchedulerCheckRunHistory.xml">JobSchedulerCheckRunHistory</a>" stop_on_error="yes" order="no">
       <script language="shell"><![CDATA[
            ...
       ]]></script>
    </job>
    

 Image Removed
The OperationsGui shows the following title:
see here for more information and also www.sos-berlin.com.