Estndares de desarrollo para progamas de tipo Web Dynpro

Consultora de SAP Portal en Servicios Nacional de Chocolates

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

Estado En Proceso

Fecha 06/02/2009

Versin Documento Versin 1

Ultima Modificacin

Aprobacin

Historia de Cambios
Tema
Elaboracin del documento

Captulo
N/A

Fecha
06/02/2009

Autor
Josu D. Cruz Soriano

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

Tabla de Contenido
Historia de Cambios ............................................................................................................................ 2 Tabla de Contenido ............................................................................................................................. 3 1. 2. 3. 4. 5. 6. 7. Resumen ...................................................................................................................................... 5 Objetivos ..................................................................................................................................... 5 reas de aplicacin y/o alcance de los procedimientos ............................................................. 5 Responsables ............................................................................................................................... 5 Polticas o normas de operacin ................................................................................................. 6 Conceptos.................................................................................................................................... 6 Procedimiento ............................................................................................................................. 6 7.1 7.1.1 7.1.2 7.1.3 7.2 7.3 7.3.1 7.3.1.1 7.3.1.2 7.3.1.3 7.3.1.4 7.3.1.5 7.3.1.5.1 7.3.1.5.2 7.3.2 7.3.2.1 7.3.2.1.1 Arquitectura de los desarrollos de tipo Web Dynpro ......................................................... 6 Estructura general de los desarrollos de tipo Web Dynpro ............................................ 7 Controllers y para que deben ser usados ........................................................................ 8 Convenciones de nomenclatura de los objetos de los desarrollos ................................. 9 Formatos de Campos ........................................................................................................ 10 Estndares para reportes. ................................................................................................. 11 Pantalla de Seleccin de Datos ..................................................................................... 11 Contenedor del reporte ................................................................................................ 11 Ttulo del reporte .......................................................................................................... 12 Contenedor de los parmetros de entrada ................................................................... 12 Botones de la vista de Campos de Entrada ................................................................... 13 Campos de entrada del Reporte. .................................................................................. 14 Campos de Entrada: De tipo Match-Code................................................................. 14 Campos de Entrada: De tipo Fecha ........................................................................... 15 Pantalla de Resultados del Reporte .............................................................................. 16 Cabecera del Reporte .................................................................................................... 17 Contenedor de la Cabecera de Resultados Reporte ................................................. 17

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

7.3.2.1.1.1 7.3.2.1.1.2 7.3.2.2 7.3.2.2.1 7.3.2.2.2 7.3.2.2.2.1 7.3.2.2.2.1.1 7.3.2.2.2.2 7.3.2.2.3 7.3.2.2.4 7.3.2.2.5 8. 9. 10.

Ttulo de la Cabecera de Resultados del Reporte ................................................. 17 Campos de la Cabecera de Resultados del Reporte .............................................. 17

Listado de Resultados del Reporte ................................................................................ 18 Ttulo del Listado de Resultados del Reporte ............................................................ 18 Botones del Listado de Resultados del Reporte........................................................ 19 Botn Exportar a Excel ....................................................................................... 19 Accion del botn Exportar a Excel ................................................................. 19 Botn ? ............................................................................................................... 21 Titulos de las columnas del listado del Reporte ........................................................ 21 Ordenamiento de los datos de las columnas ............................................................ 21 Filtros de los datos de las columnas.......................................................................... 22

Formularios ............................................................................................................................... 24 Diagramas de flujo .................................................................................................................... 24 Glosario de trminos ............................................................................................................. 24

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

1. Resumen
En el presente documento se detalla los estndares requeridos y solicitados para cualquier desarrollo de tipo Web Dynpro para Java, por parte de Servicios Nacional de Chocolates.

2. Objetivos
Los objetivos son uniformar, controlar y estandarizar la interface de usuario y arquitectura de los desarrollos de tipo Web Dynpro para Java, y as tener una capa de presentacin y de arquitectura uniforme de todos ellos; facilitar las labores de auditora, la evaluacin de control interno y su vigilancia; que tanto como los trabajadores de Everest, como gente externa conozca que se est realizando el trabajo adecuadamente y cmo se est haciendo; reducir los costos al aumentar la eficiencia general, adems de otras ventajas adicionales.

3. reas de aplicacin y/o alcance de los procedimientos

Dentro de la consultora en Everest los procedimientos han sido realizados, atendiendo al mbito de aplicacin y a sus alcances de la empresa. En este documento el rea de aplicacin tiene que ver con los desarrollos de tipo Web Dynpro para Java programados e instalados en el servidor de SAP Enterprise Portal, lo cual ser el alcance de este documento.

