Manuel d'intégration v1.3.0, v1.4.0


Installation

  • Arrêter le serveur
  • Télécharger les jars du plugin et ajouter-les (ametys-plugin-sms-1.4.x.jar et ametys-plugin-sms-resources-1.4.x.jar)  dans le répertoire WEB-INF/lib de votre application Ametys
  • Ajouter les boutons permettant d'ouvrir l'outil de gestion des listes de diffusion (org.ametys.plugins.sms.SmsList) et d'envoyer des SMS (org.ametys.sms.SendSMS) dans le fichier WEB-INF/params/cms-ribbon-default.xml.
    Il est conseillé de l'ajouter dans l'onglet Accueil, dans un nouveau groupe "SMS"

  • Dans ce même fichier, importer le fichier de ribbon propre aux liste de diffusion SMS plugin:sms://cms-ribbon,.xml

    <tabs>
        <tab label="RIBBON_TABS_TAB_HOME_LABEL">
            <groups>
                [...]
                <group label="RIBBON_TABS_TAB_HOME_GROUPS_GROUP_SMS_LABEL" icon="">
    				<large/>
    				<medium>
    					<control id="org.ametys.sms.SendSMS"/>
    					<control id="org.ametys.plugins.sms.SmsList"/>
    				</medium>
    				<small/>
                </group>
                [...]
            </groups>
        <tab>
        [...]
    
        <import>plugin:sms://cms-ribbon.xml</import>
    </tabs>
    
    



  • Choisir le fournisseur de SMS (broker) à utiliser pour l'envoi de SMS (cf. chapitre suivant)

    <org.ametys.plugins.sms.broker.Broker>org.ametys.plugins.sms.broker.EtoileDieseBroker</org.ametys.plugins.sms.broker.Broker>
    
  • Redémarrer le serveur

Choix du connecteur SMS (broker)

L'envoi de SMS s'effectue au travers d'un fournisseur de services, dit "broker".

Pour envoyer les SMS vous devez choisir un broker parmi ceux proposés par le plugin ou écrire votre propre broker. Un broker est un point d'extension simple.

Le plugin SMS fournit 2 deux brokers:

  • org.ametys.plugins.sms.broker.LoggerBroker
    Cette implémentation n'envoie pas de SMS, elle se contente de tracer les envois fictifs dans les journaux de l'application. Il s'agit donc d'une implémentation de tests uniquement.

 

  • org.ametys.plugins.sms.broker.EtoileDieseBroker
    Cette implémentation utilise le web service du fournisseur Etoile Dièse pour envoyer les SMS. Pour utiliser ce broker vous devez disposez d'un compte Etoile Dièse.

Dans le fichier WEB-INF/param/runtime.xml,déclarez le broker à utiliser:

<org.ametys.plugins.sms.broker.Broker>org.ametys.plugins.sms.broker.EtoileDieseBroker</org.ametys.plugins.sms.broker.Broker>

Vous pouvez également écrire votre propre broker (cf. Plugin SMS - Manuel développeur v1.2.0)

Erreur de certificat
Lors de l'envoi de SMS depuis le back-office, il est possible (selon le broker utilisé) que vous obteniez une erreur du type:

peer not authenticated
javax.net.ssl.SSLPeerUnverifiedException: peer not authenticated 
    at com.sun.net.ssl.internal.ssl.SSLSessionImpl.getPeerCertificates(SSLSessionImpl.java:352) 
    at org.apache.http.conn.ssl.AbstractVerifier.verify(AbstractVerifier.java:128) 
Si c'est le cas, c'est que vous devez importer le certificat du broker dans votre JVM :
keytool -alias "etoilediese" -import -file ssl.etoilediese.fr -keystore /path/to/jvm/jre/lib/security/cacerts -trustcacerts

 

Configuration du broker pour le désabonnement à la liste de diffusion

Pour être en conformité avec la législation, il peut être nécessaire de permettre à vos utilisateurs de se désabonner à la liste de diffusion SMS.

Si vous avez souscrit à un service STOP SMS auprès de votre fournisseur, vous devrez lui donner l'URL de désabonnement. L'url à fournir est: http://<url_monsite>/_plugins/sms/stop-sms où url_monsite est l'url de votre site Ametys.

Aide aux contributeurs: personnalisation de l'aide lors de l'envoi de SMS

Lors de l'envoi de SMS, un texte en bas de boite de dialogue invite les contributeurs à ajouter à la fin du message SMS la procédure à suivre pour se désabonner à la liste de diffusion:

Il peut être intéressant de surcharger ce texte d'aide afin de l'adapter à votre abonnement auprès de votre fournisseur SMS. Par exemple : Pour être en conformité avec la législation, pensez à ajouter en fin de message "Pour ne plus recevoir de message de notre part, envoyez STOP au 36 XXX".

Pour cela surchargez la clé i18n PLUGINS_SMS_SEND_DIALOG_HINT2 dans le fichier WEB-INF/i18n/plugins/sms/message_fr.xml:

<?xml version="1.0" encoding="UTF-8"?>
<catalogue xml:lang="fr">
	<message key="PLUGINS_SMS_SEND_DIALOG_HINT2">Pour être en conformité avec la législation, pensez à ajouter en fin de message \"Pour ne plus recevoir de message de notre part, envoyez STOP au 36 XXX\".</message>
</catalogue>

 

 

Retour en haut