Variables by automation event

Events can be pre (previous) and post (posterior). For example, a pre document creation event is executed before document creation, and several event vars can then be changed to modify the parent folder, document name, among others. In the case of a post document creation event, it is executed after document creation. In this case, there are no vars associated with the event; you’ll get a NodeDocument object to apply any changes directly through the OpenKM API.  

Available environment variables

Variable	Object class	Description
AutomationUtils.CATEGORIES	Set	List of categories
AutomationUtils.CREATION_DATE	Calendar	Creation date
AutomationUtils.DESTINATION_NODE	NodeFolder	Destination folder
AutomationUtils.DOCUMENT_NODE	NodeDocument	Document node
AutomationUtils.DOCUMENT_FILE	File	Document File
AutomationUtils.DOCUMENT_NAME	String	Document name
AutomationUtils.DOCUMENT_VERSION	String	Document version
AutomationUtils.EVENT	AutomationRule.EnumEvents	Event
AutomationUtils.EVENT_AT	String	Event at
AutomationUtils.FOLDER_NODE	NodeFolder	Folder node
AutomationUtils.KEYWORDS	Set	List of keywords
AutomationUtils.NODE_BASE	NodeBase - NodeDocument - NodeFolder - NodeMail - NodeRecord    These nodes extend NodeBase.	Node base
AutomationUtils.NODE_BASE_LIST	List - NodeDocument - NodeFolder - NodeMail - NodeRecord These nodes extend NodeBase.	Node base list
AutomationUtils.NOTES	List	List of notes
AutomationUtils.MAIL_BCC	String[]	Mail bcc
AutomationUtils.MAIL_CC	String[]	Mail cc
AutomationUtils.MAIL_CONTENT	String	Mail content
AutomationUtils.MAIL_FROM	String	Mail from
AutomationUtils.MAIL_NODE	NodeMail	Mail node
AutomationUtils.MAIL_RECEIVED_DATE	Calendar	Mail received date
AutomationUtils.MAIL_REPLY	String[]	Mail reply
AutomationUtils.MAIL_SENT_DATE	Calendar	Mail sent date
AutomationUtils.MAIL_SUBJECT	String	Mail subject
AutomationUtils.MAIL_TO	String[]	Mail to
AutomationUtils.MIME_TYPE	String	MIME type
AutomationUtils.NAME	String	Name
AutomationUtils.PROPERTY_GROUP_NAME	String	Property group name
AutomationUtils.PROPERTY_GROUP_PROPERTIES	Map<String, String>	Property group properties
AutomationUtils.PROPERTY_GROUPS	Set	List of property groups (metadata groups)
AutomationUtils.RECORD_NODE	NodeRecord	Record node
AutomationUtils.TEXT_EXTRACTED	String	Extracted document text
AutomationUtils.LANGUAGE_DETECTED	String	Detected language
AutomationUtils.UPLOAD_RESPONSE	String	Upload response
AutomationUtils.TITLE	String	Title
AutomationUtils.WIKIPAGE	wikiPage	The wiki page
AutomationUtils.NODE_CLASS	Long	The NodeClass ID
AutomationUtils.NEW_NODE_CLASS	Long	The new NodeClass
AutomationUtils.OLD_NODE_CLASS	Long	The old NodeClass
AutomationUtils.TASK_ID	Long	The Task ID
AutomationUtils.TASK_OBJECT	TaskManagerTask	Task object
AutomationUtils.USER	com.openkm.bean.CommonUser	User
AutomationUtils.DOCUMENT_SIZE	Long	Document size

Document

Create Document

At Pre
Variable
AutomationUtils.CATEGORIES
AutomationUtils.CREATION_DATE
AutomationUtils.NAME
AutomationUtils.MIME_TYPE
AutomationUtils.KEYWORDS
AutomationUtils.NOTES
AutomationUtils.NODE_CLASS
AutomationUtils.DESTINATION_NODE
AutomationUtils.PROPERTY_GROUPS
AutomationUtils.TITLE
AutomationUtils.WIKIPAGE
AutomationUtils.DOCUMENT_SIZE
At post
Variable
AutomationUtils.DOCUMENT_NODE
AutomationUtils.DOCUMENT_FILE

Update Document

At Pre
Variable
AutomationUtils.DOCUMENT_NODE
At post
Variable
AutomationUtils.DOCUMENT_NODE

