Configurando o Conteúdo da Ajuda para Produtos Baseados na Web

O sistema de ajuda é compactado como um archive Web (WAR) que é implementado em seu servidor de aplicativos. Ele inicia ou para quando seu produto é iniciado ou finalizado. O sistema de ajuda contém o conteúdo de ajuda que pode ser atualizado manualmente. Também é possível configurar o sistema de ajuda para servir o conteúdo da ajuda a partir do Web site ibm.com, assim o conteúdo sempre estará atualizado. A terceira opção é ter o conteúdo de ajuda fornecido pelo servidor de intranet.

Definições

As seguintes definições são usadas no fornecimento do conteúdo de ajuda:

Ajuda Local
O conteúdo da ajuda reside em um servidor local que hospeda o produto ou um servidor de intranet. Também é possível acessar a ajuda de seu computador.
Ajuda Remota
O conteúdo da ajuda que reside no Web site do ibm.com ou em outro site oficial de centro de informações como jazz.net.
Ajuda da Intranet
Conteúdo da ajuda que reside em um servidor de intranet. O conteúdo é inicialmente transferido por download para o servidor de Intranet a partir da Web.
Atualizador da ajuda local
Quando o seu produto é configurado para usar ajuda local ou pela intranet, este utilitário o ajuda a fazer o download inicial do conteúdo ou atualizar o conteúdo existente a partir do site atualizado da ajuda ou de um arquivo compactado do atualizador transferido por download (veja as próximas definições).
Site do atualizador da ajuda
O site ibm.com em que o centro de informações para seu produto está hospedado. Esse site pode ser acessado com um navegador ou se o seu produto estiver configurado para usar a ajuda remota a partir do sistema de ajuda do produto. Esse site também pode ser a origem para o atualizador da ajuda local.
Site de download da ajuda
O Web site (http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/) contém arquivos compactados do conteúdo da ajuda para seu produto, que você pode usar opcionalmente para atualizar a ajuda local ou pela intranet. O arquivo tem este formato: prod_coden.n_updateSite.zip, onde prod_code é o código do produto e n.n é o número da versão.

Introdução

Este produto oferece conteúdo de ajuda que pode ser atualizado independentemente das atualizações do produto. Pelo padrão, seu produto é configurado para acessar o conteúdo da ajuda localmente, o que significa que o arquivo de archive Web (WAR) da ajuda contém todo o conteúdo da ajuda e é instalado quando seu produto é instalado. Existem três opções para acesso do conteúdo de ajuda, incluindo o acesso local:
  • É possível acessar o conteúdo que está no servidor que hospeda o produto.
  • É possível acessar o conteúdo da ajuda que está na Web.
  • É possível acessar o conteúdo da ajuda que está em um servidor de intranet.

As três opções do conteúdo da ajuda.

Acessando o Conteúdo de ajuda no Servidor do Produto

Se o seu administrador configurou essa opção, ou se o seu produto veio configurado com essa opção, o conteúdo da ajuda está no servidor que hospeda o seu produto.

Administrador: instalando e configurando: Instalar o produto. Nada mais é necessário se a sua ajuda incluir todo o conteúdo localmente ou se a ajuda estiver configurada para ajuda remota.

Administrador: atualizando o conteúdo: Se a ajuda remota não estiver configurada, o conteúdo é atualizado manualmente usando o Site do atualizador da ajuda ou o Site de download da ajuda.

Usuário: acessando a ajuda: Navegue ao produto e comece a usá-lo. Quando precisar de ajuda, clique em Ajuda (?) para abrir a Ajuda em uma janela. Nada mais é necessário.

Acessando o Conteúdo da Ajuda a Partir da Web

Se o seu administrador configurou essa opção, ou seu produto veio configurado dessa forma, então você é vinculado ao seu centro de informações do produto por meio de um Web site ibm.com. É possível acessar a ajuda baseado na Web para o produto apenas quando você está conectado à Internet. Quando estiver desconectado, você poderá acessar um número limitado de tópicos de ajuda. Para obter detalhes adicionais, consulte o tópico de Conteúdo de ajuda sob Referência.

Nota: Você deve ter uma conexão com a Internet para utilizar essa opção de ajuda.
Administrador: instalando e configurando:
  1. Instale o produto.
  2. Inicie o produto e a ajuda.
  3. Exclua o conteúdo de ajuda existente no WAR de ajuda usando o atualizador de ajuda local.
  4. Configure a ajuda remota para apontar ao centro de informações público do produto.

Administrador: atualizando conteúdo: Nenhuma ação é necessária; o conteúdo contém sempre as informações mais recentes que estão disponíveis.

Usuário: acessando a ajuda: Navegue ao produto e comece a usá-lo. Quando precisar de ajuda, clique em Ajuda (?) para abrir a Ajuda em uma janela.

Acessando Conteúdo da Ajuda a partir de um Servidor de Intranet (solução Corporativa)

Dependendo do suporte de sua empresa, talvez seja possível acessar conteúdo da ajuda a partir de servidores de intranet. Este método pressupõe que os administradores de intranet tenham configurado um link para um servidor protegido por firewall, em que o conteúdo de ajuda do produto esteja instalado. Ao selecionar essa opção, você precisa especificar o link para o servidor de intranet. Os administradores devem fazer atualizações planejadas para o conteúdo de ajuda.

Administrador: instalando e configurando:
  1. Instale o produto no servidor do produto.
  2. Instale e configure a ajuda da intranet conforme descrito em Entregando o conteúdo da ajuda a partir de um servidor de intranet.
  3. Inicie o produto.
  4. Exclua o conteúdo existente da ajuda usando o atualizador de ajuda local.
  5. Configure a ajuda remota para usar o servidor de intranet, utilizando as informações usadas na etapa 2.

Administrador: atualizando o conteúdo: O conteúdo é atualizado manualmente no servidor de intranet usando o Site do atualizador da ajuda ou o Site de download da ajuda.

Usuário: acessando a ajuda: Navegue ao produto e comece a usá-lo. Quando precisar de ajuda, clique em Ajuda (?) para abrir a Ajuda em uma janela. Nada mais é necessário.


Feedback