Working with Scheduler Jobs

Overview

The Scheduler in Encodify allows you to run background tasks automatically at defined intervals. Typical examples include synchronizing file systems, importing data, or triggering scheduled workflows. Once configured and started, jobs will run periodically based on their defined intervals until stopped.

The Scheduler functionality in Encodify allows you to:

• Configure scheduler jobs

• Start and stop scheduler jobs

• Monitor scheduler tasks

Accessing Scheduler Properties

Note: Only Encodify administrators should modify System.properties, as incorrect settings may affect critical system functionality.

Access to Scheduler Properties is controlled via the schedulerPropertiesEditors parameter in the System.properties file.

• Specify a comma-separated list of User IDs allowed to edit Scheduler properties.

• Use * to grant access to all users.

• Users not listed will not see the Scheduler Properties button.

How to enable Scheduler Jobs

Configuring Scheduler Jobs

Scheduler jobs must be configured before they can be run. Each job can have one or more tasks with specific parameters.

Steps to configure jobs include:

1. Navigate to System Configuration → Sites → System Status → Scheduler.

2. Click Scheduler Properties to view or edit jobs.

3. Add a job definition in free text format.

4. Click Save Changes to apply your changes.

Key parameters

A typical scheduler job configuration includes:

Note: Only one joblist parameter can be defined in the properties file, but it can include multiple jobs as a comma-separated list. All other joblists must be commented out.

Example Job

Example of the job configuration. This configuration runs the fieldImport job every 10 seconds using the specified user.

joblist=fieldImport
job.fieldImport.param.UserID=11536
job.fieldImport.type=dk.encode.ebms.scheduler.FieldImportJob
job.fieldImport.interval=10

Starting and Stopping the Scheduler

To start and stop the scheduler, follow the steps below:

1. Go to System Configuration → Sites → System Status → Scheduler.

2. If no jobs are running, the status will show Currently stopped.

3. Click Start Scheduler to begin execution.

   • Status will update to Currently running.

   • The Running Scheduler Jobs section lists active tasks with their current status (Running or Stopped).

4. To stop execution, click Stop Scheduler.

   • The Scheduler will finish all active tasks before shutting down.

Monitor Scheduler Jobs

Active scheduler jobs can be monitored via the Running Scheduler Jobs section in the UI. Each job displays its current status: Running indicates the job is actively executing, while Stopped means the job has completed. Use the Refresh button to update job statuses while the Scheduler is running.

Notes and Best Practice

• Always test new job configurations in a controlled environment before production.

• Use a dedicated service account with administrator rights to avoid permission issues.

• Only one joblist can be active at a time; all others must remain inactive.

• Changes to System.properties should only be performed by an administrator.