Crear su propia Automation Validation

Consejo

La arquitectura de plugins está disponible desde la versión 6.3.7 de OpenKM; para versiones anteriores, consulte Creating your own Automation Validation ( deprecated ).

Puede crear su propia validación de automatización (Automation Validation).

Condiciones:

• La nueva clase de Automation Validation debe implementar la interfaz “Validation”.
• La nueva clase de Automation Validation debe declararse en el paquete “com.openkm.automation.validation”.
• La nueva clase de Automation Validation debe estar anotada con “@PluginImplementation”.

Interfaz de validación:

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();
}

Nota

Más información sobre Registrar un nuevo plugin.

Descripción de los métodos

Método	Tipo	Descripción
isValid(Map<String, Object> env, Object… params)	boolean	Método ejecutado por el evento de Automation para evaluar si las condiciones son verdaderas o falsas.
hasPost()	boolean	Cuando devuelve true, indica que el método isValid(…) puede utilizarse en la fase post de Automation. Más información sobre las fases de automatización en Automation.
hasPre()	boolean	Cuando devuelve true, indica que el método isValid(…) puede utilizarse en la fase pre de Automation. Más información sobre las fases de automatización en aAutomation.
getName()	String	Establece el nombre que se mostrará en la lista de selección de la interfaz de administración.
getParamType00 getParamType01 getParamType02	String	Establece el tipo de parámetro. Valores disponibles: - Automation.PARAM_TYPE_EMPTY - Automation.PARAM_TYPE_TEXT - Automation.PARAM_TYPE_INTEGER - Automation.PARAM_TYPE_BOOLEAN - Automation.PARAM_TYPE_TEXTAREA - Automation.PARAM_TYPE_CODE - Automation.PARAM_TYPE_USER - Automation.PARAM_TYPE_ROLE - Automation.PARAM_TYPE_OMR Cuando el valor es Automation.PARAM_TYPE_EMPTY los parámetros funcionan como un grupo lógico. [ getParamType00 + getParamSrc00 + getParamDesc00 ]
getParamSrc00 getParamSrc01 getParamSrc02	String	Establece el tipo de origen. Valores disponibles: - Automation.PARAM_SOURCE_EMPTY - Automation.PARAM_SOURCE_FOLDER - Automation.PARAM_SOURCE_OMR
getParamDesc00 getParamDesc00 getParamDesc00	String	La descripción del parámetro.

Entender la variable env

La variable env está presente en el método isValid, es un Map de valores inyectados por la automatización. Estos valores del mapa proporcionan información sobre el nodo implicado en el evento y otra información relacionada.

Nota

Lleva algo de tiempo hasta que toma el control de la clase AutomationUtils, porque están centralizados los métodos para obtener los datos.

 Por ejemplo, para recuperar el uuid del nodo que causó el evento.

String uuid = AutomationUtils.getUuid(env);

Entender la variable params

La variable env está presente en el método isValid, es un array de Objects. Este array lo rellena el evento de Automation según el número de parámetros establecidos en la clase Validation ( que no tendrán el valor Automation.PARAM_TYPE_EMPTY ).

El array puede tener varios Objects de distinto tipo, por lo que es necesario recuperar los parámetros con el tipo de objeto correcto.

Nota

Lleva algo de tiempo hasta que toma el control de la clase AutomationUtils, porque están centralizados los métodos para obtener los parámetros.

Por ejemplo, para recuperar el primer parámetro como objeto String.

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

Descripción de los valores disponibles de ParamType:

Propiedad	Descripción
Automation.PARAM_TYPE_EMPTY	Indica un valor vacío.
Automation.PARAM_TYPE_TEXT	Indica que se requerirá un valor de texto.
Automation.PARAM_TYPE_INTEGER	Indica que se requerirá un valor entero.
Automation.PARAM_TYPE_BOOLEAN	Indica que se requerirá un valor booleano.
Automation.PARAM_TYPE_TEXTAREA	Indica que se requerirá un valor de área de texto.
Automation.PARAM_TYPE_CODE	Indica que se requerirá un código.
Automation.PARAM_TYPE_USER	Indica que se requerirá un usuario válido de la aplicación.
Automation.PARAM_TYPE_ROLE	Indica que se requerirá un rol válido de la aplicación.
Automation.PARAM_TYPE_OMR	Indica que se requerirá un id de OMR válido (reconocimiento óptico de marcas).

Descripción de los valores disponibles de Src:

Propiedad	Descripción
PARAM_SOURCE_EMPTY	Indica un origen vacío.
PARAM_SOURCE_FOLDER	Indica que el origen debe ser una carpeta.
PARAM_SOURCE_OMR	Indica que el origen debe ser un OMR válido (reconocimiento óptico de marcas).

Ejemplo

Clase PathContains:

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