- Direct use of the external component
- Simple distribution of external components
- Necessary elements
- Distribution via a setup procedure
Distributing an external component
Once the external component was created, checked and generated, it can be made available to the developers. Multiple methods are available:
- Direct use of the external component
Example: the external component is directly used on the computer of the developer who created the component.
- Simple distribution, by providing the necessary files.
Example: the external component is intended to be used within the same company, by several developers. In this case, the necessary files can be copied to a network drive.
- Distribution via the SCM: This distribution mode allows the projects found in the SCM to directly use a component published in the SCM. For more details, see SCM and components.
Example: A company shares several projects via the SCM. The projects used to create the external components and the projects that use the components share the same SCM.
- Distribution via a setup program (with a setup procedure of the component similar to the one used for the applications).
Example: This distribution mode is recommended if the external component is intended to be sold or distributed on a large scale, with regular updates.
Direct use of the external component
The external component is created and used on the same computer.
When importing the external component into a project, all you have to do is select the WDI file corresponding to the component. This file can be found in the EXE directory of the component project.
The generation directory is the directory associated with the "External component" project configuration.
The files referenced in the <Component name>.WDO file will be automatically copied into the EXE directory of the project that uses the component.
If the external component uses specific files (data files, text files, etc.), a <Component name>.WDO file must be created (or completed) once the component is generated. This file contains the list of external files (data files, text files, ...) used by the component. For more details, see WDO file
Simple distribution of external components
The simple distribution of an external component consists in providing by simple copy the files required for the component to operate. The files are copied to a specific directory. This directory can be located on a network server, for example.
When the external component is imported into a project, all you have to do is select the WDI file corresponding to the component in the distribution directory.
To distribute an external component, you must provide:
- The files automatically generated by WINDEV or WEBDEV (<Component name>.WDK and <Component name>.WDI files)
- If necessary, the specific files handled by the component (data files, initialization files, ...) as well as <Component name>.WDO. The <Component name>.WDO file contains the list of files that must be provided with the component. For more details on this file, see Distribution of advanced component: the WDO file.
Distribution via a setup procedure
The distribution of external components via a setup procedure consists in supplying a setup program to the users of the external component. This program installs all the files required for using the external component in the directory specified by the user.
This setup mode is used to automatically manage:
- the WDO file and the setup of specific files (data files, ...) used by the external component.
- the setup of specific tools (MDAC, ODBC driver for HFSQL, ...).
- the automatic update of the data files used by the external component (if necessary).
- the uninstall program of the external component.
To propose a setup procedure for an external component:
- Create the setup procedure of the external component directly from the quick access buttons:
- In the different steps of the wizard, specify:
- the name of the external component.
- the languages proposed in the setup procedure.
- the title of the main window of the setup program. You can configure the interface of the installer via the "Advanced" button.
- the files installed. You can add specific files on top of the default component files. The WDO file will be automatically created from this list.
- the default component setup directory. You can configure the changes to be made to the system via the "Advanced" button.
- the optional modules to install.
- the installation media, security options and advanced parameters.
By default, the files required to install an external component are created in the "<Project name>\EXE\INSTALL_COMPO<Component name>" subdirectory.
Reminder: When creating the installation of an application, the necessary files are created in the "<Project name>\EXE\INSTALL" subdirectory.
This page is also available for…