Manuel d'intégration

Installation

  • Arrêter le serveur
  • Télécharger les jars du plugin et ajouter-les (ametys-plugin-dashboard-1.2.0.jar et ametys-plugin-dashboard-resources-1.2.0.jar)  dans le répertoire WEB-INF/lib de votre application Ametys

  • Ajouter le bouton permettant d'ouvrir l'outil de Tableau de bord dans le fichier WEB-INF/params/cms-ribbon-default.xml. L'identifiant du bouton est org.ametys.dashboard.Tool.
    Il est conseillé de l'ajouter dans l'onglet Accueil, dans le groupe "Outils"

<tabs>
	<tab label="RIBBON_TABS_TAB_HOME_LABEL">
    	<groups>
			[...]
			<group label="RIBBON_TABS_TAB_HOME_GROUPS_GROUP_ADVANCED_TOOL_LABEL" icon="">
				<large>
					[...]
					<control id="org.ametys.dashboard.Tool"/>
				</large>
				<medium>
					[...]
					<control id="org.ametys.dashboard.Tool"/>
				</medium>
				<small/>
    		</group>
			[...]
		</groups>
	<tab>
	[...]
</tabs>

Attention ! Si le groupe contient une description ,  et  , il faut ajouter le bouton dans les 3.

 

  • Pour ouvrir le tableau de bord à l'ouverture de l'application CMS, l'ajouter dans la section <default> du fichier WEB-INF/param/cms-uitool-default.xml l'identifiant de l'outil uitool-dashbord:

    <default>
       <uitool-factory id="uitool-sitemap"/>
       <uitool-factory id="uitool-help"/>
       <uitool-factory id="uitool-dashboard"/>
    </default>
    
  • Le tableau de bord est configurable à partir du fichier WEB-INF/params/todolist.xml.
    Ce fichier doit nécessairement exister pour que l'outil fonctionne.
    Le fichier est un fichier XML décrivant le contenu des tableaux.

    <todo-list>
        <tasks allowUserQuery="false">
            <!-- Here the list of tasks -->
        </tasks>
    </todo-list>
    

    Par exemple pour une application contenant 3 états de workflow (1. Brouillon, 2. Proposé, 3. Validé) :

    • pour voir les 5 derniers contenus modifiés, quel que soit l'état de workflow dans lequel ils sont, ajouter la tâche suivante :

      <task label="plugin.web:TODO_LIST_TASK_LATEST_DRAFTS" id="recent-drafts" length="5">
         <step id="1, 2, 3" userContents="true"/>
      </task>
      
    • pour voir tous les contenus dans l'état "Brouillon", en attente de proposition par le contributeur qui a le droit adéquat, ajouter la tâche suivante :

      <task label="plugin.web:TODO_LIST_TASK_PROPOSE" id="to-propose">
          <step id="1" rights="Workflow_Rights_Propose"/>
      </task>
      
    • pour voir tous les contenus dans l'état "Proposé", en attente de validation par le contributeur qui a le droit adéquat, ajouter la tâche suivante :

      <task label="plugin.web:TODO_LIST_TASK_VALIDATE" id="to-validate">
          <step id="2" rights="Workflow_Rights_Validate"/>
      </task>
      
  • Redémarrer le serveur

Export sur un portail externe

Pour exposer le tableau de bord sur un portail externe, comme par exemple dans un portail ESUP, il faut utiliser la portlet iframe avec l'url http://[nom_serveur]/plugins/dashboard/dashboard.html.