Delete Document

At Pre
Variable
AutomationUtils.DOCUMENT_NODE
At post
Variable
AutomationUtils.DOCUMENT_NODE

Rename Document

At Pre
Variable
AutomationUtils.DOCUMENT_NODE
At post
Variable
AutomationUtils.DOCUMENT_NODE

Purge Document

At Pre
Variable
AutomationUtils.DOCUMENT_NODE
At post
Variable
AutomationUtils.DOCUMENT_NODE

Move Document

At Pre
Variable
AutomationUtils.DOCUMENT_NODE
AutomationUtils.DESTINATION_NODE
At post
Variable
AutomationUtils.DOCUMENT_NODE

Restore Version Document

At Pre
Variable
AutomationUtils.NODE_BASE
AutomationUtils.DOCUMENT_VERSION
At post
Variable
AutomationUtils.NODE_BASE
AutomationUtils.DOCUMENT_VERSION

Download Document from UI

At Pre
Variable
AutomationUtils.DOCUMENT_NODE
AutomationUtils.DOCUMENT_VERSION
AutomationUtils.DOCUMENT_NAME
AutomationUtils.DOCUMENT_NODE
At post
Variable
AutomationUtils.DOCUMENT_NODE
AutomationUtils.DOCUMENT_VERSION
AutomationUtils.DOCUMENT_NAME
AutomationUtils.DOCUMENT_NODE

Download Document from UI for preview

At Pre
Variable
AutomationUtils.DOCUMENT_NODE
AutomationUtils.DOCUMENT_NAME
AutomationUtils.DOCUMENT_VERSION
At post
Variable
AutomationUtils.DOCUMENT_NODE
AutomationUtils.DOCUMENT_NAME
AutomationUtils.DOCUMENT_VERSION

Folder

Create Folder

At Pre
Variable
AutomationUtils.CATEGORIES
AutomationUtils.CREATION_DATE
AutomationUtils.DESTINATION_NODE
AutomationUtils.NAME
AutomationUtils.NOTES
AutomationUtils.KEYWORDS
AutomationUtils.PROPERTY_GROUPS
AutomationUtils.WIKIPAGE
At post
Variable
AutomationUtils.FOLDER_NODE

Delete Folder

Note

The event is only triggered on the root node. If the node has subnodes, an event will not be generated from them.

At Pre
Variable
AutomationUtils.FOLDER_NODE
At post
Variable
AutomationUtils.FOLDER_NODE

Purge Folder

Note

The event is only triggered on the root node. If the node has subnodes, an event will not be generated from them.

At Pre
Variable
AutomationUtils.FOLDER_NODE
At post
Variable
AutomationUtils.FOLDER_NODE

Move Folder

Note

The event is only triggered on the root node and the destination node. If the node has subnodes, an event will not be generated from them.

At Pre
Variable
AutomationUtils.FOLDER_NODE
AutomationUtils.DESTINATION_NODE
At post
Variable
AutomationUtils.FOLDER_NODE

Rename Folder

At Pre
Variable
AutomationUtils.FOLDER_NODE
At post
Variable
AutomationUtils.FOLDER_NODE

Export Folder as ZIP

At Pre
Variable
AutomationUtils.FOLDER_NODE
At post
Variable
AutomationUtils.FOLDER_NODE

Export Folder as JAR

At Pre
Variable
AutomationUtils.FOLDER_NODE
At post
Variable
AutomationUtils.FOLDER_NODE

Mail

Create mail

At Pre
Variable
AutomationUtils.CATEGORIES
AutomationUtils.CREATION_DATE
AutomationUtils.DESTINATION_NODE
AutomationUtils.MAIL_FROM
AutomationUtils.MAIL_REPLY
AutomationUtils.MAIL_TO
AutomationUtils.MAIL_CC
AutomationUtils.MAIL_BCC
AutomationUtils.MAIL_SENT_DATE
AutomationUtils.MAIL_RECEIVED_DATE
AutomationUtils.MAIL_SUBJECT
AutomationUtils.MAIL_CONTENT
AutomationUtils.NAME
AutomationUtils.KEYWORDS
AutomationUtils.MIME_TYPE
AutomationUtils.TITLE
At post
Variable
AutomationUtils.MAIL_NODE

