Implementando o Document Builder no Apache Tomcat

É possível implementar os aplicativos da web Document Builder (rpeng.war e dgaas.war) em um servidor Apache Tomcat com Derby ou DB2. Se você desejar executar o aplicativo Document Builder em um banco de dados corporativo, a etapa opcional nesta tarefa fornecerá as definições de configuração extras para suporte do DB2.

Antes de Iniciar

Deve-se instalar o Apache Tomcat V7.0.x ou V8.0.x e o Rational Publishing Engine com o recurso RPE Document Builder antes de implementar o Document Builder.
Deve-se ter acesso aos seguintes aplicativos da web disponíveis no diretório RPE_HOME\document-builder:
  • rpeng.war
  • dgaas.war

Procedimento

  1. Prepare o servidor de aplicativos Apache Tomcat:
    1. No servidor de aplicativos Tomcat, configure a variável do sistema TELELOGIC_LICENSE_FILE para port_number@hostname, por exemplo, 19353@licserver1. Para obter mais detalhes, consulte o tópico Verificar a variável de ambiente TELELOGIC_LICENSE_FILE.
    2. Aumente os tamanhos máximos do arquivo e da solicitação:

      Para o Tomcat 7:

      1. Abra o arquivo web.xml do aplicativo Tomcat Manager, por exemplo, <Tomcat_install_dir>/webapps/manager/WEB-INF/web.xml.
      2. Localize a seção a seguir:
        <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. Edite esta seção para aumentar a capacidade:
        <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. Salve e feche o arquivo web.xml.
      Para o Tomcat 8:
      1. Pare o servidor de aplicativos Apache Tomcat.
      2. Exclua os diretórios dgaas e dgaas.war do diretório <Tomcat_install_dir>\webapps se eles já existirem.
      3. Copie o arquivo dgaas.war no diretório <Tomcat_install_dir>\webapps.
  2. Opcional: Este é um ícone do DB2. Se você desejar executar o aplicativo Document Builder com o DB2, deverá concluir estas etapas extras de configuração:
    1. Copie o arquivo db2jcc4.jar do Driver JDBC 4.0 do diretório <DB2_install_dir>/java para o diretório <Tomcat_install_dir>/lib.
    2. Abra o arquivo de script de inicialização do Apache Tomcat:
      • Este é um ícone do sistema operacional Windows. <Tomcat_install_dir>\bin\catalina.bat
      • Este é um ícone do sistema operacional Linux. <Tomcat_install_dir>/bin/catalina.sh
      E inclua a linha a seguir de código:
      set "VCAP_SERVICES={'sqldb':[{}]}"
    3. Prepare uma instrução XML que defina a origem de dados no arquivo < >Tomcat_install_dir/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://<server>: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://<server>:50000/rpedb1"/>
      Em que o valor db2admin após o atributo usename é o nome do usuário do sistema com acesso de CONNECT ao banco de dados rpedb1, e myDBpassword após password é esta senha do usuário. Se você tiver definido um nome de usuário ou uma senha diferente, ou ambos, substitua db2admin e myDBpassword de forma correspondente. Além disso, substitua <server> pelo endereço para o local do servidor de banco de dados.
      Dica: O DB2 possui um limite de comprimento de nome de usuário e senha de oito caracteres para sistemas operacionais Linux, e de 30 caracteres para sistemas operacionais Windows.
    4. Inclua a declaração para o recurso no arquivo <Tomcat_install_dir>/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. Inicie o servidor de aplicativos Apache Tomcat:
    Este é um ícone do sistema operacional Windows.
    Se você estiver executando o Apache Tomcat como um serviço do Windows, para iniciar o servidor, a partir do diretório <Tomcat_install_dir>/bin, execute este comando (para Apache Tomcat V7.0.x, substitua por Tomcat7.exe):
    Tomcat8.exe start
    Para parar o servidor, a partir do diretório <Tomcat_install_dir>/bin, execute este comando (para Apache Tomcat V7.0.x, substitua por Tomcat7.exe):
    Tomcat8.exe stop
    Se você não estiver executando o Apache Tomcat como um serviço do Windows, para iniciar o servidor, a partir do diretório <Tomcat_install_dir>/bin, execute este comando:
    startup.bat
    Dica: Uma janela separada do console do Apache Tomcat é aberta. Não feche essa janela ou o servidor parará de funcionar. É necessário esperar um momento para que o servidor Tomcat seja iniciado. Após o servidor ser iniciado, o horário de inicialização, em milissegundos, será exibido na janela do Tomcat. Por exemplo, Inicialização do servidor em 25731 ms.
    Para parar o servidor, a partir do diretório <Tomcat_install_dir>/bin, execute este comando:
    shutdown.bat
    Este é um ícone do sistema operacional Linux.
    Para iniciar o servidor, a partir de <Tomcat_install_dir>/bin, execute este comando:
    startup.sh
    Para parar o servidor, a partir do diretório <Tomcat_install_dir>/bin, execute este comando:
    shutdown.sh
  4. Selecione uma das opções a seguir para implementar o Document Builder:
    • Se você deseja implementar o Document Builder usando uma interface gráfica com o usuário, continue na próxima etapa para obter detalhes sobre como implementar usando a interface do Apache Tomcat Manager interface.
    • Se você desejar implementar o Document Builder usando o sistema de arquivos, copie os arquivos rpeng.war e dgaas.war do diretório RPE_HOME\document-builder para o diretório webapps do Tomcat, por exemplo, <Tomcat_install_dir>\webapps. E, em seguida, continue com a seção Resultados e O que fazer a seguir deste tópico.
  5. Abra o Gerenciador do Apache Tomcat em um navegador em http://server:port/manager/html
    Exemplo: http://localhost:8080/manager/html
    Dica: Uma janela solicitando um nome do usuário e a senha para autenticar o Aplicativo Tomcat Manager. Você deve incluir uma função manager-gui no arquivo <Tomcat_install_dir>/conf/tomcat-user.xml, em que <Tomcat_install_dir> é o diretório de instalação do Apache Tomcat. O seguinte exemplo inclui uma função manager-gui com my_username como o nome de usuário e my_password para a senha:
    <user username="my_username" password="my_password" roles="manager-gui"/>
  6. Implemente os aplicativos rpeng.war e dgaas.war no Apache Tomcat.
    1. Na seção Implementar, insira os detalhes para o arquivo rpeng.war e, em seguida, clique em Implementar:
      • Se o arquivo WAR estiver em um servidor diferente do Apache Tomcat, insira as seguintes informações na seção Implementar diretório ou arquivo WAR localizado no servidor:
        1. Caminho do contexto: insira /rpeng como o nome para o Document Builder. Esta entrada é uma parte da URL usada para configurar o cliente.
        2. URL do arquivo de configuração XML: Não é necessário.
        3. WAR ou URL do Diretório: O caminho para o arquivo rpeng.war. Exemplo: RPE_HOME\document-builder\rpeng.war
      • Se o arquivo .war estiver no mesmo servidor que o Apache Tomcat, insira as seguintes informações na seção Arquivo WAR a Ser Implementado:
        1. Selecione WAR para upload: O caminho para o arquivo rpeng.war. Exemplo: RPE_HOME\document-builder\rpeng.war
    2. Na seção Implementar, insira os detalhes para o arquivo dgaas.war e, em seguida, clique em Implementar:
      • Se o arquivo .war estiver em um servidor diferente do Apache Tomcat, insira as seguintes informações na seção Implementar diretório ou arquivo WAR localizado no servidor:
        1. Caminho do contexto: insira /dgaas como o nome para o Document Builder. Esta entrada é uma parte da URL usada para configurar o cliente.
        2. URL do arquivo de configuração XML: Não é necessário.
        3. WAR ou URL do Diretório: O caminho para o arquivo dgaas.war. Exemplo: RPE_HOME\document-builder\dgaas.war
      • Se o arquivo .war estiver no mesmo servidor que o Apache Tomcat, insira as seguintes informações na seção Arquivo WAR a Ser Implementado:
        1. Selecione WAR para upload: O caminho para dgaas.war. Exemplo: RPE_HOME\document-builder\dgaas.war

