PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Overview
  • SCM options
  • General options
  • Options regarding the messaging
  • Options regarding the branches
  • Advanced options
  • Managing the SCM
  • Overview
  • Configuring the authentication
  • Changing the administrator password
  • Canceling the check-outs
  • Saving the database
  • Saving and clearing the history
  • Restoring a full backup
  • Restoring a history backup
  • Maintaining the SCM
  • Migrating the database to the most recent format
  • Converting the database into Client/Server
  • Re-index and repair
  • Repairing a directory
  • Performing a search in the SCM
  • Various options
  • My Projects
  • Computer renamed or changed
  • Statistics
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
SCM administrator: available tools
Overview
The SCM administrator (Source Code Manager) allows you to:
These tools can only be used by an administrator.
Note: The SCM administrator can also be used to manage the database elements, ... See Overview of SCM administrator for more details.
SCM options
The SCM options can be configured via "Tools .. Options" in the SCM administrator.To configure the SCM options, on the "Tools" pane, in the "Option" group, click "Options".

General options

The "General" tab of SCM options is used to configure the display of dialog boxes during an actions performed by the SCM. A dialog box can be displayed when:
  • Checking in without modification.
  • Adding files into the database.
  • Updating the dependencies of an element.
  • Requesting a check-out explicitly (via the toolbar for example).
  • Signaling that a project was successfully added.
The image of corresponding dialog box is displayed when the different options are hovered by the mouse cursor.

Options regarding the messaging

The "Messaging" tab of SCM options is used to specify whether the integrated messaging must be used. In this case, messages can be sent to the other users (request to unlock, information about the check-in operations, ...).
If necessary, you can ask to send a message to the users of SCM whenever an element is checked back into the SCM.

Options regarding the branches

The "Branches" tab is used to configure the path created by default when using branches.
This tab allows you to specify the remote and local directories used by default when creating a branch. See Managing branches for more details.

Advanced options

The "Advanced" tab is used to configure the database performances for a HFSQL Client/Server database accessed by ADSL.
In some cases, "Limit the size of packets for ADSL" is used to manage the specific features of some routers.
Caution: If this option is not used properly, it may slow down the SCM.
Note: From version 19, HFSQL is the new name of HyperFileSQL.
Managing the SCM

Overview

The administration tools are available only when connecting to the SCM database as Administrator. To connect to the SCM database as administrator, select "File .. Connect to a SCM database" from the SCM administrator. The administration tools are available only when connecting to the SCM database as Administrator. To connect to the SCM database as administrator, on the "Home" pane, in the "SCM database", click "Connection".
In the window that is opened:
  • Specify the characteristics of SCM database used.
  • Specify the name and password of database administrator:
    • If you are using a SCM database in HFSQL Classic format, the administrator corresponds to "Admin" by default (without password).
    • If you are using a SCM database in HFSQL Client/Server format, the administrator corresponds to the "Administrator" user by default.
Note: Establishing a connection to the SCM database as administrator differs from "Become master on the project". To perform the management operations, you must be connected as administrator.
Note: From version 19, HFSQL is the new name of HyperFileSQL.

Configuring the authentication

Configuring the authentication allows you to use the database of Control Centers to authenticate the SCM users. The login and password are the ones specified in the Project Monitoring Center.
This option is available only if you are working with a SCM database in HFSQL Classic format.
To enable the authentication:
  1. Select "Tools .. Administration .. Configure authentication".On the "Management" pane, in the "Security" group, click "Configure the authentication".
  2. Check "Enable the authentication".
  3. Specify the database of Control Centers used (in HFSQL Classic format).
  4. Validate.

Changing the administrator password

The option "Tools .. Management .. Change the administrator password" allows you to modify the password used by the administrator.

Canceling the check-outs

The option "Tools .. Management .. Undo checkouts" allows the administrator to cancel all the current check-outs on the selected project.The administrator has the ability to cancel all the check-outs currently performed on the selected project: on the "Management" pane, in the "Check-outs" group, click "Undo some check-outs"
A window lists all the checked-out elements. You can also list the elements checked out for tests or the elements checked out in a different remote directory.
All you have to do is select the requested elements and click the "Undo the check-out" button. The check-out is canceled. The element is found in the SCM database in its status before the check-out.
You have the ability to inform the users ("Send a message to the ones whose check-out was canceled").

Saving the database

