Creating your own Automation Validation

You can create your own Automation Validation.

Conditions:

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

Validation interface:

package com.openkm.automation;

import java.util.Map;

import net.xeoh.plugins.base.Plugin;

public interface Validation extends Plugin {
	public static final String METHOD = "isValid";
	
	boolean isValid(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 isValid method, it is a Map of values injected by automation. These map values provide information about the node involved on event and other related information.

 For example to retrieve the uuid of the node that caused the event.

String uuid = AutomationUtils.getUuid(env);

Understanding params variable

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

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

For example to retrive the first parameters as String object.

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

Description of available ParamType values:

Description of available Src values:

Example

PathContains class:

package com.openkm.automation.validation;

import java.util.Map;

import com.openkm.api.OKMRepository;
import com.openkm.automation.AutomationUtils;
import com.openkm.automation.Validation;
import com.openkm.dao.bean.Automation;

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

/**
 * Check if the current parent path contains a designed one. The only
 * parameter is a path and will test if this one is included in the
 * actual parent.
 *
 */
@PluginImplementation
public class PathContains implements Validation {

	@Override
	public boolean isValid(Map<String, Object> env, Object... params) throws Exception {
		String fldUuid = AutomationUtils.getString(0, params);
		String parentPath = AutomationUtils.getParentPath(env);
		String fldPath = OKMRepository.getInstance().getNodePath(null, fldUuid);
		if (parentPath.startsWith(fldPath)) {
			return true;
		} else {
			return false;
		}
	}

	@Override
	public boolean hasPost() {
		return true;
	}

	@Override
	public boolean hasPre() {
		return true;
	}

	@Override
	public String getName() {
		return "PathContains";
	}

	@Override
	public String getParamType00() {
		return Automation.PARAM_TYPE_TEXT;
	}

	@Override
	public String getParamSrc00() {
		return Automation.PARAM_SOURCE_FOLDER;
	}

	@Override
	public String getParamDesc00() {
		return "String";
	}

	@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 "";
	}
}