☰
Navigation :

Report Configurations

Report configurations allow you to create custom report types in the RALS™ SYSTEM and combine data that are not available in any single data table. Report configurations can be used to create custom queries, define how data are displayed, create aggregate columns, add summary rows, and split data into separate tables.

See Supported Resources for more information about the scope of this reporting feature.

Jump to a heading on this page:
Supported Resources
Default Reports
Institution Access
Adding
Editing
Cloning
Deactivating or Deleting
Splitting
Aggregating
Summary Rows
Fields

Supported Resources

Currently, report configurations can include data from the following resources:

Default Reports

The following report configurations are available in the RALS™ SYSTEM by default:

Institution Access

Report configurations are a system-wide resource without any institution identity.

Adding

Report configurations can be added. See Add Fields for more information.

Editing

Report configurations can be edited. See View or Edit Details Fields for more information on editing a report configuration.

Cloning

Report configurations can not be cloned.

Deactivating or Deleting

Report configurations can be deactivated.

Splitting

Reports can be split into separate tables based on any groupable attribute in the dataset. A separate data table will be displayed in the report for each unique permutation of values in the dataset from the selected Split By attributes.

Aggregating

Enabling aggregation on a report allows you to create custom columns and consolidate rows. An aggregate report will display:

Aggregate columns cannot be created using parameter filters.

Summary Rows

When enabled, summary rows for sums and averages will be displayed at the bottom of each data table in the report. You can choose to display a sum or average for any numeric column in the dataset. There are two types of summary rows:

Field Description
Sum Displays a sum of the data values in the selected column(s)
Average Displays the mean of the data values in the selected column(s)

Fields

Report configuration fields are located in the following places in the RALS™ SYSTEM:

Data Table Fields

When viewing report configurations in a data table, the fields are defined as follows:

Field Notes
General
Key Unique identifier
Active Indicates whether the report configuration is currently active in the RALS™ SYSTEM
Name Name for the report configuration
Primary Resource Starting point for collecting data for the report; all other data stems from this resource
Notes
Notes Open text field that can be used at the user’s discretion
Add Fields

When adding a report configuration, the fields are defined as follows:

Field Notes
General
Name Name associated with the report configuration; must be unique
Primary Resource Starting point for collecting data for the report; all other data stems from this resource
Configuration
Child Additional resource included in the dataset by one of the primary resource’s fields; the primary resource can have multiple children; broadens the report’s ability to include columns and filters from resources outside of the primary resource
Columns Columns/attributes that will be part of the dataset
Filters Filters that will be available as criteria when generating the report
Splitting
Split By Attributes that will be used to split the dataset into separate data tables; options include all groupable attributes in the dataset
Aggregation
Aggregate Data Enables the report to consolidate data into aggregate rows
Group By Attributes that will be consolidated into aggregate rows; options include all groupable attributes in the dataset
Columns
Column Defines which columns are displayed on the report and in what order; if aggregate data is enabled, the user will have to create aggregate columns; if aggregate data is not enabled, all columns included in the dataset will be displayed
Filter Defaults
Filter Defaults Default values for the filters that will be available when generating the report
Summary Rows
Columns to Sum Defines which columns to sum; options include all numeric columns included on the report
Columns to Average Defines which columns to average; options include all numeric columns included on the report
Notes
Notes Open text field that can be used at your discretion
View or Edit Details Fields

When viewing or editing a report configuration details record, the fields are defined as follows:

Field Notes
General
Name Name associated with the report configuration; must be unique
Configuration
Primary Resource Starting point for collecting data for the report; all other data stems from this resource
Child Additional resource included in the dataset by one of the primary resource’s fields; the primary resource can have multiple children; broadens the report’s ability to include columns and filters from resources outside of the primary resource
Columns Columns/attributes that will be part of the dataset
Filters Filters that will be available as criteria when generating the report
Splitting
Split By Attributes that will be used to split the dataset into separate data tables; options include all groupable attributes in the dataset
Aggregation
Aggregate Data Enables the report to consolidate data into aggregate rows
Group By Attributes that will be consolidated into aggregate rows; options include all groupable attributes in the dataset
Columns
Columns Defines which columns are displayed on the report and in what order; if aggregate data is enabled, the user will have to create aggregate columns; if aggregate data is not enabled, all columns included in the dataset will be displayed
Filter Defaults
Filter Defaults Default values for the filters that will be available when generating the report
Summary Rows
Columns to Sum Defines which columns to sum; options include all numeric columns included on the report
Columns to Average Defines which columns to average; if aggregate data is enabled, options include all numeric columns included on the report
Notes
Notes Open text field that can be used at your discretion