Utilisation des objets métier de l'adaptateur pour e-mail

En utilisant un adaptateur pour e-mail, un courtier d'intégration peut envoyer un message par courrier électronique et y attacher des objets métier ou des fichiers. Les objets métier ou fichiers sont encapsulés dans un objet métier hiérarchique de premier niveau, qui contient les informations de routage de l'adaptateur. Les objets métier à envoyer sont définis en tant qu'enfants de l'objet métier de premier niveau. Si l'adaptateur pour e-mail est utilisé pour traiter les requêtes d'objet métier, vous devez préciser ces définitions d'objet métier d'encapsuleur.

Notez que les objets métier d'encapsuleur n'ont besoin d'être définis que pour le traitement des requêtes. Ils ne sont pas utilisés pour l'interrogation. Lors d'une interrogation, l'adaptateur examine le type MIME de chacune des pièces jointes au courrier électronique, instancie le gestionnaire de données approprié, et transmet la pièce jointe au gestionnaire de données. Ce dernier examine le nom de l'objet métier depuis la pièce jointe, trouve la définition de l'objet métier correspondant dans la liste des objets métier pris en charge pour l'adaptateur, et convertit le contenu de la pièce jointe en un objet métier.

Structures d'objets métier

L'objet métier de premier niveau de l'adaptateur pour e-mail doit contenir un ensemble d'attributs décrivant le contenu et les informations de routage d'un message électronique. L'adaptateur compose le message électronique à l'aide des attributs obligatoires d'objet métier, indiqués dans le tableau 8.

Tableau 8. Attributs obligatoires dans un objet métier de premier niveau pour e-mail
Nom Description
RecipientName
Adresse(s) électronique(s) du destinataire. Pour plus d'informations, voir Indication d'adresses e-mail valides.
MessageSubject
Description du message électronique. Cette valeur est définie par le courtier d'intégration dans l'objet métier.
MessageContent
Contenu du message électronique. Cette valeur est définie par le courtier d'intégration dans l'objet métier.
FromAddress
Adresse électronique de l'émetteur. L'émetteur reçoit un avis de non-livraison de message. Pour plus d'informations, voir Indication d'adresses e-mail valides.
Si vous utilisez la valeur par défaut de cet attribut, vous devez également définir la propriété du connecteur UseDefaults sur true. Pour plus d'informations sur la propriété UseDefaults, voir le tableau 5.
MimeType
Type mime des pièces jointes. S'il n'est pas indiqué, l'adaptateur ne traite pas les objets métier enfants.
AttachmentExtension
Définissez la propriété Default Value de cet attribut sur l'extension qui sera celle des fichiers représentant les objets métier contenus dans le courrier électronique. Par exemple, si un objet métier est envoyé en pièce jointe à un message électronique, et si la propriété Default Value de cet attribut est définie sur txt , la pièce jointe qui représente l'objet métier aura l'extension .txt.
BusinessObjectMimeCharset
Le jeu de caractères des objets métier contenus dans le courrier électronique. Pour plus d'informations sur cette propriété, voir sa description au niveau de la définition de l'adaptateur, dans la section BusinessObjectMimeCharset.
BusinessObjectMimeEncoding
Le codage des objets métier contenus dans le courrier électronique. Pour plus d'informations sur cette propriété, voir sa description au niveau de la définition de l'adaptateur, dans la section BusinessObjectMimeEncoding.
ContentType
Type de contenu du message à envoyer. Les valeurs valides sont text/plain.
DataEncoding
Type de message : text ou binary.
MessageContentMimeCharset
Le jeu de caractères du contenu du message. Pour plus d'informations sur cette propriété, voir sa description au niveau de la définition de l'adaptateur, dans la section MessageContentMimeCharset.
MessageContentMimeEncoding
Le codage du contenu du message. Pour plus d'informations sur cette propriété, voir sa description au niveau de la définition de l'adaptateur, dans la section MessageContentMimeEncoding.
MessageHeaderMimeCharset
Le jeu de caractère de l'en-tête du message. Pour plus d'informations sur cette propriété, voir sa description au niveau de la définition de l'adaptateur, dans la section MessageHeaderMimeCharset.
MessageHeaderMimeEncoding
Le codage de l'en-tête du message. Pour plus d'informations sur cette propriété, voir sa description au niveau de la définition de l'adaptateur, dans la section MessageHeaderMimeEncoding.
ReplyTo
Adresse(s) ReplyTo de l'en-tête du message électronique. Pour plus d'informations, voir Indication d'adresses e-mail valides.

