Customizing the User Registration Form

The user registration form, which is also known as the sign up form, is generated using claims and is primarily used to gather user information which is used by ES. As the information required by business entities differ based on their strategies, WSO2 ES facilitates the option for the administrator to customize the registration form to suite the entities business requirements.

The following screenshot depicts the fields in the default ES user registration form.

Customizing the user registration form

The user registration form can be customized in any of the following methods:

• Adding a new claim mapping
  This allows you to add a new field in the user registration form. When adding the claim mapping for the new claim, you need to select the required checkbox, so that the claim will appear as a field in the user registration form.
• Editing a claim mapping
  If you wish to edit the fields in the user registration form (such as, change the order or a field, hide a field etc.), then you can edit the respective claim mappings, which correspond to those fields in the user registration form.
• Deleting a claim mapping
  If you do not want a certain field to permanently appear in the user registration form, then can delete the claim mapping that corresponds to that field.
  
  

Adding a new claim mapping

Follow the instructions below to add a new claim mapping:

1. Log into the ES Management Console.

2. On the Main menu, click Claim Management.
   
   

3. Click http://wso2.org/claims under AVAILABLE CLAIM DIALECTS.

   
   The claim mappings that correspond to the selected claim dialect appears.
   

4. Click Add New Claim Mapping to add a new claim mapping that does not already exist.

5. Enter the details required in the NEW CLAIM DETAILS form.
   

   • Display Name: Name of the dialect.

   • Description: Describe the dialect, such as, what it is designed for, etc.

   • Claim Uri: Each dialect should have at least one claim when defining it.

   • Mapped Attribute: Corresponding attribute name from the underlying user store for this claim.

   • Regular Expression: Regular expression to validate inputs for this claim.

   • Display Order: Display order of the above claim among all the other claims defined under the same dialect.

   • Supported by Default: If unchecked, this claim will not be prompted at the time of user registration.

   • Required: Whether this claim is mandatory for user registration or not. Note that the claim will only appear in the user registration form if this field is checked.

   • Read-only: If the input for this claim mapping is taken directly from the userstore, then you need to make the claim mapping as read-only, by enabling the read-only option, to prevent the user from being able to input any details for this field.

   

6. Click Add to add the new claim mapping.

Editing a claim mapping

Follow the instructions below to update a claim mapping:

1. Log into the ES Management Console.

2. On the Main menu, click Claim Management.

3. Click  http://wso2.org/claims  under AVAILABLE CLAIM DIALECTS. The claim mappings that correspond to the selected claim dialect appears.

4. Click Edit corresponding to the claim mapping that you want to edit.

5. Edit the required fields in the UPDATE CLAIM DETAILS form. Note that the claim Uri can not be updated.
   
   Error rendering macro 'excerpt-include' : No location was provided.
   
6. Click Update to save the changes made.
   Navigate to the ES Store or Back Office (Publisher) and click Register to access the registration page. Thereafter, refresh the registration page to view the registration form with the newly added customizations.
   

Deleting a claim mapping

Follow the instructions below to delete a claim mapping:

1. Log into the ES Management Console.

2. On the Main menu, click Claim Management.

3. Click  http://wso2.org/claims under AVAILABLE CLAIM DIALECTS. The claim mappings that correspond to the selected claim dialect appears.

4. Click Remove claim mapping corresponding to the claim that you want to delete.
   

5. Click yes to delete the selected claim mapping.