Skip to main content

Acquire Queue and Quality Queue

SureDrive provides two document processing queues that sit between document ingestion and the filed document archive. Both must be enabled per drive in SureDrive Properties before they appear in the navigation.

QueuePurpose
Acquire QueueNewly ingested documents that have not yet been classified and filed into the archive
Quality QueueFiled documents that require quality checks or have open discrepancies

Acquire Queue

Entry Point

ItemValue
Route stateapp.network.study.browse.acquire-queue
URL pattern/acquire-queue?page&quickStartInit
ControllerAcquireQueueController
JS fileSC/suredms-web-client/src/main/webapp/app/js/network/study/documents/acquire-queue.js
TemplateSC/suredms-web-client/src/main/webapp/app/views/network/study/documents/acquire/acquire-queue-dashboard.html

Acquire Workflow

  1. Ingestion — A user uploads a document via the Acquire assistant (SC/suredms-web-client/src/main/webapp/app/js/acquire/acquire.js). Supported ingestion methods: Upload, Scan, Workflow.
  2. Document lands in the Acquire Queue — The document is held in a staging area. It is not yet part of the filed archive.
  3. Classification — A user opens the document in the Acquire Queue, assigns it:
    • Organisation
    • Person
    • Content Type (folder destination)
    • Any required metadata
  4. "Move to Archive" — Once classified, the user triggers filing. The document is moved to the correct folder in the archive and removed from the Acquire Queue.

quickStartInit Parameter

The quickStartInit URL parameter enables the Acquire Quick-Start flow — a guided mode that opens the Acquire assistant immediately when the queue is accessed.


Quality Queue

Entry Point

ItemValue
Route stateapp.network.study.browse.quality-queue
URL pattern/quality-queue?page&documentId&discrepancyId&quickStartInit
ControllerQualityQueueController
JS fileSC/suredms-web-client/src/main/webapp/app/js/network/study/documents/quality-queue.js
TemplateSC/suredms-web-client/src/main/webapp/app/views/network/study/documents/quality/quality-queue-dashboard.html

Quality Queue Workflow

Documents land in the Quality Queue when they are already filed in the archive but have open quality issues, for example:

  • Missing mandatory signatures
  • Incorrect or incomplete metadata
  • Open discrepancies raised by a reviewer

A quality reviewer opens the document, resolves or annotates each discrepancy, and either approves (QC OK) or rejects the document. The documentId and discrepancyId URL parameters allow deep-linking directly to a specific document or discrepancy from a notification or report.

QC OK Flag

The QC OK feature (enabled in Properties alongside the Quality Queue) marks a document as quality-checked. When enabled, a document must receive a QC OK status before it is considered complete in compliance reporting.


Enabling the Queues

Both queues are disabled by default. They are enabled per-drive via the SureDrive Properties page:

  • Enable Acquire Queue — enabled via FEATURE_SURE_QMS_PROJECT_EDIT and stored on the ArchiveEntity
  • Enable Quality Queue — same feature flag, separate toggle
  • Enable QC OK — additional toggle on the same properties screen

When enabled, the Acquire Queue and Quality Queue entries appear in the SureDrive navigation menu.


Difference Between Acquire Queue and Quality Queue

Acquire QueueQuality Queue
Document stateNot yet filedAlready filed in archive
Primary actionClassify and move to archiveReview, resolve discrepancies, approve/reject
Who uses itDocument coordinators / uploadersQuality reviewers / QC managers
TriggerDocument ingested via Acquire assistantDiscrepancy raised, or QC OK required

AcquireQueueController — Service and Operations

AcquireQueueController (SC/suredms-web-client/src/main/webapp/app/js/network/study/documents/acquire-queue.js) manages the acquire queue dashboard.

Injected Services

ServiceRole
AcquireServiceFactory / EntityOperationServiceCore entity operations, download, deletion
StudyAutoArchiveServiceExecutes Move to Archive via moveToArchive(selectedItems)
StudyQcOkMarkServiceAdd and delete QC OK marks on documents
QualityDocumentActionItemsServiceAction item management for quality documents
StudyQuickWizardServiceQuick wizard launch for classification
DocumentDiscrepancyServiceDiscrepancy creation and management
StudyBrowserServiceNavigation helpers for the study context
AcquireQueueAssignmentsServiceManage assignee lists per queue item

Nuxeo Operations

OperationTrigger
OPERATION_MOBILE_GET_ACQUIRE_QUEUE_ITEMSInitial load and refresh of the queue list
OPERATION_MOBILE_ACQUIRE_QUEUE_SET_ASSIGNEESUpdate assignees for selected queue items

Move to Archive Flow

The Move to Archive action is the primary file-processing action in the Acquire Queue:

  1. User selects one or more queue items and clicks "Move to Archive"
  2. acquireQueue.canMoveToArchive(item) validates each item's eligibility
  3. If isDocumentSelected && canEditSelectedDocs && _.every(selectedItems, canMoveToArchive), the action is enabled
  4. acquireQueue.moveToArchive($event, items, actions) calls StudyAutoArchiveService.moveToArchive(selectedItems)
  5. After success, EntityOperationService.deleteDocuments may be called to remove the staging copies

