Skip to content
Other versions

Loading…

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 popup 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 popup 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 popup 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 popup as part of the process of uploading a new document.
Only take effect when an user uploads a new document from the user interface.
Applicable to documents.
AddPropertyGroup Post Metadata group name Add a Metadata group. Applicable to all node types.
AddPropertyGroupToWizard Post Metadata group name Shows a Metadata group popup as part of the process of uploading a new document.
Only takes effect when an 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 popup 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 user interface.
Applicable to documents.
CompactDocumentHistory Post Compact the document history removing all older versions. Applicable to documents.
DeleteNode Post Deletes a node that is moved into a user’s trash node. Applicable to all node types.
Download Control Post Registers a download in the activity log.
Available download causes:
- Folder or document download as ZIP.
- Document download from user interface.
- Document download from user interface to preview.
- Document download from user interface to print.
- Folder exported as JAR.
- Email download from user interface.
Applicable to documents, email, and folders.
DownloadAsDocumentVersion Post When downloading a document, rename the document, including the version number at the end. Applicable to documents.
ExecuteScripting Pre
Post
Code Executes a script. Applicable to all node types.
ForceGrantActualUser Post Permission Grants permission to the user who caused the event in the node that triggered the event.
The super user makes the security change.
Applicable to all node types.
ForceRevokeActualUser Post Permission Revoke permission from the user who caused the event in 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 on the node that triggered the event. Applicable to all node types.
GrantUser Post User name
Permission
Grants a user permission on the node that triggered the event. Applicable to all node types.
Joomla content publication Post Creates or updates content or media on joomla cms. Applicable to some HTML or image documents.
Joomla properties publication Post Update content or media properties on joomla cms.
For example, change the publication status.
Applicable to some HTML or image documents.
MoveToFolder Post Folder destination Move the node to a new location. Applicable to all node types.
MoveToYearMonthDayFolder Post Folder destination Move the node to a new location with a subfolder structure year / month / day Applicable to all node types.
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 Purge a node. The node is removed from repository. Applicable to all node types.
RevokeAllRoles Post Revokes all role permissions granted to the node that triggered the event. Applicable to all node types.
RevokeAllUsers Post Revoke all user permissions granted 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 unique names. Applicable to documents.
RevokeRole Post Role name Revokes the role permission granted to the node that triggered the event. Applicable to all node types.
RevokeUser Post User name Revokes the user permission granted to the node that triggered the event. Applicable to all node types.
Send Mail Post Role names
User names
Message
Send mail to the selected users and roles.
The message format is the same used in notification messages. For more information take a look at Notification configuration parameters.
Applicable to all node types.
SetLanguage Post Language Sets the language to 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.
SetTextExtracted Post String Replaces the original content text extracted from the document node that triggered the event. Applicable to documents.
StampDocument Post Stamp id
Stamp type
Stamp a document.
Stamp id must be and existing stamp id definition.
Stamp type values:
- “text” for text stamping.
- “images” for images stamping.
Applicable to documents.
Wordpress publication for content Post Creates or updates content or media on wordpress. Applicable to some HTML or image documents.
Wordpress publication for setProperties Post Updates content or media properties on wordpress.
For example changes the publications status.
Applicable to some HTML or image documents.