COBHTTPD-CGILIB. Librería para creación de Paginas web Dinámicas con COBOL. Manual de Templates. COBHTTPD Manual de Templates

Transcripción

1 COBHTTPD-CGILIB Librería para creación de Paginas web Dinámicas con COBOL. Manual de Templates Page - 1 -

2 I N D I C E Descripción...3 Descripcion de Variables y Parrafos...4 TPL-OPEN-FILE...4 TPL-ADD-FILENAME....5 TPL-ADD-VAR...6 TPL-ADD-SESSION...7 TPL-OPEN-BLOCK...8 TPL-DATA-FORM...10 TPL-ADD-TO-COMBO Page - 2 -

3 Descripción. CGILIB es una librería que nos sirve para crear aplicaciones web dinámicas utilizando COBOL. En este manual vamos a detallar los archivos de CGILIB que se necesitan para manejar Templates y crear asi aplicaciones web usando COBOL. Los archivos que estan involucrados son: CGI-OUT.SEL Es la declaración del SELECT del archivo de salida, donde grabaremos nuestro HTML que queremos regresar al cliente. CGI-OUT.FD Es la declaración del FD del archivo de salida de nuestro HTML. Las variables de estatus y nombre del archivo se encuentran en el archivo HTML.WSS TEMPLATE.WSS Archivo que contiene las variables necesarias para TEMPLATE.FDT TEMPLATE.FDT Este archivo contiene rutinas para el manejo de templates html creados con algun editor de páginas como el FrontPage. LS-HTTP.FDT Este archivo contiene un registro de los datos que podemos recibir en los programas web. LS-HTTP-PW3.FDT Es una versión especial del archivo de datos a recibir, es para Power COBOL 3 y COBOL 85 de Power Cobol. Page - 3 -

4 Descripcion de Variables y Parrafos Los archivos que necesitamos son: TEMPLATE.FDT y TEMPLATE.WSS Descripción de párrafos: TPL-OPEN-FILE Este párrafo necesitamos llamarlo antes de empezar la creación del contenido a regresar. No necesitamos mandarle ningún valor a alguna variable, lo que hace es crear el archivo de salida. COBHTTPD le dice siempre a nuestro programa COBOL un nombre de archivo, en el cual deberemos de regresar el contenido para que cobhttpd se lo regrese al cliente. Este nombre de archivo sera un archivo line sequential de COBOL. Nuestro nombre de archivo viene en la variable HTTP-OUTPUT, y al llamar a TPL-OPEN-FILE se crea nuestro archivo de salida y ademas se abre el archivo declarado en CGI-OUT.SEL Page - 4 -

5 TPL-ADD-FILENAME. Con este parrafo especificamos cual es el archivo de Template que usaremos, necesitamos antes llenar las siguientes variables: TPL-FILENAME Indicar el nombre del archivo html que usaremos como Template, el nombre del archivo debe de ser con ruta completa, es decir directorio exacto donde se encuentra en nuestro disco duro. Ejemplo: MOVE C:\TEMPLATES\ALTAS.HTML TO TPL-FILENAME. PERFORM TPL-ADD-FILENAME. Nota: No hay que confundirse, aqui le indicamos a cobhttpd cual sera nuestro archivo de template (HTML) que deseamos utilizar, este archivo html que usaremos como template podria tener partes variables, que nosotros podremos cambiar con valores que mandemos desde nustro programa COBOL. Este archivo nosotros lo creamos con el nombre que nosotros deseemos utilizar. Es recomendable colocar todos los templates del mismo proyecto en un mismo directorio, para asi tenerlos agrupados. Page - 5 -

6 TPL-ADD-VAR Este párrafo lo que hace es enviarle algún valor especial que necesita nuestro archivo de Template, por ejemplo, si en nuestra pagina deseamos desplegar una variable NOMBRE, deberemos de pasar el valor que queremos mostrar en la pagina web. Antes de llamar este párrafo necesitamos moverle la siguiente información a estas variables: VAR-NAME nombre de la variable que necesitamos mostrar en la pagina. VAR-VALUE valor que contiene nuestra variable y que este valor será mostrado donde aparesca la referencia a nuestra variable. VAR-VALUE tiene un picture X(250). Ejemplo: MOVE NOMBRE TO VAR-NAME. MOEE MI-CAMPO TO VAR-VALUE. PERFORM TPL-ADD-VAR. Con esto le decimos a COBHTTPD que el campo NOMBRE tendrá el valor que mi variable de cobol MI-CAMPO tiene. Más adelante se verá como indicar en el template que variables deseamos mostrar. Page - 6 -

7 TPL-ADD-SESSION Este párrafo se utiliza para almacenar una variable de sesión de manera permanente, por el tiempo de vida que tenga configurado COBHTTPD. Guardar una variable en una sesión nos garantiza que la próxima vez que la misma persona accese cualquier programa podremos recuperar el valor almacenado en la consulta anterior. Por ejemplo, si un cliente nos esta haciendo un pedido, podemos almacenar el numero de pedido en una sesión y cuando vuelva a agregar mas artículos a su pedido sabremos exactamente que numero de pedido fue. COBHTTPD garantiza que cada cliente que visite nuestra página, aun cuando ejecute el mismo programa al mismo tiempo tendrá una sesión diferente, y por lo tanto sus valores serán almacenados de manera individual por cada visitante. Así garantizamos que los valores que guardemos en una sesión jamás serán accesados por otro visitante. Una vez que se guardo una variable en una sesión, es tan sencillo recuperar su valor simplemente declarándola en las variables que recibira por la LINKAGE-SECTION y obviamente indicandole en el configurador de COBHTTPD que dicho programa necesita esa variable en especial. Este párrafo necesita las siguientes variables: SESS-NAME Hay que mover el nombre de la variable que deseamos almacenar SESS-VALUE Es el valor que queremos que contenga nuestra variable Ejemplo: MOVE FOLIO TO SESS-NAME. MOVE MY-FOLIO TO SESS-VALUE. PERFORM TPL-ADD-SESSION. De esta manera creamos una variable de COBHTTPD a la que llamamos FOLIO y le movemos un valor que tenemos en nuestro programa en una variable llamada MY-FOLIO que podría ser el último número de folio usado. Para usar dicha variable, solo hay que dar de alta una variable FOLIO en el configurador de COBHTTPD en los programas que deseemos y el valor que grabamos en la sesión nos llegara siempre, pero solamente por el tiempo de vida que tenga la sesión. Es decir, si se almacena un numero 1000, y el tiempo de vida de los cookies es de 20 minutos, solo lo recibiremos durante esos 20 minutos, si el visitante entra en el minuto 21, este valor nos llegara en ceros. Page - 7 -

