Account Manager Page

Last Updated: 09 Nov 2016

An Account Manager Page can be added to allow your users to create new accounts for themselves and edit their account details. When a user goes to the URL of the Account Manager Page, they can either login or create an account for themselves. Once they have created a user account, they can log in and edit their account details.

Bookmarks

If you only want authorised users to create accounts, you should use an Asset Builder Page instead.

Account Manager User Process

The figure below shows how this process works through the use of the Bodycopy assets created under the Account Manager Page in the Asset Map.

The Process of the Account Manager Page
The process of user creation on the Account Manager Page

The Account Manager Page can also be set up so that users have to verify their details before their user account is activated (or made Live). When the user creates an account, an email will be sent to the email address they entered. The email will contain a URL, which they click to validate their account.

The figure below shows how this process works through the use of the Bodycopy assets created under the Account Manager Page in the Asset Map. For more information about each of these Bodycopies, refer to the Additional Dependant Assets section in this chapter.

The Process of an Account Manager Page with Email Validation
The process of user creation on an Account Manager Page with validation enabled

Once your Account Manager Page is created, you can configure its settings on its associated asset screens. The majority of these screens are the same or similar to those for a Standard Page and are described in the Asset Screens manual.

In this chapter, we will describe the Details, Create Locations, Required Attributes, Messages and Pending Accounts screens, which are different for an Accounts Manager Page.

Additional Dependant Assets

The additional dependant assets of a Account Management Page
The additional dependant assets

When you create an Account Manager Page, several assets are automatically created beneath it, as highlighted in the figure to the right. You can use these assets to define the contents and layout of the Account Manager Page.

  • Not Logged In: this Bodycopy is used to define what to show the user when they are not logged in. This layout should invite users to login or allow them to create a user account for themselves.
  • Created but not Live: this Bodycopy is used to define the layout once a user account has been created with the Status of Under Construction. This layout should inform the user that their account has been created but will not be active.

    A user account needs to have a Status of Live for it to be active. If it is not Live, the user will not be able to log in.

  • Created, Live: this Bodycopy is used to define the layout once a user account has been created with the Status of Live. This layout should inform the user that their account has been created and its active.
  • Logged In: this Bodycopy is used to define what to show the user when they log into the system. This layout should allow users to update their account details.

The additional dependant assets of a Account Management Page with Email Validation
Additional assets for validation

If you are using email validation, a different set of assets will be available under the Account Manager Page in the Asset Map, as highlighted in the figure to the right. The Not Logged In and Logged In Bodycopy are the same as those outlined above. The additional assets are as follows:

  • Pending Accounts: when an account is created it is stored under the Pending Accounts User Group until the user has verified their account. Once it has been verified, it is moved into the correct location.
  • Created, awaiting validation: this Bodycopy is used to define the layout once a user account has been created. It should inform the user that an email has been sent to their email address with further instructions.
  • Validated: this Bodycopy is used to define the layout once the user has verified their account. They will see this layout when they click on the URL within the email.

Details Screen

The Details screen allows you to configure the settings for the Account Manager Page. For more information about the Status, Future Status, Thumbnail, Details, CAPTCHA, Mollom Spam Check, Google reCAPTCHA, Honeypot Question and Submission Time Threshold sections of the screen, refer to either the Details Screen chapter in the Asset Screens manual or the Form Contents chapter of the Custom Form manual.

Account Manager Settings

This section allows you to select which type of account to create and the Status to create them as. The Account Manager Settings section of the Details screen is shown in the figure below.

The Account Manager Settings section of the Details screen
The Account Manager Settings section of the Details screen

The fields available are as follows:

  • Type of Account: select the type of user to be created on the Account Manager Page. Select from User, Backend User or System Administrator.
  • Create Status: select the Status that the created user account will have. To create active accounts, select Live. To create inactive accounts select Under Construction.
  • Automatically Log User In: select whether or not new user accounts will be made Live and logged-in automatically after creation. If this field is enabled, this setting will overwrite the Create Status setting and will disable the Email Validation function. By default, this field is set to No.
  • Metadata Schemas to Apply: this field allows you to select a Metadata Schema that will automatically be applied to the user accounts that are created. The user can then fill in the metadata fields when they are creating an asset. By default, the metadata fields will appear above the create form on the Account Manager Page. It is recommended that the create form be customised so that the metadata fields can be laid out using the keyword replacement %metadata-F_<fieldid>%, where <fieldid> is the asset ID of the metadata field. For more information on how to do this, refer to the Customising the Layout of the Create Form section in this chapter.
  • Enter Simple Edit mode?: by default, when a logged in user accesses the Account Manager Page they will automatically be taken to the Simple Edit Interface where they can edit their account details. This option allows you to disable this automatic redirect so that a logged in user can create user accounts instead of editing their details.

