Please enable JavaScript to view this site.

CopiaFacts™ Reference Manual

J_PARM1, JPARM2, J_PARM3[SW CV C>] Values assigned to these variables are used as parameters for a call to the Job Admin DLL, initiated by assigning a function name to JOB_DLL_CALL.  During the  DLL call, new values may have been placed in J_PARM1 and J_PARM2.  For details, see the topic Job Admin Scripting .
JI_DATAx [SW] You may assign a value to this variable to specify a job data value after the job creation phase of an IVR session. The x value is normally from 1 to 4 unless you have specified extra data fields using $log_field. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a user variable JI_DATAx. The use of these system variables is now deprecated; it is preferable to use JI_VARDEF as described below.
JI_DELAY [SW CV C>] You may assign a value to this variable to specify a delay for the current job, after the job creation phase of an IVR session. If the value is less than three digits, it is taken as a number of hours. Otherwise it must be a date or time in one of the formats HHMM, YYYYMMDD, or YYYYMMDDHHMM. The string length determines the format. For more complex date/time selection, use JI_TOSEND to select a TOSEND queue with an appropriate schedule. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a user variable JI_DELAY.
JI_PASSWORD [SW CV C>] You may assign a value to this variable to change the password in the OWNER.UJP file that is active for the current Job IVR session. This allows an owner to change password using IVR you have provided for this purpose. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a user variable JI_PASSWORD.
JI_PHONE [SW CV C>] You may assign a value to this variable to change the phone number used for both job proofs and standard job reports for the job instance. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a user variable JI_PHONE.
JI_TOSEND [SW CV C>] You may assign a value to this variable to specify the job priority after the job creation phase of an IVR session. The value must be from 1 to the maximum defined TOSEND queue number. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a control variable JI_TOSEND.
JI_VARDEF [SW] You may assign a value of the form "varname=value" to this variable after the job creation phase of a job IVR session, to make available the variable during the processing of the broadcast job. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a user variable JI_VARDEF.
JOB_ACTION[SRO] Contains the action number specified in a job action worker-box FS file.  The value will be empty if there was no job action.
JOB_CREATE_DISABLED[CV >J] This can be set to a non-empty value in SYSTEM, OWNER or JOBTYPE properties (UJP) and causes any attempt to create a new job instance to fail (with error -61), if created using the file in which the variable appears.  Defining the variable in SYSTEM.UJP of course prevents any new job being created.  The variable has no effect in an instance UJP.
JOB_DLL_CALL[SW] Assignment of a valid Job Admin DLL function name to this variable calls the DLL function with parameters specified in the J_PARMn variables.  For details, see the topic Job Admin DLL Scripting.

JOB_DLL_LOCK_OPTIONS

