projectLogon

Sends login information to the SOAP CGI. If valid information is sent, a unique session cookie is returned. A SOAP error envelope is returned if the operation fails.

Each projectLogon operation should be paired with a databaseLogoff operation.

Note:  Areas users can have access to and license types were renamed in Helix ALM 2017.1. To preserve backward compatibility, the SDK uses 'TestTrack Pro' for issue management, 'TestTrack RM' for requirements management, and 'TestTrack TCM' for test case management.

Parameters

Parameter	Type	Description
pProj	CProject	Project name and user security permissions.
username	string	Username used to log in.
password	string	Password used to log in.

Return value

Value	Type	Notes
cookie	long	Value is used in subsequent calls (e.g., getDefect).

Example

long cookie = -1;

string username = "administrator";

string password = "";

 

CProject proj = new CProject();

 

CDatabase db = new CDatabase();

 

db.name = "Sample Project";

 

proj.database = db;

 

CProjectDataOption[] projOp = new CProjectDataOption[3];

 

projOp[0] = new CProjectDataOption();

projOp[0].name = "TestTrack Pro";

projOp[1] = new CProjectDataOption();

projOp[1].name = "TestTrack TCM";

projOp[2] = new CProjectDataOption();

projOp[2].name = "TestTrack RM";

proj.options = projOp;

 

cookie = ttsdk.ProjectLogon(proj, username, password);