Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Holidays can be configured at a global level for all jobs and per job. The resulting holiday dates of both configuration levels are applied. They Dates configured at both levels can be persistent - i.e. they are not lost on restart as they are part of the configuration file either saved in the scheduler.xml configuration file or the respective relevant run times that are can be configured in the editor web interface and stored in a database. Configuring holidays is supported by the graphical JobScheduler Object Editor, JOE. The configuration of holidays is described in detail in the articles:

The following examples illustrate how holidays can be configured at the XML level using any editor.

  • Holidays for all jobs
    Code Block
    languagexml
    titleHoliday configuration with the scheduler.xml configuration file
      <config>
          <holidays>
              <holiday date="2006-12-25"/>
              ...
              <holiday date="2006-12-26"/>
          </holidays>
          <jobs/>
          <job_chains/>
      </config>

...

  • Holidays for a specific job
    Code Block
    languagexml
    titleHoliday configuration with the run-time of a specific job

...

  •  <job>
        <run_time let_run="no">
            <period single_start = "08:00"/>
            <holidays>
                <holiday date="2006-06-19"/>
                ...
                <holiday date="2006-07-19"/>
            </holidays>
        </run_time>
      </job>
  • Holidays re-used by a number of jobs
    • A holiday configuration can be written to a specific XML file and includes just the <holidays> element and subsequent elements like this:
       

      Code Block
      languagexml
      titleHoliday configuration file
          <holidays>
              <holiday date="2006-06-19"/>
              ...
              <holiday date="2006-07-19"/>
        </holidays>
      
    • The above holiday configuration file is assumed to be available from the file /globals/company_holidays.xml and is referened like this from a job:
       

      Code Block
      languagexml
      titleRun-time configuration with reference to a global holidays file
       <job>
          <run_time let_run="no">
              <period single_start = "08:00"/>
              <holidays>
                  <include live_file="/globals/company_holidays.xml"/>
                  <include live_file="../customers/bank_holidays.xml"/>
              </holidays>
          </run_time>
        </job>
    • If the referenced holiday file is located in the live folder tree then it is referenced by use of the live_file attribute. 
      • Changes to a holiday file in the live folder tree are automatically detected and are applied by JobScheduler.
      • An absolute path to the holidays file is considered to start from the live folder.
      • A relative path can be used that start from the folder that contains the curent job.
    • If the referenced file is located outside of the live folder tree then the file attribute has to be used. Changes to a hoiday file outside of the live folder are not automatically detected and applied.