Manuel intégrateur

  1. Architecture des plugins ODF
  2. Champs énumérés
  3. Fichier de ribbon
  4. Workflow
  5. Fichier runtime.xml
  6. Import et synchronisation
    1. Liste des champs synchronisables
    2. Configuration de l'application pour Apogée
      1. Fichier runtime.xml pour Apogée
      2. Fichiers de mapping SQLMap
      3. Fichiers de conversion
      4. Paramètres de configuration
    3. Configuration de l'application pour CDM-fr (mode local)
      1. Fichier runtime.xml pour CDM-fr
      2. Paramètre de configuration
    4. Configuration de l'application pour CDM-fr (mode remote ou portail)
      1. Fichier runtime.xml pour CDM-fr (mode remote ou portail)

Architecture des plugins ODF

Ametys propose 3 modules pour construire l'offre de formation.

  • Plugin ODF
    Saisie de l'offre de formation: les parcours, unités d'enseignement, composantes, ...
    Inclue l'export CDM-fr
  • Plugin ODF-Sync
    Permet l'import et la synchronisation de l'offre de formation avec une base externe: Apogée ou CDM-fr / ROF
  • Plugin ODF-Web
    Permet d'intégrer l'offre de formation au sein de son site web: arborescence de l'offre de formations, recherche avancée des formations, listes des formations classées par domaines, type de diplômes, composantes, ... ou encore shémas des formations

Les plugins ODF-sync et ODF-Web sont optionnels.

Champs énumérés

Dans l'offre de formation un certain nombre de champs sont des champs énumérées (liste de valeurs définies): type de diplômes, domaines, niveau d'étude, lieu de formation, code ROME, code DGESIP, code ERASMUS, code SISE, etc ...

Les valeurs et les libellés de ces champs sont décrits dans des fichiers XML (donc configurable).

Téléchargez les fichiers xml de ces champs énumérés et les copier dans le répertoire WEB-INF/param/odf de votre application.

Pour chacune des valeurs possible pour un champs, le fichier XML contient 3 informations:

  • code : la valeur du champ
  • i18n-key: la clé i18n pour la traduction du libellé dans Ametys
  • cmdValue: la valeur correspondant dans CDM-fr (optionnelle, présente si différent de la valeur dans Ametys)

Fichier de ribbon

Dans le fichier cms-ribbon-default.xml vous devez importer le ribbon propre à l'offre de formation.

<import>plugin:[plugin]://cms-ribbon-[mode].xml</import>

Selon les plugins ODF utilisés et le mode d'import/synchro l'import différe. Référez vous au tableau ci-après pour connaitre le fichier à importer.

Plugin ODF

Plugin ODF-Web

Plugin ODF-SyncImport
ApogéeCDM-frCDM-fr global
x    

plugin:odf://cms-ribbon.xml

xx   

plugin:odf-web://cms-ribbon.xml

x x  

plugin:odf-sync://cms-ribbon-apogee.xml

x  x 

plugin:odf-sync://cms-ribbon-cdmfr.xml

x   x

plugin:odf-sync://cms-ribbon-cdmfr-global.xml

xxx  

plugin:odf-sync://cms-ribbon-web-apogee.xml

xx x 

plugin:odf-sync://cms-ribbon-web-cdmfr.xml

xx  x

plugin:odf-sync://cms-ribbon-web-cdmfr-global.xml

Pour intégrer l'offre de formation à l'arborescence de votre site (Plugin ODF-Web) vous devez ajouter dans le ribbon le bouton permettant de positionner la racine de l'offre de formation.

Dans l'onglet org.ametys.cms.page.Tab  de votre fichier cms-ribbon-default.xml, rajoutez le bouton suivant:

<control id="org.ametys.odf.web.page.Root"/>

Workflow

 

Plugin ODF

Plugin ODF-Web

Plugin ODF-Sync

http://viewvc.ametys.org/viewvc/trunk/plugins/odf/tags/2.2.0/main/plugin-odf/doc/workflow/

x  

http://viewvc.ametys.org/viewvc/trunk/plugins/odf-web/tags/2.2.0/main/plugin-odf-web/doc/workflow/

xx 

http://viewvc.ametys.org/viewvc/trunk/plugins/odf-sync/tags/2.2.0/main/plugin-odf-sync/doc/workflow/

x x

http://viewvc.ametys.org/viewvc/trunk/plugins/odf-web/tags/2.2.0/main/plugin-odf-web/doc/workflow-sync/

xx x

Le fichier de workflow workflows.xml doit référencer les 4 fichiers de workflow :

<workflows>
  <workflow name="course" type="file" location="workflow-course.xml"/>
  <workflow name="program" type="file" location="workflow-program.xml"/>
  <workflow name="orgunit" type="file" location="workflow-orgunit.xml"/>
  <workflow name="person" type="file" location="workflow-person.xml"/>
</workflows>

Fichier runtime.xml

Si vous utilisez le plugin ODF-Web, désactivez la feature odf/link-resolver

<plugins>
	<exclude>
   		[...]
		<feature>odf/link-resolver</feature>
	</exclude>
</plugin>

Si vous utilisez le plugin ODF-Sync, désactivez la feature odf/init

