OKMPropertyGroup

Conceptos básicos

Nota

En versiones anteriores de OpenKM llamábamos “Grupos de metadatos” a los “Grupos de propiedades”.

Aunque entendemos que este nombre no ayuda demasiado a identificar estos métodos como relacionados con los metadatos, por razones históricas continuamos manteniendo esta nomenclatura.

Para más información sobre Metadatos.

En la mayoría de los métodos verá un parámetro llamado “nodeId”. El valor de este parámetro puede ser un UUID o una ruta (path) válidos de documento, carpeta, correo o expediente.

Consejo

Ejemplo de nodeId:

• Usando UUID -> “f123a950-0329-4d62-8328-0ff500fd42db”;
• Usando ruta -> “/okm:root/logo.png”

Precaución

Debe utilizarse la clase com.openkm.util.ISO8601 para establecer y analizar los campos de metadatos de tipo fecha. Los valores de los campos de metadatos de tipo fecha se almacenan en la aplicación en formato básico ISO-8601.

Para convertir el campo de metadatos de tipo fecha recuperado en una fecha válida, use:

Calendar cal = ISO8601.parseBasic(metadataFieldValue);

Para guardar el valor de fecha en el campo de metadatos de tipo fecha utilice:

Calendar cal = Calendar.getInstance(); // Present date
String metadataFieldValue = ISO8601.formatBasic(cal);
// metadataFieldValue can be saved into repository metadata field of type date

Además, en todos los métodos verá un parámetro llamado “token”. Al acceder a la aplicación a través de SOAP, el proceso de inicio de sesión devuelve un token, que se utiliza para identificar al usuario en todos los métodos expuestos. Desde el contexto de ejecución por defecto de la aplicación debe utilizar el valor “null”, que indica a la aplicación que debe utilizar la “sesión del usuario”.

Consejo

En casos especiales puede “promocionarse como Administrador” utilizando el “token de administrador”.

String systemToken = DbSessionManager.getInstance().getSystemToken();

Métodos

addGroup

Descripción:

Método	Valores de retorno	Descripción
addGroup(String token, String nodeId, String grpName)	void	Añade un grupo de metadatos vacío a un nodo.

• El grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            OKMPropertyGroup.getInstance().addGroup(null, "/okm:root/logo.png", "okg:consulting");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeGroup

Descripción:

Método	Valores de retorno	Descripción
removeGroup(String token, String nodeId, String grpName)	void	Elimina un grupo de metadatos de un nodo.

• El grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            OKMPropertyGroup.getInstance().removeGroup(null, "/okm:root/logo.png", "okg:consulting");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getGroups

Descripción:

