Sistema de ayuda para Documentos Analíticos

Aunque en general los gráficos, tablas o tacómetros son autoexplicativos, hay casos en los que conviene aclarar el tipo de información que se muestra, por ejemplo la selección que se ha realizado, si los datos se filtran con todos los selectores o que fórmula se ha utilizado para calcular el valor representado, de manera que el usuario pueda interpretar la información de manera correcta.

Atlas SBI - Sistema de Ayuda - Ventana de ayuda
Atlas SBI - Sistema de Ayuda - Ventana de ayuda


En este artículo veremos como construir un sistema de ayuda para nuestros documentos analíticos a fin de dotar al usuario de mayor información a la hora de analizar los datos mostrados.

Nuestro sistema de ayuda constará básicamente de dos elementos, una base de datos con una tabla para guardar la información a mostrar y un documento analítico con parámetros que mediante un control de tipo Grid mostrará los datos.

En el diseño del documento de ayuda veremos una técnica que nos permitirá cambiar el formato de las filas de los grids, rompiendo el tradicional esquema de filas y columnas. Esta técnica se utiliza también para mostrar la información de la ficha del cliente en el documento Cliente - Dashboard de la Demo autoinstalable de Atlas SBI.

Construcción de la base de datos

Como hemos comentado, la base de datos tendrá una única tabla llamada BIAyuda donde se indicará el Proyecto, Documento y Control al cual pertenece la ayuda, el orden en que queremos que se muestren los registros y como campos da ayuda un título, la ayuda propiamente dicha y una ayuda técnica (aclaración para los informàticos que utilicen el sistema de ayuda).

La tabla se puede crear utilizando el siguiente código SQL

