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.
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.
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 whole 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 PDFA.	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: - Folder or document download as a ZIP. - Document download from the user interface. - Document download from the user interface to preview. - Document download from the user interface to print. - Folder exported as JAR. - Email download from the user interface.	Applicable to documents, emails, and folders.
ExecuteScripting	Pre Post	Code	Executes a script.	Applicable to all node types.
ForceGrantActualUser	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.
ForceRevokeActualUser	Post	Permission	Revokes 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.
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.
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.
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: - PNG - GIF - JPEG - BMP - TIFF - PDF
OMRDataCapture	Post		Captures data from the document.	Applicable to OMR valid 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 granted 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 granted access to the node that triggered the event.	Applicable to all node types.
Send Mail	Post	Role names User names Message	Sends mail 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: - “text” for text stamping. - “images” for image stamping.	Applicable to documents.
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.