Page tree
Skip to end of metadata
Go to start of metadata

If desired, NetX can be configured to allow users to self-register. NetX supports two methods of self-registration: automatic and approved.

This article covers user self-registration in the NetX user account system. If your site is using an alternate authentication method, such as SAML or LDAP, this process will not create a new user account in those systems.

Automatic access

Granting users automatic access to the application means that users who self-register will be able to log in to the site immediately, without being approved by an administrator or director. New users are created with a preset user level and inherit any existing permissions that impact all users

Registering a new account

  1. Navigate to NetX's login screen.
  2. Click Create new account
  3. Fill the form with identifying information such as your name and email address.  
  4. Enter a new username and password. These will be your credentials to log in to the application in the future.
  5. Click Create account. You will automatically navigate to the NetX dashboard. If you're new to NetX, see Getting Started for help on what to do now that you've logged in.

By default, NetX passwords must consist of at least 8 characters. However, your administrator may have customized more strict password parameters.

Approved access

Registering a new account

  1. Navigate to NetX's login screen.
  2. Click Create new account
  3. Fill the form with identifying information such as your name and email address.  
  4. Enter a new username and password. These will be your credentials to log in to the application in the future. 
  5. Click Create account. A notification will display indicating that administrator approval is required.
  6. A notification email will be sent to the designated approver, who will notify you when your account has been activated.
  7. Once your account is activated, navigate to the NetX login screen and use the credentials created with your user account to access the application. If you're new to NetX, see Getting Started for help on what to do now that you've logged in.

By default, NetX passwords must consist of at least 8 characters. However, your administrator may have customized more strict password parameters.

Approving a self-registered account

  1. Once a new account is registered, use the Login button in the notification email; this will take you to the NetX login window.
  2. Log in with your administrator or director-level account.
  3. Navigate to the Users tab of the Systems area.
  4. Adjust the new user's user level from no access. This will grant that user access to the application with all of the privileges and limitations of their assigned user level. For more information on user management, see managing users
  5. Notify the new user of their new access status. Their contact email address will be listed along with their user in the Users tab.

Basic configuration

PropertyValuesDescriptionRequires restart?
user.self_registration
True / FalseIf the value of this property is true, self-registration is enabled. If the value of this property is false, users will not be able to create their own account. No
user.self_registration_auto_login
True / False

If the value of this property is true, users will be able to create their own account and immediately log in to the application without approval by an administrator. If the value of this property is false, administrators will need to approve each self-registered account. 

No
user.self_registration_admin_notification_email
User email addressThe value of this property should correspond to the email address of an administrator or director-level user. This user will receive all new account registration notifications, though any administrator or director-level user can adjust an account's user level. Note: director-level users cannot promote new users to an administrator user level.No

Advanced settings

PropertyValuesDescriptionRequires restart?
user.self_registration_notification
True / False

If this property is true, users who self-register will receive a confirmation email. If automatic login is enabled, the email will say Account has been created. If administrator review is required, the email will say Your account is pending approval.

No
user.self_registration_notification_include_no_access
True / False

If this property is true all newly self-registered users will receive the same email welcoming their new user to NetX – even if their account is still waiting on administrative review. If this property is false, self-registered users who require administrative review before accessing the application will receive an email notifying them that their account is still pending.

No
user.self_registration_type
NumberThe value of this property should correspond to the numeric equivalent of a user level. If automatic self-registration is enabled, all users created via self-registration will have access to NetX with all the privileges and restrictions of their assigned user level. If this property is not set, the default user level will be consumer (2).No
user.self_registration_add_to_groups
Group name(s)The value of this property should be existing NetX group names. Any self-registered user will automatically be added to the group(s) named in this property, and they will receive any permissions already applied to those groups. To add multiple groups as a value, separate each group name with a comma and no spaces between these comma separators.No

User notification