Move Mail

At Pre
Variable
AutomationUtils.MAIL_NODE
AutomationUtils.DESTINATION_NODE
At post
Variable
AutomationUtils.MAIL_NODE

Download mail from UI

At Pre
Variable
AutomationUtils.MAIL_NODE
At post
Variable
AutomationUtils.MAIL_NODE

Import mail attachments

At post
Variable
AutomationUtils.MAIL_NODE

Delete Mail

Note

The event is only triggered on the root node. If the node has subnodes, an event will not be generated from them.

At Pre
Variable
AutomationUtils.MAIL_NODE
At post
Variable
AutomationUtils.MAIL_NODE

Purge Mail

Note

The event is only triggered on the root node. If the node has subnodes, an event will not be generated from them.

At Pre
Variable
AutomationUtils.MAIL_NODE
At post
Variable
AutomationUtils.MAIL_NODE

Record

Create record

At Pre
Variable
AutomationUtils.DESTINATION_NODE
AutomationUtils.NAME
AutomationUtils.NODE_CLASS
AutomationUtils.TITLE
At post
Variable
AutomationUtils.RECORD_NODE

Delete record

Note

The event is only triggered on the root node. If the node has subnodes, an event will not be generated from them.

At Pre
Variable
AutomationUtils.RECORD_NODE
At post
Variable
AutomationUtils.RECORD_NODE

Purge record

Note

The event is only triggered on the root node. If the node has subnodes, an event will not be generated from them.

At Pre
Variable
AutomationUtils.RECORD_NODE
At post
Variable
AutomationUtils.RECORD_NODE

Move Record

Note

The event is only triggered on the root node and the destination node. If the node has subnodes, an event will not be generated from them.

At Pre
Variable
AutomationUtils.RECORD_NODE
AutomationUtils.DESTINATION_NODE
At post
Variable
AutomationUtils.RECORD_NODE

Property Group (metadata)

Add property group

At Pre
Variable
AutomationUtils.NODE_BASE
AutomationUtils.PROPERTY_GROUP_NAME
AutomationUtils.PROPERTY_GROUP_PROPERTIES
At post
Variable
AutomationUtils.NODE_BASE
AutomationUtils.PROPERTY_GROUP_NAME
AutomationUtils.PROPERTY_GROUP_PROPERTIES

Set property group

At Pre
Variable
AutomationUtils.NODE_BASE
AutomationUtils.PROPERTY_GROUP_NAME
AutomationUtils.PROPERTY_GROUP_PROPERTIES
At post
Variable
AutomationUtils.NODE_BASE
AutomationUtils.PROPERTY_GROUP_NAME
AutomationUtils.PROPERTY_GROUP_PROPERTIES

Remove property group

At Pre
Variable
AutomationUtils.NODE_BASE
AutomationUtils.PROPERTY_GROUP_NAME
At post
Variable
AutomationUtils.NODE_BASE
AutomationUtils.PROPERTY_GROUP_NAME

Auth 

Create user

At Pre
Variable
AutomationUtils.USER
At post
Variable
AutomationUtils.USER

User login

At post
Variable
AutomationUtils.USER

User logout

At Pre
Variable
AutomationUtils.USER

Note

Create Note

At Pre
Variable
AutomationUtils.NODE_BASE
AutomationUtils.NOTE_TEXT
At post
Variable
AutomationUtils.NOTE_UUID

Update Note

At Pre
Variable
AutomationUtils.NODE_BASE
AutomationUtils.NOTE_TEXT
AutomationUtils.NOTE_UUID
At post
Variable
AutomationUtils.NODE_BASE
AutomationUtils.NOTE_TEXT
AutomationUtils.NOTE_UUID

Delete Note

At Pre
Variable
AutomationUtils.NODE_BASE
AutomationUtils.NOTE_UUID
At post
Variable
AutomationUtils.NODE_BASE
AutomationUtils.NOTE_UUID

General

Text extraction

At Pre
Variable
AutomationUtils.DOCUMENT_NODE
At post
Variable
AutomationUtils.TEXT_EXTRACTED
AutomationUtils.LANGUAGE_DETECTED

Export nodes to zip

At Pre
Variable
AutomationUtils.NODE_BASE_LIST
At post
Variable
AutomationUtils.NODE_BASE_LIST