User Class Members

The User() method is the constructor for the class. This method is called only after a successful login and must include the user ID as a parameter.

The curEnt property is a read/write property to return/set a reference to the current entity for this user. Setting this property triggers an EntChanged event if the user is the current user.

The EntList property is a read-only property that specifies the list of all entities logged on to by the user.

The EntsStatusInfo property is a read-only property that exposes the entity status information for all entities logged on to by this user.

The LangStrings property is a read-only property that specifies the language strings for the current user.

The Privs property is a read-only property that specifies the current user's privileges.

The UserDisplay property is a read-only property that specifies the current user's display name (taking into account the relevant system attribute).

The UserDisplayWithLabel property is a read-only property that specifies the current user's display name with label (taking into account the relevant system attribute and translating the label appropriately).

The UserID property is a read-only property that specifies the current user’s ID.

The UserName property is a read-only property that exposes the current user’s name.

The AddUserToGroups() method adds the current user to the groups specified in a list. This overload of the method specifies the list of groups as an array.

The ChangePassword() method allows a user change the password of another user. The user ID and password of the user making the change must be passed. Also, for the password change to succeed, the user making the change must have permission to change the other user's password.

The CloneUser() method creates a new user by copying the user information from the user defined by the user object to a new user with a user ID and encrypted password passed in. This includes adding the user to all of the user groups that the current user is in.

The GetEntList() method retrieves a list of entities available for control by this user. The list can be all the entities to which the user has access, all the entities in the user's default list, or all the entities last used by the user.

The IsUserLoggedIntoJob() method determines if the user is logged on to the specified job running on the current entity.

The IsUserLoggedOntoEnt() method determines whether the current user is logged on to the specified entity.

The JobBasedLogin() method opens the form to allow a user to log on to a job by selecting the job rather than the entity on which it is running. A user can only be logged on to that job and not all of the jobs running on the entity.

The LogOffEnt() method logs the operator off the specified entity or all entities on to which the user is currently logged.

The LogoffEntList() method logs the user off the specified list of entities. The user is logged off the entities one at a time. If an error occurs, the user might have logged off some entities but not others.

The LogOffJob() method logs the user off the job running in the specified job position on the specified entity. This method optionally logs the user off the entity as well.

The LogOffJobWithDialog() method logs the user off the specified job running on the current entity. The user is not logged off the entity unless this is the last job running on the entity and the system parameter for automatically logging the user off the entity when logging off the last job is turned on. If the user is the only user logged on to the job, a dialog is opened, asking the user what state the job should be left in.

The LogonEnt() method logs the operator on to a single entity and specifies the current labor code and percent labor to apply to this labor code. The labor code is used to specify to what labor category this job is currently assigned or against what labor category the job is collecting labor.

This overload of the method specifies the entity by its entity ID.

The LogonEntList() method logs the user on to a list of entities. This overload of the method specifies the entity list as a defined list, such as the default list for the user, the list of the last entities used by the user, or the list of all entities accessible by the user or as a DataTable with a row for each entity to log the user.

The LogonEntWithDialog() method opens the Entity Logon dialog box. This overload of the method specifies that the user can use this dialog to log on to and log off of any entity that the user has permission to access.

The LogOnJob() method logs a user on to the specified job on the specified entity. If the user is not already logged on to the entity on which the specified job is to be run, the user is logged on to the entity.

The MayAccessEntity() method returns whether the user has access to the specified entity.

The RefreshCurUserStatusRecordset() method refreshes the status of all the entities on to which the user is logged, using the DataSet returned by the ent.GetStatusInfoByUser() Middleware method.

The SaveEntList() method saves the entities that the user is currently logged on to either the user's Default list or to the user's Last Used list or always logon list.

The ToString() method retrieves the display string for the user. The display string can be a User ID, User Description, User ID/User Description, or the User Description/User ID depending on the system attribute setting.

The UpdateUser() method updates the user as defined by the user object.