Queue Filter Fields

FilterTypeDescription
NametextFile name substring match
UsersarrayFilter by user who uploaded
Created date rangedate rangeUpload timestamp range
StatusselectQueue item status
DirectoriesarrayTarget folder filter
SourceenumUpload / Workflow
OrganizationsarrayOrganisation filter
PersonsarrayPerson filter
AssigneesarrayAssigned reviewer filter
hasDuplicatesbooleanShow only items with duplicate detection flags

QC OK Mark Flags

PropertyMeaning
isQcEnabledQC OK marks enabled for this archive
isDeleteQcOKMarkEnabledPer-item delete QC OK mark permission
isDeleteQcOkMarkFeatureEnabledFEATURE_GLOBAL_DELETE_QC_OK_MARK feature flag is active

QualityQueueController — Service and Operations

QualityQueueController (SC/suredms-web-client/src/main/webapp/app/js/network/study/documents/quality-queue.js) manages the quality queue dashboard.

Injected Services

ServiceRole
DocumentDiscrepancyServiceCreates, lists, and updates discrepancy records
DocumentDiscrepancyDetailsServiceLoads the full discrepancy detail model
PortalContextServiceProvides current study and archive context

Discrepancy Filter Model

FilterDefaultDescription
discrepancyTypesAll (from currentStudy.docDiscrepancyTypes)Which discrepancy types are shown
discrepancyStatusDISCREPANCY_STATUS_OPENOpen vs. closed filter
showClosedItemsfalseInclude recently closed items

The controller reads $stateParams.documentId and $stateParams.discrepancyId on activation and sets:

  • qualityQueue.initDocumentId — auto-selects the document in the list
  • qualityQueue.initDiscrepancyId — auto-opens a specific discrepancy record

Column Variants by Archive Type

Archive typeColumns shown
Study (STUDY_COLUMNS)Name, Organization, Content Type, Items
SureDrive (SURE_DRIVE_COLUMNS)Name, Organization, Cloud Folder, Items

Quality Queue — Audit List

The Audit List is a structured quality sampling feature available within the Quality Queue. It differs from ad-hoc discrepancy review: an Audit List is created by selecting an archive, choosing a content scope, and specifying a sample percentage — the system then randomly selects a subset of documents for review.

Web Client Entry Points

Folder: SC/suredms-web-client/src/main/webapp/app/js/network/quality/audit/

FileComponentPurpose
quality-audits.jsAudit list view controllerDisplays the list of all Audit Lists for the current drive
quality-audit.jsSingle audit detail controllerOpens a specific Audit List, shows sampled documents, tracks review progress
quality.jsQualityServiceShared REST client for quality operations including audit list CRUD
quality-project-repository.jsQualityProjectRepositoryServiceRepository-scoped REST client for quality projects

Desktop Audit Wizard

The desktop client provides a four-step wizard for creating an Audit List.

File: SC/suredms-desktop-client-quality/src/main/java/com/sureclinical/suredms/ui/quality/wizard/audit/AuditWizardBuilder.java

StepClassDescription
1AuditWizardStep1SelectStudySelect the target archive (SureDrive or Study)
2AuditWizardStep2SelectContentBrowse and select the folders or categories to audit using GadgetDocNav
3AuditWizardStep3SelectSampleSizeChoose a sample percentage (0.1 % – 100 %). AuditWizardContext uses ThreadLocalRandom to pick the document subset
4AuditWizardStep4CreateAuditListProvide a name for the new Audit List

Data Model

ClassLocationDescription
AuditWizardContextsuredms-desktop-client-qualityWizard state: selected Archive, master document list, and the randomly-sampled filteredDocuments subset
AuditDatasuredms-desktop-client-qualityFinal audit result: auditDocuments, reviewedDocuments, discrepancies. Calculates qualityLevel as the ratio of documents with discrepancies
DocumentAuditReviewsuredms-desktop-client-qualityRecords which user reviewed a specific document within the audit
DocDiscrepancysuredms-desktop-client-qualityA quality finding linked to a document in the Audit List
SampleDocumentEntitySC/suredms-common/src/main/java/com/sureclinical/suredms/entity/SampleDocumentEntity.javaShared entity used for randomized audit sampling across both web and desktop

Audit List vs. Quality Queue

Quality QueueAudit List
ScopeAll documents with open discrepanciesRandomly sampled subset from a selected folder/category
CreationAutomatic (documents with issues flow in)Manually created via wizard
Sample logicN/AConfigurable percentage; random selection via ThreadLocalRandom
Review trackingPer-document discrepancy resolutionDocumentAuditReview per reviewer per document
Quality scoreNot calculated automaticallyqualityLevel calculated from discrepancy ratio

Help reference: Creating_an_Audit_List_in_SureDrive.html, Viewing_and_Managing_the_Audit_List_in_SureDrive.html