Registration Fields Setup

The Registration Page Fields setting allows the admin user to configure the fields that will appear during app registration for the end users on the registration page. These fields can be modified based on the business requirement.

The expected input format and the field mandate (mandatory/optional) can be set using this feature. Registration Fields allow for a dynamic extension of the Registration page and the scope of the fields.

Registration Page Fields can be accessed on the cidaas Admin dashboard under Settings.

The following table view is displayed for the Default fields defined by the admin for the Registration page.

The table view displays the following columns.

  1. Field Key: The identifier or name used to identify the registration field.
  2. Field Type: The type used to define the purpose, scope, and validation of the registration field. The available types include:

    • Text
    • URL (web link)
    • Email
    • Password (masked value)
    • Mobile (10-digit numeric)
    • Date
    • Number
    • Select (single-selection)
    • Username
    • Array (collection of values)
    • Checkbox (for enabling a feature)
    • Consent (to accept terms and conditions)
    • Radio (radio button selection)
    • Multiselect
    • Textarea (text input field for long-form text like descriptions, feedback, etc.)
    • JSON_STRING (a string of JSON objects).

  3. Status: This field is set to either "enabled" where the field is made visible on the registration page, or "disabled" which does not display the field.
  4. Action(s): The edit icon appears in this column clicking which the user is redirected to the Edit Field page to edit the field and locale (language) settings.

Default Registration Fields

By default, cidaas displays the following fields on an app's user registration page:

  • Email

  • Given Name

  • Family Name

  • Password

  • Confirm Password

  • Mobile

Creating Custom Registration Fields

In addition to the default fields, cidaas lets you create and define custom registration page fields based on your business requirements.

To create a custom field, follow these steps:

1. On the Registration Page Fields page, click the create button on the top-right corner.

2. On the Create Field page, set the following fields:

a. Enter the field name - Type a string values without spaces.

b. Select the appropriate field type from the dropdown list. A field type is based on a Data Type and Base Data Type.

The dataType reflects either a user interface type (like RADIO, TEXTAREA) and/or add some semantics to the data (like PASSWORD, URL, EMAIL, CONSENT) while the baseDataType is used to define how data gets stored.

Please refer to the table below to understand the different dataTypes, their corresponding baseDataTypes and what they mean.

DataType BaseDataType Description
TEXT
string This is a text field for which the constraints minimum and maximum text length can be defined.
NUMBER
double/integer Numeric Field.
RADIO
string Different values can be predefined (for a defined group) from which a value can be selected. The selected value is saved as a string.
CHECKBOX
boolean Is a binary value that is stored as boolean.
PASSWORD
string Is a text field.
DATE
datetime The date which is stored as datetime.
URL
string This is a text field. The incoming values need to match a url format.
EMAIL
string This is a text field. The incoming values need to match the email format.
TEXTAREA
string This is a text input field.
MOBILE
string This is a text field. The incoming values need to match the mobile number format.
boolean This is a binary value which is used to store the user's consent.
JSON_STRING
string This is a text field for which contains a raw JSON.
USERNAME
string This is a text field which is used to save the unique identifiers of a user.
ARRAY
array[string] This is an array of strings without predefined values.
SELECT
string This is a single value that is selected from an array of predefined ones and is saved as a string.
MULTISELECT
array [string] These are multiple values that are selected from an array of predefined ones and are saved as an array of strings.

  • Based on the field type you select, you can either set the possible key value pairs, especially for the selection and multi-selection options, and the value range for date type.
  • Field Type: SELECT You can add multiple key (identifier of the attribute) and value (name given to the attribute) pairs that define the attribute for single selection from the list of options.

    Field Type: MULTISELECT You can add multiple key (identifier of the attribute) and value (name given to the attribute) pairs that define the attribute for multiple selections from the list of options.

    Field Type: RADIO You can add multiple key (identifier of the attribute) and value (name given to the attribute) pairs that define the attribute for a mutually-exclusive selection from the list of options. This is especially useful for boolean values like true/false, yes/no, submitted/not submitted, etc. or a single selection.

    Field Type: DATE You can select the date range, the start and end dates for this field type.

  • Also, the options for Permissions also change based on the type you select. When you select the type as **Consent**, only the "Enable" and "Required" permissions are available for selection.
  • For other field types, "Enable", "Required", "Read Only", and "Internal" are available.

