Users sometimes want to reach a specific page by typing a full URL in a Web browser instead of clicking hyperlinks from the Server home page. We provide the commands used in URL. These URLs can also be used in your applications. The Scheduling Command and its Properties section further explain the scheduling task.
Note: Users of the PDF-version manual, some command line examples are too long to be displayed in the pdf file, so please refer to the html version.
Notes for upgrading to version 6:
- In JReport Enterprise Server version 6, the JSP is enabled by default (in the server.properties file, the
httpserver.jsp.enableproperty is set totrue). Terefore, you should use/jrseverin the URL to access the servlet. For example,
Instead of:http://localhost:8888?jrs.cmd=jrs.get_subnodes
You should now write:http://localhost:8888/jrserver?jrs.cmd=jrs.get_subnodes- The format to reference the catalog name and report name has been changed. Now the catalog name and report name should be used in jrs.catalog=CATALOG and jrs.report=REPORT. For example,
New:http://localhost:8888/jrserver?jrs.cmd=jrs.get_rst_vers&jrs.catalog=/hsqlDemo/Tutorial.cat&jrs.report=/hsqlDemo/Invoice.cls- Deprecated!
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls?jrs.cmd=jrs.get_rst_vers
However, the old format is still supported.
With the commands below, you can directly type the whole URL in a browser to access the destination. The HTTP methods GET and POST are available for almost all of the commands.
- jrs.get_subnodes
Description: get all the sub nodes of a specified node (deprecated since version 6.0, replaced by jrs.get_cat_rpts_new)
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_subnodes
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_subnodes
Response: Resource nodes list- jrs.get_cat_rpts
Description: get reports and catalogs (deprecated since version 6.0, replaced by jrs.get_cat_rpts_new)
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_cat_rpts
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_cat_rpts
Response: resource nodes list- jrs.get_cat_rpts_new
Description: get all resource nodes (folder, catalog, report and result) of a folder
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_cat_rpts_new&jrs.path=RESOURCENODE
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_cat_rpts_new&jrs.path=/hsqlDemo
Response: resource nodes list- jrs.get_node_prop
Description: get the properties of a resource node
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_node_prop&jrs.path=RESOURCENODE
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_node_prop&jrs.path=/hsqlDemo/Tutorial.cat
Response: resource node properties- jrs.delete_resource
Description: delete the resource node from resource tree
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.delete_resource&jrs.path=RESOURCENODE
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.delete_resource&jrs.path=/hsqlDemo/Invoice.cls- jrs.get_rst_vers
Description: get result versions list of the report
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_rst_vers&jrs.catalog=CATALOG&jrs.report=REPORT
(Deprecated)http://HOST:PORT/jrserver/REPORT?jrs.cmd=jrs.get_rst_vers
URL Example: http://localhost:8888/jrserver?jrs.cmd=jrs.get_rst_vers&jrs.catalog=/hsqlDemo/Tutorial.cat&jrs.report=/hsqlDemo/Invoice.cls
(Deprecated)http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls?jrs.cmd=jrs.get_rst_vers
Response: result versions list- jrs.get_rpt_vers
Description: get report versions list of the report
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_rpt_vers&jrs.report=REPORT
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_rpt_vers&jrs.report=/hsqlDemo/Invoice.cls
Response: report versions list- jrs.get_cat_vers
Description: get catalog versions list of the catalog
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_cat_vers&jrs.catalog=CATALOG
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_cat_vers&jrs.catalog=/hsqlDemo/Tutorial.cat
Response: catalog versions list- jrs.get_rst_doc_vers
Description: get result versions list of the result doc, the result doc can be generated by advanced running or scheduling a report
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_rst_doc_vers&jrs.result=RESULT
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_rst_doc_vers&jrs.result=/hsqlDemo/Invoice
Response: result versions list- jrs.get_ver_rst_page
Description: get a result version of the report in the version manager
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_ver_rst_page&jrs.file=FILE_NAME
(Deprecated)http://HOST:PORT/jrserver/REPORT?jrs.cmd=jrs.get_ver_rst_page&jrs.file=FILE_NAME
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_ver_rst_page&jrs.file=1%5cadmin1071108105020%5cadmin1071108105020.rst(Deprecated)http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls?jrs.cmd=jrs.get_ver_rst_pageResponse: the result file in version manager
&jrs.file=1%5cadmin1071108105020%5cadmin1071108105020.rst>
- jrs.get_ver_rst
Description: get a HTML page to view a result version of the report with the ViewerApplet
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver/REPORT?jrs.cmd=jrs.get_ver_rst&jrs.file=FILE_NAME
URL Example:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls?jrs.cmd=jrs.get_ver_rst
&jrs.file=1%5cadmin1071108105020%5cadmin1071108105020.rst
Response: HTML page to view the result file with the ViewerApplet- jrs.get_large_reports
Description: get the list of large reports. (deprecated since version 6.0, replaced by jrs.get_ondemands)
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_large_reports
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_large_reports
Response: large report list- jrs.get_ondemands
Description: get the list of on-demand reports.
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_ondemands
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_ondemands
Response: on-demand report list- jrs.view_ver_rst
Description: view a result version of the report
HTTP Method: GET/POST
URL Format:
http://HOST:PORT/jrserver/REPORT?jrs.cmd=jrs.view_ver_rst&jrs.hist_file= RESULT_VERSION_FILE_NAME&jrs.result_type=RESULT_TYPE&jrs.applet_type= APPLET_TYPE[&jrs.isjrsapltpg=TRUE/FALSE][&jrs.is_multi_files=TRUE/FALSE] [&jrs.is_applet_chart=TRUE/FALSE][&jrs.has_hyperlink=TRUE/FALSE] [&jrs.has_page_number=TRUE/FALSE][&jrs.use_table=TRUE/FALSE] [&jrs.drilldown=TRUE/FALSE][&jrs.relative_font_size=TRUE/FALSE][&jrs.no_margin_html= TRUE/FALSE][&jrs.web_browser=BROWSER_TYPE][&jrs.no_margin_pdf=TRUE/FALSE] [&jrs.is_norm_txt=TRUE/FALSE][&jrs.delimiter=DELIMITER] [&jrs.udchar_width=NUMBER][&jrs.udchar_height=NUMBER][&jrs.no_margin_ps=TRUE/FALSE] [&jrs.no_margin_rtf=TRUE/FALSE]
URL Example:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls?jrs.cmd=jrs.view_ver_rst&jrs.hist_file=1%5 cadmin1071108105020%5cadmin1071108105020.rst&jrs.result_type=1
Note:
RESULT_TYPE:
0 - To Applet
1 - To HTML
2 - To PDF
3 - To TEXT
4 - To Excel
5 - To Postscript
6 - To Rich Text Format
7 - To XML
8 - To DHTML
APPLET_TYPE:
0 - Normal (deprecated since version 5.2)
1 - Java Plug-In 1.1.1 for Windows (deprecated since version 5.2)
2 - Java Plug-In 1.2 for Windows
3 - Java Plug-In 1.3 for Windows
BROWSER_TYPE:
0 - IE
1 - Netscape- jrs.get_rpt_desc_page
Description: get an HTML page in order to enter parameter values and choose the result type of the report
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_rpt_desc_page&jrs.catalog=CATALOG&jrs.report=REPORT
(Deprecated) http://HOST:PORT/jrserver/REPORT?jrs.cmd=jrs.get_rpt_desc_page
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_rpt_desc_page&jrs.catalog=/hsqlDemo/Tutorial.cat&jrs.report=/hsqlDemo/Invoice.cls
(Deprecated)http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls?jrs.cmd=jrs.get_rpt_desc_page- jrs.get_rpt_param_page
Description: get an HTML page in order to enter parameter values of the report
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_rpt_param_page&jrs.catalog=CATALOG&jrs.report=REPORT
(Deprecated)http://HOST:PORT/jrserver/REPORT?jrs.cmd=jrs.get_rpt_param_page
URL Example:
http://localhost:8888/jrserver?jrs.cmd=jrs.get_rpt_param_page&jrs.catalog=/hsqlDemo/Tutorial.cat&jrs.report=/hsqlDemo/Invoice.cls
(Deprecated)http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls?jrs.cmd=jrs.get_rpt_param_page- jrs.del_rpt_ver
Description: delete a result version of the report
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver/REPORT?jrs.cmd=jrs.del_rpt_ver&jrs.version_id=VERSION_ID
URL Example:http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls?jrs.cmd=jrs.del_rpt_ver&jrs.version_id=103- jrs.get_ver_param
Description: get the parameter file of a report's result version
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver/REPORT?jrs.cmd=jrs.get_ver_param&jrs.version_id=VERSION_ID
URL Example:http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls?jrs.cmd=jrs.get_ver_param&jrs.version_id=103- jrs.web_vw
Description: run the report and view its result in a Web browser
HTTP Method: GET/POST
URL Format:
http://HOST:PORT/jrserver/REPORT?jrs.cmd=jrs.web_vw&jrs.result_type= RESULT_TYPE[&jrs.param$NAME=VALUE&jrs.param$NAME=VALUE...]&jrs.applet_type= APPLET_TYPE[&jrs.isjrsapltpg=TRUE/FALSE][&jrs.is_multi_files=TRUE/FALSE] [&jrs.is_applet_chart=TRUE/FALSE][&jrs.has_hyperlink=TRUE/FALSE] [&jrs.has_page_number=TRUE/FALSE][&jrs.use_table=TRUE/FALSE][&jrs.drilldown=TRUE/FALSE] [&jrs.relative_font_size=TRUE/FALSE][&jrs.no_margin_html=TRUE/FALSE] [&jrs.web_browser=BROWSER_TYPE][&jrs.no_margin_pdf=TRUE/FALSE][&jrs.is_norm_txt=TRUE/FALSE] [&jrs.delimiter=DELIMITER][&jrs.udchar_width=NUMBER][&jrs.udchar_height=NUMBER] [&jrs.no_margin_ps=TRUE/FALSE][&jrs.no_margin_rtf=TRUE/FALSE][&jrs.use_def_db_user=TRUE/FALSE] [&jrs.db_user=DB_USER][&jrs.db_pswd=DB_PASSWORD][&jrs.jdbc_url=JDBC_URL] [&jrs.jdbc_driver=JDBC_DRIVER][&jrs.rpt_language=RPT_LANGUA GE][&jrs.rpt_encoding=RPT_ENCODING][&jrs.wp=DBField='value'][&jrs.named_wp=ExistedWhereportion]
URL Example:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls?jrs.cmd= jrs.web_vw&jrs.result_type=1&jrs.param$TERMSDAYS=30&jrs.param$PTODAY=May 21, 1998&jrs.is_multi_files=true&jrs.is_applet_chart=true&jrs.use_def_db_user= false&jrs.db_user=dba&jrs.db_pswd=123456&jrs.rpt_language=en
Note:
RESULT_TYPE:
0 - To Applet
1 - To HTML
2 - To PDF
3 - To TEXT
4 - To Excel
5 - To Postscript
6 - To Rich Text Format
7 - To XML
8 - To DHTML
APPLET_TYPE:
0 - Normal (deprecated since version 5.2)
1 - Java Plug-In 1.1.1 for Windows (deprecated since version 5.2)
2 - Java Plug-In 1.2 for Windows
3 - Java Plug-In 1.3 for Windows
BROWSER_TYPE:
0 - IE
1 - Netscape
Set parameter values of the report: use jrs.param$NAME=VALUE to set parameter values of the report. The NAME is the parameter name and the VALUE is the URL-encoded parameter value. For Example: jrs.param$TERMSDAYS=30&jrs.param$PTODAY=May 21, 1998
If you want to define a new whereportion from the URL, you can choose the property "jrs.wp". For example, the report has a DBfield "Customer Region", and you want to restrict the field "Customer Region" to "CA" in the URL, then you can set a new whereportion like "...jrs.result_type=1&jrs.is_applet_chart=true&jrs.wp=Customers.Region='CA'..."
If you want to set an existing whereportion in the URL, you should use the property "jrs.named_wp". For example, to set the existed whereportion "Region" from URL, you can try "...jrs.result_type=1&jrs.is_applet_chart=true&jrs.named_wp=Region...". Here "Region" is the whereportion's name.- jrs.try_vw
Description: try to view a report in a web browser. If the report has no parameters then directly run and view the report (similar to the command jrs.web_vw). If the report has parameters then the Server returns the report description page to enter parameter values and choose the result type of the report (similar to the command jrs.get_rpt_desc_page)
HTTP Method: GET/POST
URL Format:
http://HOST:PORT/jrserver/REPORT?jrs.cmd=jrs.try_vw&jrs.result_type=RESULT_TYPE &jrs.applet_type=APPLET_TYPE[&jrs.isjrsapltpg=TRUE/FALSE][&jrs.is_multi_files=TRUE/FALSE] [&jrs.is_applet_chart=TRUE/FALSE][&jrs.has_hyperlink=TRUE/FALSE] [&jrs.has_page_number=TRUE/FALSE][&jrs.use_table=TRUE/FALSE] "[&jrs.drilldown=TRUE/FALSE][&jrs.relative_font_size=TRUE/FALSE] [&jrs.no_margin_html=TRUE/FALSE][&jrs.web_browser=B ROWSER_TYPE][&jrs.no_margin_pdf=TRUE/FALSE] [&jrs.is_norm_txt=TRUE/FALSE][&jrsd.elimiter=DELIMITER] [&jrs.udchar_width=NUMBER][&jrs.udchar_height=NUMBER][&jrs.no_margin_ps=TRUE/FALSE] [&jrs.no_margin_rtf=TRUE/FALSE][&jrs.use_def_db_user=TRUE/FALSE][&jrs.db_user=DB_USER] [&jrs.db_pswd=DB_PASSWORD][&jrs.jdbc_url=JDBC_URL][&jrs.jdbc_driver=JDBC_DRIVER] [&jrs.rpt_language=RPT_LANGUAGE][&jrs.rpt_encoding=RPT_ENCODING] [&jrs.wp=DBField='value'][&jrs.named_wp=ExistedWhereportion]
URL Example:http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/customerlist.cls?jrs.cmd=jrs.try_vw&jrs.result_type=1
Note:
RESULT_TYPE:
0 - To Applet
1 - To HTML
2 - To PDF
3 - To TEXT
4 - To Excel
5 - To Postscript
6 - To Rich Text Format
7 - To XML
8 - To DHTML
APPLET_TYPE:
0 - Normal (deprecated since version 5.2)
1 - Java Plug-In 1.1.1 for Windows (deprecated since version 5.2)
2 - Java Plug-In 1.2 for Windows
3 - Java Plug-In 1.3 for Windows
BROWSER_TYPE:
0 - IE
1 - Netscape- jrs.get_schedules
Description: get the schedules list
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_schedules
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_schedules- Another method for getting the result file
Description: get the result files through the directory when a report is viewed with a Web browser.
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver/REPORT/result/FILENAME
URL Examples:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls/result/10577952770_1.html
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls/result/10577952770_1.pdf
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls/result/10577952770_1.txt- jrs.del_schedule
Description: delete a schedule
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.del_schedule&jrs.task_id=TASK_ID
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.del_schedule&jrs.task_id=2003-12-11 11:09:16.455- jrs.enable_schedule
Description: enable a schedule
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.enable_schedule&jrs.task_id=TASK_ID
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.enable_schedule&jrs.task_id=2003-12-11 11:09:16.455- jrs.disable_schedule
Description: disable a schedule
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.disable_schedule&jrs.task_id=TASK_ID
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.disable_schedule&jrs.task_id=2003-12-11 11:09:16.455- jrs.get_new_schd_page
Description: get a HTML page in order to create a new schedule for the report with a web browser
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_new_schd_page&jrs.catalog=CATALOG&jrs.report=REPORT
(Deprecated)http://HOST:PORT/jrserver/REPORT?jrs.cmd=jrs.get_new_schd_page
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_new_schd_page&jrs.catalog=/hsqlDemo/Tutorial.cat&jrs.report=/hsqlDemo/Invoice.cls
(Deprecated)http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Invoice.cls?jrs.cmd=jrs.get_new_schd_page- jrs.get_edit_schd_page
Description: get an HTML page in order to edit the schedule with a Web browser
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_edit_schd_page&jrs.task_id=TASK_ID
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_edit_schd_page&jrs.task_id=2003-12-11 11:13:23.02- jrs.get_completed
Description: get the completed tasks list
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_completed
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_completed- jrs.del_completed
Description: delete a completed task
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.del_completed&jrs.id=RECORD_ID
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.del_completed&jrs.id=1071119897006-154848108- jrs.del_all_completed
Description: delete all completed tasks
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.del_all_completed
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.del_all_completed- jrs.get_active
Description: get the active tasks list
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_active
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_active- jrs.stop_task
Description: stop an active task
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.stop_task&jrs.task_id=TASK_ID
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.stop_task&jrs.task_id= 2003-12-11 11:13:23.02- jrs.get_change_password_page
Description: get an HTML page in order to change the password with a Web browser
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_change_password_page
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_change_password_page- jrs.change_password
Description: change the password for a user
HTTP Method: POST
Form Action:http://HOST:PORT/jrserver?jrs.cmd=jrs.change_password
Content Type : application/x-www-form-urlencoded
Content: jrs.cmd=jrs.change_password&jrs.uid=admin&jrs.password=CURRENT_PASSWORD&jrs.new_passw
ord=NEW_PASSWORD&jrs.confirm_new_password=NEW_PASSWORD
Content Example: jrs.cmd=jrs.change_password&jrs.uid=admin&jrs.password=ad&jrs.new_password=1234&jrs.confirm_new_password=1234- jrs.get_preference_page
Description: get an HTML page in order to change the user preference setting with a Web browser
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.get_preference_page
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.get_preference_page- jrs.logout
Description: log out from the JRServlet
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.logout
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.logout- jrs.login
Description: log in into the JRServlet from a login dialog with web browsers or JRViewer.
HTTP Method: GET/POST
URL Format:http://HOST:PORT/jrserver?jrs.cmd=jrs.login
URL Example:http://localhost:8888/jrserver?jrs.cmd=jrs.login
- jrs.authorization
Tag of the HTTP query field: jrs.authorization
Description: load the JRServlet and avoid the login dialog in web browsers.
Format of the value of the HTTP query field: Base64-encoded(userID:password)
URL Example: userID="admin", password="admin"
then Base64-encoded("admin:admin")="YWRtaW46YWRtaW4="
then URL-encoded("YWRtaW46YWRtaW4=")="YWRtaW46YWRtaW4%3D"
The URL:http://localhost:8888/jrserver?jrs.cmd=jrs.get_subnodes&jrs.authorization=YWRtaW46YWRtaW4%3D
Note: JRServlet does not check security when a HTTP request has no jrs.cmd in the HTTP query in the root path of the JRServlet, so JRServlet does not accept the jrs.authorization for the requesthttp://localhost:8888/jrserver?jrs.authorization=YWRtaW46YWRtaW4%3D- jrs.auth_uid and jrs.auth_pwd
Tags of HTTP query field: jrs.auth_uid and jrs.auth_pwd
Description: load the JRServlet and avoid the login dialog in web browsers.
Format of the value of the HTTP query field: jrs.auth_uid=USER_ID, jrs.auth_pwd=PASSWORD
URL Example: userID="admin", password="admin"
The URL:http://localhost:8888/jrserver/hsqlDemo?jrs.cmd=jrs.get_subnodes&jrs.auth_uid=admin&jrs.auth_pwd=admin
Note: JRServlet does not check security when a HTTP request has no jrs.cmd in the HTTP query in the root path of the JRServlet, so JRServlet do not accept the jrs.auth_uid and jrs.auth_pwd for the requesthttp://localhost:8888/jrserver?jrs.auth_uid=admin&jrs.auth_pwd=admin
- In HTML pages:
Specify the POST as the method of a form in an HTML page.- Using JRClient API or JRViewer Bean:
Three methods: usePostAsDefaultMethod(), useGetAsDefaultMethod() and ifUsePostAsDefaultMethod() can be used in the class jet.client.api.JRClient.- In java program:
For example:
URL url = new URL("http://jrserver:8888"); URLConnection uc = url.getConnection(); if (uc instanceof HttpURLConnection) { HttpURLConnection huc = (HttpURLConnection)uc; //set use POST method. huc.setRequestMethod("POST"); huc.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); huc.setDoOutput(true); //write the HTTP query to the output stream. OutputStreamWriter writer = new OutputStreamWriter(huc.getOutputStream()); writer.write("jrs.cmd=jrs.get_subnodes"); writer.close(); huc.getHeaderField(0); //get the response content from the Server. InputStream inStream = uc.getInputStream(); if (inStream != null) { BufferedReader reader = new BufferedReader(new InputStreamReader(inStream)); String inputLine; while (null != (inputLine = reader.readLine())) { System.out.println(inputLine); } } }
With these commands, you can switch the connection in the same database or between different databases at runtime. If the databases have the same structure, you will be free from the work of building another similar catalog. Instead, use switch database commands to set the JDBC connection or change the username/password to connect with another database.
Note: The two databases that you want to switch should share the same table structure. Otherwise, you will see no data after switching to the new database.
- Set the Oracle database named oracle815 connection when designing the report Report1.cls, and later switch the connection to the Oracle database named demo at run time.
The URL for switching the connection:http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Report.cls?jrs.cmd=jrs.try_vw&jrs.result_type=1&jrs.jdbc_url=jdbc:oracle:t hin:@host:1521:demo- Specify the user ID system/manager to ensure the security when designing the report Report1.cls, and want to switch to the user ID Scott and the password tiger.
The URL for switching the user ID and password:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Report1.cls?jrs.cmd=jrs.try_vw&jrs.result_type=1&jrs.db_user=Scott&jrs.db_pswd=tiger- Set the Sybase 12 database named master when designing the report Report1.cls, and later switch the connection to the Sybase 12 database named product at runtime.
The URL for switching the connection:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Report1.cls?jrs.cmd=jrs.try_vw&jrs.result_type=1
&jrs.jdbc_url=jdbc:sybase:Tds:host:5000/product- Set the SQL database named MBA2000 when designing the report Report1.cls, and later switch the connection to the SQL database named JTTest at runtime.
The URL for switching the connection:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Report1.cls?jrs.cmd=jrs.try_vw&jrs.result_type=1
&jrs.jdbc_url=jdbc:inetdae:host:1433?database=JTTest&sql7=true
- Set oracle815 connection when designing the report Report1.cls, and want to switch the connection to Access database with the JdbcOdbcDriver named products at runtime.
The URL for switching the connection:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Report1.cls?jrs.cmd=jrs.try_vw&jrs.result_type=1&jrs.jdbc_driver=sun.jd
bc.odbc.JdbcOdbcDriver&jrs.jdbc_url=jdbc:odbc:products- Set oracle815 connection when designing the report Report1.cls, and want to switch the connection to SQL server database named products at runtime.
The URL for switching the connection:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/Report1.cls?jrs.cmd=jrs.try_vw&jrs.result_type=1
&jrs.jdbc_driver=com.inet.tds.TdsDriver&jrs.jdbc_url=jdbc:inetdae:JT_P05:1433?database=products&sql7=true
Use the below commands to schedule reports via URL in a Web browser.
jrs.submit_schedule
Constant: jet.cs.util.APIConst.CMD_SUBMIT_SCHEDULE
Description: submit a scheduled task to JReport Enterprise Server
HTTP Method: GET/POST
URL Example:
http://localhost:8888/jrserver?jrs.cmd=jrs.submit_schedule&jrs.catalog=%2fhsqlDemo%2fTutorial.cat &jrs.task_class=jet.server.schedule.jrtasks.UpdateRptTask&jrs.launch_type=0 &jrs.param$PToday=May%2021%2c%201998&jrs.uid=admin&jrs.param_file=true&jrs.param$TermsDays=30& jrs.expire_days=30&jrs.report=Invoice.cls
Response: Returns the task ID for JRClient API. Returns the scheduled tasks page for web browsers.
A schedule contains two kinds of properties. The first is about the time information. The second is about the task information.
Time:
Following are details for each property in the above table:
jrs.launch_type
Constant: jet.cs.util.APIConst.TAG_LAUNCH_TYPE
Description: indicates running reports immediately, at a specific time or periodically.
Possible values: {0, 1, 8}; 0 - run immediately, 1 - run at time, 8 - run periodicallyjrs.timezone
Constant: jet.cs.util.APIConst.TAG_TIMEZONE
Description: indicates the timezone of the time.
Possible values: timezone ID strings of java default is current locale.
jrs.exe_year
Constant: jet.cs.util.APIConst.TAG_EXE_YEAR
Description: indicates to run in which year.
Possible values: 1980-2099jrs.exe_month
Constant: jet.cs.util.APIConst.TAG_EXE_MONTH
Description: indicates to run in which month.
Possible values: 1-12jrs.exe_day
Constant: jet.cs.util.APIConst.TAG_EXE_DAY
Description: indicates to run on which day.
Possible values: 1-31jrs.exe_hour
Constant: jet.cs.util.APIConst.TAG_EXE_HOUR
Description: indicates to run which hour in a day (when jrs.is_hourly is false).
Possible values: 0-23hourjrs.exe_min
Constant: jet.cs.util.APIConst.TAG_EXE_MIN
Description: indicates to run which minute in a hour (when jrs.is_hourly is false).
Possible values: 0-59minute
jrs.days_id
Constant: jet.cs.util.APIConst.SCH_DAYS_ID
Description: indicates if the schedule will run daily, weekly or monthly.
Possible values: 0 - daily; 1 - weekly; 2 - monthly
jrs.is_weekday
Constant: jet.cs.util.APIConst.SCH_IS_WEEKDAY
Description: indicates whether to run a report on a specific weekday (i.e. Monday - Friday).
Possible values: {true, false} default is false.jrs.day
Constant: jet.cs.util.APIConst.SCH_DAY
Description: indicates every how many days to run (when daily is selected and jrs.is_weekday is false).
Possible values: 1-999
jrs.week
Constant: jet.cs.util.APIConst.SCH_WEEK
Description: indicates every how many weeks to run (when weekly is selected).
Possible values: 1-99 weeksjrs.weekdays
Constant: jet.cs.util.APIConst.SCH_WEEKDAYS
Description: indicates on which day to run in a week (when weekly is selected).
Possible values: a digit string. {0, 1...5, 6} means {Sunday, Monday...Friday, Saturday}.Example: jrs.weekdays=05 means running on Sunday and Friday.
jrs.is_day
Constant: jet.cs.util.APIConst.SCH_IS_DAY
Description: indicates if to run on xth day in a month (when monthly is selected).
Possible values: {true, false} default is true.jrs.day
Constant: jet.cs.util.APIConst.SCH_DAY
Description: indicates to run on xth day in a month (when monthly is selected and jrs.is_day is true).
Possible values: 1th-31th default is 1.jrs.week
Constant: jet.cs.util.APIConst.SCH_WEEK
Description: indicates to run on xth week in a month (when monthly is selected and jrs.is_day is false).
Possible values: 0 - first, 1 - second, 2 - third, 3 - fourth, 4 - last week default is 0.jrs.weekday
Constant: jet.cs.util.APIConst.SCH_WEEKDAY
Description: indicates to run on which day in a week (when monthly is selected and jrs.is_day is false).
Possible values: {1, 2...6, 7} means {Sunday, Monday...Friday, Saturday} default is 7.jrs.month
Constant: jet.cs.util.APIConst.SCH_MONTH
Description: indicates every how many months to run.
Possible values: 1-6 months default is 1.
jrs.is_hourly
Constant: jet.cs.util.APIConst.SCH_IS_HOURLY
Description: indicates whether to run the schedule every hour.
Possible values: {true, false} default is true.jrs.hour
Constant: jet.cs.util.APIConst.SCH_HOUR
Description: indicates to run at which hour in a day (when jrs.is_hourly is false).
Possible values: 1-12hour default is 1.jrs.min
Constant: jet.cs.util.APIConst.SCH_MIN
Description: indicates to run at which minute in a hour (when jrs.is_hourly is false).
Possible values: 0-59minute default is 0.jrs.is_pm
Constant: jet.cs.util.APIConst.SCH_IS_PM
Description: indicates whether to run PM or AM in a day (when jrs.is_hourly is false).
Possible values: {true, false} default is true.jrs.hours
Constant: jet.cs.util.APIConst.SCH_HOURS
Description: indicates every how many hours to run (when jrs.is_hourly is true).
Possible values: 1-99 hours default is 1.jrs.at_min
Constant: jet.cs.util.APIConst.SCH_AT_MIN
Description: indicates to run at which minute in an hour (when jrs.is_hourly is true).
Possible values: 0-59minute default is 0.jrs.is_between
Constant: jet.cs.util.APIConst.SCH_IS_BETWEEN
Description: indicates whether to run between the start time and the finish time (when jrs.is_hourly is true).
Possible values: {true, false}
jrs.is_minutely
Constant: jet.cs.util.APIConst.SCH_IS_MINUTELY
Description: indicates whether to run the schedule every minute.
Possible values: {true, false}
jrs.minutes
Constant: jet.cs.util.APIConst.SCH_MINUTES
Description: indicates every how many minutes to run (when jrs.is_hourly is false and jrs.is_minutely is true).
Possible values: 1-999.Note: The property jrs.is_hourly has higher priority, that is, if you set both jrs.is_hourly and jrs.is_minutely to be true, the schedule will run the task based hour.
jrs.hour
Constant: jet.cs.util.APIConst.SCH_HOUR
Description: indicates the start hour of a period of time (when jrs.is_hourly is true, jrs.is_between is true).
Possible values: 1-12hourjrs.min
Constant: jet.cs.util.APIConst.SCH_MIN
Description: indicates the start minute of a period of time (when jrs.is_hourly is true, jrs.is_between is true).
Possible values: 0-59minutejrs.is_pm
Constant: jet.cs.util.APIConst.SCH_IS_PM
Description: indicates the start PM or AM of a period of time (when jrs.is_hourly is true, jrs.is_between is true).
Possible values: {true, false}jrs.hour2
Constant: jet.cs.util.APIConst.SCH_HOUR2
Description: indicates the finish hour of a period of time (when jrs.is_hourly is true, jrs.is_between is true).
Possible values: 1-12hour default is 5.jrs.min2
Constant: jet.cs.util.APIConst.SCH_MIN2
Description: indicates the finish minute of a period of time (when jrs.is_hourly is true, jrs.is_between is true).
Possible values: 0-59minute default is 0.jrs.is_pm2
Constant: jet.cs.util.APIConst.SCH_IS_PM2
Description: indicates the finish PM or AM of a period of time (when jrs.is_hourly is true, jrs.is_between is true).
Possible values: {true, false}jrs.is_after
Constant: jet.cs.util.APIConst.SCH_IS_AFTER
Description: indicates to run after the specific time (when jrs.is_hourly or jrs.is_minutely is true)
Possible value: true, false
Note: If the value is true, the specified time is represented by the properties of jrs.exe_year, jrs.exe_month, jrs.exe_day, jrs.exe_hour or jrs.exe_min.jrs.is_before
Constant: jet.cs.util.APIConst.SCH_IS_BEFORE
Description: indicates to run before the specific time (when jrs.is_hourly or jrs.is_minutely is true)
Possible value: true, false
Note: If the value is true, the specified time is represented by the properties of jrs.cease_year, jrs.cease_month, jrs.cease_day, jrs.cease_hour, jrs.cease_min or jrs.cease_sec.
Task:
| Properties | Values | Properties | Values | Properties | Values | |
|---|---|---|---|---|---|---|
| jrs.task_class | jet.server.schedule .jrtasks.UpdateRptTask |
jrs.expire_days | any integar | |||
| jet.server.schedule .jrtasks.PublishToDiskTask |
Rst | jrs.rst_dir | any path under Resourse Tree | |||
| jrs.rst | rst file name | |||||
| Html | jrs.html_dir | any path under Resourse Tree | ||||
| jrs.html | html file name | |||||
| jrs.is_dhtml | true/false | |||||
| jrs.is_multi_files | true/false | |||||
| jrs.is_applet_chart | true/false | |||||
| jrs.has_hyperlink | true/false | |||||
| jrs.has_page_number | true/false | |||||
| jrs.use_table | true/false | |||||
| jrs.relative_font_size | true/false | |||||
| jrs.drilldown | true/false | |||||
| jrs.no_margin_html | true/false | |||||
| jrs.web_browser | 0 - IE | |||||
| 1 - Netscape | ||||||
| jrs.pdf_dir | any path under Resourse Tree | |||||
| jrs.pdf | pdf file name | |||||
| jrs.no_margin_pdf | true/false | |||||
| jrs.compress_image_pdf | true/false | |||||
| jrs.print_mode_pdf | true/false | |||||
| Text | jrs.text_dir | any path under Resource Tree | ||||
| jrs.text | text file name | |||||
| jrs.is_norm_txt | text file in standard data format | |||||
| jrs.delimiter | any character used in SDF (Standard Data Format) format | |||||
| jrs.is_repeat | true/false | |||||
| jrs.udchar_width | user defined width | |||||
| jrs.udchar_height | user defined height | |||||
| jrs.is_quotemark | true/false | |||||
| jrs.hasHeadFoot | true/false | |||||
| jrs.txt_compress | true/false | |||||
| Excel | jrs.excel_dir | any path under Resource Tree | ||||
| jrs.excel | excel file name | |||||
| Ps | jrs.ps_dir | any path under Resource Tree | ||||
| jrs.ps | ps file name | |||||
| jrs.no_margin_ps | true/false | |||||
| Rtf | jrs.rtf_dir | any path under Resourse Tree | ||||
| jrs.rtf | rtf file name | |||||
| jrs.no_margin_rtf | true/false | |||||
| xml | jrs.xml_dir | any path under Resourse Tree | ||||
| jrs.xml | xml file name | |||||
| jrs.is_only_data | true/false | |||||
| jet.server.schedule .jrtasks.SendJRMailTask |
jrs.jrmail + NUMBER | integer and followed by its properties | jrs.mailto | mail address | ||
| jrs.mailcc | mail address | |||||
| jrs.mailbcc | mail address | |||||
| jrs.mailsubject |
subject for this mail | |||||
| jrs.mailcomments | any comment for this mail | |||||
| jrs.mailformat |
0 - HTML mail | |||||
| 1 - Plain text mail | ||||||
| 2 - HTML file as attachment | ||||||
| 3 - PDF file as attachment | ||||||
| 4 - JReport .rst file as attachment | ||||||
| 5 - Delimited text as attachment | ||||||
| 6 - PostScript File as attachment | ||||||
| 7 - Excel file as attachment | ||||||
| 8 - RTF file as attachment | ||||||
| 9 -XML file as attachment | ||||||
| jrs.mailcompress | true/false | |||||
| jrs.udchar_width | integer | |||||
| jrs.udchar_height | integer | |||||
| jrs.no_margin_mail | true/false | |||||
| jrs.use_table_mail | true/false | |||||
| jet.server.schedule .jrtasks.SendMailTask |
jrs.csmail + NUMBER | integer and followed by its properties | jrs.mailto | mail address | ||
|
|
|
|
jrs.mailcc | mail address | ||
| jrs.mailbcc | mail address | |||||
| jrs.mailsubject | subject for this mail | |||||
| jrs.mailcomments | any comment for this mail | |||||
| jrs.mailattach + NUMBER | integar and followed by the attached file | |||||
| jet.server.schedule .jrtasks.PrintRptTask |
jrs.printer | printer name and followed by its properties | jrs.print.copies | integer | ||
| jrs.print.leftmargin | integer and followed by its unit | |||||
| jrs.print.rightmargin | integer and followed by its unit | |||||
| jrs.print.topmargin | integer and followed by its unit | |||||
| jrs.print.bottommargin | integer and followed by its unit | |||||
| jrs.print.unit | unit name | |||||
| jrs.print.customtray | custom tray name | |||||
| Public Properties | ||||||
| jrs.task_id | task ID of a scheduled task | |||||
| *jrs.catalog | catalog full path | |||||
| *jrs.report | report name | |||||
| jrs.param$ + PARAMETER_NAME | parameter values | |||||
| jrs.param_values | parameter values | |||||
| jrs.rpt_language | report language | |||||
| jrs.rpt_encoding | report encoding | |||||
| jrs.db_user | database user ID | |||||
| jrs.db_pswd | database password | |||||
| jrs.jdbc_url | JDBC URL | |||||
| jrs.jdbc_driver | JDBC driver | |||||
| jrs.jdbc_connection_object | the user's connection object | |||||
| jrs.wp | where portion | |||||
| jrs.named_wp | existed where portion in catalog | |||||
| **jrs.if_print | true/false | |||||
| **jrs.printer | printer name | |||||
| jrs.notification_emails | email notification list | |||||
| jrs.success_notify | true/false | |||||
| jrs.fail_notify | true/false | |||||
| Note:
The two public properties marked with * are applied to the whole schedule tasks except the task property jrs.csmail + NUMBER. Only the two public properties marked with ** are effective when you use the task property jrs.csmail + NUMBER. |
||||||
Following are details for each property in the above table:
- jrs.task_class
Constant: jet.cs.util.APIConst.TAG_TASK_CLASS
Description: indicates the class name of the task.
Possible values:
"jet.server.schedule.jrtasks.UpdateRptTask",
"jet.server.schedule.jrtasks.PublishToDiskTask",
"jet.server.schedule.jrtasks.SendJRMailTask",
"jet.server.schedule.jrtasks.SendMailTask",
"jet.server.schedule.jrtasks.PrintRptTask".- jrs.has_task_listener
Constant: jet.cs.util.APIConst.TAG_HAS_TASK_LISTENER
Description: indicates whether users implemented TaskListener
Possible value: true, false- jrs.task_listener_class
Constant: jet.cs.util.APIConst.TAG_TASK_LISTENER_CLASS
Description: indicates that user's java class name implemented TaskListener(jrs.task_listener_class).
Possible value: a class name (String)- jrs.task_id
Constant: jet.cs.util.APIConst.TAG_TASK_ID
Description: indicates the task ID of a scheduled task if you want to modify it (this property is unnecessary if a new schedule is submitted).- jrs.catalog
Constant: jet.cs.util.APIConst.TAG_CATALOG
Description: indicates the catalog's full path.
Example: /hsqlDemo/Tutorial.cat- jrs.report
Constant: jet.cs.util.APIConst.TAG_REPORT
Description: indicates the report name.
Example: Invoice.cls- jrs.param$ + PARAMETER_NAME
Constant: jet.cs.util.APIConst.TAG_PARAM_PREFIX + PARAMETER_NAME
Description: indicates parameter values for running the report.
Example: jrs.param$PToday=May+21%2c+1998- jrs.param_values
Constant: jet.cs.util.APIConst.TAG_PARAM_VALUES
Description: indicates parameter values for running the report. This is the escaped string of the parameter values of the report.
Format: PARAMETER_NAME=VALUE,PARAMETER_NAME=VALUE,...
Examples: jrs.param_values=PTODAY%3dMay%2021%5c%2c%201998%2cTERMSDAYS%3d30 (original: PTODAY=May 21\, 1998,TERMSDAYS=30)
jrs.param_values=STARTDATE%3d1998-05-10%2cENDDATE%3d1998-07-10 (original: STARTDATE=1998-05-10,ENDDATE=1998-07-10)- jrs.rpt_language
Constant: jet.cs.util.APIConst.TAG_REPORT_LANGUAGE
Description: indicates the language for generating the report. The value you set for this command should be consistent with the language and country code part of the language property file name (e.g., de_DE in "ReportName_de_DE. properties"). For example, if the language property file is named as "ReportName_de_DE. properties", please set this command asjrs.rpt_language=de_DE. You can also usejrs.rpt_language=de&jrs.rpt_country=DEto achieve the same goal. If you want to usejrs.rpt_language=deonly, then you need to rename the language property file to "ReportName_de. properties".- jrs.rpt_encoding
Constant: jet.cs.util.APIConst.TAG_REPORT_ENCODING
Description: indicates the encoding for generating the report.- jrs.db_user
Constant: jet.cs.util.APIConst.TAG_DB_USER
Description: indicates the new database user ID if you do not want to use the default DB user ID stored in the catalog.- jrs.db_pswd
Constant: jet.cs.util.APIConst.TAG_DB_PSWD
Description: indicates the new database password if you do not want to use the default DB password in the catalog.- jrs.jdbc_url
Constant: jet.cs.util.APIConst.TAG_JDBC_URL
Description: indicates the new JDBC URL in the catalog to run a report.- jrs.jdbc_driver
Constant: jet.cs.util.APIConst.TAG_JDBC_DRIVER
Description: indicates the new JDBC driver in the catalog to run a report.- jrs.jdbc_connection_object
Constant: jet.cs.util.APIConst.TAG_JDBC_CONNECTION_OBJECT
Description: indicates to dynamically use the user's java.sql.Connection object to run a report. This parameter can be used in methods runReport(...), runReportNotWaitResult(...) and submitScheduledTask(...) of jet.server.api.RptServer.
Example: Running a report with user's JDBC connection object by using Report Server API.
//create the java.sql.Connection object. java.sql.Connection myCon = java.sql.DriverManager.getConnection(dbUrl); //set the parameter "jrs.jdbc_connection_object" to run a report. propParams.put("jrs.jdbc_connection_object", myCon); //run the report using this java.sql.Connection object instead of //the default DB settings in the catalog. rptServer.runReport(userID, catalog, report, propParams);- jrs.wp
Constant: jet.cs.util.APIConst.TAG_WHERE_PORTION
Description: indicates the where portion.- jrs.named_wp
Constant: jet.cs.util.APIConst.TAG_NAMED_WHERE_PORTION
Description: indicates the named where portion which exists in the catalog.- jrs.if_print
Constant: jet.cs.util.APIConst.TAG_IF_PRINT
Description: indicates whether to print the report result. The default value is false- jrs.printer
Constant: jet.cs.util.APIConst.TAG_PRINTER
Description: indicates the printer to print the report result.- jrs.mail_to_referuser
Constant: jet.cs.util.APIConst.TAG_MAIL_TO_REFERUSER
Description: indicates whether to send mails to each user who is authorized to view a Page Level Security report.
Possible value: true, false
- jrs.expire_days
Constant: jet.cs.util.APIConst.TAG_EXPIRE_DAYS
Description: indicates expired days of a result version. The default value is 30.
- jrs.rst_dir
Constant: jet.cs.util.APIConst.TAG_RST_DIR
Description: indicates the path for the published JReport result file.
Possible values: /publish_site- jrs.rst
Constant: jet.cs.util.APIConst.TAG_RST
Description: indicates the result filename for the published JReport result file.
Possible values: Invoice.rst- jrs.html_dir
Constant:
jet.cs.util.APIConst.TAG_HTML_DIR
Description: indicates the path for the published HTML file.
Possible values: /publish_site- jrs.html
Constant: jet.cs.util.APIConst.TAG_HTML
Description: indicates the filename for the published HTML file.
Possible values: Invoice.htm- jrs.is_dhtml
Constant: APIConst.TAG_IS_DHTML
Description: indicates whether to generate the DHTML TOC (To HTML).
Possible values: {true, false} default is false.- jrs.is_multi_files
Constant: jet.cs.util.APIConst.TAG_IS_MULTI_FILES
Description: indicates whether html is generated to a file or to multiple files (To HTML).
Possible values: {true, false} default is true.- jrs.is_applet_chart
Constant: jet.cs.util.APIConst.TAG_IS_CHART_APPLET
Description: indicates whether the chart in html file is an applet (To HTML).
Possible values: {true, false} default is true.- jrs.has_hyperlink
Constant: jet.cs.util.APIConst.TAG_HAS_HYPERLINK
Description: indicates whether to generate the hyperlinks in the HTML file (To HTML).
Possible values: {true, false} default is true.- jrs.has_page_number
Constant: jet.cs.util.APIConst.TAG_HAS_PAGE_NUMBER
Description: indicates whether to generate the page number (To HTML).
Possible values: {true, false} default is true.- jrs.use_table
Constant: jet.cs.util.APIConst.TAG_USE_TABLE
Description: indicates whether to use HTML table to generate the HTML page (To HTML).
Possible values: {true, false} default is false- jrs.relative_font_size
Constant: jet.cs.util.APIConst.TAG_RELATIVE_FONT_SIZE
Description: indicates whether to generate HTML pages with relative font size (To HTML).
Possible values: {true, false} default is false.- jrs.drilldown
Constant: jet.cs.util.APIConst.TAG_DRILLDOWN
Description: indicates whether to drilldown the HTML page (To HTML).
Possible values: {true, false} default is false.- jrs.no_margin_html
Constant: jet.cs.util.APIConst.TAG_NO_MARGIN_HTML
Description: indicates whether there is no margin in the HTML page (To HTML).
Possible values: {true, false} default is false.- jrs.web_browser
Constant: jet.cs.util.APIConst.TAG_WEB_BROWSER
Description: indicates generating HTML pages for which Web browser (To HTML).
Possible values: number - 0 means IE, 1 means Netscape default is 0.- jrs.pdf_dir
Constant: jet.cs.util.APIConst.TAG_PDF_DIR
Description: indicates the path of the published PDF file.
Possible values: /publish_site- jrs.pdf
Constant: jet.cs.util.APIConst.TAG_PDF
Description: indicates the filename of the published PDF file.
Possible values: Invoice.rst- jrs.no_margin_pdf
Constant: jet.cs.util.APIConst.TAG_NO_MARGIN_PDF
Description: indicates whether to display no margin (To PDF).
Possible values: {true, false} default is false.- jrs.compress_image_pdf
Constant: jet.cs.util.APIConst.TAG_COMPRESS_IMAGE_PDF Description: indicates the compression ratio of the image in the report (To PDF).
Possible values: {from 1 to 100}default is 20.- jrs.print_mode_pdf
Constant: jet.cs.util.APIConst.TAG_PRINT_MODE_PDF
Description: indicates whether to use Simulated Printing Mode (true) or
Standard Mode (false) (To PDF). The Standard Mode is supported since
version 4.0. By checking it, the exporting speed will be much improved.
Possible values: {true, false} default is false.- jrs.text_dir
Constant: jet.cs.util.APIConst.TAG_TEXT_DIR
Description: indicates the path of the published TXT file.
Possible values: /publish_site- jrs.text
Constant: jet.cs.util.APIConst.TAG_TEXT
Description: indicates the filename of the published PDF file.
Possible values: Invoice.rst- jrs.is_norm_txt
Constant: jet.cs.util.APIConst.TAG_IS_NORMAL_TEXT
Description: indicates whether this text file is a standard data format or not (To TEXT). When it is set to be false, the output format is standard data format.
Possible values: {true, false} default is true.- jrs.delimiter
Constant: jet.cs.util.APIConst.TAG_DELIMITER
Description: A character which will be used in SDF (Standard Data Format) format. A delimiter could be a ',' (the CSV format) or any other characters. The default is ' ' (a blank), that is, the SSV format (To TEXT).- jrs.is_repeat
Constant: jet.cs.util.APIConst.TAG_IS_REPEAT
Description: indicates whether the same content is repeated (To TEXT).
Possible values: {true, false} default is false.- jrs.udchar_width
Constant: jet.cs.util.APIConst.TAG_CHAR_WIDTH
Description: indicates the user defined width. It would be given up if the value is 0 or less than 0 (To TEXT) default is -1.- jrs.udchar_height
Constant: jet.cs.util.APIConst.TAG_CHAR_HEIGHT
Description: indicates the user defined height. It would be given up if the value is 0 or less than 0 (To TEXT) default is -1.- jrs.is_quotemark
Constant: jet.cs.util.APIConst.TAG_IS_QUOTEMARK
Description: indicates whether the quotation marks should be placed in the published text file.
Possible values: {true, false} default is true.- jrs.hasHeadFoot
Constant: jet.cs.util.APIConst.TAG_HASHEADFOOT
Description: indicates whether to generate the page header or footer (To TEXT).
Possible values: {true, false} default is true.- jrs.txt_compress
Constant: jet.cs.util.APIConst.TAG_TXT_COMPRESS
Description: indicates whether to compress the published text file.
Possible values: {true, false} default is false.- jrs.excel_dir
Constant:
jet.cs.util.APIConst.TAG_EXCEL_DIR
Description: indicates the path of the published Excel file.
Possible values: /publish_site- jrs.excel
Constant: jet.cs.util.APIConst.TAG_EXCEL
Description: indicates the filename of the published Excel file.
Possible values: Invoice.rst- jrs.ps_dir
Constant:
jet.cs.util.APIConst.TAG_PS_DIR
Description: indicates the path of the published Postscript file.
Possible values: /publish_site- jrs.ps
Constant: jet.cs.util.APIConst.TAG_PS
Description: indicates the result filename of the published Postscript file.
Possible values: Invoice.rst- jrs.no_margin_ps
Constant: jet.cs.util.APIConst.TAG_NO_MARGIN_PS
Description: indicates whether no margin (To Postscript).
Possible values: {true, false} default is false.- jrs.rtf_dir
Constant: jet.cs.util.APIConst.TAG_PS_DIR
Description: indicates the path of publishing to Rich Text Format.
Possible values: /publish_site- rs.rtf
Constant: jet.cs.util.APIConst.TAG_RTF
Description: indicates the result filename of publishing to Rich Text Format.
Possible values: Invoice.rst- jrs.no_margin_rtf
Constant: jet.cs.util.APIConst.TAG_NO_MARGIN_RTF
Description: indicates whether no margin (To Rich Text Format).
Possible values: {true, false} default is false.- jrs.xml_dir
Constant: jet.cs.util.APIConst.TAG_XML_DIR
Description: indicates the path of publishing to XML file.
Possible values: /publish_site- jrs.xml
Constant: jet.cs.util.APIConst.TAG_XML
Description: indicates the result filename of publishing to XML file.
Possible values: Invoice.xml- jrs.is_only_data
Constant: jet.cs.util.APIConst.TAG_IS_ONLY_DATA
Description: indicates whether contain only data in the published XML file.
Possible values: {true, false} default is false.- jrs.to_disk
Constant: jet.cs.util.APIConst.TAG_TO_DISK
Description: indicates that the report is scheduled to publish to disk.
Possible values: true/false- jrs.to_disk_???_path_type
??? indicates the format of the published report, and it can be HTML, PDF and so on. Please see the example below:
jrs.to_disk_pdf_path_type
Constant: jet.cs.util.APIConst.TAG_TO_DISK_PDF_PATH_TYPE
Description: indicate that schedule the report to publish to real disk path or JReport Server resource path in PDF format.
Possible values: 0 or 1. By default, it is 0 which means publish to JReport Server resource path. And 1 means publish to real disk path.
Example 1: Publish a report to real disk path in PDF format
http://localhost:8888/jrserver?jrs.cmd=jrs.submit_schedule&jrs.catalog=%2fhsqlDemo%2fTutorial.cat&jrs.report=TableReport.cls& jrs.task_class=jet.server.schedule.jrtasks.PublishRptTask&jrs.to_disk=true&jrs.to_disk_pdf_path_type=1&jrs.result_type=2&jrs.auth_uid=admin& jrs.auth_pwd=admin&jrs.pdf_dir=d:\&jrs.pdf=abc.pdf&jrs.to_pdf=true
Example 2: Publish a report to real disk path in TXT format
http://localhost:8888/jrserver?jrs.cmd=jrs.submit_schedule&jrs.catalog=%2fhsqlDemo%2fTutorial.cat&jrs.report=TableReport.cls& jrs.task_class=jet.server.schedule.jrtasks.PublishRptTask&jrs.to_disk=true&jrs.to_disk_text_path_type=1&jrs.result_type=3&jrs.auth_uid=admin& jrs.auth_pwd=admin&jrs.text_dir=d:\&jrs.text=abc.txt&jrs.to_text=true
- jrs.jrmail + NUMBER
Constant: jet.cs.util.APIConst.TAG_JRMAIL + NUMBER
Description: indicates one send-mail task for a report. It contains JReport mail properties.
Examples:
jrs.jrmail0=jrs.mailsubject%3dreport%2520Invoice%26jrs.mailformat%3d0%26jrs.mailto%3dreader1%26 jrs.jrmail1=jrs.mailsubject%3dreport%2520Invoice%26jrs.mailformat%3d4%26jrs.mailto%3dreader2% 252c%2520reader3%26- jrs.csmail + NUMBER
Constant: jet.cs.util.APIConst.TAG_NORMAL_MAIL + NUMBER
Description: indicates one send-mail task for any files in any format. It contains JReport mail properties.
Examples:
jrs.csmail0=jrs.mailcomments%3dto%2520user1.%26jrs.mailsubject %3dtest%2520sending%2520normal%2520emails%2520without%2520report %26jrs.mailto%3dtim%40support.jinfonet.com&jrs.mailattach1%3dd%3a%5ctest1.txt &jrs.mailattach0%3dd%3a%5ctest0.txtjrs.csmail1=jrs.mailcomments%3dto%2520user2. %26jrs.mailsubject%3dtest%2520sending%2520normal%2520emails%2520without%2520report %26jrs.mailto%3dhelen%40support.jinfonet.com%26jrs.mailattach1 %3dd%3a%5ctest2.txt%26jrs.mailattach0%3dd%3a%5ctest3.txt
- jrs.mailfrom
Constant: jet.cs.util.APIConst.TAG_MAIL_FROM
Description: indicates the mail sender's address.- jrs.mailto
Constant: jet.cs.util.APIConst.TAG_MAIL_TO
Description: indicates the mail address.- jrs.mailcc
Constant: jet.cs.util.APIConst.TAG_MAIL_CC
Description: indicates the mail address to be carbon copied to.- jrs.mailbcc
Constant: jet.cs.util.APIConst.TAG_MAIL_BCC
Description: indicates the mail address to be blind carbon copied to.- jrs.mailsubject
Constant: jet.cs.util.APIConst.TAG_MAIL_SUBJECT
Description: indicates the "SUBJECT" of the email.- jrs.mailcomments
Constant: jet.cs.util.APIConst.TAG_MAIL_COMMENT
Description: indicates "COMMENTS" field of the email.- jrs.mailformat
Constant: jet.cs.util.APIConst.TAG_MAIL_FORMAT
Description: indicates the mail format.
Possible values: 0 - HTML mail, 1 - Plain text mail, 2 - HTML file as attachment, 3 - PDF file as attachment, 4 - JReport .rst file as attachment, 5 - Delimited text as attachment, 6 - PostScript File as attachment, 7 - Excel file as attachment, 8- RTF file as attachment, 9 - XML file as attachment. The default value is 0.- jrs.mailcompress
Constant: jet.cs.util.APIConst.TAG_MAIL_COMPRESS
Description: indicates Java archive compress.
Possible values: {true, false} default is false.- jrs.udchar_width
Constant: jet.cs.util.APIConst.TAG_CHAR_WIDTH
Description: indicates the user defined character width. It would be given up if the value is 0 or less than 0 (for TEXT format) default is -1.- jrs.udchar_height
Constant: jet.cs.util.APIConst.TAG_CHAR_HEIGHT
Description: indicates the user defined character height. It would be given up if the value is 0 or less than 0.(for TEXT format) default is -1.- jrs.no_margin_mail
Constant: jet.cs.util.APIConst.TAG_NO_MARGIN_MAIL
Description: indicates whether no margin for the report in the email.
Possible values: {true, false} default is false.- jrs.use_table_mail
Constant: jet.cs.util.APIConst.TAG_USE_TABLE_MAIL
Description: indicates whether to use HTML table to generate the HTML format email.
Possible values: {true, false} default is false, which means to generate the HTML table.- jrs.mailattach + NUMBER
Constant: jet.cs.util.APIConst.TAG_MAIL_ATTACH
Description: indicates the attached file for this mail. You can attach multiple files with one mail.
Possible values: the attached file name.
Example:jrs.mailattach0=d%3a%5ctest1.txt (where "d%3a%5ctest1.txt" is the URL-encoded string of "d:\test1.txt")- jrs.mailencoding
Constant: jet.cs.util.APIConst.TAG_MAIL_ENCODING
Description: indicates encoding of mails.
Possible values: UTF-8, UTF-16, ISO8859-1 and so on.
Note: jrs.mailencoding is used to specify the mail encoding in the URL. When sending mails by RMI API, sometimes, wrong characters may be returned in the mail. In order to avoid such problems, please specify a same correct value of -Djreport.url.encoding on both server side and RMI client side.
For example, your web application calls JReport Enterprise Server (stand-alone) via RMI function from WebSphere, and UTF-8 (please use UTF-8 rather than UTF8) will be used as the mail encoding, please do as below:
- Sepcify -Djreport.url.encoding=UTF-8 for both JVM running JReport Enterprise Server and WebSphere.
- Specify jrs.mailencoding=UTF-8.
Users can select printer with the Properties:
- jrs.printer
Constant: jet.cs.util.APIConst.TAG_PRINTER
Description: indicates the printer to print the report result.- jrs.print.copies
Constant: jet.cs.util.PrintConst.TAG_PRINT_COPIES
Description: indicates the number of copies to print the report result.- jrs.print.leftmargin
Constant: jet.cs.util.PrintConst.TAG_PRINT_LEFTMARGIN
Description: indicates the length of the leftmargin to print the report result.- jrs.print.rightmargin
Constant: jet.cs.util.PrintConst.TAG_ PRINT_RIGHTMARGIN
Description: indicates the length of the rightmargin to print the report result.- jrs.print.topmargin
Constant: jet.cs.util.PrintConst.TAG_ PRINT_TOPMARGIN
Description: indicates the length of the topmargin to print the report result.- jrs.print.bottommargin
Constant: jet.cs.util.PrintConst.TAG_PRINT_BOTTOMMARGIN
Description: indicates the length of the bottommargin to print the report result.- jrs.print.unit
Constant: jet.cs.util.PrintConst.TAG_PRINT_UNIT
Description: indicates the unit to print the report result. Here are two units for you to choose: mm and inch.
Possible values: 1000 or 25400- jrs.print.customtray
Constant: jet.cs.util.PrintConst.TAG_PRINT_CUSTOMTRAY
Description: indicates the custom tray to put the printing paper.
Example:
http://localhost:8888/jrserver?jrs.cmd=jrs.submit_schedule &jrs.catalog=/hsqlDemo/Tutorial.cat&jrs.report=/hsqlDemo/3DPieChart.cls &jrs.task_class=jet.server.schedule.jrtasks.PublishRptTask&jrs.launch_type=0 &jrs.to_printer=true&jrs.print_usejdk=2&jrs.printer=smartprint &jrs.print.copies=2&jrs.print.customtray=Form-Source&jrs.print.bottommargin=7 &jrs.print.leftmargin=8&jrs.print.rightmargin=9&jrs.print.topmargin=7 &jrs.print.unit=1000Note: In this case, you must set the value for the following properties at the same time: jrs.print.leftmargin, jrs.print.rightmargin, jrs.print.topmargin, jrs.print.bottommargin and jrs.print.unit; Otherwise, it can not work smoothly.
- jrs.notification_emails
Constant: jet.cs.util.APIConst.TAG_NOTIFICATION_EMAILS
Description: indicates the email notification list for successful/failed scheduled tasks.- jrs.success_notify
Constant: jet.cs.util.APIConst.TAG_SUCCESS_NOTIFY
Description: indicates whether to send email notification for successful reports.
Possible values: {true, false} default is false.- jrs.fail_notify
Constant: jet.cs.util.APIConst.TAG_FAIL_NOTIFY
Description: indicates whether to send email notification for failed reports.
Possible values: {true, false} default is false.
- jrs.has_style
Constant: jet.cs.util.APIConst.TAG_HAS_STYLE
Description: indicates whether to enable style group.
Possible values: {true, false} default is false.- jrs.style_group
Constant: jet.cs.util.APIConst.TAG_STYLE_GROUP
Description: specifies style group.
- Submit a schedule to publish the report /hsqlDemo/Tutorial.cat/Invoice.cls to versioning system periodically.
The URL:
http://localhost:8888/jrserver?jrs.cmd=jrs.submit_schedule&jrs.catalog= %2fhsqlDemo%2fTutorial.cat&jrs.hour2=5&jrs.task_class= jet.server.schedule.jrtasks.UpdateRptTask&jrs.is_between=true&jrs.is_weekday= false&jrs.launch_type=8&jrs.min2=0&jrs.is_pm=false&jrs.hour=9&jrs.is_pm2= true&jrs.param$PToday=May%2021%2c%201998&jrs.uid=admin&jrs.hours= 1&jrs.is_hourly=true&jrs.at_min=0&jrs.days_id=0&jrs.day=1&jrs.param_file=true& jrs.timezone=CTT&jrs.min=0&jrs.param$TermsDays=30&jrs.expire_days= 30&jrs.report=Invoice.cls&jrs.rpt_language=en&- Submit a schedule to publish the report /hsqlDemo/Tutorial.cat/Invoice.cls to versioning system at Sat May 1 12:00:00 CTS 2006.
The URL:
http://localhost:8888/jrserver?jrs.cmd=jrs.submit_schedule&jrs.catalog= %2fhsqlDemo%2fTutorial.cat&jrs.task_class= jet.server.schedule.jrtasks.UpdateRptTask&jrs.launch_type= 1&jrs.param$PToday=May%2021%2c%201998&jrs.uid=admin&jrs.exe_day= 1&jrs.param_file=true&jrs.exe _month=5&jrs.timezone=CTT&jrs.exe_hour=12&jrs.exe_min=00& jrs.exe_year=2006&jrs.param$TermsDays=30&jrs.expire_days=30&jrs.report=Invoice.cls&- Submit a schedule to publish the report /hsqlDemo/Tutorial.cat/Invoice.cls to versioning system immediately.
The URL:
http://localhost:8888/jrserver?jrs.cmd=jrs.submit_schedule&jrs.catalog= %2fhsqlDemo%2fTutorial.cat&jrs.task_class= jet.server.schedule.jrtasks.UpdateRptTask&jrs.launch_type=0&jrs.param$PToday= May%2021%2c%201998&jrs.uid=admin&jrs.param_file=true&jrs.param$TermsDays= 30&jrs.expire_days=30&jrs.report=Invoice.cls &jrs.rpt_language=en&- Submit a schedule to publish the report /hsqlDemo/Tutorial.cat/Invoice.cls to file system immediately.
The URL:
http://localhost:8888/jrserver?jrs.cmd=jrs.submit_schedule&jrs.catalog= %2fhsqlDemo%2fTutorial.cat&jrs.pdf_dir=%2fgrp_param&jrs.task_class= jet.server.schedule.jrtasks.PublishToDiskTask&jrs.rst= Invoice.rst&jrs.launch_type=0&jrs.param$PToday=May%2021%2c%201998&jrs.uid= admin&jrs.is_norm_txt=true&jrs.rst_dir=%2fgrp_param&jrs.is_applet_chart= false&jrs.param_file=true&jrs.html=Invoice&jrs.text=Invoice.txt&jrs.delimiter= &jrs.is_multi_files=true&jrs.text_dir=%2fgrp_param&jrs.param$TermsDays= 30&jrs.report=Invoice.cls&jrs.pdf=Invoice.pdf&jrs.html_dir=%2fgrp_param&- Submit a schedule to publish the report /hsqlDemo/Tutorial.cat/Invoice.cls to email immediately.
The URL:
http://localhost:8888/jrserver?jrs.cmd=jrs.submit_schedule&jrs.catalog= %2fhsqlDemo%2fTutorial.cat&jrs.jrmail1=jrs.mailsubject%3dreport %2520Invoice%26jrs.mailformat%3d4%26jrs.mailto%3dreader2%252c%2520reader3%26& jrs.task_class=jet.server.schedule.jrtasks.SendJRMailTask&jrs.jrmail0= jrs.mailsubject%3dreport%2520Invoice%26jrs.mailformat%3d0%26jrs.mailto %3dreader1%26&jrs.launch_type=0&jrs.param$PToday=May%2021%2c%201998& jrs.uid=admin&jrs.param_file=true&jrs.param$TermsDays= 30&jrs.report=Invoice.cls&jrs.rpt_language=en&- Submit a schedule to publish the report /hsqlDemo/Tutorial.cat/Invoice.cls to printer immediately.
The URL:
http://localhost:8888/jrserver?jrs.cmd=jrs.submit_schedule&jrs.catalog= %2fhsqlDemo%2fTutorial.cat&jrs.task_class=jet.server.schedule.jrtasks.PrintRptTask&jrs.launch_type= 0&jrs.param$PToday=May%2021%2c%201998&jrs.uid=admin&jrs.param_file=true&jrs.param$TermsDays= 30&jrs.report=Invoice.cls&- Submit a schedule to publish the report /hsqlDemo/Tutorial.cat/Invoice.cls to versioning system immediately, and notify the user support1, support2, and support3 whenever success or failure.
The URL:
http://localhost:8888/jrserver?jrs.cmd=jrs.submit_schedule&jrs.catalog= %2fhsqlDemo%2fTutorial.cat&jrs.task_class=jet.server.schedule.jrtasks.UpdateRptTask&jrs.launch_type= 0&jrs.param$PToday=May%2021%2c%201998&jrs.uid=admin&jrs.param$TermsDays=30&jrs.expire_days= 30&jrs.report=Invoice.cls&jrs.success_notify=true&jrs.fail_notify=true&jrs.notification_emails= To%3A+support1@jinfonet.com%0D%0ACc%3A+support2@jinfonet.com%0D%0ABcc%3A+support3@jinfonet.com%0D%0A- When a large report exceeds the specific running time, send the report result by Email when it is finished.
- JSP parameter specification
jrs.catalog=%2fcatalog path%2fcatalog name
jrs.report=report name
jrs.timeout_send_email=true/[false]
jrs.report_timeout=number (if timeout >number and jrs.timeout_send_email=true, send mail)
jrs.mailto=mail address
jrs.mailsubject=mail subject
jrs.result_type=1 (HTML) or 2(PDF) or 3(Text) or 4(Excel) or 5(PostScript) or 6(Rich Text) or 7(Xml)
jrs.mailcomments=mail content
jrs.mailfrom=mail address of sender
jrs.timeout_sendmail_message=the message which users customize
When you use JSP to run a report without parameter:
http://localhost:8888/jinfonet/tryView.jsp?jrs.cmd=jrs.try_vw&jrs.catalog= %2fhsqlDemo%2fTutorial.cat&jrs.report=employeelist.cls&jrs.timeout_send_email= true&jrs.report_timeout=05&jrs.mail"mailto:to=support@jinfonet.com&jrs.mailsubject= AboutTaskForTimeoutSendEmail&jrs.res">to=support@jinfonet.com&jrs.mailsubject= "TaskForTimeoutSendEmail&jrs.result_type=1&jrs.mailcomments= IFTHEREPORTISFINISHEDTHERESULTWILLBESENT
When you use JSP to run a report with parameter:
http://localhost:8888/jinfonet/runReport.jsp?jrs.cmd= jrs.web_vw&jrs.catalog=%2fhsqlDemo/Tutorial.cat&jrs.report= customerorders.cls&jrs.timeout_send_email= true&jrs.report_timeout=0&jrs.mailto= support@jinfonet.com&jrs.mailsubject=AboutTaskForTimeo">mo%2fTutorial.cat&jrs.report= customerorders.cls&jrs.timeout_send_email=true&jrs.report_timeout=5&jrs.mailto= support@jinfonet.com&jrs.mailsubject=TaskForTimeoutSendEmail&jrs.result_type=1- Servlet parameter specification
jrs.cmd=jrs.try_vw (when the report has no parameter)
jrs.cmd=jrs.web_vw (when the report has parameter)
jrs.timeout_send_email=true/[false]
jrs.report_timeout=number (if timeout >number and jrs.timeout_send_email=true, send mail)
jrs.mailto=mail address
jrs.mailsubject=mail subject
jrs.result_type=1 (HTML) or 2(PDF) or 3(Text) or 4(Excel) or 5(PostScript) or 6(Rich Text) or 7(Xml)
jrs.mailcomments=mail content
jrs.mailfrom=mail address of sender
jrs.timeout_sendmail_message=the message which users customize
When you use Servlet to run a report without parameter:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/CountRecorderPerPage.cls?jrs.cmd= jrs.try_vw&jrs.timeout_send_email=true&jrs.report_timeout=1&jrs.mailto= support@jinfonet.com&jrs.mailsubject=AboutTaskForTimeoutSendEmail&jrs.result_type= 1&jrs.mailcomments=COUNTRECORDSPERPAGE
When you use Servlet to run a report with parameter:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/customerorders.cls?jrs.cmd= jrs.web_vw&jrs.timeout_send_email=true&jrs.report_timeout=1&jrs.mailto= support@jinfonet.com&jrs.mailsubject=TaskForTimeoutEmail&jrs.result_type= 1&jrs.mailcomments=CUSTOMERORDER- Customize your message which will display in browser
You can set your desired message by setting the parameter "jrs.timeout_sendmail_message"
For example, you want to display message as below:
Running <report name> costs more than <Timeout> seconds.
The subject is <mail subject> and has been sent to <mailto> from <mailfrom>
It is a file whose type is <type>.
Then you can set the parameter in URL:
jrs.timeout_sendmail_message=Running {6} costs more than {0} seconds.<p>The subject is {2} and has been sent to {1} from {5}.<p>It is a file whose type is {3}.
Where
{0} - The report timeout
{1} - mail to
{2} - mail subject
{3} - result type
{4} - mail comment
{5} - mail from
{6} - Catalog name/report
<p> - an Enter key
Example:
http://localhost:8888/jrserver/hsqlDemo/Tutorial.cat/customerorders.cls?jrs.cmd=jrs.web_vw &jrs.timeout_send_email=true&jrs.report_timeout=0&jrs.mailto=support@jinfonet.com &jrs.mailsubject=AboutTaskForTimeoutSendEmail&jrs.result_type=1&jrs.mailcomments=Customerorder &jrs.mailfrom=support@jinfonet.com&jrs.timeout_sendmail_message=
This {6} is a larger report whose runtime is over {0}<p>.I send the report to {1}. <p> I am {5}.The subject of the mail is {2}.<p> It''s type is {3}.
Note: When the sign " ' " is used in the message, you should type the sign twice. For example, the message " Its subject is {2}" will be displayed as "Its subject is AboutTaskForTimeoutSendEmail".