En plus des attributs indiqués dans le tableau 8, l'objet métier de premier niveau peut contenir les attributs facultatifs répertoriés dans le tableau 9.

Tableau 9. Attributs facultatifs d'un objet métier de premier niveau pour e-mail
Nom Description
PriorityLevel
Les valeurs valides sont Normal, High et Low. L'adaptateur utilise cette valeur pour déterminer la priorité du message sortant.
ContentType
Les valeurs valides sont text/plain et text/html. La valeur par défaut est text/plain.
DataEncoding
Type de message. Soit text soit binary. La valeur par défaut est text.
attributs qui représentent les objets métier hiérarchiques L'adaptateur convertit les objets métier enfants en pièces jointes à un message électronique.
attributs qui spécifient les noms des fichiers L'adaptateur inclut les fichiers en tant que pièces jointes au message électronique.

La figure 4 illustre la structure de base d'un objet métier de premier niveau, nommé Email_TLO_Customer_Wrapper, pour l'adaptateur pour e-mail. Cet objet métier contient un objet métier Customer hiérarchique en tant qu'enfant, et inclut un attribut pointant vers un fichier. L'objet métier Customer et le fichier sont ajoutés au courrier électronique en tant que pièces jointes.

Figure 4. Exemple d'objet métier d'adaptateur pour e-mail
Exemple d'objet métier d'adaptateur pour e-mail

Structure facultative d'objet métier enfant pour la personnalisation des noms des pièces jointes et l'envoi de pièces jointes binaires

Par défaut, l'adaptateur pour e-mail crée une pièce jointe nommée d'après l'objet métier envoyé pour demander le traitement, et complète le message électronique avec les informations obtenues dans les listes d'attributs obligatoires et facultatifs indiquées ci-dessus. Toutefois, pour créer un nom de pièce jointe personnalisé ou inclure une pièce jointe binaire, chaque objet métier doit utiliser un objet métier enfant pour préciser les informations relatives à la pièce jointe. Voir le tableau 10 pour connaître les attributs facultatifs des objets métier enfants pour les informations relatives aux pièces jointes.

Tableau 10. Attributs facultatifs d'objets métier enfants
Nom Description
AttachmentName
Nom de la pièce jointe. Cet attribut remplace les valeurs définies dans la propriété de l'extension de la pièce jointe. Il est au format nom de la pièce jointe + extension.
DataEncoding
Indique si l'objet métier doit être converti en un pièce jointe binaire ou non binaire. Si cette valeur n'est pas définie, l'adaptateur utilisera la valeur DataEncoding indiquée dans les attributs de méta-objet de l'adaptateur.
MimeType Instanciation MimeType pour DataHandler. Si cette valeur n'est pas définie, l'adaptateur utilisera la valeur MimeType définie dans les attributs de méta-objet de l'adaptateur.

En cas d'utilisation d'un objet métier enfant pour préciser les informations concernant la pièce jointe, le nom de l'attribut qui se mappe sur l'objet métier enfant doit être mentionné dans l'ASI de l'objet métier de premier niveau. Par exemple, cw_mo_conn=<child_bo_attr_name>.

Structure de Inbound Wrapper BO

La fonctionnalité Inbound Wrapper BO permet au connecteur d'assembler tous les objets métier des pièces jointes des messages électroniques et de les envoyer ensemble au courtier d'intégration. La structure InboundWrapperBO a également des attributs tels que FromAddress et ToAddress, renseignés par le connecteur. Voir le tableau 11 pour connaître les différents attributs pris en charge par la structure InboundWrapperBO.

