Settings · Administrator

Configure AbaReport

Display custom Abacus reports in the caller cockpit

Product: echo for TeamsUpdated: October 2026Version: 1.0

💡 This guide is optimized for PDF export. Print → “Save as PDF”, enable background graphics.

Overview

With AbaReport, echo displays custom Abacus report results in the caller cockpit. You configure the report in Abacus using the application Q948 AbaReport, then add it under Settings → Abacus in echo. Several reports can be configured; each appears in its own tab in the AbaReport widget.

Prerequisites

You have administrator access to the organization-wide Abacus settings in echo.
An Abacus service user has access to the required reports and data, with Client ID and Client Secret for AbaReport API access.

PermissionsReports run with the configured service-user credentials, not with the individual user's personal Abacus connection. Review which data the reports expose and limit the service user's access accordingly. Keep the Client Secret confidential.

1. Configure the report in Abacus

Open Q948 AbaReport in Abacus and create or configure the report you want to display in echo.

Define the report's data and any filters.
If the result should depend on the selected contact or search, define suitable input parameters in the report.
Configure the report for the intended output format: JSON for structured data or text for plain text.
Note the exact report name and the names of its input parameters.
Test the report in Abacus with representative parameter values and ensure the service user can execute it.

The input parameters in echo must match those defined in the report. There is no universal parameter name: use the names from your own Q948 configuration.

2. Add the report in echo

Open Settings → Abacus, expand the optional AbaReport section in the tenant connection settings, and enter the AbaReport Client ID and Client Secret. These are the service-user credentials for report execution; do not assume they are the same as the existing tenant connection credentials.

Click + Add report and fill in the fields:

Field	Description
Display Name	Label shown on the report tab in the caller cockpit, e.g. `Customer overview`.
Report Name	Exact name of the report configured in Q948 AbaReport.
Renderer	How echo displays the result. Start with Auto; see the display options below.
Output Type	`json` for structured results or `txt` for plain text. Must match the report's output.
Input Parameters	Name/value pairs passed to the report. Use fixed values or the context values described below.

Add further reports if needed and click Save to save the tenant settings.

3. Map the input parameters

For each report parameter, click + Add parameter. Enter its name exactly as configured in Abacus and choose a value:

Value in echo	Value passed to Abacus
`company.id`	Abacus ID of the company associated with the selected contact.
`person.id`	Abacus ID of the person associated with the selected contact.
`search.query`	Current search text, with leading and trailing whitespace removed.
Fixed text, e.g. `Open`	The configured text, with leading and trailing whitespace removed.

Use the context values as the entire value, without braces or additional text. For example, if your report defines a parameter named SubjectNumber, enter SubjectNumber as the name and company.id as the value. SubjectNumber is only an example; replace it with your report's actual parameter name.

Missing contextIf a context value is unavailable, echo does not send that parameter. For example, a contact without an Abacus person ID cannot supply person.id. Configure suitable defaults or handling for missing parameters in Q948, and test both company and person contacts.

Display options

Renderer	Suitable report output
Auto	Automatically chooses a table for JSON rows, key/value for a JSON object, or raw output otherwise.
Table	A JSON array of row objects, or a JSON object whose `data` property contains an array of row objects. The object keys become column headings.
Key/Value	A JSON object containing individual fields, rather than a table of rows.
Raw	Plain text or the report's JSON output, displayed as text.

For tabular reports, choose output type json with Auto or Table. For plain-text reports, choose txt with Auto or Raw.

Check the result in the caller cockpit

Search for an Abacus contact in echo and open the caller cockpit. The AbaReport widget appears for contacts from Abacus when credentials and at least one report are configured and the feature is enabled. Reports load automatically for the current contact/search context. Select a tab to view a different report.

Check that the result belongs to the selected contact, then repeat with another contact to verify the parameter mapping.

Troubleshooting

Problem	What to check
The widget is missing	Select a contact from Abacus. Check feature availability, the AbaReport Client ID and Client Secret, and that at least one report has a Report Name. Also check that the AbaReport widget is enabled in your cockpit layout.
The report cannot be loaded	Check the report name, service-user credentials and permissions, and whether the report runs successfully in Q948. Long-running reports may time out; reduce the report's scope if needed.
The result is empty or belongs to the wrong contact	Check parameter names, the choice of `company.id` versus `person.id`, and report filters. Ensure the selected contact has the corresponding Abacus ID.
Structured data is not displayed as expected	Check the output type and JSON structure. Select Raw to inspect the returned output, or use Auto to let echo choose the display.