Appendix 1: URL Properties

This appendix presents the basic properties concerned with working on Logi JReport Server using URL. When you run and schedule reports via URL, you also need to specify the properties for each report format. For details about those format properties, refer to the Logi JReport Javadoc.

Below is a list of the sections covered in this topic:

General Properties for Running and Scheduling Reports
Properties for Scheduling Reports
Properties for Viewing Report Results
Properties for Adding and Deleting Users/Roles

General Properties for Running and Scheduling Reports

Property Description

jrs.path Specifies a path or a resource name with full path.
Example: /SampleReports, or /SampleReports/InvoiceReport.cls

jrs.catalog Specifies the catalog name with full path.
Example: /SampleReports/SampleReports.cat, or %2fSampleReports%2fSampleReports.cat

jrs.report Specifies the report name with full path.
Example: /SampleReports/Employee Information.cls, or %2fSampleReports%2fEmployee Information.cls

jrs.result_type

Specifies which format to run a report to.
Possible values: {0, 8}

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 Page Report Studio (for page reports)
8 - To Web Report Studio (for web reports)

jrs.param$+PARAMETER_NAME 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

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.param_page

Specifies whether to show the parameter dialog for specifying parameter values that are not provided by jrs.param$ in the URL. Such parameter dialogs include the one displayed during report running and those brought by actions that lead to the change of parameters after the report is rendered in Page Report Studio, for example, the actions such as inserting a formula with a new parameter, running a master/detail report, and so on. However, the dialog displayed via Menu > Report > Change Parameters is not affected by this property, because the dialog is to display all the parameters of the report. When it is true and the value of a middle level cascading parameter (including old style cascading parameter) is provided, the parameter dialog only shows the lower level parameters. When it is false, no involved parameter dialog will pop up during the whole report running. The given parameter values and the default values of the other parameters will be used to run the report.

The default value of the property is true.

jrs.rpt_language

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, 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/jinfonet/tryView.jsp?jrs.report=%2fSampleReports%2fEmployee Information.cls&jrs.catalog=%2fSampleReports%2fSampleReports.cat&jrs.result_type=2&jrs.enable_nls=true&jrs.rpt_language=de_DE
http://localhost:8888/webos/app/pagestudio/run.jsp?jrs.catalog=/SampleReports/SampleReports.cat&jrs.report=/SampleReports/Employee Information.cls&jrs.enable_nls=true&jrs.rpt_language=de&jrs.rpt_country=DE
If you change Employee Information_de_DE.properties to Employee Information_aaa.properties in Employee Information.cls's real path folder, for example C:\Logi JReport\Server\history\1\Logi JReport_System_User457188937, then you can use the following URL to run NLS report: http://localhost:8888/webos/app/pagestudio/run.jsp?jrs.catalog=/SampleReports/SampleReports.cat&jrs.report=/SampleReports/Employee Information.cls&jrs.enable_nls=true&jrs.rpt_language=aaa

jrs.rpt_encoding Specifies the encoding in which to generate the report.

jrs.has_style Specifies whether or not to enable the style group that has been set for the report.

jrs.style_group Specifies the style group which could be StyleName<CSS> or StyleName.css. StyleName<CSS> is CSS Style Sheet whose name is StyleName in the Logi JReport resources system. It may come from a .css file on disk or be created from the CSS editor. StyleName.css is a *.css file on disk which may not follow the CSS style rule and therefore not work. It is recommended to use jrs.style_group=StyleName<CSS> in case StyleName.css fails though both can work most of the time.

jrs.db_user 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 Specifies the new database password if you do not want to use the default DB password in the catalog.

jrs.jdbc_url Specifies the new JDBC URL in the catalog to run a report.

jrs.jdbc_driver Specifies the new JDBC driver in the catalog to run a report.

jrs.wp Specifies the WHERE portion. For example, a report has a DBField Customer Region, and you want to restrict the field Customer Region to CA in the URL. You can then set a new WHERE portion such as, "...jrs.result_type=1&jrs.wp=Customers.Region='CA'...".

jrs.named_wp Specifies the named WHERE portion that exists in the catalog.

