Transformers FME: 2025.0
Se connecte à un serveur WebSocket pour envoyer ou recevoir des messages.
Cas d'utilisation courants
- Recevoir des messages de serveurs WebSocket
- Envoyer des messages aux serveurs WebSocket
- Se connecter à des serveurs WebSocket de FME Flow
Comment fonctionne-t-il ?
La première entité en entrée amènera le WebSocketConnector à initialiser une connexion à l'URL du serveur WebSocket spécifié.
Un message ping est envoyé au serveur toutes les 60 secondes pour maintenir la connexion.
Lorsque Requête > Action est Envoyer, la valeur Donnée à transmettre spécifiée sera envoyée au serveur WebSocket pour chaque entité d'entrée, y compris la première entité qui a initié la connexion.
Lorsque Requête > Action est Recevoir, une entité est produite à chaque fois qu'un message est reçu, avec le contenu du message dans l'attribut _output. Chaque entité entrante amènera le WebSocketConnector à initialiser une connexion au serveur WebSocket spécifié. Le Transformer se bloquera en attendant de recevoir des messages WebSocket jusqu'à ce que l'hôte distant ferme la connexion.
Lorsque le Mode de réception est Par lots (batch), chaque entité d'entrée ne se bloquera que jusqu'à ce que le nombre spécifié de messages soit reçu. Si le mode de réception est Flux (stream), le Transformer continuera à fonctionner jusqu'à ce que l'hôte ferme la connexion.
Configuration
Ports d'entrée
Input
Ce Transformer accepte tous types d'entités.
Ports de sortie
Output
La sortie de ce Transformer varie selon l'action à effectuer.
- Pour l'action Recevoir, les messages reçus seront sauvegardés dans la valeur de l'attribut _output et édités sur une nouvelle entité
- Une action Envoyer enregistre la valeur du message envoyé dans un attribut.
Initiator
L'entité entrante ressort par ce port.
<Rejected>
Les entités qui provoquent l'échec de l'opération sont sorties par ce port. Un attribut fme_rejection_code décrivant la catégorie de l'erreur sera ajouté, ainsi qu'un attribut fme_rejection_message plus descriptif qui contient des détails plus spécifiques sur la raison de l'échec.
Note Si une entité entre dans le WebSocketConnector en ayant déjà une valeur pour fme_rejection_code, cette valeur sera supprimée.
Gestion des entités rejetées : ce paramètre permet d'interrompre la traduction ou de la poursuivre lorsqu'elle rencontre une entité rejetée. Ce paramètre est disponible à la fois comme option par défaut de FME et comme paramètre de traitement.
Paramètres
Connexion
|
URL du serveur WebSocket |
Spécifier l'URL du serveur WebSocket distant. La valeur par défaut est ws://localhost:8080. Pour établir une connexion sécurisée avec un serveur WebSocket utilisant TLS, spécifiez wss://<nom d'hôte>:<port>. |
|
Vérifier les certificats |
Oui ou Non (par défaut Oui). Si oui, WebSocketConnector certifie le certificat (ou chaîne de certificats) du serveur WebSocket avant d'établir la connexion. |
|
Préambule de connexion |
(Facultatif) Fournir une valeur à transmettre au serveur WebSocket après l'établissement d'une connexion et avant la transmission ou la réception de toute donnée spécifiée. Pour vous connecter au serveur WebSocket de FME Flow, utilisez le préambule suivant : { Pour spécifier ce préambule, cliquez sur les points de suspension (...) pour ouvrir la boîte de dialogue Préambule de connexion. Sous Préambules WebSocket de FME Flow, sélectionnez le modèle Open Public Stream. Ensuite, spécifiez une valeur ws_stream_ids. ws_stream_ids identifie un ou plusieurs flux de messages pour que le serveur WebSocket les associe à la correcte application. |
Requête
|
Action |
Sélectionner l'opération à effectuer. Les choix sont :
|
|
Encodage du message |
Sélectionner l'encodage du message. La valeur par défaut est System Default (fme-system). Lorsque l'Action est Envoyer, le paramètre Données à transmettre est traité comme une chaîne codée en système fme et transmis comme une chaîne codée en utf-8. Si un encodage autre que fme-system ou utf-8 est sélectionné, la valeur est encodée et envoyée sous forme d'octets. Lorsque l'Action est Recevoir, les messages sont reçus sous forme d'octets. La valeur de ce paramètre est utilisée pour décoder le message en une chaîne de caractères. Si fme-binary est sélectionné comme encodage pour ce paramètre, le message ne sera pas décodé et restera intact tel qu'il a été reçu. |
Les autres paramètres disponibles dépendent de la valeur du paramètre Requête > Action. Les paramètres de chaque action sont détaillés ci-dessous.
Paramètres - Réception
Options de réception
|
Mode |
Deux options de réception de messages sont disponibles :
|
|
Taille de lot maximum |
Lorsque le Mode est Par lots, spécifier le nombre de messages à recevoir avant de fermer la connexion. |
|
Délai d'attente du message (secondes) |
(Facultatif) Spécifiez une durée en secondes après laquelle la connexion sera fermée si aucun message n'est reçu du serveur. La valeur par défaut est « vide », c'est-à-dire qu'il n'y a pas de délai d'attente. Notez que les trames ping/pong envoyées par le serveur ne sont pas prises en compte dans ce délai. |
Paramètres - Action Envoyer
Options d'envoi des messages
|
Données à transmettre |
Spécifier les données à transmettre au serveur WebSocket. Il peut s'agir d'une valeur textuelle, d'une valeur d'attribut ou du résultat d'une expression. La valeur de ce paramètre sera traitée comme une chaîne encodée en fme-system. Pour envoyer un message au serveur WebSocket de FME Flow, utilisez ce modèle : { Pour spécifier ce modèle, cliquez sur les points de suspension (...) pour ouvrir la boîte de dialogue Données à transmettre. Sous FME Flow WebSocket Messages, sélectionnez le modèle Envoi de message. Ensuite, spécifiez une valeur ws_msg. |
Attributs en sortie
Les attributs suivants peuvent être sélectionnés pour être inclus dans les entités de sortie. Chaque entité de sortie représente un message qui a été soit envoyé, soit reçu.
|
_output |
Le message envoyé ou reçu, en fonction du paramètre Action :
|
|
_timestamp |
La date de création du message en temps unix. |
Éditer les paramètres des Transformers
Les paramètres du Transformer peuvent être définis en saisissant directement des valeurs, en utilisant des expressions ou en faisant référence à d'autres éléments de l'espace de travail tels que des valeurs d'attributs ou des paramètres utilisateur. Divers éditeurs et menus contextuels sont disponibles pour vous aider. Pour voir ce qui est disponible, cliquez sur 
à côté du paramètre concerné.
Définir des valeurs de paramètres
Définir les valeurs
Il existe plusieurs façons de définir une valeur à utiliser dans un Transformer. La plus simple consiste à saisir simplement une valeur ou une chaîne de caractères, qui peut inclure des fonctions de différents types telles que des références d'attributs, des fonctions mathématiques et de chaînes de caractères, et des paramètres traitement.
Utilisation de l'éditeur de texte
L'éditeur de texte fournit un moyen efficace de construire des chaînes de textes (dont les expressions régulières) à partir de données source diverses, telles que des attributs, des paramètres et des constantes, et le résultat est directement utilisé dans le paramètre.
Utilisation de l'éditeur arithmétique
L'éditeur arithmétique fournit un moyen simple de construire des expressions mathématiques à partir de plusieurs données source, telles que des attributs et des fonctions, et le résultat est directement utilisé dans un paramètre.
Valeur conditionnelle
Définit des valeurs selon un ou plusieurs tests.
Fenêtre de définition de conditions
Contenu
Les expressions et chaînes de caractères peuvent inclure des fonctions, caractères, paramètres et plus.
Lors du paramétrage des valeurs - qu'elles soient entrées directement dans un paramètre ou construites en utilisant l'un des éditeurs - les chaînes de caractères et les expressions contenant des fonctions Chaîne de caractères, Math, Date et heure ou Entité FME auront ces fonctions évaluées. Par conséquent, les noms de ces fonctions (sous la forme @<nom_de_fonction>) ne doivent pas être utilisés comme valeurs littérales de chaîne de caractères.
Types de contenu
| Ces fonctions manipulent les chaînes de caractères. | |
|
Caractères spéciaux |
Un ensemble de caractères de contrôle est disponible dans l'éditeur de texte. |
| Plusieurs fonctions sont disponibles dans les deux éditeurs. | |
| Fonctions Date/heure | Les fonctions de dates et heures sont disponibles dans l'Editeur texte. |
| Ces opérateur sont disponibles dans l'éditeur arithmétique. | |
| Elles retournent des valeurs spécifiques aux entités. | |
| Les paramètres FME et spécifiques au traitement peuvent être utilisés. | |
| Créer et modifier un paramètre publié | Créer ses propres paramètres éditables. |
Options - Tables
Outils de tableau
Les Transformers avec des paramètres de style table possèdent des outils additionnels pour remplir et manipuler des valeurs.
|
Réordonner
|
Activé une fois que vous avez cliqué sur un élément de ligne. Les choix comprennent :
|
|
Couper, Copier et Coller
|
Activé une fois que vous avez cliqué sur un élément de ligne. Les choix comprennent :
Copier, copier et coller peuvent être utilisés au sein d'un Transformer ou entre Transfromers. |
|
Filtre
|
Commencez à taper une chaîne de caractères, et la matrice n'affichera que les lignes correspondant à ces caractères. Recherche dans toutes les colonnes. Cela n'affecte que l'affichage des attributs dans le Transformer - cela ne change pas les attributs qui sont sortis. |
|
Importer
|
Le bouton d'import remplit la table avec un jeu de nouveaux attributs lus depuis un jeu de données. L'application spécifique varie selon les Transformers. |
|
Réinitialiser/Rafraîchir
|
Réinitialise la table à son état initial, et peut fournir des options additionnelles pour supprimer des entrées invalides. Le comportement varie d'un Transformer à l'autre. |
Note : Tous les outils ne sont pas disponibles dans tous les Transformers.
Pour plus d'information, consulter la section Options des Transformers.
Références
|
Comportement |
|
|
Stockage des entités |
Non |
| Dépendances | |
| Alias | |
| Historique |
FME Community
FME Community dispose d'une mine de connaissances sur FME, avec plus de 20 000 membres actifs dans le monde entier. Obtenez de l'aide sur FME, partagez vos connaissances et entrez en contact avec des utilisateurs du monde entier.
Voir tous les résultats à propos de ce Transformer sur FME Community.
Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.