...
XBal : Service de boite aux lettres
Présentation de Xbal
Le service XBAL lit la boîte aux lettres locale par MAPI et lance des programmes de traitement des messages reçus.
Le traitement à effectuer est codifié dans l'objet du message. L'objet du message est écrit en HMP dans lequel le paramètre <ACTION> définit le traitement à effectuer. Le traitement à effectuer fait référence à un fichier d'actions (XBALF.dhfi) qui contient le nom d'un programme Diva à exécuter.
Le programme de traitement de l'action est lancé par la fonction ProgramCall. XBAL lui envoie les paramètres du message à traiter par le tunnel.
Attention : pour que Xbal fonctionne avec Outlook, il faut que ce dernier soit correctement paramétré. Voir Paramétrage de Outlook .
Voir également :
Rubrique "Harmony Markup Parameters HMP" de la documentation Xwin - Programmation.
Rubrique "Tunnels" de la documentation Xwin - Programmation.
Rubrique "ProgramCall" de la documentation Xwin - Programmation.
...
XBAL est lancé comme un service par « Divalto Services Diva » (Voir le paramétrage des services Diva). En plus des paramètres généraux valables pour tous les services, les paramètres spécifiques de XBAL du fichier paramètres des services dhsServices.txt sont les suivants :
Profil | permet de préciser le profil MAPI à utiliser pour la lecture de la boîte. |
Pwd | permet de préciser le mot de passe du profil MAPI |
Log | permet d'indiquer que l'on souhaite enregistrer les erreurs dans un fichier journal. Le paramètre Log permet de préciser le nom du fichier journal. Si la valeur du paramètre Log est à espace, XBAL écrit les erreurs dans le fichier /Divalto/sys/Xbal.log. Si le paramètre Log est absent, XBAL n'enregistre pas les erreurs. |
LogMessage | permet d'indiquer que l'on souhaite enregistrer un compte rendu des messages traités avec succès dans un fichier journal. Le paramètre LogMessage permet de préciser le nom du fichier journal. Si la valeur du paramètre MessageLog est à espace, XBAL écrit dans le fichier /Divalto/sys/XbalMessage.log. Si le paramètre MessageLog est absent, XBAL n'enregistre pas le compte-rendu |
DossierErreur | permet de préciser le nom d'un dossier de la messagerie dans lequel Xbal transfère les messages "en erreur". Cette option nécessite une messagerie compatible avec l'interface "Extended MAPI". Par défaut, XBAL crée le dossier "XBAL messages en erreur". Si l'interface MAPI ne permet pas la création de dossier, les messages "en erreur" sont simplement marqués comme étant lus. |
Attente | permet d'indiquer le temps en seconde entre deux parcours de la boîte aux lettres. La valeur par défaut est de 60 secondes. Lorsque l'interface "Extended MAPI" est disponible pour la messagerie, XBAL est automatiquement informé de l'arrivée d'un nouveau message. Ce paramètre n'est donc pas pris en considération. |
Exemple :
<nom>xbal<programme>xbal.dhop<tache>17-999<windowshow>SW_HIDE<utilisateur>BAL<profil>monprofil<pw>monmotdepasse<log> <attente>120
Remarque : Le service XBAL ne fonctionne pas si son fichier Xlogf.dhfi se trouve sur un serveur Xlan sécurisé. Voir Paramétrage des utilisateurs réseau
...
XBAL envoie les paramètres du message à traiter à travers le tunnel. Le programme de traitement les récupère par la fonction PingReceive.
"Xbal_Objet" | contient l'objet du message au format HMP. |
"Xbal_Date" | contient la date d'émission du message. |
"Xbal_Emetteur" | contient l'émetteur du message. |
"Xbal_Message" | contient le texte du message (taille maximum 32000 caractères). |
"Xbal_Param" | contient les paramètres liés à l'action dans le fichier des actions. |
"Xbal_Nbre" | contient le nombre de pièces jointes au message. |
"Xbal_Fichiern" | contient le nom complet de la pièce jointe. n varie de 1 à Xbal_nbre. |
"Xbal_NomFichiern" | contient le nom original de la pièce jointe tel qu'il apparaît dans le message. n varie de 1 à Xbal_nbre. |
Traitement des pièces jointes
Les pièces jointes sont stockées dans des fichiers temporaires. Le programme de traitement des messages doit supprimer ces fichiers avec la fonction WinDeleteFile.
Valeurs de retour du programme de traitement
Le programme de traitement, s'il est appelé en mode synchrone, doit acquitter le message par la fonction Pong avec le paramètre "Xbal_Status" et les valeurs suivantes :
0 | acquittement positif. Le message est supprimé de la boite de réception. |
1 | acquittement négatif grave. L' action ne peut pas être traitée par programme. Au retour XBAL désactive l'action. |
2 | acquittement négatif. Ce message n'a pu être traité. Il est transféré dans le dossier des messages en erreur ou marqué comme étant lu dans la boîte de réception, mais n'est pas supprimé. |
Voir également :
Rubrique "Tunnels" de la documentation Xwin - Programmation.
Rubrique "PingReceive - PongReceive - PingLocalReceive" de la documentation Xwin - Programmation.
...
Un commentaire décrivant l'action.
Un indicateur de validité de l'action. Celui-ci permet de suspendre provisoirement l'exécution d'une action. En cas de problème lors de l'exécution d'une action le programme XBAL invalide l'action en positionnant cet indicateur.
Pour les services web : un indicateur permettant de garder le programme XwebServices en résident. (voir Services Web résidentsle chapitre dédié aux services web Services web )
Le nom du programme Diva qui traite le message.
Le code utilisateur sous lequel le programme doit s'exécuter.
Les paramètres de l'action sous forme de chaîne de commande HMP.
...