This guide walks you through getting started with VDM: installing and registering the application, connecting to your database, building a View, designing reports, and scheduling automated jobs.
Follow the written steps alongside the videos. Use the linked articles for detailed instructions and current screenshots.
Before You Begin
- Review VDM System Requirements and Supported Platforms and confirm that you can install applications on your computer.
- Have your VDM registration information available: Company ID, License Key, and Registration Password.
- Have the database connection details and credentials provided by your database administrator.
- If you plan to automate reports, identify the computer that will run the Scheduler Service and the account that will access your Views, databases, and export folders.
Workflow: A View defines the data to retrieve. A Finished Report or Visualization presents that data. A Job defines how saved Views run and export their results. A Scheduler appointment sets when a job runs.
Installation and Report Creation
Step 1: Install and Register VDM
- Follow Installing VDM and Required Components to download the MSI installer and complete the installation.
- Install the required runtime components. See VDM NET 10 Runtime Installation Guide for current instructions.
- Launch VDM. If you have an existing OPTIONS file from a previous installation or shared environment, follow the installation guide to import it. An OPTIONS file is optional.
- Complete Registering and Activating VDM before creating and running reports.
Step 2: Create a Database Connection Profile
Follow How to Create a Database Connection Profile in VDM to configure the connection that your View will use.
- Select the appropriate database provider or connection type.
- Enter the server, database, and authentication information required by that provider.
- Test and save the connection profile before building your View.
Connection fields vary by database provider. Ask your database administrator for the correct values rather than copying the demonstration settings.
Optional: Use Bridgit AI
Bridgit AI can assist with writing queries, troubleshooting Views, and using VDM features. It is optional; you can continue building reports without configuring it.
See Bridgit AI Overview and Usage Guide for setup and usage instructions. Review generated queries and confirm their results before using them in a report.
Step 3: Select Tables and Fields
Use your database connection to choose the data for the View. Follow How to Use the Tables and Fields Panel in VDM.
- Expand the database or schema as applicable.
- Expand a table to display its fields.
- Add the required fields to Report Fields by double-clicking or dragging them into the View.
For example, a sales View might include the customer name, order date, and sales amount.
Step 4: Link Tables When Needed
If your View uses multiple tables, define how their records relate. Follow How to Link Tables in VDM to configure and review the links.
Choose the join type that matches the results you need. For example, customer and order tables might be linked using Customers.CustomerID = Orders.CustomerID. Actual table and field names depend on your database.
Check the returned data for missing or duplicated records before continuing.
Step 5: Add Parameters When Needed
Parameters let users supply values when a View runs, such as a date range, employee ID, or region. Follow Adding and Configuring Parameters in VDM Views.
- Create the parameter and give its prompt a clear name.
- Choose the appropriate parameter type.
- Use the parameter in the relevant filter or query condition.
- Run the View with sample values to confirm that the parameter changes the results as expected.
For example, Start Date and End Date parameters let the same View run for different reporting periods.
Step 6: Apply Filters and Verify the View
Use filters to limit the records returned by your View. See Creating Filters in VDM for configuration instructions.
- Use fixed values for conditions that should stay the same.
- Use parameters for values that users choose when running the View.
- Use supported date reserved words when the reporting period should change with the run date.
Select Run View, enter any required parameter values, and review the results. Confirm the filters and table links produce the expected records, then save the View.
Step 7: Create a Finished Report
Use the Finished Reports Designer when you need a formatted report for viewing, printing, or exporting. Follow Creating a Finished Report in VDM.
- Open, save, and run the View so its data is available to the Designer.
- Open the Finished Reports Designer.
- Add fields, labels, grouping, headers, footers, and summaries as needed.
- Save and preview the report. Check the layout and totals, then save any final changes.
For example, group sales by customer and add customer subtotals and an overall total.
Step 8: Create a Visualization
Use Visualize when you need an interactive dashboard. Follow Creating a Visualization to add charts, tables, filters, and other dashboard elements.
Assign the appropriate fields to each element, configure filtering as needed, and check that the displayed values match your View results. Save the completed visualization.
You can create a Finished Report, a Visualization, or both, depending on how you want to present the data.
Report Automation
Step 1: Configure the Scheduler
Follow VDM Scheduler Setup and Configuration Guide to set up the Scheduler database, connection profile, and Windows service.
- Configure the SQL-backed Scheduler and select the appropriate SQL connection in the required VDM options.
- To access Global Options and Service Options, close VDM, right-click the VDM shortcut, and select Run as administrator.
- Configure the BridgeWorks VDM Scheduler Service account so it can access the Views, database resources, export folders, and network locations used by your jobs.
- Confirm that the service is running before relying on scheduled execution.
Step 2: Create and Test a Job
Follow Creating a Job in VDM to define how your saved Views will run.
- Open Scheduler, select Job, and add a saved View.
- Add an execution and select its connection profile.
- Configure the export items, destination, filename, and file type.
- Enter any required parameter values. Configure email delivery or post-processing only if your workflow needs them.
- Save the job, then test it and confirm the expected exports and any enabled email delivery.
A job can contain multiple Views or executions. For example, you can run the same View for several regions using different parameter values.
Important: Saving a job does not schedule it. Create a Scheduler appointment in the next step.
Step 3: Schedule the Job
Follow Scheduling Jobs Using the VDM Scheduler to create an appointment.
- Open Scheduler at the bottom of VDM or select Calendar on the Home ribbon.
- Select New Appointment and enter a subject, start time, and end time.
- Select Select Jobs, choose the jobs to run, and select Finish.
- Select Save And Close.
- Verify the appointment on the calendar and confirm its date, time, and assigned jobs.
After the appointment runs, check the output and review Monitoring Scheduler Activity Using Logs to confirm the result or investigate a failure.
Example: Automate a Sales Report
- Connect to your sales database.
- Create a View with customer, order date, and sales amount fields, linking tables as needed.
- Add date parameters and filters, run the View, and verify the results.
- Create and preview a Finished Report grouped by customer.
- Save the View and create a job that exports the report as a PDF.
- Test the job, create an appointment for the desired date and time, and verify the scheduled output.
Need Help?
If you need help with installation, registration, report creation, or automation, contact support@bridgeworksllc.com. Include the step you are working on, your VDM version, and any error message.
Comments
0 comments
Please sign in to leave a comment.