Crystal Reports 7.0. Overview. Contents. Web Reports Server URL Commands. Crystal Web Report Server Parameters

Transcription

1 Overview Contents Crystal Web Report Server Parameters The purpose of this document is to outline the commands that can be sent to the Web Reports Server from the URL Command line. New parameters have been added for version 7.0 of the Crystal Web Reports Server. CRYSTAL WEB REPORT SERVER PARAMETERS...1 CMD# and EXPORT_FMT...2 GF...2 INIT...3 LOGDIR...4 LOGS...5 PASSWORD#...5 PROMPT#...6 PromptOnRefresh#...7 SF...7 USER#...7 CONTACTING CRYSTAL DECISIONS FOR TECHNICAL SUPPORT...8 When requesting a report from the Crystal Web Report Server, or setting up a link to a report from another web page, there are several optional parameters available to customize the information returned. Commands are passed with a report request by appending the URL address of the report with a question mark followed by each command you want to use. Commands can be passed in any order and in any combination. All commands are optional; if you do not specify any commands, the original report will be returned. The following is an example of using commands when requesting a report: nrefresh=1 Notice that each command is specified in the form: 7/4/2002 5:21 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 1

2 command=value where command is the name of the command, and value is the value you assign to that command. You should also notice that the initial command is preceded by a question mark (?) and multiple commands are separated by an ampersand (&). The following commands are available when requesting a report of the Crystal Web Report Server via the URL command line: CMD# and EXPORT_FMT GF INIT LOGDIR LOGS PASSWORD# PROMPT# PROMPTONREFRESH# SF USER# CMD# and EXPORT_FMT Specifies that the report should be exported to the indicated format. cmd=export&export_fmt=<export_fmt representation> «<EXPORT_FMT representation > is one of the following: Export Format HTML 3.0(Draft Standard) HTML3.2(Extended) HTML 3.2(Standard) Crystal Reports(RPT) Excel 2.1(XLS) Excel 3.0(XLS) Excel 4.0(XLS) Excel 5.0(XLS) Excel 5.0(XLS)Extended Rich Text Format (RTF) Word Document(DOC) EXPORT_FMT Representation U2FHTML:0 U2FHTML:1 U2FHTML:2 U2FCR:0 U2FXLS:0 U2FXLS:1 U2FXLS:2 U2FXLS:3 U2FXLS:4 U2FRTF:0 U2FWORD:0 For example: let's say that a user would like the report test.rpt downloaded to his browser in Microsoft Word format. The URL (ISO - Latin encoded) would be the following: A0 GF Specifies a group selection formula. This command is similar to SF command (selection formula). However, this command does not refresh report data if data is stored with the report. 7/4/2002 5:21 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 2

3 GF=<formula> <formula> is a selection formula in string format. For example: GF= Sum({customer.Sales},{customer.Region})>10000 The above example selects all groups where the sum of all customer sales in each region is greater than 10, NOTE The command GF only works on summarized fields. INIT Specifies how the report should be displayed in the web browser. For example: init=java Possible values are: Java - Crystal Smart Viewer/Java Crystal Smart Viewer/Java Overview The Crystal Smart Viewer/Java is a standard Java applet that can be placed inside an HTML page and viewed through any browser that supports Java. Netscape Navigator, version 2.0 and later, will display reports using the Crystal Smart Viewer/Java by default. The Java viewer must have access to either the Crystal Web Report Server (see Overview, Developer Help) or the Report Server Active Server Page (see Building Active Web Sites Index, Developer Help). The Crystal Web Report Server can be installed on any machine running Microsoft Internet Information Server (IIS), Netscape FastTrack Server, or Netscape Enterprise Server. The Report Server Active Server Page is installed with the Crystal Design-Time ActiveX Control. There may be JavaScript errors encountered while using Netscape 4.x browsers when drilling down on data then clicking the Back button to return to the last view. Please click the corresponding tab for the view you want to retrieve rather than the Back button and these errors will not occur. actx - Crystal Smart Viewer/ActiveX Crystal Smart Viewer/ActiveX Overview The Crystal Smart Viewer/ActiveX is an ActiveX control that can be placed inside an HTML page and viewed through any browser that supports ActiveX. Microsoft Internet Explorer, version 3.02 and later, will display reports with the Crystal Smart Viewer/ActiveX by default. The ActiveX viewer must have access to either the Crystal Web Report Server or the Report Server Active Server Page (see Building Active Web Sites Index). The Crystal Web Report Server can be installed on any machine running Microsoft Internet Information Server (IIS), Netscape FastTrack Server, or Netscape Enterprise Server. The 7/4/2002 5:21 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 3

