Reports
Package: BASIC
1. General
The Reports module enables the evaluation of records from brainX. Data at a specific point in time or over a period – e.g. a quarter – is aggregated and analysed, so that data-based decisions can be made and business processes can be adjusted in a targeted manner. Reports allow important KPIs to be tracked and clear strategies to be defined.
By default, reports present data as tables. Additionally configurable graphics and charts allow a quick visual overview.
The following report types are available:
- Tabular → Simple report with a header row and data rows, optionally with simple calculations.
- Calculations → Calculations based on groupings over up to three fields.
- Calculations with details → Calculations with grouping over one field, plus detail rows for the individual records.
- Matrix → Calculations over up to three groupings, presented in rows and columns with grand totals.
- Report set → A compilation of several reports and/or charts into a shared view.
Reports can be exported as PDF or CSV. The CSV export of reports runs in the background. After successful creation, a notification is displayed via which the file can be downloaded.
Via the scheduling, an automatic, time-controlled dispatch by email can additionally be configured.
1.1. Application examples
Which channels deliver the most leads? Reports show at a glance where leads originate and which sources are particularly worthwhile.
Keep an eye on calls, tasks and meetings and measure the performance of individual employees.
Overview of open quotes including the probability of closing – for a robust pipeline analysis.
Evaluate open tickets, processing times and communication volume in order to improve support in a targeted manner.
Duration, generated leads and ROI of marketing campaigns at a glance.
The sales manager wants to receive an overview of revenue, open quotes and closing rates every month. He creates three reports (type Calculations) for the respective metrics and combines them in a report set. Via the scheduling, the report set is automatically sent as a PDF to the Sales group on the last working day of the month.
The support team leader wants to know how many tickets each person on the team has processed and completed in the last 30 days. She creates a report of the type Calculations with details, grouped by the field Assignee, and sets a permanent filter on the status done as well as a date filter on the last 30 days. The result shows, per employee, the number of tickets as well as all detail rows.
Frequently used reports can be embedded directly on the home page as a dashboard widget.
2. Report types
2.1. Tabular
Simple report with a header row and the associated data rows. Optional: simple calculations on numeric fields.
In its presentation, the tabular report corresponds to a classic spreadsheet program: a header row names the selected columns, followed below by the data rows.
Optionally, simple calculations can be performed on currency, number and percentage fields: sum, average, minimum value and maximum value.
2.2. Calculations
Calculations based on groupings over up to three fields.
In the calculation report, up to three fields are selected by which the data is grouped. Different calculations can then be applied to all currency, number and percentage fields.
In addition to the standard calculations (sum, average, minimum and maximum value), the counting of records is also available.
2.3. Calculations with details
Calculations based on the grouping of one field, combined with detail rows for the individual records.
The type Calculations with details combines the report types Calculations and Tabular. Only one column can be chosen for grouping.
In contrast to the tabular report, all fields of the respective module can be used as calculation columns – they do not additionally have to be present in the detail rows.
2.4. Matrix
Calculations over up to three groupings, presented in rows and columns with grand totals per row and column.
The matrix report allows grouping by two or three fields. In contrast to the report type Calculations, one of the groupings is presented as a column instead of a row. Grand totals are formed both for rows and for columns.
2.5. Report set
A compilation of several previously created reports and/or charts into a shared view.
A report set is not a standalone report type in the strict sense: it combines several existing reports and thus enables a holistic view of individual business areas. Beyond mere comparisons, extensive report sets can be used to build complex analyses.
Example report set
For the report set, no fields are configured or calculations defined – only existing reports and charts are compiled. The creation process therefore differs from the other report types. See section Create report set.
3. Permissions
3.1. General rights settings
The permission concept for the Reports module differs from standard modules. No settings can be made via the Global rights assignment.
The rights are applied as follows:
- Create: Every user who is allowed to open the module can create reports and report sets. The Reports module can be deactivated per profile.
- View: Administrators can view all reports. Other users see:
- public reports
- reports of users subordinate in the role hierarchy
- reports explicitly shared with them
- Edit: Editing is permitted with:
- administrator rights
- the profile permission Edit all
- reports of users subordinate in the role hierarchy
- own reports (owner)
- Delete: Reports can only be deleted by the owner or by an administrator.
Depending on the profile permissions for individual fields and the permitted picklist values of the user role, it may happen that a report cannot be displayed. This occurs when columns for groupings or advanced filters may not be viewed, or when picklist values are not available for the respective role.
The export options in PDF and CSV format can likewise be authorised per profile. This setting applies both to exports from the detail view and to the time-controlled email dispatch.
3.2. Sharing
For each report, the Sharing picklist can be used to configure individually who is allowed to view the report:
- public – all users and groups can see the report.
- private – only the owner and users with administrator rights can see the report.
- restricted – via an individual share, only selected users and/or groups can see the report.
3.2.1. Configure individual sharing
If the value "restricted" was chosen in the edit view, the action icon "Configure access" (gear icon) appears. After clicking it, the "Sharing" popup opens.
Sharing popup
Via checkboxes, the users and/or groups that are allowed to view the report are selected.
4. List view
The list view of the Reports module has the usual functions of a list view in brainX. Further information on this can be found in the section Layout/structure – list view.
4.1. Actions
In the list view – depending on the module – general actions are available. An overview and description of all general actions can be found in the section Actions (list view).
In addition, the following module-specific actions are available:
| Action | Precondition | Functionality |
|---|---|---|
| Manage folders | none | Create, rename and delete folders. For detailed information see section Manage folders. |
4.1.1. Manage folders
Reports can be stored in a structured way in folders. After clicking the Actions button in the list view, a flyout menu opens with the action "Manage folders".
Action "Manage folders" in the flyout menu
After clicking "Manage folders", the "Manage directories" popup opens. It lists all existing directories; the number of contained reports is shown in brackets after the directory name.
"Manage directories" popup
The directory "Default" cannot be edited or deleted. Folders with identical names cannot be created multiple times.
The following actions are available in the popup:
"Manage directories" popup - rename and delete
4.1.2. Create directory
After clicking the "Create directory" button (icon "Folder"), the search field switches to an input field for the directory name. After entering the name, the directory is created by pressing the Enter key and is displayed in the list.
"Manage directories" popup - create directory
4.1.3. Rename directory
Behind each directory name is the "Three dots" icon. After clicking it, a flyout menu opens with the options "Rename directory" and "Delete directory".
After selecting "Rename directory", the name becomes editable. The change is saved via the "green check mark" icon.
"Manage directories" popup - rename directory
4.1.4. Delete directory
After selecting "Delete directory" in the flyout menu (icon "Three dots"), a different popup is displayed depending on whether there are still reports in the directory:
- Directory without reports: A confirmation popup asks whether the directory should really be deleted. The action is completed via "Confirm".
- Directory with reports: A popup prompts you to select a target directory into which the existing reports are moved. The action is likewise completed via "Confirm".
"Delete directory" popup
5. Detail view
In the delivery state, the detail view of a record has standard fields, which are described below.
5.1. Report details block – fields
| Field | Description |
|---|---|
| Report name * | Name of the report. |
| Module * | The module whose records are evaluated. Almost all modules in brainX are available for selection, including Users (not a standalone module, but usable for reports about brainX users). |
| Folder * | Directory in which the report is stored |
| Owner * | User who owns the report When creating a new report, the owner is automatically set to the currently logged-in user. However, this can also be changed. |
| Show audit-proof data | When activated, audit-proof (archived, immutable) data states are taken into account in the report |
| Limit for number of records | Maximum number of records evaluated in the report. No entry means no limit. |
| Limit for grouping | Maximum number of groups displayed for grouped reports. No entry means no limit. |
| Sharing * |
|
| Scheduling | Activates the automatic, time-controlled email dispatch of the report – see section 6.1.2 Scheduling |
*Mandatory field
5.2. Filter block
In the "Filter" block, the filters permanently configured for the report are displayed. In the detail view, temporary filters can additionally be set without having to open and edit the report for this purpose.
Filter block - without configured filter
Filter block - with filter for the "Status" field
Via the "Add filter" button, further individual filters are added; via "Add group", logically related filter groups can be created. After clicking Apply, the temporary filters take effect; "Reset" removes them again.
The functioning of filters is described in detail in section 6.4 Filter.
5.3. Chart and data block
In the "Chart and data" block – if configured – charts as well as the actual report data are displayed.
Example report "Deals by customer" (type "Calculations with details") with pie chart
6. Create report
After clicking the "Create report" button in the list view, the "Choose report type" popup opens.
"Choose report type" popup
After clicking a report type, the creation view opens. Creation is divided into up to five steps:
The report type report set follows a different creation process, since no new data reports are created but existing reports are compiled. See section Create report set.
6.1. Report details
In the "Report details" step, the basic details of the report are defined: name, main module, folder and description. Almost all modules in brainX are available as the main module.
Creation view - "Report details" step
Once a module has been selected in the Report details step and the next step has been called, the module can no longer be changed. If the wrong module was chosen, there are two options:
- Refresh the browser page – this resets the module selection; all previously entered details (name, folder, description) are lost in the process.
- Use the "Cancel" button and start creation over.
The "Module" picklist also offers "Users" for selection. Users is not a module that can be opened on its own, but it enables the creation of reports about brainX users.
A complete description of all fields can be found in section Report details block – fields.
6.1.1. Scheduling
Via scheduling, the report is automatically sent by email to selected users and/or groups at configured times.
Example 1: The head of customer service has statistics on created customer tickets sent to them weekly.
Example 2: The Sales group automatically receives the current revenue figures at the end of the month.
If the "Scheduling" switch is activated, the "Dispatch schedule" popup opens.
"Dispatch schedule" popup
General
| Field | Description |
|---|---|
| Interval * |
|
| Time |
|
| Format | Format of the sent file: PDF, CSV or Both |
| Recipients | Selection of the users and/or groups that receive the report by email |
*Mandatory field
PDF format options
| Field | Description |
|---|---|
| Orientation | Page orientation of the PDF file: Portrait or Landscape |
| Header template | Selection of a header template (optional) |
| Footer template | Selection of a footer template (optional) |
CSV format
| Field | Description |
|---|---|
| Format |
|
| Delimiter |
|
6.2. Field configuration
In the "Field configuration" step, it is defined which fields of the chosen module appear in the report. The available fields are displayed on the left in a list and can be transferred into the report's column selection via drag & drop or via the corresponding buttons. The order of the columns can likewise be adjusted via drag & drop.
Example creation of report type Tabular - Field configuration step
Depending on the report type, different fields can be selected:
- Tabular: All fields of the module are available as columns.
- Calculations / Matrix: Grouping fields and calculation fields are configured separately.
- Calculations with details: In addition to the grouping field, detail columns and calculation columns are chosen separately.
When grouping by date fields (report types Calculations, Calculations with details and Matrix), the following year-independent grouping options are available in addition to the year-related intervals:
- Month, year-independent -> groups all records by calendar month, regardless of the year
- Quarter, year-independent -> groups all records by calendar quarter, regardless of the year
This is useful, for example, for birthday lists, seasonal evaluations or analyses of contracts that are renewed in a particular month or quarter – across several years.
When grouping by date fields with a time of day, the time of day is ignored – grouping is done exclusively by the date.
6.3. Calculations
In the "Calculations" step, it is defined for the numeric fields (currency, number, percentage) chosen in the previous step which aggregation is to be applied.
Example creation of report type Calculations - Calculations step
Available calculation types:
- Sum – grand total of all values in the group.
- Average – mean value of all values in the group.
- Minimum value – smallest value in the group.
- Maximum value – largest value in the group.
- Count – number of records in the group.
6.4. Filter
In the "Filter" step, the permanent filter rules of the report are configured. Filters restrict the evaluated records before the calculations are performed.
Example creation of report type Calculations - Filter step
Individual filters are added via "Add filter". Several filters within a group are linked by default with AND. Via Add group, alternative conditions (OR linkage between groups) can be defined.
For each filter, the desired field, the operator (e.g. equals, contains, is greater than) and the comparison value are specified. For relational fields, the linked records are available for selection.
For date fields, two additional filter options are available:
- In month -> filters by a particular calendar month, year-independent (e.g. all records from January, regardless of the year)
- Custom (year-independent) -> enables filtering by year-independent months and quarters
If the Filter step filters on changes to line items (change tracking), only the line items that match the filter criterion are displayed in the report – not all line items of the respective record. Several line item filters can be combined with AND as well as OR.
Temporary filters in the detail view complement the permanent filters without overriding them. They are discarded after leaving the view. See section Filter block.
6.5. Chart
In the "Chart" step, a chart for the report can optionally be configured. The chart is displayed in the detail view in the "Chart and data" block above the table and reacts dynamically to temporary filters.
Example creation of report type Calculations - Chart step
In this step, chart type, field selection, calculation type and grouping are configured in a shared view. When creating a chart from a list view or a report, the step for module and view selection is automatically skipped, since this selection is already fixed.
If Count is chosen as the calculation type, the field selection is omitted – it is not required in this case. Up to two groupings can be configured.
Available chart types:
- Bar chart (horizontal/vertical)
- Line chart
- Pie chart
- Donut chart
If grouping is done by a date field, an interval for the grouping can additionally be set (e.g. day, week, month, quarter, year). Furthermore, the option for cross-year grouping is available, so that records can be aggregated by calendar month or quarter regardless of the year.
7. Create report set
A report set combines several existing reports and/or charts into a shared view. In contrast to other report types, no fields are configured or calculations defined – only existing reports and charts are compiled.
Example creation of report type Report set
With report sets, complete company dashboards can be built – e.g. a monthly sales reporting that combines revenue, pipeline and activities in a single view.
The creation view of a report set is divided into two blocks:
- Report details → corresponds to the Report details block of a report
- Layout → definition of the layout of the report set
7.1. Choose layout
Five options are available for the layout of a report set:
- single-column
- two-column
- two-column, right larger
- two-column, left larger
- three-column
Report set - start layout
After selecting a layout, the creation view is presented as follows:
Report set - two-column layout
Each row contains – depending on the chosen layout – a corresponding number of cells. Within a cell, reports and charts can be selected and texts entered.
For each additional row, a separate layout can be defined via the selection buttons:
Report set - row 1 two-column layout, row 2 three-column layout
7.2. Edit layout
The layout can be adjusted at any time during creation.
On mouseover of a cell, the following action icon is shown:
- Move cell (icon "Four-directional arrow") -> in a multi-column layout, the cell can be moved horizontally.
On mouseover of a row, the following action icons are shown:
- Delete (icon "Recycle Bin") -> the row is deleted.
- Change row layout (icon "Layout") -> the layout of the row is changed.
- Move row (icon "Four-directional arrow") -> the row is moved vertically.
Edit layout - action icons
The entire layout can be removed via the "Delete layout" button in order to start over with a new layout.
7.3. Selection Report/Chart/Text
Within a cell, the following options are available for configuring the content:
- Choose report (icon "Report") → opens a popup for selecting a report
- Choose chart (icon "Chart") → opens a popup for selecting a chart
- Enter text (icon "T") → opens a popup for entering text
7.3.1. Choose report
After clicking the "Choose report" button, the "Reports" popup opens.
Reports popup
After clicking a report name, a further popup opens in which it is selected whether the data of the report or the associated chart is to be used.
Selection Data/Chart
By clicking the respective button, either the data or the chart is transferred into the cell.
7.3.2. Choose chart
After clicking the "Choose chart" button, the "Charts" popup opens:
Charts popup
The selection is made by clicking the chart name.
After selection, in addition to the action icons "Empty cell" and "Move cell", the action icon "Preview" is displayed in the cell. After clicking "Preview", a popup with a preview of the chart opens.
7.3.3. Enter text
In a report set, each cell can contain a descriptive text. After clicking the "Enter text" button, the "Edit text" popup opens.
Edit text popup
- Title → cell heading
- Description as list (switch) → if the switch is active, each new line in the "Description" field is displayed with a bullet point.
- Description → text area for descriptions, info or details about the report
Example cell with text
8. Practical examples
1 – Monthly sales reporting as a report set with automatic dispatch
The sales manager of a company wants to receive a complete overview of revenue, open deals and closing rates on the last working day of each month – without having to open the report manually.
First, three separate reports of the type Calculations are created: one for the monthly revenue (grouped by month), one for open deals (filtered by status Request received, Deal sent and Negotiation) and one for the closing rate (ratio of won to lost deals). For each report, a chart is optionally configured.
Subsequently, a report set is created that merges all three reports in a two-column layout. Via the scheduling, the automatic dispatch is configured to monthly, last working day, as a PDF to the Sales group. From this point on, the sales team automatically receives the report without any manual effort.
2 – Support evaluation by employee with detail rows
The support team leader wants to know how many tickets each person on the team has processed and completed in the last 30 days – including the individual ticket details.
She creates a report of the type Calculations with details on the Tickets module. Assignee is chosen as the grouping field. In the Filter step, two permanent filters are set: Status equals done as well as a date filter on the creation date of the last 30 days. Count is chosen as the calculation column in order to show the number of tickets per employee.
The result shows, per employee, the total number of completed tickets as well as all associated detail rows. The report is shared with the restricted sharing setting only for the team leader and the support group.
3 – Campaign performance with matrix report and dashboard widget
The marketing team wants to evaluate the performance of ongoing campaigns: how many leads has each campaign generated, broken down by lead source and month?
A report of the type Matrix is created on the Leads module. Campaign is chosen as the row grouping and Month (creation date) as the column grouping. The calculation column Count delivers the number of leads per combination. A permanent filter on Status does not equal lost excludes already qualified and discarded leads from the count.
The finished report is then embedded directly as a dashboard widget on the home page, so that the marketing team can view the campaign performance at a glance at any time.
9. Frequently asked questions
Can I change the module of a report afterwards?
No. Once a module has been selected in the creation process and the next step has been called, the module can no longer be changed. In this case, creation must be restarted via the Cancel button or by refreshing the browser page. In doing so, all previously entered details are lost.
What is the difference between permanent and temporary filters?
Permanent filters are configured when creating or editing a report in the Filter step and always apply whenever the report is opened. Temporary filters, on the other hand, can additionally be set in the detail view of the report without changing the report – they complement the permanent filters and are discarded after leaving the view. Temporary filters also affect PDF and CSV exports as well as charts.
Can a report be sent automatically by email?
Yes. Via the scheduling in the report details, an automatic, time-controlled dispatch by email can be configured. The report can be sent daily, weekly, fortnightly, monthly or yearly to selected users and/or groups as PDF, CSV or both. The first dispatch takes place directly after saving, as soon as the background task Reports scheduling is executed the next time.
Who is allowed to see or edit a report?
Administrators can view and edit all reports. Other users see public reports, reports of users subordinate in the role hierarchy, as well as reports explicitly shared with them. Users may edit their own reports as well as reports of users subordinate in the role hierarchy – provided no differing profile permissions are set. Only the owner or an administrator can delete a report.
Can I structure reports in folders?
Yes. Via the Manage folders action in the list view, directories can be created, renamed and deleted. Each report is assigned to a folder when it is created. The default directory Default cannot be edited or deleted. When deleting a folder with existing reports, these are moved to another directory.
Can I display a report directly on the home page?
Yes. Frequently used reports can be embedded as a dashboard widget on the home page. Detailed information on this can be found in the section Dashboard Widgets.