[CV >J] Specifies a string of 1 or 0 characters to control locking features of the Job Admin DLL.  For details, see Job DLL Lock Functions.
JOB_EMAIL_FSQ[CV >J] Specifies the name of an MSMQ queue into which E-Mail FS files are to be launched, and causes the job e-mail items to be launched into the FS Queue.
JOB_ERROR [SRO] This variable returns an error number if processing of job owner, type or instance selection fails. It is used when the standard job selection procedure prompts have been bypassed by making assignments to the JOBINST, JOBOWNER, JOBTYPE and JOBNEWOLD system variables. When an error code has been set, control will be transferred to your $error_exit infobox.
JOB_EXCLUDED[SRO] This variable returns the number of job items which have been excluded from launch. The variable may be used after a job instance has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_FAIL [SRO] This variable returns the number of job items which have failed after the specified number of retries. If failed items have been 'manually' retried, they will have be counted multiple times. The variable may be used after a job instance has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_INSTANCE [SRO CB >E] This variable returns the job instance number. The variable may be used after a job instance has been created or selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_INSTUJP[SRO] This variable returns the job instance UJP pathname. The variable may be used after a job instance has been created or selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_ITEM [SRO CB >E] This variable returns the sequential item number of the FS file within a job, from 1 to the total number of items in the job. A value of 0 indicates that the FS file is not part of a job. A value of -1 indicates a proof and of -2 a standard job report.
JOB_LAUNCH_LIMIT[CV >J] This variable can be set in SYSTEM.UJP or in an override owner, jobtype or instance UJP file, to limit the maximum size of job to be processed. In an environment where bureau clients submit jobs themselves, this can avoid the accidental launch of a job with a very large number of recipients. Jobs with a larger number of items will fail to launch with error code -38.
JOB_LISTNAME [SRO] Contains the filename of a job list file, for use on a job report coversheet to show which list(s) have been used. If multiple lists are in use it returns them in sequence each time the variable is used.
JOB_LISTPATH [SRO] Contains the full pathname of a job list file, for use on a job report coversheet to show which list(s) have been used. If multiple lists are in use it returns them in sequence each time the variable is used.
JOB_LOG[SW] Any non-empty value can be assigned to this variable to be written in the job history of the current job. We recommend writing a message if you perform a job action in infobox logic for a job item, for example to show a reason when suspending a job with JOB_SUSPEND.
JOB_NOTES [SRO] This variable returns the job notes field from the job instance properties, which may be required to display the client's identifying data on a proof or report cover sheet.
JOB_RETRIES [SRO] This variable returns the number retries of job items which have not been transmitted successfully on a previous attempt. The variable may be used after a job instance has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_SCHEDULED [SRO] This variable returns the scheduled processing time for a job instance, based on the fax send date and time in the $fs_template item list. If no defer time has been entered, the value returned will be empty. If the job is not yet launched, it may not be transmitted at the scheduled time if the launch is not performed before this. The format of the returned string is YYYYMMDDHHMMSS.
JOB_SECONDS [SRO] This variable returns the aggregate number of call seconds used in sending the job. The variable may be used after a job instance has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_SENT [SRO] This variable returns the number of job items which have been successfully sent. The variable may be used after a job instance has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_SMS_FSQ[CV >J] Specifies the name of an MSMQ queue into which SMS FS files are to be launched, and causes the job SMS items to be launched into the FS Queue.
JOB_STATUS [SRO] This variable returns the status of a job as a two-digit numeric code, followed by space, colon, space and then the status description.  To obtain just the numeric code, use $set_var to assign @JOB_STATUS to another variable with a start value of 1 and a length value of 2. For details of the codes, see Job Status/Actions. The variable may be used after a job instance has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_SUSPEND[SW CV C>] Any non-empty value can be assigned to this variable to cause the current job to be suspended.  Unlike JOBACTION this variable is intended for use in a pre- or post-process infobox for a job item and can suspend the job if a specific condition is detected. The variable value will be empty if the action was successful and will contain JOBFAILn if not, where n is the (negative) error code. To allow for the action being performed simultaneously from multiple threads, no error occurs if the job is already suspended.
JOB_TIMESTAMP [SRO] This variable returns the time of the last change of status of the job instance. For example, if the job is finished, it will tell you when the job was finished. If the timestamp cannot be determined, the result will be empty. The format of the returned string is YYYYMMDDHHMMSS.
JOB_TOTAL [SRO] This variable returns the number of items in the job. For jobs which are launched over an extended period (e.g. FFMERGE jobs) the value is the job size estimate, if available. For 'open' jobs, the value returned is zero. The variable may be used after a job has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOBACTION [SW] You may assign a value to this variable to specify a job action value after the job selection phase of an IVR session. For details of job action codes, see Job Status/Actions.
JOBDOC_EXTENSION[CV >J] This variable should be set with the extension (with or without a leading '.') of a $job_document filename which contains a variable expansion.  If omitted, and if there is no extension, it will be assumed to be '.TIF'.
JOBINST [SW] You may assign a value to this variable to specify the job instance during the job selection phase of an IVR session. Assignment to this variable causes the system to skip the prompt for a job instance number. The value assigned must be a number of up to the number of digits allowed.
JOBLIST_FILENAME[CV J>] The filename (without file extension) of the list from which the job item originated. This value is set in each FS file at job launch.
JOBLIST_PATHNAME[CV J>] The full pathname of the list from which the job item originated. This value is set in each FS file at job launch.
JOBLISTS [SW] You may assign a value to this variable to specify the job broadcast list(s) after the job creation phase of an IVR session. The value is a string of 0s and 1s representing lists to be not used and used respectively. If you use 2s instead of 1s, the caller will still be prompted for additional list numbers, and list numbers already marked with 2 will be deleted from the string (replaced by 0) if selected by the caller. Assigning an empty value (@EMPTY) will pre-select all lists. Assignment to this variable is ignored if no job instance has been created or selected at the time.
JOBNEWOLD [SW] You may assign a value to this variable before the job selection phase of an IVR session to specify whether the session is to create a new job or work with an existing job. A value of 0 selects creation of a new job and a value of 1 selects working with an existing job. Add 2 to either of these values to skip all prompts (for autodialer entry). Assignment to this variable causes the system to skip the prompt for 'new or existing job'.
JOBOWNER [SW] You may assign a value to this variable to specify the job owner during the job selection phase of an IVR session. Assignment to this variable causes the system to skip the prompt for a job owner. The value assigned must be a valid directory name. Leading zeros for numeric values need not be specified.
JOBOWNER_CODE [SRO CB >E] This variable returns the directory (folder) name for the Job Owner (under the USERJOBS folder). It can be used during the job processing, for example on a cover sheet. Leading zeros in the folder name are removed.
JOBOWNER_FOLDER [SRO] This variable returns the directory (folder) name for the Job Owner (under the USERJOBS folder). It can be used during the job processing, for example on a cover sheet. Leading zeros in the folder name are not removed.
JOBOWNER_NAME [SRO] This variable returns the full name of the Job Owner. It can be used during the job processing, for example on a cover sheet.
JOBOWNER_PATH[SRO] This variable contains the full pathname of the current Job Owner properties file. It is only available at Job IVR time, not at the time a broadcast is being processed.
JOBOWNER_VOX [SRO] This variable returns the full pathname of the voicefile describing the Job Owner. It can be used during the job IVR processing to play a confirmation message to the caller.
JOBTYPE [SW] You may assign a value to this variable to specify the job type during the job selection phase of an IVR session. Assignment to this variable causes the system to skip the prompt for a job type. The value assigned must be a valid directory name. Leading zeros for numeric values need not be specified.
JOBTYPE_CODE [SRO CB >E] This variable returns the directory (folder) name for the Job Type, under the applicable owner folder. It can be used during the job processing, for example on a cover sheet. Leading zeros in the folder name are removed.
JOBTYPE_FOLDER [SRO] This variable returns the directory (folder) name for the Job Type, under the applicable owner folder. It can be used during the job processing, for example on a cover sheet. Leading zeros in the folder name are not removed.
JOBTYPE_NAME [SRO] This variable returns the full name of the Job Type. It can be used during the job processing, for example on a cover sheet.
JOBTYPE_PATH [SRO] This variable contains the full pathname of the current Job Type properties file. It is only available at Job IVR time, not at the time a broadcast is being processed.
JOBTYPE_VOX [SRO] This variable returns the full pathname of the voicefile describing the Job Type. It can be used during the job IVR processing to play a confirmation message to the caller.