Desarrollo > Diccionario datos > Documentación > Documentación sobre campos 

Esta función permite introducir la ayuda asociada a cada campo del software, que se almacena en la base de datos en forma de textos html. La ayuda se caracteriza por una palabra clave y un código de idioma. Las palabras clave se asocian al campo de las pantallas mediante el apartado correspondiente del diccionario de pantallas.

La ayuda se genera posteriormente en el disco mediante una función de extracción específica. Se sitúa en un subdirectorio denominado FLD. Cada ayuda de campo también está integrada en la ayuda funcional si la pantalla que contiene el campo documentado está asociada a un párrafo de dicha ayuda.

Hay que tener en cuenta que se puede acceder a una función de actualización de palabras clave directamente desde el código de pantalla definido en los párrafos de la ayuda funcional.

Requisitos previos

SEEREFERTTO Consulta la documentación de Puesta en marcha

Gestión de pantalla

Pestaña Pantalla de entrada

Presentación

Además del código de idioma y del código de documento, esta pantalla contiene un bloque en el que se puede introducir el texto de la ayuda mediante un editor HTML, cuya utilización se describe en una documentación anexa.

Cerrar

 

Campos

Los campos siguientes están presentes en esta pestaña :

Características

Define la lengua en la que se expresa un texto.

Este código identifica las fichas creadas de forma única.

  • Módulo (campo MODULE)

Módulo del párrafo de la documentación.

  • Ayuda genérica (campo GEN)

Cuando esta casilla está marcada, la ayuda se considera genérica, es decir, se puede utilizar en otras pantallas además de para las que se creó inicialmente.

Una función dedicada de selección permite seleccionar las ayudas genéricas.

  • Prioridad traducción (campo PRIO)

 

  • Grupo propietario (campo CREGRP)

Este campo permite mostrar el grupo que ha creado la documentación correspondiente.

Solo está disponible en los entornos en los que se ha implementado esta noción. Corresponde a los entornos que contienen el parámetro de usuario GRPDEV.

Nota: Si el grupo del usuario es distinto al grupo propietario de la tabla AOBJGRPDEV, el grupo aparece en rojo.

Vínc.

  • campo LNKORD

Texto de ayuda

  • campo TEXTE

Este campo permite introducir el texto de la ayuda en campo que se va a mostrar al solicitar la ayuda y que se va a insertar en la documentación funcional relativa a la pantalla en la que se utiliza la ayuda.

Cerrar

 

Informes

Por defecto, los informes siguientes están asociados a la función :

 ADOCFLD : Ayuda en campo

Pero esto se puede modificar por parametrización.

Botones específicos

Los campos siguientes están en la ventana abierta por el botón :

Bloque Número 1

  • campo OBJET

 

  • campo CLES

 

Bloque Número 2

  • Desde el dossier (campo DOSORG)

Indica el dossier desde el que se va a copiar la ficha. Las posibles sintaxis se describen en el anexo dedicado.

  • Todos los dossieres (campo TOUDOS)

Esta opción permite copiar la ficha en todos los dossieres definidos en el diccionario (tabla ADOSSIER de la solución en curso).

  • Hacia el dossier (campo DOSDES)

Indica el dossier en el que se va a copiar la ficha. Las posibles sintaxis se describen en el anexo dedicado.

Cerrar

Barra de menú

Opción/Acciones/Copia de documentación

Permite copiar la ayuda en otro dossier de forma más global que el botón correspondiente. Se pueden indicar rangos para realizar copias masivas. Las sintaxis que se pueden utilizar para definir un dossier están definidas en una documentación anexa.

Opción/Acciones/Priorización traducción

Permite definir un orden de prioridad en la traducción de las documentaciones.

Opción/Comprobaciones/Supr. doc. todos los idiomas

Permite suprimir la documentación del campo en todos los idiomas existentes. Aparece una ventana de confirmación y, si se confirma, la operación es irreversible.

Opción/Comprobaciones/Ayudas no utilizadas

Permite lanzar una búsqueda global en el diccionario de pantallas para encontrar las ayudas de campo que no se utilizan en ninguna pantalla. La lista se muestra en forma de fichero de traza.

Opción/Comprobaciones/Ayudas que faltan

Permite lanzar una búsqueda global en el diccionario de pantallas para encontrar los campos sin palabra clave de ayuda o cuya palabra clave no corresponde a la ayuda de campo existente. La lista se muestra en forma de fichero de traza.

Opción/Comprobaciones/Depuración ayudas no utilizadas

Opción/Caso de empleo

Permite visualizar en una ventana de selección las pantallas en las que se utiliza la ayuda de campo.

Mensajes de error

No hay ningún mensaje de error aparte de los mensajes de error genéricos.

Tablas utilizadas

SEEREFERTTO Consulta la documentación de Puesta en marcha