Método	Valores de retorno	Descripción
getGroups(String token, String nodeId)	List	Recupera una lista de los grupos de metadatos asignados a un nodo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.bean.PropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            for (PropertyGroup pg : OKMPropertyGroup.getInstance().getGroups(null, "/okm:root/logo.png")) {
                System.out.println(pg);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAllGroups

Descripción:

Método	Valores de retorno	Descripción
getAllGroups(String token)	List	Recupera una lista de todos los grupos de metadatos definidos en la aplicación.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.bean.PropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            for (PropertyGroup pg : OKMPropertyGroup.getInstance().getAllGroups(null)) {
                System.out.println(pg);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getProperties

Descripción:

Método	Valores de retorno	Descripción
getProperties(String token, String nodeId, String grpName)	List	Recupera una lista de todos los elementos del grupo de metadatos y sus valores en el nodo.

Nota

El método se utiliza normalmente para mostrar los elementos del formulario con sus valores para que el usuario los vea o los cambie.

• El grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.bean.form.FormElement;

public class Test {
    public static void main(String[] args) {
        try {
            for (FormElement fe : OKMPropertyGroup.getInstance().getProperties(null,"/okm:root/logo.png", "okg:consulting")) {
                System.out.println(fe);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setProperties

Descripción:

Método	Valores de retorno	Descripción
setProperties(String token, String nodeId, String grpName, List properties)	void	Cambia los valores del grupo de metadatos de un nodo.

Nota

No es obligatorio establecer todos los FormElement en el parámetro ofeList; basta con incluir los formElements cuyos valores desee cambiar.

Nota

El ejemplo siguiente se basa en esta definición de grupo de metadatos:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Name" type="text" name="okp:consulting.name"/>
    <input label="Date" type="date" name="okp:consulting.date" />
    <checkbox label="Important" name="okp:consulting.important"/>
    <textarea label="Comment" name="okp:consulting.comment"/>
  </property-group>
</property-groups>

• El grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;

import java.util.ArrayList;
import java.util.List;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.bean.form.FormElement;
import com.openkm.bean.form.Input;

public class Test {
    public static void main(String[] args) {
        try {
            List<FormElement> fElements = OKMPropertyGroup.getInstance().getProperties(null, "/okm:root/logo.pdf","okg:consulting");
            for (FormElement fElement : fElements) {
                if (fElement.getName().equals("okp:consulting.name")) {
                    Input name = (Input) fElement;
                    name.setValue("new value");
                }
            }

            OKMPropertyGroup.getInstance().setProperties(null, "/okm:root/logo.pdf", "okg:consulting", fElements);

            // Same modification with only affected FormElement
            fElements = new ArrayList<>();
            Input name = new Input();
            name.setName("okp:consulting.name");
            name.setValue("new value");
            fElements.add(name);
            OKMPropertyGroup.getInstance().setProperties(null, "/okm:root/logo.pdf","okg:consulting", fElements);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setPropertySimple

Descripción:

Método	Valores de retorno	Descripción
setPropertySimple(String token, String nodeId, String propGroup, String propName, String propValue)	void	Cambia el valor de un campo del grupo de metadatos de un nodo.

Nota

No es obligatorio establecer todos los valores de los campos en el parámetro properties; basta con incluir los campos cuyos valores desee cambiar.

Nota

El ejemplo siguiente se basa en esta definición de grupo de metadatos:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Name" type="text" name="okp:consulting.name"/>
    <input label="Date" type="date" name="okp:consulting.date" />
    <checkbox label="Important" name="okp:consulting.important"/>
    <textarea label="Comment" name="okp:consulting.comment"/>
  </property-group>
</property-groups>

Nota

Para añadir varios valores en un campo de metadatos de tipo múltiple como este:

<select label="Multiple" name="okp:consulting.multiple" type="multiple">
  <option label="One" value="one"/>
  <option label="Two" value="two"/>
  <option label="Three" value="three" />
</select>

Debe hacer:

"one;two";

Donde “one” y “two” son valores válidos y el carácter “;” se usa como separador.

• El grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            OKMPropertyGroup.getInstance().setPropertySimple(null, "/okm:root/logo.pdf","okg:consulting", "okp:consulting.name", "new name");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setPropertiesSimple

Descripción:

Método	Valores de retorno	Descripción
setPropertiesSimple(String token, String nodeId, String grpName, Map<String, String> properties)	void	Cambia los valores del grupo de metadatos de un nodo.

Nota

No es obligatorio establecer todos los valores de los campos en el parámetro properties; basta con incluir los campos cuyos valores desee cambiar.

Nota

El ejemplo siguiente se basa en esta definición de grupo de metadatos:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Name" type="text" name="okp:consulting.name"/>
    <input label="Date" type="date" name="okp:consulting.date" />
    <checkbox label="Important" name="okp:consulting.important"/>
    <textarea label="Comment" name="okp:consulting.comment"/>
  </property-group>
</property-groups>

Nota

Para añadir varios valores en un campo de metadatos de tipo múltiple como este:

<select label="Multiple" name="okp:consulting.multiple" type="multiple">
  <option label="One" value="one"/>
  <option label="Two" value="two"/>
  <option label="Three" value="three" />
</select>

Debe hacer:

properties.put("okp:consulting.multiple", "one;two");

Donde “one” y “two” son valores válidos y el carácter “;” se usa como separador.

• El grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;

import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.util.ISO8601;

public class Test {
    public static void main(String[] args) {
        try {
            Map<String, String> properties = new HashMap<>();
            properties.put("okp:consulting.name", "new name");

            // Date fields must be saved with basic ISO 8601 format
            properties.put("okp:consulting.date", ISO8601.formatBasic(Calendar.getInstance()));
            OKMPropertyGroup.getInstance().setPropertiesSimple(null, "/okm:root/logo.pdf","okg:consulting", properties);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertyGroupForm

Descripción:

Método	Valores de retorno	Descripción
getPropertyGroupForm(String token, String grpName)	List	Recupera una lista con la definición de todos los elementos del grupo de metadatos.

Nota

El método se utiliza normalmente para mostrar elementos de formulario vacíos para crear nuevos valores de metadatos.

• El grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.bean.form.FormElement;

public class Test {
    public static void main(String[] args) {
        try {
            for (FormElement fe : OKMPropertyGroup.getInstance().getPropertyGroupForm(null, "okg:consulting")) {
                System.out.println(fe);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

hasGroup

Descripción:

Método	Valores de retorno	Descripción
hasGroup(String token, String nodeId, String grpName)	boolean	Devuelve un booleano que indica si el nodo tiene o no un grupo de metadatos.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            boolean found = OKMPropertyGroup.getInstance().hasGroup(null, "/okm:root/logo.pdf", "okg:consulting");
            System.out.println(found);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSuggestions

Descripción:

Método	Valores de retorno	Descripción
getSuggestions(String token, String nodeId, String grpName, String propName)	List	Recupera una lista de valores sugeridos para un campo de metadatos.

Precaución

El parámetro propName debe ser de tipo campo Select de metadatos.

Nota

Más información en cCrear su propio analizador de sugerencias y Campo Select de metadatos .

Nota

El ejemplo siguiente se basa en esta definición de grupo de metadatos:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Technology" name="okg:technology">
    <select label="Type" name="okp:technology.type" type="multiple">
      <option label="Alfa" value="t1"/>
      <option label="Beta" value="t2" />
      <option label="Omega" value="t3" />
    </select>
    <select label="Language" name="okp:technology.language" type="simple">
      <option label="Java" value="java"/>
      <option label="Python" value="python"/>
      <option label="PHP" value="php" />
    </select>
    <input label="Comment" name="okp:technology.comment"/>
    <textarea label="Description" name="okp:technology.description"/>
    <input label="Link" type="link" name="okp:technology.link"/>
  </property-group>
</property-groups>

Ejemplo:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            for (String value : OKMPropertyGroup.getInstance().getSuggestions(null, "/okm:root/logo.pdf","okg:technology", "okp:technology.language")) {
                System.out.println(value);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

registerDefinition

Descripción:

Método	Valores de retorno	Descripción
registerDefinition(String token, String pgDef)	void	Establece la definición XML de los grupos de metadatos en el archivo $TOMCAT_HOME/PropertyGroups.xml.

Precaución

El método solo puede ser ejecutado por un superusuario (usuario miembro de ROLE_ADMIN).

Tenga en cuenta que cambiar los metadatos se realiza en dos pasos: primero modificando el archivo PropertyGroups.xml y después registrando el cambio. Para el segundo paso, consulte el método registerPropertyGroups en la clase OKMRepository para ello.

Ejemplo:

package com.openkm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.commons.io.IOUtils;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        InputStream is = null;
        try {
            is = new FileInputStream("/home/files/PropertyGroups.xml");
            String pgDef = IOUtils.toString(is);
            OKMPropertyGroup.getInstance().registerDefinition(null, pgDef);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(is);
        }
    }
}