• Contents
  • Index
  • Glossary
USER MANUAL
 

Background Job Detail

Note that only system administrators are authorized to edit in the Background Job Detail screen.

 

Job Id – is the ID for this particular background job.

In Database – this checkbox indicates if the background job’s parameters are saved in the database. If not, all edited values in attributes like Last Started, Started by, Run Enabled and Time Window Settings will be lost at each server restart. In version 2.1.0 of PipeChain Supply only Single Run background jobs and background jobs managed by Server Proxies are not “In Database”. The latter ones will never show up in the PipeChain clients.

Business - The Business this jobs belong to (if any).

Site - The Site this jobs belong to (if any).

Description – more detailed information about the background job.

Parameters – some complex background jobs compute and save additional information about where to continue at Next Start Time, see item 9 below.

 

 - Status –

A repetitive job normally alternates between Idle and Running. The other statuses only apply if the job is manually started or stopped. It is never finished. A single-run job is normally Running or Finished. Also single-run jobs may be stopped manually.

  • Finished

  • Stopped

  • Stopping

  • Running

  • Starting

  • Idle

 

 - History –

Information about background job history:

  • Last Started – shows the last date and time this job was started (by the system or manually).

  • by – displays the name and User ID if the job was manually started.

 

 - Scheduling–

Enabled – indicates if a repetitive job can be started by the system.

Run Mode – a background job runs in one of the following modes:

  • System Night Job which is run once a day (or night) in a system predefined order.

  • System Scheduled by Time Window Settings may run multiple times during a day, as stated in “Time Window Settings” below.

  • System Scheduled by Other Parameters, may run multiple times a day (see just above) but it uses other “Time Window Settings”, e.g. get the parameters from e.g. an agreement. 

  • User Single Run or System Single Run – depending on whether they are started by a user or by another background job. They are run once, and then automatically removed. Therefore they are seldom visible in the screen. Single run jobs are displayed in the Background Job screens, but not saved in the database.

Time Window Settings

  • First Start Time – you can edit both System Scheduled by Time Window Settings and System Night Job. Note that editing a System Night Job will apply to all such jobs because their order is fixed.

  • Last Start Time – you can only edit background jobs with the run mode: System Scheduled by Time Window Settings.

A special case:

00:00 to 00:00 – means that the First Start Time is 00:00 and the Last Start Time is 00:00, i.e. all day (24 hours/day).

  • Repetition Interval – enter how often you want to repeat can only edit background jobs with the run mode: System Scheduled by Time Window Settings.

 

Next Start Time – shows the date and time when the system will start the job (unless it is disabled).

 

 - Parameters–

Job parameters are displayed with Name, Description and Value.

Buttons

Enable – allows the system to start the job when it is due. Applies only to repetitive jobs. Does not start the job directly.

Disable – does not allow system to start the job when it is due. Applies only to repetitive jobs.

Start – starts a repetitive job instantly, whether it is enabled or not. Applies only to repetitive jobs. Usually, some System Scheduled by Other Parameters jobs will not execute anything when started outside their normal execution time.

Soft Stop – sets a flag that will cause the job to stop itself.

Hard Stop – claims to stop the job brutally, but the effect is for the time being equal to the Soft Stop (see above).

Delete – it can be necessary to manually remove a stopped single-run job (however, this is rarely the case).