CMIS Repository Searcher

Provides a user interface for building and executing a CMISQL Query.

Remarks

The CMIS Repository Searcher is an advanced UI component for constructing, editing, and executing CMISQL Queries against a CMIS Repository. It is designed to help users visually compose queries, review results, and inspect documents, all within a single, integrated interface.

Purpose and Functionality

• Query Authoring:
  Compose and edit CMISQL Queries using a code editor with syntax highlighting and intellisense.
• Property Grid Editing:
  Edit query parameters and structure using a categorized property grid, with real-time validation and contextual help.
• Query Execution:
  Run the current query and view results in a paged, tabular format.
  • Press F8 or click the {run} button to execute the query.
• Revision Toggle:
  Optionally include previous document revisions in search results using the {revision} toggle button (if supported by the repository).
• Result Review:
  Browse query results in a CMIS Tree Browser-style list.
  • Select a document to view its contents in the integrated document viewer.
• Status and Error Feedback:
  See real-time status and error messages as you edit and execute queries.

UI Components

• Toolbar:
  • {revision}: Toggle inclusion of previous revisions (if supported).
  • {run}: Execute the current query (F8).
  • Status and error labels display query execution feedback.
• Query Editor:
  • {Code Editor}: Edit the CMISQL Query as text, with syntax highlighting and completion.
  • {Property Grid}: Edit the query using a structured, categorized grid.
  • Changes in either editor are synchronized in real time.
• Result List:
  • {Result List}: Displays query results in a paged, tabular format (folders and documents).
  • Supports multi-select, sorting, and navigation.
• Document Viewer:
  • {Viewer}: Shows the currently selected document from the result list, with support for multiple file types.

Interactive Features

• Keyboard Shortcuts:
  • F8: Execute the current query.
  • Standard navigation and selection shortcuts in the result list and editors.
• Split Layout:
  • The interface is divided into resizable panels for query editing, results, and document viewing.
• Live Validation:
  • Errors in the query are shown immediately in the status bar.
  • The {run} button is enabled only when the query is valid.
• Paging:
  • Navigate through large result sets using the integrated pager in the result list.
• Document Preview:
  • Selecting a document in the result list loads its content in the viewer panel.

Example

The following diagram illustrates the layout of the CMIS Repository Searcher:

┌───────────────────────────────────────────────────────────────────────────────────────────┐
│ Toolbar: {revision} {run} {Status/Error}                                                  │
├───────────────────────────────────────────────────────────────────────────────────────────┤
│ ┌───────────── Query Editor ─────────────┐  ┌───────────── Document Viewer ─────────────┐ │
│ │ {Code Editor}                          │  │                                           │ │
│ │ {Property Grid}                        │  │                                           │ │
│ └────────────────────────────────────────┘  └───────────────────────────────────────────┘ │
├───────────────────────────────────────────────────────────────────────────────────────────┤
│ {Result List} (paged, tabular results)                                                    │
│                                                                                           │
│   | Object Name | Base Type | Object Type | Created By | Creation Date   |                │
│   |-------------|-----------|-------------|------------|-----------------|                │
│   | Folder1     | Folder    | FolderType  | admin      | 2024-01-01      |                │
│   | Document1   | Document  | DocType     | jsmith     | 2024-01-02      |                │
│   | ...         | ...       | ...         | ...        | ...             |                │
│                                                                                           │
└───────────────────────────────────────────────────────────────────────────────────────────┘

• {revision}: Toggle include previous revisions.
• {run}: Execute the query.
• {Code Editor}: Edit the CMISQL query as text.
• {Property Grid}: Edit the query using a property grid.
• {Result List}: View and select query results.
• Document Viewer: View the document selected in the result list.

Usage Tips

• Use the code editor for direct query editing, or the property grid for guided editing.
• Press F8 or click {run} to execute your query and refresh results.
• Use the {revision} toggle to include or exclude previous document versions (if available).
• Select a result to preview its content in the document viewer.
• Status and error messages help you quickly identify and resolve query issues.

The CMIS Repository Searcher streamlines the process of building, testing, and refining CMISQL Queries, making it easy to search, review, and analyze content in your connected repository.

Command Buttons

Child Controls

SELECT * FROM Document WHERE CreatedBy = 'admin'

| Object Name | Base Type | Object Type | Created By | Creation Date   |

-------------
-----------
-------------
------------
-----------------
 Document1   
 Document  
 DocType     
 jsmith     
 2024-01-02      

Used By

CMIS Repository - SearchCMIS Query Editor