DCTM Notebook

A VS Code notebook interface for DQL queries with REST and DFC connectivity to OpenText Documentum repositories.

Installation

From VS Code Marketplace

Open VS Code
Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
Search for "DCTM Notebook"
Click Install

From VSIX

Download the .vsix file from the releases page
In VS Code, go to Extensions
Click the ... menu and select "Install from VSIX..."
Select the downloaded file

Features

DQL Editor

Syntax Highlighting: Full DQL syntax highlighting for .dql files
Semantic Token Support: Dynamic highlighting of repository type names
Execute Queries: Run DQL queries directly from the editor (Ctrl+Shift+E / Cmd+Shift+E)

Repository Browser

Object Browser: Navigate repository folders and objects
Type Browser: Explore type hierarchy and attributes
Properties View: View object properties and metadata

API Method Support

Autocomplete: When typing API method names in DQL files or .api files, autocomplete suggestions appear with method signatures
Hover Documentation: Hover over a method name (e.g., save, checkout, query) to see the full dmAPI signature and description

Supported method categories:

dmAPIExec - Commands that modify state (save, destroy, link, etc.)
dmAPIGet - Commands that return values (connect, query, create, etc.)
dmAPISet - Commands that set values (set, append, insert, etc.)

API Execution Panel

Method Browser: Browse and search available DFC API methods
Execute Methods: Execute API methods on repository objects
Quick Actions: Checkout, Checkin, Cancel Checkout from context menus

Using the API Panel

The API Panel allows you to execute DFC methods on repository objects interactively.

Opening the API Panel

From Command Palette: Press Ctrl+Shift+P (or Cmd+Shift+P on Mac), type "Documentum: Open API Panel"
From Object Browser: Right-click any object and select "Execute API Method" - the object ID is pre-filled

Executing Methods

Enter Object ID (optional): If you're executing methods on a specific object, enter its r_object_id. Leave empty for session-level operations like getSessionId.
Select a Method:
- Browse methods by category (Object Operations, Query, Version Control, etc.)
- Or type in the search box to find methods by name or description
Fill Parameters: If the method requires parameters, input fields appear automatically. Required parameters are marked with *.
Click Execute: Results appear in the Result panel below with execution time.

Example Workflows

Check Out a Document

In Object Browser, right-click a document
Select "Checkout" from the context menu
Or use API Panel:
- Enter the document's r_object_id
- Select checkout method
- Click Execute

Query Object Properties

Open API Panel
Enter object ID (e.g., 0900000180001234)
Select getString method
Enter attribute name (e.g., object_name)
Click Execute to see the value

Get Session Information

Open API Panel
Leave Object ID empty
Select getSessionId method
Click Execute to see current session ID

Available Method Categories

Category	Description	Example Methods
Object Operations	Basic object manipulation	`save`, `destroy`, `fetch`, `revert`
Query	Execute queries and get values	`query`, `next`, `getString`, `getInt`
Version Control	Document versioning	`checkout`, `checkin`, `cancelCheckout`
Links & Relations	Folder and relation management	`link`, `unlink`, `getPath`
Attributes	Get/set object attributes	`get`, `set`, `append`, `remove`

Keyboard Shortcuts

Action	Shortcut
Execute DQL Query	`Ctrl+Shift+E` / `Cmd+Shift+E`

Requirements

VS Code 1.85.0 or higher
DFC Bridge service for DFC connectivity (optional for REST-only connections)

DQL Syntax Highlighting

Token Types

DQL syntax highlighting uses standard TextMate scopes that work with any VS Code colour theme:

Element	Scope	Description
Keywords	`keyword.control.dql`	SELECT, FROM, WHERE, etc.
DML Keywords	`keyword.other.dml.dql`	INSERT, UPDATE, DELETE, etc.
Operators	`keyword.operator.*.dql`	=, <>, +, -, etc.
Strings	`string.quoted.*.dql`	'text' or "text"
Numbers	`constant.numeric.dql`	123, 45.67
Comments	`comment.*.dql`	-- or /* */
Functions	`support.function.*.dql`	COUNT(), UPPER(), etc.
Types	`storage.type.*.dql`	dm_document, dm_folder, etc.
Constants	`constant.language.*.dql`	TRUE, FALSE, NULL
Hints	`keyword.other.hint.dql`	/+ SQL_DEF_RESULT_SET /

Customising Colours

You can customise DQL syntax colours in your VS Code settings.json using editor.tokenColorCustomizations:

{
  "editor.tokenColorCustomizations": {
    "textMateRules": [
      {
        "scope": "keyword.control.dql",
        "settings": {
          "foreground": "#0077CC",
          "fontStyle": "bold"
        }
      },
      {
        "scope": "storage.type.dm.dql",
        "settings": {
          "foreground": "#E67700"
        }
      },
      {
        "scope": "support.function",
        "settings": {
          "foreground": "#8250DF"
        }
      }
    ]
  }
}

Colourblind-Safe Palettes

