Diccionario Database – Manual del programador

Diccionario DataBase – Manual del Programador
Diccionario Database – Manual del programador
Página 1 di 7
Diccionario DataBase – Manual del Programador
Sumario
1
¿A quién va dirigido? ........................................................................................................... 3
2
Introducción conceptual ...................................................................................................... 3
3
Contenidos........................................................................................................................... 3
3.1
Mantenimiento Registro Configuración Aplicación .......................................................................................... 3
3.2
Mantenimiento Diccionario ........................................................................................................................ 4
3.2.1
3.3
Mantenimiento Campos ....................................................................................................................... 4
Routines para el control formal, búsqueda y descodificación campos ............................................................... 5
3.3.1
API establecidas por el usuario para el tratamiento de los campos en el Diccionario. ..................................... 5
3.3.2
UDF WUF_DEC ................................................................................................................................... 6
3.3.3
Sintaxis ............................................................................................................................................. 6
3.3.4
Descripción de los parámetros .............................................................................................................. 6
3.3.5
Ejemplo ............................................................................................................................................ 6
3.4
FICHERO DECOD ..................................................................................................................................... 7
Página 2 di 7
Diccionario DataBase – Manual del Programador
1 ¿A QUIÉN VA DIRIGIDO?
Dirigido a todos los programadores que quieren implementar las funciones automáticas de la documentación, control,
búsqueda y descodifica de los campos de databases.
2 INTRODUCCIÓN CONCEPTUAL
Webgate400 gestiona un diccionario campos planeado para incrementar las funcionalidades de la interfaz en general y de las
distintas aplicaciones configurable por el cliente (query e database links).
El diccionario permite:
•
definir cada uno campo
•
definir los programas para descodificar y buscar el contenido de los mismos.
•
Definir los nombres “alias” empleados de la applicación como alternativa al nombre principal del campo.
3 CONTENIDOS
3.1 Mantenimiento Registro Configuración Aplicación
Es necesario codificar las aplicaciones del usuario para asociar cada uno de los campos del diccionario con la aplicación
relacionada.
Los campos indispensables son los que hay en el ejemplo.
Código: insertar un código alfanumérico inferior de 001 o superior de 030 (son reservados los códigos incluidos entre los
dos numéros).
Nombre File Diccionario Campos: Indicar un nombre file en el cual se deben insertar todos los campos definidos por una
específica applicación utilizando la apropriada función de compilación que hay en el programa para el mantenimento del
“Diccionario Campos”.
Nombre Biblioteca Ficheros Originales : Insertar el nombre de la biblioteca donde será colocado el antedicho “Fichero
Diccionario campos”.
Longitud Nombres Campos: Insertar la longitud de los campos (emplear 10 excepto que el utilizo de los prefijos).
Confirmando este formato vídeo, será pedida automáticamente la asociación de la nueva aplicación a uno o más del los
programas de webgate400.
Página 3 di 7
Diccionario DataBase – Manual del Programador
3.2 Mantenimiento Diccionario
El diccionario campos es útil para unificar las nomenclaturas y las caracteristicas de los campos de database y/o aquellos
empleados en formatos vídeos y además para asociar a estos campos algunas funciones standard aptas a sus gestión.
Este elaborado permite, a través de la tecla “Compila diccionario”, obtener un único fichero que contiene todos los campos
empleados de la aplicación.
Durante la creación de la dds por un fichero de database, se puede :
-
Acceder a estas definiciones por la keyword dds a nivel de fichero REF para identificar el antedicho fichero de
diccionario.
-
En las especificaciones de campo, especificar el solo nombre sin nombrar las caracteristicas que serán introducidas
desde el diccionario.
3.2.1 Mantenimiento Campos
Para insertar un nuevo campo, es bastante escribir su nombre en el cuadro “Creación nuevo campo” y pulsar ENVÍO.
En cada campo se pueden definir los campos que hay en el siguiente ejemplo.
-
Código Aplicación
-
Nombre Campo
-
Función (para la definición principal, utilizar el valor “D” (Definición).
-
Descripción (Traducida por el programa Compila Diccionario con la keyword dds TEXT -“texto”)
-
Encabezamiento (Traducido por el programa Compila Diccionario con la keyword dds COLHDG)
-
Tipo, Longitud, Posición Decimales
-
Nombre Biblioteca decodifica/control (véase el parrafo relativo a las routines sobre el “Control formal,
búsqueda y decodifica campos ”).
-
Alias Insertar los nombres que se refieren, por lo que concierne a las funciones y el contenido, al campo objeto de
la definición.
Página 4 di 7
Diccionario DataBase – Manual del Programador
3.3 Routines para el control formal, búsqueda y descodificación campos
3.3.1 API establecidas por el usuario para el tratamiento de los campos en el Diccionario.
Cuando se necesita controlar ,descodificar, buscar un campo, WEBGATE400 vuelve a llamar al programa que ha sido
indicado en el registro del campo específico (en el ejemplo arriba RTXT01 en la biblioteca CLX). Esto es lo que pasa, por
ejemplo, en las funciones de búsqueda de los documentos por medio de la categorizacíon en la aplicación DATABASE LINKS
o bien, por medio de la función UDF WUF_DEC que se utiliza en las instrucciones SQL para descodificar los campos sin
utilizar Join.
Pronto las operaciones de control, descodificación y búsqueda de los campos, serán extendida a la utilización de los filtros y
serán objeto de específicas funciones que permitirán delegar al cliente webgate400 aquellas funciones que ahora se
desarrollan en el programa RPG.
A continuación la descripción de los parámetros y las reglas de funcionamiento que los programas establecidos por el
usuario (como RTXT01) tienen que seguir “exactamente” para asegurar el comportamiento previsto de la aplicación
webgate400.
3.3.1.1
Parámetros
Nombre
Longitud
Descripción
P0XCODIN
20
Código (Alineado a SX)
I/O
P0XDECOD
50
Descodificación (Alineado a
SX)
I/O!
P0XESITX
1
Resultado control
E=Error Descodificación
P0XSBJID
10
Identificador Subjeto
(facultativo) Se utiliza cuando I
una sola routine del usuario
desarrolla varios campos. Por
eso, se utiliza para
diferenciar los varios campos.
3.3.1.2
Valores Parámetro
Input/Output
O
Reglas de funcionamiento
La función de búsqueda se activa en las condiciones siguientes:
1.
Si el campo P0XCODIN está blanco y el campo P0XDECOD no está blanco o bien …
2.
Si el campo P0XCODIN contiene un ? (punto de interrogación) en la primera posición.
La función de descodificación y control se activa en la siguiente condición:
1.
Si el campo P0XCODIN no está blanco.
Si los dos campos P0XCODIN y P0XDECOD son rellenados, el campo P0XDECOD está blanco y se presume así la solicitud de
descodifica.
Si el usuario solicita la función de busqueda y está tiene exito, se vuelve también activa la función de descodifica y el campo
P0XDECOD será devuelto debidamente llenado.
Página 5 di 7
Diccionario DataBase – Manual del Programador
3.3.2 UDF WUF_DEC
Webgate400 posee algunas UDF (funciones definidas por el usuario) que permiten simplificar la sintaxis de las instrucciones
SQL. Estas son disponibles tanto en el entorno webgate400 como en 5250 por qualquiera instrucción sql ejecutada.
NB: La utilización de las UDF, cuando estas utilizan archivos de las applicaciones, prevee la exacta predisposición de la lista
de las bibliotecas.
Para la descodificación de los campos descritos en el diccionario, por la cual se define la routine de control y descodificación,
es disponible la siguiente UDF. Aquella devuelve un campo (columna) que contiene la descodifica del código indicado.
3.3.3 Sintaxis
WUF_DEC(CódigoApplicación, Nombre del campo en el diccionario, Campo que contiene el código que se quiere
descodificar).
3.3.4 Descripción de los parámetros
Código Aplicación
Especificar el código de la aplicación (véase códigos aplicación en las
funciones de gestión de webgate)
Nombre del campo en el diccionario
Especificar el nombre del campo a descodificar, como descrito en el
diccionario campos.
Campo que incluye el código a descodificar
Especificar el nombre del campo que contiene el valor que se quiere
descodificar.
3.3.5 Ejemplo
WUF_DEC(‘001’, ‘CODAR’, XCODAR)
Así la instrucción SQL descrita en seguida, devuelvería dos columnas: Código artículo y Descodificación artículo.
SELECT XCODAR, WUF_DEC(‘001’, ‘CODAR’, XCODAR) FROM CLBAS
Recibida esta instrucción, Webgate400 ejecuta los pasos siguientes:
1.
engancha al registro (record) de diccionario por el campo “CODAR”
2.
ejecuta el programa indicado (en este caso RTXT01 pasando en el parámetro P0XCODIN el valor del campo XCODAR
3.
recibe el valor sacado del parámetro de output P0XDECOD, anteriormente descrito.
Página 6 di 7
Diccionario DataBase – Manual del Programador
3.4 FICHERO DECOD
El fichero DECOD contiene, para cada aplicación y para cada campo que prevee una descodificación (por ejemplo un código
cliente, un código artículo, etc.), todos los valores posibles de lo mismo y su propria descodificación.
Las aplicaciones “Fast Query” y “Database Links” utilizan este fichero, que puede ser llenado por el usuario.
La aplicación Fast Query, por ejemplo, lo utiliza tanto en la descodificación automatica de los campos (sin gestionar joins
dificíles con distintos tableros y database) como en las búsquedas por orden alfabetíco durante la valorización de los campos
utiles a la “Selección Registros”.
Formato Registro
Nombre
Campo
Descripción
Tipo
Longitud
XNRR
Código Aplicación (véase parrafo “Mantenimiento Registro Configuración Aplicación“)
A
3
XDECAM
Nombre Campo (véase “Mantenimiento Diccionario Campos/ Tableros”)
A
10
XDECOD
Código
A
20
XDEDES
Descodificación
A
50
P
14
XDEHMO Fecha-Hora Imm/Agg Registro Descodificación General (formato HHMMSSGGMMAAAA)
Ejemplo de los contenidos del fichero DECOD, que contiene código y descodificación de los distintos campos.
XNRR
XDECAM
XDECOD
XDEDES
001
CAME1
07
PRODUCTOR ITALIA
1182006012006
001
CAME1
09
MATRICES C/TERZOS ITALIA
1182006012006
001
CAME1
49
CLIENTES OCASIONALES
1082006012006
001
CAUST
AA
REFERENCIA DE PRUEBA AA
2142006022006
001
CAUST
RS
REPARACÍON MATRIZ
2142006022006
001
CAUST
05
COMEDOR
2142006022006
001
CCL01
AAA
CLIENTE TOSTO 2
1102006012006
001
CCL01
002
CLASS. LIBRE CLIENTE 2
1082006012006
001
CCL02
001
CLASS. LIBRE 2 N.001
1082006012006
001
CCL02
002
CLASS. LIBRE 2 N.002
1082006012006
001
CCL03
002
CLAS .LIBRE 3 N. 002
1082006012006
001
CCL05
005
CLASS. LIBRE 5 N.005
1182006012006
001
CLASS
AD
MATERIAS POR EMBALAJE
1082006012006
001
CLASS
AF
DESCRIPCIÓN CLASE AF
1082006012006
001
CLASS
AR
ARTÍCULO TERMINADO
1082006012006
001
CODAN
C
A00001
CLIENTE DE PRUEBA MD
1082006012006
001
CODAN
C
000001
AVAGLIANO ANTONIO SRL.
2272008022008
001
CODAN
C
000002
TERMOSOL &SNC DI BOTTA
4172008042008
001
CODAR
A5
PRODUCTO MATERIA PRIMA A5
8022006082006
001
CODAR
A6
PRODUCTO MATERIA PRIMA A6
1132006012006
001
CODAR
A9
PRODUCTO MATERIA PRIMA
8222006082006
Página 7 di 7
XDEHMO