<plugins>
	<exclude>
   		[...]
		<feature>odf/init</feature>
	</exclude>
</plugin>

Import et synchronisation

Ce chapitre ne vous concerne que si vous utilisez le plugin d'import et synchronisation ODF-Sync

Si vous utilisez le plugin ODF-Sync, vous devrez choisir le mode d'import et synchronisation (Apogée ou CDM-fr) et paramétrer en fonction votre l'application.

Liste des champs synchronisables

Pour chaque entités (formation, unités d'enseignements, ...), le fichier WEB-INF/param/odf-synchro.xml liste les champs synchronisables avec la base Apogée ou le fichier CDM-fr.

Télécharger un exemple de fichier odf-synchro.xml

Configuration de l'application pour Apogée

L'import s'effectue à partir de la base Apogée de l'établissement. L'import s'effectue individuellement pour chaque entité (Formations, Parcours, ELPs, Composantes, Personnes, ..).

La synchronisation est disponible sur chaque entité individuellement ou de façon globale.

Fichier runtime.xml pour Apogée

3 points d'extensions à déclarer.

<org.ametys.plugins.odfsync.ODFSyncManager>org.ametys.plugins.odfsync.apogee.ApogeeODFSyncManager</org.ametys.plugins.odfsync.ODFSyncManager>
<org.ametys.plugins.odfsync.apogee.ApogeeSynchronizationHelper>org.ametys.plugins.odfsync.apogee.DefaultApogeeSynchronizationHelper</org.ametys.plugins.odfsync.apogee.ApogeeSynchronizationHelper>
<org.ametys.plugins.odfsync.apogee.ApogeeDAO>org.ametys.plugins.odfsync.apogee.DefaultApogeeDAO</org.ametys.plugins.odfsync.apogee.ApogeeDAO>

Dans la section <exclude> ... </exclude>, vérifiez que les features odf-sync/synchronization.apogee.datasource  et odf-sync/odf.rights.sync.others ne sont pas désactivées. Si c'est le cas, supprimez-les de cette section.

<runtime  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xsi:noNamespaceSchemaLocation="http://ametys.org/Runtime/2.0/runtime.xsd">

	<plugins>
		<exclude>
			<feature>....</feature>
			<feature>...</feature>
        </exclude>
	</plugins>

[...]
</truntime>

 

Fichiers de mapping SQLMap

Les requêtes sur la base Apogée sont décrites dans les fichiers de mapping SQLMap. Ces derniers doivent se trouver dans le répertoire WEB-INF/param/odf/apogee de l'application.

Télécharger un exemple de fichiers de mapping SQL

Fichiers de conversion

Ces fichiers permettent de faire la conversion des codes Apogée vers les codes Ametys.

Ils doivent être placés dans le répertoire WEB-INF/param/apogee/code de votre application:

Paramètres de configuration

 Il y a deux paramètres de configuration propres à Apogée à initialiser :

  • odf.apogee.administrative.year : Attend une année sur 4 chiffres pour pouvoir définir sur quelle année l'import doit être fait
  • odf.sync.apogee.prevails : Attend un booléen pour pouvoir définir la priorité des valeurs entre celles d'Apogée et celles remplies dans Ametys

Il vous faudra également configurer l'accès à la base Apogée.

Configuration de l'application pour CDM-fr (mode local)

Dans CDM-fr, l'import s'effectue à partir d'un fichier XML au format CDM-fr. L'ensemble des entités de l'offre de formation (Formations, Parcours, ELPs, Composantes, Personnes, ..) définis dans le fichier sont importés si ils n'existent pas encore dans Ametys.

La synchronisation est disponible sur une formation uniquement ou de façon globale.

Fichier runtime.xml pour CDM-fr

Il existe 2 modes de synchronisation CDM-fr:

  • De manière globale: l'import et la synchronisation des formations se font sur tous les fichiers CDM-fr connus
<org.ametys.plugins.odfsync.ODFSyncManager>org.ametys.plugins.odfsync.cdmfr.GlobalCDMFrODFSyncManager</org.ametys.plugins.odfsync.ODFSyncManager>
  • Fichier par fichier: l'import se fait sur un seul fichier CDM-fr. La synchronisation peut se faire sur un seul fichier CDM-fr ou sur la totalité des fichiers CDM-fr connus (synchronisation globale)
<org.ametys.plugins.odfsync.ODFSyncManager>org.ametys.plugins.odfsync.cdmfr.CDMFrODFSyncManager</org.ametys.plugins.odfsync.ODFSyncManager>
Paramètre de configuration

Un seul paramètre de configuration propre à l'utilisation de CDM-fr:

  • odf.cdmfr.search.repository : chemin complet vers un dossier où seront contenus les fichiers CDM-fr.

Configuration de l'application pour CDM-fr (mode remote ou portail)

Dans ce mode, l'offre de formation est synchronisé avec une autre application ODF distante.

Les formations sont publiées sur le portail par web services.

Fichier runtime.xml pour CDM-fr (mode remote ou portail)
<org.ametys.plugins.odfsync.ODFSyncManager>org.ametys.plugins.odfsync.cdmfr.RemoteCDMFrODFSyncManager</org.ametys.plugins.odfsync.ODFSyncManager>