Skip to end of metadata
Go to start of metadata

Introduction

There are a number of sources of documentation for JobScheduler, YADE and the JITL jobs delivered with JobScheduler, both online and offline.

Accessing documentation online

Documentation Sources

The most important starting points are:

Accessing Documentation Links in Job Titles

HTTP addresses can be added to job titles in JOE as shown in the screenshot below:

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

A number of different types of links can be specified. More detailed information about setting links can be found in "How to link jobs to custom documentation sources" FAQ.

Job Documentation

The most convenient method to access job documentation is online, via our Library of Standard Jobs - JITL FAQ.

Accessing documentation offline

Via JOC "Help|Extras" Menu

  • The "Documentation (en)" and "Documentation (de)" items in this menu (see the adjacent screen-shot) open the JobScheduler Reference documents in English and German respectively. These are locally stored versions and updated with each new release / update. They can also be opened directly from the file system using the paths ".\doc\en" and ".\doc\en" where "." is the JobScheduler installation directory.
    On Windows systems this is typically:

    C:\Program Files\sos-berlin.com\jobscheduler\myScheduler\
    
  • The other menu items (FAQ, Forum, etc.) are linked to online documents.

Job Documentation

The JITL JobScheduler template jobs that are delivered with each JobScheduler download are documented with a description of each job and its parameters.
These job descriptions can be accessed as follows:

ToDo - ScreenShots

  • Using the JobScheduler object editor, JOE:
    • Use the "Wizard" button to start generating the job
    • then select the job type and "Next"
    • In the "Import Jobs" dialog window select the job required and then click the "Description" button, which will open the job documentation.
  • Directly from the file System:
    • The job descriptions can also be opened directly from the file system using the path ".\jobs" where "." is the JobScheduler "data" directory, in which the configuration and log files are installed.
      On Windows systems this is typically:

       C:\ProgramData\sos-berlin.com\jobscheduler\myScheduler\
      

      See the JobScheduler Master - Installation Guide for more information about the JobScheduler file structure, in particular regarding Linux systems.