Help Content Summary and Gap Analysis
This document summarises every SureDrive-related topic found in the end-user Help system (Help/contents/Content_Repo/) and maps each topic to the current developer documentation. It then identifies gaps and missing sections in the technical documentation.
Part 1 — Help Content Summary
The Help system is authored in Adobe RoboHelp 2019 and stored at Help/toc/Default.toc. The SureDrive section lives under Mobile Web Client (NG Client) › SureDrive and SureDrive › User Guide - Desktop Client.
Overview
File: Overview-of-SureDrive_74350751.html
SureDrive is a document management repository for non-study-specific content (SOPs, training records, forms, templates) hosted on the SureClinical Certified Cloud. Key characteristics as described in Help:
- Free-form folder and document names; no eTMF schema required.
- Supports workflows, digital signing, visibility controls, reporting, export, collaboration, and annotation.
- Documents can be copied or bulk-moved from SureDrive to a Study archive (one-way only).
- Desktop client supports drag-and-drop of Windows/Mac folder hierarchies into SureDrive (as of V2.4).
- Licensing: One SureDrive per platform licence; up to 50 Adobe PDF digital-signature licences/year; 25 GB storage and 100 GB/month outbound data transfer per SureDrive.
Dashboards
Application Dashboard
File: Viewing_the_SureDrive_Application_Dashboard.htm
- Accessed by clicking SureDrive in the SureClinical Dashboard.
- Lists all SureDrive projects. Toggle between list view and image view.
- Sort by name or creation date. Filter by name or show deleted studies.
- Click + to open the New SureDrive Wizard.
Project Dashboard
File: Viewing_the_SureDrive_Project_Dashboard.htm
- Accessed by clicking a project in the Application Dashboard.
- Shows the Milestone Manager, document count, and top-level navigation to Documents, Acquire Queue, Quality Queue, Workflow, Reports, and Team menus.
Creating a SureDrive
File: Creating-a-SureDrive-in-the-Mobile-Web-Client_125042720.html (web) and Creating-a-New-SureDrive_73826455.html (desktop)
The New SureDrive Wizard collects:
- SureDrive Details — name, description, planned sites, start date, duration (months), end date (calculated), duplicate name policy (Allow Duplicates / Unique Case-Insensitive / Unique Case-Sensitive).
- Templates — select an existing project as a template, or upload from a local spreadsheet. Control which categories, properties, annotations, organizations, organization roles, persons, and person roles to import from the template.
- Content — review and confirm what will be copied from the selected template.
Desktop-specific: also supports opening a SureDrive from file and exporting a content model.
SureDrive Properties
File: Viewing-the-SureDrive-Properties_73859091.html
Accessed via the Project Dashboard overflow menu → SureDrive Properties. Displays:
- Organizations and persons assigned to the project.
- Study Properties — project size, planned sites, metadata terms, project profile. Contains checkboxes to enable Acquire Queue, Quality Queue, and QC OK features.
- Project Setup Checklist — user-defined checklist items.
- Repositories — external repositories linked to the project.
- Workflow Metrics — workflow type, phase, and planned duration. Add, edit, and delete metrics.
- Organization Roles, Organizations, and Persons tabs for team management.
Blinding Rules
File: Viewing-and-Managing-Blinding-Rules-in-SureDrive_654966840.html
Accessed via Project Dashboard overflow menu → Blinding Rules.
- Lists folders with user-access restrictions, modification dates, and the last modifying user.
- Filter by entity or username; hide inactive rules.
- Sort by entity, users, modified date, or modifying user.
- Actions per rule: Edit Rule, Delete Rule.
Content Model Editor
File: Working_with_the_Content_Model_Editor_in_SureDrive.htm
Accessed via Dashboard overflow menu → Content Model Editor. Used to define the folder structure visible in the Documents area.
Sub-topics:
- Creating Folders (
Creating-Folders_74022938.html) — add root and sub-folders. - Configuring Document Name Settings (
Configuring-Document-Name-Settings-for-a-SureDrive_654966801.html) — metadata fields appended as suffixes to document names. - Managing Metadata Terms (
Managing-Metadata-Terms-in-SureDrive_679116826.html) — define and manage reusable metadata terms. - Exporting a Content Model — export the folder/metadata structure.
Folder detail pane shows:
- Associated Metadata — add, edit, delete per-folder metadata terms; set visibility and value requirement.
- Document Name Settings — per-folder override of default name settings.
- Document Assignments — assign users to folders; reset assignees.
Desktop-specific: Editing SureDrive Content Model covers adding folders, metadata terms, annotation terms, reserving terms, duplication policy, and enabling the Acquire Queue from the desktop client.
Audit Trail
File: Viewing_the_SureDrive_Audit_Trail.htm
Accessed via Project Dashboard overflow menu → Audit Trail.
Shows: username, activity description, action type, date/time, client application, IP address.
- Click username link to view user profile.
- Click activity description to view detail (including related entities).
- Export to CSV (partial or all items).
- Filter by user name, user type, group, activity type, document, date, or IP address.
- Actions: Signing Audit Trail sub-view; Generate Report from audit trail.
Export, Delete, and Lock
| Topic | File | Entry Point |
|---|---|---|
| Exporting a SureDrive (web) | Exporting-a--SureDrive_655392787.html | Project Dashboard → Export SureDrive |
| Exporting a SureDrive (desktop) | Exporting-a-SureDrive_74252424.html | Desktop client |
| Deleting a SureDrive (web) | Deleting-a-SureDrive_655556609.html | Project Dashboard → Delete |
| Deleting or Locking (desktop) | Deleting-or-Locking-a-SureDrive_74055915.html | Desktop client |
Export options: select all documents / zip file, export format, optional 128-bit encryption with password, delivery via web link (email recipient).
Digital Signing
File: Digitally-Signing-Documents-in-SureDrive_665026692.html (parent)
Admins can sign documents without a workflow task. Three sub-flows:
| Sub-topic | File |
|---|---|
| Using eSigning Workflow | Using-eSigning-Workflow-in-SureDrive_665550904.html |
| eSigning Documents | eSigning-Documents-in-SureDrive_665354334.html |
| Signing Local Documents | Signing-Local-Documents-in-SureDrive_665092419.html |
Milestone Manager
File: Working-with-the-Milestone-Manager-in-SureDrive_74055732.html
The Document Milestone Manager tracks study progress against required documents. Visible in the Project Dashboard — shows milestone name, calendar duration, and completion status.
Sub-topics:
- Using Milestone Manager in the Dashboard (
Using-Milestone-Manager-in-the-SureDrive-Dashboard_73924659.html) - Viewing the Milestone Manager (
Viewing_the_Milestone_Manager_in_SureDrive.html) - Viewing and Managing Milestones (
Viewing-and-Managing-Milestones-in-SureDrive_73859134.html)- Editing Milestones and Adding Required Documents (
Editing-Milestones-in-SureDrive-and-Adding-Required-Documents_74022988.html) - Creating and Managing Required Documents in a Milestone
- Editing Milestones and Adding Required Documents (
- Uploading a Required Document (
Uploading-a-Required-Document-to-SureDrive_74055801.html)
Documents
File: Working-with-Documents-in-SureDrive_73891857.html
Accessed via SureDrive › Documents. Navigates the folder tree from the content model.
Sub-topics and operations documented in Help:
| Topic | File |
|---|---|
| Configuring Document Tree Settings | Configuring-SureDrive-Document-Tree-Settings_73891863.html |
| Using the SureDrive Annotation Tool | Using-the-SureDrive-Annotation-Tool_73793542.html |
| Uploading Documents | Uploading-Documents-to-SureDrive_74055721.html |
| Importing from Microsoft SharePoint | Importing-Documents-from-Microsoft-Sharepoint-to-SureDrive_353730634.html |
| Sharing Documents | Sharing-Documents-in-SureDrive_74088480.html |
| Downloading Documents | Downloading-Documents-from-SureDrive_74088477.html |
| Moving Documents to Archive | Moving-Documents-to-Archive-in-SureDrive_658931717.html |
| Deleting Documents | Deleting-Documents-from-SureDrive_74186765.html |
| Submitting Document Discrepancies | Submitting-Document-Discrepancies-in-SureDrive_73924656.html |
| Moving or Copying Documents | Moving-or-Copying-Documents-in-SureDrive_125009924.html |
| Working with Expired Documents | Working-with-Expired-Documents-in-SureDrive_125075652.html |
| Restoring or Permanently Deleting | Restoring-or-Permanently-Deleting-Documents-from-SureDrive_658079787.html |
| Using PDF Tools | Using_PDF_Tools_in_SureDrive.htm |
| Viewing Document Details | Viewing_Document_Details_in_SureDrive.htm |
| Managing Attachments | Managing-Attachments-in-SureDrive_658341895.html |
| Viewing Document History | Viewing-the-Document-History-in-SureDrive_658866177.html |
| Configuring Document Visibility | Configuring-Visibility-of-Documents-in-SureDrive_656638214.html |
| Configuring Content Visibility | Configuring-Content-Visibility-in-SureDrive_656572733.html |
| Managing Documents (overview) | Managing-Documents-in-SureDrive_73859099.html |
Acquire Queue
File: Managing-Documents-in-SureDrive-Acquire-Queue_73859138.html
Accessed via SureDrive › Acquire Queue (must be enabled in Properties first).
- Shows all uploaded documents and documents for which a workflow has been initiated.
- Columns: document name, organization, status, date of upload.
- Document status Complete = no system metadata errors.
- Document detail pane: preview, metadata editor (edit and save).
- Actions per document: Document Details, Open Document, Move to Archive, workflow initiation.
Quality Queue
File: Managing-Documents-in-SureDrive-Quality-Queue_73859147.html
Accessed via SureDrive › Quality Queue.
- Shows all documents with at least one open discrepancy.
- Detail pane shows: document preview, metadata editor.
- Discrepancy detail: assigned user, reporting date, reporter, description.
- Actions: Open Document, Delete Document, Edit Metadata, Close Discrepancy, Assign Discrepancy.
Sub-topics:
- Creating an Audit List (
Creating_an_Audit_List_in_SureDrive.html) - Viewing and Managing the Audit List (
Viewing_and_Managing_the_Audit_List_in_SureDrive.html)
Workflows
File: Working-with-Workflows-in-SureDrive_74154018.html
Accessed via SureDrive › Workflow. Displays the Workflow Dashboard with initiated workflows.
Workflow types documented:
| Workflow | File |
|---|---|
| Completing Forms | Completing-Forms-Workflow-in-SureDrive_678199303.html |
| Completing, Reviewing, and Signing Forms | Completing-Reviewing-and-Signing-Forms-Workflow-in-SureDrive_174260225.html |
| Reviewing Documents | Reviewing-Documents-Workflow-in-SureDrive_73891926.html |
| Reviewing and Signing Documents | Reviewing-and-Signing-Documents-Workflow-in-SureDrive_73859221.html |
| Reviewing Forms | Reviewing-Forms-Workflow-in-SureDrive_74088553.html |
| Reviewing and Signing Forms | Reviewing-and-Signing-Forms-Workflow-in-SureDrive_73924684.html |
| Signing Documents | Signing-Documents-Workflow-in-SureDrive_73793570.html |
| Signing Forms | Signing-Forms-Workflow-in-SureDrive_73891929.html |
| Uploading Documents | Uploading-Documents-Workflow-in-SureDrive_73891932.html |
| Uploading and Signing Documents | Uploading-and-Signing-Documents-Workflow-in-SureDrive_73859259.html |
Dashboard actions: toggle single/multi-select, Generate Report, manage Workflow Categories (rename, delete, detach processes).
Reports
File: Working-with-Reports-in-SureDrive_666730586.html
Accessed via SureDrive › Reports.
Sub-topics:
- Creating Reports using the Report Wizard or User Templates (
Creating_Reports_using_the_Report_Wizard_or_User_Templates.htm) - Subscribing to Reports (
Subscribing_to_Reports_in_SureDrive.htm) - Viewing Reports (
Viewing_Reports_in_SureDrive.htm) - Managing Reports (
Managing_Reports_in_SureDrive.htm)
Team Menu
File: Using-the-Team-menu-in-SureDrive_667353097.html
Accessed via SureDrive › Team. Shows persons and organizations belonging to the study with an optional map view.
- Filter by person name, organization name, person role, or country.
- Toggle map-based geographic filtering, show study subjects, show staff members only.
- Multi-select mode.
Sub-topics:
| Topic | File |
|---|---|
| Adding an Organization | Adding-an-Organization-to-SureDrive_667385936.html |
| Adding a Person | Adding-a-Person-to-SureDrive_667648183.html |
| Editing and Deleting Organizations | Editing-and-Deleting-Organizations-in-SureDrive_667386035.html |
| Editing and Deleting Persons | Editing-and-Deleting-Persons-in-SureDrive_668532747.html |
| Managing Organizations | Managing_Organizations_in_SureDrive.htm |
| Managing Study Roles | Managing-Study-Roles-in-SureDrive_675184644.html |
| Creating and Managing Team Groups | Creating_and_Managing_Team_Groups_in_SureDrive.htm |
| Importing Team from File | Importing-Team-to-SureDrive_670105653.html |
| Exporting Team to Excel | Exporting-the-team-in-SureDrive-to-an-Excel-file_670236684.html |
| Exporting Team to CSV | Exporting-the-Team-in-SureDrive-to-a-CSV-file_675053597.html |
Bookmarks
File: Viewing-and-Managing-Bookmarks-in-SureDrive_74154014.html
Accessed from the SureDrive navigation. Lets users bookmark frequently accessed folders or documents for quick access.
Keyboard Navigation
File: Keyboard-Navigation-in-SureDrive_74055872.html
Supported in: Documents, Bookmarks, Acquire Queue, Quality Queue.
| Key | Action |
|---|---|
| Arrow keys | Select first item if no selection; navigate up, down, or between pages |
Enter | Open selected item |
Backspace | Navigate to parent directory |
Escape | Clear selection |
SureConnect (Administration)
File: Working_with_the_SureInterface.htm
Accessed via Administration › SureConnect.
- Integrators and Connectors — lists connectors and integrators that can be configured and connected.
- Single Sign-On — enable SSO authentication for required applications.
- Contact SureClinical support for advanced configuration.
Part 2 — Gap Analysis: Technical Documentation vs. Help Content
Current Developer Docs at a Glance
| Doc | File |
|---|---|
| System Overview | system-overview.md |
| Build and Module Architecture | build-and-module-architecture.md |
| Shared Domain and Utilities | shared-domain-and-utilities.md |
| Archive Parsing Pipeline | archive-parsing-pipeline.md |
| Excel and Template Importers | excel-and-template-importers.md |
| OCR and Document Intelligence | ocr-and-document-intelligence.md |
| Web Client and Web Startup | web-client-and-web-startup.md |
| Drive Wizard and New SureDrive Creation | drive-wizard-and-new-suredrive-creation.md |
| Quality Review and Discrepancy Management | quality-review-and-discrepancy-management.md |
| Digital Signing and E-Sign | digital-signing-and-e-sign.md |
| Web Service API | web-service-api.md |
| Help Summary and Outline Review | help-summary-and-outline-review.md |
| Workflow Platform | workflow-platform.md |
| Desktop Connector and Runtime | desktop-connector-and-runtime.md |
| Desktop Client Data Layer | desktop-client-data-layer.md |
| Connectors and External Integrations | connectors.md |
Gaps and Missing Sections
1. Application Dashboard and Project Dashboard
Help topics covered: Application Dashboard, Project Dashboard.
Current doc coverage: The drive wizard doc covers creation. No doc traces the dashboard route, its Angular state, the project list component, filtering, or the dashboard data service.
Recommended: Add a Dashboards section to the existing drive-wizard-and-new-suredrive-creation.md, or create a dedicated dashboards.md covering app.network.study.browse state, the project list controller, and dashboard route registration.
2. SureDrive Properties Page
Help topics covered: Properties, Project Setup Checklist, Repositories tab, Workflow Metrics, Org Roles, Organizations, Persons.
Current doc coverage: Not documented. The properties page is a central hub linking to blinding rules, queue toggles, workflow metrics, and external repositories.
Recommended: Add a SureDrive Properties section (or new suredrive-properties.md) covering the properties route, StudyPropertiesController, queue-enable flags, and the Repositories sub-tab that links to the connectors layer.
3. Blinding Rules
Help topics covered: Viewing-and-Managing-Blinding-Rules-in-SureDrive_654966840.html — full CRUD on folder-level access rules.
Current doc coverage: Not documented. The blinding rule engine controls which users can see which content types.
Recommended: Add a Blinding Rules section to a security or visibility doc, documenting the controller, data model, and how rules interact with document visibility.
4. Content Model Editor
Help topics covered: Full CME topic — folders, metadata terms, document name settings, document assignments, annotation terms, duplication policy, acquire queue enablement.
Current doc coverage: The drive wizard doc touches template selection. There is no doc tracing the CME Angular component, folder CRUD service, or metadata term storage.
Recommended: New content-model-editor.md covering CME route, folder/metadata term entities, ContentModelService, and desktop vs. web differences.
5. Audit Trail
Help topics covered: Full audit trail with filter, export (CSV), signing audit trail sub-view.
Current doc coverage: Not documented as a standalone feature. Audit trail is mentioned in passing in quality and signing docs but not traced to its route, controller, or data model.
Recommended: Add an Audit Trail section (or new audit-trail.md) covering the audit trail Angular state, AuditTrailController, filter parameters, CSV export endpoint, and the relationship between the standard and signing audit trails.
6. Milestone Manager
Help topics covered: Milestone Manager overview, creating/editing milestones, required documents, uploading required documents.
Current doc coverage: Not documented. Milestones are a distinct project-tracking subsystem with their own data model and UI flow.
Recommended: New milestone-manager.md tracing the Milestone Manager Angular component, milestone entity model, required document model, and upload flow.
7. Documents — Full Feature Coverage
Help topics covered: 19 sub-topics spanning upload, download, share, annotation, PDF tools, move-to-archive, visibility, document history, attachments, expired documents, restore, discrepancy submission.
Current doc coverage: The quality-review doc covers discrepancies. OCR doc covers document intelligence. No single doc traces the document browser route, upload service, document history, attachment model, or PDF tools endpoint.
Recommended: New document-management.md covering the document navigator Angular state, upload service, document metadata model, document history, attachment storage, PDF tool integration, and visibility configuration.
8. Acquire Queue — Technical Detail
Help topics covered: Full queue description, document status meanings, metadata editor, Move to Archive action.
Current doc coverage: Quality review doc references the acquire queue at a high level but does not trace the Angular state, queue service, or the Move to Archive backend endpoint.
Recommended: Expand quality-review-and-discrepancy-management.md with an Acquire Queue technical section, or create acquire-quality-queues.md covering both queues together.
9. Workflows — Individual Workflow Types
Help topics covered: 10 distinct workflow types (forms, documents, signing combinations).
Current doc coverage: workflow-platform.md covers the platform-level wizard and task handling. Individual workflow type implementations (signing forms, uploading and signing, etc.) are not traced to their specific process definitions or workflow templates.
Recommended: Add a Workflow Types section in workflow-platform.md listing each type, the corresponding process template, and the signing/review steps specific to SureDrive.
10. Reports
Help topics covered: Report Wizard, user templates, subscriptions, viewing, managing.
Current doc coverage: Reporting is referenced in the web service API and quality docs, but no doc traces the report wizard route, ReportWizardController, subscription model, or report output format.
Recommended: New reports.md covering reports route registration, the wizard controller, subscription entity, and report generation endpoints in the web service.
11. Team Menu
Help topics covered: Team map, person/organization CRUD, study roles, team groups, team import/export.
Current doc coverage: Not documented. The team menu is a full subsystem with import/export, role management, and geographic filtering.
Recommended: New team-management.md covering the Team route, TeamController, organization and person entity models, role assignment, team import (Excel/CSV), and team export.
12. Bookmarks
Help topics covered: Viewing and managing bookmarks.
Current doc coverage: Not documented.
Recommended: Add a Bookmarks note to document-management.md or web-client-and-web-startup.md covering the bookmark service and storage.
13. Keyboard Navigation
Help topics covered: Full keyboard shortcut map for Documents, Bookmarks, Acquire Queue, Quality Queue.
Current doc coverage: Not documented.
Recommended: Add a Keyboard Navigation appendix to an appropriate doc (e.g., document-management.md) listing the supported keys and the Angular directive or event handler that implements them.
14. SureConnect Administration UI
Help topics covered: Administration › SureConnect — integrators, connectors, SSO configuration.
Current doc coverage: connectors.md covers the technical connector layer well. The administration UI entry point (Working_with_the_SureInterface.htm) is not cited.
Recommended: Add an Administration Entry Point section to connectors.md citing the Administration › SureConnect route and the Help file as the end-user reference.
15. Desktop Client — SureDrive-Specific Flows
Help topics covered: Opening a SureDrive from file, exporting a SureDrive (desktop), editing content model (desktop adds annotation terms, reservation, duplication policy).
Current doc coverage: desktop-connector-and-runtime.md covers the runtime layer. Desktop-specific SureDrive content model editing and file-open flows are not documented.
Recommended: Add a Desktop-Specific SureDrive Operations section to desktop-connector-and-runtime.md covering file-open flow, desktop export, and desktop CME capabilities not available in the web client.
Priority Ranking
| Priority | Missing Section | Suggested Action |
|---|---|---|
| High | Document Management (upload, history, visibility, attachments, PDF tools) | New document-management.md |
| High | Content Model Editor (folders, metadata terms, document names) | New content-model-editor.md |
| High | SureDrive Properties page | New section or suredrive-properties.md |
| High | Reports subsystem | New reports.md |
| High | Team Management | New team-management.md |
| Medium | Milestone Manager | New milestone-manager.md |
| Medium | Audit Trail (route + controller + export) | New audit-trail.md |
| Medium | Blinding Rules | New section in a security/visibility doc |
| Medium | Acquire Queue technical detail | Expand quality-review-and-discrepancy-management.md |
| Medium | Workflow Types (individual process definitions) | Expand workflow-platform.md |
| Low | Bookmarks | Add to document-management.md |
| Low | Keyboard Navigation | Add to document-management.md |
| Low | Desktop-Specific SureDrive Flows | Expand desktop-connector-and-runtime.md |
| Low | SureConnect Admin UI entry point | Add note to connectors.md |
| Low | Dashboard routes and controllers | Add to drive-wizard-and-new-suredrive-creation.md |