Built-in NodeProperties plugins

NameDescription

DefaultNodeProperties

Full node properties: path, permissions, lock info, current version, notes, categories, keywords, subscription status, PDF-conversion capability, and encryption/signature flags. The complete object used throughout the application UI.

This is the fallback plugin returned by NodePropertiesFactory when no other plugin is explicitly requested.

SimpleNodeProperties

A lighter subset of DefaultNodeProperties: core fields (path, dates, author, MIME type, and similar), keywords, and subscription status - but no permissions, notes, categories, lock info, or version, since those each require extra lookups.

SearchNodeProperties

Same fields as SimpleNodeProperties, plus the current version for documents. Used to shape search results without paying for permissions, notes, or categories on every hit.

DashboardNodeProperties

Minimal fields (uuid, path, parent, author, created date, MIME type) plus the current version. Used to build lightweight dashboard widgets (e.g. recent or most active documents) as cheaply as possible.

UuidNodeProperties

Only the node's uuid - the lightest possible result, for a Webservices call that only needs to know which nodes matched a query.

Unlike other plugin types, which is used is not a per-user or per-profile setting - NodePropertiesFactory#getNodeProperties(pluginName) looks a plugin up by its canonical class name (e.g. com.openkm.plugin.properties.UuidNodeProperties), falling back to DefaultNodeProperties if none matches. Which one applies to a given Webservices call is decided by that endpoint's own code, not by any user-facing configuration. See Creating your own NodeProperties plugin for the interface and a full example.

Table of contents [ Hide Show ]