Work with datasets and data connections
Prepare reusable business data, understand save results and reuse dataset definitions through the API.
A dataset gives native IFBI reporting a reusable definition of the business data it needs. Start with an approved connection and a query or file structure that answers a concrete reporting question, such as overdue invoices or service workload.
Separate connections, datasets and reporting
The connection identifies how IFBI reaches the source. The dataset defines the data configuration, including relevant query or worksheet settings and refresh configuration. Dashboards and KPIs then use that prepared data.
Use the Data connections and queries group in the API reference for the connection type you need. ODBC and OLE DB operations have different models and verification calls. Do not treat an account ID from another installation as interchangeable with the target installation’s account.
Read before creating or changing
List datasets returns a bare array; get one dataset returns a bare object. These are configuration resources, not a general table-row extraction API.
Before changing a query, inspect related dashboards and agree the expected columns and types with the reporting owner. A change to a source column can affect the consumers that depend on it.
Save and verify the result
Dataset Save accepts a DatasetModel. Supply the required configuration for the selected dataset type and preserve existing settings when updating. Saving requires the applicable Gizmo Management permission.
A successful save must return a valid GUID string. An Excel worksheet error can also arrive as a string with HTTP 200, so the status alone is insufficient. Read the saved dataset back and verify the intended name, connection and configuration.
Reuse a definition deliberately
Export and import support definition reuse. Import takes a JSON-encoded datasetJson string plus accountId and databaseTypeId. Map these to a compatible connection in the target installation and review schedules, file paths and access assignments.
Import may save the dataset and process its data. Plan it as a write operation, retain the resulting ID and verify the outcome before repeating a request. The Reuse a dataset definition with another connection recipe in Recipes shows the request sequence.
Next: native dashboard definitions and refresh history.
Updated 3 days ago