8 de julio de 2016

:: Alfresco. Creación de un webscript sencillo (Tip conceptual)

Los WebScripts son elementos que proporciona Alfresco como una forma de desarrollar funcionalidades. De esta manera nos permiten construir servicios web para la gestión de contenidos accesibles vía HTTP.

Estos WebScripts pueden crearse haciendo uso de JavaScript y Freemarker.

Tipos de WebSripts

Podemos distinguir dos tipos:
Webcripts de datos: Estos encapsulan el acceso o modificación del contenido del repositorio, proporcionando un ainterfaz a aplicaciones cliente. Alfresco incluye algun ejemplo de Web Scripts de datos que sirven para: añadir tags a los documentos, actividades, etc.
   
Webscripts de presentación: Permiten construir interfaces de usuario como por ejemplo: dashlets para Alfresco, portlets para un portal (siguiendo el estándar JSR-168), un portal Web o una aplicación a medida.

A continuación se muestra la arquitectura de un webscript en Alfresco

Elementos de un webscripts

Documento de descripción:  identifica la URI que instancia el script, un nombre corto, descripción y requisitos de autenticación y transacciones.
   
Script: actúa de controlador. Escrito en Javascript puede realizar tareas como consultas al repositorio de Alfresco, actualizar el repositorio, etc. El script tiene acceso a todos los argumentos de la URI, a los servicios de Alfresco y a los datos del repositorio.
   
Plantillas o vistas de respuesta. Normalmente desarrolladas en Freemaker, encargadas de renderizar la respuesta en el formato adecuado: HTML, ATOM, XML, RSS, JSON, CSV, etcétera.

Pasos para crear un webscript

.- Nos loguearemos en Alfresco y accederemos al "Repositorio" > "Diccionario de datos" > "WebScripts"
Para extender la funcionalidad de un webscript existente, copiaremos los ficheros originales y los copiaremos en la carpeta "Repositorio > Diccionario de datos > Extensiones de web scripts"

.- Crearemos el descriptor del WebScript (fichero XML), al que llamaremos: "hello.get.desc.xml" con el siguiente contenido:
< webscript >
  < shortname >Hola< /shortname >
  < description >Ejemplo de webScript< /description >
  < url >/hello< / url >
< /webscript >
.- Crearemos la plantilla para el WebScript (fichero ftl), al que llamaremos "hello.get.html.ftl" con el siguiente contenido:
Hola que tal !!!

.- Para registrar nuestro WebScript en Alfresco, abriremos la siguiente url en una nueva pestaña: "http://localhost:8080/alfresco/service/index"
Nos pedirá las credenciales de acceso y si son correctas nos mostrará un listado de los tipos de WebScripts disponibles.


.- Seleccionamos la entrada "Browse All Scripts" y buscaremos si aparece nuestro webscript recientemente creado. A continuación pulsaremos el botón "Registrar todos"


.- Para comprobar el funcionamiento de este WebScript invocaremos a la siguiente url: "http://localhost:8080/alfresco/service/hello"

El nombrado de los ficheros es muy importante:
hello.get.desc.xml
  • hello: id del servicio (previamente podría llevar un descriptor del paquete)
  • get: método utilizado (GET)
  • desc.xml: Indica a Alfresco que se trata de un descriptor de WebScripts

hello.get.html.ftl
  • hello: id del servicio (previamente podría llevar un descriptor del paquete)
  • get: método utilizado (GET)
  • html: formato de respuesta
  • .ftl: plantilla freemaker

Más información: http://www.juntadeandalucia.es/servicios/madeja/contenido/recurso/45

No hay comentarios:

Publicar un comentario

Déjanos tu comentario

:: Cookies de nuestra página web. ¿Para qué sirve cada una?

A menudo una pregunta que nos hacen es qué cookies se están utilizando en mi página y para qué sirven. Para ver las cookies, podemos selecci...