Configuration de modèles d'étape externe utilisant une ligne de commande ou un fichier de contrôle

Cette procédure vous permet de configurer un modèle d'étape externe qui utilise une ligne de commande ou un fichier de contrôle pour transférer les paramètres entre RICOH ProcessDirector et le programme externe.
Pour configurer un modèle d'étape externe, procédez comme suit :
  1. Cliquez sur l'onglet Flot de travaux.
  2. Dans la sous-fenêtre de gauche, cliquez sur Modèles d'étape.
  3. Cliquez avec le bouton droit sur le modèle d'étape RunExternalProgram et sélectionnez Copier.
  4. Indiquez un nom et une description pour le nouveau modèle d'étape.
  5. Cliquez sur Externe.
  6. Mettez à jour la propriété Commande externe.
    Voici la commande réelle et tous les paramètres de ligne de commande que RICOH ProcessDirector génère pour exécuter le programme externe. La chaîne de commande peut inclure une notation de symbole RICOH ProcessDirector :
    • Dans l'exemple suivant, la commande Linux cp copie le fichier JobNumber.print.pdf du répertoire spoule du travail uniquement lorsque le fichier source est plus récent que le fichier cible :
      cp -u ${getAbsoluteFileName(print, pdf, read)} /tmp/jobarchives
        Remarque:
      • ${getAbsoluteFileName(print, pdf, read)} correspond à la formule de symbole RICOH ProcessDirector qui renvoie le nom du fichier d'impression PDF dans le répertoire spoule. Si le fichier d'impression PDF n'existe pas dans le répertoire spoule lorsque le programme externe est exécuté, une erreur se produit.
    • Dans cet exemple, le programme externe myprogram lit le fichier NuméroTravail.print.pdf du répertoire spoule et écrit une version mise à jour du fichier dans le répertoire spoule, via le réacheminement :
      myprogram -i ${getFileName(print, pdf, read)} > ${getFileName(print, pdf, write)}
        Remarque:
      • ${getFileName(print, pdf, read)} correspond à la formule de symbole RICOH ProcessDirector qui renvoie le nom du fichier d'impression PDF dans le répertoire spoule. Si le fichier d'impression PDF n'existe pas dans le répertoire spoule lorsque le programme externe est exécuté, RICOH ProcessDirector renvoie le nom du fichier d'entrée pour le travail, qui est JobNumber.print.unknown. Si ce fichier n'existe pas dans le répertoire spoule, une erreur se produit.
    • Dans cet exemple, le programme externe auditstatistics lit le fichier NuméroTravail.overrides.text du répertoire spoule et écrit un nouveau fichier de statistiques, NuméroTravail.statistics.text, dans le répertoire spoule :
      auditstatistics inputfile=${getFileName(overrides, text, read)} outputfile=${getFileName(statistics, text, write)}
    • Dans cet exemple, le programme externe line2afp utilise un fichier de paramètres distinct pour lequel un fichier de contrôle RICOH ProcessDirector correspondant existe si la fonction de support AFP est installée. Le fichier de contrôle définit une méthode RICOH ProcessDirector qui indique au programme externe qu'il doit écrire ses résultats dans le répertoire spoule :
      line2afp parmdd=${getControlFileName()}
        Remarque:
      • ${getControlFileName()} est la formule de symbole RICOH ProcessDirector qui renvoie le nom du fichier de contrôle résolu. RICOH ProcessDirector génère le fichier de contrôle à partir du modèle de fichier de contrôle indiqué.
      • Le fichier de contrôle peut utiliser la méthode getChildFileName pour renvoyer le nom d'un fichier enfant de manière à ce que le programme externe puisse écrire un fichier dans le sous-répertoire children du répertoire spoule. Le programme externe doit écrire les noms des fichiers de travail enfant au format suivant :
        NuméroTravail.TypeSyntaxe.TypeDonnées.n,Job.JobType=NomFlotTravaux
        NomFlotTravaux est le nom du flot de travaux requis par le travail enfant. Ce flot de travaux doit exister et être activé.
      • Lorsque vous ajoutez à un flot de travaux une étape basée sur le modèle RunExternalProgram, les propriétés indiquant la valeur [Recevoir] dans les valeurs par défaut du travail changent pour correspondre à la phase réelle à laquelle l'étape est ajoutée.
    • Dans l'exemple suivant, l'étape externe utilise la commande copier de Windows pour écrire une copie du fichier JobNumber.print.pdf du répertoire spoule dans un répertoire d'archivage du système Windows :
      copy ${getAbsoluteFileName(print,pdf,read)} d:\archive\pdf
        Remarque:
      • Le système Windows doit héberger le produit de base ou un serveur d'applications. Le serveur d'applications doit être connecté au serveur principal.
      • Indiquez le répertoire Windows en renseignant le nom du répertoire au format Windows natif.
      • Lorsque vous le pouvez, utilisez des commandes Windows natives plutôt que des commandes SFU (par exemple, utilisez la commande copier plutôt que la commande cp). En effet, les commandes SFU ne sont pas toutes disponibles sur les systèmes Windows.
      • Certaines commandes rendent le répertoire Windows facultatif. Elles peuvent créer le répertoire sur le système Windows.
      • Veillez à ajuster le modèle d'étape pour qu'il s'exécute uniquement sur un serveur d'applications Windows. En raison des différents formats de noms de répertoire sous Linux, les étapes basées sur ce modèle échoueront si RICOH ProcessDirector essaie de les exécuter sur un système non Windows.
  7. Si vous avez créé un modèle de fichier de contrôle à utiliser avec le programme externe, mettez à jour la propriété Modèle de fichier de contrôle externe. Définissez la valeur sur l'emplacement de répertoire et le nom du modèle de fichier de contrôle. Si le programme externe reçoit uniquement ses paramètres sous forme d'arguments de ligne de commande, supprimez toute valeur correspondant à cette propriété.
  8. Mettez à jour la propriété Codes retour valides.
    Dans ce contexte, un code retour valide est un code en provenance du programme externe qui ne nécessite pas d'intervention de l'utilisateur. Séparez les codes retour multiples par des virgules. Pour tout code retour provenant du programme externe et ne figurant pas dans la valeur de cette propriété, RICOH ProcessDirector affecte au travail l'état d'erreur. Le programme génère également un message dans le journal du travail, pour vous alerter d'un incident signalé par le programme externe.

    Par exemple, si la valeur de la propriété des codes retour valides est 0,4 et si le programme externe s'arrête avec un code retour de 16, RICOH ProcessDirector génère un message semblable à celui-ci :

    AIWI6073E À la fin de son exécution, l'étape externe cp /aiw/aiw1/spool/default/10000016/10000016.print.unknown /archive/directory a renvoyé un code retour 16, ce qui est défini comme une erreur.

  9. Si l'installation a des exigences particulières en matière de langue, vous pouvez également dire au programme externe de renvoyer les messages dans une langue prise en charge. La liste de la propriété Langage du programme externe répertorie les langues prises en charge par RICOH ProcessDirector.
  10. Cliquez sur OK.
  11. Mettez à jour les paramètres de l'onglet Réglage pour exécuter l'étape sur les ordinateurs sur lesquels le programme externe est installé.
  12. Cliquez avec le bouton droit sur le nouveau modèle d'étape et sélectionnez Activer.