Email Validation

This section allows you define whether or not users have to verify their details before their user account is activated (or made Live). When the user creates an account, an email will be sent to the email address they entered. The email will contain a URL, which they click to validate their account. The Email Validation section of the Details screen is shown in the figure below.

The Email Validation section of the Details screen
The Email Validation section of the Details screen

By default, this option is set to No meaning that their account will not be verified and will be made active if you have selected a Create Status of Live. If you want the user to verify their account, set Use Email Validation to Yes and click Commit. Additional fields will appear within this section, as shown in the figure below.

The Email Validation fields on the Details screen
Additional fields in the Email Validation section

The fields available are as follows:

  • Email Format: this section allows you to configure the email that is sent to the user once they have created their user account. The fields available are as follows:
    • To: by default, the email will be sent to the address the user entered when they created their account. This field allows you to enter additional email addresses of the people who should also receive the email, for example a System Administrator. You can enter their email address in the text fields or select their user account in the asset finder field.
    • From: enter the email address that will appear in the from field in the email. By default, the email entered on the System Configuration screen will be used.
    • Reply-To: enter the email address for a user to reply to. If no reply-to address is configured, the header will not be sent on the email.
    • Subject: enter the text to be used as the subject of the email. You can use the keyword replacements displayed under the Body within this field. By default, Activating your new account will appear in this field.
    • Body: enter the body of the email. You can enter either the text or HTML version of the email in this field. To edit the HTML version, click on the edit icon icon – a WYSIWYG Editor will appear. You can use the keyword replacements displayed under the Body within the email. These keyword replacements are as follows:
      • %validation_url%: this will show the URL the user must click to verify their account. This keyword replacement needs to be included within the Body of the email otherwise the user cannot verify their account.
      • %first_name%: this will show the value the user entered into the First Name field when they created their user account.
      • %last_name%: this will show the value the user entered into the Last Name field when they created their user account.
      • %email%: this will show the value the user entered into the Email field when they created their user account.
      • %username%: this will show the value the user entered into the Username field when they created their user account.
  • Send Validation Button Text: enter the text to be shown on the Resend Validation button that you can include on the Not Logged In Bodycopy. The user can click this button to re-send the original validation email for their user account. By default, Re-Send Validation is used.
  • Pending Account Re-send Period: enter a period of time after which the validation email is resent to the users who have not verified their user account. For example, if you enter 2 days and the user has not verified their account 2 days after creating it, the validation email is resent. By default, 0 is entered meaning that this option is disabled.
  • Pending Account Deletion Period: enter a period of time after which a user account is deleted if the user has not verified it. For example, if you enter 5 days and the user has not verified their account 5 days after creating it, their user account is deleted. By default, 0 is entered meaning that this option is displayed.

Post Login Re-direct

This section allows you to select an asset the user is redirected to once they have created their account and logged in.

Advanced Settings

This section allows you to change the advanced options for the Account Manager Page.

The fields available are as follows:

  • Form Submission URL: this option controls where the form is submitted. This is useful if you nest an Account Manager Page in another page. By default, this is set to The Current URL and the form is submitted to the current page you are viewing (i.e. the page in which the Account Manager Page is nested). This means that the success or error message for the Account Manager Page will be shown within the original page. If you set this option to The Page's Own URL, the Account Manager Page will submit to its own URL. This means that the success or error message will not be nested in another page, because the user will be redirected to the Account Manager Page itself. The URL, the lineage, and the menu etc will change to be the Account Manager Page.
  • The User Create Form Layout asset
    The Create Form Layout asset

    Create Form Customisation: this field allows you to create a customisation of the create form. To customise the layout, select Create Form Customisation and click Commit. A Layout asset will be created under the Account Manager Page in the Asset Map, as highlighted in the figure to the right. This Layout asset is then used to layout the create form for the page. For more information on how to do this, refer to the Customising the Layout of the Create Form section in this chapter.
  • Confirm Password On Create: this option controls whether to display a confirmation input field for the password option when creating a new User Account.

Create Locations Screen

The Create Locations screen allows you to specify where the user account will be created. You can either:

  • Select a fixed location where the user accounts will be created by default.
  • Create a list of options where the user can select a location.
  • Create a list based on a particular root node. The user then selects a location from the list.
  • Select to create the user account in a particular location based on a set of rules, for example, the username the user entered.

