Préparation de la récupération de l’entrée des services Web REST
- Découvrez les exigences de communication avec le service Web REST pour l’application
:
- Les valeurs d’authentification avec l’application
- Les valeurs de demande de données au service Web REST
- Le format des données fournies dans la réponse
Reportez-vous à documentation de l’application ou consultez l’entreprise qui l’héberge.
- Pour préparer RICOH ProcessDirector à communiquer avec l’application, procédez comme suit :
- Si l’application nécessite un certificat de sécurité, installez-le sur l’ordinateur principal RICOH ProcessDirector.
- Si votre environnement exige un serveur proxy pour communiquer avec les services Web, configurez le système afin de l’utiliser.
Pour plus d'informations, consultez les tâches connexes.
- Exécutez un test manuel qui effectue une authentification avec l’application et demande
une réponse du service Web REST. Assurez-vous que le service Web renvoie la réponse
désirée.De nombreux navigateurs disposent de plug-ins, comme Boomerang pour Google Chrome, qui testent les appels du service Web aux clients REST.
- Décidez comment vous souhaitez que l’unité d'entrée du service Web REST crée les travaux
à partir des données de la réponse renvoyée par le service Web.
- Chaque fois que l'unité d'entrée reçoit une réponse, elle peut créer un travail contenant toutes les données XML ou JSON dans la réponse.
- L'unité d'entrée peut examiner la réponse à l’aide d’une expression XPath ou JSONPath.
Si l'unité d'entrée trouve des éléments XML ou des objets JSON spécifiés par l'expression, elle crée un travail pour chaque élément ou objet correspondant. Chaque travail contient l’élément ou l’objet correspondant et tous les éléments ou objets qui y sont imbriqués. Si l'unité d'entrée trouve plusieurs éléments ou objets, elle peut créer des travaux indépendants ou des travaux enfants.
Si l'unité d'entrée ne trouve aucun élément correspondant, elle ne crée par de travail.
- Définissez une unité d'entrée du service Web REST :
- Cliquez sur l'onglet Administration.
- Dans la sous-fenêtre de gauche, cliquez sur .
- Cliquez sur .
Vous pouvez également copier l’unité d'entrée du service Web REST fournie RestfulWebServiceSample . - Dans l'onglet Général :
- Indiquez un nom pour l’unité d’entrée.
- Définissez la valeur de la propriété Intervalle d’interrogation sur la durée pendant laquelle vous souhaitez que l'unité d'entrée attende entre les appels du service Web.
- Après avoir défini un flot de travaux pour traiter les travaux XML ou JSON, définissez la valeur de la propriété Flot de travaux enfant sur le nom de ce flot de travaux.
- Entrez des valeurs pour les autres propriétés à définir.
- Dans l’onglet Requête :
- Définissez la valeur de la propriété URL de la requête sur l’URL du service Web qui renvoie les données que RICOH ProcessDirector utilise pour créer un ou plusieurs travaux.
- Définissez la valeur des propriétés Méthode de demande et Type de contenu de demande sur les valeurs requises par le service Web.
- Pour la valeur de la propriété Charge de la requête, spécifiez le corps de la requête de services Web que l'unité d'entrée soumet à l’application.Pour spécifier une marque d’accréditation et une plage de temps qui correspond à la valeur de la propriété Intervalle d’interrogation, utilisez des symboles pour ces propriétés :
Nom de base de données de la propriété Nom d'interface utilisateur de la propriété Remarques WebService.Credential Néant RICOH ProcessDirector Stocke la marque d’accréditation du service Web dans cette propriété. WebService.CurrentRequestTime Néant RICOH ProcessDirector définit la valeur de cette propriété sur le début de l’intervalle d’interrogation. WebService.LastSuccessRequestTime Onglet Statut : Heure de la dernière requête réussie Lorsque l'unité d'entrée communique avec succès avec l’application, RICOH ProcessDirector définit la valeur de cette propriété sur la valeur de la propriété WebService.CurrentRequestTime. Une communication réussie se traduit par un code de réponse 200, même si RICOH ProcessDirector ne reçoit aucune donnée permettant de créer des travaux. - Remarque:
- Ces trois propriétés de travail sont utilisés comme exemples de valeur XML pour la propriété Charge de la requête et comme exemples de valeurs JSON pour la propriété Paramètres de la requête. Ce sont les exigences du service Web qui déterminent les propriétés qui doivent soumettre ces valeurs ainsi que d’autres.
Dans cet exemple XML, la charge inclut les éléments suivants : <Token>, <TimeRange>, <Start> et <End>. Les valeurs de trois éléments sont des symboles :
<Token>${WebService.Credential}</Token> <TimeRange> <Start>${WebService.LastSuccessRequestTime}</Start> <End>${WebService.CurrentRequestTime}</End> </TimeRange>
L'unité d'entrée résout ces symboles lorsqu’elle interroge l’entrée.
- Définissez les valeurs des propriétés En-tête de la requête et Paramètres de la requête, en fonction des exigences.Chaque champ ou paramètre d’en-tête est une paire mot-clé/valeur. Chaque paire doit figurer sur une ligne indépendante et être séparée par un signe deux-points (:) ou égal (=).
Le mot-clé et la valeur peuvent être plusieurs mots. RICOH ProcessDirector utilise le premier signe deux-points ou égal de chaque ligne pour séparer les mots en paire mot-clé/valeur.
L’exemple suivant contient trois paramètres : token, start et end. La valeur de chaque mot-clé est un symbole RICOH ProcessDirector. Chaque symbole contient une des propriétés suivantes : WebService.Credential, WebService.LastSuccessRequestTime et WebService.CurrentRequestTime.
token:${WebService.Credential} start:${WebService.LastSuccessRequestTime} end:${WebService.CurrentRequestTime}
L'unité d'entrée résout ces symboles lorsqu’elle interroge l’entrée.
- Sélectionnez une valeur pour la propriété Créer un travail à partir de la réponse afin de spécifier comment l'unité d'entrée crée des travaux à partir de l’entrée
:
- Pour créer un travail chaque fois que l'unité d'entrée reçoit une réponse, sélectionnez Toujours.
- Pour examiner le code XML ou JSON de la réponse et créer un travail chaque fois qu’un élément XML ou un objet JSON est trouvé, sélectionnez Uniquement lorsque le masque de réponse correspond.
- Si vous avez sélectionné Uniquement lorsque le masque de réponse correspond :
- Définissez la propriété Masque de correspondance de la réponse sur l’expression XPath qui identifie l'élément XML ou l’expression JSONPath qui identifie l’objet JSON.
- Définissez la propriété Créer des travaux enfants sur Oui si vous souhaitez créer des travaux enfants lorsque l'unité d'entrée trouve plusieurs correspondances. L'unité d'entrée crée aussi un travail parent sans aucune donnée. Si l'unité d'entrée trouve une correspondance, elle crée un travail indépendant.
- Définissez la propriété Créer des travaux enfants sur Non si vous souhaitez créer des travaux indépendants quel que soit le nombre de correspondances que trouve l'unité d'entrée.
- Si votre environnement exige un serveur proxy pour communiquer avec les services Web, définissez la propriété Utiliser un proxy sur le serveur proxy correct.
- Définissez la propriété Décalage de fuseau horaire sur le décalage en heures entre le fuseau UTC (Coordinated Universal Time) et celui
utilisé par le service Web.Par exemple, si le service Web utilise l’heure normale du Pacifique (PST), définissez la propriété sur -8.
- Remarque:
- Veillez à modifier cette propriété lorsqu’un emplacement où est hébergé le service Web passe de l’heure normale à l’heure d'été. À défaut, vous risquez, pendant l’heure perdue ou gagnée, de perdre les données que RICOH ProcessDirector utilise pour créer les travaux.
- Si le service Web utilise l’heure UTC, indiquez 0 ou laissez le champ vide.
- Dans l’onglet Authentification, spécifiez les valeurs requises pour l’authentification avec l’application.Pour plus d’informations, consultez la tâche connexe associée à l’authentification avec un service Web REST.
Si l’application ne nécessite pas d’authentification, laissez toutes les propriétés d’authentification vides.
- En option: Dans l’onglet Avancé, spécifiez les éventuelles propriétés facultatives de votre environnement.
- Lorsque vous avez terminé, cliquez sur OK.
Lorsque vous avez fini de configurer vos unités d’entrée, les notifications et les flots de travaux, testez l’échange de données entre RICOH ProcessDirector et l’application.
Examinez l’unité d'entrée du service Web REST fournie RestfulWebServiceSample.