CUser

Contains information for a specific user. Users are either local (project user) or global (Helix ALM License Server user). CUsers can also be identified as customers.

A local user or customer can be promoted to global using promoteUser or promoteCustomer.

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.

Extends

CItemToTrack

Fields

Field	Type	Description
recordid	long	Unique user record ID.
firstname	string	User’s first name.
middleinitials	string	User’s middle initials.
lastname	string	User’s last name.
usergroupname	string	Deprecated. Use usergroupnamelist instead. If used in get or edit operations and user is in multiple security groups, only one group name is returned. If used in save operations and the user is in multiple groups, the user is removed from all groups except the specified group. If both usergroupname and usergroupnamelist exist, usergroupnamelist is used instead.
usergroupnamelist	string	User's security groups.
company	string	User’s company name.
division	string	User’s division name.
department	string	User’s department name.
emailtype	string	User’s email type. Valid values: Internet or Other. Use getDropdownFieldValuesForTable to retrieve a complete list.
emailaddress	string	User’s email address.
isactive	boolean	Indicates if the user is active in this Helix ALM project.
isactiveSpecified	boolean	Indicates if the isactive field is populated. If this field is not set to true when adding or editing a user, the isactive field is ignored.
iscustomer	boolean	Indicates if the user is a customer.
iscustomerSpecified	boolean	Indicates if the iscustomer field is populated. If this field is not set to true when adding or editing a customer, the iscustomer field is ignored.
isglobal	boolean	Indicates if the user is global. Can only set when adding a user. Ignored if set when editing a user.
isglobalSpecified	boolean	Indicates if the isglobal field is populated. If this field is not set to true when adding or editing a user, the isglobal field is ignored.
isactiveglobal	boolean	Indicates if the global user is active on the license server. This field is only relevant if isglobal is set to true.
isactiveglobalSpecified	boolean	Indicates if the isactiveglobal field is populated. If this field is not set to true when adding or editing a user, the isactiveglobal field is ignored.
userLicense	string	Type of Issue Management license the user has. Valid values: None, TestTrack Pro Floating, TestTrack Pro Named.
userLicenseTCM	string	Type of Test Case Management license the user has. Valid values: None, TestTrack TCM Floating, TestTrack TCM Named.
userLicenseRM	string	Type of Requirements Management license the user has. Valid values: None, TestTrack RM Floating, TestTrack RM Named.
userLicenseRMReviewer	string	Type of Reviewer license the user has. Valid values: None, TestTrack RM Reviewer Floating, TestTrack RM Reviewer Named.
userLicenseSuite	string	Type of Helix ALM suite license the user has. Valid values: None, Suite Floating, Suite Named.
password	string	User’s login password. Returns asterisks.
loginname	string	User’s login username.
phoneone	PhoneNumber	User’s primary phone number.
phonetwo	PhoneNumber	User’s secondary phone number.
notes	string	Contents of the Notes field.
betasite	boolean	Indicates if the user is approved for beta testing. This field is unique to customers.
address	string	User’s address.
testconfig	CSystem	User’s system information.

Returned by

• editCustomer
• editCustomerByRecordID
• editUser
• editUserByRecordID
• getCustomer
• getCustomerByRecordID
• getUser
• getUserByRecordID
• getUserForCurrentSession

Used in

• addCustomer
• addUser
• saveCustomer
• saveUser