Each create location must be either a User Group or Role.
If you have selected to use email validation on the Details screen, the user account will be created in the Pending Accounts User Group under the Account Manager Page in the Asset Map. Once the user has verified their user account, it will be moved into the correct create location.

Fixed Create Locations

This section allows you to specify the locations where the user accounts are created by default. For example, say you have created an Account Manager Page to allow you users to create a members account. You can create a User Group called Site Members and select this User Group as a fixed create location. Any user accounts that are created will be stored under this User Group in the Asset Map.

By default, no fixed create location is selected. In the Add Location field, select the User Group to use. In the Link Type field, select what type of link to create the user account as. The options that are available include TYPE_1, TYPE_2, TYPE_3 and NOTICE. For more information on each of these link types, refer to the Concepts manual.

Once you have filled out these fields, click Commit. The location will appear within the list, as shown in the figure below.

Additional fields in the Fixed Create Locations section of the Create Locations screen
Additional fields in the Fixed Create Locations section

To delete a location from the list, click the Delete box and click Commit. To add additional locations to the list, use the Add Location field located under the list. If you select multiple locations, the user account will be linked under each location (i.e. it will be the same asset, with the same asset ID, appearing in multiple locations in the Asset Map). Each location can also have a different Link Type. For example, one create location can have a Link Type of TYPE_1 and another location can have a Link Type of TYPE_2.

Selectable Create Locations

This section allows you to create a list of locations. The user can then select a location from the list of values. You can create a number of different lists and each list can be shown in a number of different formats.

By default, no selectable create location will be created. To create a new list, enter a name for the list in the Add New Set field and click Commit. Additional fields will appear on the screen, as shown in the figure below.

Additional fields in the Selectable Create Locations section of the Create Locations screen
Additional fields in the Selectable Create Locations section

The fields available are as follows:

  • Location Options: select the locations that will appear in the list to the user. You can add as many locations as you want to the list. To remove a location from the list, click the Clear button and click Commit.
  • Link Type: select what type of link to create the user account as. The options that are available include TYPE_1, TYPE_2, TYPE_3 and NOTICE. For more information on each of these link types, refer to the Concepts manual.
  • Input Style: select the style of the list you want show on the Account Manager Page. The options that are available include Dropdown and Radio Buttons. Both of these formats are shown in the figures below.

    The Dropdown and Radio button lists
    A Dropdown list and a Radio Button list

  • Rules: the rules that are available for each selectable create location are as follows:
    • Allow No Selection: select this option if you want to allow the user to select no location from the list.

      If you select Allow No Selection you will need to select at least one Fixed Create Location, otherwise the user account cannot be created as the system does not know where to create it.

    • Allows Multiple Selections: select this option to allow the user to select multiple locations from the list. If they select more than one location, the user account will be linked under each location. In other words it will be the same asset, with the same asset ID, appearing in multiple locations in the Asset Map. Also if you select this option, depending on what value you have selected in the Input Style field, the format of the list will change. If you have selected Dropdown, the list will appear in a box where the user can hold down the Ctrl key to select multiple values. If you have selected Radio Buttons, a check box list will appear where the user can tick multiple values. Both of these formats are shown in the figure below.

      The Multi-select and Checkbox lists
      A Multi-Select list and a Check Box list

  • Delete Set: to delete a selectable create location, click the Delete Set button. The list will be deleted.

Once you have filled in the required fields, you need to add a keyword replacement to the Account Manager Page so that the list will appear to the user. By default, this keyword replacement should be added on the Not Logged In Bodycopy. The name of the keyword replacement will reflect the name you entered in the Add New Set field. For example, if you entered User Group when you created the Selectable Create Location, the keyword replacement you need to add will be User Group Field.

To add additional Selectable Create Locations, enter the name of the location in the Add New Set field and click Commit.

Dynamic Create Locations

This section allows you to create a list of locations based off a specific root node. For example, if you select the Users Folder as the root node for this list, you can show all of the User Groups and Roles under the Users Folder. The user can then select a location under the Users Folder to create their user account. When User Groups or Roles are added under the root node, if they match the selected criteria for the Dynamic Create Location, they will automatically appear in the list to the user.

By default, no dynamic create location will be created. To create a new list, enter a name for the list in the Add New Set field and click Commit. Additional fields will appear on the screen, as shown in the figure below.

Additional fields in the Dynamic Create Locations section of the Create Locations screen
Additional fields in the Dynamic Create Locations section

