Build a Bulk Download Module

This guide walks you through building a UI module that exports submission data from Unqork in bulk. The module handles the full sequence: starting the export job, checking its status, and generating a download link, all from a single button click.

Download the example module bundle to use as a starting point. After importing, replace every placeholder before using the module:

Prerequisites

• Creator or Express Administrator access to your workspace.

• The resource ID of the Data Model or module containing the records to export.

• Familiarity with the Plug-In, Decisions, and Button components.

Module Overview

Organize the module into three field groups: for initialization logic, for the Creator-facing UI, and for the backend Plug-In component sequence.

The example Property IDs in this guide use a plugin prefix (for example, pluginExport) for clarity. The platform default for Plug-In components is plug — see Property ID Naming Conventions.

How to read settings tables

The tables below describe each configurable option as it shows in the platform. Values are formatted as follows: inline code — a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked

Set Up the Field Groups

Create three field groups in the module to keep components organized.

Create the Supporting Fields

Add the following fields to fgConfig. These fields carry data between components throughout the export and download sequence.

Configure initOnload

The initOnload Initializer component fires when the module first loads and serves as the module's entry point. It has no outputs and no connections to other components.

1. Add an Initializer component to fgOnLoad.

2. Configure the following settings:

   Setting	Value
   Property ID	initOnload
   Trigger Type	New Submission

Configure btnExport

The btnExport Button component starts the export sequence. When a Creator clicks it, it triggers the pluginExport Plug-In component.

1. Add a Button component to fgUI.

2. Configure the following settings:

   Setting	Value
   Property ID	btnExport
   Label	Export Records
   Action	Event

3. Under Triggers, set the On Click drop-down to pluginExport.

Configure btnRefresh

The btnRefresh Button component lets the Creator manually re-check job status. It triggers the pluginGetJobDetails Plug-In component on click, and the ruleCheckStatus Decisions component enables it a job is running. It starts disabled.

1. Add a second Button component to fgUI.

2. Configure the following settings:

   Setting	Value
   Property ID	btnRefresh
   Label	Refresh
   Action	Event
   Initial State	Disabled

3. Under Triggers, set the On Click drop-down to pluginGetJobDetails.

Configure initError

The initError Initializer component sets the response field to Fail when something goes wrong. All three Plug-In components reference it as their error handler.

1. Add an Initializer component to fgConfig.

2. Configure the following settings:

   Setting	Value
   Property ID	initError
   Trigger Type	Manual

3. Configure the Outputs:

   #	Property ID	Type	Value
   1	response	Value	Fail

Configure pluginExport

The pluginExport Plug-In component starts the bulk export job. It is triggered by the btnExport Button component. On success, it triggers the pluginGetJobDetails Plug-In component to begin polling for job status.

1. Add a Plug-In component to fgConfig.

2. Configure the following settings:

   Setting	Value
   Property ID	pluginExport
   Trigger Type	Manual
   Endpoint URL	https://{environment}.unqork.io/fbu/uapi/bulkOperations/export
   Method	POST

3. Configure the Inputs:

   #	Property ID	Value
   1	resourceId	The Data Model ID or module ID containing the records to export
   2	name	A descriptive label for the operation
   3	fileFormat	'CSV' (uppercase)
   4	exportFullRecord	'false' (Unqork recommends false to export the data object)
   5	numberOfFilesToGenerate	numFilesToGen (reads from the hidden Number field; defaults to 1)
   6	targetRecordType	'ALL' (uppercase; or 'ACTIVE' or 'ARCHIVED')

4. Configure the Outputs:

   #	Property ID	Value
   1	jobId	id

5. Under Triggers, set the Post Trigger drop-down to pluginGetJobDetails and the Error Handler drop-down to initError.

To filter by date range, add dateFieldToFilterOn, dateFieldStartToFilterOn, and dateFieldEndToFilterOn to the Inputs. See Bulk Data Operations for all available parameters.

Configure pluginGetJobDetails

