Difference between revisions of "Automation events table"
From OpenKM Documentation
Line 520: | Line 520: | ||
|- | |- | ||
|AutomationUtils.RECORD_NODE | |AutomationUtils.RECORD_NODE | ||
+ | |X | ||
+ | |No | ||
+ | |6.5+ | ||
+ | |} | ||
+ | |||
+ | |||
+ | == Property Group ( metadata ) == | ||
+ | === Add property group === | ||
+ | {| border="1" cellpadding="2" cellspacing="0" | ||
+ | |'''Pre''' | ||
+ | | | ||
+ | | | ||
+ | |'''Version''' | ||
+ | |- style="color:green;" | ||
+ | |'''Variable''' | ||
+ | |'''For evaluation''' | ||
+ | |'''For changing''' | ||
+ | | | ||
+ | |- | ||
+ | |AutomationUtils.NODE_BASE | ||
+ | |X | ||
+ | |No | ||
+ | |6.5+ | ||
+ | |- | ||
+ | |AutomationUtils.PROPERTY_GROUP_NAME | ||
+ | |X | ||
+ | |No | ||
+ | |6.5+ | ||
+ | |- | ||
+ | |'''Post''' | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | |- style="color:green;" | ||
+ | |'''Variable''' | ||
+ | |'''For evaluation''' | ||
+ | |'''For changing''' | ||
+ | | | ||
+ | |- | ||
+ | |AutomationUtils.NODE_BASE | ||
+ | |X | ||
+ | |No | ||
+ | |6.5+ | ||
+ | |- | ||
+ | |AutomationUtils.PROPERTY_GROUP_NAME | ||
|X | |X | ||
|No | |No |
Revision as of 20:02, 12 January 2014
Under construction |
Events can be pre ( previously ) and post ( posterior ). For example pre document creation event, will be executed before document creation and then can be changed several event vars to change parent folder, document name among others. In case post document creation event, will be executed after document creation. In this case there're no associated vars to the event you'll get NodeDocument object to apply directly any change across OpenKM API.
Available environment variables
Variable | Object class | Description |
AutomationUtils.CATEGORIES | Set<String> | List of categories |
AutomationUtils.CREATION_DATE | Calendar | Creation date |
AutomationUtils.DESTINATION_FOLDER_NODE | NodeFolder | Destination folder |
AutomationUtils.MIME_TYPE | String | Mime type |
AutomationUtils.DOCUMENT_NODE | NodeDocument | Document node |
AutomationUtils.FILE | File | Document file |
AutomationUtils.FOLDER_NODE | NodeFolder | Folder node |
AutomationUtils.KEYWORDS | Set<String> | List of keywords |
AutomationUtils.LINK_NODE | NodeLink | Link node |
AutomationUtils.MAIL_NODE | NodeMail | Mail node |
AutomationUtils.NAME | String | Name |
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_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.NODE_BASE | NodeBase ( NodeDocument, NodeFolder, NodeMail and NodeRecord extends from NodeBase) | Node base |
AutomationUtils.NOTES | List<NodeNote> | List of notes |
AutomationUtils.PROPERTY_GROUPS | Set<NodeProperty> | List of property groups ( metadata groups ) |
AutomationUtils.RECORD_NODE | NodeRecord | Record node |
AutomationUtils.TEXT_EXTRACTED | String | Document text extracted |
AutomationUtils.TITLE | String | Title |
AutomationUtils.WIKIPAGE | WikiPage | The wiki page |
Document
Create Document
Pre | Version | ||
Variable | For evaluation | For changing | |
AutomationUtils.CATEGORIES | X | X | 6.5+ |
AutomationUtils.CREATION_DATE | X | No | 6.5+ |
AutomationUtils.DESTINATION_FOLDER_NODE | X | X | 6.5+ |
AutomationUtils.NAME | X | X | 6.5+ |
AutomationUtils.MIME_TYPE | X | X | 6.5+ |
AutomationUtils.KEYWORDS | X | X | 6.5+ |
AutomationUtils.NOTES | X | X | 6.5+ |
AutomationUtils.PROPERTY_GROUPS | X | X | 6.5+ |
AutomationUtils.TITLE | X | X | 6.5+ |
AutomationUtils.WIKIPAGE | X | X | 6.5+ |
Post | |||
Variable | For evaluation | For changing | |
AutomationUtils.DOCUMENT_NODE | X | No | 6.5+ |
Move Document
Pre | Version | ||
Variable | For evaluation | For changing | |
AutomationUtils.DOCUMENT_NODE | X | No | 6.5+ |
AutomationUtils.DESTINATION_FOLDER_NODE | X | X | 6.5+ |
Post | |||
Variable | For evaluation | For changing | |
AutomationUtils.DOCUMENT_NODE | X | No | 6.5+ |
Update Document
Pre | Version | ||
Variable | For evaluation | For changing | |
AutomationUtils.DOCUMENT_NODE | X | No | 6.5+ |
Post | |||
Variable | For evaluation | For changing | |
AutomationUtils.DOCUMENT_NODE | X | No | 6.5+ |
Folder
Create folder
Pre | Version | ||
Variable | For evaluation | For changing | |
AutomationUtils.CATEGORIES | X | X | 6.5+ |
AutomationUtils.CREATION_DATE | X | No | 6.5+ |
AutomationUtils.DESTINATION_FOLDER_NODE | X | X | 6.5+ |
AutomationUtils.NAME | X | X | 6.5+ |
AutomationUtils.KEYWORDS | X | X | 6.5+ |
AutomationUtils.NOTES | X | X | 6.5+ |
AutomationUtils.PROPERTY_GROUPS | X | X | 6.5+ |
AutomationUtils.WIKIPAGE | X | X | 6.5+ |
Post | |||
Variable | For evaluation | For changing | |
AutomationUtils.FOLDER_NODE | X | No | 6.5+ |
Link
Create link
Pre | Version | ||
Variable | For evaluation | For changing | |
AutomationUtils.DESTINATION_FOLDER_NODE | X | X | 6.5+ |
AutomationUtils.NODE_BASE | X | No | 6.5+ |
Post | |||
Variable | For evaluation | For changing | |
AutomationUtils.LINK_NODE | X | No | 6.5+ |
Create mail
Pre | Version | ||
Variable | For evaluation | For changing | |
AutomationUtils.CATEGORIES | X | X | 6.5+ |
AutomationUtils.DESTINATION_FOLDER_NODE | X | X | 6.5+ |
AutomationUtils.MAIL_BCC | X | No | 6.5+ |
AutomationUtils.MAIL_CC | X | No | 6.5+ |
AutomationUtils.MAIL_CONTENT | X | No | 6.5+ |
AutomationUtils.MAIL_FROM | X | No | 6.5+ |
AutomationUtils.MAIL_RECEIVED_DATE | X | No | 6.5+ |
AutomationUtils.MAIL_REPLY | X | No | 6.5+ |
AutomationUtils.MAIL_SENT_DATE | X | No | 6.5+ |
AutomationUtils.MAIL_SUBJECT | X | No | 6.5+ |
AutomationUtils.MAIL_TO | X | No | 6.5+ |
AutomationUtils.NAME | X | X | 6.5+ |
AutomationUtils.KEYWORDS | X | X | 6.5+ |
Post | |||
Variable | For evaluation | For changing | |
AutomationUtils.MAIL_NODE | X | No | 6.5+ |
Record
Create record
Pre | Version | ||
Variable | For evaluation | For changing | |
AutomationUtils.DESTINATION_FOLDER_NODE | X | X | 6.5+ |
AutomationUtils.NAME | X | X | 6.5+ |
AutomationUtils.TITLE | X | X | 6.5+ |
Post | |||
Variable | For evaluation | For changing | |
AutomationUtils.RECORD_NODE | X | No | 6.5+ |
Property Group ( metadata )
Add property group
Pre | Version | ||
Variable | For evaluation | For changing | |
AutomationUtils.NODE_BASE | X | No | 6.5+ |
AutomationUtils.PROPERTY_GROUP_NAME | X | No | 6.5+ |
Post | |||
Variable | For evaluation | For changing | |
AutomationUtils.NODE_BASE | X | No | 6.5+ |
AutomationUtils.PROPERTY_GROUP_NAME | X | No | 6.5+ |
General
Text extraction
Pre | Version | ||
Variable | For evaluation | For changing | |
AutomationUtils.DOCUMENT_NODE | X | No | 6.5+ |
Post | |||
Variable | For evaluation | For changing | |
AutomationUtils.DOCUMENT_NODE | X | No | 6.5+ |
AutomationUtils.TEXT_EXTRACTED | X | X | 6.5+ |
Convert to pdf
Pre | Version | ||
Variable | For evaluation | For changing | |
AutomationUtils.DOCUMENT_NODE | X | No | 6.5+ |
AutomationUtils.FILE (original) | X | No | 6.5+ |
Post | |||
Variable | For evaluation | For changing | |
AutomationUtils.DOCUMENT_NODE | X | No | 6.5+ |
AutomationUtils.FILE (converted to pdf) | X | No | 6.5+ |
Convert to swf
Pre | Version | ||
Variable | For evaluation | For changing | |
AutomationUtils.DOCUMENT_NODE | X | No | 6.5+ |
AutomationUtils.FILE (original) | X | No | 6.5+ |
Post | |||
Variable | For evaluation | For changing | |
AutomationUtils.DOCUMENT_NODE | X | No | 6.5+ |
AutomationUtils.FILE (converted to pdf) | X | No | 6.5+ |