Common input and output fields

The following fields can be found in the user-exit programs. For a detailed list of input and output fields according to user-exit, see the /usr/lpp/psf/exits/ainuexit.h file. This information can be specified from:

  • Migrated jobs
  • Download for z/OS jobs
  • Fields set in the InfoPrint Manager Administration Interface Job and Document Defaults notebook
  • Fields in the InfoPrint SMIT administrator's interfaceSubmit an InfoPrint Job panel
UserID
Identifies the user ID of the person who submitted the job. If you log in as yourself and then switch to root, the user ID is root.
NodeID
Identifies the name of the system (host). The backend program sets the NodeID.
Jobname
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=name when they submit a job.

If the job name is not specified for files defined as OTF, PCL, PostScript, ditroff, line data, unformatted ASCII, double-byte character set (DBCS) ASCII, EUC, PDF, JPEG, GIF, or TIFF files when the job is submitted, InfoPrint Manager creates a temporary file for the transform output. InfoPrint Manager uses the temporary file name for the job name.

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 printed.
Time
Identifies the time printed.
Distribution
Identifies the distribution information provided when the job is submitted.
PagePointer
Points to a buffer containing the data produced by any of these exits:
  • Header page
  • Trailer page
  • Separator page
  • Accounting
  • Audit
PageSize
Indicates the size of the data returned by these exits:
  • Header page
  • Trailer page
  • Separator page
  • Accounting
  • Audit
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 pending state. In addition, InfoPrint disables the actual destination.
Name
Identifies the name information provided when the job is submitted.

The Name field value can be any null-terminated (X'00') character string. This value can be any null-terminated (X'00') character string no greater than 24 characters.

Userid
Identifies the userid information provided when the job is submitted.

The Userid field value can be any null-terminated (X'00') character string. This value can be any null-terminated (X'00') character string no greater than 10 characters.

Nodeid
Identifies the nodeid information provided when the job is submitted.

The Nodeid field value can be any null-terminated (X'00') character string. This value can be any null-terminated (X'00') character string no greater than 10 characters.

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. This value can be any null-terminated (X'00') character string no greater than 57 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. This value can be any null-terminated (X'00') character string no greater than 57 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. This value can be any null-terminated (X'00') character string no greater than 57 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. This value can be any null-terminated (X'00') character string no greater than 57 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. This value can be any null-terminated (X'00') character string no greater than 20 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. This value can be any null-terminated (X'00') character string no greater than 24 characters.

Department
Identifies the department information provided when the job is submitted.

The Department field value can be any null-terminated (X'00') character string. This value can be any null-terminated (X'00') character string no greater than 24 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. This value can be any null-terminated (X'00') character string no greater than 24 characters.

Room
Identifies the room information provided when the job is submitted.

The Room field value can be any null-terminated (X'00') character string. This value can be any null-terminated (X'00') character string no greater than 24 characters.

Title
Identifies the title information provided when the job is submitted.

The Title field value can be any null-terminated (X'00') character string. This value can be any null-terminated (X'00') character string no greater than 24 characters.

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.

LongPrinterName
The full name of the InfoPrint destination.
Note: Because InfoPrint Manager only allows 64 character names, PrinterName and LongPrinterName are the same.

Parent topic: User-exit programs (PSF only)