Vision - User Management

Description

The user management panel provides a built-in way to edit User Source users and roles from a Vision Client.

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 Config 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.

Warning: 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

Property Type

Scripting

Category

Border

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, Line Border, and Other Border.

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

Editing Schedule Available Color

Changes the color of the available times in the schedule. See Color Selector.

Color

.schedulePreviewAvailableColor

Appearance

Editing Schedule Available Text Color

Changes the text color of events on the schedule preview. See Color Selector.

Color

.eventForeground

Appearance

Enabled

If disabled, a component cannot be used.

boolean

.componentEnabled

Common

Font

Font of the text on this component.

Font

.font

Appearance

Mode

Affects what mode the user management component runs in.

Click to see the mode values

Value	Description	intValue
Manage Users	Allows edits to all Users and Roles in a single source determined by the User Source property. Default	0
Edit Current	Allows edits to the currently logged in user details.	1
Edit Single	Allows edits to a specific user determined by the User Source and Username properties.	2

int

.mode

Behavior

Name

The name of this component.

String

.name

Common

Quality

The data quality code for any Tag bindings on this component.

QualityCode

.quality

Data

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

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

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

Changes the background color of the table headers. See Color Selector.

Color

.tableHeaderBackground

Appearance

Table Header Text Color

Changes the text color of the table headers. See Color Selector.

Color

.tableHeaderTextColor

Appearance

Table Text Color

Changes the text color of the tables. Note: When a row is selected, it will revert to black. See Color Selector.

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

Changes the window background color. See Color Selector.

Color

.windowBackground

Appearance

Window Header Color

Changes the window header background color. See Color Selector.

Color

.windowHeaderBackground

Appearance

Window Header Save Button Background Color

Changes the window header save button background color. See Color Selector.

Color

.windowHeaderSaveButtonBackground

Appearance

Window Header Save Button Text Color

Changes the window header save button text color. See Color Selector.

Color

.windowHeaderSaveButtonForeground

Appearance

Window Header Text Color

Changes the window header text color. See Color Selector.

Color

.windowHeaderForeground

Appearance

Window Text Color

Changes the text color of the window. See Color Selector.

Color

.windowForeground

Appearance

Deprecated Properties

Data Quality

The data quality code for any Tag bindings on this component.

int

.dataQuality

Deprecated

Scripting

Scripting Functions

This component does not have scripting functions associated with it.

Extension Functions

filterUser

Description

Called for each user loaded into the management table. Return false to hide this user from the management table. This code is executed in a background thread.

Parameters

Component self - A reference to the component that is invoking this function.

User Object user - The user object itself. Call user.get('propertyName') to inpsect. Common properties: 'username',' schedule', 'language', user.getRoles() for a list of rolenames.

Return

Boolean

filterRole

Description

Called for each role loaded into the management table. Return false to hide this role from the management table. This code is executed in a background thread.

Parameters

Component self - A reference to the component that is invoking this function.

String role - The role name.

Return

Boolean

filterSchedule

Description

Called for each schedule loaded into the schedule dropdown in the edit user panel. Return false to hide this schedule from the dropdown. This code is executed in a background thread.

Parameters

Component self - A reference to the component that is invoking this function.

String schedule - The schedule name.

Return

Boolean

onCreateUser

Description

Called when the add button is pressed in the users table

Parameters

Component self - A reference to the component that is invoking this function.

Object saveContext - An object that can be used to reject the add by calling saveContext.rejectSave('reason')

Return

Nothing

onDeleteUser

Description

Called when the delete button is pressed in the users table. This code is executed in the background thread and is called once for each user selected.

Parameters

Component self - A reference to the component that is invoking this function.

Object saveContext - An object that can be used to reject the edit by calling saveContext.rejectSave('reason'). If more than one user is rejected, reasons will be concatenated.

Object user - The user that is trying to be deleted. Call user.get('propertyName') to inspect. Common properties: 'username', 'schedule', 'language'. Call user.getRoles() for a list of rolenames.

Return

Nothing

onSaveUser

Description

Called when the save button is pressed when adding or editing a user. This code is executed in a background thread.

Parameters

Component self - A reference to the component that is invoking this function.

Object saveContext - An object that can be used to reject the edit by calling saveContext.rejectSave('reason').

User Object user - The user that is trying to be saved. Call user.get('propertyName') to inspect. Common properties: 'username', 'schedule','language'. Call user.getRoles() for a list of rolenames.

Return

Nothing

onCreateRole

Description

Called when the add button is pressed in the roles table.

Parameters

Component self - A reference to the component that is invoking this function.

Object saveContext - An object that can be used to reject the add by calling saveContext.rejectSave('reason')

Return

Nothing

onDeleteRole

Description

Called when the save button is pressed when adding or editing a role. This code is executed in a background thread.

Parameters

Component self - A reference to the component that is invoking this function.

Object saveContext - An object that can be used to reject the edit by calling saveContext.rejectSave('reason'). If more than one role is rejected, reasons will be concatenated.

String name - The role name that is being deleted.

Return

Nothing

onSaveRole

Description

Called when the save button is pressed when adding or editing a role. This code is executed in a background thread.

Parameters

Component self - A reference to the component that is invoking this function.

Object saveContext - An object that can be used to reject the edit by calling saveContect.rejectSave('reason').

String oldName - The role name before editing. Will be None for a role being added.

String newName - The new name of the edited role.

Return

Nothing

Event Handlers

mouse

mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mouseEntered

This event fires when the mouse enters the space over the source component.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mouseExited

This event fires when the mouse leaves the space over the source component.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mousePressed

This event fires when a mouse button is pressed down on the source component.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mouseMotion

mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

.source	The component that fired this event
.button	The code for the button that caused this event to fire.
.clickCount	The number of mouse clicks associated with this event.
.x	The x-coordinate (with respect to the source component) of this mouse event.
.y	The y-coordinate (with respect to the source component) of this mouse event.
.popupTrigger	Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
.altDown	True (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDown	True (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDown	True (1) if the Shift key was held down during this event, false (0) otherwise.

propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.source	The component that fired this event
.newValue	The new value that this property changed to.
.oldValue	The value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyName	The name of the property that changed. Remember to always filter out these events for the property that you are looking for! Components often have many properties that change.

Customizers

Vision Component Customizers

Examples

There are no examples associated with this component.

OTHER USER MANUAL VERSIONS

GETTING STARTED

MODULES AND PLATFORM

APPENDIX

TUTORIALS & HELPFUL TRICKS

PARTNER LINKS

RESOURCES

Employees