Creating your own Automation Action

You can create your own Automation Action.

Conditions:

• The new Automation Action class must implement the "Action" interface.
• The new Automation Action class must be declared under the package "com.openkm.automation.action".
• The new Automation Action class must be annotated with "@PluginImplementation".

Validation interface:

package com.openkm.automation;

import java.util.Map;

import net.xeoh.plugins.base.Plugin;

public interface Action extends Plugin {
	public static final String METHOD_PRE = "executePre";
	public static final String METHOD_POST = "executePost";
	
	public void executePre(Map<String, Object> env, Object... params);
	public void executePost(Map<String, Object> env, Object... params);
	public boolean hasPost();
	public boolean hasPre();
	public String getName();
	public String getParamType00();
	public String getParamSrc00();
	public String getParamDesc00();
	public String getParamType01();
	public String getParamSrc01();
	public String getParamDesc01();
	public String getParamType02();
	public String getParamSrc02();
	public String getParamDesc02();
}

Methods description

Understanding env variable

The env variable is present on the isValid method, it is a Map of values injected by automation. These map values provide information about the node involved in the event and other related information.

 For example to retrieve the uuid of the node that caused an event use:

String uuid = AutomationUtils.getUuid(env);

Understanding params variable

The env variable is present on the isValid method, it is an array of Objects. This array is filled by Automation event based on the number of parameters set on Action class (which will not be Automation.PARAM_TYPE_EMPTY value).

The array can have serveral Objects with a distinct type, it is necessary retrieve the parameters to the correct object type.

For example to retrieve the first parameters as a String object use:

String param00 = AutomationUtils.getString(0, params);

Description of available ParamType values:

Description of available Src values:

Detecting recursion

When you create your automation actions, you should consider the possibility of unintended recursion. For example if your action is linked to a "CREATE_DOCUMENT" event and in the action you create a new document you can go into an infinite loop. For this reason when you create a new Action you should take special care of these cases.

Code to detect recursive calls caused by automation action classes:

if (StackTraceUtils.isCallingMe(this.getClass().getName())) {
  log.info("Recursion detected");
  return;
} 

Example

AddKeyword class:

package com.openkm.automation.action;

import java.util.Map;

import net.xeoh.plugins.base.annotations.PluginImplementation;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.openkm.automation.Action;
import com.openkm.automation.AutomationUtils;
import com.openkm.core.Config;
import com.openkm.dao.NodeBaseDAO;
import com.openkm.dao.bean.Automation;

/**
 * AddKeyword
 * 
 */
@PluginImplementation
public class AddKeyword implements Action {
	private static Logger log = LoggerFactory.getLogger(AddKeyword.class);
	
	@Override
	public void executePre(Map<String, Object> env, Object... params) {
	}
	
	@Override
	public void executePost(Map<String, Object> env, Object... params) {
		String keyword = AutomationUtils.getString(0, params);
		String uuid = AutomationUtils.getUuid(env);
		
		try {
			if (uuid != null && keyword != null && !keyword.isEmpty()) {
				if (Config.SYSTEM_KEYWORD_LOWERCASE) {
					keyword = keyword.toLowerCase();
				}
				
				NodeBaseDAO.getInstance().addKeyword(uuid, keyword);
			}
		} catch (Exception e) {
			log.error(e.getMessage(), e);
		}
	}
	
	@Override
	public boolean hasPost() {
		return true;
	}
	
	@Override
	public boolean hasPre() {
		return false;
	}
	
	@Override
	public String getName() {
		return "AddKeyword";
	}
	
	@Override
	public String getParamType00() {
		return Automation.PARAM_TYPE_TEXT;
	}
	
	@Override
	public String getParamSrc00() {
		return Automation.PARAM_SOURCE_EMPTY;
	}
	
	@Override
	public String getParamDesc00() {
		return "Keyword";
	}
	
	@Override
	public String getParamType01() {
		return Automation.PARAM_TYPE_EMPTY;
	}
	
	@Override
	public String getParamSrc01() {
		return Automation.PARAM_SOURCE_EMPTY;
	}
	
	@Override
	public String getParamDesc01() {
		return "";
	}
	
	@Override
	public String getParamType02() {
		return Automation.PARAM_TYPE_EMPTY;
	}
	
	@Override
	public String getParamSrc02() {
		return Automation.PARAM_SOURCE_EMPTY;
	}
	
	@Override
	public String getParamDesc02() {
		return "";
	}
}