AYUDA EN LÍNEA
 WINDEVWEBDEV Y WINDEV MOBILE

Ayuda / Conceptos WEBDEV / Parte 3 - Entorno de desarrollo
  • Presentación
  • Definición
  • ¿De qué se compone un componente externo?
  • ¿Qué contiene un componente externo?
  • Crear y generar un componente externo
  • Distribuir un componente externo
  • Presentación
  • Uso directo del componente externo
  • Distribución estándar de componentes externos
  • Distribución a través de un procedimiento de instalación
  • Utilizar un componente externo en un sitio web
  • Implementar un sitio que contiene un componente externo
  • Presentación
  • Actualización de componentes y de sitios Web
  • Modificar un componente externo
  • Presentación
  • Tipos de compatibilidad
  • Características avanzadas de los componentes externos
  • Documentación automática
  • Visibilidad de un elemento del componente
  • Archivo WDO
  • ¿Qué es un archivo WDO?
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReportes y ConsultasCódigo de Usuario (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Código Navegador
WINDEV Mobile
AndroidWidget Android iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Otros
Procedimientos almacenados
12. Componente externo en la práctica
Página anteriorTabla de contenidoPágina siguiente
Presentación

Definición

Un componente externo es un conjunto de elementos de WINDEV, WEBDEV o WINDEV Mobile: ventanas, páginas, reportes, análisis, etc. Este conjunto de elementos realiza una operación específica. Por ejemplo, un componente puede corresponder a una de las siguientes operaciones:
  • Envío de fax,
  • Envío de correos electrónicos,
  • ...
Observaciones:
  • Para optimizar la organización de sus proyectos, puede utilizar componentes internos. Para obtener más información, consulte Componente interno.
  • En este capítulo, nos referiremos a "componente externo" como "componente".
Un componente externo puede redistribuirse a otros desarrolladores de WINDEV, WEBDEV o WINDEV Mobile. (de forma gratuita o no). Los desarrolladores podrán integrar fácilmente en su aplicación o sitio la funcionalidad incluida en el componente. Por lo tanto, el componente se integrará y distribuirá con la aplicación (o sitio).
Al crear el componente externo, el autor especifica:
  • qué elementos del componente son visibles para el usuario. Los elementos visibles son accesibles mediante programación o a través del panel "Explorador de proyectos".
  • cómo utilizar el componente (modo de uso, los parámetros utilizados para acceder a las funcionalidades del componente, etc.). Una documentación corta (a completar) se genera y asocia automáticamente al componente.

¿De qué se compone un componente externo?

Un componente externo puede ser:
  • definido y generado a partir de un proyecto existente de WINDEV, WEBDEV o WINDEV Mobile. Una configuración de proyecto de tipo "Componente" le permitirá seleccionar los elementos del proyecto existente que se integrarán en el componente.
  • creado a partir de un proyecto de tipo "Componente externo". De forma predeterminada, este proyecto se compone de una plataforma de tipo "Componente externo" que contendrá los elementos necesarios para crear y generar el componente.
Este componente externo puede integrarse en otros proyectos WINDEV, WEBDEV o WINDEV Mobile.
Todos los elementos del componente son totalmente independientes del proyecto en el que se integra. El componente externo puede tener su propio análisis, ventanas, reportes, archivos de datos, etc.
Al generar el componente externo, simplemente especifique si el proyecto que lo utiliza puede acceder a estos elementos. El proyecto no podrá leer o manipular elementos que no sean accesibles.
El componente externo está compuesto por varios archivos:
<Nombre del componente>.WDKArchivo del componente. Contiene todos los elementos del componente externo.
Este archivo es necesario para incluir el componente externo en un proyecto.
Este archivo también debe proporcionarse en la versión cliente de la aplicación que utiliza el componente externo.
<Nombre del componente>.WDIDescripción del componente (solo para el desarrollo de aplicaciones).
Este archivo es necesario para incluir el componente externo en un proyecto.
Este archivo no debe proporcionarse en la versión cliente de la aplicación que utiliza el componente externo.
<Nombre del componente>.WDZArchivo con las dependencias del archivo WDK (solo para componentes WEBDEV y WINDEV Mobile)
Archivo que contiene las dependencias del archivo WDK. Esta información se extrae en el proyecto en el que se integra el componente.
  • En el caso de un componente WEBDEV, este archivo contiene las páginas WEBDEV generadas, las imágenes, etc.
  • En el caso de un componente móvil (iOS o Android), este archivo contiene, por ejemplo, los archivos de generación de Android.
<Nombre del componente>.WDOArchivo opcional
Archivo de texto que contiene la lista de elementos adicionales proporcionados con el componente externo (archivos de datos, archivos .INI, etc.). Este archivo puede crearse manualmente o generarse automáticamente a partir de los elementos especificados en la carpeta "Otros" del panel "Explorador de proyectos". Para obtener más información, consulte Archivo WDO.

¿Qué contiene un componente externo?

Un componente externo contiene:
  • los elementos a distribuir (ventanas, reportes, etc.). Estos elementos pueden ser accesibles (o no) al importar el componente a un proyecto WINDEV, WEBDEV o WINDEV Mobile. Estos elementos no pueden modificarse desde el proyecto que utiliza el componente.
  • una breve descripción del componente.
  • un texto de ayuda para reutilizar el componente. Esta ayuda se genera a partir de los comentarios de código.
Observación: De forma predeterminada, si un componente externo utiliza un análisis y archivos de datos, las funciones HFSQL manipulan estos elementos en un contexto HFSQL independiente. Estos parámetros se pueden cambiar en las opciones avanzadas del componente. Para obtener más información, consulte Opciones avanzadas de un componente externo.
Crear y generar un componente externo
Un componente externo se crea siguiendo los pasos a continuación:
  1. Crear un componente externo.
  2. Desarrollar los elementos del componente externo.
  3. Definir las opciones avanzadas del componente externo.
  4. Generar el componente externo.
El componente externo puede distribuirse y reutilizarse. Para obtener más información, consulte Distribuir un componente externo y Utilizar un componente externo en una aplicación.
Distribuir un componente externo

Presentación

Una vez creado, probado y generado el componente, se puede distribuir a otros desarrolladores. Hay varios métodos disponibles:
  • Uso directo del componente externo
    Ejemplo: el componente externo se utiliza directamente en el equipo del desarrollador que lo creó.
  • Distribución estándar, proporcionando los archivos necesarios.
    Ejemplo: el componente externo será utilizado por varios desarrolladores dentro de la misma empresa. En este caso, los archivos necesarios pueden copiarse en una unidad de red.
  • Distribución mediante el SCM: Este modo de distribución permite que todos los proyectos que se encuentran en el SCM utilicen directamente un componente publicado en el SCM. Para obtener más información, consulte SCM y componentes.
    Ejemplo: Una empresa comparte varios proyectos a través del SCM. Los proyectos utilizados para crear los componentes externos y los proyectos que utilizan los componentes comparten el mismo SCM.
  • Distribución a través de un programa de instalación (con un procedimiento de instalación del componente similar al utilizado para las aplicaciones).
    Ejemplo: Este modo de distribución se recomienda si el componente externo está destinado a ser vendido o distribuido a gran escala, con actualizaciones frecuentes.

Uso directo del componente externo

El componente externo se crea y utiliza en el mismo equipo.
Al importar el componente externo a un proyecto, solo debe seleccionar el archivo WDI del componente. Este archivo se encuentra en el directorio EXE del proyecto del componente.
El directorio de generación es el directorio asociado a la configuración de proyecto de tipo "Componente externo".
Atención: Los archivos que se encuentran en el archivo <Nombre del componente>.WDO se copiarán automáticamente en el directorio EXE del proyecto que utiliza el componente.
Si el componente externo utiliza archivos específicos (archivos de datos, archivos de texto, etc.), se debe crear (o completar) un archivo <Nombre del componente>.WDO una vez generado el componente. Este archivo contiene la lista de archivos externos (archivos de datos, archivos de texto, etc.) utilizados por el componente. Para obtener más información, consulte Archivo WDO.

Distribución estándar de componentes externos

La distribución estándar de un componente externo consiste en copiar los archivos requeridos por el componente en una ubicación determinada. Los archivos se copian en un directorio específico. Este directorio puede estar ubicado en un servidor de red, por ejemplo.
Al importar el componente externo a un proyecto, solo debe seleccionar el archivo WDI del componente en el directorio de distribución.
Para distribuir un componente externo, es necesario proporcionar:
  • Los archivos generados automáticamente por WINDEV o WEBDEV (archivos <Nombre del componente>.WDK y <Nombre del componente>.WDI)
  • Si es necesario, los archivos específicos manipulados por el componente (archivos de datos, archivos de inicialización, etc.) así como el archivo <Nombre del componente>.WDO. El archivo <Nombre del componente>.WDO contiene la lista de archivos que deben proporcionarse con el componente. Para obtener más información sobre este archivo, consulte Distribuir un componente avanzado: archivo WDO.

Distribución a través de un procedimiento de instalación

La distribución de componentes externos mediante un procedimiento de instalación requiere proporcionar un programa de instalación a los usuarios. Este programa instala todos los archivos necesarios para el componente externo en el directorio especificado por el usuario.
Este modo de instalación permite gestionar automáticamente:
  • el archivo WDO y la instalación de archivos específicos (archivos de datos, etc.) utilizados por el componente externo.
  • la instalación de herramientas específicas (MDAC, controlador ODBC para HFSQL, etc.).
  • la actualización automática de los archivos de datos utilizados por el componente externo (si es necesario).
  • la desinstalación del componente externo.
Para crear un procedimiento de instalación para un componente externo:
  1. Cree el procedimiento de instalación del componente externo directamente desde los botones de acceso rápido:
  2. En las diferentes etapas del asistente, indique:
    • el nombre del componente externo.
    • los idiomas del procedimiento de instalación.
    • el título de la ventana principal del programa de instalación. Puede configurar la interfaz del instalador a través del botón "Avanzado".
    • los archivos instalados. Puede agregar archivos específicos además de los archivos predeterminados del componente. El archivo WDO se creará automáticamente a partir de esta lista.
    • el directorio de instalación predeterminado del componente. Puede configurar los cambios que se deben realizar en el sistema a través del botón "Avanzado".
    • los módulos opcionales a instalar.
    • los medios de instalación, las opciones de seguridad y los parámetros avanzados.
    • ...
De forma predeterminada, los archivos necesarios para instalar un componente externo se crean en el subdirectorio "<Nombre del proyecto>\EXE\INSTALL_COMPO<Nombre del componente>".
Recordatorio: Al crear la instalación de una aplicación, los archivos necesarios se crean en el subdirectorio "<Nombre del proyecto>\EXE\INSTALL".
Utilizar un componente externo en un sitio web
Un componente externo se puede reutilizar en cualquier momento en cualquier sitio WEBDEV: solo necesita conocer el directorio que contiene los archivos del componente.
Cuando haya una nueva versión del componente, solo tiene que instalar los nuevos archivos en el directorio de instalación del componente (según el modo de instalación utilizado).
Para obtener más información sobre los diferentes modos para instalar un componente, consulte Distribuir un componente externo.
Si el componente se publicó e importó a través del SCM, las actualizaciones disponibles aparecen al abrir el proyecto que utiliza el componente.
Si el componente se distribuyó con un sitio WEBDEV, se debe actualizar el componente. Para obtener más información, consulte "Implementar un sitio que contiene un componente externo".
Implementar un sitio que contiene un componente externo

Presentación

Los sitios que utilizan uno o más componentes se implementan de la misma manera que los sitios estándar: en la pestaña "Proyecto", en el grupo "Generación", despliegue "Implementar sitio".
Cuando se implementa un sitio que utiliza un componente, los siguientes archivos se instalan automáticamente en el servidor:
  • <Nombre del componente>.WDK,
  • los archivos necesarios para el componente y la aplicación.

Actualización de componentes y de sitios Web

Al actualizar un componente y/o un sitio implementado, se pueden instalar los siguientes elementos en el equipo de implementación del sitio:
  • el sitio, el componente y los archivos necesarios.
  • el sitio y los archivos necesarios para el mismo.
  • el componente y los archivos necesarios.
Para obtener más información sobre la compatibilidad entre sitios y componentes, consulte Compatibilidad entre componentes externos y aplicaciones implementadas.
Se pueden utilizar dos métodos para actualizar un componente en los equipos de los usuarios finales:
1. Recompilar el proyecto principal
Recompile el proyecto que utiliza el componente y redistribuya el sitio con el componente. En este caso, no se producirá ningún problema de versión o de compatibilidad. La recompilación es necesaria en los siguientes casos:
  • Se agregaron nuevas funcionalidades al componente y deben tenerse en cuenta.
  • Se modificaron los parámetros de algunos procedimientos.
  • Incompatibilidad entre versiones nuevas y anteriores del componente.
  • ...
2. Distribuir el archivo .WDK directamente
Proporcione una versión actualizada del componente (archivo .WDK) a los usuarios finales sin recompilar el proyecto.
En la mayoría de los casos, esta posibilidad se aplica cuando:
  • La nueva versión se utiliza para corregir problemas de una versión anterior.
  • Se agregaron nuevas funcionalidades al componente, pero no son necesarias para el funcionamiento del sitio.
Modificar un componente externo

Presentación

Una vez que se haya creado y generado el componente, puede modificarse en cualquier momento. Algunos de los cambios que se pueden aplicar son los siguientes:
  • agregar elementos al componente.
  • eliminar elementos del componente.
  • cambiar los permisos en los elementos del componente.
  • realizar cambios en uno de los elementos del componente.
En cualquiera de estos casos, se debe volver a generar el componente para tener en cuenta los cambios.

Tipos de compatibilidad

La compatibilidad está relacionada con las versiones de un componente. Si se realizan cambios en el componente, los sitios que lo utilizan pueden tener problemas de ejecución si no están sincronizados con él.
La compatibilidad es una etapa importante cuando se realizan cambios en un componente. Existen dos tipos de compatibilidad:
  • compatibilidad descendente: la versión del componente (archivo .WDK) utilizada para compilar los sitios debe ser mayor o igual a la versión que ya se ha implementado.
    Este tipo de compatibilidad se gestiona automáticamente. Si la versión del componente instalado con el sitio es anterior a la versión utilizada por el sitio, éste no funcionará.
  • compatibilidad ascendente: puede definir que la nueva versión de un componente no pueda ser utilizada con un proyecto compilado en una versión anterior. Se deben volver a compilar los proyectos para utilizar la nueva versión del componente.
Características avanzadas de los componentes externos

Documentación automática

Los componentes externos deben incluir una documentación técnica.
WINDEV, WEBDEV y WINDEV Mobile le ayudan a crear esta documentación mediante las siguientes opciones:
  • Una presentación general del componente. Esta presentación general puede introducirse al generar el componente.
  • Una documentación técnica generada automáticamente a partir de los comentarios en el código de los elementos del componente.
¿Cuáles comentarios de código se tienen en cuenta?
Los siguientes comentarios se tienen en cuenta automáticamente para crear la documentación del componente:
  • Comentarios al inicio de los procedimientos WLanguage.
  • Comentarios al inicio de los siguientes eventos:
    • Código de inicialización de ventanas o páginas,
    • Código de inicialización de reportes,
    • Código de inicialización de clases,
    • Código de inicialización de conjuntos de procedimientos.
¿Cuándo se genera la documentación?
La documentación del componente se crea la primera vez que se genera el componente (ícono en los botones de acceso rápido).
Al generar la documentación:
  • los comentarios en el código se utilizan para crear la documentación.
  • si no se encuentran comentarios en el código, los parámetros de entrada y salida esperados de cada elemento accesible del componente se incluirán automáticamente en la documentación. Los comentarios correspondientes se crean automáticamente en los diferentes elementos.
Observación: La documentación del componente puede regenerarse cada vez que se genera el componente (botón "Regenerar").

Atención: Si utiliza la opción "Regenerar", los cambios realizados en la documentación en el asistente de generación se perderán.
¿Cómo acceder a la documentación del componente?
La presentación general del componente se muestra automáticamente en la ventana de descripción del componente.
La documentación técnica del componente está disponible:
  • al integrar el componente en el proyecto: en la pestaña "Proyecto", en el grupo "Proyecto", despliegue "Importar" y seleccione "Un componente externo".
  • en la descripción de los componentes incluidos en el proyecto.
    En el panel "Explorador de proyectos":
    • En la carpeta "Componentes externos", seleccione el componente externo deseado.
    • Haga clic derecho para abrir el menú contextual y seleccione la opción "Descripción".
    • En la pestaña "Detalles", puede obtener los detalles de la documentación generada.
La documentación específica de un elemento del componente (ventana, etc.) se puede consultar:
  • haciendo doble clic en el elemento deseado en el panel del Explorador de proyectos o presionando F2 en el código del elemento.
  • desde el panel "Explorador de proyectos":
    • Seleccione la carpeta "Componentes externos".
    • Haga clic derecho para abrir el menú contextual.
    • Seleccione la opción "Lista de componentes internos importados al proyecto".

Visibilidad de un elemento del componente

Al crear un componente, se pueden definir los elementos del mismo a los que podrán acceder los usuarios finales.
  • Si un elemento es accesible, el usuario lo verá en la lista de elementos del proyecto. Los usuarios podrán manipular los elementos del componente mediante programación (como cualquier otro elemento del proyecto).
    Observación: El código de este elemento no es visible.
  • Si el elemento no es accesible, el usuario ni siquiera sabrá que existe.
Atención: Dependiendo del modo de declaración de los elementos del proyecto (clases, conjuntos de procedimientos, etc.), los elementos a los que se puede acceder podrían cambiar.

Archivo WDO

Al generar el componente externo, se crean automáticamente varios archivos en el directorio EXE del proyecto actual:
<Nombre del componente>.WDKContiene todos los elementos de WINDEV que se redistribuyen con el componente (ventanas, reportes, etc.).
<Nombre del componente>.WDIInterfaz del componente. Este archivo contiene:
  • un texto de ayuda sobre cómo utilizar el componente cuando se reintegra,
  • los elementos necesarios para utilizar el componente en el proyecto (información de compilación, etc.).
<Nombre del componente>.WDZArchivo con las dependencias del archivo WDK (solo para componentes WEBDEV y WINDEV Mobile)
Archivo que contiene las dependencias del archivo WDK. Esta información se extrae en el proyecto en el que se integra el componente.
  • En el caso de un componente WEBDEV, este archivo contiene las páginas WEBDEV generadas, las imágenes, etc.
  • En el caso de un componente móvil (iOS o Android), este archivo contiene, por ejemplo, los archivos de generación de Android.

Estos archivos deben distribuirse junto con el componente.
Si el componente externo utiliza elementos adicionales (archivos de datos, por ejemplo), se deben agregar los siguientes archivos en el directorio EXE del proyecto:
  • un archivo <Nombre del componente>.WDO: Este archivo contiene la lista de archivos externos (archivos de datos, archivos de texto, etc.) utilizados por el componente externo. Estos archivos se deben proporcionar e instalar con el componente externo.
  • los archivos que deben distribuirse con el componente externo. Estos archivos pueden estar en una subestructura jerárquica específica. En este caso, el código del componente externo debe gestionar el acceso a los archivos según esta estructura jerárquica.

¿Qué es un archivo WDO?

Un archivo <Nombre del componente>.WDO es un archivo TXT que puede crearse y editarse en cualquier momento. Este archivo se puede crear y editar con el Bloc de notas, el editor de texto estándar de Windows.
Este archivo contiene la lista de archivos externos (archivos de datos, archivos de texto, etc.) utilizados por el componente externo que deben proporcionarse e instalarse con dicho componente. Estos archivos deben copiarse en el directorio EXE de los proyectos que utilizan el componente externo.
El archivo ".WDO" puede contener:
  • el nombre completo del archivo.
    Por ejemplo: C:\ComponentesWD\ComponenteSelector\EstadoInicial.INI
  • el nombre del archivo. Este archivo se buscará en el directorio actual del componente externo.
    Por ejemplo: EstadoInicial.INI
  • un nombre de archivo que utiliza una ruta relativa. Las sintaxis disponibles son las siguientes:
    - Directorio\NombreArchivo.xxx para especificar un subdirectorio del directorio actual.
    - .\NombreArchivo.xxx para especificar el directorio actual.
    - .\NombreArchivo.xx para especificar el directorio padre.
    Por ejemplo: \ComponenteSelector\EstadoInicial.INI
Este archivo se utiliza al incluir el componente externo en el proyecto.. Las rutas especificadas en el archivo WDO deben corresponder a las rutas en las que están instalados los archivos en el equipo de desarrollo del componente externo.
Al incluir el componente externo, la estructura jerárquica especificada en el archivo WDO se mantendrá y reproducirá en el directorio EXE del proyecto. Para obtener más información, consulte Utilizar un componente externo en una aplicación.
Ejemplo: El componente "Código Postal" utiliza un archivo de datos "Cedex" (archivos Cedex.fic y Cedex.ndx). Este archivo de datos se encuentra en el directorio EXE del proyecto de creación del componente.
Para proporcionar e instalar el componente con el archivo de datos, se debe crear el archivo WDO en el directorio EXE del proyecto de creación del componente. Este archivo debe contener las siguientes líneas:
.\CEDEX.Fic
.\CEDEX.NDX
Distribuir un componente con un archivo WDO
Para distribuir un componente que utiliza un archivo WDO, es necesario proporcionar:
  • el archivo WDK (si es necesario)
  • el archivo WDI
  • el archivo WDO
  • todos los archivos necesarios a los que se hace referencia en el archivo WDO.
Página anteriorTabla de contenidoPágina siguiente
Comentarios
Haga clic en [Agregar] para publicar un comentario

Última modificación: 15/02/2024

Señalar un error o enviar una sugerencia | Ayuda local