URL Properties for Running, Scheduling, and Viewing Reports via URL

Example: /SampleReports, or /SampleReports/Payroll Report.cls

Example: /SampleReports/SampleReports.cat, or %2fSampleReports%2fSampleReports.cat

Example: /SampleReports/Employee Information List.cls, or %2fSampleReports%2fEmployee Information List.cls

• If the resource is in the Public Reports folder in the server resource tree, you should start the path with "/". For example, for the /Public Report/SampleReports folder, provide the path as "/SampleReports".
• If the resource is in the My Reports folder in the server resource tree, you should start the path with "/USERFOLDERPATH/username/" (change username to the real username with which you sign in to Report Server). For example, suppose your username is Jim and you want to access the /My Reports/Shipments folder, provide the path in the URL as "/USERFOLDERPATH/Jim/Shipments".

Possible values:

• 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)

Use jrs.param$PARAMETER_NAME=VALUE to set parameter values of a report, where PARAMETER_NAME is a parameter name and VALUE is a URL-encoded value of the parameter. For example, jrs.param$TERMSDAYS=30&jrs.param$PTODAY=May 21, 1998.

When specifying values for a multi-valued parameter, you need to add _isMultiple_jrs.param$PARAMETER_NAME=true before the parameter values, to declare that the parameter supports multiple values. For example: &_isMultiple_jrs.param$PM=true&jrs.param$PM=3&jrs.param$PM=16.

To apply all the values of a parameter, use jrs.param$PARAMETER_NAME=%07. See the example:

http://localhost:8888/jinfonet/tryView.jsp?jrs.report=%2fSampleReports%2fShipment+Status+Report.wls&jrs.catalog=%2fSampleReports%2fSampleReports.cat&jrs.result_type=8&jrs.param%24P_StartDate=2015-12-30&jrs.param%24p_EndDate=2017-1-1&jrs.param%24P_ShipperTerritory-Shipper+Territory=%07&jrs.param%24P_ShipperTerritory-Shipper+Name=%07&jrs.param_page=false

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)

The default value of the property is true. When you provide the value of a middle level cascading parameter (including old style cascading parameter) in the URL, the parameter dialog box only shows the lower-level parameters.

When you set the property value to false, Server will not display the parameter dialog box during the whole report running. Server uses the parameter values you provided and the default values of the other parameters to run the report.

Examples:

• http://localhost:8888/jinfonet/tryView.jsp?jrs.report=%2fSampleReports%2fEmployee Information List.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 List.cls&jrs.enable_nls=true&jrs.rpt_language=de&jrs.rpt_country=DE
• If you change Employee Information List_de_DE.properties to Employee Information List_aaa.properties in Employee Information List.cls's real path folder, for example C:\LogiReport\Server\history\1\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 List.cls&jrs.enable_nls=true&jrs.rpt_language=aaa

Example: Running a report with your JDBC connection object using the 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 set, propParams);

Possible values:

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

Possible values:

• 0 - IE or Chrome
• 1 - Firefox

Add the property CustomOffset=true in the URL if you want the date and time values in your report to use the time zone that you have set on the values in the XML data source, instead of using the time zone of your server runtime environment.

In the case you do not add the property in the URL, which means that CustomOffset=false, if you do not provide a specific time zone in the URL or session, the server runtime time zone is the time zone setting you defined on the Server Console > My Profile.

• The calculation of grouping and filtering on data of the Date/Time/DateTime type is always based on the runtime time zone, as the unified standard, regardless of the value-level time zone that you set in the XML data source.
• When CustomOffset=true, the values of parameters of the Date/Time/DateTime type always use the runtime time zone, regardless of the value-level time zone that you set in the XML data source.

Specify the Excel version. Possible values:

• 0 - The Excel output file uses the .xlsx format.
• 1 - The Excel output file uses the .xls format.

Specify the format of the Excel output. Possible values:

• 0 - It means Auto Format, and Server defines the format according to the objects in the report. Server uses Column Format when the report contains crosstabs or tables, or else Report Format.
  
• 1 - It means Report Format and uses the format as you designed in the template, for the report in Excel. Use this format if you just want to view the report in Excel.
  
• 2 - It means Column Format and calculates all components' row/column values in the report using the Columned property value of the report when exporting. Use this format if you want to actively use the report in Excel such as filtering and sorting.
  
• 3 - It means Data Format and only generates the report data without any format. This value is only available when jrs.excel_format=1.

• 0 - It means All Keep Existing and keeps all the settings of each object's Word Wrap property originally specified in the report.
• 1 - It means All Disabled and disables the Word Wrap property for all objects. That is, the Word Wrap property is false for all objects.
• 2 - It means All Enabled and enables the Word Wrap property for all objects. That is, the Word Wrap property is true for all objects.

