Plugins
The application includes a plugins feature system that offers an easy way to customize and extend OpenKM functionalities. By default, the application includes a general-purpose plugins implementation; these can be disabled, changed, or increased in number depending on the type of plugin. For example, for an antivirus plugin it makes sense to disable it or replace it with another; in the case of a text extractor it makes sense to disable it or increase the number of available text extractors.
Plugins are shown in a table structure:
|
Plugin family name |
||
|
Name |
Class name |
Status |
Plugin families:
| Plugin family | Module | Description |
|---|---|---|
|
AI prompts |
AI |
AI-powered prompts that can be executed on documents, either based on plain text or on a plugin implementation. More information at: |
|
Antivirus |
Document |
Antivirus checker. Helps integrate with any command-line antivirus. More information at: |
|
Autocomplete form values |
Metadata |
Retrieves suggested metadata values from server-side logic to prefill a form field automatically. For example, extracting metadata from the document content using AI. More information at: |
|
Automation actions |
Automation |
Actions are used in the automation feature. More information at: |
|
Automation validations |
Automation |
Validations are used in the automation feature. More information at: |
|
Crontab |
Administration |
Time-based jobs that automate application maintenance or administration tasks. More information at: |
|
Dashboard charts |
Dashboard |
Adds a new analytics widget to the dashboard. More information at: |
|
Default form values |
Metadata |
Sets default values for metadata form fields when a document is created. Deprecated as of version 8.1.15 in favor of Form interceptors. More information at: |
|
Document converters |
Conversion |
The conversion service is used to convert documents to other formats. More information at: |
|
Field validators |
Metadata |
Validation based on server-side logic. Helps implement complex validation rules that are not covered by the default UI validators. More information at: |
|
Form interceptors |
Metadata |
Intercepts the add, set, and get operations of metadata properties to implement custom server-side logic. More information at: |
|
Metadata adapters |
UI |
Visualization logic for the metadata UI. More information at: |
|
Node paginators |
UI |
Customizes the file browser columns shown, including metadata columns. More information at: |
|
Option select values |
Metadata |
Retrieves select values from server-side logic. For example, it helps retrieve data from a third-party system. More information at: |
|
Principal adapters |
Authentication |
Authentication adapters are used to retrieve user and role information. For example, to connect to an LDAP server or an external database that stores users and roles. More information at: |
|
Report |
Report |
Generates custom reports to be rendered in the OpenKM UI. More information at: |
|
REST |
REST API |
Extends the REST API with custom endpoints. More information at: |
|
Search |
Search engine |
Customizes the search behavior, including which search fields are visible and how results are retrieved. More information at: |
|
Security access manager |
Authentication |
Checks a user's security access level for nodes. More information at: |
|
Suggestbox values |
Metadata |
Retrieves suggestion list values from server-side logic for a Suggestbox metadata field. More information at: |
|
Suggestion analyzers |
Metadata |
Analyzes text to suggest metadata field values. More information at: |
|
Template control parsers |
OCR Zone |
A document identification checkpoint used in the OCR Zone. More information at: |
|
Template parsers |
OCR Zone |
A data extraction parser used in the OCR Zone. More information at: |
|
Text extractor |
Search engine |
Text extractor based on document MIME type. More information at: |
|
Version number adapters |
Document |
Implements version number logic. More information at: |