c. Select the scope(s) from the list of configured values. The scope will define where and how the field will be used. One field could have more than one scope. For example, Date of Birth can be mapped to the “profile” and the “personal” scopes.Multiple fields can be grouped based on a single common scope. For e.g. First Name, Last Name, and email could be mapped to the “profile” scope.

When an application request contains the “profile” and “payment” scopes, only the data for the fields mapped to these scopes will be allowed access.

The concept is depicted in the diagram below:

Access restrictions can be implemented on a set of fields by grouping them based on the scope.

For more information refer Scope Management.

d. Select one or more permissions for the field from the following options:

  • Enable: The field is visible on the registration form.

  • Required: The field is defined as mandatory where the user has to provide the input for the field during registration.

  • Read Only: The field value can be only viewed and not changed.

  • Internal: This field is internal to the app and will not be mapped to users or visible to them during registration.

Click here for more on System and Custom fields.

3. Configure the Locale Setting by providing the values for mandatory fields, Select Locale (language of the Registration field), Field Name Based on Locale (name of the registration field that will appear for the user), and Required Message (the message that will appear for the user).

4. Finally, provide the Minimum and Maximum length constraint values (optional) and click on Save.

The following success window appears which confirms the Field Setting creation before adding a new custom field.

Note: When you try to create a Field Setting that already exists, a notification window with the message This Registration Field already exists appears as shown below. The Field Key of a Field Setting must be unique.

Editing a Registration Field Setting

You can modify the created custom registration field values and attributes. Click here to learn more.

Deleting a Registration Field Setting

You can delete custom registration fields from the registration page. Click here to learn more.

Managing Registration Fields Groups and Sub-Groups

Adding a Group

You can group registration fields based on scope, purpose, or any other user registration-based categorization.

For example, create a group called "Address" to add apartment number, building name, pincode, etc. as a group. This is helpful in mapping all the fields to a common group and fetching/passing all the values at once during registration.

To add a group,

1. Click the add group button on the Registration Page Fields page.

2. In the Create Group page, under Group Setting, follow these steps:

  1. Type the group name.
  2. Select the Permission(s) as "Enable" for making the group visible on the registration page, otherwise, select "Internal".
  3. For Locale Setting, Select Locale (language) from the dropdown.
  4. Type the value for Group Name Based on Locale which will indicate the group name for the language selected.
  5. Click Save to save the changes.
  6. The following success confirmation is displayed after the group is created.

The group you've created is added to the Registration Page Fields page.

Adding a Sub-group

You can add sub-groups to a registration fields group based on scope, purpose, or any other category.

For example, create a sub-group called "Home Address" to the group "Address", and add apartment number, building name, pincode, etc. to this sub-group.

To add a sub-group,

1. Click the add group button of the group you've already created.

2. Follow the steps mentioned in Point #2 of the Adding a Group section.

Adding Registration Fields to a Group or Sub-group

You can add fields to a parent group or sub-group you've created. For example, for a group named "address", you can add the fields "Apartment name", "apartment number", etc. with the following steps:

1. Click the Create Field button for a fields setting group.

2. Under the Create Field > Field Setting, provide the values for Field Key and Field Type which are mandatory.

3. Then, select Scopes and Permissions (optional).

4. Configure Locale Setting by providing the values for the mandatory fields, Select Locale (language of the Registration field), Field Name Based on Locale (name of the registration field that will appear for the user), and Required Message (the message that will appear for the user).

5. Finally, provide the Minimum and Maximum length values (optional) and click Save.

The following success window appears.

6. The new custom field is added to the group.

Editing a Group or Sub-group

You can edit the group or sub-group information with the following steps:

1. Click the edit icon of the group.

2. On the Edit Group page, make the changes to the required fields under Group Setting and Locale Setting.

Note: The Searchable option appears for Permissions. Selecting this option makes the field searchable (adds the search feature).

3. Click Save. A success message is displayed after the field values are modified.

This completes our discussion on the registration fields setup operations. For any questions or assistance please contact our support team.

We'll be happy to help! Thank you.



results matching ""

    No results matching ""