Show Menu
TOPICS×

Report.cfg Parameters

Information about Report.cfg parameters.
The sample Report.cfg shown in Configure the Report Set contains only the parameters included in the Report.cfg file by default. The following table provides descriptions of all of the available Report.cfg file parameters.
If you need to add additional parameters to a Report.cfg file, you must do so using a text editor. For steps to do so, including examples of how to define each parameter entry, see Editing Existing Report.cfg Files .
The parameters in this table are listed in alphabetical order. When you open the Report.cfg file in Data Workbench, vectors are listed in alphabetical order, followed by individual parameters listed in alphabetical order.
Parameter Description
Alert Threshold
Optional . This parameter applies only to reports with metric indicators. Number of metric indicators that must appear in the worksheet before an alerting report is sent.
If only one metric is being monitored in the metric indicator worksheet, set the threshold to 1. The report is generated when the metric in the sheet evaluates to an up/down arrow or an X. If more than one metric is being monitored in the report, you can select the number of metric indicators that must evaluate to an up/down arrow or an X before the report is generated. For example, if two metrics are being monitored:
  • If the threshold is set to 1, the report is generated if either of the metrics in the sheet evaluate to an up/down arrow or an X.
  • If the threshold is set to 2, both of the metrics must evaluate to an up/down arrow or an X before the report is generated.
For more information about metric indicators, see the Data Workbench User Guide .
Allow Report Regeneration
Indicates whether Report Server automatically generates or regenerates particular reports when you create or modify those reports. The options are true or false. If set to true, creating or modifying a report workspace causes Report Server to regenerate that report for the most recent run.
Note: Changing the Report.cfg file causes Report Server to regenerate all reports controlled by that Report.cfg file.
Attachments
Optional . Section identifier for the name and content type of any attachments that go out with reports distributed via email, including the number of attachments.
To add a new attachment:
  1. Open the Report.cfg file in Data Workbench.
  2. Right-click Attachments and click Add new child > Attachment .
Content Type
Content type of the file to be attached.
Example: image/jpeg
FileName
Location and name of the file to be attached.
Example: c:\myimage.jpg
Color Set Identifies the color scheme to be used for .png files. 0 is for a black background; 1 is for a white background; and 2 is for a grayscale image.
Command To Execute Optional . A batch command or executable that runs after the report set is generated. If launch of the command shell interpreter is required, precede the command with cmd /c.
Default Excel Template
Optional . File name of the generic Excel template file ( .xls or .xlsx ) that you want to use when generating reports as Excel files. This parameter supports full file paths, such as c:\templates\mytemplate.xls .
This file is used for all Excel reports unless a template has been defined specifically for a particular report. See Using a Template File .
Dimension Name Optional . Name of the dimension for which you want to dynamically generate a report. If you enter a dimension name in this parameter, you must enter a value in either the Lookup File parameter or the Top N Metric and Top N Value parameters. The dimension named in this parameter must exist in the dataset for which reports are being created.
Email Only If Perfect Optional . Lets the user specify that a report set should be sent out only when no errors occurred during the run. The options are true and false. The default value is false.
End Date
Optional . The last date and time that you want the report set to run. This time is based on the As Of time of the dataset.
Format: MM/DD/YYYY hh:mm time zone, using the 24-hour syntax for time
Example: 08/01/2007 12:01 EDT
For more information about time zone settings, see the Dataset Configuration Guide .
Every Frequency of the report set generation: day, week, or month.
Excel Watchdog Timeout (seconds)
Optional . The number of seconds that you want Report Server to wait for Microsoft Excel to respond when generating a report as an Excel file before Report Server decides that Excel is not responding and terminates the process. Using this parameter enables Report Server to terminate Excel when it becomes unresponsive and continue processing your non-Excel reports. The default is 300.0. To disable this functionality, set this parameter to 0.0.
Make sure that the value you define is long enough to allow the report to be exported to Excel. Otherwise, Report Server may prematurely terminate Excel and your report will not generate.
Filter Formula
Optional . Filter that is applied to every workspace in the report set.
For more information, see the syntax for creating filters .
Gamma Correction
Gamma setting for .png file output. The default is 1.6.
Note: Adobe recommends that you do not change this value.
Hide Logos Indicates whether Report Server hides the logos when generating your reports. The options are true or false . If set to false , your report is generated with the Report logo. The default is false .
Lookup File
Optional . When this parameter is populated, Report Server runs in dynamic mode and generates reports for each element of the dimension specified in the Dimension Name parameter. This file must contain two tab-delimited columns, without a header row.
  • Column 1 contains a list of dimension elements.
  • Column 2 contains the email addresses of the report recipients. A report for a given element in column 1 is sent to the email address on the same row in column 2. You can enter multiple email addresses by separating them with commas (no spaces). If reports are not to be emailed, this column can be empty but must exist.
Note: If you enter a value in this parameter, you must enter a value in the Dimension Name parameter.
Notification Only This Report Server setting allows you to configure data workbench to send an email when a report is generated. Setting this value to true does not send out the report, but rather sends an email notifying the subscribed user that the report has been generated.
Mail Report
Section identifier for distributing reports via email. To distribute reports via email, complete the following parameters for the Mail Report entry. All reports in the report set are emailed in one message to the email addresses specified in the Recipients parameter.
Note: Report Server sends an email only when it has generated at least one report.
To enable the emailing of reports, you must complete at least the following parameters for this entry:
  • SMTP Server
  • Recipients
  • Sender Address
  • Notification Only
