Monthly Archives: agosto 2014

Entrando por la “puerta de atrás” en Alfresco

Entre la arquitectura de funcionamiento de Alfresco se encuentra la capa de persistencia donde se guardan los datos necesarios para realizar las operaciones y tareas que hacen falta. Esta capa se divide a su vez en 4 elementos, la parte de configuración con ficheros de propiedades, la parte de almacenamiento de los documentos, el almacenamiento de los índices y el almacenamiento de las propiedades y otros valores (incluidas también configuraciones).

Esta última parte es guardada en un SGBD o Sistema de Gestión de Base de Datos (relacional) que puede ser MySQL, PostgreSQL, Oracle, SQL-Server, etc.
A veces, por determinadas circunstancias o necesidades debemos hacer uso de consultas directas a la base de datos para obtener datos, también sería posible modificar estos datos directamente pero no es aconsejable debido a que el control de lo que se guarda, modifica y borra lo tiene exclusivamente la aplicación de Alfresco. Como digo, en determinadas ocasiones es una posibilidad más el poder consultar directamente a la base de datos determinados datos que sean necesarios y de esta forma evitar pasar por la aplicación, por ejemplo en casos de que el servidor de aplicaciones (Alfresco) no levante correctamente, en casos de pérdidas de documentos y datos o de integridad que paren el servidor de aplicaciones o para monitorización por parte de algún programa externo.
Evidentemente este tipo de acciones son muy dependientes de la versión del esquema (schema) de Alfresco ya que este cambia con cada versión si bien, al estar en la capa del modelo de datos (no confundir con el modelo documental) cambia relativamente poco, sobre todo determinadas tablas muy importantes. De todas formas, es bueno tener el mapa de tablas y relaciones entre ellas para poder realizar bien cualquier consulta y tener la seguridad de que los datos proporcionados son coherentes. Hay que tener en cuenta que este modelo ha ido creciendo desde las primeras versiones, por ejemplo en la versión 2.1.0 Community había 24 tablas con el prefijo ALF, en la 3.4.11 había 46 y en la versión 4.2.2 hay 48 (solo dos tablas más con prefijo ALF). No se han tenido en cuenta las tablas usadas para el repositorio AVM, para el motor jBMP ni las utilizadas para Activiti.
Versión 2.1.0

Versión 2.2.6
Versión 3.4.11

Versión 4.2.2

Seguidamente voy a poner una serie de ejemplos en SQL lo más estándar posible, si bien, incluso lo más básico es dependiente también de la base de datos que use Alfresco en determinado momento. Estos son solo unos cuantos ejemplos de extracción de datos a través de la base de datos pero se pueden realizar muchas más operaciones de consulta según la necesidad concreta de cada uno.

Stores disponibles

Aunque no es muy necesario sí que a veces resulta interesante saber cuantos “almacenes” tiene nuestro repositorio, esto se podría realizar con la siguiente consulta:
SELECT * 
FROM alf_store;

Nodos disponibles

