ALM Site Administratation Client Type Library
RestoreProjectEx Method
DomainName

The domain name.

ProjectName

The project name.

DbType

The type of database. Use the following constants or their values:

  • SA_MSSQL_DB_TYPE (value: 2)
  • SA_ORACLE_DB_TYPE (value: 3)
PhysicalDirectory

The location of the project's repository.

DbName

The database name.

DbServerName

The database server name.

ConnStr

The JDBC connection string, for example:
jdbc:inetdae7://stamina:1433?charset=MS1252

DbUserPass

Database user password.

PrIsActive

Activate the project (Y/N).

PrHasVcsDb

Is the project integrated with a version control system (Y/N).

SaqIsActive

Activate Send All Qualified to send defect emails automatically (Y/N).

UserQuota

The maximum number of concurrent user connections. For no limit, set to -1.

VmRepository

No longer in use. Pass empty string ("").

Description

Description of the project.

ProjectType
Pass the value "STANDARD".
PrIsTemplate

Pass true if this is a template project.

ProjectUID
The project identifier, a GUID.
replaceProject
If replaceProject is true and if there is already a project with this ProjectUID, this action replaces the existing project.

Description

Restores an existing project to a domain with option to replace.

Syntax

Visual Basic
Public Function RestoreProjectEx( _
   ByVal DomainName As String, _
   ByVal ProjectName As String, _
   ByVal DbType As Integer, _
   ByVal PhysicalDirectory As String, _
   ByVal DbName As String, _
   ByVal DbServerName As String, _
   ByVal ConnStr As String, _
   ByVal DbUserPass As String, _
   ByVal PrIsActive As Boolean, _
   ByVal PrHasVcsDb As Boolean, _
   ByVal SaqIsActive As Boolean, _
   ByVal UserQuota As Long, _
   ByVal VmRepository As String, _
   ByVal Description As String, _
   ByVal ProjectType As String, _
   ByVal PrIsTemplate As Boolean, _
   ByVal ProjectUID As String, _
   ByVal replaceProject As Boolean _
) As String

Parameters

DomainName

The domain name.

ProjectName

The project name.

DbType

The type of database. Use the following constants or their values:

  • SA_MSSQL_DB_TYPE (value: 2)
  • SA_ORACLE_DB_TYPE (value: 3)
PhysicalDirectory

The location of the project's repository.

DbName

The database name.

DbServerName

The database server name.

ConnStr

The JDBC connection string, for example:
jdbc:inetdae7://stamina:1433?charset=MS1252

DbUserPass

Database user password.

PrIsActive

Activate the project (Y/N).

PrHasVcsDb

Is the project integrated with a version control system (Y/N).

SaqIsActive

Activate Send All Qualified to send defect emails automatically (Y/N).

UserQuota

The maximum number of concurrent user connections. For no limit, set to -1.

VmRepository

No longer in use. Pass empty string ("").

Description

Description of the project.

ProjectType
Pass the value "STANDARD".
PrIsTemplate

Pass true if this is a template project.

ProjectUID
The project identifier, a GUID.
replaceProject
If replaceProject is true and if there is already a project with this ProjectUID, this action replaces the existing project.

Return Type

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

See Also

Send documentation feedback to HP.