Note: To send out reports by email after re-generating a report set, see Editing Existing Report.cfg Files .
The Notification Only value is available in 5.4x and 5.5x releases.
For a large set of recipients to be notified (more than 20), it is highly recommended that you use email distribution lists.
Body XSL Template
Optional . Path of the XSL template file to be applied to the reports.xml file. Using this parameter enables Report Server to send your reports within the distributed email instead of as attachments. The resulting text is used as the body of the email message.
See Report Sample Files for a sample file.
For information about Extensible Stylesheet Language (XSLT), see The Extensible Stylesheet Language Family .
Recipients Email addresses of the people to whom you want to send the report.
Sender Address Email address of the sender.
Sender Name Optional. Name of the sender.
SMTP Server Address of the SMTP server machine and the password and user name required for authentication.
Subject Optional . Subject line describing the email to be sent.
Notification Only Lets you configure data workbench to send an email when a background report is generated. Setting this value to True does not send out the report, but rather sends an email linking the subscribed user to the report location.
Output Root
Optional . Output location of the generated report sets. The default is the <profile name> \Reports folder within the Report Server installation directory.
To configure Report Server to output reports to a portal, set the Output Root to the document root of the web server used for the portal.
Preload Query Filter
Optional . This parameter applies only to the Top Dimension Element report type.
The name of the filter that you want to apply to the query that must be run to determine the top N dimension elements before the report can be generated. The default is Broken_Session_Filter . For more information about the Broken Session Filter , see the Data Workbench User Guide .
Report Types
Format(s) in which you want to generate your output. You can use any or all of the following options to output the report set in multiple formats at one time:
  • Excel creates an Excel workbook with one visualization per worksheet. As a general rule, use Excel files for email distribution. See Generating Reports as Microsoft Excel Files . For information about using a template file, see Using a Template File .
  • png creates Portable Network Graphic files. As a general rule, use .png files for display in a web browser (portal).
  • Thumbnail creates a thumbnail ( .jpg file) of the workspace. The default size is 240x180. To change the default size, edit the Thumbnail X and Thumbnail Y parameters.
To add a new report type when editing Report.cfg in data workbench, right-click Report Types , click Add new child , and select the desired report type.
Start Date
The first date and time that you want the report set to run. This time is based on the As Of time of the dataset.
Format: MM/DD/YYY hh:mm time zone, using the 24-hour syntax for time.
For more information about time zone settings, see the Dataset Configuration Guide .
Note: The reports start to run when the timestamps of the data in the profile match the date and time specified.
Example:
If the start date is 08/08/2006 12:00 EST, reports run for data with a timestamp of 08/08/2006 12:00 EST and later.
  • Daily reports will run for 08/08/2006 and each day thereafter for data with hh:mm = 12:00 EST.
  • Weekly reports will run for 08/08/2006 and for every 7th day thereafter for data with hh:mm = 12:00 EST.
  • Monthly reports will run for 08/08/2006 and for the 8th day of each month thereafter for data with hh:mm = 12:00 EST.
The Report Time metric affects “Last N” reporting dimensions, such as “Last 7 Days,” “Yesterday,” and “3 weeks ago.” For queries in Report Server, the Report Time metric ( Report Time.metric ) identifies the date and time for which the reports are being run. This is initially the date and time specified in the Start Date parameter, which then increments by the period specified by the Every parameter. For queries in data workbench, the Report Time metric is based on midnight of the As Of metric ( As Of.metric ). Because of the difference in the definitions of the Report Time metric, if you query a workspace that uses a Last N dimension, you can receive different results in data workbench and Report Server for the same workspace.
Thumbnail X Optional . Integer controlling the size (in pixels) of the X axis of thumbnails generated as output.
Thumbnail Y Optional . Integer controlling the size (in pixels) of the Y axis of thumbnails generated as output.
Top N Metric
Optional . See the description for the Top N Value parameter.
Note: If you enter a value in this parameter, you must enter a value in the Dimension Name parameter and the Top N Value parameter.
Top N Value
Optional . When this parameter is populated, Report Server runs in dynamic mode and generates reports for the top number (specified in this parameter) of elements for the dimension specified in the Dimension Name parameter, counting by the metric specified in the Top N Metric parameter.
Example: If you enter Page in the Dimension Name parameter, Sessions in the Top N Metric parameter, and 5 in this parameter, the generated report lists the five top pages with the highest number of sessions.
Note: If you enter a value in this parameter, you must enter a value in the Dimension Name parameter and the Top N Metric parameter.
Use Local Sample Only Optional . Indicates whether you want Report Server to generate reports using only the local sample of the dataset. Setting this parameter to true enables you to view a sample of the report set (without placing a load on a data workbench server) to see how the output looks without taking all the time needed to fully process the data. This operates as a test function. The options are true or false. The default is false.
Workspace Path
Optional . Location of a collection of workspaces for a given report set. This is useful for maintaining a single copy of workspaces that need to be generated and distributed multiple ways, using Report.cfg files for multiple report sets. The root directory for this path can be any profile folder. Do not enter a slash (\) at the start of the path string.
Example: You can save the common workspaces for Set A and Set B in the Reports\Common folder, then define the Report.cfg files for two different report sets, each with different generation and distribution settings. In both Report.cfg files, you would set the Workspace Path parameter to profile name \Reports\Common.
XSL Output File Optional . Path of the output file that is created when the XSL Template is applied to the report index.
XSL Template
Optional . Path of the XSL template file to be applied to the report index. The resulting transformed .xml is written to the specified XSL Output File . See Report Sample Files for a sample file.
Note: Unless you use an .xsl template when generating your reports, all reports are distributed by email as attachments.