Skip to main content

Data Connect

Data Connect reads external databases, turns their tables or application-defined forms into datasets, and makes authorized data available to charts and API clients.

Open Integration Apps → Data Connect in Soln. Availability depends on your subscription and workspace permissions. A database address must be reachable from the tenant Runtime that executes the connection.

Choose Your Starting Point​

Source storageRecommended approach
One database table already represents the data you needScan database structure, then create a dataset from the table
An application stores form definitions separately from business recordsScan form and field definitions, configure data reading, then create a dataset from the form model
Field values are stored inside JSON/XML, shared record tables, or several related tablesConfigure the form model's reading rules before creating the dataset
External applications need controlled access to saved datasetsCreate an API service, bind datasets to API roles, and issue API keys

Set Up Data Connect​

  1. Connect a data source and scan its structure.
  2. If the application has configurable forms, scan form and field definitions.
  3. If relationships are stored as application metadata, scan relationship definitions.
  4. Configure how business records and field values are read.
  5. Create and preview a dataset.
  6. Use the dataset in Visualization, or configure an API service.

Physical-table datasets can skip steps 2–4.

What Each Configuration Does​

ConfigurationPurpose
Data sourceDatabase engine, address, credentials, and TLS settings
Structure snapshotSaved description of database schemas, tables, columns, keys, and relationships
Form definition scanNames, codes, types, options, and other form/field metadata
Relationship definition scanWhich forms and fields reference other forms and fields
Data reading ruleWhere a form's actual business records and field values are stored
DatasetSelected primary source, joins, field settings, and computed fields
API roleDatasets, readable fields, row scope, and separately enabled write operations
API keyCredential for one API service and one API role

A definition scan discovers metadata. It does not import business records into Soln. Dataset queries read the source database when used.

Changes And Permissions​

Saving a dataset does not automatically give internal members permission to use it. Configure member dataset permissions separately from API roles.

An API role uses the latest saved dataset. New fields become readable automatically, removed fields lose their grants, and a main-source or join change resets that binding to all available fields with query-only access. See API authorization changes before changing datasets already used by external clients.

Where To Find Problems​

  • Connection failures: check the data source's connection test and TLS settings.
  • Missing or incorrectly typed fields: check the physical structure, form definition scan, and source field type mappings.
  • Empty values: check the form's reading rule and data preview.
  • Repeated totals: check the selected row meaning and one-to-many joins.
  • Failed API calls: open the API service's Call logs and view the original error in the request details.

Analyze Structure With AI​

With a source table or configuration page open, ask the assistant to inspect the current structure or explain a proposed relationship. It can read saved metadata, inspect bounded samples, test candidate joins in either direction and preview supported reading rules. Save or discard unsaved changes before asking it to update the persisted configuration.

Samples establish observed evidence, not whole-table uniqueness or business meaning. Before creating a dataset, define what each row represents, retain the complete entity key and check whether joins repeat amounts or counts. A physical-table dataset can be created directly; definition scans and form models are optional when no additional mapping is needed. See the Data Connect command reference for the supported workflow and limits.