Resultados

É possível confirmar que o Document Builder está implementado abrindo a página introdutória em um navegador em http://server:port/rpeng/
Importante:

Por padrão, o aplicativo rpeng.war procura o aplicativo dgaas.war no mesmo servidor, no caminho do contexto /dgaas. Se você implementar o aplicativo dgaas.war em um servidor diferente ou em um caminho do contexto diferente, você deverá configurar a variável de tempo de execução DGAAS_URL no aplicativo rpeng.war.

Para configurar a variável de ambiente de tempo de execução DGAAS_URL:
  1. Deve-se efetuar logon no Document Builder, http://server:port/rpeng/, com um usuário que tem acesso de administrador (rpe_admin). Para obter detalhes sobre como configurar um usuário com a função de usuário rpe_admin, consulte o tópico Configurando usuários para o Document Builder no Apache Tomcat.
  2. Na barra de ferramentas do usuário do Document Builder, selecione Administrador. Essa opção de menu Administrador está disponível para usuários com a função rpe_admin.
  3. Selecione Variáveis de Tempo de Execução.
  4. Configure o valor da variável de ambiente de tempo de execução DGAAS_URL para uma URL, como http://server:port/dgaas.

O que Fazer Depois

Opcionalmente, é possível implementar e executar o aplicativo de amostra Newskeeper que usa a tecnologia de serviço de geração de documento para gerar documentos e fornece uma interface de armazenamento para os documentos e ativos de serviço de geração de documento. Para obter mais detalhes, consulte Executando a amostra do Newskeeper.

Configure o Rational Publishing Engine Document Builder listado na página http://server:port/rpeng/. Consulte URLs do Document Builder para obter uma explicação de como cada URL é usada e as tarefas para configuração de cada um dos recursos.