The pluginGetJobDetails Plug-In component checks the status of the export job. It is triggered by the pluginExport Plug-In component on success, and by the btnRefresh Button component when the Creator clicks it manually. On completion, it triggers the ruleCheckStatus Decisions component.

1. Add a Plug-In component to fgConfig after pluginExport.

2. Configure the following settings:

   Setting	Value
   Property ID	pluginGetJobDetails
   Trigger Type	Manual
   Endpoint URL	https://{environment}.unqork.io/fbu/uapi/bulkOperations/jobs/{{data.jobId}}
   Method

3. Configure the Outputs:

   #	Property ID	Value
   1	status	data.status
   2	exportLocation	data.steps[0].files[0].destination.location

4. Under Triggers, set the Post Trigger drop-down to ruleCheckStatus.

All BDO endpoints in this module use the bulkOperations path (camelCase, no hyphen).

Configure ruleCheckStatus

The ruleCheckStatus Decisions component reads the job status written by the pluginGetJobDetails Plug-In component and triggers a pop-up message to the Creator. It enables the btnRefresh Button component a job is running and triggers the pluginGetDownloadLink Plug-In component automatically when the job reaches completed.

1. Add a Decisions component to fgConfig after pluginGetJobDetails.

2. Configure the following settings:

   Setting	Value
   Property ID	ruleCheckStatus
   Trigger Type	Manual

3. Configure the Inputs:

   #	Property ID	Alias	Type
   1	jobId	A	Exact
   2	status		Exact

4. Configure the Outputs:

   #	Property ID	Type
   1	btnRefresh	Disabled
   2	fgUI	Pop Message
   3	pluginGetDownloadLink	Trigger

5. Add row per job status in the Decision grid:

   Status	Refresh Button (btnRefresh_disabled)	Pop Message (fgUI_popMessage)	Download Trigger (pluginGetDownloadLink_trigger)
   created	=IF(LEN(A)>0,'no','yes')	Export started.
   inProgress	=IF(LEN(A)>0,'no','yes')	Export in progress.
   completed	=IF(LEN(A)>0,'no','yes')	Export complete. Generating download link.	GO
   partiallyCompleted	=IF(LEN(A)>0,'no','yes')	Export partially complete.
   canceled	=IF(LEN(A)>0,'no','yes')	Export canceled.
   failed	=IF(LEN(A)>0,'no','yes')	Export failed.

   The formula in the disabled column uses A (the jobId alias); the button enables when a job ID is present.

Configure pluginGetDownloadLink

The pluginGetDownloadLink Plug-In component generates a signed URL for downloading the exported file. It is triggered by the ruleCheckStatus Decisions component when the job status reaches completed, and writes the result to the downloadLink field.

1. Add a Plug-In component to fgConfig after ruleCheckStatus.

2. Configure the following settings:

   Setting	Value
   Property ID	pluginGetDownloadLink
   Trigger Type	Manual
   Endpoint URL	https://{environment}.unqork.io/fbu/uapi/bulkOperations/downloadLink
   Method	POST

3. Configure the Inputs:

   #	Property ID	Value
   1	fileLocation	exportLocation

4. Configure the Outputs:

   #	Property ID	Value
   1	downloadLink	downloadLink

5. Under Triggers, set the Error Handler drop-down to initError.

Test the Module

1. Open the module in Preview.

2. Click Export Records.

3. Click Refresh until the pop-up message reads Export complete. Generating download link.

4. Open the submission using the platform's submission inspection method. See Debugger for how to access submission data from Express View.

5. Locate the downloadLink field value. It contains a relative path in the format /files/{fileId}.

6. Construct the full download URL by prepending https://{environment}.unqork.io/api to the path (for example, https://qa22.unqork.io/api/files/6abe94956afacf4d485c59a2).

   The URL must include /api/ between the environment domain and /files/. Navigating to /files/ directly returns a bad route.

7. Paste the full URL into a browser. The file should begin downloading.