jrs.jdbc_connection_object

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 Logi 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.security_file_name Specifies to apply a security file. When a security file is given, the security definitions in the specified catalog will be replaced by that defined in the security file.

jrs.applet_type

Specifies the Java runtime environment to run applets.

Possible values:

2 - Java Plug-In 1.2 for Windows
3 - Java Plug-In 1.3 for Windows

jrs.web_browser

Specifies the web browser for which the HTML result adapts.

Possible values:

0 - IE or Chrome
1 - Firefox

jrs.timeout_send_email Specifies whether to notify someone of the task status via e-mail if the task has not yet finished running when the task duration is up. Possible values: true/false. The task duration uses the time specified by jrs.report_timeout in the URL. If there is not jrs.report_timeout, the time specified by web.timeouts.report_wait in the server.properties file in <install_root>\bin will be used.

jrs.report_timeout Specifies a time duration in seconds for a scheduled report running task.

jrs.mailto Specifies the address you want to send the e-mail to.

jrs.mailsubject Specifies the subject of the e-mail.

jrs.mailcomments Specifies the comments to the e-mail contents.

jrs.mailfrom Specifies the e-mail address of the sender.

jrs.timeout_sendmail_message Specifies the contents of the e-mail.

Properties for Scheduling Reports

Property	Description
General properties
jrs.task_class	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	Specifies whether or not to implement TaskListener.
jrs.task_listener_class	Specifies the user's Java class name which implements the TaskListener (jrs.task_listener_class).
jrs.task_id	Specifies the task ID of a scheduled task. This property is unnecessary if a new schedule is submitted.
jrs.mail_to_referuser	Specifies whether or not to send mails to each user who is authorized to view a report with cached report bursting.
jrs.is_bursting_task	Indicates it is to schedule a bursting report task.
jrs.bursting_schema$Schema_Name	Specifies the names of the schemes to schedule.
Publishing to the versioning system properties
jrs.to_version	Specifies whether to publish the report result to the versioning system.
jrs.to_version_rst	Specifies whether to publish page report to a Logi JReport result file or publish web report to a static web report result file (WST file). You can further specify the result properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_version_rsd	Specifies whether to publish the report to page report result. You can further specify the result properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_version_html	Specifies whether to publish the report result to the versioning system in HTML format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_version_pdf	Specifies whether to publish the report result to the versioning system in PDF format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_version_excel	Specifies whether to publish the report result to the versioning system in Excel format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_version_txt	Specifies whether to publish the report result to the versioning system in Text format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_version_rtf	Specifies whether to publish the report result to the versioning system in RTF format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_version_xml	Specifies whether to publish the report result to the versioning system in XML format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_version_ps	Specifies whether to publish the report result to the versioning system in PostScript format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.archive_location	Specifies the location for the saved report result version. Possible values: 0 - Specifies to save the report result version to the built-in version folder. Not supported for organization users when the report is from the Public Reports folder. 1 - Specifies to save the report result version to the My Reports folder. You can then use jrs.archive_my_destination to specify a version name with the path in the My Reports folder. 2 - Specifies to save the report result version to the Public Reports folder. You can then use jrs.archive_public_destination to specify a version name with the path in the Public Reports folder. Not supported for organization users.
jrs.enable_archive_policy	Specifies whether to apply an archive policy to the report result version.
jrs.archive_new_version	Specifies how to archive the new version. Possible values: true - Specifies to use multiple versions for the report result. You can then use jrs.maxversion to specify the maximum number of versions that will be listed in the version table of the report result. 0 means that the version number is unlimited. false - Specifies to replace the old version when a new version is generated.
jrs.need_expire	Specifies whether the report result will be expired.
jrs.auto_delete_method	Specifies when the report result will be expired and deleted. Set the result to be automatically deleted within one hundred years. If the time you specify exceeds one hundred years, Logi JReport Server will keep the report result forever. Possible values: 0 - The report result will be automatically deleted after a specified number of days. You can then use jrs.expire_days to specify the number of days, for example: `jrs.need_expire=true&jrs.auto_delete_method=0&jrs.expire_days=60`. 1 -The report result will be automatically deleted after a specified date. You can then use jrs.auto_delete_year, jrs.auto_delete_month, and jrs.auto_delete_date to specify the year, month and date, for example: `jrs.need_expire=true&jrs.auto_delete_method=1&jrs.auto_delete_year=2017&jrs.auto_delete_month=5&jrs.auto_delete_date=16`.
jrs.expire_days	Specifies the number of days a result version will be kept until it expires. The default value is 30.
Publishing to the file system properties
jrs.to_disk	Specifies whether or not the report is scheduled for publishing to disk.
jrs.to_rst	Specifies whether to publish page report to a Logi JReport result file or publish web report to a static web report result file (WST file). You can further specify the result properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_rsd	Specifies whether to publish the report to page report result. You can further specify the result properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_html	Specifies whether to publish the report result to the file system in HTML format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_pdf	Specifies whether to publish the report result to the file system in PDF format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_excel	Specifies whether to publish the report result to the file system in Excel format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_text	Specifies whether to publish the report result to the file system in Text format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_rtf	Specifies whether to publish the report result to the file system in RTF format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_xml	Specifies whether to publish the report result to the file system in XML format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_ps	Specifies whether to publish the report result to the file system in PostScript format. You can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.to_disk_xxx_path_type	Specifies where to publish the report result in xxx format: to the server resource tree or to the server disk path. Possible values: {0, 1} 0 - Publishes to the Logi JReport Server resource tree. 1 - Publishes to a real disk path.
jrs.xxx_dir	Specifies the path for the published xxx format file.
jrs.xxx	Specifies the file name for the published xxx format file.
Publishing to e-mail properties
jrs.jrmail + NUMBER	Contains specifications (Logi JReport mail properties) of one send-mail task for a report.
jrs.csmail + NUMBER	Contains specifications (Logi JReport mail properties) of one send-mail task for sending an e-mail with or without an attachment. This property is used via URL or via invoking Server API.
jrs.mailto	Specifies the mail address.
jrs.mailcc	Specifies the mail address to be carbon copied to.
jrs.mailbcc	Specifies the mail address to be blind carbon copied to.
jrs.mailsubject	Specifies the subject of the e-mail.
jrs.mailcomments	Specifies the comment of the e-mail.
jrs.mailformat	Specifies the mail format. Possible values: {0, 1, 2, 3, 4, 6, 7, 8, 9, 11} 0 - E-mail Result in HTML E-mail Format 1 - E-mail Result in Plain Text E-mail Format 2 - Attachment in HTML Format 3 - Attachment in PDF Format 4 - Attachment in Logi JReport Result Format (for page reports) 4 - Attachment in Web Report Result Format (for web reports) 6 - Attachment in PostScript Format 7 - Attachment in Excel Format 8 - Attachment in RTF Format 9 - Attachment in XML Format 11 - Attachment in Text Format When sending the report result as an attachment file, you need to specify a file name using jrs.mailattach + NUMBER. You can further specify format properties for the attachment file. See the Logi JReport Javadoc for details about these properties.
jrs.mailcompress	Specifies whether to enable Java archive compress.
jrs.mailattach + NUMBER	Specifies the attached file for this mail. You can attach multiple files with one mail. Possible values: The attached file name.
jrs.mailencoding	Specifies the encoding of the 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, specify the same correct value of -DLogi JReport.url.encoding on both the server and RMI client side. For example, your web application calls Logi JReport Server (standalone) via the RMI function from WebSphere, and UTF-8 (use UTF-8 rather than UTF8) will be used as the mail encoding, do as follows: Specify -DLogi JReport.url.encoding=UTF-8 for both JVM running Logi JReport Server and WebSphere. Specify jrs.mailencoding=UTF-8.
Publishing to a printer properties
jrs.if_print	Specifies whether or not to print the report result.
jrs.printer	Specifies the printer with which to print the report result.
jrs.print_copies	Specifies the number of copies to print the report result.
jrs.print_mediatray	Specifies the custom tray to put the printing paper.
jrs.has_margins	Specifies whether or not to have margins in the printed report result.
When jrs.has_margins=true, you must set the following properties:
jrs.margins_left	Specifies the length of the left margin to print the report result.
jrs.margins_right	Specifies the length of the right margin to print the report result.
jrs.margins_top	Specifies the length of the top margin to print the report result.
jrs.margins_bottom	Specifies the length of the bottom margin to print the report result.
jrs.margins_unit	Specifies the unit to print the report result. Possible values: jrs.margins_unit_mm Specifies mm as the margin unit. jrs.margins_unit_inch Specifies inch as the margin unit.
Publishing to fax properties
jrs.to_fax	Specifies whether or not to publish the report result to fax.
jrs.to_fax_quality	Specifies the fax quality. Possible values: jrs.to_fax_quality_best Indicates the best fax quality. jrs.to_fax_quality_fast Indicates the fast fax quality. jrs.to_fax_quality_normal Indicates the normal fax quality.
jrs.to_fax_is_inclue_cover	Specifies whether to send a cover sheet with the fax.
jrs.to_fax_date	Specifies the date on which the fax is to be sent.
jrs.to_fax_to	Specifies the fax recipient.
jrs.to_fax_to_fax_num	Specifies the fax number of the recipient.
jrs.to_fax_from	Specifies the fax sender.
jrs.to_fax_from_company_name	Specifies the sender's company.
jrs.to_fax_from_phone	Specifies the sender's phone number.
jrs.to_fax_subject	Specifies the subject of the fax.
jrs.to_fax_comments	Specifies the comments of the fax.
jrs.to_fax_urgent	Specifies whether or not the fax is urgent.
jrs.to_fax_for_review	Specifies whether or not the fax is for review.
jrs.to_fax_please_comment	Specifies whether or not the recipient is required to comment on the content of the fax.
jrs.to_fax_please_reply	Specifies whether or not a reply is required for the fax.
Publishing to FTP properties
jrs.to_FTP	Specifies whether or not to publish the report result to FTP.
jrs.ftp	Specifies an FTP site by holding the FTP setting properties. To configure multiple FTP sites, use jrs.ftp0 to specify the first site and jrs.ftp1 to specify the second, and so on. Multiple sites are separated by &. Examples: `jrs.ftp=Property1%3DValue1%26Property2%3DValue2...`, here %3D represents "=" and %26 represents "&". `jrs.ftp0=jrs.ftpHost%3D192.0.0.1%26jrs.ftpPort%3D21%26jrs.ftpUn%3Dtest%26jrs.ftpPsd%3Dtest%26jrs.ftpAcct%3Dtest...&jrs.ftp1=jrs.ftpHost%3D192.0.0.2%26jrs.ftpPort%3D22...`
jrs.ftpLbl	Specifies the label of the FTP server.
jrs.ftpHost	Specifies the host of the FTP server.
jrs.ftpPort	Specifies the port of the FTP server.
jrs.ftpUn	Specifies the user name for logging in the FTP server.
jrs.ftpPsd	Specifies the password for logging in the FTP server.
jrs.ftpAcct	Specifies the account for logging in the FTP server.
jrs.ftpLoc	Specifies the remote directory on the FTP server to which the files will be published.
jrs.ftpHdlCls	Specifies the FTP client-end handler class for communicating with the FTP server. Possible values: FTPHandler class name or null which is the default value.
jrs.ftpProt	Specifies the protocol for communicating with the FTP server. Possible values: {0, 1, 2, 3} 0 - FTP 1 - SFTP 2 - SCP 3 - FTPS
jrs.ftpsConType	Specifies the connection type of FTPS. Possible values: {0, 1} 0 - EXPLICIT 1 - IMPLICIT
jrs.ftpsEnNoSec	Specifies whether to enable falling back to the no-security FTP connection if the explicit FTPS connection is not available.
jrs.ftpsKSType	Specifies the keystore type of FTPS.
jrs.ftpsKSFile	Specifies the keystore file of FTPS.
jrs.ftpsKSPsd	Specifies the keystore password of FTPS.
jrs.ftpsKMAlg	Specifies the keymanager algorithm of FTPS.
jrs.ftpsSecProt	Specifies the security protocol of FTPS.
jrs.ftpsTMAlg	Specifies the trustmanager algorithm of FTPS.
jrs.ftpsTransMode	Specifies the transfer mode of FTPS.
jrs.ftpsTSType	Specifies the truststore type of FTPS.
jrs.ftpsTSFile	Specifies the truststore file name of FTPS.
jrs.ftpsTSPsd	Specifies the truststore password of FTPS.
jrs.sftpC2SCmpA	Specifies the C2S compression algorithms of SFTP/SCP.
jrs.sftpC2SCphA	Specifies the C2S cipher algorithms of SFTP/SCP.
jrs.sftpC2SLang	Specifies the C2S language of SFTP/SCP.
jrs.sftpC2SMA	Specifies the C2S MAC algorithms of SFTP/SCP.
jrs.sftpHKAlgs	Specifies the host key algorithms of SFTP/SCP.
jrs.sftpKexAlgs	Specifies the kex algorithms of SFTP/SCP.
jrs.sftpKH	Specifies the knownhosts file of SFTP/SCP.
jrs.sftpS2CCmpA	Specifies the s2c compression algorithms of SFTP/SCP.
jrs.sftpS2CCphA	Specifies the S2C cipher algorithms of SFTP/SCP.
jrs.sftpS2CLang	Specifies the S2C language of SFTP/SCP.
jrs.sftpS2CMA	Specifies the S2C MAC algorithms of SFTP/SCP.
jrs.sftpSHKC	Specifies whether to check the strict host key. Possible values: {yes, no}
jrs.ftp_param_validation	Specifies the command of checking the validation of FTP connection options. Possible values: TAG_FTP_CONNECTION_FAILED The connection cannot be created because the host name/IP or port is not valid. Possible values: {100} (the only value) TAG_FTP_CONNECTION_IS_OK The connection is valid. Possible values: {200} (the only value) TAG_FTP_NO_PERMISSION The connection can be built but the user name or password is not valid. Possible values: {300} (the only value) TAG_FTP_INVALID_FOLDER The connection can be built but the directory where the report result files reside cannot be found. Possible values: {400} (the only value)
jrs.ftpIsDht	Specifies whether to export TOC in the HTML result.
The following properties are used to specify in which formats to send the report result file to the FTP site. For each result file you can further specify the format properties. See the Logi JReport Javadoc for details about these properties.
jrs.ftpRst	Specifies whether to send report result in a Logi JReport Result file (for page report) or in web report result (for web report) to the FTP site.
jrs.ftpRstFn	Specifies the file name of the Logi JReport Result file (for page report) or of the web report result (for web report).
jrs.ftpHtml	Specifies whether to send the report result in an HTML file to the FTP site.
jrs.ftpHtmlFn	Specifies the file name of the HTML file.
jrs.ftpPdf	Specifies whether to send the report result in a PDF file to the FTP site.
jrs.ftpPdfFn	Specifies the file name of the PDF file.
jrs.ftpExl	Specifies whether to send the report result in an Excel file to the FTP site.
jrs.ftpExlFn	Specifies the file name of the Excel file.
jrs.ftpTxt	Specifies whether to send the report result in a Text file to the FTP site.
jrs.ftpTxtFn	Specifies the file name of the Text file.
jrs.ftpRtf	Specifies whether to send the report result in a RTF file to the FTP site.
jrs.ftpRtfFn	Specifies the file name of the RTF file.
jrs.ftpXml	Specifies whether to send the report result in an XML file to the FTP site.
jrs.ftpXmlFn	Specifies the file name of the XML file.
jrs.ftpPs	Specifies whether to send the report result in a PostScript file to the FTP site.
jrs.ftpPsFn	Specifies the file name of the PostScript file.
Notification properties
jrs.notification_emails	Specifies the e-mail notification list for successful/failed scheduled tasks.
jrs.success_notify	Specifies to send e-mail notification for successful reports.
jrs.fail_notify	Specifies to send e-mail notification for failed reports.
Time condition properties
jrs.timezone	Specifies the timezone. Possible values: timezone ID strings of java default is current locale.
jrs.launch_type	Specifies to run a report immediately, at a specific time or periodically. Possible values: {0, 1, 8} 0 - Immediately 1 - At a specified date and time 8 - Periodically
Properties for a specific date and time (jrs.launch_type=1)
jrs.exe_date	Specifies a date.
jrs.exe_year	Specifies a year of 4 numbers.
jrs.exe_month	Specifies a month, for example, May. Possible values: 0 to 11. 0 is January, 1 is February, ..., and 11 is December.
jrs.exe_day	Specifies a day number. Possible values: 1 to 31
jrs.exe_hour	Specifies an hour number (when jrs.is_hourly is false). Possible values: 0 to 23
jrs.exe_min	Specifies a minute number (when jrs.is_hourly is false). Possible values: 0 to 59
jrs.exe_sec	Specifies a second number (when jrs.is_hourly is false). Possible values: 0 to 59
Properties for periodical time (jrs.launch_type=8)
jrs.is_after	Specifies whether to run after the specified date and time, also the start time of the whole periodical time. If the value is true, use properties for a specific time to define the specific time.
jrs.is_before	Specifies whether to run before the specified date and time. If the value is true, the specified time is represented by the jrs.cease_* properties.
jrs.cease_year	Specifies a year of 4 numbers.
jrs.cease_month	Specifies a month. Possible values: 0 to 11. 0 is January, 1 is February, ..., and 11 is December.
jrs.cease_day	Specifies a day number. Possible values: 1 to 31
jrs.cease_hour	Specifies an hour number (when jrs.is_hourly is false). Possible values: 0 to 23
jrs.cease_min	Specifies a minute number (when jrs.is_hourly is false). Possible values: 0 to 59
jrs.cease_sec	Specifies a second number (when jrs.is_hourly is false). Possible values: 0 to 59
jrs.days_id	Specifies whether the schedule will run daily, weekly or monthly. Possible values: {0, 1, 2} 0 - Daily 1 - Weekly 2 - Monthly
Properties for daily (jrs.days_id=0)
jrs.is_weekday	Specifies whether to run a report on each weekday (Monday to Friday).
jrs.day	Specifies that the report will run once every how many days specified here (when jrs.is_weekday is false). For example, if the value is set to 1, the report will run once everyday. If the value is set to 2, the report will run once every 2 days. Possible values: 1 to 999 days
Properties for weekly (jrs.days_id=1)
jrs.week	Specifies that the report will run once every how many weeks specified here. Possible values: 1 to 99 weeks
jrs.weekdays	Specifies on which days to run in a week. Possible values: A digit string. {0, 1, 2, 3, 4, 5, 6}. 0 is Sunday, 1 is Monday, ..., and 6 is Saturday. Example: jrs.weekdays=05 means running on Sunday and Friday.
Properties for monthly (jrs.days_id=2)
jrs.is_day	Specifies whether to run on the xth day in a month.
jrs.day	Specifies to run on the xth day in a month (when jrs.is_day is true). Possible values: 1 to 31
jrs.week	Specifies to run on the xth week in a month (when jrs.is_day is false). Possible values: {0, 1, 2, 3, 4} 0 - The first week 1 - The second week 2 - The third week 3 - The fourth week 4 - The last week
jrs.weekday	Specifies to run on which day in the week (jrs.is_day is false). Possible values: {1, 2, 3, 4, 5, 6, 7}. 1 is Sunday, 2 is Monday, ..., and 7 is Saturday.
jrs.month	Specifies that the report will run once every how many months specified here. Possible values: 1 to 6 months.
Properties for a specific time
jrs.hour	Specifies to run at which hour in a day. Possible values: 1 to 12
jrs.min	Specifies to run at which minute in an hour. Possible values: 0 to 59
jrs.is_pm	Specifies whether the time is PM or AM in a day.
Properties for hourly
jrs.is_hourly	Specifies whether to run the schedule every hour.
jrs.hours	Specifies that the report will run once every how many hours specified here. Possible values: 1 to 99 hours
jrs.at_min	Specifies to run at which minute in an hour. Possible values: 0 to 59
jrs.is_between	Specifies whether to run between the start time and the finish time. When the value is true, see Properties for when jrs.is_between=true to define a time duration.
Properties for minutely
jrs.is_minutely	Specifies whether to run the schedule every minute. Note: The property jrs.is_hourly has the higher priority. That is, if you set both jrs.is_hourly and jrs.is_minutely to true, the schedule will run the task based on hour.
jrs.minutes	Specifies that the report will run once every how many minutes specified here.
jrs.is_between	Specifies whether to run between the start time and the finish time. When the value is true, see Properties for when jrs.is_between=true to define a time duration.
Properties for when jrs.is_between=true
jrs.hour	Specifies the start hour of a period of time. Possible values: 1 to 12
jrs.min	Specifies the start minute of a period of time. Possible values: 0 to 59
jrs.is_pm	Specifies whether the start time is PM or AM.
jrs.hour2	Specifies the finish hour of a period of time. Possible values: 1 to 12
jrs.min2	Specifies the finish minute of a period of time. Possible values: 0 to 59
jrs.is_pm2	Specifies whether the finish time is PM or AM.

