Defining Users (Release 4.0 and Prior)

For SmartServer 4.2 and higher, see Defining Users.

For SmartServer 4.1 (Beta), see Defining Users (Release 4.1).

You can create and manage SmartServer user accounts if you are signed into a SmartServer account with system administrator, owner, or supervisor privileges.  User account management includes assigning roles and capabilities of each user account.  This section consists of the following:

Creating a User

You can create a user account to add a new user for a SmartServer.  To create a new user account, follow these steps:

  1. Open the CMS Users widget.



  2. Click the Action button () and select the Create User action.



    The Create User view appears.

    Click the Expand button (  ) for a better view of this widget. 



  3. Enter the the following for the new user:

    • Login
    • Email
    • First Name
    • Last Name

  4. Select the user type as follows:

    • Admin (can only be created by an admin user type)
    • Owner
    • Supervisor
    • User

    The following table summarizes the capabilities of each user type:

    TasksOwnerSupervisorUser
    (see note)
    Modify CMS license limits with an activation key√

    Manage account information√

    Manage non-admin user accounts√√
    Grant access to a geozone or context√√
    Grant access to individual widgets√√
    Deploy or delete custom apps√

    Add, provision, replace, or delete devices√

    Create and modify schedules√

    Perform actions within a widget if visible√

    User roles are assigned by the system administrator, owner, or supervisor and define what tasks a user can perform in the system.

    A user can have multiple user roles, including: 

    • Field Technician – can add, provision, replace, or delete devices
    • Scheduler â€“ can create and modify schedules
  5. Set the number of days (or none) before the password expires in the Password Expiration (days) field.

  6. Set the Automatic password generation option for the new user.  

    If enabled, the automatic password generation requires the SmartServer IoT to be connected to a network with Internet access. A notification containing the automatically-generated password is sent to the specified email address for the newly created user. 

    If disabled, the following view appears requiring you to specify a password.

    Password requirements

    • The password must be at least 14 characters long and must include each of the following: an uppercase letter, a lowercase letter, a number, and a special character.

    • The New Password and Repeat New Password entries must match. 
    • Enabling the Show Passwords feature () displays the disguised password characters.



  7. Click SAVE to create the new user.

Creating an Admin User

To create an admin user type, follow these steps:

  1. Log into the SmartServer CMS as an admin user.

  2. Open the CMS Users widget.



  3. Click the Action button () and select the Create User action.



    The Create User view appears.

    Click the Expand button (  ) for a better view of this widget. 



  4. Enter the the following for an admin user:

    • Login
    • Email
    • First Name
    • Last Name
    • User type â€“ select Admin.




  5. Supply a Google API Key for maps display.

    The Google API Key is used for access to Google Maps for maps display in the Locations widget (prior to SmartServer 3.4, the Locations widget was called the Map widget). The default admin user will have an embedded key. New admin users should be supplied with a key in order to view maps. The same key that is used for the default admin user can also be used for new admin users.



  6. If OAuth authentication is enabled in the CMS, users can log into its UI using external credentials from the configured external OAuth server. You can enter this information in the OAuth Login field. The OAuth Login information is used to link the SmartServer CMS user to a known external user on a server that provides OAuth authentications (i.e, Google, Facebook, etc.).

  7. Set the Automatic password generation option for the new admin user.  

    If enabled, the automatic password generation requires the SmartServer IoT to be connected to a network with Internet access. A notification containing the automatically-generated password is sent to the specified email address for the newly created user. 

    If disabled, the following view appears requiring you to specify a password.

    Password requirements

    • The password must be at least 14 characters long and must include each of the following: an uppercase letter, a lowercase letter, a number, and a special character.

    • The New Password and Repeat New Password entries must match. 
    • Enabling the Show Passwords feature () displays the disguised password characters.

  8. Click SAVE to create the admin user.

Editing the Apollo User

The Apollo Owner user account is available by default as the primary CMS user for the SmartServer IoT.

To edit the CMS apollo user account, follow these steps:

  1. Open the CMS Users widget.



  2. Click the apollo user account.



    The apollo User view appears.



  3. Edit the the following information for the CMS apollo user as needed:

    • Email â€“ change fake@echelon.com to the new apollo user email
    • First Name
    • Last Name
    • Password Expiration – set the number of days (or none) before the password expires.



  4. Click SAVE to confirm the changes.

For information on managing the apollo user password, see Changing User Passwords in the (Optional) Secure Your SmartServer section.

Assigning User Permissions and Roles 

You can assign user permissions and roles by geozone.  A geozone is a geographic region that you define on a map using the Planning widget.  The SmartServer includes a default World geozone which represents a region for the entire world.  To assign a user to a geozone and set the roles for the user in the geozone, follow these steps:

  1. Open the CMS Geozones widget.



  2. Click the Action button () and select the Assign User to Geozone action.



    The "user" types that exist in your system appear on the window as well as the selections for role assignments.



  3. Select the user for which you wish to assign a role(s).



  4. Select the roles for the user by checking the appropriate option.

    An individual user can have one or more roles with the following capabilities:

    • Field Technician – can add, provision, replace, or delete devices
    • Scheduler â€“ can create and modify schedules



  5. Click APPLY to save the role assignments for the user.

Removing a User

You can remove a user account to disable access to a SmartServer for a user.  To remove a user account, follow these steps:

  1. Open the CMS Users widget.



  2. Click the Action button ()  for the desired user and select the Remove User action.



  3. Click OK to confirm removing the user.

Removing Multiple Users

You can remove multiple user accounts to disable access to a SmartServer for the selected users (you will need to leave at least one user for system access). To remove multiple user accounts, follow these steps:

  1. Open the CMS Users widget.



  2. Select the users to remove.



    Or, if you have many users on the system and want to remove all of them, you can use the Select All button () to select all users.

    Note: If you are deleting all users from the system using the Select All button, then be sure to deselect (at least) the Apollo Owner user in order to leave at least one user for system access.



  3. Click the Action button () and select the Remove Selected Users action.



  4. Click OK to confirm removing the selected user accounts.