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 Resource Types for more information about the scope of this reporting feature.
Jump to a heading on this page:
Supported Resource Types
Default Reports
Institution Access
Adding
Editing
Cloning
Deactivating or Deleting
Splitting
Aggregated Reports and Custom Columns
Summary Rows
Fields
Supported Resource Types
Currently, report configurations can include data from the following resource types:
- Devices
- Locations
- Institutions
- Materials
- Operators
- Results
Default Report Configurations (Templates)
A default report configuration is a pre-defined report template.
Default report configurations are read only; they cannot be edited nor cannot be deleted.
The following default report configurations are available in the RALS™ SYSTEM:
- Workload Summary Report
- i-STAT® 1 Reagent Usage by Location
- i-STAT® 1 Quality Check Codes by Location
- i-STAT® 1 Quality Check Codes by Operator
- i-STAT® 1 Quality Check Codes by Operator Location
- i-STAT® 1 Simulator Results
- QC Test Results
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 be cloned. All values will be copied, except:
| Field | Notes |
|---|---|
| Name | You will be prompted to enter a new one |
| Active | Will be set to true, even if cloned from a deactivated report configuration |
| Default | Will be set to false, even if cloned from a default report configuration |
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.
Aggregated Reports and Custom Columns
Enabling aggregation on a report allows you to create custom columns, consolidate rows, and make calculations. There are two types of custom columns:
For each custom column, the following must be defined:
| Field Name | Notes |
|---|---|
| Name | Must be unique for the report; must contain 1-128 characters; the following characters and strings are prohibited: [ ] “-root” |
| Type | Aggregated or calculated |
Aggregated Columns
An aggregate column will display a count of items in the dataset that match a certain filter criteria.
When creating an aggregated column, you must set the filter criteria:
| Field Name | Notes |
|---|---|
| Filter | A filter can be created from any attribute in the dataset that is not reliant on instutition access or certification group access |
Calculated Columns
A calculated column allows simple calculations based on aggregated columns.
When creating a calculated column, you must create an equation by defining the following:
| Field Name | Notes |
|---|---|
| Supports Filtering During Report Creation | When enabled, the custom column will be filterable after the report is generated |
| Equation | Used to calculate the numeric value to be displayed in the custom column; an equation can be defined using aggregate and custom columns; see equation limitations for details |
| Select Column to Insert into Equation | Clicking on an item in the list will insert it into the equation field at the cursor’s location |
| Number of Decimals | Values will be rounded to the selected number of decimals |
| Suffix | Appended to the end of the calculated value; unit of measure for the value |
Equation Limitations
Valid equations follow the following rules:
- Must be a valid mathematical equation
- Mathematical operations must be explicit (e.g., users must use * for multiplication)
- Column references must be enclosed in square brackets: []
- Numbers must be between -30,000 and 30,000
- Numbers must contain 9 or fewer decimal places
- Max length of 1,000 characters
- In addition to column references and numbers, only the following characters are supported:
- +
- -
- *
- /
- (
- )
- Decimal separator (depending on the user’s selected culture)
Aggregated Report Display
A report with aggregated or calculated columns will display:
- Each selected Group By attribute as a column
- Each custom column that the user created
- One row for each unique permutation of values in the dataset for the selected Group By attribute(s)
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 |
| Default | Indicates if the report configuration is a default configuration (i.e., a template) |
| Name | Name for the report configuration |
| Primary Resource | Starting point for collecting data for the report; all other data stems from this resource |
| Resource Types | List of the resource types that will be included in the dataset |
| 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 | |
| Related Data | Additional resource included in the dataset by one of the primary resource’s fields; the primary resource can have multiple connections; broadens the report’s ability to include columns and filters from resources outside of the primary resource; you can select from resources for which you have read or manage access |
| 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, see custom columns for more information; 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; filters reliant on instutition access or certification group access are not available |
| 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 |
| Default | Indicates if the report configuration is a template (i.e., a default configuration) |
| Configuration | |
| Primary Resource | Starting point for collecting data for the report; all other data stems from this resource |
| Related Data | Additional resource included in the dataset by one of the primary resource’s fields; the primary resource can have multiple connections; broadens the report’s ability to include columns and filters from resources outside of the primary resource; you can select from resources for which you have read or manage access |
| 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, see custom columns for more information; 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; filters reliant on instutition access or certification group access are not available |
| 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 |