The fields available are as follows:

  • Root Node: select a root node for the list. For example, if you want to create a list based on the assets in the Users Folder, select the Users Folder in this field.
  • Depth: enter the number of levels of the asset hierarchy you want to show in the list. For example, if you only want to show the child assets of the root node, enter 1. By default this value is 0 meaning that all levels will be shown in the list.
  • Restrict to these Asset Types: select which asset types will be available in the list. For example, if you only want to show the User Groups under the root node in the list, select User Group. To select more than one asset type, click on the More... button. An additional list will appear on the screen. To remove an asset type from the list, click the Clear button and click Commit.
  • Include links of the following type in the locations list: select what type of link the asset must be to be included in the list. For example, if you only want to show the TYPE_1 assets under the root node, only select TYPE_1.
  • Link Type of Created Asset: select what type of link to create the asset as. The options that are available include TYPE_1, TYPE_2, TYPE_3 and NOTICE. For more information on each of these link types, refer to the Concepts manual.
  • Input Style: select the style of the list you want show on the Account Manager Page. The options that are available include Dropdown and Radio Buttons. Both of these formats are shown in the figure below.

    The Dropdown and Radio button lists
    A Dropdown list and a Radio Button list

  • Display Assets as a Tree: select this option if you want to show the hierarchy of the assets in the list based on the Asset Map. An example of this is shown in the figure below.

    A list displaying the hierarchy of assets
    A list displaying the hierarchy of assets

  • Rules: the rules that are available for each dynamic create location are as follows:
    • Allow No Selection: select this option if you want to allow the user to select no location from the list.

      If you select Allow No Selection you will need to select at least one Fixed Create Location, otherwise the user account cannot be created as the system does not know where to create it.

    • Allows Multiple Selections: select this option to allow the user to select multiple locations from the list. If they select more than one location, the user account will be linked under each location. In other words it will be the same asset, with the same asset ID, appearing in multiple locations in the Asset Map. Also if you select this option, depending on what value you have selected in the Input Style field, the format of the list will change. If you have selected Dropdown, the list will appear in a box where the user can hold down the Ctrl key to select multiple values. If you have selected Radio Buttons, a check box list will appear where the user can tick multiple values. Both of these formats are shown in the figure below.

      The Multi-select and Checkbox lists
      A Multi-select list and Checkbox list

  • Delete Set: to delete a dynamic create location click the Delete Set button. The list will be deleted.

Once you have filled in the required fields, you need to add a keyword replacement to the Account Manager Page so that the list will appear to the user. By default, this keyword replacement should be added on the Not Logged In Bodycopy. The name of the keyword replacement will reflect the name you entered in the Add New Set field. For example, if you entered Users Folder when you created the Dynamic Create Location, the keyword replacement you need to add will be Users Folder Field.

To add additional Dynamic Create Locations, enter the name of the location in the Add New Set field and click Commit.

Create Location Rules

This section allows you to specify where the user account will be created based on a set of rules. For example, if the Username starts with a, create it under the User Group called A-K Users.

To create a new rule, click the New Rule link. Additional fields will appear as shown in the figure below.

Additional fields in the Create Location Rules section of the Create Locations screen
Additional fields in the Create Location Rules section

The fields available are as follows:

  • If all these conditions are true: add the conditions for this rule. Each condition consists of an attribute, a comparison rule and a comparison value. The list of available comparison rules will include Equals, Starts With, Ends With and Contains.
    To add a condition, select an attribute from the first list, select a comparison rule in the second list and enter a value in the text box provided. You can add as many conditions as you want to the list. The rule is met when all conditions are true.
  • link the asset to all these locations: select where you want to create the user account when the conditions have been met.
  • Link Type: select what type of link to create the asset as. The options that are available include TYPE_1, TYPE_2, TYPE_3 and NOTICE. For more information on each of these link types, refer to the Concepts manual.
  • Delete Rule: to delete a rule, click the Delete Rule button. The rule will be deleted.

To add additional rules for an asset type, click the New Rule hyperlink. Additional fields will appear in the Create Locations Rules section.

Additional Create Locations

This section allows you to specify where the user account will be created based on a number of different sources and should only be used by advanced users.

