Navigation:  Appendices > Appendix J: Job Status/Actions/API > Job Action Codes for DLL calls

This section includes additional notes on job action code and validation requirements. In almost all cases the parm1 parameter should contain the pathname of the job instance.

The return code from the Job Action function is negative on error and normally 0 on success.  However actions 8, 16 and 18 return the number of failed items which have been resubmitted.

ACTION 1 - Report

Performs defined reporting tasks. This action may be requested at any time and will cause a standard report to be produced and faxed or emailed to the specified destination. This action does not run the defined EOJ tasks.

ACTION 2 - Cancel Delayed Launch

The job must be in state 22, waiting for delayed launch. If not, and if the job is currently active, it is suspended (see action code 15).

ACTION 3 - Launch

This action is equivalent to the Launch function. The job status must be less than 30 (active) and not equal to 25 (launch in progress).

ACTION 4 - Launch Proof

This action is equivalent to the Launch function with parm2 set to 'PROOF'. A proof may be launched at any time.

ACTION 5 - Resume

Resume a suspended job. The job status must be 32, 42 or 52.

ACTION 6 - Extract Job Data into TAB-delimited field file

This action runs JOBXDATA on the job. The status must be 80 or higher (completed), or 32 (suspended).

ACTION 7 - Archive the Job

This action runs JOBZIP on the job. The status must be 80 or higher (completed).  See also Action 107.

ACTION 8 - Resubmit failed faxes

Any FS files belonging to the job that are in FAIL are resubmitted, and the job status is reset to active. If the job status was previously 80 or higher (completed) then EOJ tasks are set to repeat when the job next completes. Resubmitting failed items will result in multiple entries for the job item in the standard job report (see also action 16).  If parm2 contains the string 'outcome' followed by a comma-separated list of outcome class letters (preceded by 'E' for e-mail outcome classes) and outcome codes, only failures with those outcomes will be resubmitted.

ACTION 9 - Extract Job Data into DBF file

This action runs JOBDDATA on the job. The status must be 80 or higher, or 32 (suspended).

ACTION 15 - Suspend job

If the job status is active, it is suspended.

ACTION 16 - Resubmit failed items

Any FS files belonging to the job that are in FAIL are resubmitted, and the job status is reset to active. If the job status was previously 80 or higher (completed) then EOJ tasks are set to repeat when the job next completes. The standard job list is cleared so that the list produced at the next job completion point will only show the resubmitted items (see also action 8).

ACTION 17 - Get SMS Delivery Outcomes

Any FS files belonging to the job that are in SENT and relate to SMS operations, and for which the value of the variable SMS_DELIVERY_OUTCOME is other than SUCCESS are resubmitted with this variable set to the value 'PENDING'. This causes a status request to be sent to the SMS provider.

ACTION 18 - Resubmit individual failed item

An individual failed item (for which the FS file pathname is in parm2) is resubmitted for the job.  This action is intended only for use from JOBADMIN.  It does not affect the job status, so may not have expected results if called from elsewhere.

ACTION 19 - Reset EOJ Tasks

This action resets the EOJ tasks.  It is intended only for use from JOBADMIN.

ACTION 21 - Launch after delay

This action is similar to action 2 (launch) but checks that the job status is 22 (waiting for delayed launch) and fails if it is not.

ACTION 101 - Delete Job

This action deletes all files associated with the job. If you call this function while the job is active, unpredictable results will occur: job items in progress may complete, fail, or remain undeleted. From JOBADMIN this action can only be selected for active jobs by using 'shift-control-rightclick' on the job instance button.

ACTION 102 - Delete Unsent Job items

This action deletes all the FS files for a job that are still unprocessed. Items being sent will not be interrupted. No indication of the deleted items will appear in the standard job report, and no data will be available for them in the extracted files from JOBDDATA and JOBXDATA, although an empty record will be included.

ACTION 103 - Launch Unconditional

Do not call the function with this action code. There is very seldom a situation when it is right to do so and you will usually make matters worse by taking this action.

ACTION 104 - Cancel / Fail Unsent Items

If the job has had no launch action (conversion, proof or launch) then it is deleted (as for action 101).  If the job is active, the status is set to 27, which causes all remaining FS files to be failed with outcome code 134 as soon as they are picked up.  If the launching process has started, the status will be set to 33 when it is complete, unless items are enqueued in an FS queue, in which case the status will be set to 36.

ACTION 106 - Archive without deletion

This action will unconditionally run JOBZIP to archive the job, but will not delete files.  Use this action code with great caution. This action can also be selected from JOBADMIN after using 'shift-control-rightclick' on the job instance button.

ACTION 107 - Archive Unconditional

This action will unconditionally run JOBZIP to archive the job.  Note that if the job is active, FS files may continue to be written back to any of the folders under CALLBACK, after the JOBZIP has been completed.  So use this action code with great caution.

ACTION 1001 - Change Owner Password

Supply the owner.ujp pathname in parm1 and the new numeric password in parm2.

ACTION 10001..10009 - Set Priority

Changes the job priority to the action code less 10000. If the job has been launched, items are moved from one TOSENDx folder to another. See system variable JI_TOSEND.

ACTION 20000 - Schedule job

Delays the job start to the time and date specified in parm2 in one of the formats yyyymmddhhmm, yyyymmdd or hhmm. This action is ineffective if the job has already been launched. See system variable JI_DELAY.

ACTION 20001..20999 - Schedule job

Delays the job start by a number of hours specified by the action code less 20000. This action is ineffective if the job has already been launched. See system variable JI_DELAY.

ACTION 30001..30009 - Update DATAx $var_def field

Changes or adds the value of a job instance properties $var_def line for DATAx, where x is the action code less 30000. The value to be assigned to the DATAx variable is passed in parm2. This action is ineffective if the job has already been launched. These action codes are now deprecated, see 30010 below.

ACTION 30010 - Update $var_def field

The value passed in parm2 should have the form varname=value. This action changes or adds the value of a job instance properties $var_def line for variable varname. This action is ineffective if the job has already been launched. See system variable JI_VARDEF.

ACTION 30101..30108 - Update Retry Delays NOT YET IMPLEMENTED

The value passed in parm2 should be a string of delay values in the usual format for $retry_delays.  The eight action codes apply to retry classes A to H respectively.  Double-quotes around the whole string are optional.

ACTION 40000..40003 - Update Phone and Notify settings

In all 40000..40003 cases an empty parm2 value will delete the corresponding command(s).

 

---

Topic url: http://www.copia.com/support/refmanual/index.html?jobactioncodesfordllcalls.htm