Tableau 11. Attributs InboundWrapperBO pris en charge
Nom Type Cardinalité Signification Obligatoire dans la structure de l'objet métier
FromAddress String 1 En-tête "From" du message électronique Oui
ToAddress
String 1 En-tête "To" du message électronique Oui
CC String 1 En-tête "CC" du message électronique Oui
BCC String 1 En-tête "BCC" du message électronique Oui
Subject String 1 Objet du courrier Oui
ReplyTo String 1 En-tête ReplyTo du message électronique Oui
SentDate String 1 Date et heure d'envoi du message électronique Oui
ReceivedDate String 1 Date et heure de réception du message électronique Oui
<actual_bo> <bo_type> <1/N> Type d'objet métier réel. Exemples : Customer
Invoice
PurchaseOrder
Oui

Remarque :
Dans le tableau 11, <actual_bo> contient l'objet métier central (Customer, Invoice, etc.) créé à l'aide du gestionnaire de données. Chaque objet métier enfant a également un objet métier enfant pour conserver les informations liées à la pièce jointe. Comme ces valeurs d'attribut sont renseignées dynamiquement par le connecteur, le nom doit être indiqué dans l'ASI au niveau de l'objet métier, sous la forme suivante :

cw_mo_conn=<child_bo_attribute_name>

child_bo_attribute_name est le nom de l'attribut qui se mappe sur le méta-objet de la pièce jointe. Pour obtenir une liste des attributs pris en charge par le méta-objet de la pièce jointe, voir le tableau 12.

Tableau 12. Attributs pris en charge par le méta-objet de la pièce jointe
Nom Type Cardinalité Signification Obligatoire dans la structure de l'objet métier
AttachmentName String 1 Nom de la pièce jointe Oui
Size* String 1 Taille de la pièce jointe Oui
MimeType String 1 MimeType de la pièce jointe Oui

Remarque :
* Taille en octets. La taille ne se mappe pas sur la taille exacte de la pièce jointe, mais retourne une estimation utilisée pour calculer la taille du contenu affiché dans une interface utilisateur.

Attributs précisant les objets métier

Tout objet métier peut être inclus dans l'objet métier pour e-mail de premier niveau, ainsi longtemps que l'objet métier contenu est conforme aux exigences imposées par le gestionnaire de données configuré. Si un attribut est un objet métier, sa cardinalité doit être égale à 1.

Lors de la création de définitions d'objets métier pour l'adaptateur pour e-mail, gardez à l'esprit qu'un gestionnaire de données de l'adaptateur doit placer dans une unique pièce jointe chaque objet métier contenu dans l'objet métier de premier niveau. Par défaut, l'adaptateur convertit chaque pièce jointe en un objet métier et l'envoie séparément au courtier. Toutefois, si vous configurez la propriété InboundWrapperBO, l'adaptateur rassemblera tous les objets métier des pièces jointes de message du gestionnaire de données, et les enverra ensemble au courtier.

Pour cela, l'adaptateur créera un objet métier d'encapsuleur. L'objet métier d'encapsuleur contiendra les informations sur le courrier électronique, ainsi que les objets métier réels créés par le gestionnaire de données (tel que Customer ou Invoice). Ensuite, chaque objet métier inclus dans l'objet métier d'encapsuleur aura un objet métier enfant pour conserver les informations relatives aux pièces jointes. Pour plus d'informations sur les pièces jointes, voir Structure facultative d'objet métier enfant pour la personnalisation des noms des pièces jointes et l'envoi de pièces jointes binaires.

La structure d'objet métier d'encapsuleur a des attributs (tels que FromAddress, ToAddress et ReplyTo) qui sont renseignés de façon dynamique par l'adaptateur quand la propriété InboundWrapperBO a été définie. Pour que l'adaptateur effectue cette action, le nom de l'objet métier enfant doit avoir été identifié dans l'ASI d'objet métier, avec le format suivant :

cw_mo_conn=<child_bo_attr_name>

<child_bo_attr_name> est le nom de l'attribut qui se mappe sur le méta-objet de la pièce jointe. Pour connaître les attributs pris en charge par le méta-objet de la pièce jointe, voir le tableau 13.

