Documentation Index

Fetch the complete documentation index at: https://docs.unqork.io/llms.txt

Use this file to discover all available pages before exploring further.

Data Collections

Prev Next

Data Collections are workspace-level reference datasets that modules and workflows can query at runtime. Use Data Collections to store lookup tables, configuration values, product catalogs, and other reference data that must be shared across multiple applications. This approach avoids hardcoding values into individual modules. Data Collections can also be promoted to the library for use across workspaces. See Shared Elements and Workspace RBAC for the sharing workflow.

What Are Data Collections?

A Data Collection is a structured dataset stored at the workspace level. Each collection defines a schema (field names and types) and stores rows of data that modules can query dynamically through the Query API during runtime.

Data Collections store reference data, which is information that modules read but typically don't modify. Examples include:

  • Lookup tables: State abbreviations, country codes, tax rates by region.
  • Configuration values: Feature flags, environment-specific settings, approval thresholds.
  • Product catalogs: Item names, SKUs, pricing tiers, category mappings.
  • Reference lists: Department names, office locations, valid status codes.

Each collection belongs to a specific application and can be queried by modules in that application.

When to Use Data Collections

Use Data Collections to:

  • Share reference data across multiple modules without duplicating the dataset in each module.
  • Update reference values centrally without modifying module logic or redeploying modules.
  • Store lookup tables that modules query at runtime to display user-friendly values or validate input.
  • Maintain configuration data that varies by environment or changes independently of module updates.
  • Centralize product catalogs or reference lists that multiple applications need to access.

Data Collections work best for datasets that:

  • Are read frequently but updated infrequently.
  • Contain structured, tabular data with a consistent schema.
  • Need to be queried dynamically instead of embedded as static values.

Why Use Data Collections Instead of Other Data Approaches

Approach When to Use Instead Trade-Offs
Hardcoded values in module logic The dataset never changes and is specific to one module. Updating values requires editing and redeploying the module. No central management.
External database integration The data is already maintained in an external system of record or requires complex relational queries. Requires API configuration and credentials. Higher latency for external calls.
Submission data storage The data is user-generated, transactional, or frequently updated by end-users through modules. Submission storage is designed for end-user input, not shared reference data. Queries are scoped to individual submissions.
Global variables or constants The value is a single constant or small set of values used in one module. Global variables don't support structured datasets or runtime queries across modules.

Data Collections provide a middle ground: structured, queryable, centrally managed reference data that modules can access at runtime without external dependencies.

How to Create a Data Collection

Creators can create a Data Collection from the explorer tree in the Explorer tab.

The explorer tree displays a context menu when Creators right-click an application or select the EllipsisVertical (ellipsis) icon.

  1. In the explorer tree, locate an application.
  2. Right-click the application, or select the EllipsisVertical (ellipsis) icon that displays when hovering over the row.
  3. Select Create Data Collection from the menu to open the creation form in a new tab in the Unqork platform.

The workspace and application fields pre-fill with the selected application's values.

Creation Form Fields

Field Type Required Description
Workspace Drop-down Yes Select the workspace where the Data Collection will be created. The drop-down lists all accessible workspaces as Workspace Name (workspace-id). Selecting a workspace refreshes the Application drop-down to show only that workspace's applications.
Application Drop-down Yes Select the application that will own the Data Collection. The drop-down lists applications in the selected workspace as Application Name (application-id). The drop-down is disabled until a workspace is selected.
Data Collection Name Text input Yes Enter a unique name for the Data Collection. This becomes the collection identifier used in Query API calls. When a file is uploaded, the field auto-fills with the file's basename; Creators can edit the name before creating the collection.
Server Side Execution Only Toggle No (Default: ON) When set to ON, this setting restricts the collection to queries through the Query API from server-side execution. Disable if modules need to query the collection directly from the browser.

Schema Definition

Creators can define the collection's schema in two ways: manually or by uploading a CSV file.

Manual Schema Definition

  1. In the schema section, select Add Field to add a row to the schema table.
  2. Enter a Field Name for each column in the collection.
  3. Select a Field Type from the drop-down: String for text values, Number for numeric values, or Boolean for true/false values.
  4. Select Add Field to add additional fields as needed.
  5. Select Create Data Collection to create an empty collection with the defined schema.

Creators can add data to the collection after creation by opening the collection's detail view.

CSV Upload

  1. In the schema section, select Upload a file instead.
  2. Drag and drop a CSV file into the upload area, or select a file. The system uses the first row as column headers (field names).
  3. Select Create Data Collection to create the collection with the CSV schema and data.

CSV files must meet the following requirements:

  • First row must contain column headers.
  • All rows must have the same number of columns.
  • Maximum file size: 10 MB.
  • Supported encoding: UTF-8.

When Creators upload a CSV file, the Data Collection Name field auto-fills with the file's basename. Creators can edit the name before creating the collection.

To switch back to manual schema definition, select Define schema manually instead.

After Creation

After Creators create a Data Collection, the Unqork platform opens the Data Collection Page in a new tab. From there, Creators can add and edit rows, manage schema fields, configure server-side execution, and export or share the collection. Modules and workflows can query the collection immediately through the Query API.

Sharing a Data Collection to the Library

A workspace Data Collection can be promoted to the library so other workspaces can use it. Once shared, the Data Collection is available in Library Elements. Its EllipsisVertical (ellipsis) menu now shows Access & Usage instead of Share to Library.

To share a Data Collection, select EllipsisVertical (ellipsis) next to the Data Collection in the Applications section of the Explorer and select Share to Library. This opens the Access & Usage dialog in share mode, where Creators configure the sharing scope.

For the full sharing workflow, permission requirements, and access management, see Shared Elements and Workspace RBAC.

Note: Shared Data Collections cannot be moved to a different application. Unshare the Data Collection before moving it.


Changelog

Date Change
2026-08-12 Editorial pass: replaced "Unqork IDE" with "Unqork platform"; added ellipsis accessibility markup (EN-8001).
2026-08-11 Editorial review: capitalized Data Collection/Data Collections consistently; added missing periods to all bulleted and numbered lists; changed second-person "you" to third-person "Creators"; corrected ⋮ (ellipsis) icon markup throughout; changed "click" to "Select" throughout; fixed fragment descriptions in Application table row; replaced em dash with period in Data Collection Name description; fixed "Server Side Execution" to "server-side execution" in description; fixed toggle description to "When set to ON, this setting..."; changed "user input" to "end-user input"; folded result steps into action steps (steps 4→3 in creation flow, step 3→2 in CSV flow); fixed split numbered list in Manual Schema Definition by integrating field types into step 3; converted "Field Types:" and "CSV File Requirements:" labels to complete sentence introductions; fixed "Access and Usage" to "Access & Usage" (EN-8001).
2026-08-11 Condensed "After Creation" to link to new Data Collection Page article; added DocsCreateDataCollectionMockup; converted Workspace/Application/Name/SSE-Only to field table; stripped redundant HR separators (EN-8001).
2026-08-10 Added "Sharing a Data Collection to the Library" section; updated intro with library reference; updated See Also (EN-8001).
2026-06-29 Complete rewrite with concept explanation, creation workflows, and form field reference.
2026-05-22 Initial stub.