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
  • 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)pour le broker OLM ou properties/broker/proxy/proxy.properties pour le broker "proxy".

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.name=olm
    
    Ce paramètre défini le nom du 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=180
    
    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=730
    
    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 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

Les brokers disponibles sont "olm" et "proxy".

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
    
  • Chemin d'accès du certificat utilisé pour communiquer avec OLM (fourni par OLM) :
    Bloc de code
    libmgs.smsuapi.https.keystore=/an/example/certificat.ks
    
  • Mot de passe du certificat (fourni par OLM) :
    Bloc de code
    libmgs.smsuapi.https.passwd=xxxxxxx
    
  • 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.

Broker "proxy"

  • URL de back office SMS-U proxy
    Bloc de code
    
    sms.connector.proxy.ws.address=https://sms.univ-xxx.fr/xfire
    
  • Intervalle en secondes de connection au proxy pour obtenir les statuts
    Bloc de code
    
    sms.connector.proxy.acknoledgeStatus.repeatInterval=20
    
    Pour obtenir le statut d'un SMS (En cours, Délivré, Numéro invalide...), le back office doit se connecter au back office "proxy" à intervalle régulier.

Création de la base de données

...