Skip to main content
Use this page to create a Data Source when Reporter needs to read from an external database or from a connection that is not already configured. If the report uses internal Lerian product data, such as Midaz or CRM, the Data Source may already exist.

​
Objective

Configure an external connection that Templates and Reports can use. For example, create a Data Source named production-postgres that points to an external reporting database, or compliance-readonly for a read-only database user used by reporting operators.

​
When to use

Use this task when:
  • the required Data Source is not already available in Reporter
  • a new database must feed reports
  • an existing report process needs a separate read-only connection
  • operators need schemas and fields available in Template Builder or report filters
Before adding one, check whether the required internal Data Source already exists. Creating a duplicate external connection is unnecessary when Reporter already has the source configured. Do not use this task to fix an existing connection. Use Edit a Data Source and Test a Data Source Connection.

​
Before you start

Have these details ready:
  • host, port, and database name
  • username and password
  • schema names, when the database uses schemas
  • the SSL mode that your database requires
  • a clear connection name, such as production-postgres or compliance-readonly
Use credentials intended for reporting access. A Data Source gives Reporter access to read data used in Templates and Reports.

​
Step by step

1

Open Data Sources

Go to Data Sources and click Add Data Source.
2

Fill in connection details

In Add Data Source, enter Connection Name, Database Type, Host, Port, Database Name, Username, and Password.
3

Configure schemas when needed

For PostgreSQL, add the schemas that Reporter should inspect. Type a schema name and click Add, or press Enter. Without schemas, Reporter uses public.
4

Select the SSL mode

Select SSL Mode. The form starts at Require.
5

Add metadata when useful

Expand Metadata to add key-value fields that help operators classify the connection.
6

Create the Data Source

Click Create. The Console saves the Data Source and tests its connection.
7

Read the test result

When the test succeeds, the dialog closes and a message shows the latency. When it fails, the Data Source stays saved and the dialog shows the reason. Click Edit connection to fix it, or Keep anyway. When the test cannot run, the dialog closes and a message says that the connection could not be checked.

​
Field guide

​
Expected result

The new external Data Source appears on the Data Sources page with the result of its connection test. After a successful test, operators can use its fields in Templates and Reports.

​
Common errors and care points

Host should be the database server address, such as db.example.com, not the URL of an application or admin panel.
If the database uses schemas and the required schema is not listed, operators may not see the expected tables and fields.
If the database requires SSL, the connection can fail until SSL Mode matches that requirement.
Names like db1 are hard to use safely. Prefer names that show environment and purpose, such as production-compliance-readonly.

​
Next steps