Configuración del contenido de la ayuda para los productos basados en web

El sistema de ayuda se empaqueta como un archivo de archivado web (WAR) que se despliega en el servidor de aplicaciones. Se inicia y se detiene cuando inicia o detiene el producto. El sistema de ayuda contiene el contenido de la ayuda que puede actualizarse manualmente. También puede configurar el sistema de ayuda para que sirva el contenido de la ayuda desde el sitio web ibm.com de forma que el contenido esté siempre actualizado. La tercera opción es prestar servicio al contenido de la ayuda desde un servidor de intranet.

Definiciones

Se utilizan las siguientes definiciones en la entrega del contenido de la ayuda:

Ayuda local
Contenido de la ayuda que reside en un servidor local que aloja el producto o un servidor de intranet. Puede acceder a la ayuda desde el sistema.
Ayuda remota
Contenido de la ayuda basado en el sitio web ibm.com u otro sitio oficial del Information Center como, por ejemplo, jazz.net.
Ayuda de intranet
Contenido de la ayuda que reside en un servidor de intranet. El contenido se descarga inicialmente en el servidor de intranet desde la web.
Actualizador de ayuda local
Cuando el producto está configurado para utilizar ayuda local o de intranet, este programa de utilidad le permite descargar contenido inicial o actualizar contenido existente desde el sitio del actualizador de ayuda o desde un archivo comprimido del actualizador descargado (vea nuevas definiciones).
Sitio del actualizador de ayuda
El sitio web ibm.com donde se aloja el Information Center del producto. Se puede acceder a este sitio con un navegador o bien, si el producto está configurado para utilizar ayuda remota, desde el sistema de ayuda del producto. Este sitio también puede ser el origen del actualizador de ayuda local.
Sitio de descarga de ayuda
El sitio web (http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/) contiene archivos comprimidos del contenido de la ayuda del producto que puede opcionalmente utilizar para actualizar la ayuda local o de intranet. El archivo tiene este formato: código_producton.n_updateSite.zip, donde código_producto es el código del producto y n.n es el número de versión.

Introducción

Este producto ofrece el contenido de la ayuda que puede actualizarse independientemente de las actualizaciones del producto. De forma predeterminada, el producto se configura para acceder localmente al contenido de la ayuda, lo que significa que el archivo de archivado web (WAR) de ayuda contiene todo el contenido de la ayuda y se instala cuando se instala el producto. Hay tres opciones para el acceso al contenido de la ayuda, incluido el acceso local:
  • Puede acceder al contenido que está en el servidor que aloja el producto.
  • Puede acceder al contenido de la ayuda que está en la web.
  • Puede acceder al contenido de la ayuda que está en un servidor de intranet.

Las tres opciones de contenido de la ayuda.

Acceder al contenido de la ayuda en el servidor del producto

Si el administrador ha configurado esta opción, o bien si el producto estaba ya configurado con esta opción, el contenido de la ayuda se encuentra en el servidor que aloja el producto.

Administrador: Instalación y configuración: Instale el producto. No se precisa nada más si la ayuda incluye todo el contenido de forma local o si la ayuda está configurada para la ayuda remota.

Administrador: actualización de contenido: Si el contenido remoto no está configurado, el contenido se actualiza manualmente utilizando el Sitio del actualizador de ayuda o el Sitio de descarga de ayuda.

Usuario: Acceso a la ayuda: desplácese al producto y empiece a utilizarlo. Cuando necesite ayuda, pulse Ayuda (?) para abrir la Ayuda en una ventana. No necesita nada más.

Acceder al contenido de la ayuda desde la web

Si el administrador ha configurado esta opción o si el producto estaba configurado de esta manera, el usuario está enlazado al Information Center del producto a través del sitio web ibm.com. Sólo podrá acceder a la ayuda basada en web para el producto si está conectado a Internet. Si está desconectado, puede acceder a un número limitado de temas de la ayuda. Para obtener más detalles, consulte el tema Contenido de la ayuda bajo Referencia.

Nota: Debe tener una conexión a Internet para poder utilizar esta opción de ayuda.
Administrador: Instalación y configuración:
  1. Instale el producto.
  2. Inicie el producto y la ayuda.
  3. Suprima el contenido de la ayuda existente en el archivo WAR de la ayuda.
  4. Configure la ayuda remota para que apunte al Information Center público del producto.

Administrador: actualización del contenido: No es necesaria ninguna acción; el contenido es siempre la información más reciente que hay disponible.

Usuario: Acceso a la ayuda: desplácese al producto y empiece a utilizarlo. Cuando necesite ayuda, pulse Ayuda (?) para abrir la Ayuda en una ventana.

Acceder al contenido de la ayuda desde un servidor de intranet (solución Enterprise)

Dependiendo del soporte de la empresa, podrá acceder al contenido de la ayuda desde los servidores de intranet internos. En este método se asume que el administrador de la intranet ha configurado un enlace a un servidor, situado tras el cortafuegos, donde está instalado el contenido de la ayuda. Si selecciona esta opción, deberá especificar el enlace al servidor de intranet. Los administradores deben efectuar actualizaciones planificadas en el contenido de la ayuda.

Administrador: Instalación y configuración:
  1. Instale el producto en el servidor del producto.
  2. Instale y configure la ayuda de intranet tal como se describe en Delivering help content from an intranet server.
  3. Inicie el producto.
  4. Suprima el contenido existente de la ayuda mediante el actualizador de ayuda local.
  5. Configure la ayuda remota para que utilice el servidor de intranet utilizando la información que ha utilizado en el paso 2.

Administrador: Actualización del contenido: el contenido se actualiza manualmente en el servidor de intranet utilizando el Sitio del actualizador de ayuda o el Sitio de descarga de ayuda.

Usuario: Acceso a la ayuda: desplácese al producto y empiece a utilizarlo. Cuando necesite ayuda, pulse Ayuda (?) para abrir la Ayuda en una ventana. No necesita nada más.


Comentarios