To accommodate Natural Printing, a number of URL line parameters are available. It is extremely important that the syntax is used correctly. There must not be spaces in the URL. The following table provides additional information on each printing parameter. For examples of how to use and combine parameters, see Examples.
|
Parameter |
Description |
Valid Values |
Default (if parameter is not present) |
|
REPORTPRINTER |
Specifies the printer to use. |
A printer name (without spaces). The printer name should be entered exactly as it appears in the Proficy Portal client's Print dialog box (from the File menu, choose Print, and then Display). If printing to a local printer, you can print only to the local printer that is set as the default. NOTE: If your local printer name contains spaces, rename the printer (in your Printers control panel). |
The default system printer. |
|
REPORTCOPIES |
Specifies the number of copies to print. |
1 - the printer limit |
1 |
|
REPORTORIENTATION |
Specifies the orientation of the paper. |
"L" - Landscape "RL" - Reverse Landscape "P" - Portrait "RP" - Reverse Portrait |
The system's default orientation. |
|
REPORTCOLOR |
Whether to print in color or monochrome. |
"TRUE" - color "FALSE" - monochrome |
The default setting of the printer. |
|
REPORTTOPDF |
Whether to create a PDF file of the report. |
"TRUE" "FALSE" |
"FALSE" |
|
REPORTNAME |
Specifies the directory path and name for the PDF file. |
A valid path. If there are spaces in the path/name, they must be replaced with "%20". |
Only used if REPORTTOPDF is "TRUE" If saving the PDF on the local machine, the default location is AllUsers\reports or Users\username\reports depending on the directory location of the display. The display name is used as the default PDF file name. If REPORTLOCAL is "FALSE", the path will be of similar format to the DISPLAY Parameter path. Each user has a Reports folder on the server where the report can be saved to. |
|
REPORTLOCAL |
Specifies the report destination as the local file system or the Proficy Portal server. |
"TRUE" "FALSE" |
"TRUE" |
|
REPORTAPPENDDATE |
Requests that the current date and time are appended to the given REPORTNAME so that it will not overwrite a previous report. |
"TRUE" "FALSE" |
"FALSE" If "TRUE", the date/time will be appended. The format will match the regional settings format for date/time. The date/time separators are replaced by "–" |
The following example URL will print the "Emissions" display on a shared printer:
http://localhost/ProficyPortal/default.asp?USER=bob&PASSWORD=pwd&
APP=REPORT&DISPLAY=Users\jsmith\displays\Trending\Emissions&REPORT
PRINTER=\\sharedprinterlocation\printername
The following example URL will print 5 copies of the "Emissions" display on the local printer, with the orientation set to Landscape.
http://localhost/ProficyPortal/default.asp?USER=bob&PASSWORD=pwd&
APP=REPORT&DISPLAY=Users\jsmith\displays\Trending\Emissions&REPORT
PRINTER=\\localprintername&REPORTCOPIES=5&REPORTORIENTATION=L
The following example URL will save the "Emissions" display as a PDF file in a local directory:
http://localhost/ProficyPortal/default.asp?USER=bob&PASSWORD=pwd&
APP=REPORT&DISPLAY=Users\jsmith\displays\Trending\Emissions&
REPORTTOPDF=TRUE&REPORTLOCAL=TRUE&REPORTNAME=C:\Reports\Emissions
The following example URL will save the "Emissions" display as a PDF file in a directory on the Proficy Portal server:
http://localhost/ProficyPortal/default.asp?USER=bob&PASSWORD=pwd&
APP=REPORT&DISPLAY=Users\jsmith\displays\Trending\Emissions&
REPORTTOPDF=TRUE&REPORTLOCAL=FALSE&REPORTNAME=Users\jsmith\reports\Emissions
