Script Execution Job Extension

Transcription

1 Script Execution Job Extension Appway AG Lessingstrasse 5, CH-8002 Zürich, Switzerland

2 Table of Contents 1 Introduction 3 2 Scheduled Jobs Cron Expressions 5 3 Startup and Shutdown Jobs Configuration Script Files 6

3 1 Introduction The "Script Execution Job" extension may be used to register scripts for execution in the background. Examples: check for new s in a POP3 mailbox every 5 minutes download and import a CSV file from a remote server once every night load frequently used data into the Application Cache on system startup delete temporary directory on system shutdown There are two different types of jobs: jobs executed at given times defined by a schedule like "every minute", "every day at 02:00", "every friday at 11 pm" etc. jobs executed at system startup or shutdown (supported since extension version 1.3) Jobs of the first type have to be defined in the extension configuration. Jobs of the second type may as well be defined in the extension configuration. But in addition, they may also be created by putting files into the directories "<DataHome>/conf/jobs/startup" and "<DataHome>/conf/jobs/shutdown" Appway AG Page 3 of 6

4 2 Scheduled Jobs A job is defined by adding a couple of configuration settings to the extension configuration: scriptjob.id.title (mandatory) scriptjob.id.description (optional) scriptjob.id.function (mandatory) Name of this job (displayed in Job Scheduler administration) Description of this job (displayed in Job Scheduler administration) Script code to execute if the job is triggered scriptjob.id.schedule fig 2: Job Scheduler overview (mandatory) Cron expression used to define a schedule for this job (see examples below) 2.1 Cron Expressions scriptjob.id.paused If set to "true", this job isn't executed (optional, default "false") A cron expression is a sequence of 6 or 7 elements (numbers or words) which together define a schedule. Every element scriptjob.id.userid stands for a time unit: second, minute, hour, day of month, User month, id of day the of user week to and be set year as (optional). "current user" during job (optional) execution scriptjob.id.versionfilter * *? Version Every day filter at to 01:00:00 fig 1: Example extension configuration be set as "current version filter" during job (optional, default "TimestampFilter") execution 0 0/5 * * *? Every 5 minutes, starting at 00:00:00 After the extension has been started, the jobs will be listed in the Job Scheduler section. scriptjob.id.onenodeonly If not defined or set to "false", this job is executed on all (optional, /6 default * *? "false") nodes Every of 6 an hours, Appway starting cluster at 01:15:00 in parallel *? If Every set to "true", 1st of every the job month is executed at 23:00:00 only on one node ,12? * MON-FRI This Monday setting to has Friday no impact at 07:00:00 on a and single 12:00:00 node installation. Table Table 1: Configuration 2: Cron expression settings examples ID The stands extension for an arbitrary uses Quartz alphanumeric as job scheduler. identifier. Quartz is delivered together with Appway. For more information on Cron expressions, check the following resources provided on the Quartz website: CronTrigger tutorial ( and CronTrigger example ( If you use an extension version older than 1.7, ID must be an integer value. The first job must use number 1, the second number 2 and so on. Do not skip a number! The extension starts with index 1 and stops registering jobs as soon as "scriptjob.id.title" isn't defined or contains an empty text for a given index.

5 Appway AG Page 5 of 6

6 .nel Files with this extension are expected to contain Appway script code..bsh Files with this extension are expected to contain Java code which may be executed with the Bean Shell interpreter. 3 Startup and Shutdown Jobs Startup fig 4: Startup and shutdown files jobs are executed when Appway fires the ApplicationStartedEvent or ApplicationShutdownEvent. They can be defined in two different ways: No other file extensions are supported. Files in subdirectories of "startup" or "shutdown" are ignored. 3.1 Configuration If there are multiple files in a directory, they are executed in alphabetical order (case-sensitive). Startup and shutdown jobs can be defined the same way as scheduled jobs. Instead of a cron expression, the words "startup" and "shutdown" are used to define the time at which the job has to be executed. Appway AG Page 6 of 6