General properties

When scheduling reports via URL, there are the following general properties:

jrs.catalog
Constant: jet.cs.util.APIConst.TAG_CATALOG
Description: Specifies the catalog name with full path.
Example: /SampleReports.cat, or %2fSampleReports.cat
jrs.report
Constant: jet.cs.util.APIConst.TAG_REPORT
Description: Specifies the report name with full path.
Example: /EmployeeInformation.cls, or %2fEmployeeInformation.cls
jrs.param$ + PARAMETER_NAME
Constant: jet.cs.util.APIConst.TAG_PARAM_PREFIX + PARAMETER_NAME
Description: Specifies parameter values for running the report. Use jrs.param$NAME=VALUE to set parameter values of the report. Where, NAME is the parameter name and VALUE is the URL-encoded parameter value. For Example: jrs.param$TERMSDAYS=30&jrs.param$PTODAY=May 21, 1998. When specifying values for a multi-value parameter, you need to add _isMultiple_jrs.param$NAME=true before the parameter values to declear that the parameter supports multiple values. For example: &_isMultiple_jrs.param$PM=true&jrs.param$PM=3&jrs.param$PM=16.
jrs.param_values
Constant: jet.cs.util.APIConst.TAG_PARAM_VALUES
Description: Specifies 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.task_class
Constant: jet.cs.util.APIConst.TAG_TASK_CLASS
Description: Specifies 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: Specifies whether or not to implement TaskListener.
Possible values: {true, false}
jrs.task_listener_class
Constant: jet.cs.util.APIConst.TAG_TASK_LISTENER_CLASS
Description: Specifies the user's Java class name which implements the TaskListener (jrs.task_listener_class).
Possible value: a class name (String)
jrs.task_id
Constant: jet.cs.util.APIConst.TAG_TASK_ID
Description: Specifies the task ID of a scheduled task. This property is unnecessary if a new schedule is submitted.
jrs.rpt_language
Constant: jet.cs.util.APIConst.TAG_REPORT_LANGUAGE
Description: Specifies the language in which to generate 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 (for example, de_DE in ReportName_de_DE. properties). For example, if the language property file is named ReportName_de_DE. properties, you should set this command as jrs.rpt_language=de_DE. You can also use jrs.rpt_language=de&jrs.rpt_country=DE to achieve the same goal. If you only want to use jrs.rpt_language=de, then you will have to rename the language property file to ReportName_de. properties.
Examples:
- http://localhost:8888/jrserver/SampleReports.cat/EmployeeInformation.cls?jrs.cmd=jrs.web_vw&jrs.result_type=2&jrs.enable_nls=true&jrs.rpt_language=de_DE
- http://localhost:8888/dhtmljsp/dhtml.jsp?jrs.catalog=/SampleReports.cat&jrs.report=/EmployeeInformation.cls&jrs.enable_nls=true&jrs.rpt_language=de&jrs.rpt_country=DE
- If you change EmployeeInformation_de_DE.properties to EmployeeInformation_aaa.properties in EmployeeInformation.cls's real path folder, for example C:\JReport\Server\history\1\JReport_System_User457188937, then you can use the following URL to run NLS report:
  
  http://localhost:8888/dhtmljsp/dhtml.jsp?jrs.catalog=/SampleReports.cat&jrs.report=/EmployeeInformation.cls&jrs.enable_nls=true&jrs.rpt_language=aaa
jrs.rpt_encoding
Constant: jet.cs.util.APIConst.TAG_REPORT_ENCODING
Description: Specifies the encoding in which to generate the report.
jrs.db_user
Constant: jet.cs.util.APIConst.TAG_DB_USER
Description: Specifies 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: Specifies 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: Specifies the new JDBC URL in the catalog to run a report.
jrs.jdbc_driver
Constant: jet.cs.util.APIConst.TAG_JDBC_DRIVER
Description: Specifies 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: Specifies 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 JReport 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 set, propParams);

jrs.wp
Constant: jet.cs.util.APIConst.TAG_WHERE_PORTION
Description: Specifies the where portion.
jrs.named_wp
Constant: jet.cs.util.APIConst.TAG_NAMED_WHERE_PORTION
Description: Specifies the named where portion that exists in the catalog.
jrs.if_print
Constant: jet.cs.util.APIConst.TAG_IF_PRINT
Description: Specifies whether or not to print the report result. The default value is false
jrs.printer
Constant: jet.cs.util.APIConst.TAG_PRINTER
Description: Specifies the printer for printing the report result.
jrs.mail_to_referuser
Constant: jet.cs.util.APIConst.TAG_MAIL_TO_REFERUSER
Description: Specifies whether or not to send mails to each user who is authorized to view a report with cached report bursting.
Possible values: {true, false}