USE [AyudaSBI]
GO
/****** Objeto:  Table [dbo].[BIAyuda]    ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
SET ANSI_PADDING ON
GO
CREATE TABLE [dbo].[BIAyuda](
 [Proyecto] [varchar](120) NULL,
 [Documento] [varchar](100) NULL,
 [Control] [varchar](50) NULL,
 [Titulo] [varchar](200) NULL,
 [Orden] [int] NULL,
 [AyudaTecnica] [varchar](max) NULL,
 [Ayuda] [varchar](max) NULL
) ON [PRIMARY]
GO
SET ANSI_PADDING OFF


Una vez creada la tabla insertaremos unos registros de prueba. En este caso cuatro registros para cuatro controles del 'Doc1' de un proyecto llamado 'Ayuda'.

INSERT INTO [AyudaSBI].[dbo].[BIAyuda]([Proyecto], [Documento], [Control],[Titulo],[Orden],[AyudaTecnica],[Ayuda])
     VALUES ('Ayuda','Doc1', 'Control1', 'Grafico Evolución mensual', 10, null, 
'El Gráfico de evolución mensual permite saber 
bla, bla, bla, bla, bla, bla') INSERT INTO [AyudaSBI].[dbo].[BIAyuda]([Proyecto], [Documento], [Control],[Titulo],[Orden],[AyudaTecnica],[Ayuda]) VALUES ('Ayuda','Doc1', 'Control2', 'Funcionamiento control2', 20, null, 'El control 2 permite el siguiente funcionamiento
bla, bla, bla, bla, bla, bla') INSERT INTO [AyudaSBI].[dbo].[BIAyuda]([Proyecto], [Documento], [Control],[Titulo],[Orden],[AyudaTecnica],[Ayuda]) VALUES ('Ayuda','Doc1', 'Control3', 'Funcionamiento control3', 30, null, 'El control 3 permite el siguiente funcionamiento
bla, bla, bla, bla, bla, bla') INSERT INTO [AyudaSBI].[dbo].[BIAyuda]([Proyecto], [Documento], [Control],[Titulo],[Orden],[AyudaTecnica],[Ayuda]) VALUES ('Ayuda','Doc1', 'Control4', 'Funcionamiento control4', 40, null, 'El control 4 permite el siguiente funcionamiento
bla, bla, bla, bla, bla, bla')

Como se puede observar, dentro del campo Ayuda insertamos código HTML para mejorar la presentación y facilitar la lectura del contenido.

Creación del documento de ayuda

Una vez creada la conexión a la base de datos, crearemos un documento llamado 'Ayuda Documentos Analíticos' y le asignaremos cuatro parámetros: Proyecto, Documento, Control y AyudaTecnica.

Atlas SBI - Creación Documento Ayuda - Parámetros
Atlas SBI - Creación Documento Ayuda - Parámetros

Seguidamente añadiremos un control de tipo Grid para seleccionar los datos que mostrará nuestro documento de ayuda. La selección se hará utilizando los parámetros del documento Proyecto, Documento, Control y AyudaTecnica.

Atlas SBI - Creación Documento Ayuda - Control Grid
Atlas SBI - Creación Documento Ayuda - Control Grid

El parámetro AyudaTecnica determinará si queremos que nuestro documento muestre el contenido del campo AyudaTecnica. El resto de parámetros determinará que registros se seleccionan de manera que la sentencia retornará todos aquellos registros del Proyecto, Documento y Control seleccionados o, en caso de que el parámetro Control contenga el valor '-Todos-', retornará todos los registros del Proyecto y Documento seleccionado.

Atlas SBI - Creación Documento Ayuda - Select del Grid
Atlas SBI - Creación Documento Ayuda - Select del Grid
Una vez tenemos la selección, generamos las columnas utilizando el botón de Generar Columnas y asignamos el campo Titulo como Clave Unica.

Atlas SBI - Creación Documento Ayuda - Columnas del Grid
Atlas SBI - Creación Documento Ayuda - Columnas del Grid

Cambio del formato de la tabla de datos

Para facilitar la lectura de la ayuda cambiaremos la estructura tradicional de filas y columnas de nuestro Grid cambiando la disposición de los campos mediante una plantilla HTML en la sección Data Row Template.

Atlas SBI - Creación Documento Ayuda - Formato de las columnas del grid
Atlas SBI - Creación Documento Ayuda - Formato de las columnas del grid

Distribuyendo los campos en filas con codigo HTML para destacar los puntos que creamos conveniente como por ejemplo el título o definir el tamaño.

Atlas SBI - Creación Documento Ayuda - Formato de las columnas del grid
Atlas SBI - Creación Documento Ayuda - Formato de las columnas del grid
Una vez hayamos colocado el control Grid en el diseño HTML del documento estará listo para ser llamado desde cualquier control.

Llamada desde un control

Para llamar a la ayuda, abriremos el control desde el que queremos llamarla y crearemos un enlace al documento que acabamos de crear.

Atlas SBI - Creación enlace al documento de Ayuda
Atlas SBI - Creación enlace al documento de Ayuda

En el campo Texto del menú escribiremos el texto que queremos que le aparezca al usuario cuando haga clic sobre el control. Este texto ha de ser fácilmente entendible por lo que en este ejemplo pondremos 'Como interpretar este gráfico'.

Atlas SBI - Creación enlace al documento de Ayuda
Atlas SBI - Creación enlace al documento de Ayuda

En los parámetros del enlace activaremos la opción Valor y asignaremos los valores de Proyecto, Documento y Control que correspondan, así como si queremos que se muestre la ayuda técnica o no.

Una vez guardado el proyecto, podremos ver que nuestro control muestra una nueva opción al hacer clic sobre él con el texto de la ayuda.

Atlas SBI - Sistema de Ayuda
Atlas SBI - Sistema de Ayuda

Y al seleccionar la opción mostrará el contenido de la ayuda definida en la base de datos.

Atlas SBI - Sistema de Ayuda - Ventana de ayuda
Atlas SBI - Sistema de Ayuda - Ventana de ayuda


Llamada desde el documento

Creación de un botón 

Podemos utilizar el mismo sistema para proporcionar ayuda a todo el documento. Para ello crearemos un control de tipo Button al que le asignaremos el texto Ayuda.
Atlas SBI - Sistema de Ayuda - Creación botón Ayuda
Atlas SBI - Sistema de Ayuda - Creación botón Ayuda

Llamada al documento de ayuda

Tal como hicimos en el ejemplo anterior, crearemos un enlace a nuestro documento de ayuda. En este caso adaptaremos el texto del menú cambiando 'gráfico' por 'documento', ampliaremos el alto de la ventana, y lo más importante, en el parámetro Control escribiremos el texto '-Todos-' para que seleccione todos los registros de ayuda del documento y proyecto concretos.

Atlas SBI - Sistema de Ayuda - Creación botón Ayuda
Atlas SBI - Sistema de Ayuda - Creación botón Ayuda

Insercción del botón en el panel

Seguidamente añadiremos el botón creado al panel de selectores añadiendo un margen para que se desplace a la derecha. y guardaremos nuestro proyecto.

Atlas SBI - Sistema de Ayuda - Creación botón Ayuda
Atlas SBI - Sistema de Ayuda - Creación botón Ayuda

Con esto conseguimos que al pasar sobre el botón Ayuda se desplegue la opción como interpretar el documento.
Atlas SBI - Sistema de ayuda de documento
Atlas SBI - Sistema de ayuda de documento

Que al ser seleccionada abre una ventana con la ayuda de todos los controles del documento que se haya definido en nuestra base de datos de ayuda.

Atlas SBI - Sistema de ayuda de documento
Atlas SBI - Sistema de ayuda de documento

Este ejemplo se puede mejorar añadiendo campos a la tabla de base de datos para ofrecer una ayuda más personalizada como por ejemplo el idioma o el rol en caso de que diferentes usuarios deban tener información diferente.

0 comentarios :

Publicar un comentario

Lo más visto