Server Side Include

Exemplo de Cenário de utilização do SSI

Suponha uma página detalhes de notícias configurada para ser cacheada (acessar página com extensão .HTM). Na página de detalhes, além da interface de detalhes, há também a interface de Lista Rápida, com as três últimas notícias publicadas.

Sem a tecnologia SSI, se cada vez que uma notícia for publicada ou editada, precisar gerar novamente todos os HTML da página de detalhes, o processo pode se tornar ineficiente, haja visto a quantidade de notícias publicadas.

Para tornar, portanto, este processo eficiente, é necessário colocar aquela interface de Lista Rápida como server-side-include. Desta forma, a lista de notícias vai ser salva em um arquivo HTML diferente de cada página de detalhes. Os arquivos HTM de detalhes, por sua vez, terão simplesmente um #include para o HTM gerado para a interface Lista Rápida .

Todos os detalhes vão compartilhar o mesmo <locale>.HTM, e atualizando só esse arquivo, todos os HTMs de detalhes vão ter a nova lista de notícias, sem precisar gerá-los novamente.

Outro exemplo

Suponha que todas as páginas cacheadas do portal precisam conter informações que são atualizadas constantemente. Para isso, deve-se utilizar a interface Exibir HTML do serviço HTML em cada uma das páginas do portal, com um #include para um arquivo.html, que contém todas as tais informações que são atualizadas constantemente.

Portanto, alterando somente o arquivo.html, todas as páginas cacheadas apresentarão as informações atualizadas, porém, sem que seja necessário gerá-las novamente.

Configurações no LumisXP

No LumisXP, qualquer interface pode ser configurada com SSI. Essa configuração deve ser realizada nas propriedades de uma instância de interface, mais precisamente na seção referente a aba Desempenho das propriedades. Verificar também nas propriedades avançadas da página, configurada para ser cacheada, está com server side include habilitado. Isso significa que quando o arquivo HTML da página estiver sendo gerada, porém com extensão SHTML (extensão default para arquivos que têm SSI), também será gerado um arquivo HTML contendo o conteúdo da instância da interface configurada com SSI , no diretório data/pages/interfaces/<guid da instancia da interface>/<locale>.htm). Cada página cacheada apresentará um #include para o arquivo HTM da interface.

No arquivo de configuração do portal, na seção de configuração de cache, devem estar especificadas as extensões a serem utilizadas, como exemplicado nas configurações de cache abaixo:

<!-- Uncomment to enable customized HTML Generation.  See LumisXP documentation for details.
 <htmlGeneration>
 <connectTimeout>30000</connectTimeout>
 <pageRequestTimeout>50000</pageRequestTimeout>
 <frameworkUrl>http://localhost:8080/portal</frameworkUrl>
 <htmlCacheLogNavigation>1</htmlCacheLogNavigation>
 <htmlFileExtension>.htm</htmlFileExtension>
 <shtmlFileExtension>.shtml</shtmlFileExtension>
 <ssi>
         <sendRedirectOnPageNotFound>true</sendRedirectOnPageNotFound>
         <waitBeforeSendRedirect>500</waitBeforeSendRedirect>
 </ssi>
 </htmlGeneration>
-->

É possível habilitar processamento SSI no Tomcat, editando o arquivo Tomcat/conf/web.xml, retirando os comentários dos seguintes blocos:

<filter>
        <filter-name>ssi</filter-name>
        <filter-class>
          org.apache.catalina.ssi.SSIFilter
        </filter-class>
        <init-param>
          <param-name>contentType</param-name>
          <param-value>text/x-server-parsed-html(;.*)?</param-value>
        </init-param>
        <init-param>
          <param-name>debug</param-name>
          <param-value>0</param-value>
        </init-param>
        <init-param>
          <param-name>isVirtualWebappRelative</param-name>
          <param-value>0</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>ssi</filter-name>
        <url-pattern>*.shtml</url-pattern>
        <dispatcher>REQUEST</dispatcher>
    </filter-mapping>
    <mime-mapping>
        <extension>shtml</extension>
        <mime-type>text/x-server-parsed-html</mime-type>
    </mime-mapping>

Após as devidas alterações no arquivo de configuração do Lumis e do servidor de aplicação, reiniciar este último.