The fields available in this section are as follows.

  • Additional Location Data Sources: this section allows you to select which source to use to create the asset. To add a new data source select Additional Create Locations from the Parameter list, select an option from the Source list and click Commit. Additional fields will appear in this section as shown in the figure below.

    The Additional Location Data Sources fields
    The Additional Location Data Sources fields

    Enter the required value into the fields provided and click Commit. The options that are available in the Source list include the following:
    • GET Variable Name: this option allows you to enter a GET parameter. For example, if you called the parameter create_in, the Account Manager Page can be called with a get string of ?create_in=123 to specify that the user account will be created as a child of asset 123. You can then create a hyperlink with this GET parameter to the Account Manager Page on another page in your Site. You can also pass through the type of link the asset should be created as. For example, if you use the get string of ?create_in=123-2, the user account will be created as a child of asset 123 and have a link type of TYPE_2.
    • POST Variable Name: this allows you to enter a POST parameter. When using this option you can also pass through the type of link to create the user account as. For example, if you want to create the asset under asset 145 and not show it in the menu, you can pass through 145-2. This will create the user account as a child of asset 145 and it will have a link type of TYPE_2.
    • SESSION Variable Name: this allows you to enter a SESSION parameter.
    • Current Asset: this allows you to set the create location according to the asset the user is viewing.
    • Current User: this allows you to set the create location to the user who is currently viewing the page. This can be a logged in user.
    • Current Site: this allows you to set the create location to the Site the user is currently viewing.
    • Set Value: this allows you to enter a static value.
    • Any Super Global: this allows you to enter a value for any of the major super global arrays. The SESSION, POST and GET variables will be checked in succession until a value is found.
    To delete a source, click the Delete box and click Commit. To add additional sources, use the lists provided in the Additional Location Data Sources section.
  • Default Link Type: select what type of link to create the user account as. This will only be used if the link type has not been specified in the Additional Location Data Sources section. The options that are available include TYPE_1, TYPE_2, TYPE_3 and NOTICE. For more information on each of these link types, refer to the Concepts manual.
  • Permitted Tree Locations: this field allows you to specify that the new user account will only be created in the specified location, if it is beneath a particular root asset. To add addition tree locations, click the More... button – an additional field will appear on the screen. To remove a tree location, click the Clear button and click Commit.
  • Permitted Asset Types: this field allows you to specify that the create location specified must be of a particular asset type, for example a User Group. You can select as many asset types as you want by clicking on the More... button. To delete an asset type from the list, click the Clear button and click Commit.

Required Attributes Screen

The Required Attributes screen allows you to select which fields are mandatory when the user is creating a user account.

From the list provided, select the attribute you want to make required and click Commit. Additional fields will appear, as shown in the figure below.

An attribute in the Required Attributes section of the Required Attributes screen
The Required Attributes for a User

Enter an error message to show the user if they have not filled in this field and click Commit. If you no longer want to make this attribute mandatory, click Delete and click Commit.

If you have selected to use email validation on the Details screen, the Username and Email will become mandatory and error messages will appear on the Required Attributes screen, as shown in the figure below.

Additional fields in the Required Attributes section of the Required Attributes screen
The Required Attributes section of the Required Attributes screen

You can change the error message that is shown for either field in the Error Text field. To add additional attributes to the required fields, select the attribute from the New required attribute list and click Commit.

Messages Screen

The Message screen allows you to change the messages that are shown to the user on the Account Manager Page.

Login

This section allows you to specify the messages to be displayed to the user on the Not Logged In Bodycopy if they are logging in.

The messages available are as follows:

  • Invite: enter a message to show to the users to invite them to log in. This will appear when the keyword replacement Login Invite is used. To edit the message, click on the edit icon icon – a WYSIWYG Editor will appear where you can edit the message. By default this message will be If you already have an account, sign in using the form below.
  • Error: enter a message to show to the user if they have entered an incorrect user name or password when they were trying to log in. This will appear when the keyword replacement Login Error Message is used. To edit the message, click on the edit icon icon – a WYSIWYG Editor will appear where you can edit the message. By default this message will be Incorrect username or password entered. Please try again.

Create Account

This section allows you to specify the messages to be displayed to the user on the Not Logged In Bodycopy when they are creating their user account.

The messages available are as follows:

  • Invite: enter a message to show to the users to invite them to create a user account. This will appear when the keyword replacement Create Asset Invite is used. To edit the message, click on the edit icon icon – a WYSIWYG Editor will appear where you can edit the message. By default this message will be Sign up for an account using the form below.
  • Error: enter a message to show to the user if the new user account cannot be created. This will appear when the keyword replacement Create Asset Error Message is used. To edit the message, click on the edit icon icon – a WYSIWYG Editor will appear where you can edit the message. By default this message will be Your account was not created. Ensure you have entered a username and password and try again.

Edit Your Details

This section allows you to specify the messages to be displayed to the user on the Logged In Bodycopy when they are editing their account details. 

