How to Start a New Bulk Export Job
Follow these steps to start a new bulk export.
Prerequisites
Permissions
You must have Admin permissions for the project from which you are exporting data.
Step 0: Open the New Export Dialog
- Sign in to Flywheel.
- Go to your project, select the options menu, and choose Exports.
- Click the New Export button
Step 1: Settings
- (Optional) Enter a name and description for the new export job to help you locate it and remember its purpose at a later time.
- (Required) Select the destination to where the files should be exported.
- (Optional) Configure how the export process should handle any pre-existing files in the destination.
For more information, refer to the section on Export Job Settings.
Step 2: Rules
Selection Criteria
First, select the Container Level at which the subsequent filter rules will be applied for select which files to export, then apply filters to select which files should be exported.
For more information, refer to the section on Selecting Files.
In the example below, only DICOM files from subjects within the mlset value of "Training" are exported.
Placement Rules
Placement rules are used to define how files will be organized and named when placed into the destination storage. The default settings are generally acceptable in most circumstances, but you may configure them as you need.
For more information, refer to the section on Placement Rules
Step 3: Timepoint
You can either export files from the current state of the Project or a previously-recorded snapshot by selecting the timepoint.
For more information, refer to the section on Timepoint (Snapshot).
Step 4: Review & Test
In this final step review your selections for the export job configuration.
Dry-Run (Test)
Press the Run Dry-Run button perform a short test of the export. This test will not write any data to the destination storage, but it will run simulate the export by applying the export rules against the selected timepoint for the first 100 files, then present the results for review. Once complete, verify that the correct files are being selected and that they are properly organized and named according to the export rules. Hover over longer names to view the full name.
Step 5: Start Export Job
If you are satisfied with the dry run, and have confirmed the settings, press the Begin Export button to start the export job. After starting the export, the dialog closes and brings you to the Bulk Export job list where you can find and monitor your new Bulk Export job.
If you selected "My Computer" as the export destination, the download progress will be shown in the bottom-right corner.
Downloading to 'My Computer'
The browser tab where the download is in progress must remain open until the download is fully complete.
However, you may continue to navigate around Flywheel and perform other tasks in this same tab.
Output
After the export is started, files will start to populate the storage destination according to the configuration (path template, filters, etc.).
The Bulk Export job runs in the background on the Flywheel server. If you are exporting to an External Storage destination, you may close your browser entirely and check back to see the progress at a later time. However, if you are exporting to "My Computer", then you will need to keep your browser tab open where the download progress is shown until the export job is complete and all files are downloaded.