JobScheduler start script offers option for bulk removal of ad hoc orders

Current Situation

• Users make frequently use of programmatically generated orders, i.e. ad hoc orders. Such orders are not permanent but are executed just once and can be created by job scripts or monitor scripts that make use of the JobScheduler API.
• Should the script implementation that creates orders misbehave then e.g. some 1000+ orders can be unintentionally created and might affect the JobScheduler performance, particularly for the JOC GUI.
• Currently there are two ways how to get rid of such orders:
  • Shut down JobScheduler and remove such orders selectively from the SCHEDULER_ORDERS table in the database, then restart JobScheduler.
  • Send subsequently XML commands such as <remove_order job_chain="..." order="..."/> by use of the JobScheduler start script.

Desired Behavior

• The JobScheduler command line interface should leverage the situation when a larger number of orders have to be removed.
  • The job chain path has to be specified.
  • The order identification
    • can be omitted to remove all ad hoc orders from a job chain.
    • can be specified by a range for the first and last order.
• No permanent orders are removed by this functionality that is exclusively applied to ad hoc orders.

Delimitation

• Bulk removal for file orders is excluded from this functionality.
• For removal of file orders it is sufficient to (re)move the files from the monitored directory.

Implementation

• The PowerShell Command Line Interface is provided with JS-1630 that includes support for bulk operations.
• Remove all ad hoc orders from a job chain:

  • Get-Order -JobChain "/my_folder/my_job_chain" -NoPermanent | Remove-Order
    

  • This will remove all ad hoc orders from the given job chain.

Hints

• Bulk removal applies to ad hoc orders, not to permanent orders.
• It does not apply to file orders that can more easily be removed by (re)moving the respective files from the directory that is watched for incoming files.