Service Web pour la publication des résultats des tâches

VoiceCheck emploie un service Web exposé par le système hôte afin d'afficher les résultats ; il s'agit essentiellement d'une exportation de données. Pour une tâche donnée, ce message peut être envoyé plusieurs fois. Il est envoyé chaque fois qu'un utilisateur soumet des résultats via l'interface utilisateur graphique de VoiceCheck. Il inclut les résultats de toutes les étapes dont le statut est « terminé » ou « ne s'applique pas » au moment de la soumission et qui n'ont pas déjà été envoyées vers le système hôte.

Pour utiliser cette fonction d'exportation, le système hôte doit mettre en œuvre un service Web REST ou SOAP selon les détails spécifiés ci-dessous. VoiceCheck comprend à la fois les clients des services Web REST et SOAP qui peuvent employer un service établi conformément aux spécifications ci-dessous. Pour SOAP, le document WSDL PostAssignmentResults.wsdl inclus dans le profil du produit détaille le contrat que le service SOAP doit mettre en œuvre. Pour REST, un exemple de WADL est inclus dans le profil du produit comme référence pour les programmeurs qui développent un service REST.

Notez que pour REST, la spécification est légèrement plus flexible que celle détaillée dans l'exemple de WADL. En fait, il n'est même pas nécessaire d'utiliser un schéma WADL tant que le comportement du service est conforme à celui indiqué ci-dessous.

Service Web REST

URL : totalement flexible, peut être décidée par chaque mise en œuvre de serveur.

L'URL peut spécifier http ou https. Le client VoiceCheck utilise le transport correspondant au protocole spécifié. Configurez l'URL comme point d'extrémité du service dans la page Administration > Configuration système de l'interface utilisateur.

Exemple : <http ou https>://<serveur>/assignmentResults

Authentification : l'authentification HTTP de base est prise en charge, mais n'est pas obligatoire. Activez l'authentification pour le client VoiceCheck en cochant la case Nécessite une authentification dans la page Administration > Configuration système de l'interface utilisateur.

Méthode : POST

Content-Type : application/xml;charset=UTF-8

Le client VoiceCheck choisit toujours ce type de contenu pour envoyer le contenu des résultats ; la mise en œuvre du serveur hôte doit donc accepter ce type de contenu.

Corps du message : XML tel que décrit dans le schéma WADL, dont les éléments sont décrits dans les tableaux ci-dessous.

Réponse : en cas de succès, HTTP Status 204 (pas de contenu) avec un corps vide. Il est également acceptable que le service renvoie le statut HTTP 200 (réussite) avec ou sans corps. Si le client VoiceCheck reçoit un corps, il est ignoré.

Pour renvoyer le contenu, le serveur doit utiliser le type de contenu : application/xml;charset=UTF-8

Tout code de statut HTTP autre que 200 ou 204 est considéré comme une erreur. Dans la mesure du possible, le système hôte doit renvoyer un corps pour les erreurs contenant un élément faultInfo. Les informations contenues dans l'élément faultInfo sont utilisées pour fournir à l'utilisateur de l'interface utilisateur graphique des détails supplémentaires sur l'erreur. Pour plus de détails, voir la section Traitement des erreurs pour les données de tâche.

Service Web SOAP

WSDL : vous devez créer un serveur qui met en œuvre le fichier PostAssignmentResults.wsdl tel que fourni par Honeywell. Les détails d'entrée ci-dessous décrivent les éléments de données du schéma WSDL.

Point de terminaison de service : totalement flexible, peut être décidé par chaque mise en œuvre de serveur.

L'URL peut spécifier http ou https. Le client VoiceCheck utilise le transport correspondant au protocole spécifié. Configurez l'URL comme point d'extrémité du service dans la page Administration > Configuration système de l'interface utilisateur.

Exemple : <http ou https>://<serveur>/assignmentResultsService

Authentification : l'authentification HTTP de base est prise en charge, mais n'est pas obligatoire. Activez l'authentification pour le client VoiceCheck en cochant la case Nécessite une authentification dans la page Administration > Configuration système de l'interface utilisateur.

Traitement des erreurs : le serveur peut renvoyer toute erreur SOAP. Si le serveur renvoie l'erreur WebServiceException spécifiée dans le schéma WSDL, le message contenu dans la classe WebServiceException s'affiche dans l'interface utilisateur graphique de VoiceCheck, dans le cadre du message d'erreur. Toutes les autres erreurs déclenchent un message d'erreur générique dans l'interface utilisateur graphique.

Détails de l'entrée

Résultats des tâches : en-tête
PropriétéTypeObligatoireDéfinition
siteNamechaîne

oui

Nom du site.
assignmentIdchaîneouiL'assignationId envoyé à partir du système hôte à VoiceCheck dans le message Créer une tâche.
workIdchaîneouiLe workId envoyé à partir du système hôte à VoiceCheck dans le message Créer une tâche.
utilisateurchaîneouiUtilisateur de l'interface utilisateur graphique de VoiceCheck qui a soumis les résultats.
timeSubmitteddatetimeoui

