Database Views
Database views for the ADM (APEX Document Management) system, in two groups: adm_report_* administrative reporting views, which apply no user-access filter, and adm_my_* application integration views, which return only what the ADM user established in the current session may see.
Which one do I want?
Section titled “Which one do I want?”The prefix is the answer, and it is the only thing on this page worth memorising.
| If you are… | Use | Because |
|---|---|---|
| building a report, region or REST feed for your users | adm_my_*_v | It returns only what the ADM user in the current session may see. |
| writing an administrative report, a dashboard or a data audit | adm_report_*_v | It returns every row in the instance, whoever is asking. |
Naming Convention
Section titled “Naming Convention”Two prefixes, and the prefix is what tells you the access scope. adm_report_v are administrative reporting views: they apply no user-access filter and return every row in the instance. adm_my_v are application integration views: they take their identity from the ADM context and return only what that user may see. Both end in _v.
Application integration views (6)
Section titled “Application integration views (6)”Session scoped. Identity comes from the ADM context - see the integration guide for how to establish one and for worked examples.
| View Name | Category | Description |
|---|---|---|
| adm_my_documents_v | Documents | One row per active document the ADM user established in the current session may see, with the metadata of its current version. |
| adm_my_folders_v | Folders | One row per folder the ADM user established in the current session may see. |
| adm_my_document_tags_v | Tags | One row per tag applied to a document the ADM user established in the current session may see. |
| adm_my_document_versions_v | Versions | One row per version of a document the ADM user established in the current session may see, metadata only. |
| adm_my_document_annotations_v | Annotations | One row per annotation on a document the ADM user established in the current session may see. |
| adm_my_folder_annotations_v | Annotations | One row per annotation on a folder the ADM user established in the current session may see. |
Administrative reporting views (12)
Section titled “Administrative reporting views (12)”Unfiltered. 12 views across 11 categories for system analysis and reporting.
| View Name | Category | Description |
|---|---|---|
| adm_report_audit_log_v | Audit | Audit log reporting view with categorized actions, time-based analysis fields, and asset information for security monitoring and usage analytics. |
| adm_report_documents_v | Documents | Document reporting view showing metadata, ownership, status and file information. |
| adm_report_document_shares_v | Sharing | Document sharing reporting view showing recipient details, permission levels, document information, and share status for access management analysis. |
| adm_report_document_versions_v | Versions | Document version reporting view showing version history, file sizes, change tracking, and categorization for document lifecycle management and storage analysis. |
| adm_report_folders_v | Folders | Folder reporting view showing hierarchy, content counts and status information. |
| adm_report_folder_shares_v | Sharing | Folder sharing reporting view showing recipient details, permission levels, folder content statistics, and share status for access management analysis. |
| adm_report_groups_v | Groups | Group reporting view showing member counts, ownership statistics, sharing information, and group folder details for group management and analysis. |
| adm_report_job_status_v | Jobs | Job monitoring view showing job execution status, error tracking, recent activity, and log summaries for system administration and troubleshooting. |
| adm_report_file_type_analysis_v | Storage | Storage analysis view categorizing documents by MIME type, showing storage consumption, file counts, and size statistics for capacity planning and cleanup activities. |
| adm_report_system_overview_v | System | System-wide metrics and statistics providing a high-level overview of the document management system including user activity, document counts, storage usage, and sharing statistics. |
| adm_report_tags_v | Tags | Tag reporting view showing usage statistics, tag group memberships, and categorization for tag management and analysis. |
| adm_report_users_v | Users | User reporting view showing role information, activity status, ownership counts, and sharing statistics for user management and analysis. |
Design Principles
Section titled “Design Principles”- The prefix states the access scope: adm_report_ is unfiltered, adm_my_ is session scoped
- Self-documenting through table and column comments
- Stable IDs anchor relationships; names and paths are conveniences that change
- Raw values, formatted by the caller
- One child relationship per view, so nothing multiplies the document rows
- Metadata only - no file content, no credentials, no share or embed tokens
Common Patterns
Section titled “Common Patterns”- Status categorization (ACTIVE, INACTIVE, etc.)
- Count aggregations for relationships
- Time-based analysis fields
- Size calculations in multiple units (bytes, KB, MB)
- Percentage calculations for ratios