vendredi 10 juin 2011

Guide de conception d'un Dashlet Share

Introduction

Alfresco Share est une interface web pour Alfresco qui peut être personnalisée de nombreuses façons. Bien sûr, la solution étant open-source, vous pouvez regardez chaque partie du code, et le modifier pour obtenir le comportement de votre choix. Mais il existe certains « points d’extension » qui vous permettent de personnaliser Share simplement, tout en vous assurant que vos développements spécifiques continueront de fonctionner dans les futures versions d’Alfresco :
  • Les themes
  • Les dashlets de tableau de bord (d’utilisateurs, ou de sites collaboratifs)
  • Les actions dans la page des documents (document library) à la fois de l’entrepôt, mais également des sites
  • Les composants de la page d’administration
  • Les formulaires
Cet article va vous guider tout au long de la conception d’un dashlet spécifique pour Alfresco Share, qui pourrait être inséré au sein du tableau de bord d’un utilisateur ou d’un site collaboratif.


Prérequis

Pour suivre ce tutorial dans de bonnes conditions, vous devriez connaître le framework “Webscripts”. Si ce n’est pas le cas, vous pouvez en avoir un aperçu aux pages suivantes :

http://wiki.alfresco.com/wiki/Web_Scripts (noter que l’exemple “Hello World” qui figure sur cette page n’est qu’un simple webscript, pas un dashlet).

http://www.springsurf.org/sites/1.0.0.M3/spring-webscripts/spring-webscripts-documentation/reference/index.html


Ressources

Will abson (http://blogs.alfresco.com/wp/wabson/ ) a développé un ensemble d’add-ons (développements spécifiques) pour Alfresco Share. C’est hébergé sur Google Code, et cela s’appelle “Share Extras” :

http://code.google.com/p/share-extras/

Ces modules sont totalement Open Source, vous pouvez télécharger le code, les compiler, les installer et les tester. Si vous souhaitez simplement voir à quoi ils ressemblent, vous pouvez télécharger directement les packages, les installer rapidement et visualiser le résultat.

Cet article va montrer la construction de trois dashlets qui figurent dans le SVN de Share Extras : HelloWorld1, HelloWorld2, HelloWorld3.



Environnement

Voici ce dont vous avez besoin pour suivre ce guide dans les meilleures conditions :

  • Une instance Alfresco 3.4 sur laquelle vous disposez de droits d’administration
  • Idéalement, vous disposez du code source de Share Extras (par SVN checkout) au sein de votre environnement de développement (j’utilise Eclipse)
  • Quelques plugins Eclipse peuvent vous faciliter la vie, notamment le Web Tools plugin, ou encore le plugin FreeMarker. N’oubliez pas de vérifier régulièrement si des mises-à-jour sont disponibles pour ces plugins

Nous allons décrypter l’anatomie des trois dashlets « HelloWorld » de Will Abson, vous avez le choix de récupérer les projets associés sur le SVN, ou alors utiliser le projet zippé « Sample dashlet » (toujours sur Share Extras) et de construire chaque dashlet depuis zéro à partir des indications de cet article.



L'objectif

Notre objectif est de créer un dashlet spécifique qu’un utilisateur pourrait ajouter à son tableau de bord, ou qu’un gestionnaire de site pourrait ajouter au tableau de bord du site. Le dashlet sera très simple, en affichant un message d’exemple.












Pourquoi voir trois différents dashlets faisant la meme chose ? En fait, nous allons partir de l’implémentation technique de cet objectif la plus simple (HelloWorld 1), et ensuite visualiser les spécificités des implémentations un peu plus complexes (HelloWorld 2 et HelloWorld 3).

A suivre dans de (très) prochains articles, l'implémentation de ces trois dashlets ...

Aucun commentaire:

Enregistrer un commentaire