Properties for Viewing Report Results

Property	Description
jrs.file	Specifies the file name of the result.
jrs.hist_file	Specifies the file name of the result with its real path in the `<install_root>\history` folder, for example, 1%2fadmin567625353%2f2109098280.pdf.
jrs.resource_path	Specifies the path of the resource in the server resource tree, for example, /SampleReports.
jrs.result	Specifies the name of the result with its path in the server resource tree, for example, /SampleReports/InvoiceReport.
jrs.rst_version	Specifies the version number of the result.
jrs.ver_suff	Specifies the suffix of the result file. Possible values: .rst - The suffix of Logi JReport result (for page report) or web report result (for web report). .html - The suffix of the HTML result file. .pdf - The suffix of the PDF result file. .txt - The suffix of the Text result file. .xls - The suffix of the Excel result file. .ps - The suffix of the PostScript result file. .rtf - The suffix of the RTF result file. .xml - The suffix of the XML result file.
jrs.version_number	Specifies the version number of the resource, for example, 1.
type	Specifies the type of the result. Possible values: rstfile - Gets the result versions attached to a specific report. rstdoc - Gets the versions of a specific result.
jrs.is_pls_result=true	Applies cached report bursting to view the result.

Properties for Adding and Deleting Users/Roles

Property	Description
currentEditRealm	Specifies the security realm in which the user/role is.
user	Specifies the name of the user.
fullName	Specifies the full name of the user.
email	Specifies the e-mail address of the user.
password	Specifies the password of the user.
confirmPassword	Confirms the password.
accountDisabled=ON	Disables the user account for the time being.
passwordLife	Specifies the validity period of the password. Possible values: neverExpire When passwordLife=neverExpire, the password will not expire. expire When passwordLife=expire, you can specify a period of time during which the password is valid, by setting the expireTime property.
expireTime	Specifies a period of time in days during which the password is valid.
enableBlank	Specifies the length of the password. Possible values: blank When enableBlank=blank, the password can be blank. minValue When enableBlank=minValue, you can specify the minimum number of characters that can be used in the password, by setting the minLength property.
minLength	Specifies the minimum number of characters that can be used in the password. Possible values: 1 to 20
roleName	Specifies the name of the role.
parentRoles	Specifies the parent role for the role. Possible values: An existing role name or "NoneParent" which means that the role does not have a parent role.
description	Specifies the description for the role.
jrs.privilege_publish_report	Specifies whether to grant the user/role the ability to publish resources to Logi JReport Server.
jrs.privilege_access_advanced_properties	Specifies whether to grant the user/role the ability to view advanced version properties information, such as catalog connections and report related resources.

Previous Topic Next Topic

Appendix 1: URL Properties

General Properties for Running and Scheduling Reports

Properties for Scheduling Reports

Properties for Viewing Report Results

Properties for Adding and Deleting Users/Roles

Recently viewed articles

Related articles