If self-registered users require approval, the following AutoTask example will automatically alert new users once their account has been upgraded from the default No access user level:

  • matchCriteria: If the matchCriteria type is or, an email will be sent to the affected user when any user's level is changed. If the matchCriteria type is and, an email will only be sent if all criteria are met, e.g. a userLevelChange for a specific user level such as a consumer (2).
  • criteria: The criteria that triggers the AutoTask. This criteria may be built upon; in this example, the first criterion userLevelChange indicates that the first trigger is a change to a user's user level. The following criteria specify the notification will only be sent if a user's type (level) is changed to the specified numerical user level equivalent; here the task is triggered if a user's level is changed to any user level.
  • emailTemplate: Specifies the email template that will be sent when the notification is triggered. In this case, the email will indicate to the new user that their account has been approved. 
     
<autotask>
	<task id="Notify new users" name="Account Approval Email">
		<matchCriteria type="or">
			<criteria type="action" value="userLevelChange"></criteria>
			<criteria level="1" type="user"></criteria>
			<criteria level="2" type="user"></criteria>
			<criteria level="3" type="user"></criteria>
			<criteria level="4" type="user"></criteria>
			<criteria level="7" type="user"></criteria>
			<criteria level="8" type="user"></criteria>
			<criteria level="9" type="user"></criteria>
		</matchCriteria>
		<notifications>
			<notify emailTemplate="newUser.tpl" type="email" user="self"></notify>
		</notifications>
	</task>
</autotask>

With this AutoTask, any user level change will trigger this notification email, even if the affected user is not new to the site. 




  • No labels

3 Comments

  1. If "user.self_registration_auto_login" is set to false, or

    if "user.self_registration_type" is set to 0 (No Access),

    then "user.self_registration_notification_include_no_access" property must be set to true in order for the new user email to be sent to the user

    1. Sian, that is not quite correct. `user.self_registration_auto_login` bears no relation to whether or not an email is sent when someone self-registers.

      No email will be sent to the registrant unless `user.self_registration_notification` is set to `true`.


      If that property is `true`, THEN the `user.self_registration_type` and `user.self_registration_notification_include_no_access` come into play. Here's what they do:

      1. if `user.self_registration_auto_login` is `false` and `user.self_registration_notification_include_no_access` is `false` (the default), the new user will receive an email saying "Once your request is approved, you will be able to access NetX."
      2. if auto-login is not disabled, or `user.self_registration_notification_include_no_access` is true, the user will get an email saying "Your account (${register.userLogin}) has been created. To access the site, please use the credentials you specified during registration."


      To put it another way... if you want self-registered users to get an email, you need to set `user.self_registration_notification` to `true`.

      And if, for some strange reason, you want new users who don't yet have access yet to get the same email as users who do, then set `user.self_registration_notification_include_no_access` to `true`.

      The only scenario I can see for that is if there's some autotask-based way of granting the user access, but autotask event isn't fired unless `user.self_registration_auto_login` is `true`. Mystifying...


      Here are the defaults, for the record:

      `user.self_registration_notification`: `false` (i.e. no email is sent to new users, ever)
      `user.self_registration_auto_login`: `true`
      `user.self_registration_notification_include_no_access`: `false`

      The relevant code hasn't changed since the date of your comment, although it's very possible that the NetX version containing this logic was released later. But what I said above should be true for 8.11 and 8.12.


  2. Further clarification on the self-registration workflow and which email is sent to the user:

    Scenario 1: If you want new users to self-register, gain access immediately and receive the default email (registerUser.tpl) that says: "Your account (${register.userLogin}) has been created. To access the site, please use the credentials you specified during registration.", then set these properties:

    • user.self_registration = true
    • user.self_registration_auto_login = true
    • user.self_registration_notification = true

    Scenario 2: If you want new users to self-register but not gain access to the site, and receive the default email (newUserNeedsApproval.tpl) that says "Once your request is approved, you will be able to access NetX.", then set these properties:

    • user.self_registration = true
    • user.self_registration_auto_login = false
    • user.self_registration_notification = true

    Note that 'user.self_registration_notification_include_no_access' is not really useful. As Eric has explained above, you would only use this if you want no access users to receive the regular new account notification that says "Your account has been created", which you probably don't want.