IPMailSMS
Module d’envoi d’E-MAIL & SMS pour CITECT
Le module d’envoi d’e-mail & sms permet d’envoyer depuis CITECT, sur l’apparition d’une alarme, un message électronique et/ou un message court.
Il s’interface à votre application via un projet CITECT à inclure.
Nous expliquerons donc dans cette documentation comment paramétrer et utiliser ce module dans votre application.
Sommaire
1 Installation ... 2
1.1 Restauration du projet MADMA ... 2
1.2 Intégration dans le projet principal ... 2
2 Configuration des missions ... 3
2.1 Paramétrage des services ... 4
2.2 Ajout d’une mission ... 6
2.3 Edition d’une mission ... 8
2.4 Suppression d’une mission ... 9
2.5 Activation/Désactivation d’une mission ... 9
3 Paramètres avancés... 10
4 Application de test ... 11
5 Enregistrement du produit ... 12
1 Installation
Le module d’envoi d’email & sms est compatible avec les versions 7.20 et supérieures de CITECT
1.1 Restauration du projet MADMA
Il faut dans un premier temps restaurer le projet MADMA avec l’outil de restauration de l’explorateur CITECT.
Le nom du projet doit impérativement être « MADMA »
1.2 Intégration dans le projet principal
Dans le projet principal, aller dans l’éditeur de projet CITECT, menu « Système », puis cliquer sur « Projets Inclus »
Indiquer le nom de projet MADMA puis cliquer sur « Ajouter »
Ensuite, dans une vue du projet principal, il est possible d’ajouter soit :
- un génie déjà configuré dans le projet MADMA : APPEL_MAD, librairie MAD_LIB
- soit d’appeler directement depuis un bouton, par exemple, la fonction AfficheMaP() Cela permet de lancer l’outil de configuration des missions.
Afin d’initialiser le moteur permettant de gérer l’envoi des messages lors de l’apparition des alarmes, il est obligatoire de lancer une fonction au démarrage de l’application :
Cette fonction se nomme :
Init_Projet_Madma()
2 Configuration des missions
Une mission permet de définir les paramètres qui vont être utilisés afin d’envoyer un message sur l’apparition d’une alarme.
Des filtres peuvent être paramétrés afin d’optimiser l’envoi des messages.
Afin d’appeler l’outil de configuration des missions, il est possible soit d’utiliser le génie intégré dans le projet MADMA soit directement la fonction Cicode AfficheMaP() (voir 1.2 Intégration dans le projet principal)
2.1 Paramétrage des services
Cliquer sur le bouton « Paramètres » de la fenêtre principale du module d’envoi d’EMAIL & SMS afin de paramétrer les propriétés de l’envoi de SMS et/ou d’e-mail :
L’envoi de SMS se fait par l’intermédiaire d’un modem GSM connecté sur un port série.
Il faut donc paramétrer les propriétés du port, dans la section Modem : - Numéro du port série
- Vitesse de transmission - Nombre de bit de données - Nombre de bit de stop - Type de parité
Ensuite, si la carte SIM insérée dans le modem GSM est protégée par un code PIN, il faut le renseigner dans la section Connexion.
Enfin, il faut indiquer l’indicatif pays du numéro vers lequel le SMS va être envoyé, dans la section Connexion.
Pour l’envoi d’Email, la connexion réseau disponible est utilisée.
Il faut paramétrer les informations suivantes, dans la section Envoi d’e-mail : - Adresse du serveur SMTP
- Authentification (si le serveur SMTP l’exige) - Login (si l’authentification est nécessaire) - Mot de passe (si l’authentification est nécessaire)
- E-Mail de l’expéditeur (non obligatoire, est indiqué dans l’email reçu par le destinataire) - Nom de l’expéditeur (OBLIGATOIRE, est indiqué dans l’email reçu par le destinataire)
- Sujet par défaut : sujet utilisé dans tous les e-mails envoyés à tous les destinataires. Si ce champ est vide c’est le libellé de la mission qui est utilisé.
Tous ces paramètres sont enregistrés dans le citect.ini, dans la section MADMA.
2.2 Ajout d’une mission
Cliquer sur le bouton « Ajouter » de la fenêtre principale du module d’envoi d’EMAIL & SMS afin d’ajouter une nouvelle mission.
Description de la mission
Nom de la mission : Nom définissant la mission d’envoi de message. Ce nom peut être utilisé afin d’activer/désactiver la mission (voir 2.5 Activation/Désactivation d’une mission)
Libellé de la mission : Description de la mission, utilisé dans le sujet du message envoyé
Paramétrage du service
Mail : Si sélectionné, la mission enverra un e-mail au destinataire défini lors de l’apparition d’une alarme gérée par celle-ci.
SMS : Si sélectionné, la mission enverra un sms au destinataire défini lors de l’apparition d’une alarme gérée par celle-ci.
Destinataire : Si Mail est sélectionné, on indique ici l’adresse e-mail qui recevra les messages en cas d’apparition d’alarmes gérées par cette mission.
Si SMS est sélectionné, on indique ici le numéro qui recevra les messages en cas d’apparition d’alarmes gérées par cette mission.
Définition des masques d’appel
Masque sur le mnémonique : Permet de filtrer l’envoi d’un message en fonction du nom du tag alarme.
Le caractère « ? » permet de remplacer un caractère précis et donc de filtrer sur toutes les occurrences possible ex :
ALM_? = cela va prendre en compte toutes les alarmes commençant par ALM_ puis suivi de n’importe quel caractère remplaçant le caractère « ? » : ALM_1 par exemple
Le caractère « * » remplace tous les caractères possible.
ex :
ALM_*=cela va prendre en compte toutes les alarmes commençant par ALM_ puis suivi de n’importe quelle chaîne de caractère remplaçant le caractère « * » : ALM_TEST par exemple
Le caractère « ; » permet de filtrer sur plusieurs noms de tag alarme.
Ex :
ALM_1;TEST_ALM
Masque sur la catégorie :
Permet de filtrer l’envoi d’un message sur une catégorie précise. (De 0 à n) Le caractère « * » envoi un message pour toutes les catégories d’alarmes.
Le caractère « ; » permet de filtrer sur plusieurs catégorie d’alarme.
Ex : 1 ;2 ;5
Formatage et envoi du message
Délai avant l’envoi du message (seconde) : Temps d’attente en seconde avant qu’un message ne soit envoyé lors de l’apparition d’une alarme gérée par cette mission.
Ordre et type d’informations à envoyer : Défini le contenu du message envoyé lors de l’apparition d’une alarme gérée par cette mission. Il faut choisir le type et l’ordre des informations que l’on souhaite voir apparaitre dans le message.
Le bouton Aide permet d’afficher tous les types d’information auxquels on a accès.
On formate ce champ comme ci-dessous, par exemple : DHLE
On aura donc dans le contenu du message envoyé, en fonction de l’alarme qui a été déclenchée : Date Heure Libellé Etat
Ex : 19/04/2012 11:53:22 DESC ALM1 ON Aide :
Appel du popup décrivant les différents types d’information et leurs formatages que l’on peut utiliser dans le champ « Ordre et type d’informations à envoyer »
Date : Date d’apparition de l’alarme Heure : Heure d’apparition de l’alarme Mnémonique : Nom du Tag de l’alarme Nom : Nom de l’alarme
Libellé : Description de l’alarme Catégorie : Catégorie de l’alarme Etat : Etat de l’alarme
Valeur : Valeur de l’alarme
2.3 Edition d’une mission
Après avoir sélectionné une mission de la fenêtre principale du module d’envoi d’EMAIL & SMS, cliquer sur le bouton « Editer » de la fenêtre principale du module d’envoi d’EMAIL & SMS, afin d’éditer une mission déjà existante.
Modifier les informations souhaitées puis cliquer sur le bouton « OK »
2.4 Suppression d’une mission
Après avoir sélectionné une mission de la fenêtre principale du module d’envoi d’EMAIL & SMS, cliquer sur
« Effacer » afin de supprimer la mission sélectionnée.
Cliquer sur OK afin d’effacer la mission sélectionnée.
2.5 Activation/Désactivation d’une mission
Il est possible de gérer un bit dans votre application permettant d’activer ou désactiver une mission.
Ce bit boit être déclaré dans vos variables et doit porter le nom de la mission à activer/désactiver.
Dans ce cas vous ne devez pas utiliser d’espace ou de caractères spéciaux dans le nom de votre mission.
Exemple si votre mission s’appelle Mission1 :
Ce bit sera à mettre à 1 pour que la mission soit active et donc que les messages d’alarmes soient envoyés.
Dans le cas contraire (bit à 0) aucun message d’alarme de cette mission ne sera envoyé.
3 Paramètres avancés
[MADMA]
EnableCutCall = 1 //Valeur : 1 ou 0 - Annule l’envoi du message si l’alarme a été acquittée AppelAcq=1 // Valeur : 1 ou 0 - Annule l’envoi du message si l’alarme n’est plus active PagingEnabled = 1 // Valeur : 1 ou 0 - Active/Désactive l’envoi de message
SeqEnabled = 0 // Valeur : 1 ou 0 - Si l’alarme est toujours active, envoi automatiquement un message cycliquement
Rappel = 300 //Valeur : 1 à n - Temps d’attente en seconde entre chaque envoi de message si le paramètre SeqEnabled est à 1
TimeOutAppel = 120 //TimeOut d’envoi de message en seconde (si l’envoi du message dépasse ce temps, celui- ci ne sera pas envoyé)
Softkey = 1 // Valeur : 1 ou 0 - Gestion de l’enregistrement du produit par une clef logiciel si le paramètre est à 1, sinon gestion par la clef Citect connectée au poste.
Les paramètres ci-dessous sont modifiables lorsque l’application est exécutée, dans la fenêtre de paramétrage des services.
ServeurSMTP = MailExpediteur = NomExpediteur = SujetDefaut = Authentification =0 LoginSMTP =
MdPSMTP =
COM =COM1 SPEED =9600 STOPBITS =1 DATABITS =8 PARITY =N PIN = PAYS=France
4 Application de test
Une application de test est à votre disposition afin de tester l’envoi de mail et/ou SMS sur votre installation.
La sauvegarde du projet IPMailSMS est à restaurer depuis l’outil de restauration de l’explorateur Citect.
Il inclut le projet MADMA qui doit être préalablement restauré.
Ce projet permet de simuler des alarmes digitales et analogiques.
Des missions du module d’envoi d’e-mail & SMS sont préconfigurées.
5 Enregistrement du produit
Pour une clef logiciel (paramètre [MADMA]SoftKey=1), il faut envoyer à l’adresse mail info@ip-systemes.fr l’IPTools keynumber et dès que la commande sera validée, un code d’enregistrement sera envoyé et à renseigner dans le champs Registration code.
Pour l’utilisation d’un dongle Citect, il faut envoyer à l’adresse mail info@ip-systemes.fr le numéro de série de la clef Citect du serveur où l’application fonctionnera.
