Kavi® Members Help

Chapter 141. Report Builder

Overview

Use the Report Builder tool to view, create and test your organization's reports. As soon as a report has been created and activated, it becomes available in the Reports Area where it can be used to run reports. The Reports Area is accessible by Report Admins and higher-level admins such as Organization Admins and Super Admins. There are four stock reports available in the Reports Area by default. These reports may be used as a basis for custom reports, but they cannot be deleted. See the document Run a Report for more information on using these and other reports created through the Report Builder tool.

Note

Membership-related Report Types and fields will only be displayed if membership is enabled on the site.

Report Type

Underlying each report is a Report Type that is designed to return the broadest possible set of data fields related to a specific topic without overwhelming system resources. You may narrow the set of fields available in your report (to streamline use and improve performance), but you will not be able to add to these fields.

Select the Report Type that provides the fields you need for your report. If you aren't sure which type you need, select the one that seems most likely and check to see whether all the fields you need are available. If not, select another type.

Table 141.1. Kavi Members default Report Types

Name Description
Company Returns company and company membership data. Company records are displayed one per line. Company memberships are returned as a comma-delimited list.
Company Membership Returns company membership data and company data. Company memberships are displayed one per line, so the same company may appear in more than one line.
Individual Membership Returns individual membership data and user data. Individual memberships are returned as a comma-delimited list.
User Returns user data, a limited set of individual membership data (if this organization offers individual memberships) and a limited set of data for the user's company (including Company Membership Type). User records are displayed one per line. Individual memberships are returned as a comma-delimited list. This Report Type returns the broadest data set of all Report Types.

Filter configuration

Once the appropriate Report Type has been selected, filtering options are set for each available field to determine whether the field will be fixed or present in the Search Form, and whether it will be displayed in Viewable Results and Downloadable Results when a report is run. A report must have at least one field designated as Searchable or Fixed.

Filters:

Fixed

Define a fixed field to restrict query results by selecting the field in the 'Fixed' column and setting the fixed value on the next step.

Fixed fields are rarely used. The most common use case is a "Primary Contact" report. Add a report based on the 'User' Report Type, designate the 'Company Administration and Contact Type' field as a fixed field and set the value to 'Primary Contact'. The query will retrieve every user designated as a Primary Contact (i.e., every user who has been assigned this Company Administration and Contact Type).

Searchable

Selecting a field in the 'Searchable' column causes it to appear on the Search Form displayed to administrators when they run reports. Any field that you want to be able to use in searches should be set as 'Searchable'. If you build a report with no searchable fields, the Report Admin will simply click the Run Report button to generate the report.

Viewable

Select fields to be included in the Viewable Results displayed to an administrator when a report is run. If you limit the number of viewable fields to 15 or less, the fields will be sortable when displayed. If the number of Viewable fields exceeds this limit, they will not be sortable when displayed.

Downloadable

Select fields to be included in the Downloadable Results when a report is run. You may build a report with no downloadable fields if the results should simply be Web-viewable.

Operators

Operators are set to determine whether the search returns values that contain or exclude a specified value or range of values. Operators are configured at several points in the process of designing the report. If Fixed Fields are set when selecting report fields, the next step is to provide default values and configure operators for these Fixed fields. Default values and default operators are also set for Searchable Fields.

The set of available operators depends on the type of values that are valid for a field. These may include 'is' or 'is not', or 'contains' or 'does not contain'. If the specified value is a date, operators may also include 'is before' and 'is after'.

Configuring the Search, Results and Download Forms

Once the fields for the report have been selected as 'Fixed', 'Searchable', 'Viewable' and 'Downloadable', the Super Admin sets default values and operators. It isn't necessary to set a default value for a Searchable Fields unless most reports will require the field to be set to a certain value. For instance, the Status field is often set to 'Active' because the organization is usually most interested in managing active users, companies and memberships. A Report Admin can always set this value to 'Inactive' to generate a report on deactivated users or companies, or set the field value to 'Any Status' to retrieve companies or users irregardless of status.

The Super Admin can also set the order in which fields will be displayed in the Search Form, Results Form and Download Form when administrators run reports.

Field values displayed as checkboxes

When you designate a field as searchable and it displays 'Show results for' as an operator, the values will be displayed as a set of checkboxes on the Search Form. As you'd expect, any checkboxes you select while configuring the Search Form will be prechecked when they are displayed to the Reports Admin.

Unless an operator is displayed, these fields are in an 'or' relationship, so when a report is run, the results will include records that contain any of the selected values. If none of the checkboxes are preselected by the Super Admin and the Report Admin doesn't check any when running the report, the field will be ignored (i.e., the results will not be restricted by the values in this field). Ironically, the result of running a report with all the field values selected is the same as the result of running a report with none of the field values selected.

Fields where you can set an operator include the 'Membership Status' and 'User Purpose' fields.

Custom fields

The Report Builder includes custom fields, which are displayed in the context of their data type (company, user or membership). They appear at the bottom of each section, in alphabetical order. You can set the order in which these fields will be displayed in the report's Search Form and Results Form.

How Report Admins use reports

As soon as a report is added it becomes available at the Reports Area. When the Report Admin clicks a link to a report, the report's Search Form is displayed.

The Search Form presents the fields designated as 'Searchable' in the order set by the Super Admin with the specified default values and operators. The Report Admin sets search parameters to generate the kind of report they need, then runs the report.

The Results Form displays fields designated as 'Viewable' in the order set by the Super Admin.

Fields designated as 'Downloadable' by the Super Admin will be available in the Downloadable Results. The downloadable version of the report usually includes a more complete set of fields than those displayed in the Viewable Results. For example, item key fields aren't available for inclusion in Viewable Results.

Use the Report Builder tool to:

  • View, manage and run available reports.

  • Access the Add a Report tool to create a custom report.

Back to top

How to Use the Report Builder tool

View a tabular list of existing reports and click the 'Manage' link adjacent to any report you'd like to manage, or click the link to 'Add a New Report'.

Fields

Name

The name of the report.

Description

A textual description of the report.

Type

The default Report Type on which this report is based. The Report Type determines which database tables will be queried, so the selection of Report Type is based on the type of data that needs to be included in the report. This can be any of the Kavi Members Report Types.

Default

Indicates whether this is a default or custom Report. Default Reports are listed in the following table. Default reports cannot be edited or deleted.

Table 141.2. Kavi Members default reports

Name Description Type
Company Data Report A report derived from data stored in the Company table. Company
Company Membership Report A report derived from data stored in the Company Membership table. Company Membership
Individual Membership Report A report derived from data stored in the Individual Membership table. Individual Membership
User Data Report A report derived from data stored in the Person table. User
Status

This will be either 'Active' or 'Inactive'. If 'Active', the Report will be displayed in the list of reports displayed to administrators through Report tools. If 'Inactive', the Report will be hidden in that list, so no one will be able to run reports.

Action

Click the links in this column if you want to 'Manage' or 'Run this Report'.

Back to top