4. Responsables
Josu David Cruz Soriano (josue.cruzs@gmail.com) .

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

5. Polticas o normas de operacin

Las polticas mencionadas a continuacin son una sugerencia y no estn incluidas las polticas o normas de operacin del Grupo Nacional de Chocolates.

6. Conceptos
Pantallas de Seleccin de Datos de un Reporte: son pantallas donde el usuario ingresar algunos datos de entrada para ejecutar algn reporte. Pantallas de Resultados de un Reporte: Es la salida que se produjo como resultado de la ejecucin del Reporte. Pantallas de tipo Transaccionales: Son pantallas que ejecutan algn proceso, y para esto se deben ir a travs de diversas pantallas, hasta el fin del mismo.

7. Procedimiento
. A continuacin se mencionan los estndares a seguir para desarrollos en Web Dynpro para Java:

7.1 Arquitectura de los desarrollos de tipo Web Dynpro

Responsable Objetivo Josu Cruz S. Definir la arquitectura esencial para los desarrollos de tipo Web Dynpro.

El patrn de diseo presentado a continuacin esta realizado para desacoplar la presentacin y la lgica de los desarrollos.

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

7.1.1

Estructura general de los desarrollos de tipo Web Dynpro

1) Todos los desarrollos deben ser de tipo Development Component. En los cuales debe haber 2. El primero, donde estarn todos los models y el segundo para alojar todas las vistas y control del programa. Nota: No deben usarse proyectos de tipo Web Dynpro, ya que slo son recomendados por SAP para pruebas, adems que para una integracin posterior a un ambiente de desarrollo, son ms fcil de integrar a SAP Netweaver Development Infrastructure (NWDI). 2) Los parmetros generales para crear los proyectos de tipo Development Component, son los siguientes: Vendor: Name: a) Para el Development Component, que alojara los models ser: models/<modulo_funcional> b) Para el Development Component, que alojara las Web Dynpro Components ser: a. En el caso de programas de tipo reportes: reportes/<modulo_funcional> b. En el caso de programas de tipo transaccionales: transaccional/<modulo_funcional> snch.com

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

3) Para los nombres de package se debe usar de forma general com.snch. Para organizar de una forma adecuada los proyectos se deben usar la siguientes nomenclaturas para nombres de los package. Applications com.snch.app.<nombre_de_application>App Components com.snch.component.<nombre_componente>Comp Models com.snch.model.<nombre_model>Model Windows com.snch.window.<nombre_window>Win Views com.snch.views.<nombre_view>View Custom Controller com.snch.cust.<nombre_CustomController>Cust Types com.snch.types.<nombre_type>Type Interface Controller com.snch.interface.<nombre_interface>CompI

7.1.2

Controllers y para que deben ser usados

El modelo de programacin Web Dynpro ofrece los siguientes tipos de controladores y que deben ser usados segn su necesidad. A continuacin se menciona que controladores hay en un proyecto Web Dynpro y adems como deben ser usados.

Tipo de Controller View Controller

Uso Debe contener solo datos, mtodos y eventos que conciernen a la vista. Debe contener solo datos, mtodos y eventos que no se pueden asignar a un a particular vista, sino que conciernen a algunas o varias vistas; tambin debe ser usado para tareas globales del componente. Debe contener datos, mtodos y eventos relacionados al entero componente y no debe estar relacionado a tareas globales.

Custom Controller

Component Controller

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

Component Interface Controller

Debe contener datos, mtodos y eventos que son usados por otros componentes.

7.1.3

Convenciones de nomenclatura de los objetos de los desarrollos

Cada objeto debe tener una nomenclatura para as poder captar rpidamente lo que ese objetos significa, a continuacin se mencionan las nomenclaturas que deben serusadas: Applications - <nombre_aplicacion>App Components - <nombre _del_componente>Comp Custom Controllers - <nombre_del_custom>Cust Interface Controller - <nombre_interface>CompI Windows - <nombre_window>Win View - <nombre_view>View Model - <nombre_model>Model Inbound Plug - <nombre_inbound>In Outbound Plug - <nombre_outbund>Out ViewSets - <nombre_viewset>ViewSet Types - <nombre_type>Types

Los objetos de interface de usuario deben ser nombrados como se muestra a continuacin, aqu solo se muestran algunos ejemplos, pero debe servir como base para todos los componentes grficos. Group - <nombre_group>Group Label - <nombre_label>Label Tray - <nombre_try>Try TextEdit - <nombre_TextEdit>TexEdi HorizontalGuntter - <nombre_horizontalGuntter>HorGun

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

TransparentContainer - <nombre_TransparentContainer>TraCon

