Préparation à l’envoi de statut à 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 de l’événement qui doit déclencher la notification et les conditions qui déterminent
quand la notification appelle le service Web.Si vous souhaitez envoyer une notification pour un événement qui ne se produit que lorsqu’un flot de travaux spécifique traite un travail, indiquez ce flot de travaux comme condition.
- Définissez une notification de service Web REST :
- Cliquez sur l'onglet Administration.
- Dans la fenêtre de gauche, cliquez sur .
- Cliquez sur .
Vous pouvez également copier la notification de service Web REST fournie RestfulWebServiceSampleNotify . - Dans l'onglet Général, entrez un nom pour la notification.
- Dans l’onglet Requête :
- Définissez la propriété URL de la requête sur l’URL du service Web à notifier.
- Définissez la valeur de la propriété Méthode de demande sur la valeur requise 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.Dans cet exemple XML, la charge inclut deux éléments XML : <Token> et <OrderNumber>.
<Token>${WSNotification.WebService.Credential}</Token> <OrderNumber>${Job.Info.Attr1}</OrderNumber>
La valeur de chaque élément est un symbole RICOH ProcessDirector contenant une propriété. Si vous utilisez un service Web pour l’authentification avec l’application, incluez la propriété WSNotification.WebService.Credential dans un symbole. Remplacez l’autre élément et l’autre propriété par les éléments et propriétés que vous souhaitez envoyer à l’application. La notification résout les symboles lorsqu’elle envoie le statut au service Web REST.
- 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, orderNumber et customerName. La valeur de chaque mot-clé est un symbole RICOH ProcessDirector. Chaque symbole contient une des propriétés suivantes : WSNotification.WebService.Credential, Job.Info.Attr1 et Job.CustomerName.
token:${WSNotification.WebService.Credential} orderNumber:${Job.Info.Attr1} customerName:${Job.CustomerName}
L’unité d’entrée résout les symboles lorsqu’elle envoie le statut au service Web REST.
- 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.
- 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.
- Dans l'onglet Événement :
- Sélectionnez le type d'objet à surveiller.
- Sélectionnez la propriété, l'action et la valeur à surveiller.
- Pour définir un autre événement, cliquez sur + à droite d'un événement.
- Pour supprimer un événement, cliquez sur - à droite de l'événement que vous souhaitez supprimer.
Par exemple, pour envoyer une notification lorsque le statut d'un travail devient Conservé, sélectionnez Statut actuel du travail, Change en et Conservé. - Dans l'onglet Conditions :
- Sélectionnez la propriété et la valeur à satisfaire avant d'envoyer des notifications éventuelles.
- Pour définir une autre condition, cliquez sur + à droite d'un événement.Pour spécifier comment se combinent les conditions, sélectionnez Une, Toutes ou Personnalisé.
- Pour supprimer une condition, cliquez sur - à droite de celle-ci.
Par exemple, pour n’envoyer une notification que quand un travail enfant est dans le flot de travaux ProcessWebOrders, spécifiez deux conditions :- Flot de travaux = ProcessWebOrders
- Numéro de travail like*.*
Pour n’appliquer les conditions que quand un travail satisfait aux deux, sélectionnez Toutes.
- 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 la notification de service Web REST fournie RestfulWebServiceSampleNotify.