Skip to main content

SureDrive Properties

This page documents the SureDrive Properties page — the central configuration hub for a SureDrive project. It covers the Angular route and controller, queue-enable flags, external repository integration, blinding rules, and workflow metrics.


Overview

The Properties page is accessed from the Project Dashboard overflow menu → SureDrive Properties. It is the administrative entry point for configuring all project-level settings: enabling document queues, linking external repositories (SharePoint, Google Drive), managing the Project Setup Checklist, editing workflow metrics, and managing organisation roles, organisations, and persons.

Key owning modules:

  • UI: suredms-web-clientnetwork/study/properties/ and network/study/blinding/
  • Domain model: suredms-common — project/archive entity model

Angular Route

File: SC/suredms-web-client/src/main/webapp/app/js/state/app-states-management.js

State: app.network.management.browse.properties


Controller

File: SC/suredms-web-client/src/main/webapp/app/js/network/study/properties/study-properties.js

Controller: StudyPropertiesController

This controller owns all property panel tabs and sub-sections. It loads the project's current configuration on activation and saves changes back via the backend connection service.


Properties Sections

Study Properties

The core tab displays project metadata and toggles for optional document queue features:

SettingDescription
Project sizeEstimated volume of documents for the project
Planned sitesNumber of clinical sites participating
Metadata termsProject-level metadata term definitions
Project profileCustom profile fields
Acquire Queue toggleEnables the Acquire Queue for this SureDrive; documents uploaded by external users land here before moving to the main archive
Quality Queue toggleEnables the Quality Queue; documents with open discrepancies are tracked here
QC OK toggleEnables the QC OK workflow step within quality review

The Acquire Queue and Quality Queue toggles are managed within StudyPropertiesController and stored as flags on the archive entity. Both queues are disabled by default and must be explicitly enabled per SureDrive.


Project Setup Checklist

A user-defined checklist of setup tasks. Items can be added, marked complete, and deleted. This is a lightweight tracking mechanism for administrators during SureDrive configuration.


Repositories

Files: studyProperties.externalSources.sharepoint and studyProperties.externalSources.googleDrive within study-properties.js

Links external document repositories to the SureDrive project. Supported sources:

RepositoryIntegration
Microsoft SharePointConfigured with SharePoint site URL, credentials, and library selection; documents can be imported directly from SharePoint into SureDrive (see Connectors)
Google DriveLinked via OAuth; allows importing Google Drive files as SureDrive documents

Workflow Metrics

Navigates to the workflow metrics sub-state via $state.go("app.network.study.browse.workflow-metrics", ...). Workflow metrics track planned duration and completion phases for each workflow type configured on the project. Fields per metric:

  • Workflow type
  • Phase
  • Planned duration

Admins can add, edit, and delete metrics within this sub-view.


Organisation Roles, Organisations, and Persons Tabs

Three additional tabs provide team configuration access from within Properties. These tabs overlap with the Team menu (see Team Management) — they provide direct access to the same underlying data without leaving the Properties page.


Blinding Rules

File: SC/suredms-web-client/src/main/webapp/app/js/network/study/blinding/study-blinding-rules.js

Controller: StudyBlindingRulesController

Accessed via the Project Dashboard overflow menu → Blinding Rules. Blinding rules layer fine-grained access restrictions on top of system roles — a user's role may grant general read access, but a blinding rule can further restrict which content types or folders they see within a specific SureDrive.

Each blinding rule is modelled as an ExpandedArchiveAclRule (see Role-Based Access Control) and carries:

DimensionDescription
Target archiveThe specific SureDrive the rule applies to
UsersSet of user IDs covered by this rule
Content typesWhich content type folders are visible (hidden) or editable (writable)
OrganisationsWhich organisations are visible or editable
DocumentsWhich individual documents are hidden

The rules list view shows: entity (folder/document), affected users, modification date, and the last modifying user. Filter by entity or username; toggle inactive rules. Per-rule actions: Edit Rule, Delete Rule.

At the data layer, blinding rules are stored and evaluated via ContentVisibilityService (see Document Management).


Help Reference

TopicFile
SureDrive PropertiesHelp/contents/Content_Repo/Viewing-the-SureDrive-Properties_73859091.html
Blinding RulesHelp/contents/Content_Repo/Viewing-and-Managing-Blinding-Rules-in-SureDrive_654966840.html

Key Source Files Reference

FilePurpose
SC/suredms-web-client/src/main/webapp/app/js/state/app-states-management.jsRoute definition for app.network.management.browse.properties
SC/suredms-web-client/src/main/webapp/app/js/network/study/properties/study-properties.jsStudyPropertiesController — all property tab logic, queue toggles, repository config
SC/suredms-web-client/src/main/webapp/app/js/network/study/blinding/study-blinding-rules.jsStudyBlindingRulesController — blinding rule CRUD
SC/suredms-common/src/main/java/com/sureclinical/suredms/common/objects/ExpandedArchiveAclRule.javaACL rule data model used by blinding rules