Skip to end of metadata
Go to start of metadata
General

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. 

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

This feature is new in Ignition version 7.9.5
Click here to check out the other new features

Some of these properties are new!

NameDescriptionProperty TypeScriptingCategory
AntialiasDraw with antialias on? Makes text smoother.boolean.antialiasAppearance
BorderThe border surrounding this component. NOTE that the border is unaffected by rotation.Border.borderCommon
Contact Info Editing EnabledIf true, a user's contact info will be editable.boolean.allowContactInfoEditingBehavior
Data QualityThe data quality code for any tag bindings on this component.int.dataQualityData
Editing Schedule Available ColorChanges the color of the available times in the schedule. New in 7.9.5.Color.schedulePreviewAvailableColorAppearance
Editing Schedule Available Text ColorChanges the text color of events on the schedule preview. New in 7.9.5.Color.eventForegroundAppearance
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
FontFont of the text on this component. New in 7.9.5.Font.fontAppearance
ModeAffects what mode the user management component runs inint.modeBehavior
NameThe name of this component.String.nameCommon
Role Assigning EnabledIf true, a user's roles will be editable.boolean.allowRoleAssigningBehavior
Role Management EnabledIf true, role management is available.boolean.allowRoleManagementBehavior
Row HeightAlter the size of the rows in the component's tables. New in 7.9.5.int.rowHeightAppearance
Schedule Adjustments EnabledIf true, a user's schedule adjustments will be editable.boolean.allowScheduleModificationsBehavior
Show Contact Info ColumnControls whether the user table shows the contact info column or not.boolean.columnContactInfoAppearance
Show Name ColumnControls whether the user table shows the name column or not.boolean.columnNameAppearance
Show Roles ColumnControls whether the user table shows the roles column or not.boolean.columnRolesAppearance
Show Schedule ColumnControls whether the user table shows the schedule column or not.boolean.columnScheduleAppearance
Show Username ColumnControls whether the user table shows the username column or not.boolean.columnUsernameAppearance
StylesContains the component's styles.Dataset.stylesAppearance
Table ColorChanges the background color of the tables, User Roles and Role Member lists. NOTE: When a row is selected it will revert to highlighted. New in 7.9.5.Color.tableBackgroundAppearance
Table Header ColorChanges the background color of the table headers. New in 7.9.5.Color.tableHeaderBackgroundAppearance
Table Header Text ColorChanges the text color of the table headers. New in 7.9.5.Color.tableHeaderTextColorAppearance
Table Text ColorChanges the text color of the tables. NOTE: When a row is selected, it will revert to black. New in 7.9.5.Color.tableForegroundAppearance
Touchscreen ModeControls when this input component responds if touchscreen mode is enabled.int.touchscreenModeBehavior
User SourceThe user source to manage users in. If blank, uses the project's default user source.String.userProfileBehavior
UsernameThe 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.usernameBehavior
Username Editing EnabledIf true, usernames will be editable.boolean.allowUsernameEditingBehavior
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Window ColorChanges the window background color. New in 7.9.5.Color.windowBackgroundAppearance
Window Header ColorChanges the window header background color. New in 7.9.5.Color.windowHeaderBackgroundAppearance
Window Header Save Button Background ColorChanges the window header save button background color. New in 7.9.5.Color.windowHeaderSaveButtonBackgroundAppearance
Window Header Save Button Text ColorChanges the window header save button text color. New in 7.9.5Color.windowHeaderSaveButtonForegroundAppearance
Window Header Text ColorChanges the window header text color. New in 7.9.5.Color.windowHeaderForegroundAppearance
Window Text ColorChanges the text color of the window. New in 7.9.5.Color.windowForegroundAppearance
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

  • Scope

Client

 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

  • Scope

Client

 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

  • Scope

Client

 onCreateUser


This feature is new in Ignition version 7.9.4
Click here to check out the other new features

  • 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

  • Scope

Client

 onDeleteUser


This feature is new in Ignition version 7.9.1
Click here to check out the other new features

  • 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

  • Scope

Client

 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

  • Scope

Client

 onCreateRole


This feature is new in Ignition version 7.9.4
Click here to check out the other new features

  • 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

  • Scope

Client

 onDeleteRole


This feature is new in Ignition version 7.9.4
Click here to check out the other new features

  • 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

  • Scope

Client

 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

  • Scope

Client

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.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (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.

.sourceThe component that fired this event
.buttonThe code for the button that caused this event to fire.
.clickCountThe number of mouse clicks associated with this event.
.xThe x-coordinate (with respect to the source component) of this mouse event.
.yThe y-coordinate (with respect to the source component) of this mouse event.
.popupTriggerReturns 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.
.altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
.controlDownTrue (1) if the Control key was held down during this event, false (0) otherwise.
.shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 propertyChange
 propertyChange

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

.sourceThe component that fired this event
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyNameThe name of the property that changed. NOTE: remember to always filter out these events for the property that you are looking for! Components often have many properties that change.
Examples

There are no examples associated with this component.

  • No labels