En Alfresco casi cualquier cosa es un nodo, un usuario, un grupo, una carpeta o un documento por ejemplo, para sacar los nodos disponibles podemos hacerlo como:
SELECT * 
FROM alf_node;
Pero no vamos a quedarnos aquí, podemos saber a que almacén pertenece cada nodo como:
SELECT uuid, protocol, identifier, alf_store.version 
FROM alf_node, alf_store
WHERE alf_node.store_id = alf_store.id;
Y ahora vamos a realizar una consulta que nos devuelva el nodo con la nomenclatura del tipo NodeRef, pero para esto ya nos encontramos con problemas, con la misma concatenación de campos, ya que dependerá de cada sistema de base de datos:
— Para Oracle
SELECT protocol || ‘://’ || identifier || ‘/’ || uuid AS nodeRef, 
alf_store.version, local_name   
FROM alf_node, 
alf_store, 
alf_qname   
WHERE alf_node.store_id = alf_store.id
AND   alf_node.type_qname_id = alf_qname.id;
— Para MySQL
SELECT CONCAT(protocol, ‘://’, identifier, ‘/’, uuid) AS nodeRef, 
alf_store.version, 
local_name   
FROM alf_node, 
alf_store, 
alf_qname   
WHERE alf_node.store_id = alf_store.id
AND   alf_node.type_qname_id = alf_qname.id;
— Para SQL-Server
SELECT protocol + ‘://’ + identifier + ‘/’ + uuid AS nodeRef, 
alf_store.version, 
local_name   
FROM alf_node, 
alf_store, 
alf_qname   
WHERE alf_node.store_id = alf_store.id
AND   alf_node.type_qname_id = alf_qname.id;

Extrayendo metadatos

La tabla más importante en Alfresco es alf_data_properties, esta es la que mantiene los valores de todas la propiedades de todos los nodos disponibles y es la que es más utilizada para devolver información ya que generalmente casi cualquier dato en Alfresco será una propiedad de un nodo. Por tanto, las siguientes tablas podríamos decir que son las básicas a la hora de realizar consultas directas:
  • alf_store : Guarda la información de los almacenes disponibles
  • alf_node : Guarda los nodos, aquí obtenemos el uuid que corresponde (con otros campos) al llamado NodeRef (referencia de nodo)
  • alf_qname : En versiones posteriores a 2.1 (2.2.x, 3.1.x, 3.2.x, 3.4.x, etc.) contiene los nombres identificativos de los tipos de propiedades, en versiones anteriores se almacenaba en un campo llamado alf_qname de la tabla alf_node_properties
  • alf_node_properties : Sin duda la tabla más importante a la hora de extraer datos en Alfresco, guarda los valores de las propiedades de los modelos de datos documentales de Alfresco, incluyendo los datos de las carpetas, documentos, usuarios, grupos, etc.
Con estas y alguna más de forma auxiliar podremos obtener la información necesaria.
Es interesante el uso de la tabla alf_qname (en versiones 2.2.x en adelante) porque con esta podemos posteriormente determinar que tipo de propiedad queremos, por tanto es buena idea tener un listado de los posibles nombres cualificados posibles:
— Versiones 2.2.x y siguientes
SELECT
FROM    alf_qname;
— Versiones 2.1.x
SELECT alf_node_properties.qname 
FROM alf_node_properties;
Veamos dos ejemplos sobre el uso de extraer propiedades, uno sobre los usuarios y otro sobre los documentos:
En ocasiones necesitamos saber los datos de un usuario en particular, las siguientes consultas nos devuelven un listado de usuarios:
— Versiones 2.2.x y siguientes
SELECT
    alf_node_properties.node_id,
    alf_node_properties.string_value
FROM
    alf_node_properties,
    alf_qname
WHERE
    alf_node_properties.qname_id = alf_qname.id
AND
    alf_qname.local_name = ‘userName’;
— Versiones 2.1.x
SELECT
    alf_node_properties.node_id,
    alf_node_properties.string_value 
FROM
    alf_node_properties 
WHERE
    alf_node_properties.qname = ‘{http://www.alfresco.org/model/content/1.0}userName’;
Y las siguientes (según la versión de Alfresco) nos devolverán la propiedades de un usuario concreto (sustituir NOMBRE-DEL-USUARIO por el nombre del usuario a buscar)
— Versiones 2.2.x y siguientes
SELECT
    alf_node_properties.node_id,
    alf_qname.local_name,
    alf_node_properties.string_value
FROM
    alf_node_properties,
    alf_qname
WHERE
    alf_node_properties.qname_id = alf_qname.id
AND
    alf_node_properties.node_id = (
        SELECT
            alf_node_properties.node_id
        FROM
            alf_node_properties,
            alf_qname
        WHERE
            alf_node_properties.qname_id = alf_qname.id
        AND
            alf_qname.local_name = ‘userName’
        AND
            alf_node_properties.string_value = ‘admin’
        );
— Versiones 2.1.x
SELECT
    alf_node_properties.node_id,
    alf_node_properties.qname, 
    alf_node_properties.string_value 
FROM
    alf_node_properties 
WHERE
    alf_node_properties.node_id = (
        SELECT
            alf_node_properties.node_id
        FROM
            alf_node_properties 
        WHERE
            alf_node_properties.qname = ‘{http://www.alfresco.org/model/content/1.0}userName’
        AND
            alf_node_properties.string_value = ‘NOMBRE-DEL-USUARIO’
        );
Y por último una aplicación real cuando se necesita el nombre que Alfresco ha puesto en el repositorio. En casos de recuperación de documentos necesitamos saber donde está guardado el fichero en el repositorio a partir del nombre del documento guardado en Alfresco. Esta consulta nos devuelve esta información a partir del nombre del documento. Es para la versión 3.4.x y 4.x
— Versiones 3.4.x y 4.x
SELECT alf_node_properties.node_id,
alf_node_properties.string_value,
alf_content_url.content_url
FROM alf_node_properties,
alf_qname,
alf_content_data,
alf_node_properties,
alf_content_url
WHERE alf_node_properties.string_value = ‘NOMBRE-DEL-DOCUMENTO’ 
AND alf_node_properties.qname_id = alf_qname.id 
AND alf_qname.local_name = ‘name’ 
AND alf_content_data.id = alf_node_properties.long_value 
AND alf_node_properties.node_id = alf_node_properties.node_id 
AND alf_node_properties.long_value = alf_content_data.id 
AND alf_content_data.content_url_id = alf_content_url.id;