Esta guía fue hecha por Adrián Jímenez Vega (ajv) y editada por Pablo Conejeros Garrido (Sphinx)
En este caso como usuario me preguntaba a menudo cómo hacer para crear tipos de contenido personalizados y buscando información en foros alguna vez no me ha quedado muy claro, por eso me he propuesto realizar una mini-guía con el fin de que cualquiera pueda crearse sus tipos de contenido, según sus necesidades. Esta no pretende abarcar todos los aspectos relacionados con la creación de tipos de contenido, únicamente los más básicos y comunes con el fin de que cualquiera pueda "atreverse" con esto de crear nuevos tipos de contenido.
Trabajando con Tipos de contenido personalizadosIntroducciónAlfresco es una plataforma flexible para desarrollar aplicaciones de gestión de contenidos. El primer paso en el proceso de diseñar una aplicación de gestión de contenido es crear el modelo de contenido.
El modelo de contenido provisto por Alfresco es bastante detallado. De hecho, para necesidades de gestión documental básicas probablemente sea suficiente. No obstante, se estaría desaprovechando la potencia y funcionalidad de tener un modelo personalizado a las necesidades del negocio.
Esta mini-guía pretende enseñar a crear un modelo de contenido personalizado. No obstante, no profundiza ni aborda todos los conceptos. Pretende ser una guía introductoria para que cualquiera pueda crearse sus propios tipos de contenido.
¿Qué es un tipo de contenido?Los tipos presentan un gran parecido a las clases en el mundo de orientación a objetos. Pueden usarse para representar objetos de nuestro modelo de negocio: Tienen propiedades y pueden heredar de un tipo base. Contenido (cm:content) , Persona (cm:person) o Carpeta (cm:folder) son tres tipos importantes definidos por Alfresco. Los tipos personalizados están limitados únicamente por nuestra imaginación y requerimientos de negocio. Factura, Receta médica o Película serían ejemplos de tipos personalizados.
¿Cómo se crean?Los pasos a realizar cada vez que queramos incorporar un nuevo tipo de contenido en Alfresco son:
- Definición el tipo de contenido personalizado.
- Extender el modelo de contenido con el nuevo tipo de contenido.
- Configurar el cliente Web para que sea capaz de reconocer el nuevo tipo de contenido.
- Reiniciar Alfresco para que los cambios sean efectivos.
- Crear contenido basado en el nuevo tipo de contenido.
A continuación explicaremos paso a paso cada uno de los puntos para llegar a tener disponible nuestro nuevo tipo de contenido. Para ello, nos “crearemos” la necesidad de disponer un nuevo tipo de contenido, llamado “ajv:carpeta”, que iremos desarrollando en esta mini-guía.
El Ejemplo1.- Definición del tipo de contenido personalizado.Consiste en determinar qué propiedades, aspectos y asociaciones conforman nuestro tipo de contenido personalizado. En nuestro caso, nuestra “carpeta” además de las propiedades básicas de un espacio, queremos que tenga las siguientes:
Tipo**********Nombre**********EtiquetaTexto (text)******Mail**************eMail
Texto (text)******Proyecto*********Proyecto
Fecha (date)******Fecha************Fecha
Podemos reutilizar aspectos existentes en el modelo de contenido de Alfresco, para incorporar por defecto propiedades que ya están encapsuladas en dichos aspectos.
2.- Extender el modelo de contenido con el nuevo tipo de contenido.Una vez definido nuestro tipo de contenido, lo siguiente es extender el modelo de contenido con una representación XML de nuestro tipo de contenido.
Estos XML tienen una estructura similar a esta:
Fichero ajvModel.xml
- <
?xml version="1.0" encoding="UTF-8"?>
<!-- Modelo personalizado -->
<model name="ajv:modeloPersonalizado" xmlns="http://www.alfresco.org/model/dictionary/1.0">
<!-- Optional meta-data about the model -->
<description>Modelo personalizado
<author>Adrian E. Jimenez Vega
<version>1.0
<imports>
<!-- Importamos definiciones de Alfresco, concretamente el diccionario de datos y el modelo de contenido de Alfresco -->
<import uri="http://www.alfresco.org/model/dictionary/1.0" prefix="d"/>
<!-- Import Alfresco Content Domain Model Definitions -->
<import uri="http://www.alfresco.org/model/content/1.0" prefix="cm"/>
</imports>
<!-- Registramos el Nuevo namespaces que se utilizara en este modelo -->
<!-- NOTE: The following namespace custom.model should be changed to reflect your own namespace -->
<namespaces>
<namespace uri="modelo.miniguia" prefix="ajv"/>
</namespaces>
<types>
<!-- Definicion de los tipos de contenido personalizados -->
<!-- Definicion del tipo de contenido ajv:carpeta -->
<type name="ajv:carpeta">
<title>Carpeta de Proyecto
<parent>cm:folder
<properties>
<property name="ajv:Mail">
<title>eMail
<type>d:text
</property>
<property name="ajv:Proyecto">
<title>Proyecto
<type>d:text
</property>
<property name="ajv:Fecha">
<title>Fecha
<type>d:date
</property>
</properties>
</type>
</types>
<aspects>
<!-- Definicion de los aspectos personalizados -->
</aspects>
</model>
Si nos fijamos, el tipo que hemos definido hereda del tipo cm:folder (<parent>cm:folder</parent>), es decir, contiene todas las propiedades y funcionalidad de un espacio, pero además contiene las propiedades que hemos especificado nosotros.
Este fichero lo llamaríamos como quisiéramos, por ejemplo ajvModel.xml, y lo guardaríamos en el directorio extension (En Tomcat este directorio se encuentra en ...\shared\classes\alfresco\extension para JBoss el directorio está en ...\server\default\conf\alfresco\extension).
Hay que tener en cuenta que el XML que hemos creado para definir nuestro modelo de contenido, debe ir acompañado de un fichero de contexto que se encargue de incluir en la lista modelos el fichero que acabamos de crear.
Para ello, en el mismo directorio extension debemos crear un fichero de contexto similar a este:
Fichero ajvModel-context.xml
- <
?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>
beans>
!-- Registro de nuevos modelos -->
<bean id="extension.dictionaryBootstrap" parent="dictionaryModelBootstrap" depends-on="dictionaryBootstrap">
<property name="models">
<list>
<value>alfresco/extension/ajvModel.xml</value>
</list>
</property>
</bean>
</beans>
Como se observa, incluimos el modelo ajvModel.xml en la lista de modelos (models) para que se cargue en el diccionario de Alfresco al arrancar.
Este fichero es importante que termine en –context.xml ya que es la terminación que Alfresco reconoce para interpretar los ficheros de contexto.
3.- Configurar el cliente Web para que sea capaz de reconocer el nuevo tipo de contenido.Ahora debemos asegurarnos que el cliente Web reconoce el nuevo tipo de contenido y visualiza las propiedades en la pantalla pertinente. Para ello, debemos ir al fichero web-client-config-custom.xml que se encuentra en el mismo directorio extension.
Debemos incluir los siguientes fragmentos:
3.a) Si queremos que el nuevo tipo aparezca como opción de tipo de contenido en el wizard de reglas de contenido, deberemos incluir lo siguiente:
<config evaluator="string-compare" condition="Action Wizards">
<subtypes>
<type name="ajv:carpeta"/>
</subtypes>
</config>
Esto hará que cuando queramos crear una regla de contenido cuya condición se base en el tipo de contenido del objeto que dispara la regla, nos aparezca nuestro tipo personalizado como una posible condición.
3.b) Si queremos tener la posibilidad de convertir los espacios existentes tendremos que añadir lo siguiente :
<config evaluator="string-compare" condition="Action Wizards">
<especialise-types>
<type name="ajv:carpeta"/>
</especialise-types>
</config>
También se puede reutilizar el config evaluator del paso 3.a para englobar tanto los subtypes como los specialize-types.
3.c) Si queremos que nos aparezca el nuevo tipo de espacio en el asistente de creación de espacio, debemos incluir las siguientes líneas en web-client-config-custom.xml:
<config evaluator="string-compare" condition="Space Wizards">
<folder-types>
<type name="ajv:carpeta"/>
</folder-types>
</config>
3.d) Por último, lo más probable es que nos interese editar las propiedades que hemos definido (si no, para qué íbamos a crear un tipo de contenido con propiedades nuevas?). Para ello:
<config evaluator="node-type" condition="ajv:carpeta">
<property-sheet>
<show-property name="ajv:Mail"/>
<show-property name="ajv:Proyecto"/>
<show-property name="ajv:Fecha"/>
</property-sheet>
</config>
Todas las líneas de configuración del cliente Web deben estar colocadas antes de la última línea </alfresco-config>
4.- Reiniciar Alfresco. 5.- Crear un espacio basado en el nuevo tipo de contenido.Para crear un nuevo espacio
- Crear / Asistente Avanzado de Espacio
- Desde cero
- A la hora de seleccionar qué tipo de espacio queremos, nos debería aparecer un nuevo tipo de espacio llamado “Carpeta de Proyecto” (que es el título que le hemos dado a nuestro tipo de contenido).
- Introducimos las propiedades básicas del espacio y pulsamos Finalizar.
Para editar las propiedades específicas de nuestro espacio:
- Ver detalles del espacio.
- En el marco de propiedades, en el borde superior derecho, hay un botón para editar las propiedades. Nos deberían aparecer las propiedades de nuestro espacio, disponible para editarlas.
NOTASLo más habitual no es crear un tipo de contenido que herede de cm:folder, sino que herede de tipo cm:content. Generalmente, los espacios que vienen en Alfresco satisfacen todas las necesidades de los usuarios. Es más usual que nos encontremos con la necesidad de definir un nuevo tipo de contenido que encapsule propiedades adicionales. En estos casos, las únicas modificaciones que habría que tener en cuenta con respecto a lo anterior es:
1- Definir el tipo de contenido de manera que herede de cm:content.
- <
parent>cm:content
2- La configuración del cliente Web respecto a listar el tipo de contenido en el asistente de espacios (apartado 3.b de la mini-guía), no tiene sentido para contenidos. En su lugar, deberíamos configurar algo como esto:
<config evaluator="string-compare" condition="Content Wizards">
<content-types>
<type name="ajv:contenido"/>
</content-types>
</config>
De esta forma, a la hora de crear un contenido, en la lista desplegable de tipo, nos aparecería nuestro nuevo tipo de contenido.
Pues con esto en principio ya tendríamos para poder crear los tipos de contenido que se necesiten
Espero que les resulte útil.
Hasta pronto!!
