User Management
Component Palette Icon:
Description
The user management panel provides a built-in way to edit users and roles from a client. To use this component, you should be aware that it is only editing the users and roles from a single User Source.By default, the component will use the user source of the containing project. You can change this by typing in the name of another user source into the component's "User Source" property.
To make changes to the Gateway's system user source from the Designer or Client, Allow User Admin must be checked in Gateway Settings in the Gateway Configuration page.
This component can be run in one of three modes:
- Manage Users Mode: In this mode, the component manages all of the users contained in the user source. Users and roles may be added, removed, and edited.
- Edit Single Mode: In this mode, the component only edits a single user. Which user is being edited is controlled via the "User Source" and "Username" properties.
- Edit Current Mode: In this mode, the user who is currently logged into the project can edit themselves. Obviously, the ability to assign roles is not available in this mode. This can be useful to allow users to alter their own password, adjust their contact information, and update their schedules.
caution
Be careful to only expose this component to users who should have the privileges to alter other users. Access to this component in "Manage Users" mode will allow users to edit other users' passwords and roles.
Properties
| Name | Description | Type | Scripting | Category |
|---|---|---|---|---|
| Antialias | Draw with antialias on? Makes text smoother. | boolean | .antialias | Appearance |
| Border | The border surrounding this component. Note that the border is unaffected by rotation. | Border | .border | Common |
| Contact Info Editing Enabled | If true, a user's contact info will be editable. | boolean | .allowContactInfoEditing | Behavior |
| Data Quality | The data quality code for any tag bindings on this component. | int | .dataQuality | Data |
| Editing Schedule Available Color | New in 7.9.5 Changes the color of the available times in the schedule. | Color | .schedulePreviewAvailableColor | Appearance |
| Editing Schedule Available Text Color | New in 7.9.5 Changes the text color of events on the schedule preview. | Color | .eventForeground | Appearance |
| Enabled | If disabled, a component cannot be used. | boolean | .componentEnabled | Common |
| Font | New in 7.9.5 Font of the text on this component. | Font | .font | Appearance |
| Mode | Affects what mode the user management component runs in | int | .mode | Behavior |
| Name | The name of this component. | String | .name | Common |
| Role Assigning Enabled | If true, a user's roles will be editable. | boolean | .allowRoleAssigning | Behavior |
| Role Management Enabled | If true, role management is available. | boolean | .allowRoleManagement | Behavior |
| Row Height | New in 7.9.5 Alter the size of the rows in the component's tables. | int | .rowHeight | Appearance |
| Schedule Adjustments Enabled | If true, a user's schedule adjustments will be editable. | boolean | .allowScheduleModifications | Behavior |
| Show Contact Info Column | Controls whether the user table shows the contact info column or not. | boolean | .columnContactInfo | Appearance |
| Show Name Column | Controls whether the user table shows the name column or not. | boolean | .columnName | Appearance |
| Show Roles Column | Controls whether the user table shows the roles column or not. | boolean | .columnRoles | Appearance |
| Show Schedule Column | Controls whether the user table shows the schedule column or not. | boolean | .columnSchedule | Appearance |
| Show Username Column | Controls whether the user table shows the username column or not. | boolean | .columnUsername | Appearance |
| Styles | Contains the component's styles. | Dataset | .styles | Appearance |
| Table Color | New in 7.9.5 Changes the background color of the tables, User Roles and Role Member lists. Note: When a row is selected it will revert to highlighted. | Color | .tableBackground | Appearance |
| Table Header Color | New in 7.9.5 Changes the background color of the table headers. | Color | .tableHeaderBackground | Appearance |
| Table Header Text Color | New in 7.9.5 Changes the text color of the table headers. | Color | .tableHeaderTextColor | Appearance |
| Table Text Color | New in 7.9.5 Changes the text color of the tables. Note: When a row is selected, it will revert to black. | Color | .tableForeground | Appearance |
| Touchscreen Mode | Controls when this input component responds if touchscreen mode is enabled. | int | .touchscreenMode | Behavior |
| User Source | The user source to manage users in. If blank, uses the project's default user source. | String | .userProfile | Behavior |
| Username | The name of the user being edited. Read-only except when mode is "Edit Single", in which case it defines the user to be edited. | String | .username | Behavior |
| Username Editing Enabled | If true, usernames will be editable. | boolean | .allowUsernameEditing | Behavior |
| Visible | If disabled, the component will be hidden. | boolean | .visible | Common |
| Window Color | New in 7.9.5 Changes the window background color. | Color | .windowBackground | Appearance |
| Window Header Color | New in 7.9.5 Changes the window header background color. | Color | .windowHeaderBackground | Appearance |
| Window Header Save Button Background Color | New in 7.9.5 Changes the window header save button background color. | Color | .windowHeaderSaveButtonBackground | Appearance |
| Window Header Save Button Text Color | New in 7.9.5 Changes the window header save button text color. | Color | .windowHeaderSaveButtonForeground | Appearance |
| Window Header Text Color | New in 7.9.5 Changes the window header text color. | Color | .windowHeaderForeground | Appearance |
| Window Text Color | New in 7.9.5 Changes the text color of the window. | Color | .windowForeground | Appearance |
Scripting
See the User Management Scripting Functions page for the full list of scripting functions available for this component.
Event Handlers
Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page.