Built-in Automation Action plugins
| Name | Apply at | Parameter | Description | Restriction |
|---|---|---|---|---|
|
AddCategory |
Post |
Category |
Adds a category to the node that triggered the event. |
Applicable to all node types. |
|
AddCategoryToWizard |
Post |
|
Shows a category pop-up as part of the process of uploading a new document. Only takes effect when a user uploads a new document from the user interface. |
Applicable to documents. |
|
AddDigitalSignatureToWizard |
Post |
|
Shows a digital signature pop-up as part of the process of uploading a new document. |
Applicable to documents. |
|
AddKeyword |
Post |
Keyword name |
Adds a keyword to the node that triggered an event. |
Applicable to all node types. |
|
AddKeywordToWizard |
Post |
|
Shows a keyword pop-up as part of the process of uploading a new document. Only takes effect when a user uploads a new document from the user interface. |
Applicable to documents. |
|
AddOCRDataCaptureToWizard |
Post |
|
Shows an OCR data capture pop-up as part of the process of uploading a new document. Only takes effect when a user uploads a new document from the user interface.
|
Applicable to documents. |
|
AddPropertyGroup |
Post |
Metadata group name |
Adds the Metadata group. |
Applicable to all node types. |
|
AddPropertyGroupToWizard |
Post |
Metadata group name |
Shows a Metadata group pop-up as part of the process of uploading a new document. Only takes effect when a user uploads a new document from the user interface. |
Applicable to documents. |
|
AddPropertyGroupWithAI |
Post |
Metadata group name |
Adds a metadata property group to the node and populates its fields using AI extraction from the document's text content. If the group already exists on the node, its properties are updated. Throws an exception if the AI extraction fails to produce any property values. Available from OpenKM version 8.2.4 onwards. |
Applicable to documents. Fires on document create and update events. |
|
AddWorkflowToWizard |
Post |
Workflow name |
Starts a workflow as part of the process of uploading a new document. A pop-up will be shown if a workflow requires a user to set parameters for starting the workflow. Otherwise, it will be transparent to the end user. Only takes effect when a user uploads a new document from the user interface. |
Applicable to documents. |
|
AIExecutePrompt |
Post |
ClassName |
Executes an AI prompt using the text extracted from the node. Available from OpenKM version 8.2.4 onwards. |
Applicable to documents and emails only. |
|
CatalogByMetadata |
Post |
Used by the file plan to automatically catalog documents in the repository. |
Applicable to all node types. |
|
|
CheckUniqueDocumentName |
Pre |
If a document with the same name exists in the entire repository, an exception is raised. |
Applicable to documents. |
|
|
CompactDocumentHistory |
Post |
Compacts the document history, removing all older versions. |
Applicable to documents. |
|
|
ConvertToPDF |
Post |
Converts a document to PDF. |
Applicable to documents. |
|
|
ConvertToPDFA |
Post | Converts a document in PDF format to PDF/A. |
Applicable to documents. |
|
|
CreateDestinationPathByCatalogManager |
Post |
Used by the file plan to automatically create the destination path of a node. |
Applicable to all node types. |
|
|
DelCadReferences |
Pre |
Deletes the OpenKM document references of an AutoCAD document. |
Applicable to documents. |
|
|
DeleteNode |
Post |
Deletes a node that is moved into the user's trash node. |
Applicable to all node types. |
|
|
DocumentCreationNameToLowerCase |
Pre |
Forces the name and the extension of the document to lowercase. |
Applicable to documents. |
|
|
DownloadAsDocumentVersion |
Post |
|
When downloading a document, the document is renamed to include the version number at the end. |
Applicable to documents. |
|
DownloadControl |
Post |
Registers the action that triggered a download in the activity log. Available download causes:
|
Applicable to documents, emails, and folders. | |
|
ExecuteScripting |
Pre Post |
Code |
Executes a script. |
Applicable to all node types. |
|
FeedRAG |
Post |
|
Feeds the RAG (Retrieval-Augmented Generation) module with the extracted text from a document or mail node. Adds the node's content to the vector store for use in semantic search and AI-powered queries. Available from OpenKM version 8.2.4 onwards. |
Applicable to documents and emails. Fires on text extraction events. |
|
FilterGetAllPropertyGroup |
Post |
Property groups (one per line) |
Filters the list of property groups returned to the user interface by removing the groups specified in the parameter. Groups are listed one per line in the parameter field. Useful for hiding specific metadata groups from certain automation contexts. |
Applicable to the Get All Property Groups event only. |
|
ForceGrantCurrentUser |
Post |
Permission |
Grants permission to the user who caused the event on the node that triggered the event. The super user makes the security change. |
Applicable to all node types. |
|
ForceRevokeCurrentUser |
Post |
Permission |
Revokes permission from the user who caused the event on the node that triggered the event. The super user makes the security change. |
Applicable to all node types. |
|
ForceTextExtractionExecution |
Post |
|
Forces the text extraction process to run immediately on the triggering document node, bypassing any deferred or scheduled extraction. |
Applicable to documents. Fires on document create and update events. |
|
GrantRole |
Post |
Role name Permission |
Grants a role permission to the node that triggered the event. |
Applicable to all node types. |
|
GrantUser |
Post |
User name Permission |
Grants a user permission to the node that triggered the event. |
Applicable to all node types. |
|
LimitConcurrentUsersAction |
Pre |
Maximum number of concurrent users (integer) |
Limits the number of concurrent non-admin users allowed to be logged in simultaneously. If the limit has been reached or exceeded, the login attempt is rejected and the user is logged out. Sessions belonging to the administrator user (DEFAULT_ADMIN_USER) are excluded from the count and are never restricted. |
Applicable to the User Login event only. |
|
MoveToAZFolder |
Post |
Folder destination Folder depth; |
Creates a folder hierarchy based on the name of the node and depth, and moves the node into it. Document named "Testing.pdf" Folder destination = /okm:root/move/into With depth = 3 The document will be moved to /okm:root/move/into/T/E/S/Testing.pdf |
Applicable to all node types. |
|
MoveToFolder |
Post |
Folder destination |
Moves the node to a new location. |
Applicable to all node types. |
|
MoveToShard |
Post |
Shard ID (long) |
Moves the physical content of the triggering node to the specified storage shard. Handles documents, mails, folders, and records, applying the move recursively to child nodes where applicable. |
Applicable to all node types. Fires on document, mail, and property group events. |
|
MoveToYearMonthDayFolder |
Post |
Folder destination |
Moves the node to a new location with a year/month/day subfolder structure. Document named "Testing.pdf" Folder destination = /okm:root/move/into Current date = 2020-05-08 The document will be moved to /okm:root/move/into/2020/05/08/Testing.pdf |
Applicable to all node types. |
|
NewCadReferences |
Post |
Creates the OpenKM document references of an AutoCAD document. |
Applicable to documents. |
|
|
OCRDataCapture |
Post |
|
Captures data from the document. |
Applicable to some MIME-type documents:
|
|
OMRDataCapture |
Post |
|
Captures data from the document. |
Applicable to valid OMR files. |
|
PurgeNode |
Post |
Purges a node. The node is removed from the repository. |
Applicable to all node types. |
|
|
RevokeAllRoles |
Post |
|
Revokes all roles granted to the node that triggered the event. |
Applicable to all node types. |
|
RevokeAllUsers |
Post |
|
Revokes all users' access to the node that triggered the event. |
Applicable to all node types. |
|
RemoveCategory |
Post |
Category |
Removes the category from the node that triggered the event. |
Applicable to all node types. |
|
RemoveKeyword |
Post |
Keyword name |
Removes the keyword from the node that triggered the event. |
Applicable to all node types. |
|
RenameUniqueDocument |
Pre |
Ensures new documents will have a unique name. |
Applicable to documents. |
|
|
RevokeRole |
Post |
Role name |
Revokes the role granted to the node that triggered the event. |
Applicable to all node types. |
|
RevokeUser |
Post |
User name |
Revokes the user's access to the node that triggered the event. |
Applicable to all node types. |
|
Send Mail |
Post |
Role names User names Message |
Sends email to the selected users and roles. The message format is the same as used in notification messages. For more information, take a look at Notification configuration parameters. |
Applicable to all node types. |
|
SetAutoStartToWizard |
Pre, Post |
Sets the autostart for the wizard. |
Applicable to all node types. |
|
|
SetInQuarantine |
Post |
When the antivirus engine detects a virus in a document, it moves the document into the quarantine folder /okm:root/quarantine. |
Applicable to documents. |
|
|
SetLanguage |
Post | Language |
Sets the language of the document node that triggered the event. The language value is based on ISO 639-1. For example, for Spanish the value is "es", for English "en", etc. |
Applicable to documents. |
|
SetRelationsFromXRef |
Post |
Sets the relations from xref. |
Applicable to documents. |
|
|
SetSummarization |
Post |
Sets the document summarization. The KEA Summarization service must be enabled. |
Applicable to documents. | |
|
SetTextExtracted |
Post |
String |
Replaces the original extracted text content of the document node that triggered the event. |
Applicable to documents. |
|
SetTextExtractor |
Pre |
ClassName |
Replaces the default text extractor. |
Applicable to documents. |
|
StampDocument |
Post |
Stamp ID Stamp type |
Stamps a document. The stamp ID must be an existing stamp ID definition. Stamp type values:
|
Applicable to documents. |
|
StartWorkflow |
Post |
Workflow name |
Starts a workflow process automatically using the latest version of the named workflow definition. The triggering node's UUID is passed to the workflow as the starting document. Throws an exception if the workflow definition is not found. |
Applicable to documents, records, folders, and emails. |
|
VidSignerDocumentSigned |
Post |
Marks a document as signed by VidSigner. A VidSigner account is required. |
Applicable to documents. |
|
|
VidSignerDocumentToSign |
Post |
Sends a document to be signed by VidSigner. A VidSigner account is required. |
Applicable to documents. |