The option "Tools .. Management .. Full database backup" allows the administrator to perform a backup of SCM database. This backup is performed in a file in .ZIP format.
Note: During the backup, the SCM database can be accessed in read-only.
The administrator has the ability to perform a backup of the SCM database: on the "Management" pane, in the "Backups" group, click "Full backup". This backup is performed in a file in .ZIP format.
Note: During the backup, the SCM database can be accessed in read-only.
The backup of the database can also be performed in a command line via the following notation:
WDGDSAdmin.exe /SAVE
/BASE=<Database Address>
/LOGIN=<Login>
/PASS=<Password>
/ZIP=<Full Name of Zip File>
In this code, <Database Address> has the following format:
  • For HFSQL Client/Server: "CS:\\<IP address of server>:<Server port>\<Name of SCM database>"
  • For HFSQL Classic: the local path of the database must be specified. For example: "D:\PC SOFT\Local SCM database\"
Example:
ExeRun("""C:\WinDev\Programs\WDSCMAdmin.exe"" /SAVE /BASE=CS:\\DOC2:4900\GDS " + ...
" /LOGIN=admin /PASS=admin /ZIP=C:\Temp\test.zip")

Saving and clearing the history

The option "Tools .. Management .. Save and clear the history" allows the administrator to delete part of the history from the SCM database. The deleted part is automatically saved in a file in .ZIP format. This backup can be restored thereafter.The administrator has the ability to delete part of the history for the SCM database: on the "Management" pane, in the "Backups" group, click "Clear the history with backup". The deleted part is automatically saved in a file in .ZIP format. This backup can be restored thereafter.
To save and clear the history, specify the date from which the history must be stored.

Restoring a full backup

To restore a full backup that was previously performed on the database, select "Tools .. Management .. Restore a full backup".To restore a full backup that was previously performed on the database, on the "Management" pane, in the "Backups" group, click "Full restore".

Restoring a history backup

To restore a history backup that was previously performed on the database, select "Tools .. Management .. Restore a history backup".To restore a history backup that was previously performed on the database, on the "Management" pane, in the "Backups" group, click "Restore history".
Maintaining the SCM
The SCM administrator proposes several maintenance options. These options allow you to optimize and manage the SCM database at any time.

Migrating the database to the most recent format

To migrate the SCM database into a more recent format, select "Tools .. Maintenance .. Migrate the database to the most recent format". This format optimizes the accesses to the database.To migrate the SCM database into a more recent format, on the "Tools" pane, in the "Maintenance" group, click "Migrate to the most recent format". This format optimizes the accesses to the database.
Note: To use this option, the SCM database must not be directly installed on a share name.
For example, if the files are installed on "\\Server\SCM" where "SCM" is the name of the shared directory, the option will not operate. The files must be installed in a directory such as "\\Server\SCM\SCMDatabase"
If this is not the case, the data files can be moved manually (all users must be disconnected). During the next opening of projects, you will have to specify the new directory of the SCM database.
Caution: Don't hesitate to check the Evolutions regarding the format of SCM files page.

Converting the database into Client/Server

To start the wizard used to switch the database to HFSQL Client/Server mode, select "Tools .. Maintenance .. Convert the database to Client/Server".To start the wizard used to switch the database to HFSQL Client/Server mode, on the "Tools" pane, in the "Maintenance" group, click "Switch to Client/Server".
This operation can be performed only if a HFSQL Client/Server engine is installed on the server where the SCM database must be installed.
You must specify:
  • The server name.
  • The database name and port.
  • The name and password of an administrator of HFSQL database.
Depending on the size of SCM database, migrating the database may take quite a long time.
At the end of this operation, the SCM proposes to automatically create the user account corresponding to the connected user (if this account does not exist).
The next time the project is opened, you will have to specify the new parameters for connecting to SCM.
Note: The SCM database in "Classic" mode is not deleted. Once the migration to the HFSQL Client/Server format is over, you must inform all the users in order for them to change their parameters for connecting to the SCM database.
Note: From version 19, HFSQL is the new name of HyperFileSQL.

Re-index and repair

The option "Tools .. Maintenance .. Reindex and repair" is used to:
  • Reindex the SCM database (whether it is in HFSQL Classic mode or in HFSQL Client/Server mode).
  • Cancel the locked transactions on the SCM database.
  • Analyze and repair the SCM database.
On the "Tools" pane, in the "Maintenance" group, click "Reindex and repair". This option is used to:
  • Reindex the SCM database (whether it is in HFSQL Classic mode or in HFSQL Client/Server mode).
  • Cancel the locked transactions on the SCM database.
  • Analyze and repair the SCM database.
Note: From version 19, HFSQL is the new name of HyperFileSQL.
Versions 22 and later

Repairing a directory

In some case, repairing a directory is used to fix some problems regarding the access to the data found in an SCM directory. This option is used to repair the directory without locking the SCM database during the repair.
To repair a directory:
  • Select the directory to repair in the list of directories of the SCM database.
  • On the "Tools" pane, in the "Maintenance" group, click "Repair a directory". This option is used to repair the SCM database for this directory.
Note: If necessary, the SCM automatically propose to repair the directory only (instead of repairing the entire SCM database).
New in version 22

Repairing a directory

In some case, repairing a directory is used to fix some problems regarding the access to the data found in an SCM directory. This option is used to repair the directory without locking the SCM database during the repair.
To repair a directory:
  • Select the directory to repair in the list of directories of the SCM database.
  • On the "Tools" pane, in the "Maintenance" group, click "Repair a directory". This option is used to repair the SCM database for this directory.
Note: If necessary, the SCM automatically propose to repair the directory only (instead of repairing the entire SCM database).

Repairing a directory

In some case, repairing a directory is used to fix some problems regarding the access to the data found in an SCM directory. This option is used to repair the directory without locking the SCM database during the repair.
To repair a directory:
  • Select the directory to repair in the list of directories of the SCM database.
  • On the "Tools" pane, in the "Maintenance" group, click "Repair a directory". This option is used to repair the SCM database for this directory.
Note: If necessary, the SCM automatically propose to repair the directory only (instead of repairing the entire SCM database).
Performing a search in the SCM
Several search modes are available in the SCM database:
  • Select "Tools .. Search by name" (Ctrl + E) to easily find an element in the SCM database. All you have to do is specify the name of sought element.Search by name (on the "Tools" pane, in the "Search" group, click "By name"): This option is used to easily find an element in the SCM database. All you have to do is specify the name of sought element.
  • Select "Tools .. Search by check-out" to find the check-outs according to the user (current user, specific user, all the users) and to the type of check-out (for test, exclusive, ...). You have the ability to check in an element or to cancel a check-out.Search by check-out (on the "Tools" pane, in the "Search" group, click "By check-out"): This option is used to find the check-outs according to the user (current user, specific user, all the users) and to the type of check-out (for test, exclusive, ...). You have the ability to check in an element or to cancel a check-out.
  • Select "Tools .. Search by task or incident" to find the elements corresponding to the execution of a task or incident. You have the ability to see the modifications performed.Search by task or incident: This option is used to find the elements corresponding to the execution of a task or incident. You have the ability to see the modifications performed.
  • Versions 23 and later
    Search in the history: This option is used to perform a search in the history of actions performed in SCM. This allows you to get all comments typed between two dates and to export them into a file. See Search in SCM history for more details.
    New in version 23
    Search in the history: This option is used to perform a search in the history of actions performed in SCM. This allows you to get all comments typed between two dates and to export them into a file. See Search in SCM history for more details.
    Search in the history: This option is used to perform a search in the history of actions performed in SCM. This allows you to get all comments typed between two dates and to export them into a file. See Search in SCM history for more details.
Various options

My Projects

The option "Tools .. My Projects..." is used to list the projects with a local directory on the current computer ("Find" button). The remote directory and the local directory are displayed for each project found. To list the projects with a local directory on the current computer:
  1. On the "Tools" pane, in the "Search" group, click "My projects".
  2. In the window that is displayed, specify the requested login if necessary and click the "Find" button.
  3. The remote directory and the local directory are displayed for each project found.
You have the ability to delete the association between the remote directory and the local directory ("Delete the association" button). This option is useful when a project of SCM was opened then deleted from the local computer: by deleting the association, the user will no longer receive the automatic messages of SCM regarding this project.

Computer renamed or changed

The option "Tools .. Rename or change computer" is used to update the name of the computer used in the SCM. See Renaming or changing computer for more details.

Statistics

The option "Tools .. Statistics" is used to get statistical calculations about the SCM database.
Minimum required version
  • Version 12
This page is also available for…
Comments
Click [Add] to post a comment