WEBDEV Concepts

Part 3: Development environment 105 1.3 What elements are included in an external component? An external component contains: • the elements to be distributed (windows, reports, etc.). These elements can be accessible (or not) when importing the component into a WINDEV, WEBDEV or WINDEV Mobile project. These elements cannot be modified from the project that uses the component. • a short description of the component. • a help text to reuse the component. This help is generated from the code comments. Remark: By default, if an external component uses an analysis and data files, the HFSQL functions will handle these elements in an independent HFSQL context. These parameters can be changed in the advanced options of the component. For more details, see "Advanced options of an external component", page 108. 2 Creating and generating an external component Below are the steps to create an external component: 1. Creating the external component. 2. Developing the elements of the external component. 3. Defining the advanced options of the external component. 4. Generating the external component. The external component can be distributed and reused. 3 Distributing an external component 3.1 Overview Once the component has been created, tested and generated, it can be distributed to other 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 it. • Standard distribution , 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 all projects 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. 3.2 Direct use of the external component The external component is created and used on the same computer. When the external component is imported 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. Caution : The files in the <Component name>.WDO file will be automatically copied to 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, etc.) used by the component. For more details, see WDO file.