Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If desired, NetX can be configured to allow users to self-register

...

This property controls whether Users can automatically register themselves with the application. If this value is set to "true", then a register option will appear on the login page. Users can click this option and from a self-registration page, they can input their information, including choosing a login and password.

...

This property only has meaning if the user.self_registration property is set to "true". If this property is also set to "true" (the default), then self-registered users are automatically logged-in upon successful registration. If this property is set to "false", then the User's level is automatically set to "No Access". The User is redirected to a page explaining that their registration was successful, but they must wait for approval in order to finally gain access to the system. A notification email is sent to the administrator about this event. And it is up to the administrator to manually change the User's type for the User to finally gain access.

. NetX supports two methods of self-registration: automatic and approved.

Info
iconfalse

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.


Anchor
Automatic
Automatic
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.

Image Added

Note
iconfalse

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

Anchor
Review
Review
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.

Image Added

Note
iconfalse

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.

Image Added

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
String (
User email
)
address
If this value is set to a valid email address, new user registrations will cause an email notification to be sent to this email address. The email for this notification is driven by the "registerAdmin" email template.
The 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_type
IntegerThis property sets the user level that a new registrar is set to automatically. It will accept an integer, see User Level Numeric Equivalents for more info. If this property is not set on the system, new users that are created will be Consumers (level 2).
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
comma separated values

Comma separated list of groups to add users to automatically after registration.

 

Configuration

To enable a new user approval workflow:

  • Set the "user.self_registration" property to "true"
  • Set the "user.self_registration_auto_login" property to "false"

Now, users can see a "Sign up now" link in the lower lefthand corner of the Login page:

Image Removed

With "user.self_registration_auto_login" set to "false", users that fill in the registration form will be presented with this:

Image Removed

This also causes a notification email to be sent to the email address specified in the "user.self_registration_admin_notification_email" property.  An Admin (or Director) can then login to NetX and manually change enable an appropriate access level to new users. 

Notifying the User

For the final stage of this workflow, you will want to automatically notify these users that their access has been approved, and that they can now login. This can be done with an AutoTask. Here's an example:

...

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. 
     
Code Block
<autotask>
	<task id="Notify new users" name="Account Approval Email">
		<matchCriteria type="andor">
			<criteria type="action" value="userLevelChange" ></>criteria>
			<criteria level="1" type="user"></criteria>
			<criteria level="2" />type="user"></criteria>
		</matchCriteria>	<criteria level="3" type="user"></criteria>
		<notifications>
	<criteria level="4" type="user"></criteria>
			<notify <criteria level="7" type="emailuser"></criteria>
			<criteria level="8" type="user"></criteria>
			<criteria level="9" type="user"></criteria>
		</matchCriteria>
		<notifications>
			<notify emailTemplate="notifyNewUserApprovednewUser.tpl" type="email" user="self"></>notify>
		</notifications>
	</task>
</autotask>

In this example, the AutoTask is listening for a "userLevelChange" event AND that the user level was set to "2". Here is a table of user levels and their corresponding user types:

LevelType
0No Access
1Browser
2Consumer
3Importer
4Producer
7Manager
8Director
9Administrator

Next, when that criteria is met, then the AutoTask emails the user with the specified email template. This can be anything, but it must:

The file must end with the ".tpl" extension

The file must live in the emailTemplates folder, here: $INSTALL_DIR/netx/emailTemplates.

Variables within the file are specified with a ${variable} notation.

Available variables include:

...


 

 

Note
iconfalse

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