Managing Connections in WebReports

Connection profiles allow WebReports to communicate with the databases and data sources used by published reports.

The Connections page allows authorized administrators to create, review, edit, and delete connection profiles.

Screenshots use fictional demo data consistent with the other WebReports articles.

Open the Connections page

Sign in to WebReports.
Select Management.
Select Connections.

WebReports Connections directory showing shared DemoSQL and DemoAnalytics profiles and private DemoArchive, with the same databases as the companion articles.

The shared demo profiles are DemoSQL (SQL Client, DemoSales) and DemoAnalytics (MySQL, DemoOperations). DemoArchive (SQL Client, DemoArchive) is private.

Review connection profiles

The Connections table displays:

Profile Name — The name used to identify the connection.
Connection Type — The database or data-source type.
Is Priv. — Indicates whether the connection is private.
Database — The configured database name.
DSN — The configured data source name, when applicable.
Connector — The configured connector, when applicable.

Use the search box to find a connection by profile name, type, database, or connector.

Create a connection profile

Select Add.
Enter a unique connection profile name.
If applicable, select Is Connection Private?
Select the connection type.
If required by your environment, select Prefix TO/Schema Name.
Select Next.

Example: creating DemoSQL as a shared SQL Client connection. Is Connection Private? is unchecked.

The fields on the next page vary according to the selected connection type.

SQL Client connection information

For a SQL Client connection, enter the applicable information:

Server
Instance, if required
Database
User Name
Password

Additional options include:

Encrypt
Trusted Connection
Trust Server Certificate

A trusted connection may not require a username and password.

SQL Client example for DemoSQL: fictional server DEMO-SQL01 and database DemoSales. User Name and Password are intentionally blank.

Select Test Connection to verify the settings. After the connection succeeds, select Finish to save the connection profile.

Never include database credentials in documentation screenshots.

Edit a connection profile

Select the connection profile from the table.
Select Edit.
The Connection Profile Wizard opens with the existing settings.
Review or update the profile name, connection type, private setting, and prefix option.
Select Next.
Update the applicable connection information.
Select Test Connection.
After the connection succeeds, select Finish.

Example: editing the existing DemoSQL profile. Its SQL Client type and shared setting match the creation example.

Select the close button to exit without saving changes.

Delete a connection profile

Before deleting a connection, verify that it is not being used by reports, assignments, schedules, or publishers.

To delete a connection:

Select the connection profile.
Select Delete.
Verify that the correct connection is selected.
Confirm the deletion when prompted.

Deleting a connection profile may prevent reports from running. A deleted connection must be recreated before it can be used again.

Private connections

Private connection profiles allow credentials or connection access to be managed differently from standard shared connections.

For private-connection setup and credential instructions, see Managing Private Connections in WebReports.