EnableVersionControl Method

Description

Enables project version control and retrieves project properties.

Syntax

Visual Basic
Public Function EnableVersionControl( _ ByVal DomainName As String, _ ByVal ProjectName As String _ ) As String

Parameters

DomainName: The domain name.
ProjectName: The project name.

Return Type

On success, returns an XML string containing the project properties.

Remarks

The source project must be deactivated before this function is called.

Return Value Details

The properties of the XML return string:

PROJECT_ID - The ID number of the project.
PROJECT_NAME - The project name.
DESCRIPTION - The project description.
DOMAIN_ID - The domain ID number.
DOMAIN_NAME - The domain name.
DB_NAME - The database name.
DB_TYPE - The database type number: MS SQL (2), Oracle (3).
CREATE_FROM_PROJECT - The source project of the created project.
CREATE_FROM_DOMAIN - The source domain of the created project.
PHYSICAL_DIRECTORY - The physical directory of the project.
DB_NATIVE_AUTHENTICATION - Indicates if user login is handled by the operating system (MS_SQL Windows Authentication). If 'N', the authentication is handled explicitly using the user name and password.
DB_USER - The database administrator user name.
DB_USER_PASS - The database administrator password.
DBSERVER_NAME - The database server name.
DBCONNSTR_FORMAT - The database connection string.
DB_ENCRYPTED_CONNSTR - For internal use.
DB_DRIVER_CLASS_NAME - The name of the database manager connection class (JDBC driver class).
PR_EXCEPTION_FILE - The pathname of the file that defines errors that the verify process ignores.
PROJECT_VERSION - The ALM version.
PR_IS_ACTIVE - Indicates if the project is active (Y/N).
SAQ_IS_ACTIVE - Indicates if SEND ALL QUALIFIED is active (Y/N).
PR_IS_QPM_AUTO_CALC_ENABLED - Automatic KPI calculation is enabled (Y/N).
PR_HAS_VCSDB - Indicates if the project includes version control: (Y)es, (N)o, (D)isabled. This field appears only if version control is available.
USERS_QUOTA - The maximum number of concurrent connections. -1 indicates an unlimited number of connections.
PR_LANGUAGE - The search language.
PROJECT_TYPE - The type of project.
IS_TEMPLATE - Indicates whether this is a template project (Y/N).
PROJECT_UID - The project ID.
PR_SMART_REPOSITORY_ENABLED - One of: NO - not a smart repository; YES - smart repository; PENDING - offline migration completed and waiting for online migration; MIGRATING - online migration in progress.
PR_SR_GC_STATUS - Optimized repository garbage collection status.
PR_SR_GC_LAST_RUN_TIME - Optimized repository garbage collection last run time.

Example

Example (Visual Basic)

Private Sub EnableVersionControl()

'The following Visual Basic example enables version control.
    Dim sDomainName As String
    Dim sProjectName As String
    Dim sReply As String

    On Error GoTo err
    
    sDomainName = "MyDomain"
    sProjectName = "MyProject"
    sReply = m_SAClient.EnableVersionControl _
        (sDomainName, sProjectName)
    MsgBox sReply
    Exit Sub

err:
    MsgBox "Program failed:" + err.Description
End Sub