Documentation

Documentation - available Formats

Documentation is available in the following formats:

• XML, uses XSLT for display with IE starting with 5.5 and Mozilla Firefox
• PDF, preferably used for printer friendly layout

Getting Started

We recommend you start by reading the following introduction:

• JobScheduler Architecture Guide  

in which the architecture of the JobScheduler and its mode of operation are explained.

Installation and Configuration

• Installation and Configuration (PDF)
  We recommend you read this before you start to install and configure.
• Quickstart for Job Configuration (PDF)
  Example jobs and orders to get you up and running.
• Reference Documentation (XML) (PDF)
  The reference documentation explains job configuration and interfaces in detail.
• JobScheduler Amazon AMI Installation Guide (PDF)
  This documentation describes the installation on an Amazon AMI Linux 64Bit image.
• Installation by Cloning (PDF)
  This documentation describes the deployment of multiple JobSchedulers on distributed servers by copying a template JobScheduler.

JID (JobScheduler Information Dashboard) Documentation

Provides an overview of jobs planned and those that have successfully been completed.

• JobScheduler Information Dashboard (PDF)
  Describes the installation, configuration & use of JID together with the SOS Security Server.
• SOS Security Server (PDF)
  Introduced with JobScheduler version 1.7, brings authentication and authorization to the JID interface.

Job Documentation with the JobScheduler Editor

We provide the following tutorial for developers who write documentation for their jobs:

• JobScheduler Job Documentation Editor (PDF)

Implementation of Jobs Using the JobScheduler API

These documents are intended for job developers, you do not need to read this document in order to be able to configure automated job starts for executable programs and scripts.

• API Documentation (XML) (PDF)
  Explains the objects and methods of the API for job development.

  For quick navigation use the following shortcuts:

  • Java API Documentation
  • JavaScript API Documentation (Rhino with Beans)
  • JavaScript API Documentation (Rhino)
  • JavaScript API Documentation (Spidermonkey)
  • PowerShell API Documentation
  • VBScript API Documentation
  • Perl API Documentation
  • Javadoc Documentation
• Internal API Job Implementation Tutorial (PDF)
  An introduction to the development of jobs using the JobScheduler internal API.

Advanced Topics

More complex job scheduling scenarios are explained in the following documents:

• Using and Migrating Cron with JobScheduler (HTML) (PDF)
  Explains how to use and migrate crontabs with JobScheduler.
• Tutorial Web Service Implementation (HTML) (PDF)
  Explains the configuration and implementation of Web Services for your jobs.
• Conditional Job Processing with Events (PDF)
• Explains how events can be used for conditional job execution.

Further Resources