8 TPL-OPEN-BLOCK Este párrafo nos permite crear un bloque repetido, e insertarlo en el contenido a regresar. Muy especial por ejemplo para crear un listado de Registros de un archivo, en donde no sabemos cuantos va a contener, ya que como pueden ser 10, pueden ser 1,000 o muchos más. Para esto, se crean en el template unas marcas especiales con las que se le indica cual será el código que deseamos repetir, y dicho bloque de código HTML será repetido por este párrafo. Supongamos que en nuestro Template, tenemos un código html como el siguiente: <html> <body> <table> <tr><td>clave</td><td>nombre</td></tr>   <tr> <td><? Clave?></td> <td> <? Nombre?> </td>  </body> </html> Este tipo de marcas son las que se pueden usar en un Template, pero aquí básicamente nos interesan 2:  define un inicio de un bloque, y lo llama ROW1, y termina hasta donde aparece , esto quiere decir que el bloque ROW1 contiene todo lo que esta adentro. La macro  Indica en donde deseamos pegar el contenido del bloque, puede contener cualquier nombre, nosotros lo marcamos como TABLA. Hay un detalle con este bloque, y es que, dentro de el se indica que se usan dos variables, estas son clave y nombre, entonces, antes de imprimir un renglón en esta tabla por medio de un bloque, debemos de indicar que valores tendrán estas variables Los datos que necesita el párrafo TPL-OPEN-BLOCK para funcionar son: BLOCK-NAME Contiene el nombre del block a insertar. BLOCK-PASTE Contiene el nombre de la posición donde queremos insertar el block. Page - 8 -

9 Ejemplo: MOVE CLAVE TO VAR-NAME. MOVE 1000 TO VAR-VALUE. PERFORM TPL-ADD-VAR. MOVE NOMBRE TO VAR-NAME MOVE JUAN PEREZ TO VAR-VALUE. PERFORM TPL-ADD-VAR. MOVE ROW1 TO BLOCK-NAME. MOVE TABLA TO BLOCK-PASTE. PERFORM TPL-OPEN-BLOCK. Antes de escribir el bloque, le asignamos unos valores a las variables que usa en el bloque. Si estuvieramos leyendo datos de un archivo, usaríamos claro los valores de los campos del archivo, de esta manera secuencialmente grabaríamos tantos bloques como registros procesara el archivo. Page - 9 -

10 TPL-DATA-FORM Este parrafo es utilizado para enviar valores a controles especiales de una forma que se encuentra dentro de nuestro template. Es muy parecido al TPL-ADD-VAR, solo que TPL-ADD-VAR solo sirve para sistituir una variable definida en el template por un texto que nosotros indiquemos desde nuestro programa. Pero no sirve para controles definidos en la forma que sean del tipo: RADIO, CHECKBOX, SELECT Las variables que necesitamos usar para este parrafo son: FORM-NAME Nombre del control en la forma a quien deseamos darle un valor inicial FORM-VALUE Valor que deseamos colocar en el control de la forma Page

11 TPL-ADD-TO-COMBO Este párrafo lo vamos a utilizar cuando necesitemos llenar un combo (SELECT en HTML) con valores que asignara nuestro programa COBOL. Dichos valores podemos ya sea extraerlos de un archivo de datos por ejemplo. Este párrafo necesita las siguientes variables: COMBO-NAME Es el nombre que contiene el combo en el template html. COMBO-ITEM Asignaremos la descripcion que se vera en el navegador. COMBO-VALUE Es el valor que la pagina nos regresara con el elemento seleccionado por el usuario desde la pagina web. COMBO-SELECTED Para indicar si el elemento actual es seleccionado o no, los valores son Y para seleccionar, y N para no seleccionar. Ejemplo: MOVE "CIUDAD" TO COMBO-NAME. MOVE "TAMPICO" TO COMBO-ITEM. MOVE "001" TO COMBO-VALUE. MOVE "N" TO COMBO-SELECTED. PERFORM TPL-ADD-TO-COMBO. MOVE "MADERO" TO COMBO-ITEM. MOVE "002" TO COMBO-VALUE. PERFORM TPL-ADD-TO-COMBO. MOVE "ALTAMIRA" TO COMBO-ITEM. MOVE "003" TO COMBO-VALUE. MOVE "Y" TO COMBO-SELECTED. PERFORM TPL-ADD-TO-COMBO. En este ejemplo, se cargan tres opciones en el combo CIUDAD, y esta marcada como seleccionada el elemento 3, que corresponde a la ciudad ALTAMIRA. Si desearamos cargar todo el contenido de un archivo, seria cuestion de leer el archivo secuencialmente, y en cada lectura pasar los valores correspondientes a las variables necesarias para este parrafo. Page