The default theme colours depend on your VS Code colour theme. For users who need accessible colour schemes, here are recommended palettes that avoid red/green distinctions:

Blue-Orange Palette (Deuteranopia/Protanopia friendly)

{
  "editor.tokenColorCustomizations": {
    "textMateRules": [
      {
        "scope": ["keyword.control.dql", "keyword.other.dml.dql"],
        "settings": { "foreground": "#0077CC", "fontStyle": "bold" }
      },
      {
        "scope": "string.quoted",
        "settings": { "foreground": "#E67700" }
      },
      {
        "scope": ["storage.type.dm.dql", "storage.type.dmi.dql"],
        "settings": { "foreground": "#6E5494", "fontStyle": "italic" }
      },
      {
        "scope": "support.function",
        "settings": { "foreground": "#0550AE" }
      },
      {
        "scope": "comment",
        "settings": { "foreground": "#656D76", "fontStyle": "italic" }
      },
      {
        "scope": "constant.numeric",
        "settings": { "foreground": "#953800" }
      },
      {
        "scope": "constant.language",
        "settings": { "foreground": "#0077CC", "fontStyle": "bold" }
      }
    ]
  }
}

High Contrast Palette (Uses bold/italic for additional distinction)

{
  "editor.tokenColorCustomizations": {
    "textMateRules": [
      {
        "scope": ["keyword.control.dql", "keyword.other.dml.dql"],
        "settings": { "foreground": "#005A9E", "fontStyle": "bold" }
      },
      {
        "scope": "string.quoted",
        "settings": { "foreground": "#B35900", "fontStyle": "" }
      },
      {
        "scope": ["storage.type.dm.dql", "storage.type.dmi.dql"],
        "settings": { "foreground": "#5C2D91", "fontStyle": "italic" }
      },
      {
        "scope": "support.function",
        "settings": { "foreground": "#005A9E", "fontStyle": "underline" }
      },
      {
        "scope": "comment",
        "settings": { "foreground": "#5A5A5A", "fontStyle": "italic" }
      },
      {
        "scope": "constant",
        "settings": { "foreground": "#7B3F00", "fontStyle": "bold" }
      }
    ]
  }
}

Monochrome with Styles (Maximum accessibility)

For users who prefer minimal colour variation, this palette uses font styles as the primary differentiator:

{
  "editor.tokenColorCustomizations": {
    "textMateRules": [
      {
        "scope": ["keyword.control.dql", "keyword.other.dml.dql"],
        "settings": { "foreground": "#1F2328", "fontStyle": "bold" }
      },
      {
        "scope": "string.quoted",
        "settings": { "foreground": "#1F2328", "fontStyle": "" }
      },
      {
        "scope": ["storage.type.dm.dql", "storage.type.dmi.dql"],
        "settings": { "foreground": "#1F2328", "fontStyle": "italic underline" }
      },
      {
        "scope": "support.function",
        "settings": { "foreground": "#1F2328", "fontStyle": "italic" }
      },
      {
        "scope": "comment",
        "settings": { "foreground": "#656D76", "fontStyle": "italic" }
      },
      {
        "scope": "constant",
        "settings": { "foreground": "#1F2328", "fontStyle": "bold italic" }
      }
    ]
  }
}

Extension Settings

This extension contributes the following settings:

documentum.connections: List of Documentum connection configurations
documentum.defaultConnection: Name of the default connection
documentum.dfc.profiles: DFC profile configurations
documentum.bridge.port: Port for DFC Bridge microservice (default: 9876)
documentum.bridge.autoStart: Automatically start DFC Bridge when connecting

Sample Files

The samples/ directory contains example DQL files to help you get started:

basic-queries.dql - Common queries: listing cabinets, searching documents, counting by format
advanced-queries.dql - Complex queries: full-text search, joins, version history, ACLs

Open these files to see syntax highlighting in action and use them as templates for your own queries.

Data Files

The extension includes reference data for API methods:

data/api-methods.json: Comprehensive reference for ~140 Documentum Server API methods

To add or modify API method documentation, edit the JSON file following the existing format.

Development

# Install dependencies
npm install

# Compile
npm run compile

# Run tests
npm test

# Watch for changes
npm run watch

License

MIT License - see LICENSE file for details.

DCTM Notebook

Spire Professional Services Ltd

DCTM Notebook

Installation

From VS Code Marketplace

From VSIX

Features

DQL Editor

Repository Browser

API Method Support

API Execution Panel

Using the API Panel

Opening the API Panel

Executing Methods

Example Workflows

Check Out a Document

Query Object Properties

Get Session Information

Available Method Categories

Keyboard Shortcuts

Requirements

DQL Syntax Highlighting

Token Types

Customising Colours

Colourblind-Safe Palettes

Blue-Orange Palette (Deuteranopia/Protanopia friendly)

High Contrast Palette (Uses bold/italic for additional distinction)

Monochrome with Styles (Maximum accessibility)

Extension Settings

Sample Files

Data Files

Development

License