Emetteur de message - Contexte

L'émetteur peut avoir besoin d'informations contextuelles pour définir certaines informations complémentaires nécessaires au système pour l'envoi de messages. Sélectionnez Administration > Intégration > Emetteur de message, puis la page Contexte.

Description de la page

Définissez le Type de contexte et la Valeur contexte qui contiennent les paramètres pour les émetteurs quand des informations complémentaires sont nécessaires. Voir ci-dessous les valeurs de contexte prises en charge pour les différents types d'émetteur.

Contexte d'émetteur d'email

L'émetteur d'email est utilisé par le service fonctionnel qui envoie des messages email en temps réel.

L'émetteur d'email doit pointer sur la classe de message RTEMAILSNDR. En outre, les enregistrements de contexte suivants doivent être définis pour les émetteurs de ce type.

Type de contexte Description
Nom d'hôte SMTP Nom d'hôte du serveur SMTP.
Nom d'utilisateur SMTP ID utilisateur utilisé pour accéder au serveur SMTP.
Mot de passe SMTP Mot de passe utilisé pour accéder au serveur SMTP.
Adresse SMTP de l'expéditeur Adresse électronique à utiliser dans le champ "De" lors de l'envoi de l'email.
Activation SMTP TLS Définissez la valeur sur "true" ou "Y" (O) pour envoyer des emails au moyen du protocole TLS (Transport Layer Security).
Expiration du délai de réponse Durée d'attente du système pour obtenir une réponse en temps réel.

Une fois vos expéditeurs de courriel définis, configurez dans Option de message l'expéditeur d'email par défaut à utiliser lorsqu'aucun expéditeur explicite n'est défini.

Emetteur HTTP

Les émetteurs HTTP envoient des messages à un serveur HTTP via un protocole HTTP. Les émetteurs HTTP doivent référencer la classe de message RTHTTPSNDR, RTJSONSNDR ou SOAPSNDR. (Votre implémentation peut utiliser une intégration spécifique qui nécessite la classe de message HTTPSNDR. Celle-ci doit uniquement être utilisée si indiqué dans la documentation de cette intégration.)

Différents paramètres sont nécessaires pour établir une session avec le serveur HTTP cible. Vous devez indiquer ces paramètres en définissant un ensemble de valeurs contextuelles pour l'émetteur. Un ensemble de types de contexte liés aux variables HTTP est fourni avec le système. Cette section décrit les types de contexte et indique les valeurs valides, si nécessaire.

Avant de définir l'émetteur HTTP, vous devez établir comment le serveur HTTP, de l'autre côté, traite la réception de la requête et, en particulier, répondre aux questions suivantes :

  • Quelle est l'adresse du serveur HTTP ?
  • Le serveur HTTP utilise-t-il une méthode POST ou GET HTTP ?
  • Si le serveur utilise la méthode POST, comment le contenu des messages est-il transmis ? Utilise-t-il un formulaire HTTP ou transmet-il les données dans le corps d'un message XML ?
Type de contexte Description Valeurs
URL1 - URL9 HTTP

Utilisées pour créer l'URL du serveur HTTP cible.

Comme l'URL peut être longue et complexe, vous pouvez la scinder en parties plus petites, chacune d'entre elles étant définie par un enregistrement de contexte distinct. L'URL complète est créée en concaténant les valeurs des URL 1 à 9.

Vous pouvez utiliser des variables de substitution quand vous entrez les valeurs pour les parties d'URL. A noter que la chaîne de substitution @XMLMSG@ peut être utilisée pour les appels GET lorsque du code XSL a été appliqué pour convertir le message en paramètres GET HTTP. Cette possibilité est utile lorsque le formulaire HTTP n'est pas applicable au type de message.

Pour connaître la configuration nécessaire pour prendre en charge les URL dynamiques lors de l'envoi d'un message sortant, voir Prendre en charge les URL dynamiques.

Méthode HTTP Méthode HTTP utilisée pour envoyer le message.
Remarque :
La classe d'émetteur de message SOAP SOAPSNDR ne prend en charge que la méthode POST.
POST ou GET
Méthode de transport HTTP Indiquez le type du message. Vous pouvez soit uniquement envoyer le message, soit envoyer le message et attendre une réponse. Send ou sendReceive
Données de formulaire HTTP

Utilisées quand le message est au format formulaire HTML (Content-Type : application/x-www-form-urlencoded).

Ce contexte indique les paramètres de formulaire (données) qui doivent être transmis via le message HTML. Comme un formulaire peut être associé à plusieurs paramètres, vous devez ajouter un enregistrement de contexte pour chaque paramètre de formulaire.

