Troubleshooting Bulk Import
Audit Report
After an import job terminates for any reason (whether successful, cancelled, or failed), an audit report is made available.
The audit report contains details of what action was taken for every single source file discovered in the source data location, including any errors that may have occurred. The audit report can be extremely helpful in troubleshooting issues, and it can also be useful for maintaining a record of exactly where each file came from and where it was placed in Flywheel.
Downloading the Audit Report
Via the Web App
The audit report can be found by navigating to the Bulk Imports list page, locating the import job, and then either:
-
Selecting the "Download Report" option in the overflow menu on the import job line, or
-
Opening the Import job details dialog from the overflow menu on the import job line and then selecting the "Download Report" button
The audit report is available in either CSV or JSON Lines (JSONL) format.
- The CSV format can be opened in any standard spreadsheet software and may be the simplest option.
-
The JSON Lines format is best when reading the report programmatically.
Via the New (BETA) CLI
The import audit report can be downloaded via the new (BETA) CLI using the following procedure.
First, you will need to locate the import job ID by running the following command:
Tip
Similar to the fw-beta admin storages list
command, the fw-beta import list
command also has similar options for filtering, sorting, skipping, and changing the length of the list to help locate a particular import job. Append the -h
flag to the command to see these options.
Once you have the import job ID, run the following command to resuming monitoring the progress:
Where:
<id>
is replaced with the ID of the import job to be monitored, and<format>
is eithercsv
orjsonl
If you do not know the export job ID, see the article locating the export job ID.
Tip
The output will be written to the terminal (stdout), so you may want to redirect the output to a file for storage instead. E.g., fw-beta import get 682ccd2079fed7cd5c0cd46e --report jsonl > ~/Downloads/import-audit-report-682ccd2079fed7cd5c0cd46e.jsonl
For more information, see the new CLI documentation for import get
.
Formats for the Audit Report
The audit report is available in either CSV or JSON Lines (JSONL) format.
CSV
The CSV version of the audit report contains the following columns:
status
-- Indicates whether the file was successfully imported, skipped, or if an error was encounteredreason
-- Reason for why the file was not imported (empty if the file was successfully imported)src_path
-- Path (including name) of the file in the Source Data Locationdst_path
-- Path to where this file should be placed in the Flywheel Hierarchyfile_id
-- ID of the Flywheel File object in which the source file should be placedversion
-- Version of the Flywheel File object in which the source file should be placedsession_uid
-- UID (DICOM) of the Flywheel Session in which the source file should be placedacquisition_uid
-- UID (DICOM) of the Flywheel Acquisition in which the source file should be placed
Import Audit Report -- CSV Example
The following table shows an entire CSV-formatted Import Audit Report.
status | reason | src_path | dst_path | file_id | version | session_uid | acquisition_uid |
---|---|---|---|---|---|---|---|
success | nan | 1-01.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-02.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-03.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-04.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-05.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-06.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-07.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-08.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-09.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-10.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-11.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-12.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-13.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-14.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-15.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-16.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-17.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-18.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-19.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-20.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-21.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-22.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
success | nan | 1-23.dcm | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip | 6706ab158db3c4807117644c | 1 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
The following table shows a single line from a CSV-formatted Import Audit Report. The line has been transposed for easier viewing.
column | row value |
---|---|
status | success |
reason | nan |
src_path | 1-01.dcm |
dst_path | PGBM-017/RA FH MR RCBV OP/16 - T1post/16 - T1post.dicom.zip |
file_id | 6706ab158db3c4807117644c |
version | 1 |
session_uid | 1.3.6.1.4.1.14519.5.2.1.4429.7055.577653094293787944422597985753 |
acquisition_uid | 1.3.6.1.4.1.14519.5.2.1.4429.7055.152382305681163727022426619554 |
JSON Lines
The JSON Lines version of the audit report contains far more technical details about how the system processed each file.
Here is an example of just one line from an import audit report in JSON Lines format describing how the system processed a single source file:
Import Audit Report -- JSONLines Example
The following is an entire JSONLines-formatted Import Audit Report.
The following is a single line from a JSONLines-formatted Import Audit Report. The line has been reformatted for easier viewing.