Assetas support

Single Value Report

This page will walk you through the process of creating or editing a single value report.

Create a report | Report details | Report properties | Style | Filters | SQL Select Statement | Security | Validate and run | Report customizationRelated topics 

Icon Light 500px.png
Assetas support
 
  1. Expand "Reports" on the sidebar navigation.

  2. Select "Design" to design a new report. This will immediately bring you to the Report Details screen.
     

Create a single value report
 
Report details
 

The report details include the primary foundational details of the report. Please note that items with an asterisk are required.

Report Details:

Populate the following fields:

  • Category*: The category grouping for this report. You can create your own categories by navigating to Report Categories under the Lists & Types menu under Configuration.

  • Type*: The type of report. Select Single Value.

  • Name*: Enter the name of the report.

  • Icon*: Select an icon to represent the report.

  • Data source*: Select the underlying data for the report. 

  • Description*: Enter a short description of the report.

  • External Identifier: Create a unique identifier for this report.

Please note that all fields with the exception of the External Identifier are required for this type of data record.

A single value report displays one value based on information captured in the application. It can be accompanied by a short text description and may be formatted with different colors using logic rules. This report type is a simple way to display a single summary statistic clearly on the dashboard.
 

What is a single value report?
Report properties

Please note that items with an asterisk are required.

Single Value Properties:

Populate the following fields:

  • Value*: The data element to use for the display value.

  • Aggregate*: The aggregate function to apply to the value. Options include: average, count, list, maximum, minimum, standard deviation, sum, variance.

    • List combines the values into one column with commas separating the values. Standard Deviation returns the statistical standard deviation of all values in the expression. Variance returns the statistical variance of all values in the expression.

  • Rounding: The number of decimal places to round the value.

  • Value Format: The format mask to apply to the value. This is used to apply custom formatting to dates and numbers. For example, you may define the Value Format as “MMM yyyy” (case-sensitive) to show “Jan 2020”. In the Assetas manual, Section 8.2 of the Appendix provides a table of commonly-used formats for dates and numbers.

  • Auto-Scale: Automatically scale the value and append a K, M, B, or T for thousand, million, billion, or trillion, respectively.

  • Label: The default suffix to display when no style is matched (styles are defined in the section below). Note that this value is placed below the single value information.

  • Color: The default color to use when no style is matched.

  • Icon: The default icon to display when no style is matched.

  • Text: The default text to display when no style is matched. This value is placed to the right of the single value information.

  • Calculated Field: Toggle on to treat the Text field above as a calculated field. Calculated fields are advanced functions – please reach out to Assetas if you need assistance. 

 
Style

The system allows users to configure up to three styles that differ from the default settings (e.g., text, colors), based on logic incorporating the single value. Please note that items with an asterisk are required.

When this condition is met:

Populate the following fields:

  • Operator*: The operator to use for this style.

  • Value: The value to use for this style. Note that when the Operator is “is blank” or “is not blank”, any populated Value field will be removed upon save.

Apply these styles:

Populate the following fields:

  • Label: the suffix to apply for this style. Labels appear next to the single value.

  • Color: The color to use for this style.

  • Icon: The icon to display for this style.

  • Text: The text to display for this style. Text appears below the single value.

  • Calculated Field: Toggle on to treat the Text field as a calculated field. Calculated fields are advanced functions – please reach out to Assetas if you need assistance.

 
Filters

Filters allow the report to dynamically return results based on defined logic, criteria, and order.

Populate the following fields:

  • Group*: Defines the order of operations when using OR logic. If only AND logic is used or you only have a single filter, you’ll only use a single grouping of filters, so select Group 1. If you have any OR logic to apply, you may need to use additional grouping for your filtering logic to work properly.

    For example, if your logic looks something like:
    (A and B and C) OR (D and E), the filter elements within the first set of parenthesis will be in Group 1, and the filter elements within the second set of parenthesis will be in Group 2.
     

  • Precedence*: Defines the order of filters within each Group in relation to the other filters defined and requires a whole number.
     

  • Column*: The data element chosen for each filter. The naming convention is: [Table.Element] (data type). For example, if you want to filter on the type asset, you would select Asset Type.Name. There is a search box within the dropdown that is helpful if you’re not certain which table your data element resides in.
     

  • Operator*: The operator used to apply the filter.

    The Operator value of “contains any of these items” will return all results that meet the entries.  For example, a filter to show only records that “contains any of these items” with “WELL,TANK” would return WELL0001, WELL0002, and TANK0001. 

    The Operator value of “is in the list” is appropriate for matching entire values.

     

  • Value*: The value(s) for which you are applying the filter. There are several options:

    • Enter a single numerical or text value (please note that text values are not case sensitive).

    • A comma separated list of numerical or text values

    • Use a variable. The Append Variable button allows you to quickly select a variable from a re-defined list, including {Today}, {CurrentUser}, {StartDate}, or {EndDate}. Variables are denoted with curly brackets. Certain variables require you to enter a variable’s unique identifier or external identifier to evaluate properly. For example, for {ContactID}, simply enter the Contact’s unique/external identifier within the curly brackets. For Selection Lists, enter the Selection List report’s external identifier within the curly brackets, like so: {SL:Assetas_SL_Active_Assets}.
       

The two filters {StartDate} and {EndDate} must be applied together; you cannot reference only one of these two in the filters for a report. 


If the filter is referencing one date, please use {AsOfDate}, which uses the current date as the reference point.
 

  • Logical*: Contains either ‘AND’ or ‘OR’ and describes how the filter relates to the following filter (in order of precedence). If the filter directly after this filter is in a different group, then the Logical field will describe how the two groups interact.

 
SQL Select Statment

This is a non-editable box that returns the SQL defined by the report parameters chosen in sections above. The SQL will dynamically adjust as data elements, filters, and sorting rules are changed. If you are comfortable with SQL, reviewing the code within this box may provide additional validation that your report is returning correctly.

No SQL skills necessary! This is simply for validation, if you'd like to use it.

 
Security

In this section you may define which security roles have access to your report.
 

By default, reports are not assigned to any security roles; only the user who created the report and anyone with the “Report Administrator” security function will be able to access the newly created report. 
 

When a report is granted to one or more security roles, users of those security roles will also be able to access it.  You can add single roles at a time, or all roles at once.

 
Validate and run

Validate:  Click the Validate button to check the report for any issues and display any errors found.

Run: The Run button will run your report and will return any data per your report requirements.

A report without validation errors does not necessarily guarantee that the logic in the report is accurate or that the report will return data. It simply affirms that the way the map properties, filters, and sorting rules have been defined allow the report to run. It’s always best practice to click on the Validate button and check there are no errors.

 
Report customization

Certain reports allow for further customization once they are run. Any customization changes made the report will be saved for the next time the report is run and will not impact the original report settings.

Variable inputs: Any variable inputs will display at the top of the report. For example, if you’ve chosen the {StartDate} and {EndDate} or {AsOfDate} variables in your filters, you will see a dropdown list of many possible date range combinations to select from.