- Creating the project
- Required configuration of environment
- Opening project
- Opening project
- Managing the share
- Developing a project in teamwork: temporarily checking out the elements and checking them back in
- To check out an element
- To check in an element:
- Possible actions
- Structure of the directory for a shared project
- Compiling the project and running its test
- Optimizing the compilation time of a shared project
Sharing the development of a project
The development of a large IS system requires the participation of several developers. These developers must work on a single WINDEV project while sharing the different resources (windows, classes...).
This chapter presents information about teamwork development via the developer groupware. We recommend that you use the Source Code Manager that simplifies the share of project development
. This chapter presents:
- Creating a project
- Project opened by several developers
- Developing the project
- Project test
: this chapter only presents the share of a project. All the access rights to the project and to its elements are the rights granted by default when sharing a project. The development of a shared project can be associated with an advanced management of rights for the project elements. See Rights granted to developers
for more details.
|From version 17, the management of rights is no longer available in the developer groupware.|
From version 18, the options used to handle the developer groupware are not available in the ribbon. These menu options are available in the drop-down menu of WINDEV, WEBDEV or WINDEV Mobile that can be accessed:
- Via the icons
- Via the main menu accessible via the logo of product version:
The method for creating a project that will be used by several developers is identical to the method for creating an individual project. In this case, you must:
- Create the project in a shared directory, accessible in read/write by all the project developers.
- Specify that the project will be used by several developers. To do so, check "I share the project with other developers" in the project description ("Project .. Project description", "Project" tab).Specify that the project will be used by several developers.
- Display the description window of project: on the "Project" pane, in the "Project" group, click "Description".
- Display the "SCM" tab.
- Select "Teamwork by using the developer groupware".
When creating a shared project, you can:
- Create the main structure of the project from the beginning: analysis, main windows, classes, sets of procedures, etc. Indeed, the developers involved in the project development will only have to modify the different project elements according to their own requirements.
- Grant specific rights on the project elements via the Rights granted to developers.
Required configuration of environment
Depending on the environment configuration, the options regarding the developer groupware may not be accessible.
To use the developer groupware:
- Select "Tools .. Options .. Options of the environment".
- In the "Environment" tab, check:In the "Functions" tab, check:
- "Former mode of Developer Groupware".
- "Control Centers".
To open a project in WINDEV, all you have to do is open the corresponding ".WDP" file. Two constraints exist for a shared project:
- The directory of the project must be a directory accessible in read/write by all the developers.
- The access path to the project must be the same for all the developers, on all the development computers. We recommend that you use either a UNC path, or a virtual drive that is using the same letter on all development computers.
Therefore, it is not allowed to have the following paths on two development computers for the same project:
Note: To simplify the management of a shared project and to quickly identify the developers working on the project, we advise you to specify a user name when starting WINDEV.
Managing the share
The project is opened in automatic mode by default ("Project .. Developer groupware .. I let WINDEV manage the rights on the project").
The rights in "Write" mode are automatically granted according to the action performed on the project (add an element to the project, modify the code of the project, ...).
Note: WINDEV allows you to manage specific opening modes:
- I consult the project, no rights are granted to me: no action can be performed on the project (add elements, ...)
- I take all the rights on the project: any action can be performed on the project. However, all the developers who open this project will have read-only rights on the project. These developers will not be able to add elements to the project.
Developing a project in teamwork: temporarily checking out the elements and checking them back in
As soon as a project element is opened by a developer, this element is automatically checked out from the project.
For the person who checks out the element, this element is in "Read/Write" mode: all the possible modifications can be performed on the element. The element is checked out until it is checked back in. This check-in is not mandatory when closing the project or when closing WINDEV.
For the other developers, the element is in read-only mode, in its status before check-out.
In any case, you have the ability to view the name of the developer who checked out the project element:
- In the list of project elements ("Project .. Developer groupware .. Status of elements").
- In the title bar of the element, when this element is opened.
- in the "Project explorer" pane.
- In the project editor: the initials of the developer are indicated in the graphic representation of element (in blue).
This information is automatically updated when opening or closing the elements.
Caution: The automatic refresh may depend on the type of network used.
To check out an element
- Solution 1: Open the element (from the "Project explorer" pane).
- Solution 2: Select "Check out" from the popup menu of element.
- Solution 3: Perform the check-out from the list of elements ("Project .. Developer groupware .. Status of elements").
To check in an element:
- Solution 1: When closing the object, WINDEV automatically proposes to check the element back in.
- Solution 2: Select "Check in" from the popup menu of element (in the "Project explorer" pane).
- Solution 3: Open the element and select "File .. Groupware .. Check in".
Caution: if you check in an element that remains opened in your editor, the element will be in "Read-only" mode for the other developers.
- Solution 4: Perform the check-in from the list of elements ("Project .. Developer groupware .. Status of elements").
Regardless of the developer, when one or more elements are checked out, you can:
- run a test of the project,
- creating the executable,
- create the library.
During these operations, a synchronization is proposed if necessary to take into account the elements checked in since the last compilation of the project.
Structure of the directory for a shared project
When sharing a project, several sub-directories are automatically created. These sub-directories are as follows:
- A sub-directory for each developer in the CPL sub-directory:
The CPL directory contains the compiled codes of the project elements. The CPL sub-directories per developer contain the compiled codes corresponding to each developer.
Caution: the CPL directory and its sub-directories must not be deleted.
Note: To optimize the compilation time, this directory can be created locally. See Compiling the project and running its test for more details.
- A Groupware sub-directory:
The Groupware sub-directory contains the elements checked out from the project. The status of these elements corresponds to their status before the check-out operation.
Tip: The file of an element can be copied from the Groupware directory to the main project directory: the element will no longer be checked out but it will have its status before check-out.
Caution: This directory must not be deleted.
Compiling the project and running its test
Any developer can compile the project and run its test. .
When running the test of the project or window, WINDEV automatically proposes to synchronize the existing elements modified by other developers.
Note: you also have the ability to synchronize at any time ("File .. Reload the document" from the project editor).
Optimizing the compilation time of a shared project
By default, all the elements that belong to the shared project are located in a single directory, shared by all the developers. To optimize the compilation time of the project, we recommend that you use a local compilation directory. This directory will contain the compiled codes of each project element.
To define a local directory for compiling the shared project:
- Display the project description ("Project .. Project description").Display the project description: on the "Project" pane, in the "Project" group, click "Description".
- In the "Project" tab, select the compilation directory.In the "Compilation" tab, select the compilation directory.
- Validate. A <ProjectName>.Cpl file will be created in the specified directory. A directory to the name of the developer will be created in this directory. This directory will contain the compiled codes of the project elements.
This page is also available for…
Click [Add] to post a comment