4 Report Server Active Server Page is installed with the Crystal Design-Time ActiveX Control. There may be JavaScript errors encountered while using Netscape 3.x browsers when drilling down on data then clicking the Back button to return to the last view. Please click the corresponding tab for the view you want to retrieve rather than the Back button and these errors will not occur. html_frame - Crystal Smart Viewer/HTML (with frames) Crystal Smart Viewer/HTML Overview The Crystal Smart Viewer/HTML is not an actual viewer component that can be configured. Instead, the Crystal Web Report Server or the Crystal Report Engine Automation Server translates a report into a set of web pages using HTML 3.2 format. Web browsers with support for HTML 3.2 table tags will be able to view such documents (i.e., Netscape Navigator 2.0 or later, Microsoft Internet Explorer 2.0 or later). Browsers supporting font colors and table cell background colors will render a more accurate view of actual report objects (Netscape Navigator 3.0 or later and Internet Explorer 2.0 or later). There may be JavaScript errors encountered while using Netscape 3.x browsers when drilling down on data then clicking the Back button to return to the last view. Please click the corresponding tab for the view you want to retrieve rather than the Back button and these errors will not occur. html_page - Crystal Smart Viewer/HTML (standard) Crystal Smart Viewer/HTML Overview The Crystal Smart Viewer/HTML is not an actual viewer component that can be configured. Instead, the Crystal Web Report Server or the Crystal Report Engine Automation Server translates a report into a set of web pages using HTML 3.2 format. Web browsers with support for HTML 3.2 table tags will be able to view such documents (i.e., Netscape Navigator 2.0 or later, Microsoft Internet Explorer 2.0 or later). Browsers supporting font colors and table cell background colors will render a more accurate view of actual report objects (Netscape Navigator 3.0 or later and Internet Explorer 2.0 or later). There may be JavaScript errors encountered while using Netscape 3.x browsers when drilling down on data then clicking the Back button to return to the last view. Please click the corresponding tab for the view you want to retrieve rather than the Back button and these errors will not occur. If the INIT command is not specified, the Crystal Web Report Server will detect the type of browser requesting a report and will provide a default viewer for that browser. For instance, if the browser is Netscape Navigator 4.5, the Crystal Web Report Server will display the report using the Crystal Smart Viewer/Java. Not all browsers support all methods of viewing reports. For instance, versions of Netscape Navigator and Internet Explorer earlier than 3.0 do not support Java applets or ActiveX controls. LOGDIR 7/4/2002 5:21 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 4

5 Specifies the directory of the web server log if the report is based on a web log file. This directory path can be a UNC path. NOTE You cannot report off of web log files on a Win9x system, the system will crash or even GPF! LOGDIR=<log_directory> <log_directory> is the full path to the log file directory in string format. For example: logdir=c:\inetsrv\logdir logdir=\\server\c\inetsrv\logdir NOTE This command is only valid when you are requesting reports based on web server activity logs. LOGS Specifies a date range for the web server log file to report on. NOTE You cannot report off of web log files on a Win9x system, the system will crash or even GPF! LOGS=<log_range> <log_range> is the date range of the log files to report on expressed in a string format. The following examples illustrate correct formats for the <log_range> string: logs= <std,all> Obtains IIS standard activity log information from December 31, 1996, to January 15, logs= <ncsa,all> Obtains NCSA standard activity log information for the entire year of NOTE This command is only valid when you are requesting reports based on web server activity logs. PASSWORD# Specifies passwords for logging on to SQL, ODBC, or password-protected databases used by the report. PASSWORD#=<password> <password> is a string. For example: 7/4/2002 5:21 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 5

6 password0=secret If the report accesses more than one password protected database, multiple passwords can be passed by incrementing the index number. For example: password0=secret&password1=mystery&password2=unknown PASSWORD# is normally used in conjunction with USER# command. For example: user0=smithj&password0=secret&user1=johns&password1=mystery Make sure passwords appear in the URL in the same order that the password protected databases appear in the report. If passwords are not passed using the URL address, the user will be prompted for logon information at runtime. For subreports, you will need to explicitly log on to subreports if the subreports data sources are password protected. The correct format for logging on to subreports is the following: Also, the subreportname portion of this parameter must be identical to how it appears in the Crystal Reports Designer. For instance, if the subreport is shown in the Designer as subreport1.rpt, then you will want to log on as follows: However if the subreport is shown in the Designer as subreport1, then you will want to log on as follows: PROMPT# Specifies values for parameter fields in the report. Parameter field values are assigned to parameter fields in the order that the parameter fields exist in the report. For Crystal Reports 7, the PROMPT# command also includes Stored Procedure parameters. PROMPT#=<parameter_field_values> <parameter_field_values> is a string. For example: prompt0=ca If the report contains more than one parameter field, multiple parameter field values can be passed by incrementing the PROMPT index value. For example: prompt0=ca&prompt1=1000 Make sure parameter field values appear in the URL in the same order that the parameter fields and the Stored Procedures appear in the report. If parameter field values are not passed using the URL address, the user will be prompted to provide values at runtime. 7/4/2002 5:21 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 6

7 PromptOnRefresh# Specifies whether a report should prompt for parameter field values when refreshed. promptonrefresh#=<value> <value> is 0 or 1. For example: promptonrefresh=1 Reports that have the promptonrefresh command applied will not have their pages shared. Caching will be by user. SF Specifies a selection formula. Will automatically refresh report data. SF=<formula> <formula> is a selection formula in string format. For example: Universal Selects all records where the studio is Universal. USER# Specifies user IDs for logging on to SQL, ODBC, or password-protected databases used by the report. USER#=<userid> <userid> is a string. For example: user0=smithj If the report accesses more than one password protected database, multiple user IDs can be passed by incrementing the USER index number. For example: user0=smithj&user1=johns&user2=jsmith USER# is normally used in conjunction with PASSWORD# command. For example: user0=smithj&password0=secret&user1=johns&password1=mystery Make sure user IDs appear in the URL in the same order that the password protected databases appear in the report. If user IDs are not passed using the URL address, the user will be prompted for logon information at runtime. For subreports, you will need to explicitly log on to subreports if the subreports data sources are password protected. The correct format for logging on to subreports is the following: 7/4/2002 5:21 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 7

8 Also, the subreportname portion of this parameter must be identical to how it appears in the Crystal Reports Designer. For instance, if the subreport is shown in the Designer as subreport1.rpt, then you will want to log on as follows: However if the subreport is shown in the Designer as subreport1, then you will want to log on as follows: Contacting Crystal Decisions for Technical Support We recommend that you refer to the product documentation and that you visit our Technical Support web site for more resources. Self-serve Support: Support: Telephone Support: 7/4/2002 5:21 PM Copyright 2001 Crystal Decisions, Inc. All Rights Reserved. Page 8