PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Overview
  • Opening the project from SCM (1st project opening only)
  • Working on a project found in the Source Code Manager
  • Project options affecting the SCM
  • Working on a shared project in the SCM
  • The different check-out modes
  • Management mode of project
  • Managing the project in Master/Guest mode
  • Managing the project in automatic mode
  • Special cases
  • Modifying the analysis
  • Changing computer
  • Required configuration of environment
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Overview
The principle for working with the Source Code Manager is as follows:
  • All the developers work on a local copy of the project. This project and all its elements are read-only by default.
  • When a project element is opened, this element is read-only by default: it cannot be modified. To modify it, it must be checked out from the Source Code Manager, modified and checked back in.
  • Only the master can modify the characteristics of the project (analysis, project description, ...).
Note: The SCM can only be used with the operating systems that support the data files exceeding 4 GB. The SCM cannot be used on the computers that run the following operating systems: Windows 98 and Me. If the SCM database is in HFSQL Client/Server mode, the SCM can be used with these operating systems (on the client computers).
This help page explains how to work with a project found in the SCM. See Creating an SCM database for more details.
Opening the project from SCM (1st project opening only)

Working on a project found in the Source Code Manager

To work on a project found in the Source Code Manager:
  1. You must get a local copy of the project found in the Source Code Manager. To do so, open the project from the Source Code Manager.
    This operation must be performed once only by each developer who is using the project. The developer who added the project to the Source Code Manager has no operation to perform.
    Important: Don't copy the files locally via the Windows explorer.
  2. Select "File .. Open a project from SCM".Expand among the quick access buttons and select "Open a project from the SCM".
    Versions 18 and later
    Note: You also have the ability to use the home window to open a project found in the SCM.
    New in version 18
    Note: You also have the ability to use the home window to open a project found in the SCM.
    Note: You also have the ability to use the home window to open a project found in the SCM.
  3. In the wizard, specify:
    • the path of SCM database (network computer or shared directory)
    • the user name and password (if necessary).
  4. Select the directory of the SCM database corresponding to the requested project.
  5. Specify the local directory into which the project will be copied.
  6. Validate. The project is copied locally and it is automatically opened according to the mode specified during its integration in the database.
Note: The next openings of a project managed by SCM are identical to the openings of a project not managed by SCM: all you have to do is open the project (".WDP" file) corresponding to the local copy.

Project options affecting the SCM

Several options are used to configure a project handled by the Source Code Manager. These options are grouped in the "SCM" tab of the project description. These options are checked by default.
Reminder: To display the project description, on the "Project" pane, in the "Project" group, click "Description". Reminder: To display the project description, select "Project .. Project description".
  • Propose to get the latest version of elements when opening the project:
    When opening a project found in the SCM database, this option proposes to retrieve the latest version of project elements. By default, the latest version of elements is automatically retrieved.
  • Propose to check in the elements when closing the project
    When the project is closed, this option is used to display the list of elements that are currently checked out in order for some of them (or all of them) to be checked back in.
    By default, the checked-out elements are not checked back in when the project is closed.
  • Propose to check in and to get the latest version of the elements when generating executables, libraries, de components, ...
    When creating an executable or a library, this option is used to display the list of checked-out elements so that they can be checked back in and to get the latest version of these elements. Therefore, the executable, the component or the library will contain the most updated elements.
    By default, the generation of the executable, library, ... is performed with the project elements currently found on the local computer.
  • Check out/Check in the project automatically:
    This option is used to automatically manage the "project file". This option is used to disable the "Master/Guest" management on the project.
    If this option is checked:
    • The project file is checked out only if the action performed requires it.
    • Once the action was performed on the project, the check-in of the project file is automatically proposed.
      Versions 21 and later
      If the option "Automatically check the project back in at the end of operation" was checked during the check-out, the project file is automatically checked back in (without confirmation window).
      New in version 21
      If the option "Automatically check the project back in at the end of operation" was checked during the check-out, the project file is automatically checked back in (without confirmation window).
      If the option "Automatically check the project back in at the end of operation" was checked during the check-out, the project file is automatically checked back in (without confirmation window).
    Tip: This option can also be enabled as follows: on the "SCM" pane, in the "Project" group, expand "Master/Guest" and select "Manage the project check-out automatically". This option can also be enabled via "SCM .. Manage the project .. Manage the project check-out automatically".
  • Versions 17 and later
    Include the new elements in the current configuration only:
    This option is used to automatically add the new elements (windows, reports, ...) into the current configuration. The window used to specify the configuration in which the element must be included will not be displayed.
    New in version 17
    Include the new elements in the current configuration only:
    This option is used to automatically add the new elements (windows, reports, ...) into the current configuration. The window used to specify the configuration in which the element must be included will not be displayed.
    Include the new elements in the current configuration only:
    This option is used to automatically add the new elements (windows, reports, ...) into the current configuration. The window used to specify the configuration in which the element must be included will not be displayed.
