Defining custom AR System reports


AR System reports are often used to export data in XML, .arx, or .csv format for use in another application or on another AR System server. In addition, you can use the AR System reports to generate statistical values based on the data. AR System reports can be run on the Web.

To create an AR System report

  1. In the Report Console, click New.
  2. Select the AR System report type.
    The ReportCreator opens in New mode.
    AR Report.png
    If you click Add All while creating reports, you might experience a delay in the generation of reports if your form contains multiple fields. To shorten the duration of report generation, disable the client-side logs. 
  3. In the Report Name field, enter a unique, locale-specific name for the report, for example, MyReport-en.
  4. From the Report Format list, select one of the following options:
    • Record—Displays each field of the request on a separate line.
    • Column—Displays each field as a column heading and displays information from each request in a separate row.
    • Compressed—Compresses the information with commas, white space, or any other specified characters between the columns. In a browser, the compressed format is viewed in a column format.
  5. (For administrators) In the Locale field, enter the locale of the report in the format language_Country, for example, pt_BR.
    The country portion of the locale code is optional, depending on whether you want to allow all country variations of a language to use the report. If you enter only the language portion, all country variations of a language can use the report. For example, an entry of pt would include all country variations of Portuguese, but pt_BR designates only Brazilian Portuguese.
    In AR Reports, a comma (,) is displayed as a delimiter between date and time values for a few locales such as English or German.
    For a list of standard choices for this field, check the Locale view property on any form in Developer Studio.
  6. In the Report Set field, enter a locale-independent description for the report.
    The Report Set field is used to identify locale variants of the same report. The combination of Report Set and Locale must be unique.
  7. Update each tab in the form as described in the following sections.
    Entries that are specific to Windows reports are identified in each of the tabs. Those settings are ignored for Web reports.
  8. Save the report.

To specify fields for a report

  1. Open the Fields tab.
  2. In the Field field, click the menu button to select which fields on the specified form will be displayed on the report.
  3. In the Label field, enter the field name as you want it displayed on the report.
  4. In the Field to Add Before/After field, select a field to use as a reference when clicking the Add After or AddBefore buttons.
  5. Click Add Before or Add After to set the positioning of fields in a report, with reference to the Field to Add Before/After field. 
    You can click Remove to remove a selected field or click Remove All to remove all selections from the field list.
  6. Click Modify to update the selected field label or width specification.

To specify sorting criteria for a report

  1. Open the AR Systemtab.
  2. From the first FieldName list, select the field on which you want to sort.
  3. Select Ascending or DescendingSortOrder for the selected field.
  4. To group by a field, select the Group check box for the selected field.
  5. Repeat steps 1 through 3 for the other fields on which you want to sort.
    You can select up to five fields for sorting.

To specify report records

  1. Open the Qualification tab.
  2. In the Qualification table, define a qualification (query) to specify which records to include in a report.
    report_console.png
    • Only an administrator can access the report console.
    • If a report is run from a results list, any qualifications defined in this tab are ignored.
    • The Advanced search option on the report console honors the AR System server time zone. For more information, see Advanced search - date range in the AR Report Console article on BMC Communities.

    • To view the report in user's time zone, select the Filter and Override option.

To enter description for a report

  1. Open the Description tab.
  2. In the Provide a description for the report field, enter description about the report.
  3. In the Provide a descriptive comment for the report field, enter additional comments for the report.

To set permissions for a report

  1. Open the Permissions tab.
  2. In the Assignee Groups field, define the groups that can access the report.
    If the server is configured to allow multiple groups in the Assignee Group field, this field will allow multiple groups to be specified, separating each group with a single space. If the server is not configured to allow multiple groups, only one group can be specified in this field. 
    Leaving the Assignee Groups field blank allows only the submitter to view the report. Specifying Public allows anyone to view the report.

To specify the report administrator and status

  1. Open the Administration tab.
  2. In the Submitter field, enter the name of the user creating the report.
  3. In the Status field, select one of the following options:
    • Active—Makes the report available in the Report Console.
    • Inactive—Indicates a report that is no longer active.
    • Pending—Indicates a report that is being reviewed.

      If Inactive or Pending is selected, the report does not appear in the Report Console list.