From 75095d5cfea39194bc545dbb4e7c83a2ae18d003 Mon Sep 17 00:00:00 2001 From: Jono Chang Date: Mon, 5 Jan 2026 21:16:15 +1100 Subject: [PATCH 1/2] add exporting-workflow-data page --- .../user-manual/managing-workflows/_index.md | 1 + .../creating-workflow-orders.md | 3 +- .../exporting-workflow-data.md | 73 +++++++++++++++++++ 3 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 content/docs/user-manual/managing-workflows/exporting-workflow-data.md diff --git a/content/docs/user-manual/managing-workflows/_index.md b/content/docs/user-manual/managing-workflows/_index.md index f29dbfc..ae9d3e3 100644 --- a/content/docs/user-manual/managing-workflows/_index.md +++ b/content/docs/user-manual/managing-workflows/_index.md @@ -9,3 +9,4 @@ weight = 30 draft = false +++ +Export workflow data, including CSV results and case files: [Exporting Workflow Data](/docs/user-manual/managing-workflows/exporting-workflow-data/). diff --git a/content/docs/user-manual/managing-workflows/creating-workflow-orders.md b/content/docs/user-manual/managing-workflows/creating-workflow-orders.md index 93febef..d4aaa8a 100644 --- a/content/docs/user-manual/managing-workflows/creating-workflow-orders.md +++ b/content/docs/user-manual/managing-workflows/creating-workflow-orders.md @@ -20,6 +20,8 @@ Workflow Orders are a way of dividing up the work of your Assessment Workflow in A Workflow Order funnels work through a sequence of Workflow Steps. For example, the sequence might be Data Source -> Machine Assessment Step -> Human Assessment Step. The following instructions assume your sequence of Workflow steps has already been set up, and includes a data source as the first step. +To export workflow data (CSV results or case files) for a workflow order, see [Exporting Workflow Data](/docs/user-manual/managing-workflows/exporting-workflow-data/). + - Navigate To The Workflow Orders Page - Manually Create Workflow Orders - Bulk-Create Workflow Orders @@ -59,4 +61,3 @@ You will see instructions about the format of CSV required. Once you have create Also set the 'State of Orders' dropdown to indicate whether you want the new Workflow Orders to be created as 'draft' or 'approved'. The state of an order is a way to indicate whether it's a work-in-progress that you will make further changes to, or whether it's finished and approved. Then click 'Create Orders' and you'll be redirected to your orders page, with a message indicating the results, for example:
Successfully imported orders: 30 total, 30 created, 0 skipped due to same name, 0 skipped due to same filter original source url.
You can change your CSV and try again - only orders that don't already exists in the system will be created. - diff --git a/content/docs/user-manual/managing-workflows/exporting-workflow-data.md b/content/docs/user-manual/managing-workflows/exporting-workflow-data.md new file mode 100644 index 0000000..1d6b40c --- /dev/null +++ b/content/docs/user-manual/managing-workflows/exporting-workflow-data.md @@ -0,0 +1,73 @@ ++++ +title = "Exporting Workflow Data" +description = "Export workflow data, including case files and CSV results, from Highlighter." +date = 2025-05-01T08:00:00+00:00 +updated = 2025-05-01T08:00:00+00:00 +draft = false +weight = 20 +sort_by = "weight" +template = "docs/page.html" + +[extra] +toc = true +top = false ++++ + +Use the workflow page to export data for an entire workflow or a specific workflow order. + +- If you select a workflow order, exports include only that order. +- If no order is selected, exports include all cases in the workflow. + +## Navigate to the workflow page + +1. Click "Develop" in the top navigation. +2. Click "Workflows" under "Assessments". +3. Open the workflow you want to export. +4. Use the order selector to choose a workflow order (optional). + +## Export results as CSV + +1. Choose the submissions and layout options. +2. Click "Export CSV". + +The CSV export includes assessment results and metadata for the current workflow or selected order. + +## Export case files (ZIP) + +1. Click "Export Case Files". +2. (Optional) Enter a folder path template. +3. Click "Download Files". + +If no template is provided, files are placed at the ZIP root using the default filename pattern: +`__.` + +### Customize the ZIP path + +You can control the folder structure inside the ZIP by providing a template. Use Liquid-style +variables like `{{ WORKFLOW_ORDER_NAME }}` and `/` to create folders. + +Example: +`{{ WORKFLOW_ORDER_NAME }}/{{ CASE_EXTERNAL_ID }}/{{ FILENAME }}` + +Available variables: +- `WORKFLOW_NAME`: Project/workflow name +- `WORKFLOW_ORDER_NAME`: Workflow order name (or workflow name if no order) +- `CASE_ID`: Case database ID +- `CASE_SHORT_ID`: Case short ID +- `CASE_EXTERNAL_ID`: External ID (entity, case, or short ID) +- `CASE_EXTERNAL_ID_PADDED`: External ID zero-padded to 12 digits +- `FILE_UUID`: File unique identifier +- `FILE_COUNT`: File number within the case (1-based) +- `FILE_EXT`: File extension (.jpg, .png, etc.) +- `ORIGINAL_FILENAME`: Original uploaded filename +- `FILENAME`: Default generated filename + +Notes: +- Templates only support plain variables. Tags, filters, and `${TOKEN}` syntax are not supported. +- Invalid path characters are sanitized, and unsafe paths (absolute paths or `..`) are rejected. + +## Export annotated case files (ZIP) + +1. Select a workflow order. +2. Click "Export Annotated Case Files". +3. You will receive an email with a download link when the export is ready. From 9f2ca840942a909b19abd00ad260713cd9958789 Mon Sep 17 00:00:00 2001 From: Simon Hudson <52228262+simon-dev-ml@users.noreply.github.com> Date: Tue, 6 Jan 2026 14:47:28 +1100 Subject: [PATCH 2/2] Apply suggestion from @gemini-code-assist[bot] Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- .../user-manual/managing-workflows/exporting-workflow-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/user-manual/managing-workflows/exporting-workflow-data.md b/content/docs/user-manual/managing-workflows/exporting-workflow-data.md index 1d6b40c..43c6e97 100644 --- a/content/docs/user-manual/managing-workflows/exporting-workflow-data.md +++ b/content/docs/user-manual/managing-workflows/exporting-workflow-data.md @@ -16,7 +16,7 @@ top = false Use the workflow page to export data for an entire workflow or a specific workflow order. - If you select a workflow order, exports include only that order. -- If no order is selected, exports include all cases in the workflow. +- If no order is selected, exports include all cases in the workflow. Note that some export types, such as annotated case files, require a workflow order. ## Navigate to the workflow page