Optimisation des étapes de BuildPDFFromDocuments

L'étape BuildPDFFromDocuments est une étape gourmande en ressources qui permet d'assembler un travail PDF à partir de documents qui ont été identifiés par RICOH ProcessDirector. S'il y a un grand nombre de documents ou si vous utilisez des règles complexes dans votre dossier, la durée de traitement de cette étape se mesure en heures et non en minutes. Des options de configuration avancées permettent de réduire le temps de traitement de cette étape pour les travaux très volumineux ou très complexes.
    Important:
  • Cette configuration est très avancée. Elle n'est pas recommandée pour toutes les implémentations de RICOH ProcessDirector.

Votre système est un bon candidat pour cette configuration si toutes ces conditions sont remplies :

  • Le traitement plus rapide d'un seul travail PDF est plus important que le débit total.
  • Vos travaux PDF contiennent de nombreux documents ou utilisent des règles complexes qui rendent le traitement très long.
  • Vous disposez (ou pouvez acquérir) des ressources matérielles adéquates pour le système utilisé par l'étape. Le système doit disposer de nombreux cœurs de CPU, car chaque thread utilisé pour le traitement nécessite trois ou quatre threads d'arrière-plan pour gérer l'utilisation de la mémoire et d'autres activités. Le système doit également disposer d'au moins 16 Go de RAM pour ce traitement sur votre ordinateur principal ou sur des serveurs supplémentaires à configurer en tant que serveurs secondaires.
  • Les membres de votre équipe possèdent les compétences et les outils nécessaires pour contrôler les performances du système. Pour régler correctement le système, vous devez être en mesure de le surveiller :
    • Mémoire utilisée par les processus Java
    • Nettoyage de mémoire Java
    • Utilisation de la mémoire du système
    • Utilisation de l'unité centrale
    • Échange de ressources
    • E/S du système

Dans cette configuration, vous configurez votre système pour qu'il exécute l'étape BuildPDFFromDocuments en utilisant plusieurs threads. La configuration exige que l'étape s'exécute dans une machine virtuelle Java (JVM) distincte. Pour exécuter l'étape dans sa propre JVM, créez un serveur secondaire et configurez l'étape BuildPDFFromDocuments pour qu'elle s'exécute sur ce serveur. Aucune autre étape ne doit être configurée pour être exécutée sur ce serveur.

