Connection Knowledge helps Bridgit understand the terminology, relationships and approved reporting patterns used with a Connection Profile. This guide explains how to add useful information without treating assumptions as established database facts.
Trouble Viewing Images? Right-click an image and select Open in new tab to view a larger version. You can also zoom in using Ctrl + Mouse Wheel.
Before You Begin
Bridgit AI must be configured with an approved OpenAI API key before you begin. See Bridgit AI Overview and Usage Guide for setup information.
- Work with an administrator or someone who understands the database and reporting rules.
- Use approved schema metadata and report examples.
- Confirm that the selected connection is the one whose Knowledge you intend to change.
- Review what information may be sent for AI processing in the Bridgit AI Data Privacy article.
Open the Knowledge Editor
- Open the Tables and Fields panel.
- Right-click the required Connection Profile.
- Select Edit Knowledge (Beta).
Describe the Schema and Relationships
Use Schema Discovery to review Notes, Discovery SQL, Preferred Join SQL and Join Rules.
- Record useful schema conventions and caveats in Notes.
- Have an administrator review the connection-specific Discovery SQL. It is a metadata query, not a general reporting query.
- Save the intended configuration and use Refresh Schema to update the stored catalog.
- Where Preferred Join SQL is configured, use Refresh Discovered Joins and review the resulting relationships.
Note: A join that works in one report does not prove that the relationship is unique or appropriate for every report. Check whether matching rows can multiply values.
Add Business Terminology
Open Schema Vocabulary and select New Term. Enter the term, useful variants, its scope and the table, field or schema area to which it applies. Use Notes for approved context and select Save Term.
Record what is known. Do not infer the meaning, units or calculation of a field from its name alone. Versions that include Meaning and Evidence provide additional fields for these definitions.
Import an Approved View as an Example Report
- Open Example Reports.
- Select Import From VDM.
- Select one or more approved
.vdmView files and open them. - Wait for the import to complete, then review the example’s name, description and SQL.
- Check that the imported example belongs to the current connection and does not contain unsuitable fixed values or confidential information.
The import extracts available query text and prepares reusable example knowledge. If no query text can be extracted, VDM reports that no generated or advanced query text was available. Importing an example does not establish that its business calculations are correct.
Curate Successful Queries and Learning Candidates
In Successful Queries, review useful history and use Promote To Example Report when a query should become an intentional reusable example. Use Disable Query when a saved query should no longer be offered for direct reuse.
In versions that include Learning Review, inspect a captured candidate before selecting Promote Candidate. Use Dismiss Candidate to retain an item as dismissed history when it should not be promoted. A captured candidate is not automatically an approved reporting rule.
Verify the Knowledge
- Return to Ask Bridgit using the same connection.
- Ask a small question that uses the terminology or example you added.
- Review the selected fields, relationships and retrieved example.
- Run and independently check a representative report when execution is appropriate.
- If an issue remains, review Health before adding more instructions.
Maintain and Protect the Knowledge
Use VDM’s editing and save controls rather than directly modifying Knowledge files. Confirm the configured Knowledge folder in Settings and include it in your organization’s backup plan. Coordinate changes with other editors; if VDM reports a save conflict, reload and reconcile the changes rather than overwriting another person’s work.
Comments
0 comments
Please sign in to leave a comment.