La valeur d'un paramètre de formulaire prend le format x=yx est le nom du paramètre du formulaire et y sa valeur.

Si y contient la chaîne @XMLMSG@ (sensible à la casse), alors cette chaîne est remplacée par le contenu du message XML de réponse du service. La chaîne @XMLMSG@ peut être utilisée dans les données du formulaire HTTP ou dans l'URL HTTP, mais pas dans les deux.

Si un enregistrement de contexte de ce type est défini pour un émetteur, l'émetteur utilise le format de message du formulaire HTML pour envoyer le message, même si @XMLMSG@ n'est pas indiqué dans l'un des enregistrements de contexte.

Si un enregistrement de contexte de ce type n'est pas défini pour un émetteur, le XML est alors envoyé avec Content-Type : text/plain. Lorsque vous utilisez la méthode POST, il est inséré dans le corps du message HTTP.

Obligatoire quand vous utilisez la méthode GET. Si vous utilisez la méthode GET et que vous ne spécifiez aucun enregistrement de contexte de type données de formulaire, aucun message n'est transféré au serveur HTTP.

Vous pouvez utiliser des variables de substitution quand vous entrez les valeurs pour les données de formulaire.

Utilisateur de connexion HTTP Le serveur HTTP peut nécessiter une authentification. Ajoutez un enregistrement de contexte de ce type pour indiquer l'utilisateur de connexion à utiliser.
Mot de passe de connexion HTTP Le serveur HTTP peut nécessiter une authentification. Ajoutez un enregistrement de contexte de ce type pour indiquer le mot de passe de connexion à utiliser.
En-tête HTTP

Il arrive que le serveur HTTP, de l'autre côté, nécessite l'ajout d'en-têtes HTTP au message.

Pour chaque en-tête HTTP qui doit être spécifié, vous devez ajouter un enregistrement de contexte associé à une valeur au format x:y, où x est le nom de l'en-tête et y la valeur de l'en-tête.

