User create portlet

From VYRE

Jump to: navigation, search
User create portlet
module: Users and groups module
supplier: VYRE Ltd.


The User create portlet is used to generate a form used to create a new user in Unify.

Contents

Edit mode

The configuration of the User create portlet is similar to the that of the User and Item edit portlets.

Realm selection

Selecting the User realm

When adding a User create portlet to a content area on your page you will first be presented with a drop-down box, from which to select the User realm within which you would like the user to be created. Click the 'Save' button to progress to the next configuration screen.


The main configuration screen

The main configuration screen

User name is email address

When this checkbox is checked then the user's email address will be used as their username.

Redirect

This field is used to enter the absolute path to the page you would like the form to redirect to upon its submission. It is important that the path includes the leading slash '/' to denote the root of your site. A correct path would look something like this:

/my_root_page/user_list

Please note: It is not possible to use dynamic variables (such as $context_path) in this string.

If you leave this field empty then no redirect will takes place and the page will simply be reloaded upon submission of the form.

Send request parameter

This is used in conjuction with the 'redirect to page' function. When the 'Send request parameter containing user info when redirecting' checkbox is checked then the 'id' of the user is passed to page specified in the field above. This allows you to redirect to a user detail page to display information about the user that has just been been created.

Confirmation message

If no page is selected for redirect upon submission of the form then a message can be written to be displayed in place of the completed form. This can either be a custom message or it can be a localisation key:

Enter Custom message

Select the Message that will be displaed after successful creation of a user radio button option and use the text-area to enter the message you would like to be displayed.

Use Localization key

Select the Use localisation key radio button option and specify a localisation key in the corresponding input field.

Log user in after creating

When this checkbox is checked then the person completing the User create form will be logged in upon the form's submission. An example of the configuration would be a User Registration page. Once a user has completed their registration and submitted the form then they would be logged in and ready to use the website/application as a registered user.

Generate an authentication key

When this checkbox is checked, Unify will generate an authentication key and store it in the user profile properties when a user is created through the portlet.

Send message on submit

When this checkbox is checked then Unify will send messages/emails based on the selection of the following fields:

Please note: If no message is selected then this checkbox will be ignored and Unify will not send any messages.

Message sent to new user

Select a message template from the list available in the drop-down. This, in conjuction with the Send message on submit checkbox, will send a message (based on the template selected) to the user that is to be created using the form.

Message sent on submit

Select a message template from the list available in the drop-down. This, in conjuction with the Send message on submit checkbox, will send a message to users that are specified in the message template selected.

Adding Fields to your form

This section allows you to add the requisite fields to your User createform.

Please note: Make sure that you save your configuration prior to adding any fields to your form as the configurations that you have just entered will be lost.

Selected fields in the form

fields in the form

This is where your selected fields will appear, you can edit, remove or move fields up or down using the corresponding icons

General

These are general (common) fields that are used in a form such as: username, password, groups, user activation, submit button and custom code etc. You can also add CAPTCHA validation field since 4.6.1. Many of the fields here are used for editing the user profile fields. Some of the fields and there uses are defined in greater detail below:

Custom Code

Custom code allows you to add any custom code or text. Various dynamic variables are available for use here.

Deactivation Date

This option allows you to define the Deactivation date for the user. This can be displayed as either a calender or a drop down box. By using the drop down box it is possible to limit the values which it is possible to enter into this field. The values of this drop down box are defined in a similar way to attribute presentation rules. e.g:

3 Months;current+90 
6 Months;current+180

Note that the values have to be defined in days.

Default attributes

These are the default (out-of-the-box) user attributes that are automatically set up for a Unify realm, such as: First name, Surname, Address etc.

Custom attributes

Any custom attributes that you have set up for a realm will be listed here.

Item links

Here you will see listed any User link definitions that are set up. Selecting a link definition will offer the user a list of avaliable links.

See Also

Personal tools