Pour optimiser les étapes de BuildPDFFromDocuments :

  1. Déterminez si votre ordinateur principal dispose d'une mémoire suffisante pour prendre en charge cette configuration.
    Passez en revue le sujet Optimisation de l'allocation de mémoire Java. Nous vous recommandons d'allouer au moins 16 Go de mémoire vive au serveur secondaire local. Si les calculs effectués dans cette rubrique indiquent que vous disposez de 16 Go de mémoire vive ou que vous pouvez installer de la mémoire supplémentaire sur le système, vous pouvez utiliser un serveur secondaire local. Passez à l'étape .
  2. Créez un serveur secondaire local en suivant la procédure suivante : Définition des serveurs secondaires sur l'ordinateur principal.
    Définissez la propriété Dans le groupe de serveurs général sur Non et laissez la propriété Nombre maximum d'étapes nécessitant une quantité non négligeable de ressources serveur définie sur 1.
      Remarque:
    • Arrêtez après avoir créé le serveur secondaire. Ne réglez pas encore le modèle d'étape BuildPDFFromDocuments.
  3. Mettez à jour les paramètres de la JVM pour ce serveur secondaire.
    1. Ouvrez %AIWDATA%\config\jvmsettings.cfg à l'aide d'un éditeur de texte.
      Par défaut, %AIWDATA% is \aiw\aiw1.
    2. Copiez la ligne pour le serveur primaire qui ressemble à ceci :
      primary=-Xmx2048m -Djava.net.preferIPv4Stack=true -Djava.awt.headless=true

      Collez-la dans une nouvelle ligne du fichier.

      La valeur indiquée après primary=-Xmx représente la quantité maximale de mémoire vive que l'environnement d'exécution Java RICOH ProcessDirector est autorisé à utiliser pour le processus principal RICOH ProcessDirector. Dans cet exemple, le serveur principal peut utiliser 2 048 Mo (2 Go) de RAM pour son segment de mémoire.

    3. Mettez à jour la ligne que vous avez copiée pour remplacer primary par la valeur de la propriété Nom de serveur pour le serveur secondaire.
    4. Mettez à jour la valeur après nom_serveur_secondaire=-Xmx en fonction de la quantité de mémoire dont vous disposez pour ce processus. La valeur doit être d'au moins 16 g.
    5. Si la ligne de votre serveur secondaire ne contient pas ce paramètre : -XX:+UseG1GC, mettez la ligne à jour pour l'ajouter.
    6. Enregistrez et fermez le fichier.
  4. Redémarrez le service RICOH ProcessDirector pour appliquer les nouveaux paramètres.
  5. Activez le serveur secondaire dans l'interface RICOH ProcessDirector.
  6. Ajustez le modèle d'étape BuildPDFFromDocuments.
    Nous vous recommandons de faire une copie du modèle d'étape pour l'utiliser dans la configuration multithread.
    1. Ouvrez Flux de travail ⇒ Modèles d'étape.
    2. Recherchez le modèle d'étape BuildPDFFromDocuments, cliquez avec le bouton droit de la souris et sélectionnez Copier.
    3. Dans l'onglet Général, saisissez une valeur pour la propriété Nom.

      Choisissez un nom qui indique clairement qu'il s'agit de la version multithread de l'étape.

    4. Dans l'onglet Réglage :
      • Réglez Ajustement avancé sur Créer plusieurs threads pour cette étape.
      • Définissez Serveurs à utiliser sur Exécuter sur des serveurs spécifiques, puis sélectionnez uniquement le serveur secondaire que vous avez créé.
    5. Dans l'onglet PDF, examinez toutes les propriétés de Création du fichier de contrôle PDF.
      • Si votre étape utilise un ou plusieurs fichiers de contrôle, vérifiez que Création de la bibliothèque est définie sur Utiliser le fichier par défaut ou le fichier de contrôle.
      • Si votre étape n'utilise pas de fichiers de contrôle, définissez Création de la bibliothèque sur PDF Java Toolkit.
        Remarque:
      • Les valeurs de l'onglet PDF peuvent être différentes pour chaque flux de travail. Mettez ces valeurs à jour si nécessaire après avoir ajouté ce modèle d'étape à un flux de travail.
    6. Mettez à jour tous les autres paramètres nécessaires à votre installation.
    7. Cliquez sur OK.
  7. Activez le modèle d'étape.
  8. Définissez le nombre maximum de threads que le modèle d'étape est autorisé à utiliser.
    • Commencez par un nombre de threads correspondant à environ 25 % des cœurs de la machine. Chaque thread utilisé par cette étape nécessite d'autres threads pour le soutenir, de sorte que vous ne pouvez pas utiliser tous les threads pour l'étape. Par exemple, si vous disposez d'un serveur à 16 cœurs, allouez 4 threads à cette étape.
    • Vous devrez peut-être expérimenter pour déterminer le nombre optimal de threads pour votre installation.
    1. Ouvrez %AIWDATA%\config\product.cfg dans un éditeur de texte.
    2. Ajoutez cette ligne au bas du fichier, en remplaçant le nombre de threads que vous souhaitez utiliser par nombre_de_threads : 
      useBuildPdfMT_MaxThreads=number_of_threads
        Remarque:
      • Nous vous recommandons de commencer par 4 threads.
    3. Enregistrez et fermez le fichier.
  9. Redémarrez le service RICOH ProcessDirector pour appliquer le nouveau paramètre.
  10. Testez un flux de travail avec la nouvelle étape.
    Nous vous recommandons de copier le flux de travail dont vous essayez d'améliorer les performances, puis de remplacer l'étape BuildPDFFromDocuments actuelle par la version multithread. Exécutez un travail représentatif dans le flux de travail.

    Au cours de vos tests, surveillez les éléments suivants :

    • Utilisation de la mémoire du processus Java

      Si le processus a atteint le maximum configuré pour la mémoire java et que les performances sont toujours inacceptables, envisagez d'augmenter l'allocation de mémoire. Respectez les directives énoncées dans Optimisation de l'allocation de mémoire Java. Redémarrez le serveur secondaire chaque fois que vous mettez à jour le fichier jvmsettings.cfg.

    • Utilisation de la mémoire du système
    • Utilisation de l'unité centrale
    • Échange de ressources
    • Nettoyage de mémoire Java

      Si vous voyez beaucoup de threads sur le nettoyage de mémoire, activez la journalisation pour le nettoyage de mémoire. Mettez à jour le fichier jvmsettings.cfg pour ajouter ces paramètres :

      • -verbose:gc
      • -XX:+PrintGCDetails
      • -XX:+PrintGCTimeStamps
      • -XX:+PrintGCDateStamps
      • -Xloggc:/aiw/aiw1/trace/gc_secondary.log
      • -XX:+UseGCLogFileRotation
      • -XX:NumberOfGCLogFiles=10

        Ajustez ce paramètre en fonction de vos besoins.

      • -XX:GCLogFileSize=8m

        Ajustez ce paramètre en fonction de vos besoins.

      Vous devez redémarrer le service RICOH ProcessDirector chaque fois que vous mettez à jour jvmsettings.cfg.

      Examinez les journaux pour déterminer la fréquence et la durée du nettoyage de mémoire. Si le processus prend plus de cinq à dix secondes, cela peut affecter les performances.
    • Utilisation E/S

  11. Après chaque test, ajustez les paramètres pour optimiser le traitement. Lorsque vous aurez fini d'ajuster l'étape, mettez à jour vos flux de travaux de production pour l'utiliser à la place de l'étape BuildPDFFromDocuments actuelle.
Rubrique parente : Considérations de performances et de capacité avec les fonctions de traitement de document