The messages available are as follows:

  • Invite: enter a message to show to the user to invite them to edit their user account. This will appear when the keyword replacement Edit Details Invite is used. To edit the message, click on the edit icon icon – a WYSIWYG Editor will appear where you can edit the message. By default this message will be Edit your details using the form below.
  • Success: enter a message to show to the user once they have edited their account details. This will appear when the keyword replacement Edit Details Success Message is used. To edit the message, click on the edit icon icon – a WYSIWYG Editor will appear where you can edit the message. By default this message will be Your account details have been updated.
  • Lock Error: enter a message to show to the user if they cannot get the lock to edit their account details. This will appear when the keyword replacement Lock Error Message is used. To edit the message, click on the edit icon icon – a WYSIWYG Editor will appear where you can edit the message. By default this message will be Failed to acquire lock for editing. Your account details are displayed below.

Send Validation

This section allows you to specify the message to be displayed to the user when they are re-sending the validation email to themselves.  

The messages available are as follows:

  • Success: enter a message to show to the user when they have successfully resent the validation email. This will appear when the keyword replacement Resend Validation Success is used. To edit the message, click on the edit icon icon – a WYSIWYG Editor will appear where you can edit the message.
  • Error: enter a message to show to the user when they cannot resend the validation email. This will appear when the keyword replacement Resend Validation Error is used. To edit the message, click on the edit icon icon – a WYSIWYG Editor will appear where you can edit the message.

Pending Accounts Screen

If you have selected to use email validation on the Details screen, the Pending Accounts screen allows you to manage the user account that have not been verified by the user. The Validate Account section of the Pending Accounts screen is shown in the figure below.

The Validate Account section of the Pending Accounts screen
The Validation Account section of the Pending Accounts screen

A Pending User Account
A Pending User Account. By default, if no user accounts are awaiting validation, the Manually Validate list will be empty, as shown in the figure above. When a user account has been created and is awaiting validation, it will appear in the Pending Accounts User Group under the Account Manager Page in the Asset Map, as shown in the figure to the right. It will also be listed on this screen, as shown in the figure below.

A Pending Account in the Validate Account section
The Validation Account section of the Pending Accounts screen

For each user account listed, you can manually validate the account by clicking the Validate field and clicking Commit. This will move the user account from the Pending Accounts User Group into the correct location. If you want to delete the user account, click the Delete box and click Commit. This will permanently delete the user account from the system.

Not Logged In Bodycopy

The Not Logged In Bodycopy asset is used to define what to show the user when they are not logged in. This layout should invite users to login or allow them to create a user account for themselves. For example, for the Account Manager Page shown in the figure below, the form that allows the user to create an account and the login fields are being shown. This has been defined in the Not Logged In Bodycopy.

The default Not Logged In layout
An Account Manager Page (Not logged in)

To change what information is being shown, right click on the Not Logged In Bodycopy in the Asset Map and select Edit Contents. Click on the edit icon icon – the WYSIWYG Editor will appear where you can use keyword replacements and formatting to layout the information to show on the page. By default, the information shown in the figure below will appear in the WYSIWYG Editor.

The WYSIWYG Editor on the Not Logged In Bodycopy
The WYSIWYG Editor on the Not Logged In Bodycopy

Keyword Replacements on the Not Logged In Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor toolbar on the Edit Contents screen of the Not Logged In Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for each asset in the list. The standard keyword replacements that are available include the following:

  • Login Invite: this will show the Login Invite message that has been defined on the Messages screen.
  • Login Form: this will show the login form with a username and password field.
  • Login Error Message: this will show the Login Error message that has been defined on the Messages screen.
  • Create Asset Invite: this will show the Create Account Invite message that has been defined on the Messages screen.
  • Create Asset Form: this will show the form where the user can create their user account.
  • Create Asset Error Message: this will show the Create Account Error message that has been defined on the Messages screen.
  • Resend Validation Error: this will show the Send Validation Success message that has been defined on the Messages screen. You should include this keyword replacement if you are using email validation.
  • Resend Validation Form: this will show the form that will allow the user to resend the validation email to themselves. You should include this keyword replacement if you are using email validation.
  • Resend Validation Success: this will show the Send Validation Error message that has been defined on the Messages screen. You should include this keyword replacement if you are using email validation.

Customising the Create Form Layout

On the Account Manager Page, you can change the layout of the create form. By default, when you add a user account, the default create form that is seen in the Administration Interface is used, as shown in the figure below.

The default Not Logged In layout
An Account Manager Page (Create form)

To create a customisation, go to the Details screen of the Account Manager Page. Click the Create Form Customisation option and click Commit. A Layout asset will be added under the Account Manager Page in the Asset Map, as shown in the example below.

The User Create Form Layout asset
The Create Form Layout asset. If you would like to change this layout, add attribute fields or add metadata fields you can do so by customising the create form.

