Pages enfant
  • Manual d'installation du Back Office (esup-smsu-api)

Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

...

  • properties/config.properties
    • vérifier les informations de connexion à la base de donnée
    • vérifier le chemin d'accès au fichier libmgs.properties
  • properties/libmgs.properties (paramètres liés au broker)
    • Pas de paramétrage à modifier à l'heure actuelle
  • build.properties
  • properties/logging/log4j.properties
    • Vérifier le chemin d'accès du fichier de log
  • properties/broker/olm/libmgs.properties (paramètres liés au broker OLM)

Paramètres généraux

Voici la liste des paramètres disponibles :

  • Url d'accès à la base de donnée :
    Bloc de code
    hibernate.connection.jdbc.url=jdbc:mysql://<host>:3306/smsuapi
    
    Ce paramètre défini l'url de la base de donnée du back office.
  • Login d'accès à la base de donnée :
    Bloc de code
    hibernate.connection.jdbc.username=root
    
    Ce paramètre défini le login pour l'accès à la base de donnée du back office.
  • Mot de passe d'accès à la base de donnée :
    Bloc de code
    hibernate.connection.jdbc.password=xxx
    
    Ce paramètre défini le mot de passe pour l'accès à la base de donnée du back office.
  • Mode d'accès à la base de donnée :
    Bloc de code
    hibernate.useJndi=false
    
    Défini le mode d'accès à la base de donnée du back office.
  • Nom du connecteur OLM utilisé :
    Bloc de code
    sms.connector.olm.name=smsuapiolm
    
    Ce paramètre défini le nom du connecteur OLM utilisé par l'application. Ce nom doit être identique à celui que l'on trouve dans le fichier libmgs.properties et notamment dans le champ libmgs.< name>.sid.
  • Localisation du fichier de configuration de la libraire MGS :
    Bloc de code
    
    sms.connector.olm.propertyFile=/an/example/libmgs.properties
    
    Ce paramètre défini le chemin d'accès vers le fichier contenant la configuration de la librairie MGS.
  • Statut utilisé par OLM pour définir un envoi réussi :
    Bloc de code
    
    sms.connector.olm.olmSentStatusCode=0
    
    Ce paramètre défini la valeur du statut envoyée par les acquittements d'OLM définissant un SMS transmis avec succès.
  • Statut utilisé par OLM définissant un échec d'envoi:
    Bloc de code
    
    sms.connector.olm.olmErrorStatusCode=1
    
    Ce paramètre défini la valeur du statut envoyée par les acquittements d'OLM définissant une erreur lors de la transmission d'un SMS.
  • Valeur de la cause utilisée par OLM pour définir un échec d'envoi du à un numéro invalide:
    Bloc de code
    
    sms.connector.olm.olmInvalidMSISDNCauseCode=10
    
    Ce paramètre défini la valeur de la cause envoyée par les acquittements d'OLM définissant une erreur lors de la transmission d'un SMS du à un numéro invalide.
  • broker utilisé. Les brokers disponibles sont "olm" et "proxy".
  • Active / désactive l'envoi effectif des SMS :
    Bloc de code
    sms.connector.simulateSending=false
    
    Ce paramètre sert à désactiver l'envoi effectif des messages au broker. Si à « true » alors aucun message ne sera envoyé au broker.
  • Nombre maximum de jour de conservation des SMS :
    Bloc de code
    purge.sms.seniorityDay=90180
    
    Ce paramètre sert à définir la durée maximum (en jours) de conservation des SMS en base avant que ceux ci ne soient purgés.
  • Nombre maximum de jour de conservation des statistiques :
    Bloc de code
    purge.statistic.seniorityDay=365730
    
    Ce paramètre sert à définir la durée maximum (en jours) de conservation des statistiques en base avant que ceux ci ne soient purgés. Ces statistiques sont utilisés pour la création des rapports consolidés.
  • La localisation du fichier de configuration de quartz :
    Bloc de code
    
    quartz.configFile.location=/an/example/smsuapi_quartz.properties
    
    Ce paramètre défini le chemin d'accès vers le fichier de configuration de quartz.La cron expression utilisée par la tache de génération des statistiques :
    Bloc de code
    quartz.buildStatisticsTrigger.cronExpression=0 0 0 1  * ?
    
    Ce paramètre défini l'expression cron qui est utilisée pour planifier la tache qui génère les statistiques nécessaires aux relevés consolidés.
  • La cron expression utilisée par la tache de purge des sms :
    Bloc de code
    quartz.purgeSmsTrigger.cronExpression=0 0 3 1 *  ?
    
    Ce paramètre défini l'expression cron qui est utilisée pour planifier la tache qui purge les SMS.
  • La cron expression utilisée par la tache de purge des statistiques :
    Bloc de code
    quartz.purgeStatisticTrigger.cronExpression=0 0 5 1  * ?
    
    Ce paramètre défini l'expression cron qui est utilisée pour planifier la tache qui purge les statistiques.

Paramètres liés au broker OLM

Voici la liste des paramètres disponibles dans le fichier properties/broker/olm/libmgs.properties :

  • Identifiant de l'application (fourni par OLM) :
    Bloc de code
    libmgs.smsuapi.sid=2421
    
    L'identifiant unique de l'application
  • Chemin d'accès du certificat utilisé pour communiquer avec OLM (fourni par OLM)
  • Mode de fonctionnement de la librairie :
    Bloc de code
    
    libmgs.smsuapi.mode=sgs
    
    Spécifie le mode de fonctionnement de la librairie (texte, voix, fax ...)
  • Url utilisée pour l'envoi de SMS :
    Bloc de code
    
    libmgs.smsuapi.mgs.messageUrl=https://sms.cvf.fr/cgi-bin/messages.cgi
    
    Défini l'url à appeler pour envoyer des SMS.
  • Url utilisée pour le suivi des acquittements des SMS :
    Bloc de code
    
    libmgs.smsuapi.mgs.notifUrl=http://sms.cvf.fr/cgi-bin/notifications.cgi
    
    Défini l'url à utiliser pour suivre les acquittements des SMS.
  • Localisation du certificat :
    Bloc de code
    libmgs.smsuapi.https.keystore=/an/example/certificat.ks
    
    Défini le chemin d'accès jusqu'au certificat utilisé pour communiquer avec OLM
  • Mot de passe du certificat (fourni par OLM) :
    Bloc de code
    libmgs.smsuapi.https.passwd=xxxxxxx
    
    Défini le mot de passe du certificat
  • Type de logger :
    Bloc de code
    libmgs.smsuapi.log.type=file
    
    Défini le type de logger utilisé par la librairie.
  • Fichier de log :
    Bloc de code
    libmgs.smsuapi.log.file.path=/an/example/pushLibMGS.log
    
    Défini le chemin d'accès du fichier de log utilisé par la librarie libMGS.
  • Timeout de notification :
    Bloc de code
    libmgs.smsuapi.advanced.notifTimeout=1
    
    Défini la durée (en minute) avant que la connexion vers l'url de notification soit automatiquement fermée et ré-ouverte.Timeout :
    Bloc de code
    
    libmgs.smsuapi.timeout=15
    
    Défini la durée (en seconde) du timeout.

Création de la base de données

...