Appel d'un service Web REST à partir d'un flot de travaux

Pour appeler un service Web REST, identifiez les paramètres utilisés pour appeler le service Web REST. Testez l’échange de données entre RICOH ProcessDirector et l’application. Ajoutez ensuite une étape basée sur le modèle d'étape CallRESTService au flot de travaux.
Pour appeler un service Web REST à partir d'un flot de travaux :
  1. 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.

  2. 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.

  3. 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.
  4. Si le service Web comprend une charge, décidez comment vous souhaitez fournir cette information :
    • Vous pouvez entrer la charge comme valeur de la propriété Charge de la requête.
    • Vous pouvez stocker la charge dans un fichier texte auquel l’étape CallRESTService peut accéder pendant le traitement des travaux.
  5. Cliquez sur l'onglet Flot de travaux.
  6. Cliquez sur le nom du flot de travaux à modifier.
  7. En option: Désactivez le flot de travaux en cliquant sur le commutateur à gauche du nom du flot de travaux.
    Si vous ne désactivez pas le flot de travaux pendant que vous le modifiez, les travaux qui l'utilisent continuent à suivre les étapes de la procédure. Lorsque vous enregistrez, le flot de travaux est momentanément désactivé, puis il est activé à nouveau. Les travaux qui sont en cours de traitement dans le flot de travaux pourraient se déplacer dans l'erreur.
  8. Passez en revue la procédure incluse dans le flot de travaux et les valeurs par défaut définies lors de cette procédure.
  9. Ajoutez une étape basée sur le modèle d'étape CallRESTService au flot de travaux à l’emplacement approprié.
  10. Définissez les valeurs des propriétés de travail.
    1. Définissez la propriété URL de la requête sur l'URL du service Web appelé par l'étape.
      L'adresse URL peut utiliser au choix le protocole HTTP ou le protocole HTTPS.
    2. Définissez la valeur de la propriété Méthode de demande sur la valeur requise par le service Web.
    3. Définissez la propriété Mot de passe sur le mot de passe que l’étape fournit au service Web REST pour procéder à l’authentification avec l’application.
      Entrez le mot de passe comme valeur de cette propriété. Pour fournir le mot de passe au service Web REST , spécifiez la propriété Job.WebService.Password sous forme de symbole dans la propriété Charge de la requête, En-tête de la requête ou Paramètres de la requête : ${Job.WebService.Password}. Pour déterminer quelle propriété utiliser, reportez-vous à la documentation du service Web.
    4. Définissez la propriété Type de charge de requête :
      • Pour spécifier le corps de la demande de service Web comme valeur de la propriété Charge de la requête, sélectionnez TEXTE.
      • Pour spécifier le corps de la demande de service Web dans un fichier texte auquel l’étape CallRESTService peut accéder pendant le traitement du travail, sélectionnez FICHIER.
        Remarque:
      • Si vous ne spécifiez pas de charge, RICOH ProcessDirector ignore la valeur de cet propriété.
    5. Si le service Web comprend une charge, définissez la valeur de la propriété Charge de la requête :
      • Si vous avez défini la propriété Type de charge de requête sur TEXTE, entrez la charge comme valeur de cette propriété.
      • Si vous avez défini la propriété Type de charge de requête sur FICHIER, entrez le chemin complet, le nom et l'extension du fichier texte comme valeur de cette propriété.

        Indiquez la charge comme contenu du fichier texte.

      Pour envoyer le mot de passe dans la charge, spécifiez la propriété Job.WebService.Password sous forme de symbole.

      Dans cet exemple XML, l’ID de la commande est stocké comme valeur de la propriété de travail Personnalisé 3 ( Job.Info.Attr3). La charge inclut le mot de passe comme valeur de l'élément <Token> et l'ID de commande comme valeur de l'élément <OrderID> :

      <Token>${Job.WebService.Password}</Token><OrderID>${Job.Info.Attr3}</OrderID>

      L’étape résout les symboles lorsqu’elle appelle le service Web REST.

    6. 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 deux paramètres : token et orderID. La valeur de chaque mot-clé est un symbole RICOH ProcessDirector. Chaque symbole contient une des propriétés suivantes : Job.WebService.Password et Job.Info.Attr3.

      token:${Job.WebService.Password}orderId:${Job.Info.Attr3}

      L’étape résout les symboles lorsqu’elle appelle le service Web REST.

    7. 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.
    8. Définissez la propriété Fichier de réponses sur le chemin d'accès complet et le nom du fichier utilisé par RICOH ProcessDirector pour stocker la réponse de l'application.
      Généralement, cette valeur est ${getFileName(print,json,write)} ou ${getFileName(print,xml,write)}, selon le type de réponse que l’application renvoie.
      Une fois la réponse stockée dans le fichier, les autres étape du flot de travaux peuvent la traiter.
  11. Lorsque vous avez terminé, cliquez sur OK.
  12. Enregistrez et activez le flot de travaux.

Une fois vos flots de travaux configurés, testez l’échange de données entre RICOH ProcessDirector et l’application.

Exemple

La fonction Activation des services Web inclut un flot de travaux RestfulWebServiceWF fourni avec une étape CallRESTService.

Related information:

CallRESTService
CallSOAPService
Installation d'un certificat de sécurité pour un site Web
Configuration du système pour l'utilisation d'un serveur proxy
Rubrique parente : Préparation à l'utilisation de flots de travaux