User (baja-User)

This component represents a station connection, typically a specific type of person who needs to access the system or another system that makes a station-to-station connection (machine-to-machine). Users are children of the station’s UserService container.



To open these properties, expand Config > Services > UserService > User Prototypes and double-click Default Prototype.

In addition to Enabled, these properties configure default users.

PropertyValueDescription
Full NametextProvides additional information.
Expiration, Never Expiresradio button (enabled by default)Indicates that this user is valid without restriction.
Expiration, Expires Ondate and timeLimits the validity of this user.
  • Never Expires permits this user to always log in.

  • Expires On [date and time] allows this user to log in until the expiration date and time.

Lock Outtrue or false (default)Controls this user’s ability to access the system.

true prohibits the user from logging in.

false allows the user to log in without restriction.

Languagetwo lower-case letters
Defines the ISO 639 language code. For a list of codes, see the following: http://www.loc.gov/standards/iso639-2/langcodes.html.
EmailtextProvides an email address for information about this user.
Authenticator, Password and ConfirmtextProvides a password for this user.
Authenticator, Force Reset At Next Logintrue or false (default for a new station)Determines if the station resets the password when a user logs in. The next time the user logs in the system prompts for a password change.

If you find yourself typically changing this each time you create a new User, change it to desired value in the Default Prototype.

Authenticator, Expiresradio button (defaults to enabled)Saves the password for this user indefinitely.

Typically, you leave this at default. However, it is possible you might change this to some far future date in the Default Prototype.

Authenticator, Expires Onradio button (defaults to disabled)Sets a specific date and time after which the user must change their password.
Facets, Time Format Configures the time format.
Facets, Unit Conversion Configures the units to use.
Nav FileORDIdentifies the file that contains the software navigation (customized navigation tree) appropriate for this user.
Prototype Namedrop-down list (defaults to Default Prototype)Identifies the name of the prototype used to synchronize this user with the same user in other stations.

The value of this property applies only when Network User is true.

Network Usertrue or false (default)Configures this user to synchronize with the same user in other stations.

true indicates that this user can be synchronized with other stations.

false configures this user as a local user in this particular station only.

Cell Phone Numbertelephone numberProvides a mobile number for information about this user.
Authentication Scheme Namedrop-down listSelects the authentication scheme for user identity.
RoleslistIdentifies this user’s role(s).
Allow Concurrent Sessionstrue (default) or falseConfigures the station for multiple sessions.

true permits multiple sessions.

false prohibits multiple sessions.

PropertyValueDescription
Auto Logoff Settings, Auto Logoff Enabledtrue (default) or falseControls automatic logoff.

true automatically disconnects a station connection (session) via Workbench or web a browser if a period of inactivity exceeds the amount of time specified for the Default Auto Logoff Period as defined in the UserService)

false does not automatically terminate a user’s session due to inactivity.

Note: Separate auto logoff options exist for Workbench which functions independently of these station settings.
Auto Logoff Settings, Use Default Auto Logoff Periodtrue or false (default)Configures the default setting for automatic logoff.

true configures a specific Default Auto Logoff Period time.

false ignores the specified Default Auto Logoff Period. Instead, you can use the Auto Logoff Period property to set a different auto logoff time period.

Auto Logoff Settings, Auto Logoff Periodread-only and hours minutes (defaults to 15 minutes)Configures the amount of time until an automatic logoff.

When Use Default Auto Logoff Period is set to false, this property specifies a different time period range from 2 minutes to 4 hours. Otherwise, this property is read-only, showing the value specified in the UserService’s Default Auto Logoff Period.

Absolute Logoff Enabledtrue (default) or falseAs of Niagara 4.15, if enabled, it will force an absolute timeout for the user. If the timeout is set for 7 days (default), then after 7 days of login, regardless of activity, the user will be forced to log in again. It can be disabled globally and per user.
Note: This property is not available in stations that run Niagara 4.14 and earlier.
Fault CausetextAs of Niagara 4.15, describes the reason for the user's fault status.
Default Web Profile, Typesub propertiesConfigure how the framework functions in a browser.

The first property, Type, selects the type of browser profile. This property defaults to HTML5 Hx Profile.

Each profile provides a separate set of properties. The sections that follow in this topic document each profile.

Mobile Web Profile, Typesub propertiesConfigure how the framework functions in a cellular device.

Each profile provides a separate set of properties. The sections that follow in this topic document each profile.

Video Alarm Console Optionsadditional propertiesConfigures video alarms.

“Video Alarm Console options (videoDriver-VideoAlarmConsoleOptions)” documents the additional properties.

Alarm Popup Settingsadditional propertiesConfigures popup settings.

“Console Recipient Monitor (videoDriver-ConsolerecipientMonitor)” documents the additional properties.

SAML PrototypescontainerHolds SAML prototypes.

HTML5 HX Profile

These properties configure the HTML5 HX Profile.

PropertyValueDescription
Mobile Nav File (available for Mobile Wed Profiles only)ORDSelects the navigation file for a mobile device.
Hx Themedrop-down list (defaults to Zebra)
Selects the look of the user interface:
  • Zebra

  • Lucid

Enable Hx Workbench Viewstrue (default) or falseConfigures the interface to display all Workbench views.
Enable Nav Tree Side Bartrue (default) or falseConfigures the interface to display the navigation tree (Nav tree).
Enable Search Side Bartrue (default) or falseConfigures the interface to display the Search side bar.
Enable Palette Side Bartrue (default) or falseConfigures the interface to display the Palette side bar.
Enable Nav File Treetrue (default) or falseConfigures the interface to display the nav file tree in general.
Enable Config Treetrue (default) or falseConfigures the interface to display the Config tree.
Enable Files Treetrue (default) or falseConfigures the interface to display the Files tree.
Enable Histories Treetrue (default) or falseConfigures the interface to display the History tree.
Enable Hierarchies Treetrue (default) or falseConfigures the interface to display the Hierarchy tree.
Enable View Selectiontrue (default) or falseConfigures the interface to display the navigation tree (Nav tree).

Basic Hx Profile, Default Hx Profile, Handheld Hx Profile,

PropertyValueDescription
Mobile Nav File (available for Mobile Wed Profiles only)ORDSelects the navigation file for a mobile device.
Hx Themedrop-down list (defaults to Zebra)
Selects the look of the user interface:
  • Zebra

  • Lucid

Default Mobile Web Profile (obsolete)

PropertyValueDescription
Theme, drop-down listdefaults to mobile 
Theme, second drop-down listdefaults to DefaultJQueryMobileTheme 
Show HeaderShow (default) or Hide 
Show Header Back ButtonShow (default) or Hide 
Show Select ViewsShow (default) or Hide 
Show HomeShow (default) or Hide 
Show LogougShow (default) or Hide 

Default Mobile Handheld Hx Profile

PropertyValueDescription
Mobile Nav File (available for Mobile Wed Profiles only)ORDSelects the navigation file for a mobile device.
Hx Themedrop-down list (defaults to Zebra)
Selects the look of the user interface:
  • Zebra

  • Lucid

Basic Wb Web Profile, Default Wb Web Profile, Handheld Wb Web Profile and Simple Admin Wb Web Profile

PropertyValueDescription
Workbench Themedrop-down list (defaults to Zebra)
Selects the look of the user interface:
  • Zebra

  • Lucid

Show Web Start Address Bartrue (default) or false 
Show Web Start Status Bartrue (default) or false