User Guide

From Obsidian Scheduler
Jump to: navigation, search

This is your guide to using Obsidian scheduler, including the administration web application.

Follow the specific feature guide links below to find the information you need.

  • Getting Started - Get Obsidian up and running for evaluation, development or production.
  • Deployment Diagram - A visual representation of how Obsidian is deployed.
  • Implementing Jobs - How to write your own jobs.
  • Scripting Jobs - Some bundled scripting jobs which let you execute new jobs without builds.
  • Admin Web Application Guide - A comprehensive guide for our management web application.
  • Job Features - An outline of some job features that apply to recovery, execution, etc.
  • Built-in Jobs - A guide to the free jobs that we bundle with Obsidian for your convenience.
  • Chaining - How Obsidian chains execution of different jobs based on execution status and saved job results.
  • Conflicts - A description of how Obsidian allows you to prevent certain jobs from running concurrently.
  • Clustering - A guide to how clustering works in Obsidian.
  • Recovery & Failover - An outline of Obsidian's recovery and failover mechanisms for job execution.
  • Job Forking - An overview of Obsidian's support to run jobs in their own JVM instance. This feature supports hot swapping of JARs.
  • Licenses & Nodes - Full details on how license verification is handled in Obsidian.
  • Event Notifications - An outline of the mechanisms Obsidian provides to be notified of various events, such as job failures.
  • Email Templates - How to customize Obsidian's notifications using your own templates.
  • REST API - Complete documentation on our REST API.
  • Embedded API - Complete documentation on our Embedded API, which is exposed through Java.
  • Initializing and Restoring - Documentation on Obsidian's support for initializing, backing up or restoring a scheduler environment.