Moment où l'utilisateur a envoyé les résultats au système externe.

Type de données : schéma  XML xs:dateHeure.

Format : valeur de chaîne xs:dateTime valide indiquant l'heure UTC : AAAA-MM-JJThh:mm:ss.sssZ

Exemple : 2014-06-14T19:27:33.152Z

métadonnéesliste des paires clé-valeurnonListe d'informations supplémentaires sur la tâche envoyée dans le message Créer une tâche.
sectionResultsliste des résultats de sectionouiListe des résultats de section définis dans le tableau suivant.
Résultats des tâches : résultats de section
PropriétéTypeObligatoireDéfinition
sectionIdchaîneouiIdentifiant pour la section envoyé par le système hôte dans le message de création de tâche.
stepResults

liste des résultats d'étape

ouiListe des résultats d'étapes définis dans le tableau suivant.
Résultats des tâches : résultats d'étape
PropriétéTypeObligatoireDéfinition
sequenceCounter

chaîne numérique

oui

Chaîne sequenceCounter envoyée pour l'étape dans le message Créer une tâche.

stepIdchaîneouiIdentifiant de l'étape exécutée à partir du VoiceForm. Cette valeur correspond au stepId envoyé pour l'étape dans le message Créer une tâche.
utilisateur

chaîne

ouiNom de l'utilisateur ou du technicien qui a effectué la dernière mise à jour du résultat de l'inspection vocale.
métadonnéesliste des paires clé-valeurnonListe d'informations supplémentaires sur l'étape envoyée dans le message Créer une tâche.
startTime

datetime

oui

Date et heure auxquelles l'opérateur du terminal a démarré l'étape dans l'application vocale.

Type de données : schéma XML xs:dateTime

Format : valeur de chaîne xs:dateTime valide indiquant l'heure UTC : AAAA-MM-JJThh:mm:ss.sssZ

Exemple : 2014-06-14T19:27:33.152Z

Les résultats générés par le système, tels qu'une étape dépendante marquée « ne s'applique pas », ne comprennent pas d'heure de début.

Les paramètres startTime et endTime ne reflètent pas toujours le temps réellement consacré à l'exécution de l'étape car l'application vocale fournit aux techniciens des fonctions permettant d'ignorer et de répéter les étapes.

endTime datetimeoui

Date et heure auxquelles l'opérateur du terminal a terminé l'étape dans l'application vocale.

Type de données : schéma XML xs:dateTime

Format : valeur de chaîne xs:dateTime valide indiquant l'heure UTC : AAAA-MM-JJThh:mm:ss.sssZ

Exemple : 2014-06-14T19:27:33.152Z

Les paramètres startTime et endTime ne reflètent pas toujours le temps réellement consacré à l'exécution de l'étape car l'application vocale fournit aux techniciens des fonctions permettant d'ignorer et de répéter les étapes.

statutentieroui

Valeur entière décrivant l'état final de l'étape.

Valeurs valides :

2 = ne s'applique pas

3 = terminé

résultatsliste de chaînes de caractèresnon

Liste de résultats pour l'étape. Chaque résultat est spécifié sous la forme d'un élément de résultat contenant une chaîne.

Lorsque le statut est « 2 » (ne s'applique pas), aucun résultat n'est envoyé (le XML ne contient aucun élément de résultat).

Lorsque le statut est « 3 » (terminé), les résultats peuvent être envoyés ou non, en fonction du type d'étape. Voir le tableau Résultats pour les étapes terminées ci-dessous.

 

Résultats pour les étapes terminées
Type d'étape (à partir du VoiceForm)Description
Invite seule

Aucun résultat envoyé.

PrêtAucun résultat envoyé.
RemarquesZéro ou plus de résultats envoyés. Un résultat est envoyé pour toute transcription qui n'est pas vide. Si les transcriptions sont vides pour toutes les notes d'une étape, aucun résultat n'est envoyé.
Sélection multiple dans la listeUn ou plusieurs résultats envoyés. Un résultat est envoyé pour chaque sélection effectuée à l'invite. La valeur de chaque résultat est la clé du VoiceForm représentant la sélection effectuée.
Valeur flottanteUn seul résultat envoyé. Le résultat est la valeur prononcée par l'utilisateur.
Saisie de valeurUn seul résultat envoyé. Le résultat est la valeur prononcée par l'utilisateur.
Saisie de valeur longueUn seul résultat envoyé. Le résultat est la valeur prononcée par l'utilisateur.
FractionUn seul résultat envoyé. Le résultat est la valeur prononcée par l'utilisateur.
DateUn seul résultat envoyé. Le résultat est la valeur prononcée par l'utilisateur et formatée conformément au format de date spécifié dans le VoiceForm.
PhotosUn ou plusieurs résultats envoyés. Un résultat est envoyé pour chaque photo prise. La valeur de chaque résultat est l'URL qu'un système externe peut utiliser pour récupérer la photo en utilisant le service Web Get Photo.
Numéro de pièceUn seul résultat envoyé. Le résultat est la valeur choisie ou prononcée par l'utilisateur.