Working on a shared project in the SCM
To handle the elements of a project found in SMC, you must:

The different check-out modes

The SCM proposes two modes for checking out the project elements:
  • the standard mode: if you display a SCM element that is not checked out, a panel indicates that the element must be checked out before it can be modified. The element can be checked out immediately (check-out button found in the dialog box).
  • the automatic mode: if you try to modify a SCM element that is not checked out, the SCM automatically proposes to check out this element. Once the check-out is validated, the element can be modified.
    Note: this mode is not recommended when using SCM with a slow Internet connection.
The check-out mode of the SCM elements is an option of WINDEV, WEBDEV and WINDEV Mobile.
To change the check-out mode:
  1. Select "Tools .. Options .. General options of WINDEV/WEBDEV/WINDEV Mobile". On the "Home" pane, in the "Environment" group, expand "Options" and select "General options of WINDEV/WEBDEV/WINDEV Mobile".
  2. Select the "General" tab. The "Check out elements during the first modification" option is used to switch all the projects opened from the current product to the automatic mode.
Caution: In this version, the automatic mode is supported by the windows, the pages, the queries and the reports.
Management mode of project

Managing the project in Master/Guest mode

The Source Code Manager distinguishes between 2 types of users:
  • the master: the master is the user who initially stored the project in the Source Code Manager.
  • the guests: the guests are the developers who handle the project from the Source Code Manager.
    There is no need to be connected in master mode on a project. The "Master" mode is only required to:
  • modify the project characteristics and check these modifications back into the SCM database.
  • check in all the elements to create the executable and the setup program of the application.
To switch from master mode to guest mode, select "SCM .. Project management .. Become guest on the project (and check all in)".To switch from master mode to guest mode: on the "SCM" pane, in the "Project" group, expand "Master/Guest" and select "Become guest on the project (and check all in)". In this case, the Source Code Manager proposes to check in all the project elements (including the.WDP file).
To switch from the guest mode to the master mode, select "SCM .. Project management .. Become master on the project".To switch from guest mode to master mode: on the "SCM" pane, in the "Project" group, expand "Master/Guest" and select "Become master on the project".
Modifying the options of the project
All the users of the project (master or guests) can modify the project characteristics (first project window, animation, programming charter, ...).
These modifications will have to be checked back in into the Source Code Manager by the project master.
The modifications made by a guest will be lost when the project is updated from the SCM database.

Managing the project in automatic mode

With the automatic mode, the project file is checked out only if the action performed requires it (regardless of the user). Once the action was performed on the project, the project file is automatically checked back in.
The automatic mode avoids you managing the "Master/Guest" mode on the project.
To enable the automatic mode:
  1. Display the project description ("Project .. Project description").Display the project description: on the "Project" pane, in the "Project" group, click "Description".
  2. In the "SCM" tab, check "Check out/Check in the project automatically".
This option can also be enabled via "SCM .. Manage the project .. Manage the project check-out automatically".
Special cases

Modifying the analysis

The analysis is opened in read-only by default. Therefore, it cannot be modified.
To modify the analysis, it must be checked out.
To check out the analysis:
  1. Open the analysis in the data model editor.
  2. Click the "Check out" button in the SCM toolbar.
  3. Validate the analysis check-out. The analysis is opened in modification mode. It can be modified.
The modifications performed on the analysis can affect several elements in the project (pages, windows, controls, ...).
Before generating the analysis, we recommend that you get the latest version of all the project elements. Indeed, the checked-out elements cannot be modified and therefore they cannot be synchronized with the analysis. Therefore, make sure that:
  • all the project elements are checked in,
  • the latest version of the project elements is found on the computer where the analysis is generated.

Changing computer

If you have to change your computer (or the name of your computer), everything must be checked back in via the SCM administrator BEFORE changing computer. To start the SCM administrator, select "SCM .. SCM administrator".To start the SCM administrator, on the "SCM" pane, in the "Database" group, expand "Manage" and select "SCM administrator".See What to do if you change computer for more details.
WINDEVWEBDEV - Server codeWINDEV Mobile

Required configuration of environment

Depending on the environment configuration, the options regarding the SCM may not be accessible.
To use the SCM:
  1. Select "Tools .. Options .. Options of the environment".
  2. In the "Environment" tab, check "Source Code Manager (SCM)".In the "Functions" tab, check "Source Code Manager (SCM)".
  3. Validate.
Minimum required version
  • Version 10
This page is also available for…
Comments
Click [Add] to post a comment