Stop a flow at a specific point by putting a job on hold

About this task

In some cases, you may want to stop a flow at a specific point so that you can fix problems. You can do this by putting a job in the flow on hold.

When you put a job in the flow on hold:

  • The job receives the status On Hold. The status of the flow is not affected.

  • The flow pauses at that specific job.

    Only the branch of the flow that contains the job that is On Hold pauses. Other branches of the flow continue to run.

Only jobs in the Waiting state can be put on hold. When desired, you can then release the job that you have put on hold. The flow instance continues to run and the job receives the status Waiting.

You can put on hold LSF® jobs, job submission scripts, local jobs, job arrays, and job array scripts.

If the selected job is in a flow array, by default the hold applies to the job in the element the job is in. You can, alternatively, apply the hold to jobs in all elements in the flow array.

Only users who own the flow, the Process Manager administrator, or Process Manager control administrator can hold and release LSF jobs, job submission scripts, local jobs, job arrays, and job array scripts.

Procedure

  1. Select the By Definition tab, and double-click a flow to display it.
  2. Select the desired job in the Waiting state in the flow, right-click and choose Hold.

From the command line

Procedure

  1. On the command line, specify the following for a job in the Waiting state: 
    jjob -i flow_id -p flow_name[:subflow_name]:job_name

    where flow_ID is the unique flow ID containing the job you want to put on hold, flow_name is the name of your flow, subflow_name is the name of your subflow (if you have one), and job_name is the name of your job.

  2. Press Enter.

    The job will be put on hold.

    Note:

    To release the job at a later time, use the -g option on the command line.