Ektron 9.00
Managing Users and User Groups
NOTE: Only members of the Administrators User Group and those defined in the Manage Members for Role: User Admin screen can view, add, or edit users and user groups.
Users are people who administer the website, create content, or publish content. Without users, the website would be blank. In Ektron, you can add, edit, and delete users to and from the application through the Settings folder in the Workarea.
Every Ektron user belongs to a User Group. When you create a user, the user is added to the Everyone group by default. User groups are used when creating permissions and an approval chain for content folders. User groups can be departments in your company (Human Resources, Sales, Engineering) or indicate a user’s role (Publishers, Administrators, Editors, and so on).
All user and user group information is accessible from the Workarea.
To access the user folder in Ektron, navigate to Workarea > Settings > Users. The View Users screen appears. From this screen, you can add, edit, and delete users.
To access the user group folder in Ektron, navigate to Workarea > Settings > User Groups. The View User Groups screen appears. From this screen, you can add, edit, and delete user groups.
IMPORTANT: This chapter only applies to systems that do not use Active Directory Integration. If your system uses the Active Directory Integration Feature, see Using Active Directory with Ektron to learn about user management functions. If your system uses LDAPLightweight Directory Access Protocol; permits access to distributed information. Authentication, see Using LDAP with Ektron.
Before you can assign a user to a user group, you must add the user to the system.
NOTE: To learn about the lock and unlock buttons ( ), see Account Locked (below). The buttons provide a shortcut to that field for users with a check in the box to the left of their name.
—Editable by a non-administrator user. Non-admin users can edit their own profiles only, and only fields indicated.
General Tab (tabs only appear when editing)
NOTE: The Display Name cannot be blank.
The drop-down list is derived from the Language Settings screen, available from the Settings > Configuration folder.
Do not confuse the system language with the user’s ability to create and edit foreign editions of content. This field does not prevent a user from working with multiple language content.
See Also: Working with Multi-Language Content
NOTE: If the selected language is not English, French or German, it is only supported after you download the Ektron Language Support Program from Ektron and translate the website.
ek_EditControlWin
(for Windows computers) or ek_EditControlMac
(for Macintosh computers) property to UserPreferred
, you may choose an editor. Otherwise, the default editor appears, and you cannot change it.Insert a Web path to the image. For example: http://www.example.com/smileyface.gif
. Alternatively, you can click Upload to browse to a file on your network.
By default, an avatar's maximum size is 200 kilobytes, and its height and width are reduced 125 pixels, preserving the aspect ratio. To change the file size limit, edit Siteroot\Workarea\Upload.aspx.vb. In this file, change the line shown below to the maximum file size.
If (numFileSize > 200) Then
To change the avatar's default height and width, edit Siteroot\App_Code\VBCode\Utilities.vb
. In this file, change the following lines to the desired size.
Dim Width As Integer = 125 Dim Height As Integer = 125
Custom Properties Tab
If email notification is turned off in the setup page, you are notified when editing, adding, or viewing a user.
NOTE: Contact Ektron Sales for pricing of adding more users to your license.
After adding a user, you can view that information. While viewing a user, you can edit or delete the user.
NOTE: If you are using Active Directory to edit a user, see Adding and Maintaining User Information.
When editing a user, you can change the fields set when adding the user, such as username, first name, last name, password, user language, and email address. Also, while editing, you can change fields that were not available when the user was created.
—Editable by a non-administrator user. Non-admin users can edit their own profiles only, and only fields indicated.
General Tab
Workarea Tab
Custom Tab (same as when adding a user)
Activities Tab
If you disable Notifications, the Activities tab (which lets the user pick Notifications to receive and send) disappears.
For Developers:Ektron has created a UserGroupPreferences user control. If you add the control to a community group’s profile page, users can specify notification preferences for individual groups. This control is installed with Ektron and is located in:
[Drive:]\webroot\siteroot\Workarea\Notifications\Controls
NOTE: If you are using Active Directory to delete a user, see Maintaining AD User Information.
When you need to remove a user from the application, you can easily do it from the User’s Folder in the Workarea.
WARNING! When a user is deleted from the database, the user is permanently deleted. The process cannot be undone.
NOTE: If you are using Active Directory to remove a user from a group, see Maintaining AD User Group Information.
Removing a user from a user group does not delete the user from Ektron. Also, you cannot remove users from the Everyone group.
NOTE: If you are using Active Directory to manage user groups, see Setting Up Active Directory Integration Mode.
Every Ektron user belongs to at least one User Group. User groups are used when creating permissions and an approval chain for content folders.
NOTE: If you are using Active Directory to create a new user group, see Importing AD User Group Information .
NOTE: If you are using Active Directory to assign a user to a user group, see Importing a User’s AD Group Information to Ektron.
When you create a user group, no user is initially assigned to it. To add a user to a user group:
When editing a User Group, you can only change its name.
NOTE: You cannot edit the default Administrators and Everyone user groups.
NOTE: If you are using Active Directory to delete a user group, see Maintaining AD User Group Information.
When you do not need a User Group anymore, you can delete it from the system.
NOTE: You cannot delete the Administrator and Everyone groups.
NOTE: If you are using Active Directory to remove a user from a group, see Maintaining AD User Group Information.
Removing a user from a user group does not delete the user from Ektron. Also, you cannot remove users from the Everyone group.
Prerequisite
Only members of the Administrators Group can work with Custom User Properties.
Custom User Properties let you create custom fields that collect user information beyond the standard Ektron properties. Examples include employee ID, phone number, start date, position, department, and IP address. Custom fields appear on the User Properties and Membership User Properties screens on the Custom tab, and on the Membership server controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified..
Use the View Custom Properties screen (Settings > Configuration > Custom Properties) to create custom properties for users and membership users. From the View Custom Properties screen, you can:
From the View Custom User Properties screen, you can view the custom users properties by languages.
NOTE: If there is only an English version of the property, the English version appears in all the languages.
All custom user properties, in languages other than English, are tied to the English version of the property. If you delete the English version of the property, all other language versions of the properties are deleted.
To view the custom user properties by language:
NOTE: The Title and Label are the same field. On some screens the word Title is used, on others the word Label is used.
Use a SelectList field to present the user completing the User Information or Membership User Properties screen with a list of choices.
When you create a custom user property and specify its type to be Select List, the screen changes, allowing you to add, change, or remove list entries.
To add an item to the list, enter its text in the Text field, then click Add . Added items then appear in the larger box on the left. You can then:
You can use the first list item to prompt the user to make a selection instead of being a valid response. For example, the first list item may say Select from a list of choices. To do this, check the First item is not a valid selection for example, “[Select]” check box.
If this option is selected, the field has an asterisk (*) next to it (indicating it is required) on the User Information and Membership User Properties screens. The user completing the screen must choose any selection other than the first item. If he tries to file the screen without choosing a different item, the following error message appears: Please fill in all required fields (*)
Use a MultiSelectList field to present the user completing the User Information or Membership User Properties screen with a list of choices. The user can choose as many responses as appropriate.
Selected items are indicated by a blue background.
When you create a custom user property and specify its type to be MultiSelect List, the screen changes.
For information about completing the screen, see Completing a SelectList Field Entry.
mm/dd/yyyy
. Use with String and Date.username@domain.domainextention
.nnnn nnnn nnnn nnnn
nnn-nn-nnnn
. (String)nnnnn
Numeric) or 9 digits (String)separated by a dash after the fifth (nnnnn-nnnn
).NOTE: If you use the Numeric Type, you cannot have a dash or space when using a 9 digit Zip Code
nnn-nnn-nnnn
.xnx nxn
) alpha or numeric characters (String) with a space after the first 3 characters.HH:MM—
Hours and Minutes 09:30HH:MM:SS—
Hours, Minutes and Seconds 09:30:45HH:MM:SS.mm
—Hours, Minutes, Seconds and milliseconds 09:30:45.002nnn nnn nnn
). (String)This field is automatically included on the User or Member profile Custom Tab to let the profile owner edit events on a Web calendar. When this is checked, it cannot be unchecked. For more information about Web Calendar, see Adding System Calendar Events.
This field is automatically included on the User or Member profile Custom tab. It lets the profile owner determine which other users can see the owner's community activities. For example, Using the ActivityStream Widget on a PageBuilder Page explains how this setting affects other users' ability to see your activities.
The Private Profile field value also determines if a user's profile is visible on a forum. See Also: Managing a Discussion Board on Your Website
When a Micro-message server control is placed on a page in TimeLine mode, micro-messages only appear for users whose Private Profile setting is set to Public. See Also: Server Control Reference
The Time Zone property field is a special field used by the Web Calendar feature.
Select the time zone of the User or Member here. When they are logged in, appointment times will show in this time zone. For more information, See Also: Adding System Calendar Events.
Click a custom user property’s title to display the Edit Custom Property Screen. From this screen, you can edit and delete a custom property or create a version of the custom property in a non-English language. When you edit a custom user property, the changes are applied to all users and membership users when the Save button is clicked. These changes are also applied to any other language versions of the custom user properties that exist.
NOTE: You cannot edit the Type field. If you need to change the type, you must delete the custom user property and create a new one.
WARNING! If you delete a custom user property, it is removed from all users and membership users. Any information that has been collected about users and membership users for that property will be lost. In addition, any language versions of the custom user property are deleted.
If you delete a custom user property, it is removed from all users and membership users. Any information that has been collected about users and membership users for that property will be lost. In addition, any language versions of the custom user property are deleted.
Like content, custom user properties have a language attribute. This is useful if you have users or membership users that only use a specific language. It can also be used if you want a custom user property to appear in the language in which the user is signed in.
Unless a language other than English is defined for a custom user property, the property defaults to the English version. For example, if you have 2 properties called Birthday and Phone Number in English and you can translate the French version of Birthday to Anniversaire, when you view the properties in French, you see the English version of Phone Number and the French version of Birthday.
When creating a custom user property, it must be created in English then translated to the desired language. This is done by editing the property, changing languages, filling out the Translate Custom Property Label screen and saving the property.
WARNING! All custom user properties in languages other than English are tied to the English version of the property. If you delete the English version of the property, all other language versions of the properties are deleted also. However, you can remove a non-English language version of the custom properties without deleting the English version. See Removing a Non-English Custom User Property Title
To translate the Title/Label of a property into French.
Removing a non-English version of a custom user property title does not remove the English version of the property. When you remove the non-English version of a property, you are basically removing the label for that specific language in the custom property.
WARNING! Do not click the delete button on the Edit Custom Property screen. This action deletes the English version of the custom user property. If you click the delete button, you lose all information collected by the property and all language versions of the property.
Ektron contains an Administrators User Group. Any user who is a member of that group automatically has full administrator privileges. The Roles feature lets you assign limited or specific administrator privileges to users who do not require full administrator privileges. For example, you can let certain users create, redirect, or remove tasks but deny them other privileges normally granted to administrators.
The Permissions Table lets you control which users can manage a folder’s properties, its content, library items, and create or edit collectionA list of Ektron content links for display on a Web page.s. (See Also: Managing Folder and Content Permissions) Together, the Roles feature and the Permission Table enable you to assign administrative privileges to users who are not members of the Administrators group.
Best Practice
When creating new user groups to use with roles, assign names as a mnemonic aid for the role, especially for folder-specific rules. For example, the Marketing Folder Admins user group could be used for all role members who administer the marketing folder.
Use the Roles screens to assign limited administrator privileges. To access the Roles screens, go to Workarea > Settings > Roles > Built-In > Folder Specific or System-Wide.
NOTE: In the Roles screens, you can select users or groups. However, you cannot select the Administrators group, because that group already has full permissions.
To view all roles assigned to any user, go to Workarea > Settings > Users. Then, select a user and click the Roles tab.
When setting up users and groups for administrative access over folders, keep these guidelines in mind.
View and edit folder properties. These users can update properties, permissions, the approval chain, metadata, Web alerts, purge history, and so on. For example, create a user group and give it permission to manage the top-level marketing folder. Group members can do everything to that folder and its subfolders, but cannot manage other folders.See Also: Creating a Custom Permissions Role and Setting Folder Properties.
Move or copy content. An Ektron best practice is to create a User Group for this purpose, then assign the group to this role. You should not assign the role to individual users. After assigning the User Group here, go to the folders whose content these users will be allowed to move or copy, and assign to that User Group at least Read Only and Traverse permissions. See Also: Managing Folder and Content Permissions and Moving or Copying Content.
Perform all URL Aliasing functions. See Creating User-Friendly URLs with Aliasing
Perform all functions related to URL Aliasing except viewing and editing the URL Aliasing Setting screen and Editing aliasing rules.
Can view:
Create or edit business rules and rule sets. See Creating Business Rules for Your Website.
Create, edit and delete collectionA list of Ektron content links for display on a Web page.s and menus via the Content tab.
NOTE: To manage permissions for creating collections and menus via the folder’s New > Collection or New> Menu option, use folder permissions. See Also: Managing Folder and Content Permissions
See Working with Collections and Creating Menus for Your Website.
Create, edit and delete collectionA list of Ektron content links for display on a Web page.s via the Content tab.
NOTE: To manage permissions for creating collections via the folder’s New > Collection option, use folder permissions. See Also: Managing Folder and Content Permissions
If approval is required for a collectionA list of Ektron content links for display on a Web page., approve changes to it, including the deletion of a collection. See Setting Up Collection Approval .
Use the eCommerce feature from the Workarea. See Conducting eCommerce.
Perform the following community activities:
See Sending Notifications to a Community and Micro-messaging.
Create, edit and delete and manage all community groups. These users have the same privileges as the group Administrator and members of the Administrators group. See Managing Community Groups.
Create and manage community groups. A user with this role can only manage community groups she or he has created. See Managing Community Groups.
Create and manage DxH connections via the Workarea > Settings > Digital Experience Hub > Connect to DxH screen.
Import and update DxH content into Ektron folders.
Create and edit PageBuilder Master Layouts. See Creating a PageBuilder Master Layout.
Create, edit and delete Menus via the Content tab.
NOTE: To manage permissions for creating menus via the folder’s New> Menu option, use folder permissions. See Also: Managing Folder and Content Permissions
See Creating Menus for Your Website
Manage membership users and membership user groups. Member admin role members cannot work with Ektron users. Users assigned to this role can create, edit, and delete membership users and groups through the following screen.
See Also: Membership Users and Groups; Membership Groups
Approve pending comments or delete existing comments on a message board. See Who Can Moderate Message Board?
View, create and edit metadata definitions. See Working with Metadata.
Perform multivariate testing. Setting up a Multivariate Experiment.
Create and edit Synonym Sets, Suggested Results, Integrated Search Mappings, and the Search Status screen. See Providing Suggested Results, Using Synonym Sets, Including External Files in Your Search.
Create and edit Smart Forman Ektron-defined Web page that contains XML (hidden from the end user) to display content, and receive, verify, and save user input.s. See Working with Smart Forms.
Access the Workarea > Settings > Configuration > Synchronization screen, which lets the user perform all synchronization activities, such as:
See Synchronizing Servers Using eSync.
See Synchronizing Servers Using eSync.
Create tasks. See Creating a Task.
Delete tasks. See Deleting a Task.
Redirect tasks. See Assigning and Managing Tasks.
Create and manage taxonomiesa content-level categorization system that uses one-to-many relationships to create a scalable organization of content. A taxonomy lets you create a navigation system that is independent of the folder structure.. See Organizing Content with Taxonomies .
View, create, update, and delete system templates. See Working with Templates.
Change the translation status of content. See Marking Translation Statuses.
Create, view, edit, and delete users and user groups. See Managing Users and User Groups.
Use the Language Xport feature, which copies content into XLIFF files that can be submitted to a translation agency. Can change the translation status of content. See Exporting Content to XLIFF and Marking Translation Statuses.
Update widgets and edit their title, label, and parameters.
The custom permissions role lets your Web developer create a site page, and then extend or restrict access to that page’s content (or areas with a page) to users assigned to a custom role.
Items you could show and hide could be as simple as a content block. But they could be more complicated, such as displaying buttons and fields for one user group, and something completely different for another.
Custom roles have no effect inside the workarea.
The API provides 2 methods that determine if the current user is logged in, and if he is a member of the Administrators group. The methods let you test customizable roles with conditions outside the standard Is-Logged-In / Is-Admin tests. API methods are listed below.
GetRolePermissionSystem(RoleName
As String, nUserId As Long)
is a Boolean value indicating if the user belongs to the system-wide custom role.
GetRolePermissionFolder(RoleName
As String, nFolderId As Long, nUserId As Long)
is a Boolean value indicating if the user belongs to the custom role for the given folder.
Administrator privileges include access to the screens that appear when you select Settings > Configuration.
Administrators can also