Format Report Output

The options on the Report Format page specify templates that control how the report's output is formatted.

To format a report with a template:

  1. In Configurator, expand Reports in the configuration tree to display the existing report definitions.

  2. Select the report that you want to edit.

    The report's property pages appear in the right pane.

  3. Click the Report Format tab.

    The report's current format templates are shown.

  4. Click Edit.

  5. To calculate report text for plain text-based (non-template) reports:

    • Click options or type values using the descriptions in the following table.

      Report definition calculation options
      Option Description

      Name calculation expression

      Type a VBScript expression to calculate the name of the worksheet that is created if users select Microsoft Excel output or of the table that is created if users select Microsoft Access output. Click the Meridian Enterprise Script Editor button to build a VBScript expression. For information on using VBScript for configuration expressions including their limitations, see the Accruent Meridian Enterprise VBScript API Reference.

      Header calculation expression

      Type a VBScript expression to calculate a header to appear at the top of each page. Click the Meridian Enterprise Script Editor button to build a VBScript expression. For information on using VBScript for configuration expressions including their limitations, see the Accruent Meridian Enterprise VBScript API Reference.

      Body calculation expression

      Type a VBScript expression to calculate the text that is output in the body of the report for each document upon which the report is built. The result of this expression will be output instead of the properties selected on the Report Data page. The report body may be one or the other but not both. If you want to include property values in the report body, they must be retrieved by this expression. Click the Meridian Enterprise Script Editor button to build a VBScript expression. For information on using VBScript for configuration expressions including their limitations, see the Accruent Meridian Enterprise VBScript API Reference.

      Footer calculation expression

      Type a VBScript expression to calculate a footer to appear at the bottom of each page. Click the Meridian Enterprise Script Editor button to build a VBScript expression. For information on using VBScript for configuration expressions including their limitations, see the Accruent Meridian Enterprise VBScript API Reference.

  6. To add a new template (for non-plain text reports), click the Add button.

    The New Report Template dialog box appears.

    1. Click options or type values using the descriptions in the following table.

    2. Click OK to close the New Report Template dialog.

      The template appears in the Templates list.

      Note:

      The template file will be stored in a hidden area of the vault. To edit the file later, edit a copy of the original file and replace it as described below. If you did not retain a copy of the original file outside of the vault, export the file first as described below.

      New report definition template options
      Option Description

      Text-based report generated from script expressions

      Formats the report output as plain text using the VBScript expressions typed in the top of the property page.

      Note:

      The document properties for each row of the report are specified by the Body calculation expression, not the properties selected on the Report Data page.

      MS Word template

      Click Browse to select a Microsoft Word file to format the report output. The structure of this template is described in Create a Microsoft Word Report Template.

      XSLT stylesheet

      Click Browse to select an  XSLT file to format the output of HTML reports. An example template named Sample report.xslt is installed in C:\Program Files\BC-Meridian\Program.

      For information about working with XSLT style sheets, see XSLT Tutorial and Incorporating <STYLE> Elements into an XSLT File.

      Note:

      When this option is enabled, the Body calculation expression option is ignored and the properties selected on the Report Data tab are output.

      Display name

      Type a name for the report template as you want it to appear to users.

      Name

      Type an internal name for the report template.

      Description

      Type an optional description of the template.

      Default extension

      Select a default file extension to be applied to files created by this report.

  7. To view an existing template, select the template and click View.

    The template is opened in a new viewer window.

  8. To edit an existing template, select the template and click Edit.

    The Edit Report Template dialog box appears.

    1. Click options or type values using the descriptions in the following table.

    2. Click OK to close the Edit Report Template dialog.

      Report definition template editing options
      Option Description

      Display name

      The name of the template as you want it to appear to users.

      Name

      A default internal name is calculated. Accept the default in most cases.

      Description

      An optional description of the template.

      Default extension

      Select a default file extension to be applied to files created by this report.

      To replace file

      Click Browse to select a different file to replace this template.

      Note:

      To edit the file, edit a copy of the original file and select it here. If you did not retain a copy of the original file outside of the vault, export the file as described below.

  9. To export an existing template, select the template and click Export.

  10. To delete an existing template, select the template and click Remove.

  11. Click OK.

2021 R2