Hoy quiero compartir un procedimiento que la verdad es muy útil cuando tenemos una aplicación que tiene muchos elementos en las páginas que son complejos de entender su uso o cuando una página tiene mucha información. Es bueno contar con una página de ayuda que nos permita visualizar que significa cada elemento de la página y de qué se trata la página en sí misma.
Es por ello que quiero mostrarte cómo puedes usar el procedimiento APEX_APPLICATION.HELP.
Básicamente, este procedimiento muestra la ayuda con formato HTML tanto de las páginas como de los Elementos y nos permite personalizar la ayuda en nuestra aplicación.
Esta es la sintaxis del procedimiento:
APEX_APPLICATION.HELP (
p_request IN VARCHAR2 DEFAULT NULL,
p_flow_id IN VARCHAR2 DEFAULT NULL,
p_flow_step_id IN VARCHAR2 DEFAULT NULL,
p_show_item_help IN VARCHAR2 DEFAULT 'YES',
p_show_regions IN VARCHAR2 DEFAULT 'YES',
p_before_page_html IN VARCHAR2 DEFAULT '<p>',
p_after_page_html IN VARCHAR2 DEFAULT NULL,
p_before_region_html IN VARCHAR2 DEFAULT NULL,
p_after_region_html IN VARCHAR2 DEFAULT '</td></tr></table></p>',
p_before_prompt_html IN VARCHAR2 DEFAULT '<p><b>',
p_after_prompt_html IN VARCHAR2 DEFAULT '</b></p>: ',
p_before_item_html IN VARCHAR2 DEFAULT NULL,
p_after_item_html IN VARCHAR2 DEFAULT NULL);
Vamos a mostrar en un ejemplo como podemos hacer uso de este procedimiento.
Primero de todo es conveniente tener una aplicación en el cual ingresemos el texto de ayuda en las casillas que corresponden a la Ayuda el cual están disponibles tanto en páginas como en elementos de APEX.
Yo he creado para este ejemplo una aplicación con un Informe Interactivo de las tablas EMP y DEPT usando el asistente de Pantalla Basada en Tabla con Informe.
En la edición de la página 1 - Inicio, en la propiedad Ayuda ingresamos un texto de ejemplo, en mi caso:
Ejemplo demo para aprender a utilizar el procedimiento HELP de APEX.
De este mismo modo en las demás páginas ingresamos textos de ayuda en cada página y en los elementos que componen las páginas.
Crear Página Ayuda
Ahora vamos a crear una página en blanco que le pondremos como nombre Ayuda. En Ruta de Navegación, no le asignamos ninguna ruta y tampoco le asociamos al Menú de navegación. Podemos asignarle que el modo de página sea: Cuadro de Diálogo Modal.
En el Diseñador de Página de la página Ayuda, creamos una Región de tipo Contenido Dinámico PL/SQL.
Ingresamos el siguiente código PL/SQL en Origen de la Región:
APEX_APPLICATION.HELP( p_flow_id => :APP_ID, p_flow_step_id => :REQUEST, p_before_region_html => '<p><br/><table bgcolor="#A3BED8" width="100%"><tr><td><b>',p_after_prompt_html => '</b></p> ');
Y guardamos la página.
Agregar link en Lista de Barra de Navegación
Ahora lo que necesitamos crear es un link a la Página de Ayuda en la Lista de Barra de Navegación al lado del link Desconectar, en la parte superior derecha de la aplicación.
Para ello, ingresamos a Componentes Compartidos de la aplicación y en la sección Navegación, hacemos clic en el enlace: “Lista de Barra de Navegación”.
Abrimos la lista “Escritorio Barra de Navegación” y hacemos clic en el botón Crear Entrada de Lista >
Configuramos lo siguiente:
- Image/Clase: fa-question-circle
- Etiqueta de Entrada de Lista: Ayuda
- Tipo de Destino: Página en ésta aplicación
- Página: <colocamos el número de la página Ayuda>
- Solicitud: &APP_PAGE_ID.
- Hacemos clic en el botón Crear Entrada de Lista.
Volvemos a la Aplicación y ejecutamos la misma para probar que se visualice el texto de ayuda.
Si estamos en la página de inicio por ejemplo solo tengo puesto el texto de ayuda de la página si hago clic en el icono de ayuda se abrirá la ventana modal mostrando la ayuda.
Ahora si vamos al formulario de edición de datos de Empleados y llamamos a la ayuda nos mostrará todos los textos de ayuda que hayamos ingresado en la página de Edición de Empleados.
De este modo usando el procedimiento APEX_APPLICATION.HELP podemos personalizar nuestros mensajes de ayuda y mostrarlos todos juntos en una página de Ayuda.
Hasta la próxima!