Data Sources and Structure
Create a data source before scanning definitions, creating datasets, or exposing an API service.
Create A Data Source
- Open Data Connect → Data sources and create a data source.
- Enter its name and select PostgreSQL, MySQL, MariaDB, SQL Server, or Oracle.
- Enter the host, port, database, username, and password. For Oracle, enter the service name rather than a connection descriptor.
- Choose TLS and, when needed, supply a CA certificate.
- Use Test connection to check the configuration.
- Save. Saving tests the submitted configuration again; a failed test prevents it from being saved.
Use a database account with the privileges required for the intended operation. Queries require read access. API inserts, updates, and deletes also require the corresponding database privileges; configuring an API role cannot grant database privileges.
When editing an existing source, leave the password empty to keep the saved password. Passwords are stored encrypted and are not returned in source details.
TLS
TLS protects the connection between the tenant Runtime and the source database. It is separate from the HTTPS connection used by browsers or API clients.
| Setting | Behavior |
|---|---|
| Enabled | Requests encrypted communication and verifies the database server's certificate and identity |
| Disabled | Does not request TLS; traffic can be unencrypted |
| CA certificate omitted | Uses the driver's default trust configuration |
| Custom CA certificate | Uses the supplied PEM certificate for certificate verification |
The database must support TLS. An expired, untrusted, or mismatched certificate can prevent connection; the client does not automatically fall back to plaintext after TLS failure.
For private CA or self-signed certificates, supply the appropriate trusted certificate. Use a host name that matches the server certificate. Oracle uses TCPS and server identity verification; its connection form does not accept an uploaded CA certificate.
Scan Database Structure
- Open the source's structure view.
- Start a structure scan and wait for completion.
- Browse schemas and tables, then inspect columns, native types, primary keys, and relationships.
- Use the changes view to examine differences from the previous scan.
The snapshot records structure, not a copy of the business records. Scanning structure does not change the source tables.
Use the scan schedule when database structure changes regularly. Check the last result and next scheduled run after saving the schedule.
Refresh After A Source Change
After a column, key, or table changes in the source database:
- Run a new structure scan.
- Open affected form models and datasets.
- Refresh their structure and resolve missing or invalid fields and joins.
- Save the confirmed configuration and preview it.
A saved dataset retains its selected structure until you reconcile and save it. A structure change that makes that saved configuration unusable can block queries until it is repaired.
Troubleshooting
| Result | Check |
|---|---|
| Cannot connect | Runtime-to-database connectivity, host, port, and database listener |
| Authentication failed | Username, password, and database login policy |
| Database not found | Database name or Oracle service name |
| TLS failed | Server TLS support, certificate chain, expiry, and host-name match |
| Connection succeeds but tables or queries fail | The database account's schema, table, and operation privileges |
Continue with form definition scanning, or create a dataset directly from database tables.