Web Part: Create Jazz User

Modified on 2014/09/29 23:57 by Charles — Categorized as: Jazz Web Parts

Table of Contents [Hide/Show]

   Create Jazz User Web Part
      Access
      Features
         Format of Email Domain Blacklist file
      Edit Properties

Figure 1: Jazz New User form

Create Jazz User Web Part¶

This Web Part is used to create new Jazz Users. The basic form displayed in the first image is a standard form that is produced by this Web Part. It collects various information for the new Jetfire user.

The second image is the same form, albeit decorated differently and displaying a different set of fields (due to how the Web Part is configured). Of particular note, this image shows the image-based captcha form.

Figure 2: Jazz New User form

Access¶

This Web Part is accessed by the Jazz Admin Panel and the Jazz Login Library.

Features¶

The Web Part has a number of options, including:

Customized text for prompting the user.
(optional) Collect User Email and Password Recovery question and answer.
(optional) Save browser user's IP address in property 'IPAddress'.
(optional) A Captcha prompt used as a security measure.
Add new user to specific workspace.
Add new user as a custom class.
(optional) Select the custom class that is used to create the new user.
(optional) Enforce the user name as an email address.
(optional) Hide the User workflow.
Url to direct the user to if the user cancels the new user request.
Prompts for additional custom properties.
An Automatic Login Type that supports multiple ways to login.
Confirm new user registration by sending the user an email with customized text.
(optional) Email Domain Blacklist: if not blank, then compares the domain of the email address to a list of domains in the xml file. If found, then the profile is not accepted, because the 'Email domain not accepted'.

Format of Email Domain Blacklist file¶

An example of the Email Domain Blacklist file is:

<?xml version="1.0" encoding="utf-8" ?>
<Domains comment="This is a list of domains." xmlns="http://schemas.TrackerRealm.com/AspNet/Domains">
	<Domain>yopmail.fr</Domain>
	<Domain>yopmail.net</Domain>
	<Domain>cool.fr.nf</Domain>
	<Domain>jetable.fr.nf</Domain>
	<Domain>nospam.ze.tc</Domain>
	<Domain>nomail.xl.cx</Domain>
	<Domain>mega.zik.dj</Domain>
	<Domain>speed.1s.fr</Domain>
	<Domain>courriel.fr.nf</Domain>
	<Domain>moncourrier.fr.nf</Domain>
	<Domain>monemail.fr.nf</Domain>
	<Domain>monmail.fr.nf</Domain>
	<Domain>ypmail.webarnak.fr.eu.org</Domain>
</Domains>

Edit Properties¶

Custom Edit properties include:

Admin Role: A comma-delimited list of Roles that can use the Web Part.
User Class Name: Select the User Class that is created.
Default Workspace: Workspace to add the new user to.
User can immediately login?: If checked, then the new user is approved and can immediately log in.
Save User Name as Email?: If checked, then the user name is expected to be an email address.
Display Additional Properties: if checked, then adds properties from the configuration file. If the Configuration file is blank, then the embedded configuration file is used for the display.
Configuration File: The Workflow Configuration File used to display properties of the user code class.
Requires Question and Answer?: If checked, then the user is prompted to enter a security question and answer.
Auto-generate Password?: If checked, then the password is not prompted, but is automatically generated.
Captcha Type: None, Image.

None: The captcha form is not used on the form.
Image: The captcha form is displayed on the form.

Auto-Login Type: Manual, Automatic or Auto-cookie.

Manual mode allows the user to login using the login form.
Automatic mode automatically logs the user in after being created.
Auto-cookie mode creates a cookie in the user's browser. This logs the user in automatically when they surf the domain.

Create User Action: Select the Create User Action:

None
Another Account: allows user to add another user
Return to Previous Page: returns user to previous page
Login: logs the new user in immediately
Login and return to Previous Page: logs the new user in immediately and returns to the previous page
Login and route to destination: logs the new user in immediately and proceeds to destination page

Cancel Page Url: The page address that the user is routed to if the user clicks the 'Cancel' button. If blank, clears the form and returns to this page.
Destination Page Url: The page address that the user is routed to after the new user is created. If blank, returns to this page.
Send Email?: If checked, then a registration email is sent to the user when the user is created.
Email Link Text: used if Send Email is checked. The text associated with the email link sent to the user to confirm registration.
Confirm Url: used if Send Email is checked. The absolute address of the page used in the sent email to confirm the registration.
bcc List: if send email is checked, the email is sent to the new user's email address in the form. A blind copy can be sent to additional users in this semi-colon delimited list or email addresses.
Email Subject: The subject of the registration email being sent.
Email Body: The body of the registration email being sent.
Email Domain Blacklist: the path to an xml file that contains a list of domains. If the email domain is listed in the xml list, then the profile is not accepted, because the 'email domain is not accepted'.
Jazz Common Edit Properties

Figure 3a: Editor for Jazz New User form

Figure 3b: Editor for Jazz New User form