To change what information is being shown, right click on the Layout asset in the Asset Map and select Edit Contents. Click on the edit icon icon – the WYSIWYG Editor will appear where you can use keyword replacements and formatting to layout the information to show on the page. An example layout is shown in the figure below.

The WYSIWYG Editor on the User Create Form Layout Bodycopy
The WYSIWYG Editor on the User Create Form Layout

This layout includes the Username field, Password field, the password rules, Email field and the Date of Birth metadata field. When a user creates a user account, the fields shown in the figure below will be shown instead of the default create form.

The new layout of the Create Form
The new layout of the User Create Form

Keyword Replacements on the Layout Assets

To find out what keyword replacements you can use on the Layout asset, click on a list of specific asset keywords available for use in Simple Edit Mode hyperlink on the Edit Contents screen. A pop up will appear as shown in the figure below.

The Keyword Replacement pop-up
The keyword replacement pop-up

Select the User asset type in the list provided and click Get Simple Edit Keywords. The list of available keyword replacements will appear, as shown in the figure below.

Keywords for the User asset type on the Keyword Replacement pop-up
The keyword replacement pop-up displaying the User Keyword List

Copy the keyword replacements you want to use and paste them into the WYSIWYG Editor.

Keyword Replacement for the Commit Button

In addition to the keyword replacements for each field, you need to add the Commit button otherwise the user will not be able to submit their information so the user account can be created. This keyword replacement is %commit_button%.

Keyword Replacement for Metadata Fields

If you have selected a Metadata Schema to apply to the assets in the Metadata Schemas to Apply field on the Details screen, you can change the layout of the fields by using the metadata field keyword replacement. This keyword replacement has the format %metadata-F_<fieldid>% where <fieldid> is the asset ID of the metadata field. For example, in the layout that was created above, the keyword replacement %metadata-F_676% was used to show the Description field from the Metadata Schema.

Created but not live Bodycopy

The Created but not live Bodycopy is used when email validation is not being used and defines the layout once a user account has been created with the Status of Under Construction. This layout should inform the user that their account has been created but will not be active. For example, for the Account Manager Page shown in the figure below, a message is shown informing the user that their account has been created but it is not active. This has been defined in the Created but not live Bodycopy.

The default Created, not Live layout
An Account Manager Page (Created but not live)

To change what information is being shown, right click on the Created but not live Bodycopy in the Asset Map and select Edit Contents. Click on the edit icon icon – the WYSIWYG Editor will appear where you can use keyword replacements and formatting to layout the information to show on the page. By default, the information shown in the figure below will appear in the WYSIWYG Editor.

The WYSIWYG Editor on the Created, not Live Bodycopy
The WYSIWYG Editor on the Created but not live Bodycopy

Keyword Replacements on the Created but not live Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor toolbar on the Edit Contents screen of the Created but not live Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for each asset in the list. The standard keyword replacements that are available include the following:

  • Created Asset ID: this will show the ID of the user account that has been created.
  • Created Asset Name: this will show the first and last name of the user account that was created.
  • Created Asset Short Name: this will show the first and last name of the user account that was created.
  • Created Asset URL: this will show the URL of the user account that has been created.
  • Created Asset Simple Edit URL: this will show the URL of the user account that will take the user to the Simple Edit Interface.
  • Created Asset Admin Interface URL: this will show the URL of the user account that will take the user to the Administration Interface.
  • Created Account Invite: this will show the Create Account Invite message that has been defined on the Messages screen.
  • Create Account Form: this will show the form where the users can create their user account.
  • Create Account Error Message: this will show the Create Account Error message that has been defined on the Messages screen.
  • Resend Validation Form: this will show the form that will allow the user to resend the validation email to themselves. You should include this keyword replacement if you are using email validation.

Created, live Bodycopy

The Created, live Bodycopy is used when email validation is not being used and defines the layout once a user account has been created with the Status of Live. This layout should inform the user that their account has been created and its active. For example, for the Account Manager Page shown in the figure on the following, a message is shown informing the user that their account has been created and they are able to login. This has been defined in the Created, live Bodycopy.

The default Created, Live layout
An Account Manager Page (Created, live Bodycopy)

To change what information is being shown, right click on the Created, live Bodycopy in the Asset Map and select Edit Contents. Click on the edit icon icon – the WYSIWYG Editor will appear where you can use keyword replacements and formatting to layout the information to show on the page. By default, the information shown in the figure below will appear in the WYSIWYG Editor.

The WYSIWYG Editor on the Created, Live Bodycopy
The WYSIWYG Editor on the Created, live Bodycopy

