Built-in Automation Action plugins

NameApply at
ParameterDescriptionRestriction

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.

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.

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.

ExecuteScripting

Pre

Post

Code

Executes a script.

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

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.

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.

RevokeAllRoles

Post

 

Revokes all roles granted to the node that triggered the event.

Applicable to all node types.

RevokeAllUsers

Post

 

Revokes all users 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.  

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 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.

Language value is based on ISO 639-1.

For example, for Spanish the value is "es", for English "en", etc.

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.

 

Table of contents [ Hide Show ]