Editing Existing Report.cfg Files

IMPORTANT

Read more about Data Workbench’s End-of-life announcement.

Steps to edit existing Report.cfg files using Worktop or a text editor.

NOTE
  • You must be working online to edit Report.cfg files. To work online, from the Worktop, right-click the title bar and click Work Online.

  • If the Allow Report Regeneration parameter in the Report.cfg file is set to True, when you make changes to that file and save that file back to the server, Report automatically re-generates the reports in that set. Although it regenerates the reports, it does not re-send the reports via email. For steps to do so, see Resending Reports by Email.

You can edit an existing Report.cfg from the Worktop or using a text editor.

Editing a Report.cfg file using the Reports tab of the Worktop enables you to edit only those parameters, vectors, and vector items that already exist in the file. If you need to add a parameter or vector to the file, you must edit it using a text editor, such as Notepad.

To edit an existing Report.cfg using the Worktop

NOTE

You must be working online to edit the Report.cfg from the Worktop.

  1. In data workbench, on the Reports tab, select the subfolder (tab or drop-down subdirectory) for the report set that you want to configure.

  2. Click Report.cfg. The parameters of the Report.cfg for this report set display.

  3. Edit the configuration parameters as desired. For information about these parameters, see Report.cfg Parameters.

  4. Save the file by right-clicking Report.cfg (modified) at the top of the parameters and clicking Save to*< server location>*.

To edit an existing Report.cfg using a text editor

  1. Open the Reports Manager by right-clicking within a workspace and clicking Admin > Profile > Reports Manager.

  2. Click the folder for your report set.

  3. Right-click the check mark next to the Report.cfg for this report set and click Make Local.

  4. In the User column, right-click the check mark next to Report.cfg for this report set and click Open > in Notepad. The Report.cfg file opens.

    The sample Report.cfg shown in Configure the Report Set contains only the parameters included in the Report.cfg file by default. The following example includes all of the parameters available for the Report.cfg file that you can use as models for your parameter entries:

    Attachments = vector: 1 items
      0 = Attachment:
        FileName = string: c:\\myimage.jpg
        Content Type = string: image/jpeg
    Alert Threshold = int: 0
    Allow Report Regeneration = bool: true
    Color Set = int: 1
    Command To Execute = string:
    Default Excel Template = string:
    Dimension Name = string:
    Email Only If Perfect = bool: false
    End Date = string:
    Every = string: month
    Excel Watchdog Timeout (seconds) = double: 300.0
    Filter Formula = string:
    Gamma Correction = double: 1
    Hide Logos = bool: false
    Lookup File = string:
    Mail Report = MailReport:
      Body XSL Template = string:
      Recipients = vector: 0 items
      SMTP Server = SmtpServerInfo:
        Address = string:
        Password = string:
        User = string:
      Sender Address = string:
      Sender Name = string:
      Subject = string:
    Notification Only = bool: false
    Output Root = string:
    Report Types = vector: 3 items
      0 = string: thumbnail
      1 = string: png
      2 = string: excel
    Start Date = string: 7/1/06 19:16 EDT
    Thumbnail X = int: 240
    Thumbnail Y = int: 180
    Top N Metric = string:
    Top N Value = int: 0
    Use Local Sample Only = bool: false
    Workspace Path = string:
    
  5. Edit the configuration parameters as desired. For information about these parameters, see Report.cfg Parameters.

  6. Save and close the file.

  7. In the Reports Manager, right-click the check mark in the User column for the Report.cfg file and select Save to*< profile name>*.

On this page