Open topic with navigation

You can automate certain print actions for Print Portal by adding Print Document dialog query parameters to your Print Portal URL address in your browser window. The URL scheme to print a document is as follows.

You must know the base URL for the document that you want, and if the root folder name or path contains special characters, they must be URL-encoded.

The following query parameters are available:

• Copies (integer): Specifies the number of identical copies to print for the document, if the document supports changing the number of copies.

• SerialNumbers (integer): Specifies the number of serialized items to print, if the document supports serialization.

• Printer (string): Specifies the printer that you want to print the document to. This parameter value must exactly match a printer name for a printer that is already configured for use with Print Portal. You can view a list of these printers on the Printers property page. This parameter is case-sensitive.

• Task (string): Specifies whether the print job starts immediately or the page opens in Print Preview. Valid values for this query string are "Print" and "PrintPreview". If the selected printer is a client printer, the requested task is completed after the client print module has successfully loaded. The behavior is the same as if you had manually clicked the Print or Print Preview button, so if any data entry is required, the data entry form opens first.

• ReturnAfterCompletion (boolean): Specifies how Print Portal behaves after a specified task ("Print" or "PrintPreview") is completed. When this parameter is set to true, the default behavior is specified. For example, after a successful print task (including data entry if appropriate), Print Portal returns to its browser page. When this parameter is set to false, the Print Document dialog remains open after the successful print task.

• <Data Entry Control Name>=<value> (string): Sets the default value of a data entry control. This parameter is case-sensitive.

Sample URLs

The following URL specifies that you want two serialized items to be printed for a document that is named "serial.btw", which is located at the base level of the "My Files" root folder.

The following URL specifies that you want five identical copies to be printed for a document that is named "AIAG_PT1.btw", which is located in the "New Folder/AIAG" folder of the root folder "Labels". It specifies that the copies are printed to the "Easycoder IP" printer.

The following URL is the same as in the preceding example except that it is automatically printed (or shows the data entry form if required) when the client print module has loaded.

The following URL is the same as in the preceding example except that it automatically displays a print preview (or shows the data entry form if required) when the client print module has loaded.

This URL sets the default value of the "Text Input Box 1" data entry control to a value of "Sample Text".