Los ejemplos anteriores hacen referencia a la regla: Si es una sola palabra el nombre del objeto se pone la palabra completa, si son dos palabras o ms se ponen las tres primeras letras de cada palabra.

7.2 Formatos de Campos

Responsable Objetivo Josu Cruz S. Definir los formatos requeridos para los diferentes tipos de datos posibles.

Se deben formatear los campos segn el tipo del mismo, los requisitos del formato segn el tipo son los siguientes: Campos de tipo numricos: es ###,###,### Ejemplo: Nmero: 123456 Nmero: 7890123 Campo formateado: 123,456 Campo formateado: 7,890,123 Se deben separar por una coma cada tres dgitos. El patrn

Campos de tipos decimales: Se deben separar por una coma cada tres dgitos en la parte entera y dos lugares para los decimales. El patrn es ###,###,###.## Ejemplo: Nmero: 123456.12 Campo formateado: 123,456.12

Nmero: 431544.5544 Campo formateado: 431,544.55 Campos de tipo fecha: Se debe seguir el patrn dd/MM/yyyy Ejemplo: Fecha: 2008-09-13 Fecha: 09/13/1977 Campo formateado: Campo formateado: 13/09/2008 13/09/1977

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

7.3 Estndares para reportes.

Responsable Objetivo Josu Cruz S. Definir las pautas de presentacin para la presentacin de los programas.

7.3.1

Pantalla de Seleccin de Datos

7.3.1.1 Contenedor del reporte

La pantalla de seleccin de datos debe estar contenida dentro de un control Group, que contenga un estilo sapcolor.

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

7.3.1.2 Ttulo del reporte

El Ttulo deber empezar por la palabra Reporte o Consulta ms el nombre del reporte. Deber poner la imagen

7.3.1.3 Contenedor de los parmetros de entrada

Deber poner un control Tray que sirva como contenedor de los parmetros de entrada y botones. El ttulo del control Tray deber decir Seleccin de datos de entrada.

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

7.3.1.4 Botones de la vista de Campos de Entrada

Debe haber tres botones siempre en cualquier reporte y se mencionan a continuacin: o El botn Ejecutar, deber iniciar la consulta con los parmetros de entrada seleccionados.

El botn Limpiar deber implementar la accin de poner en blanco o sin valores los parmetros de entrada del reporte. Deber poner la pantalla como la primera vez que el usuario entro.

El botn ?, deber mostrar una descripcin general de la definicin del reporte. Es importante que este sea colocado al lado derecho de todos los dems botones.

Si el usuario da clic en el botn ?, se le desplegar al usuario un pop-up, como a continuacin se muestra.

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

Esta pantalla deber llevar por ttulo Informacin del Reporte. En la seccin XXX, se muestra la definicin de pantallas de tipo pop-up.

7.3.1.5 Campos de entrada del Reporte.

Cualquier campo de entrada necesita de un Label, que definir un nombre corto y descriptivo de lo que es el campo, seguido por el carcter :. A continuacin se definen los tipos de campo de entrada.

7.3.1.5.1

Campos de Entrada: De tipo Match-Code

Los match-code, se usarn para proveer listas de opciones en campos que requieren validacin contra registros de tablas secundarias.

Pantalla del Match-Code. Una vez abierta la ventana del Match-Code, como mnimo deber mostrar la clave y la descripcin del campo.

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

Seleccin del Match-Code. Una vez seleccionado el Match-Code en el campo de entrada deber aparecer el parmetro requerido que se selecciono en el Match-Code y adems una leyenda al lado derecho con el contenido de la descripcin del campo seleccionado.

7.3.1.5.2

Campos de Entrada: De tipo Fecha

Los campos de tipo fecha deben estar acompaados de un control que muestre el calendario, con la fecha del da seleccionada por default.

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

Pantalla del Calendario: Muestra el control de calendario con la fecha del da en curso seleccionada

7.3.2

Pantalla de Resultados del Reporte

La pantalla de resultado del reporte es donde se muestran los resultados de la consulta y bsicamente consta de las siguientes partes: Cabecera del reporte Es la parte donde se muestran los datos principales del reporte, y que son de carcter general. Este suele a veces no ir, dependiendo del requerimiento. Listado del reporte Es la parte donde generalmente se lista todos los registros encontrados segn el criterio de bsqueda seleccionado en la consulta. Detalle del listado del reporte Es la parte donde generalmente se ve especficamente un registro del listado de resultados del reporte.

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

7.3.2.1 Cabecera del Reporte 7.3.2.1.1 Contenedor de la Cabecera de Resultados Reporte

El contenedor del la cabecera del reporte, debe ser el control Tray.

