IUser¶
- class IUser¶
Bases:
ImpactCOMWrapperBase- Description:
Represents a user in a database.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property addresses¶
Gets Addresses.
- Description:
Returns the IAddresses associated with the user.
- Remarks:
Introduced in Impact 8.0.0.75.
- Returns:
The value of Addresses.
- Return type:
- property administrator¶
Gets Administrator.
- Description:
Determines if the user is an administrator or not.
- Returns:
The value of Administrator.
- Return type:
administrator (bool)
- property connected¶
Gets Connected.
- Description:
Determines if the user is connected to a primary database or not.
- Remarks:
This property will return true if the user is connected from either Impact or from nServer.
- Returns:
The value of Connected.
- Return type:
connected (bool)
- property connected_from¶
Gets connected_from.
- Description:
The name of the workstation the user has connected from.
- Remarks:
If the user is not currently connected to a database from Impact this method fails.
- Returns:
The value of connected_from.
- Return type:
connected_from (str)
- property connection_date_time¶
Gets connection_date_time.
- Description:
The date and time the user last connected.
- Remarks:
If the user is not currently connected to a database from Impact this method fails.
- Returns:
The value of connection_date_time.
- Return type:
connection_date_time (datetime)
- property disabled¶
Gets Disabled.
- Description:
Indicates if logins are currently disabled for the user.
- Returns:
The value of Disabled.
- Return type:
disabled (bool)
- property documents¶
Gets Documents.
- Description:
An IDocuments collection representing all the documents associated with this item.
- Returns:
The value of Documents.
- Return type:
- property email¶
Gets Email.
- Description:
The users email address
- Returns:
The value of Email.
- Return type:
email (str)
- property formatted_name¶
Gets formatted_name.
- Description:
The formatted name of the user.
- Remarks:
Returns the formatted name of user which may include the login_id, full_name and other user properties as configured. Introduced in Impact 8.0.0.75.
- Returns:
The value of formatted_name.
- Return type:
formatted_name (str)
- property full_name¶
Gets full_name.
- Description:
The full name of the user.
- Returns:
The value of full_name.
- Return type:
full_name (str)
- property guid¶
Gets GUID.
- Description:
The GUID of the user.
- Remarks:
Introduced in Impact 8.0.0.75.
- Returns:
The value of GUID.
- Return type:
guid (str)
- property impact_connected¶
Gets impact_connected.
- Description:
Determines if the user is connected to a primary database from Impact or not.
- Returns:
The value of impact_connected.
- Return type:
impact_connected (bool)
- property key¶
Gets Key.
- Description:
The key of the user.
- Returns:
The value of Key.
- Return type:
key (int)
- property ldap_enabled¶
Gets ldap_enabled.
- Description:
Determines if the user is configured for LDAP authentication.
- Remarks:
Introduced in Impact 8.0.0.75.
- Returns:
The value of ldap_enabled.
- Return type:
ldap_enabled (bool)
- property ldap_security_groups¶
Gets ldap_security_groups.
- Description:
Determines the LDAP security group that the LDAP user is a member of.
- Remarks:
If the user is not configured as an ldap_enabled user then this function will fail Introduced in Impact 8.0.0.75.
- Returns:
The value of ldap_security_groups.
- Return type:
ldap_security_groups (str)
- property ldap_user_account_status¶
Gets ldap_user_account_status.
- Description:
Determines the domain account status for the LDAP user.
- Remarks:
If the user is not configured as an ldap_enabled user then this function will fail. The domain account status currently only returns valid information when LDAP is configured to a Windows Active Directory service. If no domain account status is available this property returns nothing. Introduced in Impact 8.0.0.94.
- Returns:
The value of ldap_user_account_status.
- Return type:
- property login_id¶
Gets login_id.
- Description:
The login ID of the user.
- Returns:
The value of login_id.
- Return type:
login_id (str)
- property manager¶
Gets Manager.
- Description:
Returns the manager IUser associated with the user.
- Remarks:
If the user does not have an associated manager then NULL will be returned. Introduced in Impact 8.0.0.75.
- property n_server_connected¶
Gets n_server_connected.
- Description:
Determines whether the user is connected to a primary database from the nServer application
- Returns:
The value of n_server_connected.
- Return type:
n_server_connected (bool)
- property site¶
Gets Site.
- Description:
Returns the ISite associated with the user.
- Remarks:
If IDatabase.settings.db_sites is false, or the user is not associated with a site, then NULL will be returned.
- property user_group¶
Gets user_group.
- Description:
The group the user belongs to.
- Returns:
The value of user_group.
- Return type:
user_group (str)
- property user_type¶
Gets user_type.
- Description:
Gets or sets the ipUserType of the user.
- Remarks:
Introduced in Impact 8.0.0.75.
- Returns:
The value of user_type.
- Return type:
- property values¶
Gets Values.
- Description:
An IDatabaseValues object that can be used to read/write the users associated database values.
- Remarks:
The Values object can be used to directly read/write database values, extreme care should be taken when using this object.
- Returns:
The value of Values.
- Return type:
- property working_documents¶
Gets working_documents.
- Description:
An IDocuments collection representing all the checked out documents in this database.
- Remarks:
The IDocuments collection contains checked out documents for this specific user in the database. The IDatabase.working_documents property can be used to access checked out documents for all users in the database. Introduced in Impact 9.0.0.83.
- Returns:
The value of working_documents.
- Return type:
- Examples:
- force_disconnect()¶
- Description:
Forces the user to be disconnected from the database.
- Remarks:
Introduced in Impact 6.4.0.7 and 7.0.0.47.
- get_format_for_table(table_name)¶
- Description:
Retrieves a string representing the format used for display text of certain tables.
- Remarks:
Currently formatted strings are supported only for the “CUSTOMER” and “ADDRESS” tables. For CUSTOMER, the result can be one of the following strings:”Name”, “name_tc”, “Name+Code”, “name_tc+Code”, “Code”, “Code+Name”, “Code+name_tc” For ADDRESS, the result can be “Desc” representing the description. Additionally, if the Advanced Format is selected, the string represents the key of the Formatted Strings MTS. The Tc part means “title case” which is equivalent to “Pretty-print” and only applies to name parts. There is no title case variant for addreses. The format is user-specific because it is configured in the database settings associated with the user group, and the user can also override it. Introduced in Impact 11.0.0.40
- Returns:
A string representing the various fixed-formats available in Impact database options, or a key value.
- Parameters:
table_name (str) – The table for which the formatted settings have been defined.
- get_working_projects()¶
- Description:
Gets a list of IDatabaseItem objects representing the projects this user is currently working on.
- Examples:
- ldap_attribute(name)¶
- Description:
Retrieves an LDAP user attribute directly from the LDAP server.
- Remarks:
If the user is not configured as an ldap_enabled user then this function will fail. To determine the LDAP security groups for an LDAP user is a member of use the ldap_security_groups property. Introduced in Impact 8.0.0.75.
- Parameters:
name (str) – The LDAP user attribute name.
- ldap_update()¶
- Description:
Updates the LDAP user attributes for an LDAP enabled user.
- Remarks:
If the user is not configured as an ldap_enabled user then this function will fail. When updating the user attributes of multiple LDAP users it is recommended that you use the IDatabase.connect_to_ldap_service and IDatabase.disconnect_from_ldap_service to imrpove performance. Introduced in Impact 8.0.0.75.
- refresh()¶
- Description:
Refresh the user information from the database.
- send_message(text)¶
- Description:
Sends a message to the user.
- Parameters:
text (str) – Specifies the text of the message.
- Examples: