SCM: Checking out an element

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / Developing an application or website / Source Code Manager (SCM)

Overview
Checking out an element
How to check out an element?
Checking out an element
Checking out an element already checked out in exclusive mode

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SCM: Checking out an element

Overview

To edit an element of a project hosted on an SCM repository, you must first check out the element.

Two check-out modes are available:

Automatic extraction (default): Extraction of the element is automatically proposed the first time the element is modified.
Manual check-out: You must request the check-out before editing the element.

To change the check-out mode:

On the "Home" tab, in the "Environment" group, expand "Options" and select "WINDEV/WEBDEV/WINDEV Mobile general options".
Select the "General" tab. The "Check out elements on first modification" option switches all currently open projects to automatic mode.
Validate.

Special case: Before generating the analysisit is advisable to retrieve the latest version of all project elements. Indeed, the checked-out elements cannot be modified and therefore they cannot be synchronized with the analysis. It is therefore necessary that:

all the elements of the project are reintegrated,
the latest version of the project elements is found on the computer where the analysis is generated.

Checking out an element

How to check out an element?

1st solution: automatic extraction:
1. Open the element in the editor.
2. Make the desired changes. When the modification is validated, the SCM automatically extracts the item to be modified. If the check-out is validated, the modification is performed on the checked-out element. If the check-out is refused, the element is not modified.
2nd solution: extraction requested (available with automatic or manual extraction):
- Via the "Project Explorer" pane:
  1. Select the element in the "Project explorer" pane.
  2. Select "Check out" in the context menu of the element.
- Via the ribbon:
  1. Open the element in the editor.
  2. In the "SCM" pane, in the "Current element" group, click on "Extract" ( icon).
3rd solution: manual extraction:
1. Open the element in the editor. An orange panel indicates that the element has not been checked out and that it cannot be modified.
2. In the orange panel, click the check-out icon to modify the element.

Checking out an element

Regardless of the method, the SCM offers the following check-out options:

The check-out mode can be:

Exclusive: This element will not be available until it is checked back in. The element can be checked out for tests only.
For test: The element can be modified, but changes won't be checked in.
Multiple: Other users will also be able to check out the element. In this case, the differences between the element versions can be viewed when the element is checked back in.

When this window is validated, the element is opened in the editor, if necessary, and extracted. The title bar indicates that the element is checked out.

Remarks:

If you try to modify the source code of an element that is not checked out, the Source Code Manager automatically proposes to check out the element.
If you check the "Do not display this message again in this case" box, you can redisplay this window by pressing options of SCM administrator.

Checking out an element already checked out in exclusive mode

If the item you are trying to extract has already been extracted in exclusive mode by a user, the Source Code Manager displays a window indicating that the item has already been extracted in exclusive mode.

You can:

See the characteristics of checked-out element ("Properties").
Send a message to the person who checked out the element ("Send a message" button).
Reminder: WINDEV, WEBDEV and WINDEV Mobile include a messaging tool. This tool uses the parameters specified in the control centers (users, files location, etc.). To open the messaging tool, on the "Tools" tab, in the "Control Centers" group, click "WDBal - Messaging".
Check out the element for test only. In this case, the modifications made to the element will be ignored in the reference project (found on the SCM server).