Remarque :
L'installation prend également en charge les en-têtes HTTP dynamiques qui peuvent être inclus dans le message lors de l'exécution.
Délai d'attente HTTP Indique la durée de l'attente pour établir une connexion avec un système distant.
Codage des caractères Indique si le message doit être codé. L'émetteur ajoute à l'en-tête de type de contenu HTTP la chaîne ;charset=x, où x est la valeur de ce contexte qui codera les données à l'aide de ce format de code à l'envoi du message. UTF-8 ou UTF-16
Expiration du délai de réponse Temps pendant lequel le système doit attendre que le système distant envoie une réponse.
Type de sécurité pour l'expéditeur Indique le type de sécurité à appliquer. (Notez que des types de sécurité supplémentaires ne sont applicables qu'à l'expéditeur SOAP. Voir ci-dessous pour plus d'informations.) BASIC (HTTP de base), TEXT (jeton de nom d'utilisateur en texte simple), DIGEST - Jeton de nom d'utilisateur en condensé, OWSM - Sécurité OAuth via OWSM, OAUTH - Sécurité OAuth.
Ensemble de règles OWSM

Applicable uniquement si le type de sécurité de l'émetteur est OWSM. Définit l'ensemble de règles à appliquer.

Entrez une valeur valide pour la consultation avancée Ensemble de règles (F1-SetOfPolicies). L'installation standard fournit la valeur F1-OAUTH, qui peut être utilisée ici.
Type d'octroi OAuth

Applicable uniquement si le type de sécurité de l'émetteur est OAUTH . Définit la méthode de spécification OAuth pour l'acquisition d'un jeton d'accès.

client_​credentials
URL du jeton d'accès OAuth

Utilisée pour créer l'URL du serveur d'autorisation cible. Vous pouvez utiliser des variables de substitution pour construire l'URL.

ID de client OAuth

Identifiant généré pour l'application en cours dans le serveur d'autorisation du système tiers.

Secret client OAuth

Clé secrète associée à l'ID de client OAuth fourni par le serveur d'autorisation du système tiers.

Trousseau de clés OAuth

Définit le trousseau de clés utilisé pour stocker l'ID client OAuth et la clé secrète fournis par le serveur d'autorisation du système tiers. Si un trousseau de clés est spécifié, les entrées de contexte ID de client OAuth et Secret client OAuth ne sont pas autorisées.

Périmètre API REST OAuth

Niveau d'autorisation accordé par le point de terminaison.

Détails de requête de jeton OAuth dans le corps

Par défaut, la demande de jeton d'autorisation inclut les informations d'ID de client et de clé secrète dans l'en-tête de message. Ce type de contexte peut être utilisé pour indiquer que ces informations doivent être envoyées dans le corps de la demande.

Attribuez à cette option la valeur "Y" (Oui) pour envoyer les informations d'ID de client et de clé secrète dans le corps de la requête de jeton d'autorisation.

Emetteur HTTP en temps réel

Le type de contexte suivant n'est applicable qu'aux émetteurs ayant la classe de message RTHTTPSNDR.

Type de contexte Description
Type de contenu Indiquez ici une valeur pour remplacer l'attribut Content-Type dans l'en-tête HTTP, dont la valeur par défaut est text/xml.

Emetteur SOAP

Un émetteur SOAP est un émetteur HTTP qui ajoute automatiquement la prise en charge du format SOAP. Pour ce type d'émetteur (classe de message SOAPSNDR), outre les valeurs de contexte répertoriées ci-dessus, les entrées de contexte suivantes peuvent également être fournies.

Type de contexte Description Valeurs
URI d'espace de noms de message Permet d'indiquer un espace de noms spécifique à inclure dans les messages de cet émetteur. Notez que cette valeur était uniquement utilisée lorsque le lien Message externe vers cet émetteur est configuré avec l'option d'espace de noms Configuré sur l'émetteur.
SOAP - Insérer l'horodatage Indique si l'horodatage doit être ajouté. La valeur par défaut est N. Y (O) ou N
Délai d'expiration SOAP (en secondes) Indique le délai d'expiration à ajouter à l'horodatage. La valeur par défaut est 60.
Type de sécurité pour l'expéditeur Des types de sécurité supplémentaires sont pris en charge pour les expéditeurs SOAP pour des intégrations tierces spécifiques. CIM - Utilise un espace de noms approprié et ajoute des informations de sécurité dans l'en-tête SOAP propre à Landis+Gyr, MS_​V30 - Utilise un espace de noms approprié et ajoute des informations de sécurité dans l'en-tête SOAP propre à MultiSpeak v3.0, MS_​V41R - Utilise un espace de noms approprié et ajoute des informations de sécurité dans l'en-tête SOAP propre à MultiSpeak v4.1. ITRON - Utilise les informations de sécurité d'en-tête SOAP appropriées dans l'en-tête SOAP propre à Itron.
Remarque :
Pour plus d'informations sur l'inclusion dynamique de paramètres d'en-tête SOAP lors de l'envoi d'un message, voir Ajouter des paramètres d'en-tête SOAP lors de l'exécution.

Emetteur JMS

Un émetteur JMS est un émetteur envoyant des messages à une file d'attente JMS ou à un thème JMS. Les émetteurs JMS doivent référencer la classe de message RTJMSQSNDR ou RTJMSTSNDR, respectivement.

Les paramètres ci-dessous sont utilisés pour la connexion à la ressource JMS.

Type de contexte Description Valeurs
Type de message JMS (Octets(Y(O))/Texte(N)) Indique si les données sont envoyées sous forme de message octets ou de message texte. Y (O) ou N
Nom utilisateur JMS Entrez le nom utilisateur pour la connexion à la ressource JMS.
Mot de passe de l'utilisateur JMS Entrez le mot de passe à utiliser pour la connexion à la ressource JMS.
En-tête JMS

Si des valeurs d'en-tête JMS sont requises pour le message, utilisez ce type de contexte.

Pour chaque en-tête JMS qui doit être spécifié, ajoutez un enregistrement de contexte ayant une valeur au format x:y, où x est le nom de l'en-tête et y sa valeur.

Variables d'application

Certaines API peuvent nécessiter que des variables d'identification d'application soient incluses dans la charge utile du message. Ces valeurs sont généralement disponibles lors du provisionnement et doivent être capturées par rapport à ces configurations d'API.
Remarque :
Ce type de contexte n'est pas impliqué dans le processus d'orchestration et de routage de l'appel d'API. Il doit être incorporé dans la charge utile par la logique applicative qui compose le message à l'aide du script de service "Obtenir les variables d'application (F1MsgVars)".

Les paramètres suivants peuvent être utilisés pour capturer des variables d'application.

Type de contexte Description Valeurs
ID d'application Identifie l'environnement en cours pour cette API. Déterminé au moment du provisionnement par le fournisseur d'API.
ID de locataire Identifie le locataire en cours pour cette API. Déterminé au moment du provisionnement par le fournisseur d'API.