Examples of typing remote URL:

It is just like any other URL. Here is an example of a JSP report generation URL generates a report and converts it to a PDF. The output form this URL is therefore a PDF document and can be viewed or silent printed like any other URL pointing to an existing PDF.

http://www.activetree.com/silent_print_report_from_browser/PdfJSPDemo2.jsp

It lets you specify a password for those password protected documents. See parameter table next to know more about how to provide password for the PDF URL.

Calling the PDF viewer URL with a PDF as argument will display it in the browser window. There are JSP and PHP script files to call for printing or viewing. In this tutorial we will use the JSP script in our examples.

Downloaded archive silent_print_pdf_from_browser.war has few JSP and PHP scripts to call. For viewing a PDF call are going to use view_pdf.jsp. It requires a minimum of one parameter is the PDF document.

Here is how the PDF viewer URL looks like: http://host:port/silent_print_pdf_from_browser/view_pdf.jsp

Here is an example: http://www.activetree.com/silent_print_pdf_from_browser/view_pdf.jsp?DOCUMENT=[PdfURL]

Pass one or more of these parameters to the view_pdf.jsp.

These examples are pointing to an existing deployment.

Details	URL
Existing PDF	http://www.activetree.com/silent_print_pdf_from_browser/view_pdf.jsp?DOCUMENT=http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf
URL that generates a PDF dynamically	http://www.activetree.com/silent_print_pdf_from_browser/view_pdf.jsp?DOCUMENT=http://www.activetree.com/silent_print_report_from_browser/PdfJSPDemo2.jsp
Password protected PDF	http://www.activetree.com/silent_print_pdf_from_browser/view_pdf.jsp?DOCUMENT=http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf&PASSWORD=myDocPassword

This web archive lets you 'silent print' an existing PDF or a PDF dynamically generated from an URL to a printer. Learn more next about the parameters with examples about how you can control "silent print" PDF.

You call silent_print_pdf.jsp script from this web application with one or more parameters to it.

For understanding this web application we'll use silent_print_pdf.jsp script from a deployment in our website. We'll pass one or more parameters to this URL in order to control silent printing. At least one parameter is required for silent printing is a PDF document (static or dynamically generated from an URL).

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[PDF]

DOC_LIST is the parameter to use for specifying the PDFs to print. This parameter is always enclosed with a leading "[" and a trailing "]" character. This example is going to silent print an existing PDF http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf from a remote web site.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]

