E.2 HTML Parameters

The following parameters can be used to enhance the iPrint HTML pages. They are used in the HTML files as PARAM NAME=parameter VALUE=identifier statements.

E.2.1 call-back-url

Targets the results from the onchange JavaScript function associated with selecting jobs from the job list. The JavaScript function causes the browser to reload the indicated control frame passing the list of selected jobs as a parameter.

Example:

PARAM NAME=call-back-url VALUE=CONTROL.HTM

E.2.2 debug

If set to True, displays message boxes with debug and profiling information.

Example:

PARAM NAME=debug VALUE=true

E.2.3 error-type

Determines how the plug-in reports errors associated with the requested operation. The plug-in has the ability to return the errors.

Option

Description

cookie

Puts the error information in a cookie.

html

Displays results as an HTML page generated by the plug-in.

msgBox

Displays results in a message box.

none

No response.

url

Passes the results as a URL parameter.

The plug-in defaults to the same reply mechanism that is specified in results-type if error-type is not specified.

Example:

PARAM NAME=error-type VALUE=html

E.2.4 file-path-name

Specifies a printer-ready file that can be passed to the plug-in for printing. This mechanism bypasses the print provider and the printer driver. The printer does not need to be installed on the workstation to use this operation.

Example:

PARAM NAME=file-path-name VALUE=directory path\filename

E.2.5 job-list

The plug-in can perform several operations on jobs. The job-list parameter is a comma-delimited string of job IDs that indicates which jobs to operate on. A job list with the job ID of -1 is equivalent to selecting all jobs

Example:

PARAM NAME=job-list VALUE=3,5,7

E.2.6 job-list-options

When the plug-in creates the HTML for job-list, it can add buttons to allow the user to hold, resume, delete, or display information for selected jobs. The job-list-options parameter specifies which of the following possible buttons to display and support:

Example:

PARAM NAME=job-list-options VALUE=op-job-hold,op-job-release-hold, op-job-cancel, op-job-get-info

E.2.7 persistence

Printer installation can be temporary or permanent. If it is not specified, persistence defaults to persistent. The persistence parameter specifies how long the printer is to be installed for. The choices include the following:

Option

Description

persistent

Printer is not removed.

volatile-date-time

Printer is removed at the indicated time (year, month, day, hour, minute).

volatile-reboot

Printer is removed when the workstation reboots.

Examples:

PARAM NAME=persistence VALUE=volatile-reboot
PARAM NAME=persistence VALUE=volatile-date-time:2004,3,22,8,30

E.2.8 printer-url

Indicates which printer the operation should be directed to.

Example:

PARAM NAME=printer-url VALUE=ipp://MyPrinter.com/ipp/Printer1

E.2.9 result-type

Determines how the plug-in reports the results of the requested operation. The plug-in can return the results in any of the following ways:

Option

Description

cookie

Puts the results in a cookie.

html

Displays results as an HTML page generated by the plug-in.

msgBox

Displays results in a message box.

none

No response.

url

Passes the results as a URL parameter.

The plug-in defaults to none if results-type is not specified.

Example:

PARAM NAME=result-type VALUE=html

E.2.10 target-frame

Specifies the name of the frame to put the results or error information into. If the operation results type is url, the target frame is the one reloaded with the indicated URL.

Example:

PARAM NAME=target-frame VALUE=FrameName