Keyword Replacements on the Created, live Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor toolbar on the Edit Contents screen of the Created, live Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for each asset in the list. The standard keyword replacements that are available include the following:

  • Created Asset ID: this will show the ID of the user account that has been created.
  • Created Asset Name: this will show the first and last name of the user account that was created.
  • Created Asset Short Name: this will show the first and last name of the user account that was created.
  • Created Asset URL: this will show the URL of the user account that has been created.
  • Created Asset Simple Edit URL: this will show the URL of the user account that will take the user to the Simple Edit Interface.
  • Created Asset Admin Interface URL: this will show the URL of the user account that will take the user to the Administration Interface.
  • Created Account Invite: this will show the Create Account Invite message that has been defined on the Messages screen.
  • Create Account Form: this will show the form where the users can create their user account.
  • Create Account Error Message: this will show the Create Account Error message that has been defined on the Messages screen.
  • Resend Validation Form: this will show the form that will allow the user to resend the validation email to themselves. You should include this keyword replacement if you are using email validation.

Logged In Bodycopy

The Logged In Bodycopy is used to define what to show the user when they log into the system. This layout should allow users to update their account details. For example, for the Account Manager Page shown in the figure below, the user can edit their details. This has been defined in the Logged In Bodycopy.

The default Logged In layout
An Account Manager Page (Logged in)

To change what information is being shown, right click on the Logged In Bodycopy in the Asset Map and select Edit Contents. Click on the edit icon icon – the WYSIWYG Editor will appear where you can use keyword replacements and formatting to layout the information to show on the page. By default, the information shown in the figure below will appear in the WYSIWYG Editor.

The WYSIWYG Editor on the Logged In Bodycopy
The WYSIWYG Editor on the Logged In Bodycopy

Keyword Replacements on the Logged In Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor toolbar on the Edit Contents screen of the Logged In Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for each asset in the list. The standard keyword replacements that are available include the following:

  • Create Asset Invite: this will show the Create Account Invite message that has been defined on the Messages screen. You should include this keyword replacement if you have set Enter Simple Edit mode to No.
  • Create Asset Form: this will show the form where the user can create their user account. You should include this keyword replacement if you have set Enter Simple Edit mode to No.
  • Create Asset Error Message: this will show the Create Account Error message that has been defined on the Messages screen. You should include this keyword replacement if you have set Enter Simple Edit mode to No.
  • Edit Details Invite: this will show the Edit Your Details Invite message that has been defined on the Messages screen.
  • Edit Details Form: this will show the form where the user can edit their account details.
  • Edit Details Success Message: this will show the Edit Your Details Success message that has been defined on the Messages screen.
  • Lock Error Message: this will show the Edit Your Details Lock Error message that has been defined on the Messages screen.
  • Logout Form: this will show a button that allows the user to logout of the Site.

Created, awaiting validation Bodycopy

The Created, awaiting validation Bodycopy is used when email validation is being used and defines the layout once a user account has been created. It should inform the user that an email has been sent to their email address with further instructions. For example, for the Account Manager Page shown in the figure below, a message is shown informing the user that their account has been created and it needs to be verified. This has been defined in the Created, awaiting validation Bodycopy.

The default Created, Awaiting Validation layout
An Account Manager Page (Created, awaiting validation)

To change what information is being shown, right click on the Created, awaiting validationBodycopy in the Asset Map and select Edit Contents. Click on the edit icon icon – the WYSIWYG Editor will appear where you can use keyword replacements and formatting to layout the information to show on the page.

Keyword Replacements on the Created, awaiting validation Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor toolbar on the Edit Contents screen of the Created, awaiting validation Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for each asset in the list. The standard keyword replacements are the same as those that are available for the Created but not live Bodycopy.

Validated Bodycopy

The Validated Bodycopy is used when email validation is being used and defines the layout once the user has verified their account. They will see this layout when they click on the URL within the email. For example, for the Account Manager Page shown in the figure below, a message is shown informing the user that their account has been created and they are able to login. This has been defined in the ValidatedBodycopy.

The default Validated layout
An Account Manager Page (Validated)

Keyword Replacements on the Validated Bodycopy

A list of keyword replacements is provided in the WYSIWYG Editor toolbar on the Edit Contents screen of the Validated Bodycopy. You can use these keyword replacements in conjunction with text, images and links etc to layout what to show for each asset in the list. The standard keyword replacements are the same as those that are available for the Created but not live Bodycopy.


Next Chapter

The Latest

Let Us Know What You Think

Let us know if you spot any errors or if you have any ideas on how we can improve the Matrix Community Website.

Contact Squiz for Demo

Let us show you the true power of Squiz Matrix by giving you a personalised demonstration.