Logon

Description

Logs the specified user into the schema repository.

Call this method after creating the AdminSession object but before trying to access any elements in the schema repository. The user login and password must correspond to the HCL Compass administrator or to a user who has access to the schema repository. The administrator can grant access to users by enabling special privileges in their account. Users with the Schema Designer privilege can modify the schemas in a database (using HCL Compass Designer not the API). Users with the User Administrator privilege can create or modify groups and user accounts. Users with the Super User privilege have complete access to the schema repository, just like the administrator.

Syntax

VBScript

adminSession.Logon login_name, password, databaseSetName 

Perl

$adminSession->Logon(login_name, password, databaseSetName); 

Identifier

Description

adminSession

The AdminSession object representing the current schema repository access session.

login_name

A String that specifies the login name of the user.

password

A String that specifies the user's password.

databaseSetName

A String that specifies the name of the schema repository, also referred to as a Database Set, DBset, or Connection, as displayed in the HCL Compass Maintenance Tool.

Note: You can use an empty string ("") if you have only one database set or to refer to the default database set. The default database set name is the one that matches the product version number, 7.0 for example.

Return value

None.

Examples

VBScript

set adminSession = CreateObject("ClearQuest.AdminSession")
adminSession.Logon "admin", "admin", "" 

Perl

use CQPerlExt;

#Create a HCL Compass admin session
$adminSession= CQAdminSession::Build();

#Logon as admin
$adminSession->Logon( "admin", "admin", "" );

#...

CQAdminSession::Unbuild($adminSession);