Déploiement de Document Builder sur Apache Tomcat

Vous pouvez déployer les applications web de Document Builder (rpeng.war et dgaas.war) sur un serveur Apache Tomcat avec Derby ou DB2. Si vous voulez exécuter l'application Document Builder sur une base de données d'entreprise, l'étape facultative de cette tâche vous indique les paramètres de configuration supplémentaires pour le support de DB2.

Avant de commencer

Vous devez installer Apache Tomcat V7.0.x ou V8.0.x et Rational Publishing Engine avec la fonction RPE Document Builder avant de déployer Document Builder.
Vous devez avoir accès aux applications web suivantes dans le répertoire RPE_HOME\document-builder :
  • rpeng.war
  • dgaas.war

Procédure

  1. Préparez votre serveur d'applications Apache Tomcat :
    1. Sur le serveur d'applications Tomcat, définissez la variable système TELELOGIC_LICENSE_FILE à numéro_port@nom_hôte. Par exemple, 19353@serveurlic1. Pour plus d'informations, voir la rubrique Vérification de la variable d'environnement TELELOGIC_LICENSE_FILE.
    2. Augmentez la taille de fichier et la taille de demande maximales :

      Pour Tomcat 7 :

      1. Ouvrez le fichier web.xml de l'application du gestionnaire Tomcat, par exemple, <rép_install_Tomcat>/webapps/manager/WEB-INF/web.xml.
      2. Recherchez la section suivante :
        <multipart-config>
        <!-- 50 MB max -->
        <max-file-size>52428800</max-file-size>
        <max-request-size>52428800</max-request-size>
        <file-size-threshold>0</file-size-threshold>
        </multipart-config>
      3. Modifiez cette section pour augmenter la capacité :
        <multipart-config>
        <!-- 70 MB max -->
        <max-file-size>73400320</max-file-size>
        <max-request-size>73400320</max-request-size>
        <file-size-threshold>0</file-size-threshold>
        </multipart-config>
      4. Sauvegardez et fermez le fichier web.xml.
      Pour Tomcat 8 :
      1. Arrêtez votre serveur d'applications Apache Tomcat.
      2. Supprimez le répertoire dgaas et le fichier dgaas.war dans le répertoire <rép_install_Tomcat>\webapps s'ils existent déjà.
      3. Copiez le fichier dgaas.war dans le répertoire <rép_install_Tomcat>\webapps.
  2. Facultatif : Icône de DB2. Si vous voulez exécuter l'application Document Builder avec DB2, vous devez effectuer les étapes de configuration supplémentaires suivantes :
    1. Copiez le fichier db2jcc4.jar du pilote JDBC 4.0 du répertoire <rép_install_DB2>/java au répertoire <rép_install_Tomcat>/lib.
    2. Ouvrez le fichier de script de démarrage d'Apache Tomcat :
      • Icône du système d'exploitation Windows. <rép_install_Tomcat>\bin\catalina.bat
      • Icône du système d'exploitation Linux. <rép_install_Tomcat>/bin/catalina.sh
      Et ajoutez la ligne de code suivante :
      set "VCAP_SERVICES={'sqldb':[{}]}"
    3. Préparez une instruction XML définissant la source de données dans le fichier <rép_install_Tomcat>/conf/server.xml :
      <Resource auth="Container"
                  driverClassName="com.ibm.db2.jcc.DB2Driver"
                  name="jdbc/RPENG_DB"
                  username="db2admin"
                  password="myDBpassword"
                  type="javax.sql.DataSource"
                  url="jdbc:db2://<serveur>:50000/rpedb1"/>
      <Resource auth="Container"
                  driverClassName="com.ibm.db2.jcc.DB2Driver"
                  name="jdbc/DGAAS_DB"
                  username="db2admin"
                  password="myDBpassword"
                  type="javax.sql.DataSource"
                  url="jdbc:db2://<serveur>:50000/rpedb1"/>
      Où la valeur db2admin après l'attribut username est le nom de l'utilisateur système ayant l'accès CONNECT à la base de données rpedb1, et myDBpassword après password, le mot de passe de cet utilisateur. Si vous avez défini un nom d'utilisateur et/ou un mot de passe différent, remplacez db2admin et/ou myDBpassword comme il convient. D'autre part, remplacez <serveur> par l'adresse de votre serveur de base de données.
      Conseil : DB2 limite le nom d'utilisateur et le mot de passe à 8 caractères sous Linux et 30 sous Windows.
    4. Ajoutez la déclaration de votre ressource dans le fichier <rép_install_Tomcat>/conf/context.xml :
      <Context>
        ...
         <ResourceLink name="jdbc/RPENG_DB" global="jdbc/RPEBG_DB" type="javax.sql.DataSource"/>
         <ResourceLink name="jdbc/DGAAS_DB" global="jdbc/DGAAS_DB" type="javax.sql.DataSource"/>
      </Context>
  3. Démarrez le serveur d'applications Apache Tomcat :
    Icône du système d'exploitation Windows.
    Si vous exécutez Apache Tomcat en tant que service Windows, pour démarrer le serveur, à partir du répertoire <rép_install_Tomcat>/bin, exécutez la commande suivante (pour Apache Tomcat version 7.0.x, utilisez à la place Tomcat7.exe) :
    Tomcat8.exe start
    Pour arrêter le serveur, à partir du répertoire <rép_install_Tomcat>/bin, exécutez la commande suivante (pour Apache Tomcat version 7.0.x, utilisez à la place Tomcat7.exe) :
    Tomcat8.exe stop
    Si vous n'exécutez pas Apache Tomcat en tant que service Windows, pour démarrer le serveur, à partir du répertoire <rép_install_Tomcat>/bin, exécutez la commande suivante :
    startup.bat
    Conseil : Une fenêtre console Apache Tomcat distincte s'ouvre. Ne la fermez pas ou le serveur cessera de fonctionner. Vous devez patienter pendant le démarrage du serveur Tomcat. Une fois le serveur démarré, le temps de démarrage s'affiche en millisecondes dans la fenêtre Tomcat. Par exemple, Server startup in 25731 ms.
    Pour arrêter le serveur, à partir du répertoire <rép_install_Tomcat>/bin, exécutez la commande suivante :
    shutdown.bat
    Icône du système d'exploitation Linux.
    Pour démarrer le serveur, à partir du répertoire <rép_install_Tomcat>/bin, exécutez la commande suivante :
    startup.sh
    Pour arrêter le serveur, à partir du répertoire <rép_install_Tomcat>/bin, exécutez la commande suivante :
    shutdown.sh
  4. Sélectionnez l'une des options suivantes pour déployer Document Builder :
    • Pour déployer Document Builder avec une interface graphique, voyez les détails du déploiement avec l'interface Apache Tomcat Manager à l'étape suivante.
    • Pour déployer Document Builder avec le système de fichiers, copiez les fichiers rpeng.war et dgaas.war du répertoire RPE_HOME\document-builder au répertoire Tomcat webapps, par exemple <rép_install_Tomcat>\webapps. Passez ensuite à la section Résultats et Que faire ensuite de cette rubrique.
  5. Ouvrez Apache Tomcat Manager dans un navigateur à l'adresse http://server:port/manager/html
    Exemple : http://hôte_local:8080/manager/html
    Conseil : Une fenêtre s'ouvre, vous demandant de saisir un nom d'utilisateur et un mot de passe d'authentification de l'application Tomcat Manager. Vous devez ajouter un rôle manager-gui dans le fichier <rép_install_Tomcat>/conf/tomcat-user.xml, où <rép_install_Tomcat> désignele répertoire d'installation du serveur Apache Tomcat. L'exemple suivant ajoute un rôle manager-gui avec mon_nom_utilisateur pour le nom d'utilisateur et mon_motdepasse pour le mot de passe :
    <user username="mon_nom_utilisateur" password="mon_motdepasse" roles="manager-gui"/>
  6. Déployez à la fois les applications rpeng.war et dgaas.war sur Apache Tomcat.
    1. Dans la section Deploy, entrez les détails relatifs au fichier rpeng.war, puis cliquez sur Deploy :
      • Si le fichier WAR se trouve sur un serveur autre qu'Apache Tomcat, entrez les informations suivantes dans la section Deploy directory or WAR file located on server :
        1. Context Path : Entrez /rpeng comme nom pour Document Builder. Cette entrée fait partie de l'URL utilisée pour configurer le client.
        2. XML Configuration file URL : Non requis.
        3. WAR or Directory URL : Chemin d'accès au fichier rpeng.war. Exemple : RPE_HOME\document-builder\rpeng.war
      • Si le fichier .war se trouve sur le même serveur qu'Apache Tomcat, entrez les informations suivantes dans la section WAR file to deploy :
        1. Select WAR to upload : Chemin d'accès au fichier rpeng.war. Exemple : RPE_HOME\document-builder\rpeng.war
    2. Dans la section Deploy, entrez les détails du fichier dgaas.war, puis cliquez sur Deploy :
      • Si le fichier .war se trouve sur un serveur autre qu'Apache Tomcat, entrez les informations suivantes dans la section Deploy directory or WAR file located on server :
        1. Context Path : Entrez /dgaas comme nom pour Document Builder. Cette entrée fait partie de l'URL utilisée pour configurer le client.
        2. XML Configuration file URL : Non requis.
        3. WAR or Directory URL : Chemin d'accès au fichier dgaas.war. Exemple : RPE_HOME\document-builder\dgaas.war
      • Si le fichier .war se trouve sur le même serveur qu'Apache Tomcat, entrez les informations suivantes dans la section WAR file to deploy :
        1. Select WAR to upload : Chemin d'accès au fichier dgaas.war. Exemple : RPE_HOME\document-builder\dgaas.war

