Plantillas HTML (formularios HTMPL)

Este artículo contiene los siguientes temas:
casm173
Este artículo contiene los siguientes temas:
Los formularios de la interfaz Web de se proporcionan a modo de plantillas HTML, mediante archivos con el sufijo .htmpl. A partir de ahora, en este documento se hará referencia a ellos como formularios HTMPL.
Los formularios HTMPL contienen código HTML estándar (incluido JavaScript) y extensiones de idioma interpretadas por un demonio (o servicio) del servidor de denominado motor Web que proporciona código HTML estándar al explorador. Estas extensiones son:
  • Referencias a variables de servidor. Su nombre empieza por un signo de dólar. Pueden ser los valores de las columnas de la base de datos de , referencias a propiedades de configuración del motor Web u otra información del servidor.
  • Etiquetas especiales que hacen que el motor Web realice tareas en el servidor, tales como leer información de la base de datos de . Estas etiquetas tienen nombres con el formato <PDM_...> o <pdm_...>.
No es necesario entender las extensiones HTMPL ni el propio lenguaje HTML para poder personalizar los formularios de CA SDM mediante WSP.
Convenciones de nomenclatura para las plantillas
Las siguientes convenciones de nomenclatura se utilizan para identificar los cuatro tipos básicos de archivos HTMPL, donde
xxx
es el objeto:
Tipo de plantilla
Nombre
Lista (resultados y filtro de búsqueda)
list_
xxx
.htmpl
Formulario de detalles combinado de sólo lectura y edición (interfaz de analistas)
detail_
xxx
.htmpl
Formulario de detalles de sólo lectura
detail_
xxx
_ro.htmpl
Formulario de detalles de edición
detail_
xxx
_edit.htmpl
Encontrará las definiciones de los objetos y sus propiedades en las siguientes ubicaciones:
  • (UNIX) $NX_ROOT/bopcfg/majic/*.maj
  • Windows: d
    irectorio directorio-i
    nstalación\bopcfg\majic
Para obtener más información sobre los objetos y atributos que definen CA SDM, consulte Comandos de referencia de CA Service Desk Manager.
Directorios HTMPL
Se proporcionan diversos conjuntos de archivos HTMPL para implementar estas interfaces, tal y como se muestra en la tabla siguiente:
Sistema operativo
Directorio que contiene los archivos HTMPL
Windows
directorio-instalación
\bopcfg\www\htmpl\web\
interfaz
UNIX
$NX_ROOT/bopcfg/www/htmpl/web/
interfaz
En esta tabla,
interfaz
corresponde al nombre de la interfaz (analista, cliente o empleado).
No existe ningún directorio independiente para los archivos de la interfaz de invitados; de forma predeterminada, esta interfaz utiliza los archivos correspondientes a la interfaz de empleados. Para cambiar la interfaz de usuario de invitados, es necesario cambiar el tipo de acceso asociado al usuario System_Anonymous. Tanto los archivos de cliente como los de empleado cambian de forma dinámica en función de si el usuario actual es un usuario conocido o un invitado, gracias al comando de plantilla <PDM_IF> descrito en este documento.
Existen tres subdirectorios de interfaz más bajo el directorio HTMPL:
  • default:
    Contiene los archivos HTMPL comunes a todas las interfaces. Cuando busca un archivo, el motor Web examina en primer lugar el directorio correspondiente a la interfaz del usuario actual y, posteriormente, este directorio predeterminado.
  • pda/analyst: (UNIX)
  • pda\analyst: (Windows)
    Contiene los archivos HTMPL utilizados por la interfaz de dispositivos móviles. En CA Service Desk Manager r11.0, la interfaz para dispositivos móviles se proporciona únicamente para los analistas.
  • web/
    interface
    /legacy: (UNIX)
  • web\
    interface
    \legacy: (Windows)
    Contiene los archivos HTMPL de la versión anterior de CA SDM que ya no se utilizan. Este directorio se crea automáticamente si se actualiza a partir de una versión anterior al instalar CA SDM. Es posible eliminar este directorio de legado si los archivos personalizados no hacen referencia a ninguno de los archivos contenidos en él.
Se recomienda encarecidamente no modificar directamente los archivos HTMPL que se proporcionan. En su lugar, utilice WSP o copie de forma manual el archivo que desee modificar en el directorio site/mods y modifíquelo allí. El servidor Web de CA SDM busca los formularios nuevos en el directorio site/mods adecuado antes de comprobar el directorio de distribución. Los directorios site/mods estándar de cada una de las interfaces son los siguientes:
Sistema operativo
Directorio para los archivos HTMPL modificados por el sitio
Windows
directorio-instalación\site\mods\www\htmpl\interfaz\interfaz
UNIX
$NX_ROOT/site/mods/www/htmpl/
interfaz/interfaz
Si cambia un formulario y lo guarda en el directorio
directorio-instalación\site\mods\www\htmpl\interfaz
, todos los usuarios podrán verlo, independientemente del grupo de formularios al que pertenezcan. Si lo guarda en el directorio
directorio-instalación
\site\mods\www\htmpl\interfaz\
interfaz
, sólo los contactos que pertenezcan al grupo de formularios en cuestión verán el formulario modificado.
En la tabla anterior,
interfaz
se refiere al nombre de la interfaz (analista, cliente o empleado). No existe ningún directorio independiente para los archivos de la interfaz de invitados; esta interfaz utiliza los archivos correspondientes a la interfaz de empleados. La ventaja de almacenar los archivos HTMPL modificados en el directorio site/mods es que este directorio se conserva en las instalaciones de mantenimiento o al instalar una versión nueva de . Además, el almacenamiento de los archivos modificados en el directorio site/mods a la vez que se conservan los originales garantiza que siempre existirá una copia correcta del archivo HTMPL distribuido originalmente.
Cada página de la interfaz Web tiene una función principal, tal y como se indica en la siguiente tabla que incluye las plantillas HTML más importantes. No obstante, es posible agregar bloques <PDM_FORM> a cualquier plantilla a fin de acceder directamente a cualquier operación admitida por la interfaz Web. Por ejemplo, puede modificar el menú principal a fin de que incluya campos para enviar incidencias sin utilizar la página intermedia, o bien puede agregar campos de criterios de búsqueda y un botón de búsqueda a un formulario de lista.
Página Web
Plantilla HTML
Formulario principal
menu_frames.htmpl
Ver, crear o actualizar una orden de cambio
detail_chg.htmpl
Ver una lista de órdenes de cambio
list_chg.htmpl
Ver, crear o actualizar una incidencia
detail_iss.htmpl
Ver una lista de incidencias
list_iss.htmpl
Ver, crear o actualizar una solicitud
detail_cr.htmpl
Ver una lista de solicitudes
list_cr.htmpl
Ver información detallada sobre un anuncio
detail_cnote_html
Ver una lista de anuncios
list_cnote.html
Inicio de sesión
login.htmpl
Para ver una lista completa de las plantillas, consulte el contenido de los directorios en la tabla situada al principio de este apartado.
Grupos de formularios Web
Es posible recopilar las páginas Web personalizadas en uno o más grupos de formularios. Los directorios de grupos de formularios se encuentran en las siguientes ubicaciones:
  • Windows
    directorio-instalación\site\mods\www\htmpl\web\
    interfaz
    directorio-instalación\site\mods\www\wwwroot\subdirectory
  • UNIX
    $NX_ROOT/site/mods/www/htmpl/web/
    interfaz
    $NX_ROOT/site/mods/www/wwwroot/subdirectory
Cada grupo de formularios constituye un subdirectorio de estos directorios. El directorio de los formularios personalizados se especifica en el campo Grupo de formularios de personalización del tipo de acceso.
Cuando un usuario solicita un formulario, el motor Web busca en primer lugar en el directorio del grupo de formularios personalizados apropiado, después en el directorio estándar de la interfaz Web correspondiente al usuario y, por último, en el directorio predeterminado. Es posible definir más de un tipo de acceso para una misma interfaz Web, cada uno con un grupo de formularios personalizados diferente. Esto permite definir algunos formularios especializados para distintos tipos de usuarios, a la vez que se toma la mayor parte de los formularios de la interfaz estándar.
Un proceso similar tiene lugar cuando una página Web solicita un archivo de alguno de los subdirectorios de wwwroot (css, html, img o scripts). El motor Web examina una referencia HTMPL con el formato CAisd/img/xxx.gif y la convierte en uno de los archivos GIF siguientes (selecciona el primer xxx.gif que encuentra):
  • /CAisd/sitemods/img/formgroup/xxx.gif
  • /CAisd/sitemods/img/xxx.gif
  • /CAisd/img/xxx.gif
Cómo crear un grupo de formularios Web
Puede crear grupos de formularios para especificar los formularios que podrán ver los miembros de un grupo.
Siga los pasos siguientes:
  1. Si se desea un grupo de formularios además de los grupos de formularios predefinidos Analista, Cliente o Empleado, cree otro nuevo. Para ello, seleccione Guardar como en el menú Archivo de WSP y, a continuación, haga clic en el botón Agregar grupo de formularios en el cuadro de diálogo Guardar formulario como. Por ejemplo, si desea ofrecer dos versiones personalizadas distintas de la interfaz de analistas, puede crear dos grupos de formularios denominados Analista1 y Analista2 para controlarlas. También podría definir un grupo de formularios nuevo si la interfaz que se está definiendo no se ajusta de forma lógica a ninguno de los grupos de formularios predefinidos.
  2. En la interfaz Web (no en una sesión de vista previa de Web Screen Painter), seleccione Seguridad, Tipos de acceso en el menú Administración. A continuación, haga clic en un tipo de acceso (o cree otro nuevo) y utilice la lista desplegable Grupo de formularios de personalización de la ventana Detalles de tipo de acceso para asignar un grupo de formularios a un tipo de acceso. determina el tipo de acceso cuando un contacto inicia la sesión y utiliza un grupo de formularios de personalización para determinar en qué lugar de la estructura del directorio site/mods se deben buscar los formularios personalizados. Si el motor Web no encuentra ningún formulario en el directorio del grupo de formularios, lo busca en el directorio estándar correspondiente al tipo de acceso del usuario y, posteriormente, en el directorio predeterminado.
  3. En Web Screen Painter, seleccione Guardar en el menú Archivo, o bien copie de forma manual los archivos HTMPL personalizados al siguiente directorio:
    En Windows:
    directorio_instalación
    \site\mods\www\htmpl\web
    \nombre_grupo_formularios
    En UNIX: $NX_ROOT/site/mods/www/htmpl/web/
    nombre_grupo_formularios
Después de configurar un grupo de formularios Web nuevo y de copiar los archivos de respaldo en los subdirectorios apropiados, es necesario reiniciar el servicio Web para que los cambios surtan efecto.