Vínculos de documentación
La función de gestion de los vínculos de documentación permite asociar a una documentación dada, vínculos a los elementos del diccionario. Estos se utilizan, junto con los datos encontrados en el diccionario, para generar de forma automática de los párrafos y su contenido, sobre todo en las secciones previamente requerida y las secciones anexas finales.
Vínculo según los tipos de documentación
La lista de vínculos existentes y la forma en la que se utilizan según el tipo de documentación de origen se da a continuación. En estos cuadros se encuentra una columna Compl.
Esta columna define, cuando está en Sí, los vínculos descritos por este código vienen a completar los vínculos que aparecen en el diccionario. Así, cuando se genera una documentació funcional, las ventanas, tablas, objetos que tiene asociados se analizan para encontrar los códigos de actividad asociados, pero es posible que un código de actividad que no está directamente vinculado a la función influya en su funcionamiento. Entonces se añadirá este código de actividad mediante un vínculo.
Cuando la columna Compl está en No, ninguna otra información del diccionario permite definir el vínculo en cuestión. Es obligatorio indicar este tipo de vínculo si se desea que esta información figure en la documentación generada. Hay que tener en cuenta que en ciertos casos (tablas diversas, menúes locales) se pueden encontrar vínculos de este tipo, pero de forma poco fiable (en este caso sólo interesan las tablas diversas y los menúes locales cuya parametrización es un requisito previo de la función).
Funciones
Las documentación de las funciones (códigos AFC) pueden enriquecerse por vínculos del cuadro siguiente.
Enlace | Significado | Uso en el momento de la generación de la documentación | Compl |
ACV | Código actividad | Lista de códigos de actividad afectados en los requisitos previos. | Sí |
ADP | Parámetro | Paramentros afectados por los requisitos previos. | No |
ANM | Contadores | Lista de contadores asociados a la función en los requisitos previos. | No |
GAU* | Asientos automáticos | Lista de asientos asociados a la función en los requisitos previos. | No |
CDE | Códigos de sección | Lista de códigos de sección asociados a la función en los requisitos previos. | No |
TRS | Transacciones | Lista de funciones que premiten definir transacciones para la función documentada. | No |
ADI | Tablas diversas | Lista de tablas diversas en los requisitos previos de función. | No |
AML | Menús locales | Lista de menúes locales a parametrizar en los requisitos previos. | No |
ARP | Informes | Informes lanzados desde la función. | Sí |
ABT | Tareas batch | Anexo de tareas batch que permiten lanzar la función. | Sí |
ATB | Tablas | Tablas para la función. | Sí |
Importante: la búsqueda de códigos de actividad a partir de funciones en el diccionario es muy exhaustiva, y es susceptible de reenviar ciertos códigos de actividad cuya presencia no tiene por qué ser esperada. Para cambiar esto, basta con crear un vínculo al código de actividad FAL (siempre falso). Cuando se inserta un vínculo de este tipo, sólo se reenvían el resto de códigos de actividad presentes en la lista de vínculos.
Parámetros
Las documentación de las funciones (códigos ADP) pueden enriquecerse por vínculos del cuadro siguiente.
Enlace | Significado | Uso en el momento de la generación de la documentación | Compl |
AFC | Función | Funciones afectadas en la ayuda que describe el parámetro. | No |
ACV | Código actividad | Lista de códigos de actividad asociados. | Sí |
AOE | Modelos importación/exportación | Lista de modelos de import/export con este parámetros. Este vínculo sólo se utiliza de forma recíproca (para obtener parámetros asociados a los modelos en la documentación en cuestión). | No |
AT2 | Tablas requisito previo | Lista de tablas a indicar en los requisitos previos. | No |
Variable de Dimensionamiento
Las documentación de las funciones (códigos ADM) pueden enriquecerse por vínculos del cuadro siguiente.
Enlace | Significado | Uso en el momento de la generación de la documentación | Compl |
ATB | Talas dimensionadas | Lista de tablas dimensionadas por la variable. | Sí |
Modelos importación/exportación
Las documentación de los modelos de import/export (códigos AOE) pueden enriquecerse por vínculos del cuadro siguiente.
Enlace | Significado | Uso en el momento de la generación de la documentación | Compl |
ADP | Parámetros afectados | Lista de los parámetros que influyen en el funcionamiento del modelo. Hay que tener en cuenta los vínculos recíprocos que se recorren. | No |
AT2 | Tablas requisito previo | Lista de tablas mencionadas en los requisitos previos de uso. | No |
ATB | Tablas de actualización | Lista de tablas actualizadas | Sí |
Informes
Las documentación de los modelos de informes (códigos ARP) pueden enriquecerse por vínculos del cuadro siguiente.
Enlace | Significado | Uso en el momento de la generación de la documentación | Compl |
ATB | Tablas editadas | Lista de las tablas cuyo contenido alimenta el informe | Sí |
Eventos de Workflow
Las documentación de los eventos (códigos AWA) pueden enriquecerse por vínculos del cuadro siguiente.
Enlace | Significado | Uso en el momento de la generación de la documentación | Compl |
ATB | Tablas del contexto | Lista de las tablas cuyo contenido forma parte del contexto de activación | Sí |
Acciones
Las documentación de las acciones (códigos ACT) pueden enriquecerse por vínculos del cuadro siguiente.
Enlace | Significado | Uso en el momento de la generación de la documentación | Compl |
ACT | Acciones asociadas | Acciones vinculadas a la anterior | Sí |
Activador de estadísticas
Las documentación de los activadores de estadísticas (códigos PS1) pueden enriquecerse por vínculos del cuadro siguiente.
Enlace | Significado | Uso en el momento de la generación de la documentación | Compl |
ATB | Tablas | Tablas utilizadas en el contexto de activación | Sí |
Caso particular de puntos de entrada
Los puntos de entrada se apoyan de forma un poco particular en los vínculos. De hecho:
- el elemento del diccionario que está documentado es el tratamiento en el diccionario de los tratamientos
- cada punto de entrada se define por un vínculo al tipo APE, y el código asociado es el nombre del punto de entrada. Los vínculos que siguen (hasta el próximo vínculo APE) caracterizan este punto de entrada. Si hay características comunes antes del primer vínculos APE, tienen que estar válidos por defecto para todos los puntos de entrada.
- los vínculos ATB y AT2 se utilizan para definir las tablas abiertas (respectivamente con un contenido significativo o no significantes)
- el vínculo TRS permite definir si hay una transacción en curso (valor 2) o no (valor 1)
- el vínculo TRA permite definir si hay un fichero de traza abierta (valor 2) o no (valor 1)
Así, si existe el cuadro de los vínculos siguiente:
| TRS | 1 |
| TRA | 2 |
| ATB | TABLA1 |
| AT2 | TABLE2 |
| APE | PUNTO1 |
| ATB | TABLA3 |
| APE | PUNTO2 |
| TRA | 1 |
| APE | PUNTO3 |
| AT2 | TABLA4 |
El tratamiento dispone de 2 puntos de entrada PUNTO1, PUNTO2, PUNTO3:
- El PUNTO1 no tiene transacción abierta, gestiona una traza, la tabla TABLA1 está en línea y es significativa, la tabla TABLA" está en línea sin ser significativa (valor por defecto), la tabla TABLA3 está en línea y es significativa.
- El punto PUNTO2 tiene los mismos valores por defecto, excepto que no hay traza (la tabla TABLA3 no está en línea).
- El punto PUNTO3 tiene los mismos valores por defecto (hay una traza abierta). La tabla TABLA4 está abierta sin ser significativa.