Difference between revisions of "Automation events table"

From OpenKM Documentation
Jump to: navigation, search
(Move Document)
(Available environment variables)
Line 13: Line 13:
 
|AutomationUtils.CATEGORIES
 
|AutomationUtils.CATEGORIES
 
|Set<String>
 
|Set<String>
 +
|List of categories
 
|-
 
|-
 
|AutomationUtils.CREATION_DATE  
 
|AutomationUtils.CREATION_DATE  
 
|Calendar
 
|Calendar
 +
|Creation date
 +
|-
 +
|AutomationUtils.DESTINATION_FOLDER_NODE
 +
|NodeFolder
 +
|Destination folder
 
|-
 
|-
 
|AutomationUtils.DOCUMENT_MIME_TYPE  
 
|AutomationUtils.DOCUMENT_MIME_TYPE  
 
|String
 
|String
 +
|Document mime type
 
|-
 
|-
 
|AutomationUtils.DOCUMENT_NAME
 
|AutomationUtils.DOCUMENT_NAME
 
|String
 
|String
 +
|Document name
 
|-
 
|-
 
|AutomationUtils.DOCUMENT_NODE
 
|AutomationUtils.DOCUMENT_NODE
 
|NodeDocument
 
|NodeDocument
 +
|Document node
 
|-
 
|-
 
|AutomationUtils.FOLDER_NODE
 
|AutomationUtils.FOLDER_NODE
 
|NodeFolder
 
|NodeFolder
 +
|Folder node
 
|-
 
|-
 
|AutomationUtils.KEYWORDS
 
|AutomationUtils.KEYWORDS
 
|Set<String>
 
|Set<String>
 +
|List of keywords
 
|-
 
|-
 
|AutomationUtils.NOTES
 
|AutomationUtils.NOTES
 
|List<NodeNote>
 
|List<NodeNote>
 +
|List of notes
 
|-
 
|-
 
|AutomationUtils.PARENT_NODE
 
|AutomationUtils.PARENT_NODE
 
|NodeBase
 
|NodeBase
 +
|Parent node ( usually will be a folder )
 
|-
 
|-
 
|AutomationUtils.PROPERTY_GROUPS
 
|AutomationUtils.PROPERTY_GROUPS
 
|Set<NodeProperty>
 
|Set<NodeProperty>
 +
|List of property groups ( metadata groups )
 
|-
 
|-
 
|AutomationUtils.TITLE
 
|AutomationUtils.TITLE
 
|String
 
|String
 +
|Title
 
|-
 
|-
 
|AutomationUtils.WIKIPAGE
 
|AutomationUtils.WIKIPAGE
 
|WikiPage
 
|WikiPage
 +
|The wiki page
 
|}
 
|}
  

Revision as of 11:25, 11 January 2014


Nota advertencia.png 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
AutomationUtils.CATEGORIES Set<String> List of categories
AutomationUtils.CREATION_DATE Calendar Creation date
AutomationUtils.DESTINATION_FOLDER_NODE NodeFolder Destination folder
AutomationUtils.DOCUMENT_MIME_TYPE String Document mime type
AutomationUtils.DOCUMENT_NAME String Document name
AutomationUtils.DOCUMENT_NODE NodeDocument Document node
AutomationUtils.FOLDER_NODE NodeFolder Folder node
AutomationUtils.KEYWORDS Set<String> List of keywords
AutomationUtils.NOTES List<NodeNote> List of notes
AutomationUtils.PARENT_NODE NodeBase Parent node ( usually will be a folder )
AutomationUtils.PROPERTY_GROUPS Set<NodeProperty> List of property groups ( metadata groups )
AutomationUtils.TITLE String Title
AutomationUtils.WIKIPAGE WikiPage The wiki page


Create Document

Pre Version
Variable For evaluation For changing
AutomationUtils.CATEGORIES X X 6.5+
AutomationUtils.CREATION_DATE X No 6.5+
AutomationUtils.DOCUMENT_NAME X X 6.5+
AutomationUtils.DOCUMENT_MIME_TYPE X X 6.5+
AutomationUtils.KEYWORDS X X 6.5+
AutomationUtils.NOTES X X 6.5+
AutomationUtils.PARENT_NODE 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.FOLDER_NODE X X 6.5+
Post
Variable For evaluation For changing
AutomationUtils.DOCUMENT_NODE X No 6.5+