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 |
|---|---|---|
| Automation validations | Automation | Validations are used in the automation feature. More information at: - Automation - Creating your own Automation Validation |
| Automation actions | Automation | Validations are used in the automation feature. More information at: - Automation - Creating your own Automation Action |
| 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 |
| 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 |
| 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 |
| 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: - Metadata - Metadata Validator element - Creating your own Form Validator 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 |
| Version number adapters | Document | Implements version number logic. More information at: - Creating your own Version Number Adapter |
| Document converters | Conversion | The conversion service is used to convert documents to other formats. More information at: - Creating your own Document Converter |
| Metadata adapters | UI | Visualization logic for the metadata UI. More information at: - Creating your own Stack Metadata Adapter (deprecated) |
| Text extractor | Search engine | Text extractor based on document MIME type. More information at: - Creating your own Text extractor |
| Antivirus | Document | Antivirus checker. Helps integrate with any command-line antivirus. More information at: - Creating your own Antivirus Analyzer plugin |