Common input and output fields
These fields can be found in the user-exit programs. For a detailed list of input and output fields according to user-exit, see the install_path\psf\exits\ainuexit.h file. This information can be specified from:
- Migrated jobs
- MVS Download jobs
- Fields set in the InfoPrint Manager Administration Interface Job and Document Defaults notebook
- UserID
- Identifies the system user ID of the person who submitted the job.
The Userid field value can be any null-terminated (X'00') character string. You should limit the string to 10 or less characters.
- NodeID
- Identifies the name of the system (host). The backend program sets the NodeID.
The Nodeid field value can be any null-terminated (X'00') character string. You should limit the string to 10 or less characters.
- Jobname or Name
- Identifies the name of the job. This is the same as the file name in the job.
Job submitters can also specify the job name with the InfoPrint Manager job attribute job-name=
nameor name=namewhen they submit a job. If the job name is not specified for files defined as PCL, PostScript, line data, unformatted ASCII, double-byte character set (DBCS) ASCII, or PDF, when the job is submitted, InfoPrint creates a temporary file for the transform output. InfoPrint uses the temporary file name for the job name.This field value can be any null-terminated (X'00') character string. You should limit the string to 24 or less characters.
- SpoolID
- Identifies the PSF job ID, which is an integer. InfoPrint Manager sets the SpoolID.
- PrinterName
- Identifies the first 64 characters of the InfoPrint Manager destination name.
- hab
- This function is not used.
- Date
- Identifies the date the job is printed in
MM/DD/YYformat. - Time
- Identifies the time the job is printed in
HH:MM:SSformat. - Distribution
- Identifies the distribution information provided when the job is submitted.
- PagePointer
- Points to a buffer containing the header page or trailer page data produced by the exit.
- PageSize
- Indicates the size of the header page or trailer page data returned by the exit. This field is initially set to 0 before the exit is called. If no data is generated by the exit, this field remains set at 0.
- PageType
- Indicates the type of header or trailer page data (if any) that the exit generates.
The field is initially set to 0 (AFP data stream) before the exit is called. Valid
values are:
- 0
- AFP data stream
- 1
- ASCII data
- Job Completion
- Indicates the status returned by the exit. This field is initially set to 0 before
the exit is called. Valid return codes are:
- 0
- Good completion, all done, accept resultant page.
- -1
- Bad completion, non-fatal error, no page generated.
- -5
- Bad completion, fatal error. The exit is disabled until you shut down the actual destination.
- -8
- Bad completion, terminate the current job.
- -12
- Bad completion: terminate the job and put it in
pendingstate. In addition, InfoPrint disables the actual destination.
- Account
- Identifies the account information provided when the job is submitted. The Account field value can be any null-terminated (X'00') character string. You should limit the string to 20 characters or less. Job submitters can specify this same information through the account-text document attribute.
- Address1
- Identifies the first line of address information provided when the job is submitted.
The Address1 field value can be any null-terminated (X'00') character string. You should limit the string to 57 or less characters.
- Address2
- Identifies the second line of address information provided when the job is submitted.
The Address2 field value can be any null-terminated (X'00') character string. You should limit the string to 57 or less characters.
- Address3
- Identifies the third line of address information provided when the job is submitted.
The Address3 field value can be any null-terminated (X'00') character string. You should limit the string to 57 or less characters.
- Address4
- Identifies the fourth line of address information provided when the job is submitted.
The Address4 field value can be any null-terminated (X'00') character string. You should limit the string to 57 or less characters.
- Account
- Identifies the account information provided when the job is submitted.
The Account field value can be any null-terminated (X'00') character string. You should limit the string to 20 or less characters.
- Building
- Identifies the building information provided when the job is submitted.
The Building field value can be any null-terminated (X'00') character string. You should limit the string to 24 or less characters. You can specify this same information through the building-text document attribute.
- Department
- Identifies the department information provided when the job is submitted.
The Department field value can be any null-terminated (X'00') character string. You should limit the string to 24 or less characters. You can specify this same information through the department-text document attribute.
- Passthru
- Identifies any other information provided when the job is submitted that will be passed
through the user-exit to the backend program.
These Passthru flags are supported:
- class
- Identifies the one-character class attribute.
- destination
- Identifies the one-to 64-character destination attribute.
- forms
- Identifies the one-to 64-character forms attribute.
- segmentid
- Identifies the one-to ten-character segmentation identifier.
- ServerJobID
- Identifies the job identifier.
The Passthru field value can be any null-terminated (X'00') character string no greater than 1,024 characters.
- Programmer
- Identifies the programmer information provided when the job is submitted.
The Programmer field value can be any null-terminated (X'00') character string. You should limit the string to 24 or less characters. You can specify this same information through the programmer-text document attribute.
- Room
- Identifies the room information provided when the job is submitted.
The Room field value can be any null-terminated (X'00') character string. You should limit the string to 24 or less characters. You can specify this same information through the room-text InfoPrint document attribute.
- Title
- Identifies the title information provided when the job is submitted.
The Title field value can be any null-terminated (X'00') character string. You should limit the string to 24 or less characters. You can specify this same information through the title-text document attribute.
- LongPrinterName
- The full name of the InfoPrint destination.
Note: Because InfoPrint Manager only allows 64 character names, PrinterName and LongPrinterName are the same.