{"id":15425,"date":"2020-05-05T10:57:52","date_gmt":"2020-05-05T17:57:52","guid":{"rendered":"http:\/\/clartechsolutions.com\/?p=15425"},"modified":"2023-03-01T18:25:12","modified_gmt":"2023-03-01T18:25:12","slug":"como-crear-la-funcionalidad-de-ayuda-en-apex-usando-apex_application-help","status":"publish","type":"post","link":"https:\/\/kiusi.com\/en\/como-crear-la-funcionalidad-de-ayuda-en-apex-usando-apex_application-help\/","title":{"rendered":"C\u00f3mo crear la funcionalidad de ayuda en APEX usando APEX_APPLICATION.HELP"},"content":{"rendered":"

Hoy quiero compartir un procedimiento que la verdad es muy \u00fatil cuando tenemos una aplicaci\u00f3n que tiene muchos elementos en las p\u00e1ginas que son complejos de entender su uso o cuando una p\u00e1gina tiene mucha informaci\u00f3n. Es bueno contar con una p\u00e1gina de ayuda que nos permita visualizar que significa cada elemento de la p\u00e1gina y de qu\u00e9 se trata la p\u00e1gina en s\u00ed misma.<\/p>\n

Es por ello que quiero mostrarte c\u00f3mo puedes usar el procedimiento APEX_APPLICATION.HELP.<\/p>\n

B\u00e1sicamente, este procedimiento muestra la ayuda con formato HTML tanto de las p\u00e1ginas como de los Elementos y nos permite personalizar la ayuda en nuestra aplicaci\u00f3n.<\/p>\n

Esta es la sintaxis del procedimiento:<\/p>\n

APEX_APPLICATION.HELP (\n    p_request        IN VARCHAR2 DEFAULT NULL,\n    p_flow_id        IN VARCHAR2 DEFAULT NULL,\n    p_flow_step_id   IN VARCHAR2 DEFAULT NULL,\n    p_show_item_help IN VARCHAR2 DEFAULT 'YES',\n    p_show_regions   IN VARCHAR2 DEFAULT 'YES',\n    p_before_page_html     IN VARCHAR2 DEFAULT '<p>',\n    p_after_page_html      IN VARCHAR2 DEFAULT NULL,\n    p_before_region_html   IN VARCHAR2 DEFAULT NULL,\n    p_after_region_html    IN VARCHAR2 DEFAULT '<\/td><\/tr><\/table><\/p>',\n    p_before_prompt_html   IN VARCHAR2 DEFAULT '<p><b>',\n    p_after_prompt_html    IN VARCHAR2 DEFAULT '<\/b><\/p>:&nbsp;',\n    p_before_item_html     IN VARCHAR2 DEFAULT NULL,\n    p_after_item_html      IN VARCHAR2 DEFAULT NULL);\n<\/pre>\n
Vamos a mostrar en un ejemplo como podemos hacer uso de este procedimiento.<\/p>\n
Primero de todo es conveniente tener una aplicaci\u00f3n en el cual ingresemos el texto de ayuda en las casillas que corresponden a la Ayuda el cual est\u00e1n disponibles tanto en p\u00e1ginas como en elementos de APEX.<\/p>\n
Yo estoy utilizando una aplicaci\u00f3n donde realizo los diferentes demos para los art\u00edculos que publico aqu\u00ed en el blog.<\/p>\n
\"\"<\/p>\n
En la edici\u00f3n de la p\u00e1gina 1 – Inicio<\/strong>, en la propiedad Ayuda ingresamos un texto de ejemplo, en mi caso:<\/p>\n
Aplicaci\u00f3n con ejemplos que son realizados en diferentes entradas del blog de ClarTech. <\/em><\/p>\n
\"\"<\/p>\n
De este mismo modo he ingresado textos breves que explica lo que se refiere cada pagina, solo a modo de ejemplo.<\/p>\n
Crear P\u00e1gina Ayuda<\/strong><\/h3>\n
Ahora vamos a crear una p\u00e1gina en blanco que le pondremos como nombre Ayuda<\/strong>. En Ruta de Navegaci\u00f3n, no le asignamos ninguna ruta y tampoco le asociamos al Men\u00fa de navegaci\u00f3n. Podemos asignarle que el modo de p\u00e1gina sea: Cuadro de Di\u00e1logo Modal<\/strong>.<\/p>\n
En el Dise\u00f1ador de P\u00e1gina de la p\u00e1gina Ayuda<\/strong>, creamos una Regi\u00f3n de tipo Contenido Din\u00e1mico PL\/SQL<\/strong>.<\/p>\n
Ingresamos el siguiente c\u00f3digo PL\/SQL en Origen de la Regi\u00f3n:<\/p>\n
APEX_APPLICATION.HELP(    p_flow_id => :APP_ID,    \np_flow_step_id => :REQUEST,    \np_before_region_html => '<p><br\/>\n<table bgcolor="#A3BED8" width="100%"><tr><td><b>',\np_after_prompt_html  => '<\/b><\/p>&nbsp;&nbsp;');<\/pre>\n
Y guardamos la p\u00e1gina.<\/p>\n
Agregar enlace en la Lista de Barra de Navegaci\u00f3n<\/strong><\/h3>\n
Ahora lo que necesitamos crear es un enlace a la p\u00e1gina de Ayuda<\/strong> en la Lista de Barra de Navegaci\u00f3n al lado del nombre del usuario, en la parte superior derecha de la aplicaci\u00f3n.<\/p>\n
Para ello, ingresamos a Componentes Compartidos de la aplicaci\u00f3n y en la secci\u00f3n Navegaci\u00f3n, hacemos clic en el enlace: \u201cLista de Barra de Navegaci\u00f3n\u201d.<\/p>\n
Abrimos la lista \u201cEscritorio Barra de Navegaci\u00f3n\u201d y hacemos clic en el bot\u00f3n Crear Entrada ><\/strong><\/p>\n
Configuramos lo siguiente:<\/p>\n
– Image\/Clase: fa-question-circle<\/strong><\/p>\n
– Etiqueta de Entrada de Lista: Ayuda<\/strong><\/p>\n
– Tipo de Destino: P\u00e1gina en \u00e9sta aplicaci\u00f3n<\/strong><\/p>\n
– P\u00e1gina: <colocamos el n\u00famero de la p\u00e1gina Ayuda><\/strong><\/p>\n
– Solicitud: &APP_PAGE_ID.<\/strong><\/p>\n
– Hacemos clic en el bot\u00f3n Crear Entrada de Lista.<\/strong><\/p>\n
\"\"<\/p>\n
Volvemos a la Aplicaci\u00f3n y ejecutamos la misma para probar que se visualice el texto de ayuda.<\/p>\n
Si estamos en la p\u00e1gina de inicio vemos la ayuda de esa p\u00e1gina, y as\u00ed recorremos todas las p\u00e1ginas y podemos ver c\u00f3mo se va mostrando los textos de ayuda.<\/p>\n
\"\"<\/p>\n
\"\"<\/p>\n
\"\"<\/p>\n
De este modo usando el procedimiento APEX_APPLICATION.HELP podemos mostrar la ayuda en cada una de las p\u00e1ginas de nuestra aplicaci\u00f3n.<\/p>","protected":false},"excerpt":{"rendered":"
Hoy quiero compartir un procedimiento que la verdad es muy \u00fatil cuando tenemos una aplicaci\u00f3n que tiene muchos elementos en las p\u00e1ginas que son complejos de entender su uso o cuando una p\u00e1gina tiene mucha informaci\u00f3n. Es bueno contar con una p\u00e1gina de ayuda que nos permita visualizar que significa cada elemento de la p\u00e1ginaContinue reading “C\u00f3mo crear la funcionalidad de ayuda en APEX usando APEX_APPLICATION.HELP”<\/span><\/a><\/p>","protected":false},"author":132749711,"featured_media":16539,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_coblocks_attr":"","_coblocks_dimensions":"","_coblocks_responsive_height":"","_coblocks_accordion_ie_support":"","advanced_seo_description":"","jetpack_seo_html_title":"","jetpack_seo_noindex":false,"jetpack_seo_schema_type":"","_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_wpcom_ai_launchpad_first_post":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"{title}\n\n{excerpt}\n\n{url}","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"_wpas_customize_per_network":false,"jetpack_post_was_ever_published":true},"categories":[121913,122053],"tags":[121903,122061,122062,121904],"class_list":["post-15425","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-blog","category-oracle-apex-20-1","tag-apex","tag-apex_application-help","tag-ayuda","tag-oracle-apex","entry"],"jetpack_publicize_connections":[],"jetpack_likes_enabled":true,"jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/paMvMS-40N","amp_enabled":true,"jetpack_featured_media_url":"https:\/\/i0.wp.com\/kiusi.com\/wp-content\/uploads\/2020\/05\/Destacada-Como-crear-la-funcionalidad-de-ayuda-en-APEX-usando-APEX_APPLICATION.HELP_.jpg?fit=2949%2C1735&ssl=1","_links":{"self":[{"href":"https:\/\/kiusi.com\/en\/wp-json\/wp\/v2\/posts\/15425","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/kiusi.com\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/kiusi.com\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/kiusi.com\/en\/wp-json\/wp\/v2\/users\/132749711"}],"replies":[{"embeddable":true,"href":"https:\/\/kiusi.com\/en\/wp-json\/wp\/v2\/comments?post=15425"}],"version-history":[{"count":3,"href":"https:\/\/kiusi.com\/en\/wp-json\/wp\/v2\/posts\/15425\/revisions"}],"predecessor-version":[{"id":16540,"href":"https:\/\/kiusi.com\/en\/wp-json\/wp\/v2\/posts\/15425\/revisions\/16540"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/kiusi.com\/en\/wp-json\/wp\/v2\/media\/16539"}],"wp:attachment":[{"href":"https:\/\/kiusi.com\/en\/wp-json\/wp\/v2\/media?parent=15425"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/kiusi.com\/en\/wp-json\/wp\/v2\/categories?post=15425"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/kiusi.com\/en\/wp-json\/wp\/v2\/tags?post=15425"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}