Page tree
Skip to end of metadata
Go to start of metadata

Overview

Roles are used to customise the site for a group of users. Typically, a site will have several roles set up for certain functions within the site, e.g. Administrator Role, B2B Role, B2C Role, Public Role, Accounts Role, and so forth.

When a user first hits the site, they will use the default role; once they have logged in (or registered), they will then be using the corresponding role.

This page is intended for use by CSS Administrators on classic (non-BPD) sites. It provides an overview of the Role function, as well as a guide to maintaining them in CSS.

What is a role?

A Role is the equivalent of an access level within the site. Each role can be thought of as a sub-site or access area of the site. A role can be configured so that it displays its own home page, utilises a unique menu structure, has its own colour theme, and presents differently from the default site settings and other roles on the site. Settings at role level will override any corresponding system-wide settings (such as the columns displayed in the order grid); many settings can be defined at the global/system level, but then customised for a certain role.

Example: The Order Grid Columns are set system-wide to be: Product Code, Description, Price, Quantity, Extended Price. 
A B2B role is then set up with the Order Grid Columns as: Product Code, Description, Cost Centre, Price, Quantity, Extended Price.

The order grid on all roles will be shown as defined at the system level except the B2B role where the setting is overridden. Most system-wide settings can be overridden with a role setting. Some role settings can also be overridden at the customer or user level. Users can be assigned multiple roles and once logged in, the user can switch between roles depending on what functionality they require.

Step-by-step guides

To Create a New Role:

  1. Login as an Administrator
  2. Navigate to 'Accounts' --> 'Role Management' (/zRoles.aspx).
  3. Click the 'Role Details' tab.
  4. Click 'New' to create a new role.
  5. Populate the fields as specified below.
  6. Click 'OK' to save or 'Cancel' to discard.

 

Good to Know

  • When creating a new role, if any fields/settings are not populated, they will be ignored and the system default setting will be used.
  • Some settings are overridden at the user or customer level. If a role setting has been updated and is not being reflected on the website, check that there are no overriding user or customer settings.


To Copy a Role:

  1. Login as an Administrator. 
  2. Navigate to 'Accounts' --> 'Role Management' (/zRoles.aspx).
  3. Select the required role via radio button; the 'Role Details' tab will load. 
  4. Click 'Copy'.
  5. Assign the new role a unique name in the 'Role Name' field.
  6. Set the value for the 'Home Page' field (this is the default landing page if the role is public and will be the site's default role). 
    1. Click on the .. box to the right of the field.
    2. Search for the template name and select a template from the results.
    3. Alternatively, type in the template's name.
  7. Set the value for the 'Home Page After Login' field (this is the default landing page for users logging in under that role).
    1. Click on the .. box to the right of the field.
    2. Search for the template name and select a template from the results.
    3. Alternatively, type in the template's name.
  8. Set the value for any other required fields on the 'Role Details', 'Functions', 'Navigation', 'Sorting' or 'Templates' tabs.
  9.  Click 'OK' to save.

 

Good to Know

When copying a role, all settings will be identical to the original role except for the Role Name and ID. Copying a role is useful when a similar role is required, where only a few settings need be changed.


To Edit a Role:

  1. Login as an Administrator. 
  2. Navigate to 'Accounts' --> 'Role Management' (/zRoles.aspx).
  3. Select the required role via radio button; the 'Role Details' tab will load.
  4. Click 'Modify'.
  5. Update the details as required.
  6. Click 'OK' to save.

 

To Delete a Role:

  1. Login as an Administrator. 
  2. Navigate to 'Accounts' --> 'Role Management' (/zRoles.aspx).
  3. Select the required role via radio button; the 'Role Details' tab will load.
  4. Click 'Delete'.
  5. On the confirmation pop-up, click 'OK' to proceed with the deletion, or 'Cancel' to leave the role as is.

Role Settings

Note: The following table doesn't cover all role-based settings.

Setting

Description

Role Name

The name of the role. For sites pre-version 3.75, this is what is shown to the user in the list when they are choosing between roles.

Description

A friendly description of the role to assist in identifying them. This is displayed to the end user in sites running version 3.75 and later.

Default Customer Code

The default customer code assigned to a user on this role. Applies to Public user roles only.

Is B2C

Indicates whether this role is for B2C (General public), or B2B (Registered Users associated with an account code).

System Default Role

One of the roles must be set up as the default for the site. This is the role that is used when a user first accesses the site. This role may consist of only a very cut down version of the website where there's only a home page, 
login page, information page and contact us page.


To Nominate a Role as the Site Default:

  1. Login as an Administrator. 
  2. Navigate to 'Settings' (/zSettings.aspx).
  3. Set the value of the field labelled 'Role for Casual Users' using the drop-down list.
  4. Click the 'Update' button at the bottom of the page to save changes.

User Roles

A User is assigned a default role, which is what the user operates on after login. If a user has multiple roles assigned, they can switch between them once logged in.


To Assign a Role to a User:

  1. Login as an Administrator

  2. Navigate to 'Accounts' --> 'User Maintenance' (/zUsers.aspx).
  3. Search fore the required user.
  4. Select the user record via radio button.
  5. Click 'Modify'.
  6. Set the value of the field labelled 'Initial Role After Login' by selecting a role from the drop-down list.
  7. Click 'OK' to save changes.

 

 

 

Additional Information

This page is intended for use by CSS Administrators on classic (non-BPD) sites. It provides an overview of the Role function, as well as a guide to maintaining them in CSS.

Minimum Version Requirements

**.**.**

Prerequisites

--

Self Configurable

Yes

Business Function

BPD Structure

BPD Only?

no

B2B/B2C/Both

Both

Ballpark Hours From CV (if opting for CV to complete self config component)

Contact CV Support

Ballpark Hours From CV (in addition to any self config required)

Contact CV Support

Third Party Costs

n/a

CMS Category

 CMS Category