stcUser Properties
The stcUser type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
|
AccountSource | |
|
|
CellPhone |
Cellphone number as a part of Contact Information of the user
(Optional) |
|
|
ChatAvailibilityStatus |
Gets Specify chat status for the user
By default when adding a new user it sets it to NULL Based on the following values, chat status for the user can be set. 0: Available 1: Away 2: Do Not Disturb (Optional) |
|
|
ChatFilterSelection |
User Filter Selection for Chat – Used with ServicePRO Application.
By Default when adding a new user 'Select All' is set. Not required to specify while creating user |
|
|
ChatFilterSelectionType |
User Filter Selection type for Chat – Used with ServicePRO Application.
By default when adding a new user 0 is set to this field. Not required to specify while creating user |
|
|
ChatSessionIds |
Chat Sessions the user is currently on – Used with ServicePRO Application.
Not required to specify while creating/updating user
|
|
|
Comments |
Specifies User memo for this user.
By default when adding a new user NULL is set. (Optional) |
|
|
CompanyId |
ID of the external company to which user will be associated if External User. (i.e. if bInternalUser parameter is specified as FALSE) .
Either CompanyId or DepartmentId has to be specified. Not required when creating new User. |
|
|
CompanyName |
Internal use
|
|
|
datLastAlarm |
Internal use
|
|
|
DefaultRequestType |
This is the default request type that is used every time the user creates a request. This is set in user options.
When creating a new user, by default it is set to 0 (Optional) |
|
|
DepartmentId |
Specifies the id of the Organizational Unit to which the user will be associated if Internal User. (i.e. if bInternalUser parameter is specified as TRUE)
Either CompanyId or DepartmentId has to be specified. Not required when creating new User. |
|
|
DepartmentName |
Internal use
|
|
|
DirtyRoles |
Internal use
When new user is created by default it is set to 0. |
|
|
DisplayName |
Specify with the name of the user to be created.
Required- when performing Add/Edit operation on User. |
|
|
EMailable |
Specifies if the user’s settings for Mail is disabled or enabled.
By Default, when adding a new user Emailable is set to 0. 0: Disabled -1: Enabled |
|
|
EmailAddress |
Specify user’s Email address
By default it is set to NULL when new user is created. (Optional) |
|
|
EncryptedName |
Internal use
|
|
|
Extension |
Indicates Extension number of the user as a part of Contact Information
(Optional) |
|
|
Fax |
Indicates Fax number of the user as a part of Contact Information
(Optional) |
|
|
HasRoles |
Specifies whether the user has role assignments
Default value is 0. Internal use |
|
|
Id |
ID of the user to be created.
Not required when creating new User. Required when performing Edit/View/Delete/De-Activate/Re-store user. |
|
|
ImportFileName |
Based on User’s chat status corresponding image are set.
Not to be set by User |
|
|
InActive |
Specifies if the User is de-activated or not
When adding a new User it set to default as 0 0: Active User -1: De-activated User |
|
|
InActiveDate |
Contains DateTime value as of when user was de-activated.
Not Required Null, when standard best solution is active. |
|
|
INetAddress |
Indicates Internet address as a part of Workstation Information
(Optional) |
|
|
Inventory |
Not in use
|
|
|
IsNamed |
Gets or sets a value indicating whether this instance is named.
|
|
|
Location |
Indicates Location of the user as a part of Contact Information
(Optional) |
|
|
Loginable |
Set this option to allow the user to login to ServicePRO (via ServicePRO application or End User Portal).
|
|
|
Name |
Specify with the name of the user to be created.
Required when performing Add/Edit operation on User. |
|
|
NetWorkAddress |
Indicates Network address as a part of Workstation Information
(Optional) |
|
|
ObjectTypeId |
Based on ObjectTypeId , user can be of type Generic or custom
When adding a new user it adds 0 by default which specifics Generic User. (optional) |
|
|
Options |
Specifies user options settings
Not to be set by the User |
|
|
PagerEmailAddress |
Text messaging email address.
(Optional) |
|
|
PagerOption |
Specifies whether text messaging is enabled or not.
When adding a new user it adds 0 by default. |
|
|
Password |
Gets the password for user’s login. By default password for a new user is set to ‘helpstar’ and stored as hash value
(Optional) |
|
|
Picture |
For setting the User’s picture
|
|
|
PostOffice |
(Optional)
|
|
|
PrivateKey |
Used for setting encryption trustee passphrase
Internal use |
|
|
publicKey |
Used for setting encryption trustee passphrase
Internal use |
|
|
SecondaryEmailAddresses |
Allows to specify secondary email addresses for the user if any.
(Optional) |
|
|
SendEmail |
Specifies whether send email is enabled or not.
(Optional) |
|
|
strPassword |
Sets the password for user’s login. By default password for a new user is set to ‘helpstar’
|
|
|
SystemLatestMailCount |
Not in use
|
|
|
Telephone |
Indicates Telephone number of the user as a part of Contact Information
(Optional) |
|
|
Trustee |
Used for setting encryption trustee passphrase
Internal use |
|
|
Workstation |
Indicates the name of the Workstation associated to the user as a part of Workstation Information.
(Optional) |