DOC_LIST is still is the parameter name for printing multiple PDF files. Each PDF file must be separated by "[" and "]" characters. In this example URL we are printing two PDF files:
http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf and http://www.activetree.com/silent_print_report_from_browser/PdfJSPDemo2.jsp

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf][http://www.activetree.com/silent_print_report_from_browser/PdfJSPDemo2.jsp]

Job name is controlled using JOB_NAME name parameter. This example is using "PDFPrintJob" is the job name for this parameter.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob

This is controlled by PAGE_SCALING parameter. PDF page area may be different than the media printable area. Therefore it is important to set this flag in order to get the desired output. Following are the accepted values:
- NONE if applied page content is not scaled to fit to the media size and orientation.
- FIT_TO_PRINTABLE_AREA is used for page content to always get scaled to fit to the media printable area. If the printable area is smaller than the page content it will shrink the page content to fit to the printable area. On the other hand if the media printable area is larger than the page content it will expand the content to fit to the printable area.
- SHRINK_TO_PRINTABLE_AREA is same as FIT_TO_PRINTABLE_AREA except that if the media printable area is larger than the page content it will not expand the page content to fit to the printable area. Otherwise it will shrink the page content to fit to the media printable area.

Default value is set to FIT_TO_PRINTABLE_AREA.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&AUTO_ROTATE_AND_CENTER=true

This is a boolean "true" or "false" flag used to indicate whether or not to automatically rotate and center the document page content to the media printable area. A media printable area may not be of exact match with the document page size. Even if the size of the media is same but the orientation may be different. This flag therefore ensures you to automatically re-orient and center the content to the media printable area if this flag is set to "true". This flag works with the PAGE_SCALING parameter. Value "false" for this flag only effective if the value of PAGE_SCALING parameter is NONE. All other value of page scaling will have no effect on this flag and a value "true" will be used (even if you have set it to "false").

Default value is set to true.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=NONE&AUTO_ROTATE_AND_CENTER=false

PAPER - parameter is used with a paper size value for which should look like "(widthInPixel, heightInPixel)". For an NA_LETTER paper it will be PAPER=(612,792) where paper width is 612 pixels and height is 792 pixels.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&AUTO_ROTATE_AND_CENTER=true&PAPER=(612,792)

AUTO_MATCH_PAPER can be set to true or false. If set to true it will take each PDF page size and find a matched paper size looking into ISO paper size list. If found it will use that paper size, otherwise, it will use the paper size you specify with the PAPER flag. If PDF page size is not matched for auto-paper size match and you have not specified a PAPER size it will use a default paper size. We suggest you provide a default paper size using the PAPER parameter.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&AUTO_ROTATE_AND_CENTER=true&PAPER=(612,792)&AUTO_MATCH_PAPER=true

PASSWORD parameter is used for setting the password. Only one password is supported even when you are printing multiple PDF files. We therefore suggest, if you are printing multiple PDF files where more than one PDF is password protected print one PDF at a time.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&AUTO_ROTATE_AND_CENTER=true&PAPER=(612,792)&AUTO_MATCH_PAPER=true&PASSWORD=myDocPassword

The document URL (or the URL dynamically producing the document) might be password protected in the web server. Web server therefore requires a access USER NAME and PASSWORD (Note: this is different from document PASSWORD).

Following parameters are used for accessing the password protected URL:
URL_AUTH_ID - user name (or ID) for the protected URL.
URL_AUTH_PASSWORD - user password for the protected URL.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&AUTO_ROTATE_AND_CENTER=true&PAPER=(612,792)&AUTO_MATCH_PAPER=true&PASSWORD=myDocPassword&URL_AUTH_ID=urlAuthId&URL_AUTH_PASSWORD=urlAuthPassword

There are no flag to print to a default printer. However, if you want to print to a named printer look for PRINTER_NAME and PRINTER_NAME_SUBSTRING_MATCH parameters next.

PRINTER_NAME and PRINTER_NAME_SUBSTRING_MATCH parameters are used in combination to print to a particular printer identified by a name. PRINTER_NAME value is either full name of the printer or a substring of it. On the other hand PRINTER_NAME_SUBSTRING_MATCH tells whether or not API should look for a printer that is of exact match (value if false) with the string in PRINTER_NAME or API should try to find a printer taking the PRINTER_NAME value and do a substring match (value if true) with all the available printers. If it do not find a matched printer using these two parameters it will print to default printer.

In this example PRINTER_NAME=HP LaserJet 4200 PCL&PRINTER_NAME_SUBSTRING_MATCH=false used to indicate that an exact match should be performed for finding a printer named "HP LaserJet 4200 PCL". When PRINTER_NAME_SUBSTRING_MATCH=true the first printer found using a substring match will be used even there are other printer name might match this substring.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&PAPER=(612,792)&AUTO_MATCH_PAPER=true&PASSWORD=myDocPassword&PRINT_QUALITY=High&PRINTER_NAME=HP LaserJet 4200 PCL&PRINTER_NAME_SUBSTRING_MATCH=false

PRINT_QUALITY parameter is used for setting the printout quality. Possible values are High, Normal and Draft. For laser printers this parameter may not make any difference in output quality. It is important for other kinds of printer such as a thermal printer.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&PAPER=(612,792)&AUTO_MATCH_PAPER=true&PASSWORD=myDocPassword&PRINT_QUALITY=High

SIDE_TO_PRINT parameter is used for this purpose. Possible values are ONE_SIDED, DUPLEX, TUMBLE, TWO_SIDED_LONG_EDGE, or TWO_SIDED_SHORT_EDGE. Actual outcome for this parameter will depend on whether or not the printer supports it. In this example a value of DUPLEX is used with the expectation that the output be printed on both sides of the pages. Duplex mode saves paper and is recommended if your printer support it.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&PAPER=(612,792)&AUTO_MATCH_PAPER=true&PASSWORD=myDocPassword&PRINT_QUALITY=High&SIDE_TO_PRINT=DUPLEX

IS_USE_PRINTER_MARGINS parameter is used for validating the paper size with the printer. A printer might be configured to keep certain amount of margins around the page. PDF content if printed ignoring this margins it might produce the content near the boundary of the paper is cut off. Set this flag to true if you want to use the printer margins, otherwise, set this flag to false. Default value is true.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&PAPER=(612,792)&AUTO_MATCH_PAPER=true&IS_USE_PRINTER_MARGINS=true

COPIES parameter takes an integer number as the number of copies to be printed. Default value is 1 copy. This example is using COPIES=2 for printing 2 copies.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&PAPER=(612,792)&AUTO_MATCH_PAPER=true&IS_USE_PRINTER_MARGINS=true&COPIES=2

COLLATE_COPIES parameter takes boolean true if you want the copies to be collated false otherwise. This is used when printing multiple copies. Default value for this parameter is true.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&PAPER=(612,792)&AUTO_MATCH_PAPER=true&IS_USE_PRINTER_MARGINS=true&COPIES=2&COLLATE_COPIES=true

SINGLE_PRINT_JOB parameter takes boolean true if you want all the DOC_LIST documents be printed as one print job, false otherwise. This is used when printing multiple PDF documents. One print job will cause the API to put together pages from all of the PDF documents and print them together as one document. If this flag it set to false it will print each PDF document as one print job post fixed with a number.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf][http://www.activetree.com/silent_print_report_from_browser/PdfJSPDemo2.jsp]&SINGLE_PRINT_JOB=true

SHOW_PRINT_DIALOG parameter can be set to true if you want to select all of these printing parameters from a dialog window, false otherwise. This flag makes the printing non-silent since it will wait for user input before printing. Moreover it will ignore all the parameter values and will use what user select from this dialog. Only parameter API will use from the URL parameters is the PASSWORD value.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&PASSWORD=myDocPassword&SHOW_PRINT_DIALOG=true

SHOW_PRINT_ERROR_DIALOG parameter if true shows a dialog displaying any kind of printing error if any, false otherwise. Error dialog is shown only if there are printing errors. Default value is true. This example set this flag to false so no dialogs are shown. (See DEBUG parameter later in this tutorial to trace the printing debug messages).

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&PAPER=(612,792)&AUTO_MATCH_PAPER=true&IS_USE_PRINTER_MARGINS=true&SHOW_PRINT_ERROR_DIALOG=false

STATUS_UPDATE_ENABLED parameter if true it shows messages in the browser window while printing is happening. Messages such as PDFs to print, total number of pages, printer it is printing to etc. are displayed when printing is in progress. Default value is true. When you run without this parameter it will display messages in the browser window. Set this to false if do not want to see any messages in the browser window.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&PAPER=(612,792)&AUTO_MATCH_PAPER=true&IS_USE_PRINTER_MARGINS=true&SHOW_PRINT_ERROR_DIALOG=false&STATUS_UPDATE_ENABLED=false

DEBUG parameter if true it shows API debug messages in the Java console window while printing is in progress. This is helpful for the end user as well as developers when trying to print and report a problem if any. This example is using a value false for not recording any debug messages. Default value is set to true.

http://www.activetree.com/silent_print_pdf_from_browser/silent_print_pdf.jsp?DOC_LIST=[http://www.activetree.com/silent_print_pdf_from_browser/demo/sample_pdf/sample1.pdf]&JOB_NAME=PDFPrintJob&PAGE_SCALING=FIT_TO_PRINTABLE_AREA&PAPER=(612,792)&AUTO_MATCH_PAPER=true&IS_USE_PRINTER_MARGINS=true&SHOW_PRINT_ERROR_DIALOG=false&STATUS_UPDATE_ENABLED=false&DEBUG=false

Processing a web document may involve crossing many different security parameters before any success to print, view or other processing may take place. While maintaining security of the data is essential, processing them is a requirement. This product has established a framework that enables one not to disclose the access security parameters in advance. They may be provided when the document is attempted to access at run time using a callback server program of your choice.

If the user is accessing a secured document the callback server program may set them and reply back to the browser client. Security information such as document security password, URL protection ID and password are some of the document authorization parameters may be set through the callback server program.

In addition to providing document access parameters one may not disclose the actual document location and its identity in advance. Instead, the real document location URL (file etc) may be kept hidden and a ID may be set as the document. Callback server program of choice may set the actual document URL or the byte[] content of the document in the browser client reply map.

Once a document is silent printed (and/or done viewing) a success page may be shown to the end user. Similarly, a failure page may be shown in case of a failure has happened.

In summary, one can have complete control over internet document processing by way of:

Several jobs may be processed concurrently from a browser page and each job may include multiple documents (or data source) associated with it. For example, using a java script one may fire a series of call to the "silent print pdf" script. Each URL may have DOC_LIST consists of multiple data source. Each call to the silent print script will launch the job with a unique JOB_ID aimed at monitoring or logging the status.

Ways to track running jobs

While the process continues it updates the job status by calling the context message handler posting the message as parameter. Typically a java script in browser page and the server callback URL (if any) is used for tracking. If a server URL is set, it will call it before and after each job. Java script method is also called for posting a message. One may or may not have defined java script to call and also may not specify a server call back URL. One or both of these two may be used to properly control all aspects of the job processing.

Java Script (client) based job tracking

In the browser page following java script may be declared to receive messages posted by the on going process. Process will call this default java script method with message as the argument.

     function showMessage(msg) {
       //todo - process the message here; e.g. may show in a pane or track to persist in a server once done.
     }

      .../silent_print_pdf.jsp?...&ON_MESSAGE_JS_NAME=myJavaScriptMethod&...
    

Format of the input message
Input message is formatted with minimum of three parameters which one has to parse and extract the content.