Synopsis
Aborts a job if it is in a running state.
Description
Aborts the specified job if it is in a running state, which changes it to a failed state, fails all running tasks, and holds all waiting tasks.
Input

Input

Description

Abort Job Name

The name of the job to be aborted. The specified name must exactly match the job name as displayed by the WhereScape RED Scheduler. The specified job must be in a running or failed state in order to be aborted.

Job Instance Identifier

Unique identifier of the running job (that may be in a failed state).

Abort Job Message Text

Custom message text to be recorded in the WhereScape RED Audit Log for the aborted job and the WhereScape RED Task Log for each aborted task.

Output

Output

Description

Result Number

[ORACLE only]

Output Result Number [ORACLE only]:

  • 1      Success.
  • -2     Error. e.g. Due to invalid job name or job not running.
  • -3     Fatal/Unexpected Error.


SQL Server

SQL Server Parameters: Ws_Job_Abort
Callable Routine Type: PROCEDURE.

Parameter Name

Datatype

Mode

@p_job_name

VARCHAR(64)

IN

@p_job_sequence

INTEGER

IN

@p_job_msg

VARCHAR(256)

IN

SQL Server Examples: Ws_Job_Abort

EXEC Ws_Job_Abort
  'Daily Run'
, 1234
, 'Job aborted via manual execution of Ws_Job_Abort.'

Teradata

Teradata Parameters: Ws_Job_Abort
Callable Routine Type: PROCEDURE.

Parameter Name

Datatype

Mode

p_job_name

VARCHAR(64)

IN

p_job_sequence

INTEGER

IN

p_job_msg

VARCHAR(256)

IN

Teradata Examples: Ws_Job_Abort

CALL [METABASE].Ws_Job_Abort
( 'Daily Run'
, 1234
, 'Job aborted via manual execution of Ws_Job_Abort.'
);

Oracle

Oracle Parameters: Ws_Job_Abort
Callable Routine Type: FUNCTION.

Parameter Name

Datatype

Mode

v_job_name

VARCHAR2

IN

v_job_sequence

NUMBER

IN

v_job_msg

VARCHAR2

IN

FUNCTION Return Value

NUMBER

OUT-Function

Oracle Examples: Ws_Job_Abort

v_result_num                    number;
v_result_num := Ws_Job_Abort
( 'Daily Run'
, 1234
, 'Job aborted via manual execution of Ws_Job_Abort.'
);

DB2

DB2 Parameters: Ws_Job_Abort
Callable Routine Type: PROCEDURE.

Parameter Name

Datatype

Mode

p_job_name

VARCHAR(64)

IN

p_job_sequence

INTEGER

IN

p_job_msg

VARCHAR(256)

IN

DB2 Examples: Ws_Job_Abort

CALL [METABASE].Ws_Job_Abort
( 'Daily Run'
, 1234
, 'Job aborted via manual execution of Ws_Job_Abort.'
);


  • No labels