Tableau 13. Attributs pris en charge par le méta-objet de la pièce jointe
Nom Type Cardinalité Signification Obligatoire dans la structure de l'objet métier
AttachmentName String 1 Nom de la pièce jointe Oui
Size String 1 Taille approximative de la pièce jointe (en octets) Oui
MimeType String 1 MimeType de la pièce jointe Oui

Attributs précisant les fichiers

Pour joindre un fichier à un message électronique, indiquez le nom de fichier complet, y compris le nom du chemin. Si le fichier réside sur une autre machine, indiquez le nom du fichier en appliquant la convention de dénomination UNC. Par exemple, si le fichier réside sur une machine nommée Ernesto, indiquez le chemin de la façon suivante : \\Ernesto\Email\EmailMessage.txt. Vous pouvez également mapper un lecteur réseau sur la machine et indiquer le nom de fichier sous la forme F:\Email\EmailMessage.txt.

Mode de traitement des objets métier et des fichiers

Une fois que l'adaptateur a traité l'ensemble des attributs de base de l'objet métier de premier niveau, il recherche des attributs supplémentaires. Ils peuvent être de type String ou objet métier. Si l'attribut est d'un autre type, l'adaptateur l'ignore. L'adaptateur traite chaque attribut non null supplémentaire de la façon suivante :

Après avoir traité tous les attributs non null de l'objet métier de premier niveau, l'adaptateur envoie le message.

Conformité de l'objet métier avec les exigences du gestionnaire de données

Vous pouvez inclure tout objet métier dans l'objet métier d'encapsuleur de premier niveau de l'adaptateur pour e-mail, mais ces objets métier doivent livrer les données dans un format conforme aux exigences du gestionnaire de données utilisé pour convertir les données.

Par exemple, pour le gestionnaire de données BySize, une définition d'objet métier doit préciser la propriété d'attribut MaxLength ^pir chaque attribut d'objet métier. Pour le gestionnaire de données XML, la définition de l'objet métier doit inclure un texte spécifique à l'application lui permettant de générer un document XML.

Vous devez donc créer vos propres définitions d'objets métier pour chaque type de données à traiter. Dans la définition de l'objet métier, indiquez uniquement les données requises par l'application et les informations exigées par le gestionnaire de données. Vous pouvez ensuite inclure ces objets métier dans un objet métier de premier niveau d'adaptateur pour e-mail.

Voir le Data Handler Guide pour obtenir des informations spécifiques à chaque gestionnaire de données.

Traitement des instructions d'objet métier

Lors du traitement des requêtes d'objet métier, l'adaptateur pour e-mail gère uniquement l'instruction Create. Il indique un échec pour toute autre instruction. L'adaptateur conserve l'instruction des objets métier enfants.

Pour la notification des événements, chaque courrier électronique peut générer plusieurs objets métier. L'application qui envoie le message électronique est chargée de définir l'instruction de chaque objet métier. Le gestionnaire de données ne traite pas les instructions de ces objets métier, mais il les répercute dans les objets métier qu'il génère.

Propriétés des attributs des objets métier

Les attributs d'objet métier ont des propriétés qui peuvent affecter la façon dont l'adaptateur et le courtier d'intégration traitent ces attributs. Le tableau 14 indique comment l'adaptateur pour e-mail utilise ces propriétés pour les attributs de l'objet métier de premier niveau.

Tableau 14. Propriétés d'attribut d'objets métier
Propriété d'attribut Description
Required Pour les requêtes d'objet métier, l'adaptateur pour e-mail vérifie si la propriété Required est définie sur True.
Valeurs par défaut Si l'objet métier ne fournit pas de valeur pour un attribut Required, et si une valeur par défaut est précisée, l'adaptateur utilise cette dernière.
Max Length Non utilisé
Type Non utilisé
Key Non utilisé
Foreign Key Non utilisé
Application-Specific Information Non utilisé

Pour la notification d'événement, l'adaptateur pour e-mail n'utilise pas de propriétés d'attributs d'objet métier.

Copyright IBM Corp. 2003, 2005