Notes Overview – BridgeWorks Help Center

Use Notes to document a VDM View’s purpose, owner, requirements, parameters, and change history. Notes are saved inside the View file, so the documentation stays with the View when you share it.

Trouble viewing images? Right-click an image and select Open image in new tab to view it at full size.

What Are Notes?

Notes provide a place to record information about the current View’s design, maintenance, and use. Each View has its own Notes; users who open that View can read its documentation.

What to Include in Notes

Information	What to Record
Purpose	What the View reports on and how the results should be used.
Owner or Author	Who created the View and who maintains it.
Request and Requirements	Who requested the View and the requirements it was designed to meet.
Business Logic	Important calculations, filters, assumptions, and exclusions.
Parameters	What each parameter controls and which values users should enter.
Change History	The date, author, and reason for significant changes.

Open Notes

Open the View you want to document.
Expand the Tools section.
Select Notes.

Add or Update Notes

With the correct View open, select Notes from Tools.
Enter new documentation or update the existing text.
Save the View to keep your changes.

Important: Notes belong to the current View and are stored in its file. Save the View after editing Notes.

Example Notes

Use a consistent format to make the documentation easy to scan. For example:

View: Monthly Sales Summary
Purpose: Summarize sales by customer for a selected date range.
Owner: Reporting Team
Parameters: Start Date and End Date define the reporting period.
Business Logic: Excludes cancelled orders.
Change History:
2026-10-08 — Reporting Team — Added customer subtotals.

This is example documentation. Replace it with information that describes your View.

Keep Notes Useful

Start with the View’s purpose and current owner.
Explain parameter values and any assumptions that affect the results.
Record significant changes with a date and a brief reason.
Update the Notes when the View’s requirements or business logic change.

Verify and Share Notes

After saving, reopen the View and select Tools > Notes to confirm that your changes were retained.

When you share the saved View file, its Notes are included. Anyone who opens that View can access the Notes associated with it.

Need Help?

For assistance with Notes, contact support@bridgeworksllc.com. Include your VDM version and describe what happens when you open, edit, or save Notes.