• jrs.delimiter=%23(#)
• jrs.delimiter=~
• jrs.delimiter=/

Set this property to true if you want to use Windows end-of-line characters to indicate the start of a new line. Report will use two characters <cr> and <lf> at the end of the line. Or, set it to false if you want to use UNIX End-of-line characters to indicate the start of a new line. Report will only use the UNIX End-of-line character <lf>.

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

Possible values:

• 0 - Save the report to the built-in version folder. Not supported for organization users when the report is from the Public Reports folder.
• 1 - Save the report to the My Reports folder. You can then use jrs.archive_my_destination to specify a report version name with the path in the My Reports folder.
• 2 - Save the report to the Public Reports folder. You can then use jrs.archive_public_destination to specify a report version name with the path in the Public Reports folder. Not supported for organization users.

Possible values:

• true - Use multiple versions for the report. You can then use jrs.maxversion to specify the maximum number of versions in the version table of the report. 0 means unlimited number.
• false - Replace the old version with the new version.

Possible values:

• 0 - Server automatically deletes the report 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 - Server automatically deletes the report 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.

Possible values:

• 0 - Publish to the Report Server resource tree.
• 1 - Publish to a drive path.

Possible values:

• 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 Report 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 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. For more information, see the Report Javadoc.

Possible values: The attached file name.

Possible values: such as UTF-8, UTF-16, and ISO8859-1.

You can use jrs.mailencoding to specify the email encoding in the URL. When sending emails by RMI API, sometimes, Server might return wrong characters in the email. To avoid such problems, specify the same correct value of -Djreport.url.encoding on both the server and RMI client side.

For example, your web application calls Report Server (standalone) via the RMI function from WebSphere, and you want to use UTF-8 (rather than UTF8) as the email encoding, do as follows:

• Specify -Djreport.url.encoding=UTF-8 for both JVM running Report Server and WebSphere.
• Specify jrs.mailencoding=UTF-8.

Specify whether to generate the linked reports (excluding the detail reports) in the output when the report is linked with other reports. Generating linked reports at the same time will cause performance issue, especially when the linked reports contain a large amount of data. If you are only interested in the primary report, do not set this property.

jrs.to_mail_textmail and jrs.to_mail_htmlmail cannot work concurrently.

Changing the default value may cause abnormalities in report layout.

Specify the image type with which you want to display charts: GIF, JPEG, PNG, or Auto-select (Server will automatically detect the image format: GIF if the image colors are less than 256 colors or else JPEG).

Specify the Excel version:

• Excel 97-2003 Workbook (*.xls)
  Specify to run the file in the .xls format.
• Excel Workbook (*.xlsx)
  Specify to run the file in the .xlsx format.

Specify the format of the Excel output.

• Auto Format
  Specify to define the format according to the objects in the report. Server uses Column Format when the report contains crosstabs or tables, or else Report Format.
• Report Format
  Specify to use the format as you designed in the template, for the report in Excel. Use this format if you just want to view the report in Excel.
• Column Format
  Specify to calculate all components' row/column values in the report using the Columned property value of the report when exporting. Use this format if you want to actively use the report in Excel such as filtering and sorting.
• Data Format
  Specify to only generate the report data without any format. Data Format is only available for the Excel version of Excel 97-2003 Workbook (*.xls).

• All Keep Existing
  Specify to keep all the settings of each object's Word Wrap property originally specified in the report.
• All Disabled
  Specify to disable the Word Wrap property for all objects. That is, the Word Wrap property is false for all objects.
• All Enabled
  Specify to enable the Word Wrap property for all objects. That is, the Word Wrap property is true for all objects.

Specify the delimiter to separate fields.

• CSV Format
  Specify to use a comma to separate fields.
• Tab Delimited
  Specify to use a Tab delimiter to separate fields.
• Custom Delimiter
  Specify to separate fields by a user defined delimiter. Then, specify your own delimiter using jrs.mail_delimiter.

Specify whether you want to only contain the database column information in the generated XML file and to only contain the structure information of the report in the generated XML schema file.

Specify the path of an existing XML schema file (.xsd). Server generates the XML file based on it. Otherwise, Server generates a new XML schema file to the folder where the XML file is. The new XML schema file and the XML file will have the same name but with different extensions.

Possible values:

• jrs.margins_unit_mm - Use mm as the margin unit.
• jrs.margins_unit_inch - Use inch as the margin unit.

Possible values:

• jrs.to_fax_quality_best - Best fax quality.
• jrs.to_fax_quality_fast - Fast fax quality.
• jrs.to_fax_quality_normal - Normal fax quality.

Example: jrs.ftp0=jrs.ftpHost%3D192.0.0.1%26jrs.ftpPort%3D21...&jrs.ftp1=jrs.ftpHost%3D192.0.0.2%26jrs.ftpPort%3D22... (%3D represents "=" and %26 represents "&".)

Possible values: FTPHandler class name or null which is the default value.

Possible values:

• 0 - FTP
• 1 - SFTP
• 2 - SCP
• 3 - FTPS

Possible values:

• 0 - EXPLICIT
• 1 - IMPLICIT

Possible values: {yes, no}

Possible values:

• TAG_FTP_CONNECTION_FAILED - Server cannot create the connection because the host name/IP or port is not valid.
  Possible value: 100 (the only value)
• TAG_FTP_CONNECTION_IS_OK - The connection is valid.
  Possible value: 200 (the only value)
• TAG_FTP_NO_PERMISSION - Server can build the connection, but the username or password is not valid.
  Possible value: 300 (the only value)
• TAG_FTP_INVALID_FOLDER - Server can build the connection but cannot find the folder where the output files reside.
  Possible value: 400 (the only value)

Possible values: time zone ID strings of Java. The default is current locale.

Possible values:

• 0 - Immediately
• 1 - At a specified date and time
• 8 - Periodically

Possible values: 0 to 11. 0 is January, 1 is February, ..., and 11 is December.

Possible values: 0 to 11. 0 is January, 1 is February, ..., and 11 is December.

Possible values:

• 0 - Daily
• 1 - Weekly
• 2 - Monthly

Possible values: 1 to 999 days

Possible values: 1 to 99 weeks

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.

Possible values: 1 to 31

Possible values:

• 0 - The first week
• 1 - The second week
• 2 - The third week
• 3 - The fourth week
• 4 - The last week

Possible values: 1 to 7. 1 is Sunday, 2 is Monday, ..., and 7 is Saturday.

Possible values: 1 to 99 hours

The property jrs.is_hourly has the higher priority. If you set both jrs.is_hourly and jrs.is_minutely to true, the report will run hourly.

Specify the data source. It is a JSON string, with the format:

jrs.datasources=
{
    jrs.datasources:[
    {
        "jrs.data_source_name":"xxx",
         "jrs.connections":[
        {
            "jrs.connection_name":"xxx",
            "jrs._ds_driver":"xxx",
            "jrs._ds_url":"xxx",
            "jrs.ds_user":"xxx",
            "jrs.ds_pswd":"xxx",
            "jrs.databases":[
            // The database list in the MongoDB connection, which is an array.
            {
                "jrs.dbs_catalog-database-name":"xxx", // The database name you defined in the catalog for MongoDB.
                "jrs.dbs_database-name":"xx", // The new database name you want to use at runtime to replace the original database name you defined in MongoDB APE.
                "jrs.dbs_collections":[
                // The collection list in a MongoDB database, which is an array.
                {
                    "jrs.dbs_catalog-collection-name":"xxx", // The collection name you defined in the catalog for MongoDB.
                    "jrs.dbs_collection-name":"xxx" // The new collection name you want to use at runtime to replace the original collection name you defined in MongoDB APE.
                }
                ]
            }
            ]
        }
        ]
    }
    ]
}

URL Example:

http://localhost:8888/jinfonet/tryView.jsp?…&jrs.datasources={jrs.datasources:[{"jrs.data_source_name":"xxx","jrs.connections":[{"jrs.connection_name":"xxx","jrs._ds_driver":"xxx","jrs._ds_url":"xxx","jrs.ds_user":"xxx","jrs.ds_pswd":"xxx","jrs.databases":[{"jrs.dbs_catalog-database-name":"xxx","jrs.dbs_database-name":"xx","jrs.dbs_collections":[{"jrs.dbs_catalog-collection-name":"xxx","jrs.dbs_collection-name":"xxx"}]}]}]}]}…

Possible values:

• .rst - The suffix of Logi Report Result (for page report) or Web Report Result (for web report).
• .html - The suffix of the HTML file.
• .pdf - The suffix of the PDF file.
• .txt - The suffix of the Text file.
• .xls - The suffix of the Excel file.
• .ps - The suffix of the PostScript file.
• .rtf - The suffix of the RTF file.
• .xml - The suffix of the XML file.

Possible values:

• rstfile - Get the result versions of a specific report.
• rstdoc - Get the versions of a specific result.
  

Possible values:

• neverExpire
  Set passwordLife=neverExpire if you don't want the user password to expire.
• expire
  Set passwordLife=expire, and then specify the number of days during which the password is valid, by setting the expireTime property.

Possible values:

• blank
  Set enableBlank=blank if the password can be blank.
• minValue
  Set enableBlank=minValue, and then specify the minimum number of characters in the password, by setting the minLength property.

Possible values: 1 to 20

Possible values: An existing role name or "NoneParent" if the role does not have a parent role.