Definición XML de metadatos

Los metadatos de la aplicación se basan en una definición XML formal. El DTD (Document Type Definition) define la estructura y los elementos y atributos válidos de un documento XML.

Esqueleto XML básico

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 3.10//EN"
                                 "http://www.openkm.com/dtd/property-groups-3.10.dtd">
<property-groups>

</property-groups>

El DOCTYPE es una definición formal de una DTD. En el ejemplo anterior, el DOCTYPE es property-groups-3.10.dtd.
El XML empieza con la etiqueta y termina con . Dentro de esta jerarquía se definen los grupos de metadatos.

Definición de un grupo de metadatos

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 3.10//EN"
                                 "http://www.openkm.com/dtd/property-groups-3.10.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">

  </property-group>
</property-groups>

Cada bloque …</property-group identifica el inicio y el fin de una nueva definición de grupo de metadatos.
Cada grupo de metadatos tiene una etiqueta (label), utilizada por la interfaz de usuario: Consulting.
Cada grupo de metadatos tiene un nombre único, okg:consulting.
El nombre del grupo de metadatos siempre debe comenzar por “okg:” (OpenKM Group).
No deben utilizarse caracteres especiales en el nombre.

Atributo	Descripción	Obligatorio
label	El texto que se muestra como etiqueta en la interfaz de usuario.	true
name	Identificador único del campo. Dos grupos de metadatos no pueden tener el mismo nombre. El nombre debe ser único. El nombre debe comenzar por “okg:”. Utilice únicamente letras, números y guion bajo: “0-9a-zA-Z_”.	true
visible	Muestra u oculta el metadato. Valores permitidos: - true. - false. Por defecto, los metadatos son visibles.	false
readonly	Los valores de los metadatos no pueden modificarse desde la interfaz de usuario, solo desde la API. Los valores permitidos son: - true. - false. Por defecto los metadatos son modificables.	false
defaultValueClassName	Establece una clase JAVA personalizada para fijar los valores iniciales por defecto.	false

Ejemplo básico

Tipos de campo disponibles:

Checkbox
Input
Iframe
Select
Separator
Suggestbox
Text
TextArea

Más información sobre los elementos de tipo de campo en Campos de metadatos

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 3.10//EN"
                                 "http://www.openkm.com/dtd/property-groups-3.10.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Input label" name="okp:consulting.input1" />
    <separator label="Separator label" name="okp:consulting.separator" />
    <input label="Input label" name="okp:consulting.input2" />
  </property-group>
</property-groups>

Utilizar un DTD del sistema de archivos

Si el servidor no tiene acceso a Internet, el archivo DTD debe ser accesible de algún modo; por ejemplo, puede almacenar una copia en su servidor de aplicaciones.

<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 3.10//EN"
                                 "file:///home/openkm/property-groups-3.10.dtd">

En el ejemplo, /home/openkm/property-groups-3.10.dtd es la ruta del sistema de archivos al archivo.

Cómo se almacenan los metadatos en OpenKM

Cuando registra una nueva definición de metadatos en OpenKM, los valores de los metadatos se almacenan en dos tablas distintas: una para los valores actuales de los metadatos y otra para los valores históricos.

Ejemplo:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 3.10//EN"
                                 "http://www.openkm.com/dtd/property-groups-3.10.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Input label" name="okp:consulting.input1" />
    <separator label="Separator label" name="okp:consulting.separator" />
    <input label="Input label" name="okp:consulting.input2" />
  </property-group>
</property-groups>

Tras registrar la definición de metadatos anterior, se crearán dos tablas con estas columnas:

OKM_PGRP_CUR_CONSULTING (se utiliza para los valores actuales de los metadatos)
- RGT_UUID: ID del nodo que tiene este metadato
- RGT_PRO_INPUT1: valor de la propiedad okp:consulting.input1
- RGT_PRO_INPUT2: valor de la propiedad okp:consulting.input2
- RGT_PRO_SEPARATOR: valor de la propiedad okp:consulting.separator
OKM_PGRP_HIS_CONSULTING (se utiliza para los valores históricos de los metadatos)
- RGT_UUID: ID del nodo que tiene este metadato
- RGT_VERSION: ID de la versión relacionada
- RGT_PRO_INPUT1: valor de la propiedad okp:consulting.input1
- RGT_PRO_INPUT2: valor de la propiedad okp:consulting.input2
- RGT_PRO_SEPARATOR: valor de la propiedad okp:consulting.separator

Tamaño de columna por defecto según el tipo:

Tipo	Tamaño
Input	128 caracteres
Select	128 caracteres
SuggestBox	128 caracteres
TextArea	256 caracteres

Si tiene valores de metadatos más grandes, debe aumentar el tamaño de la columna mediante el atributo “dbColumnSize”. Vea el ejemplo siguiente:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 3.10//EN"
                                 "http://www.openkm.com/dtd/property-groups-3.10.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Input label" name="okp:consulting.input1" dbColumnSize="256"/>
    <separator label="Separator label" name="okp:consulting.separator" />
    <input label="Input label" name="okp:consulting.input2" dbColumnSize="512"/>
  </property-group>
</property-groups>