7.3.2.1.1.1

Ttulo de la Cabecera de Resultados del Reporte

El ttulo de la cabecera deber ser 1.Resmen.

7.3.2.1.1.2

Campos de la Cabecera de Resultados del Reporte

Etiquetas Son nombres descriptivos de los campos seguidos del carcter : Campos - Son los valores a los cuales se hace referencia. Todos los campos deben ser no editables y formateados. Ej. o Datos numricos - ###.###.### (Cada tres digitos un punto). Nota: Para ms informacin acerca de formatos revise ms adelante la seccin 7.2.

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

7.3.2.2 Listado de Resultados del Reporte

Muestra los resultados de la consulta realizada.

7.3.2.2.1

Ttulo del Listado de Resultados del Reporte

El ttulo de las consultas deber incluir la imagen

El ttulo deber estar compuesto de la siguiente forma Lista de + <Nombre de los objetos de la lista> : <Nombre del Reporte> Ejemplo Lista de partidas: Credito y Cartera

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

7.3.2.2.2

Botones del Listado de Resultados del Reporte

Todos los reportes deben llevar los siguientes botones del lado izquierdo: o o Exportar a Excel - Manda los registros de la lista a un archivo Excel. ? Muestra informacin acerca de los listados y sus opciones.

7.3.2.2.2.1

Botn Exportar a Excel

El botn Exportar a Excel, deber tener la forma de la imagen siguiente.

7.3.2.2.2.1.1

Accion del botn Exportar a Excel

Cuando el botn Exportar Excel es oprimido, el sistema arroga una pantalla popup como la siguiente:

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

Partes del PopUp:

Titulo Debe llevar por ttulo Exportacin de Recurso de Excel. Mensaje El mensaje muestra el resultado de la operacin , en este caso El archivo de <programa y versin con la que se abre el archivo> fue creado satisfactoriamente. De clic en el link para abrir el recurso en una ventana separada. Link Archivo Link que muestra el nombre del archivo. Este deber formarse de la siguiente forma: Rep_<nombre del reporte>.<extensin del archivo>

Barra de Separacin Divide la pantalla de los opciones. Botones En la opcin de botones mnimo deber ir el botn Cerrar, que cierra la ventana del PopUp. Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

7.3.2.2.2.2 7.3.2.2.3

Botn ? Titulos de las columnas del listado del Reporte

Los ttulos de los mensajes deben formarse de la siguiente forma: 1. Centrados Alineados al centro. 2. Si es una palabra muy larga que abarque ms de la longitud del dato, esta se debe abreviar. 3. Si hay dos palabras y abarcan ms de la longitud del dato, entonces el formato ser: <Primera letra de la primera palabra>. <Segunda palabra> Ejemplo : Como viene: Ttulo: Fecha de Vencimiento Como debe ser: Ttulo Columna: F. Vencimiento

7.3.2.2.4

Ordenamiento de los datos de las columnas

El ordenamiento de los registros se debe poder hacerse para cualquier columna, dando clic en el ttulo de la misma.

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

Una vez seleccionada la columna a ordenar, se tendrn que ver los registros ordenados y el icono de ordenamiento dependiendo de si ordeno ascendentemente descendentemente.

Los iconos para ordenar, ascendentemente y descentemente son: Descendente -

Ascendente

7.3.2.2.5

Filtros de los datos de las columnas

Se debe poder filtrar los registros visualizados en la lista, con mnimo dos opciones de filtrado que se pueden visualizar en el siguiente ejemplo: 1. Ejemplo 1. Valor del filtro 18 Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

Resultado = Registros donde en cualquier dato de la columna filtrada tenga un 18, en cualquier parte de la cadena. Ejmeplo: 1800001, 2000018, 10001800, etc. 2. Ejemplo 2. Valor del filtro =18 (Notese el carcter =) Resultado = Registros que empiecen con el carcter 18. Ejemplo: 1800001, 1800002, 180003, etc.

A continuacin se muestra como se deben ver los filtros:

Para accionar el filtro que se puso, hay que dar clic en el botn enter un clic en el botn . Ejemplo de filtrado =18

Nota: Adicionalmente si la especificacin lo requiere se deben aladir rangos, es decir, si el usuario teclea en un campo 12~15, significa que debe traer todos los registros del 12 al 15.

Josu Cruz S. (josue.cruzs@gmail.com)

Estndares para desarrollos Web de SAP Portals Consultora de SAP Portal en SNCH

8. Formularios
No existen formularios para el requerimiento o la ejecucin del procedimiento.

9. Diagramas de flujo
No existen.

10. Glosario de trminos

Josu Cruz S. (josue.cruzs@gmail.com)