Dataset DBs (Reference) define database connections for data storage, retrieval, and manipulation within the FrameworX platform. It provides:
- SQL database connectivity
- Pre-configured system databases
- Connection string management
- Development/production isolation
- Multi-provider support
Each DB represents a connection to a database used for tags, alarms, historian, or custom data operations.
In this page:
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Steps style none
Configuration Properties
| Property | Description | Required |
|---|---|---|
| Name | Unique database identifier | Yes |
| Provider | Database technology (SQLite, SqlClient, etc.) | Yes |
| Database | Database type/instance | Yes |
| ConnectionString | Connection parameters | Yes |
| LogonPassword | Authentication password (admin only) | No |
| ServerIP | Remote gateway for security | No |
| FilterColumns | Query optimization columns | No |
| CustomOptions | Additional configuration | No |
| Description | Documentation text | No |
Pre-Defined Databases
Four system databases are included in every solution:
| DB Name | Purpose | Default Location |
|---|---|---|
| Retentive | Stores retentive tag values | <SolutionNameAndPath>.dbRetentive |
| RuntimeUsers | Dynamic user management | <SolutionNameAndPath>.dbRuntimeUsers |
| AlarmHistorian | Alarm and audit trail records | <SolutionNameAndPath>.dbAlarmHistorian |
| TagHistorian | Time-series data storage | <SolutionNameAndPath>.dbTagHistorian |
Creating Database Connections
- Navigate to Datasets → DBs
- Click Plus icon
- Configure:
- Name: Unique identifier
- Provider: Select from list
- Database: Choose type
- Description: Documentation
- Click OK
ConnectionString Configuration
Structure
Provider=<provider>;Data Source=<source>;Additional ParametersExamples
SQLite (Local):
Provider=System.Data.SQLite;
Data Source=_SolutionPathAndName_.dbSQL Server Express:
DataSource=.\SQLEXPRESS;
Initial Catalog=myDatabase;
User Id=sa;Password=pwdPostgreSQL:
Host=localhost;Database=mydb;
Username=user;Password=pass;Port=5432ConnectionString Macros
Use these macros for portable configurations:
| Macro | Description | Example |
|---|---|---|
_SolutionPath_ | Solution directory | C:\Solutions\MyApp\ |
_SolutionName_ | Solution name only | MyApp |
_SolutionPathAndName_ | Full path with name | C:\Solutions\MyApp\MyApp |
_ExecutionPath_ | Working directory | Current runtime folder |
_ExecutionPathAndName_ | Working path with name | Runtime location |
_ProductPath_ | Installation directory | C:\Program Files\FrameworX\ |
_Transfers_ | Default transfer folder | Public\Documents\Transfers\ |
_ThirdParty_ | Third-party components | MyDocuments\ProductName\ThirdParty\ |
Supported Providers
| Provider | Supported Databases |
|---|---|
| System.Data.SQLite | SQLite |
| System.Data.SqlClient | SQL Server, SQL Server Express |
| Npgsql | PostgreSQL |
| MySql.Data.MySqlClient | MySQL |
| Oracle.DataAccess.Client | Oracle |
| System.Data.Odbc | Any ODBC-compatible |
| System.Data.OleDb | Access, Excel, CSV |
Development vs Production
Execution Profiles
Automatic database switching for development:
| Production DB | Development Override |
|---|---|
<name>.dbRetentive | <name>.dbRetentiveDev |
<name>.dbRuntimeUsers | <name>.dbRuntimeUsersDev |
<name>.dbAlarmHistorian | <name>.dbAlarmHistorianDev |
<name>.dbTagHistorian | <name>.dbTagHistorianDev |
Configuration
- Configure production databases normally
- Run in Development profile
- Data automatically redirects to Dev databases
- No manual switching required
Security Considerations
Password Management
- Only administrators can set LogonPassword
- Passwords encrypted in configuration
- Use Windows Authentication when possible
Remote Access
Configure ServerIP for gateway security:
- Requires TWebServices on remote computer
- Provides secure tunnel for database access
- Isolates database from direct access
Utilities
SQLite Admin
Built-in tool for SQLite management:
- Browse tables
- Execute queries
- Import/export data
Visual Query Builder
Interactive SQL query creation:
- Drag-and-drop interface
- Join visualization
- Query testing
Best Practices Checklist
- Use macros - Portable connection strings
- Test connections - Verify before deployment
- Document databases - Clear descriptions
- Secure passwords - Admin-only access
- Use Dev profiles - Protect production data
- Regular backups - Especially SQLite files
- Monitor performance - Check query execution
Troubleshooting
Connection failed:
- Verify provider installed
- Check connection string syntax
- Confirm database exists
- Test network connectivity
Access denied:
- Check credentials
- Verify permissions
- Review firewall rules
Performance issues:
- Add indexes
- Optimize queries
- Check network latency
- Review connection pooling
Claude can make mistakes.
Please double-check responses.
In this section...
| Page Tree | ||||
|---|---|---|---|---|
|