Résultats

Vous pouvez vérifier que Document Builder est déployé en ouvrant la page d'introduction dans un navigateur : http://serveur:port/rpeng/
Important :

Par défaut, l'application rpeng.war recherche l'application dgaas.war sur le même serveur, sous le chemin de contexte /dgaas. Si vous déployez l'application dgaas.war sur un autre serveur ou sous un autre chemin de contexte, vous devez configurer la variable d'environnement d'exécution DGAAS_URL dans l'application rpeng.war.

Pour configurer la variable d'environnement d'exécution DGAAS_URL :
  1. Vous devez vous connecter à Document Builder, http://server:port/rpeng/, sous un nom utilisateur disposant de l'accès administrateur (rpe_admin). Pour configurer un utilisateur avec le rôle rpe_admin, voir la rubrique Configuration des utilisateurs pour Document Builder sur Apache Tomcat.
  2. Dans la barre d'outils utilisateur de Document Builder, sélectionnez Administrer. L'option de menu Administrer est disponible pour les utilisateurs qui disposent du rôle rpe_admin.
  3. Sélectionnez Variables d'exécution.
  4. Affectez à la variable d'environnement d'exécution DGAAS_URL une valeur d'URL, par exemple, http://serveur:port/dgaas.

Que faire ensuite

Au besoin, vous pouvez déployer et exécuter le modèle d'application Newskeeper qui utilise la technologie du service de génération de document pour générer des documents et qui fournit une interface de stockage pour les actifs et les documents de ce service. Pour plus de détails, voir Exécution du modèle Newskeeper.

Configurez l'application Rational Publishing Engine Document Builder indiquée sur la page http://serveur:port/rpeng/. Pour une explication sur la manière dont chaque URL est utilisée et sur les tâches de configuration de chacune des fonctions, voir Adresses URL de Document Builder.