Trouble Viewing Images? Right-click on any image and select "Open in new tab" to view a larger version. You can also zoom in using Ctrl + Mouse Wheel for easier readability.
Article Goal
Learn how Settings work in VDM and how they can be used to control application behavior, performance, appearance, and reporting functionality.
What Are Settings?
Settings allow users and administrators to customize how VDM behaves, displays information, and interacts with data sources.
Settings can be used to control:
- Application behavior
- User interface preferences
- Reporting features
- Performance-related options
- Export and formatting behavior
When Would I Use Settings?
Use Settings when you need to:
- Customize the VDM user experience.
- Configure reporting behavior.
- Adjust performance-related options.
- Control export and formatting preferences.
- Enable or disable application features.
Accessing and Managing Settings
VDM provides three categories of settings that control application behavior, reporting features, and service-related functionality.
Settings Categories
| Category | Description |
|---|---|
| User Options | Settings that can be modified by the current user and apply only to their VDM environment. |
| Global Options | Application-wide settings that affect all users on the workstation. |
| Service Options | Settings related to VDM services and background processes. |
Administrative Access Requirements
Important: VDM must be launched using Run as Administrator to modify Global Options and Service Options. Without administrative privileges, users can only view or modify settings located within User Options.
Some setting changes may require VDM to be restarted before they take effect.
Settings File Locations
VDM stores settings in separate configuration files based on the settings category.
| Settings Category | Location |
|---|---|
| User Options | %APPDATA%\BridgeWorks VDM\OPTIONS |
| Global Options | %PROGRAMDATA%\BridgeWorks VDM\OPTIONS |
| Service Options | %PROGRAMDATA%\BridgeWorks VDM\SERVICEOPTIONS |
Changes made within the Settings window are saved to these configuration files and are loaded automatically when VDM starts.
Bridgit AI Settings
Bridgit AI Settings control how Bridgit AI interacts with AI providers, processes requests, and generates responses within VDM. These settings define the models used for chat, analysis, embeddings, and query generation, as well as various behavior and performance options.
Bridgit AI Settings
| Setting | Description |
|---|---|
| Analysis Model | AI model used for data analysis and reporting tasks. |
| API Key | API key used to authenticate with the configured AI provider. |
| Chat Model | AI model used for conversational interactions with Bridgit AI. |
| Compaction Threshold Tokens | Defines the token threshold at which conversation history may be compacted or summarized. |
| Embedding Model | Model used to generate embeddings for search, retrieval, and knowledge-related functionality. |
| Enable Chat Logging | Enables or disables the logging of Bridgit AI conversations. |
| Max_Tokens | Specifies the maximum number of tokens that can be returned in a response. |
| Query Model | AI model used when generating or processing queries. |
| Streaming | Enables or disables streaming responses from the AI provider. |
| System Prompt | Defines the default instructions provided to the AI when generating responses. |
Important: Changes to Bridgit AI Settings may affect response quality, performance, and AI functionality. These settings should only be modified by users familiar with their purpose and configuration requirements.
Connection Options
Connection Options control how VDM establishes, maintains, and manages database connections. These settings can be used to configure connection behavior, timeouts, automatic loading, and database-specific functionality.
Connection Options
| Setting | Description |
| Connection Attempt Limit | Defines the number of times VDM will attempt to reconnect if a database connection fails. |
| Default Connection | Specifies the Connection Profile that will automatically open when VDM launches if Load All Connections is disabled. |
| Heartbeat Duration | If Persistent Connection is enabled, defines the interval (in minutes) between connection heartbeat checks used to maintain an active database connection. |
| Idle Timeout (Persistent Connection Disabled) | Specifies how long (in minutes) an inactive connection remains open before timing out when Persistent Connection is disabled. |
| Load All Connections | When enabled, all available Connection Profiles are automatically loaded into the Tables and Fields panel when VDM starts. When disabled, a single connection must be opened manually or through the configured Default Connection. |
| Max List Size | Defines the maximum size of lists used within View filters. When database query limits are exceeded, VDM automatically splits the query into smaller pieces and combines the results before displaying them in the Details Data Grid. |
| NLS Dates | When enabled, applied date filters are formatted using the YYYY-MM-DD date format. |
| Persistent Connection | When enabled, VDM keeps the database connection open after a View is executed, reducing connection overhead and improving performance. When disabled, the database connection is closed after each View execution. |
| Query Delay | Defines the number of seconds VDM waits between executing dynamic parameter queries. This setting can be useful for databases that limit rapid query execution. A value of 0 disables the delay. |
| Special Character Support | Enables support for database table and field names that contain special characters, such as spaces or slashes. |
| Use Brackets (Special Character Support) | Used in conjunction with Special Character Support. When enabled, VDM wraps table and field names in brackets ([ ]) instead of double quotes, which can help when database object names contain special characters. When disabled, object names are used exactly as they are returned by the database. |
Note: Connection settings can affect database connectivity, performance, and query behavior. These settings should only be modified when their purpose and impact are understood.
Finished Reports Settings
Finished Reports Settings control certain behaviors within the Finished Reports designer, including how report data is displayed and which reporting layout technologies are used.
Finished Reports Settings
| Setting | Description |
|---|---|
| Allow Open With No Data | When enabled, Finished Reports can be opened without first loading report data. When disabled, report data must be available before opening the Finished Report. |
| Pivot or Crosstab | Determines whether Finished Reports use a Pivot Table or Crosstab Table for displaying summarized and grouped data. |
Note: Changing the Pivot or Crosstab setting affects how summarized data is displayed within Finished Reports and may impact existing report designs.
Folder Locations
Folder Locations define where VDM stores and retrieves various files, templates, configurations, and reporting assets. These locations can be customized to support organizational standards, shared storage, or backup requirements.
Folder Locations
| Location | Description |
|---|---|
| Auto Scheduler | Stores files used by the VDM Scheduler and scheduled jobs. |
| Bridgit AI | Stores files and resources used by Bridgit AI. |
| Command Tables | Stores Command Table files used within Views and reporting processes. |
| Dashboards | Stores Visualize Designer dashboards and related assets. |
| Favorite Tables | Stores saved Favorite Tables. |
| Formats | Stores custom formatting definitions used throughout VDM. |
| Formulas | Stores saved formulas and reusable calculation definitions. |
| Knowledge | Stores Knowledge files used by the Knowledge Editor and AI-assisted reporting features. |
| Linking | Stores saved linking definitions and related configuration files. |
| Lists | Stores saved list files used by filters, parameters, and reporting workflows. |
| Logs | Stores VDM log files used for troubleshooting and diagnostics. |
| Profiles | Stores Connection Profiles and related connection configuration files. |
| Templates | Stores report, dashboard, and other reusable templates. |
| Views | Stores VDM View files. |
Storage Recommendations
Folder Locations can be redirected to shared network drives, cloud-synchronized folders, or centralized storage locations. However, some locations are recommended to remain on the local workstation.
| Location Type | Recommended Storage |
|---|---|
| Views | Local or Shared |
| Templates | Local or Shared |
| Lists | Local or Shared |
| Dashboards | Local or Shared |
| Profiles | Local Recommended |
| Logs | Local Recommended |
| Knowledge | Depends on deployment requirements |
Important: Connection Profiles are encrypted using machine-specific information and are intended to be used on the workstation where they were created. Moving or sharing encrypted Connection Profiles between systems may prevent them from functioning correctly.
Before redirecting folder locations, verify that the associated files are designed to support shared or portable storage.
Note: Folder locations stored within cloud-synchronized services such as Microsoft OneDrive may experience file access or file locking issues while synchronization is occurring. If users experience problems opening, saving, or updating files, consider storing frequently used VDM folders in a local, non-synchronized location.
Insights Settings
Insights Settings control how Insights loads, where layouts are stored, and where Insights retrieves exported data. These settings can be used to customize the Insights startup experience and manage saved layouts and scheduled exports.
Insights Settings
| Setting | Description |
|---|---|
| Data Location | Specifies the location where Insights looks for data that has been exported from the Scheduler using the Export to Insights option. |
| Default Layout | Determines which Insights layout is loaded when Insights starts. If left blank, a new layout is created each time Insights is launched. |
| Insight Pages | Defines the number of available Insight pages within the layout. |
| Launch on Load | When enabled, Insights automatically launches when VDM starts. When disabled, VDM opens to the standard VDM interface. |
| Layout Location | Specifies the location where Insights layouts are stored when they are saved. |
Note: If Data Location or Layout Location are redirected to network drives or cloud-synchronized folders, performance may vary depending on network availability and synchronization activity.
Logging Options
Logging Options control the information VDM records for troubleshooting, diagnostics, and monitoring purposes.
Logging Options
| Setting | Description |
|---|---|
| Write Heartbeats to Logs | When enabled, VDM records database connection heartbeat activity within the log files. |
| Write to Event Logs | Enables VDM to write application events to the Windows Event Log. Modifying this setting requires VDM to be launched using Run as Administrator. |
Note: Logging can be useful when troubleshooting connectivity, performance, or application issues. Additional logging may increase the size of log files over time.
MDS Settings
MDS (Multi-Data Source) Settings control the database used by VDM's Multi-Data Source functionality.
MDS Settings
| Setting | Description |
|---|---|
| SQL Database | Specifies the database used by VDM's Multi-Data Source (MDS) functionality. MDS allows a single View to retrieve and combine data from multiple databases. |
Note: Changes made to MDS Settings require VDM to be restarted before they take effect.
For additional information on configuring and using Multi-Data Source reporting, refer to the Setting Up Multiple Data Sources (MDS) in VDM.
Options
Options contain application-level configuration settings used by VDM.
| Setting | Description |
|---|---|
| Company ID | Displays the Company ID assigned to your VDM license. |
Note: The Company ID is used to identify your organization's VDM licensing and configuration. This value is typically assigned during licensing and should only be modified under the direction of BridgeWorks Support.
Scheduler Settings
Scheduler Settings control how VDM Scheduler stores scheduling information, connects to its data source, and exposes service management functionality. These settings are used to configure Scheduler behavior and manage how scheduled jobs and automation processes are stored and executed.
Note: The Scheduler settings displayed may vary depending on whether User Options, Global Options, or Service Options are selected.
Some Scheduler settings are only available when VDM is launched using Run as Administrator. Users without administrative privileges may not see all Scheduler configuration options.
| Setting | Description |
|---|---|
| Calendar Location | Specifies the location where Scheduler calendar backups and related calendar files are stored. |
| Show Service Commands | When enabled, the Start Service, Stop Service, and Restart Service commands are displayed under the Service menu within the Scheduler Calendar. These commands can be used to manage the Scheduler Service directly from VDM. |
| SQL Connection | Specifies the Connection Profile used by Scheduler for database operations when Use SQL Database is enabled. |
| Use SQL Database | When enabled, Scheduler stores and retrieves scheduling information using the configured SQL database. When disabled, Scheduler uses the local Scheduler Calendar file instead of a SQL database. Using a SQL database is the recommended configuration for most environments, but the Calendar file can be used when a SQL database is not available. |
Administrative Access: Some Scheduler settings are located within Global Options and Service Options. These settings are only visible when VDM is launched using Run as Administrator.
The Calendar Location setting is available within User Options and Global Options, while service-related Scheduler settings are available within Service Options.
Note: Using a SQL database is the recommended Scheduler configuration because it provides centralized storage and improved reliability for scheduled jobs. The Calendar file option is intended primarily for environments where a SQL database is not available.
Changes to Scheduler Settings may affect scheduled jobs, Scheduler database connectivity, and service functionality.
Scheduler Service Settings
Scheduler Service Settings control how the VDM Scheduler Service stores scheduling information, logs activity, and connects to data sources. These settings are used to configure the background service responsible for executing scheduled jobs, reports, exports, and automated processes.
Note: Scheduler Service Settings are only available within Service Options and require VDM to be launched using Run as Administrator.
| Setting | Description |
|---|---|
| Appointment Diagnostic Logging | When enabled, Scheduler records detailed diagnostic information about appointment activity, including appointment ticks, appointment executions, next scheduled run times, execution results, and related scheduling events. These logs can be used to troubleshoot scheduling issues, missed executions, and appointment behavior. |
| Calendar Location | Specifies the location where the Scheduler Service stores and accesses the Scheduler Calendar file and related backup files. |
| Default Connection | Specifies the default Connection Profile used by the Scheduler Service for database operations. |
| Enable Timer Logs | When enabled, Scheduler records timer-related events and service timing activity within the Scheduler logs. |
| Historical Data | Defines the number of days of historical Scheduler data retained by the Scheduler Service. |
Note: Diagnostic and timer logging can be useful when troubleshooting Scheduler behavior, execution timing, and appointment-related issues. Enabling additional logging may increase the size of Scheduler log files over time.
Changes to Scheduler Service Settings may require the Scheduler Service to be restarted before they take effect.
View Options
View Options control how data is displayed and processed when a View is executed. These settings can be used to optimize performance, control data processing behavior, and configure how View-related functionality operates within VDM.
| Setting | Description |
|---|---|
| Best Fit On Search | When enabled, Data Grid columns are automatically resized to fit their contents each time a View is executed. When disabled, column widths remain unchanged and must be adjusted manually. |
| Client-Side Grouping | When enabled, grouping operations are processed by the local workstation. When disabled, grouping operations are processed by the database server. |
| Client-Side Sorting | When enabled, sorting operations are processed by the local workstation. When disabled, sorting operations are processed by the database server. |
| Embedded Command Tables | When enabled, Command Tables can be embedded directly within a View file, allowing the View to retain the Command Tables required for execution and distribution. When disabled, Command Tables remain external files that must be accessible separately from the View. |
Note: Client-side processing can reduce database workload but may increase memory and CPU usage on the local workstation when working with large datasets. Database-side processing is generally recommended when working with large result sets.
Embedded Command Tables can simplify View distribution by storing Command Table definitions directly within the View file.
Comments
0 comments
Please sign in to leave a comment.