Page Comparison

The user registration form, which is also known as the sign up form, is generated using claims and is primarily used to gather information of users using a given service or product. The user information which is used by ES. As the information required by business entities will 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 includes the fields shown below.

Image Removed

Follow the instructions below to customize the user registration form:

Login to the Carbon management console using admin:admin as the username:password.

...

By default, <ES_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <ES_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

...

Image Added

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.
   Image Added
   

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

   Info
   In WSO2 ES the http://wso2.org/claims is used to configure the registration form and it is the default dialect being used by WSO2 Carbon.

   Image Removed

   Working with claims: 
   Image Removed
   Add a new claim:

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

4. Click Add New Claim Mapping to add a new claim mapping that is does not already addedexist.
5. Update

   Enter the details required in the NEW CLAIM DETAILS form.
   

   Excerpt
   The fields related to claim details are explained as follows: Info icon false Display Name: This is the name of the claim displayed on the UI.

6. Click Add to add the new claim.
   Image Removed
Add or remove a claim from the registration form:
7. Click Edit next to the on a preferred claim you wish to add or remove.
8. Check the Required check box to get the respective field on the registration form.
   Uncheck the Required check box to remove the respective field from the registration form.
   Example:
   Currently The filed named country is not on the registration form. Therefore by checking the required checkbox it will be included in the registration form.

Description: This gives you the option to describe the functionality of the claim. Claim Uri: This is the URI defined under the dialect, specific to the claim. There are different URIs available in Carbon and these equate to user attributes displayed in the profile of users. These URIs are mapped to the attributes in the underlying user store. Mapped Attribute: This is the corresponding attribute name from the underlying user store that is mapped to the Claim Uri value. When you have multiple user stores connected to ES, this maps the equivalent attribute in all of them to the Claim Uri you are configuring. For example, if you specify the cn attribute, this is mapped to the cn attribute in all the connected user stores. If you want to specify the attribute in a specific user store, you must add the domain name in addition to the mapped claim. For example, in a scenario where you have a primary user store configured called PRIMARY and secondary user stores called AD (representing Active Directory) and JDBC, you can map an attribute from each of these user stores to the Claim Uri value by entering them in a semi-colon separated list. In this example, your Mapped Attribute value would read as follows: PRIMARY/attribute1;AD/attribute2;JDBC/attribute3. Regular Expression: This is the regular expression used to validate inputs for this claim. Display Order: This enables you to specify the order in which the claim is displayed, among the other claims defined under the same dialect. Supported by Default: If unchecked, this claim will not be prompted during user registration. Required: This specifies whether this claim is required for user registration. The claim will only appear in the user registration form if this field is checked. Read-only: This specifies whether the claim once added at the time of registration can or can not be modified later when updating user details. If a claim is read-only, ES will not allow you to update the field corresponding to it when updating the corresponding user's details.

Image Added

9. 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.
   

   Insert excerpt
   Customizing the User Registration Form Customizing the User Registration Form nopanel true

   Image Added
6. Click Update to save the changes made.
   Image RemovedOnce the above steps have been followed navigate Navigate to the ES store front or back office (publisher) registeration page. Refresh the page and the changes made will be visible.
   

...

1. 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.
   Image Added

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.
   Image Added

5. Click yes to delete the selected claim mapping.