Plugins
The application includes a plugin feature system that offers an easy way to customize and extend OpenKM functionality. By default, the application includes a general-purpose plugin 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: - AI Prompt - Creating your own AI prompt plugin |
| Antivirus | Document | Antivirus checker. It helps integrate with any command-line antivirus. More information at: - Creating your own Antivirus Analyzer plugin |
| 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: - Metadata - Creating your own Autocomplete Form plugin |
| Automation actions | Automation | Actions are used in the automation feature. More information at: - Automation - Creating your own Automation Action |
| Automation validations | Automation | Validations are used in the automation feature. More information at: - Automation - Creating your own Automation Validation |
| Crontab | Administration | Time-based jobs that automate application maintenance or administration tasks. More information at: - Crontab - Creating your own Crontab plugin |
| Dashboard charts | Dashboard | Adds a new analytics widget to the dashboard. More information at: - Creating your own Dashboard Chart plugin |
| 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: - Metadata - Creating your own Default Form Values |
| Document converters | Conversion | The conversion service is used to convert documents to other formats. More information at: - Creating your own Document Converter |
| Field validators | Metadata | Validation is based on server-side logic. It helps implement complex validation rules that are not covered by the default UI validators. More information at: - Metadata - Metadata Validator element - Creating your own Form Validator plugin |
| Form interceptors | Metadata | Intercepts the add, set, and get operations of metadata properties to implement custom server-side logic. More information at: - Metadata - Creating your own FormInterceptor plugin |
| Metadata adapters | UI | Visualization logic for the metadata UI. More information at: - Creating your own Stack Metadata Adapter (deprecated) |
| Node paginators | UI | Customizes the file browser columns shown, including metadata columns. More information at: - Creating your own NodePaginator plugin |
| 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: - Metadata - Metadata Select field - Creating your own Option Select Values plugin |
| 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: - Creating your own Principal Adapter |
| Report | Report | Generates custom reports to be rendered in the OpenKM UI. More information at: - Reports - Creating your own Report plugin |
| REST | REST API | Extends the REST API with custom endpoints. More information at: - RESTful - Creating your own REST Plugin (extending the REST API) |
| Search | Search engine | Customizes the search behavior, including which search fields are visible and how results are retrieved. More information at: - Creating your own Search plugin |
| Security access manager | Authentication | Checks a user’s security access level for nodes. More information at: - Creating your own security access manager |
| Suggestbox values | Metadata | Retrieves suggestion list values from server-side logic for a Suggestbox metadata field. More information at: - Metadata - Metadata Suggestbox field - Creating your own Suggestbox plugin |
| Suggestion analyzers | Metadata | Analyzes text to suggest metadata field values. More information at: - Metadata - Creating your own Suggestion Analyzer |
| Template control parsers | OCR Zone | A document identification checkpoint used in the OCR Zone. More information at: - OCR templates - Creating your own OCR Validation Control plugin |
| Template parsers | OCR Zone | A data extraction parser used in the OCR Zone. More information at: - OCR templates - Creating your own OCR Data Capture plugin |
| Text extractor | Search engine | Text extractor based on the document’s MIME type. More information at: - Creating your own Text extractor |
| Version number adapters | Document | Implements version number logic. More information at: - Creating your own Version Number Adapter |