XcmJMJobXStateReasons
This representation is bit-encoded, so that multiple reasons can occur at once. Each bit corresponds to a Xerox OID for the same Xerox extension to the ISO DPA job state reason. In a DPA protocol, the DPA and Xerox OID can be intermixed. But in a bit encoded SNMP information object, we need to keep the bit encodings separate. The MIB enum value is given by: value = 2 ** (last arc of Xerox xid-val-reasons-xxx OID) xid-val-reasons-cascaded = 1.2.840.113550.1.6.19.0 The last arc is shown in parens in the description. ISO DPA: Job-state-reasons This attribute identifies the reason or reasons that the job is in the held, [processing] terminating, retained, or completed state. The server shall indicate the particular reason(s) by setting the value of the job-state-reasons [xcmJobStateReasons, xcmJobXStateReasons, and xcmX2StateReasons objects] attribute. When the job is not in any of these states, the server shall set the value of the job-state-reasons attribute to the empty set. The following values are defined as Xerox extensions. The specification is copied from the Xerox Job Model, Phase 1, updated to version 0.67, 12/20/96. NOTE: In the Xerox Job Model, the acronym JSP stands for Job Service Provider. In ISO DPA and this MIB the term server is used equivalently to JSP. The extensions defined by Printxchange: cascaded 0x1 (0) After the outbound gateway retrieves all job and document attributes and data, it stores the information into a spool directory. Once it has done this, it sends the supervisor a job-processing event with this job-state-reason which tells the supervisor to transition to a new job state. deletedByAdministrator 0x2 (1) The administrator has issued a Delete operation on the job or a Clean operation on the server or queue containing the job; therefore the job may have been cancelled before or during processing, and will have no retention-period or completion-period. discardTimeArrived 0x4 (2) The job has been deleted (cancelled with the job- retention-period set to 0) due to the fact that the time specified by the job's job-discard-time has arrived [if the job had already completed, the only action that would have occurred is that the job-retention-period would be set to 0 and the job is deleted]. postprintFailed 0x8 (3) The post-processing agent failed while trying to log accounting attributes for the job; therefore the job has been placed into retained state for a system-defined period of time (Printxchange, 5 minutes), so the administrator can examine it, resubmit it, etc. The post-processing agent is a plug-and-play mechanism which the system and the customer uses to add functionality that is executed after a job has finished processing. submissionInterrupted 0x10 (4) Indicates that the job was not completely submitted for the following reasons: (1) the server has crashed before the job was closed by the client. The server shall put the job into the completed state (and shall not process the job). (2) the server or the document transfer method has crashed in some non-recoverable way before the document data was entirely transferred to the server. The server shall put the job into the completed state (and shall not process the job). (3) the client crashed or failed to close the job before the time-out period (Printxchange, 20 minutes). The server shall close the job and put the job into the held state with job-state-reasons of submission-interrupted and job-hold-set and with the job's job-hold attribute set to TRUE. The user may release the job for scheduling by issuing the ReleaseJob operation. maxJobFaultCountExceeded 0x20 (5) The job has been faulted and returned by the server several times and that the job-fault-count exceeded the device's (or server's, if not defined for the device) cfg- max-job-fault-count. The job is automatically put into the held state regardless of the hold-jobs-interrupted-by- device-failure attribute. This job-state-reasons value is used in conjunction with the job-interrupted-by-device- failure value. Job timed-out while processing (optional): Implementation option: The following values of job-state- reasons are derived from ISO DPA printer states for use when the system moves a processing job to the held state because a site- settable time-out condition was exceeded while the job was in the processing state: devicesNeedAttentionTimeOut 0x40 (6) One or more document transforms that the job is using needs human intervention in order for the job to make progress, but the human intervention did not occur within the site-settable time-out value and the JSP has transitioned the job to the held state. needsKeyOperatorTimeOut 0x80 (7) One or more devices or document transforms that the job is using need a specially trained operator (who may need a key to unlock the device and gain access) in order for the job to make progress, but the key operator intervention did not occur within the site-settable time-out value and the JSP has transitioned the job to the held state. jobStartWaitTimeOut 0x100 (8) The JSP has stopped the job at the beginning of processing to await human action, such as installing a special cartridge or special non-standard media, but the job was not resumed within the site-settable time-out value and the JSP has transitioned the job to the held state. Normally, the job is resumed by means outside the job model, such as some local function on the device. jobEndWaitTimeOut 0x200 (9) The JSP has stopped the job at the end of processing to await human action, such as removing a special cartridge or restoring standard media, but the job was not resumed within the site-settable time-out value and the JSP has transitioned the job to the retained state. Normally, the job is resumed by means outside the job model, such as some local function on the device, whereupon the job shall transition immediately to the terminating state. jobPasswordWaitTimeOut 0x400 DEPRECATED: (10) The JSP has stopped the job at the beginning of processing to await input of the job's password, but the human intervention did not occur within the site-settable time-out value and the JSP has transitioned the job to the held state. Normally, the password is input and the job is resumed by means outside the job model, such as some local function on the device. This value is DEPRECATED because the JSP shall move Secure Jobs from processing to held when they are the next to run and set the jobPasswordWait job-state-reason, so that the device is not blocked. deviceTimedOut 0x800 (11) A device that the job was using has not responded in a period specified by the device's site-settable device- timeout-period attribute (In ISO DPA the printer's printer- timeout-period attribute). connectingToDeviceTimeOut 0x1000 (12) The JSP is attempting to connect to one or more devices which may be dial-up, polled, or queued, and so may be busy with traffic from other systems, but JSP was unable to connect to the device within the site-settable time-out value and the JSP has transitioned the job to the held state Reasons used when the job is in processing state: The following values for the job-state-reasons attribute have been added by the Job Model team to give requesters feedback about the job when the job is in the processing state: transferring 0x2000 (13) The job is being transferred to a down stream server or device. queueInDevice 0x4000 (14) The job has been queued in a down stream server or device. jobCleanup 0x8000 (15) The JSP is performing cleanup activity as part of ending normal processing. processingToStopPoint 0x10000 (16) The requester has issued an InterruptJob operation and the JSP is processing up until the specified stop point occurs. Other reasons added by the Xerox Job Model: The following values for the job's job-state-reasons attribute have been added by the Xerox Job Model team: jobPasswordWait 0x20000 (17) Either: (1) The JSP has selected the Secure Job to be next to process, but instead of assigning resources and starting the job processing, the JSP has transitioned the job to the held state to await entry of a password (and dispatched another job, if there is one) OR (2) the JSP has interpreted (ripped) the Secure Job and the marker is scheduled separately, so that the JSP transitions the job to the held state to await entry of a password (and dispatched another job, if there is one). The user resumes the job either locally or by issuing a ReleaseJob supplying a job-password=secret-code input parameter that SHALL match the job's job-password attribute. validating 0x40000 (18) The job is validating the job after a CreateJob operation. The job state may be creating, held, pending, or processing. queueHeld 0x80000 (19) The operator has held the entire queue by means outside the scope of the Job model. jobProofWait 0x100000 (20) The job has produced a single proof copy and is in the held state waiting for the requester to issue the ReleaseJob operation to release the job to print normally, obeying the job-copies and copy-count job and document attributes that were originally submitted. heldForDiagnostics 0x200000 (21) The system is running intrusive diagnostics, so the all jobs are being held. serviceOffLine 0x400000 (22) The service/document transform is off-line and accepting no jobs. All pending jobs are put into the held state. This could be true if its input is impaired or broken. noSpaceOnServer 0x800000 (23) The job is held because there is no room on the server to store all of the job. For example, there is no room for the document data or a scan-to-file job. pinRequired 0x1000000 (24) The device requires that a pin be entered in order to proceed, because the PIN was not supplied with the document or job. exceededAccountLimit 0x2000000 (25) The account for which this job is drawn has exceeded its limit. This condition should be detected before the job is scheduled so that the user does not wait until his/her job is scheduled only to find that the account is overdrawn. This condition may also occur while the job is processing either as processing begins or part way through processing. An overdraft mechanism should be included to be user- friendly, so as to minimize the chances that the job cannot finish or that media is wasted. For example, the JSP should finish the current copy for a job with collated document copies, rather than stopping in the middle of the current document copy. jobHeldForRetry 0x4000000 (26) The job encountered some errors that the JSP could not recover from with its normal retry procedures, but the error is worth trying the job later, such as phone number busy or remote file system in-accessible. For such a situation, the JSP shall add the held-for-retry value to the job's job- state-reasons attribute and transition the job from the processing to the held (via the evaluate-hold internal momentary state), rather than to the retained state. The remaining bits are reserved for future standardization and shall not be used by conforming implementations. This is the equivalent of a type 2 enum.