Project WebSynergy Milestone 4 Administration Guide

Chapter 4 Administering Roles and Permissions

Roles and permissions can be administered by using portlets such as the Enterprise Admin Portlet and Communities Portlet. Alternatively, you can use the Control Panel to administer roles and permissions. The admin user needs to administer roles and permissions for the resources he need to manage to build a site.

Portlets for Administering Roles and Permissions

The admin user can use the Control Panel to set roles and permissions for users, user groups, communities, and organizations. Also, the Enterprise Admin portlet and Communities are the most helpful in administering roles and permissions.

Using the Control Panel to Administer Roles and Permissions

The admin user can use the Control Panel to administer roles and permissions.

ProcedureTo use the Control Panel to Administer Roles and Permissions

  1. Login to Project WebSynergy as Admin user.

  2. Choose Control Panel from the welcome menu.

    Figure 4–1 Choosing Control Panel from the welcome menu

    Welcome menu – Control Panel

    The Control Panel page appears.

    Figure 4–2 The Control Panel

    To use the Control Panel

  3. To view and make changes to an item, choose an item from the left menu.

    For example, click Users under Portal. From this page, you can set roles and permissions for users. Similarly, you can set roles and permissions for Organizations, Communities, and User Groups.

    Figure 4–3 Using the Control Panel

    To use the Control Panel

Using Administrative Portlets of WebSynergy

The Enterprise Admin portlet is used for most administrative tasks. This portlet has an interface for the creation and maintenance of the following:

Additionally, it allows you to configure many server settings, including:

You need to use the Enterprise Admin portlet to create your portal structure, implement security, and administer users. Only the users with the Administrator role has permission to add the Enterprise Admin portlet to a page.

WebSynergy Portal Resources

The following is a brief overview of concepts which WebSynergy uses to organize a portal and to add and maintain user resources.

  1. Portals are accessed by Users.

  2. Users can be collected into User Groups.

  3. Users can belong to Organizations.

  4. Organizations can be grouped into hierarchies.

  5. Users, Groups, and Organizations can belong to Communities that have a common interest.

The simplest way to think about this is that you have users and various ways those users can be grouped together. Some of these groupings follow an administratively organized hierarchy, and other groupings may be done by the users themselves (such as different users from multiple organizations starting a community called 'Dog Lovers' that has a common interest in dogs). And other groupings may be done administratively via User Groups or Roles for other functions that may cut across the portal (such as a Message Board Administrators group made up of users from multiple communities and organizations, allowing those users to administer any message board in the portal).

This way of organizing portal concepts may be illustrated in the following manner:

Figure 4–4 WebSynergy Portal Resources

WebSynergy Portal Resources

In the illustration above, each arrow may be read using the words “can be a member of”. So this means that Organizations can be members of Communities, Communities can be members of Roles, Users can be members of anything, and so on. Though this seems very complex, it provides a powerful mechanism for portal administrators to configure portal resources and security in a consistent and robust manner.

User Groups

User Groups are arbitrary groupings of users. These groups are created by portal administrators to group users who do not have an obvious organizational or community-based attribute or aspect that brings them together. Groups can have permissions, much like roles. You would therefore use a User Group to grant permissions to any arbitrary list of users.

For example, a User Group called “People Who Have Access to My Stuff” could be created, and permission to a particular Document Library folder could be granted to that User Group. This list of users could be members of separate Organizations, Communities, or Roles, who happen to also have access to this 'Document Library' folder which is on some personal, community, or organization page that is accessible to them in the portal.

Defining User Groups

To be done.

ProcedureTo Create a User Group

  1. Login to WebSynergy as Admin user.

  2. Click 'Add Applications' from the welcome menu.

    Figure 4–5 Adding Enterprise Admin portlet to the portlet page

    This figure illustrates adding Enterprise Admin portlet
to the portlet page.

  3. Click Add' against the 'Enterprise Admin' portlet.

  4. Click on 'User Groups'.

  5. Click 'Add'.

  6. Specify a name and a description for the group and click Save.

Assigning Users to User Groups

To be done.

ProcedureTo Assign Users to User Groups

  1. Login to WebSynergy as Admin user.

  2. Click 'Add Applications' from the welcome menu.

  3. Click 'Add' against the 'Enterprise Admin' portlet.

  4. Click on 'User Groups'.

  5. Click 'Actions' button corresponding to a user group and select 'Assign Members' from the menu.

    This page allows making assignments to the user group.

  6. Choose the 'Available' tab to view the list of all available members.

  7. Select the users who you are needed in the user group and click 'Update Associations'.

  8. Choose the 'Current' tab to verify updated associations to the user group.

Communities

Communities are collections of Users who have a common interest. WebSynergy's default pages are in the 'Guest' community, because everyone-whether they are anonymous or members of the portal has common interest in the default public pages of your site.

There are three types of Communities:

An Open Community (the default) allows portal users to join and leave the Community whenever they want to, provided they have access to a Communities portlet from which to do this. A Restricted Community requires that users be added to the Community by a community administrator. Users may use the 'Communities' portlet to request membership. A Private community do not allow users to join and to leave the community.

Defining Communities

To be done.

ProcedureTo add a Community

  1. Login to WebSynergy as Admin user.

  2. Click 'Add Applications' from the welcome menu.

  3. Click 'Add' against the 'Communities' portlet.

  4. Click 'Add Community'.

  5. Specify the Name, Description, Type, and Active attributes for the community. Open is the default type.

  6. Click Save to save the community.

Assigning Users to Communities

To be done.

ProcedureTo Assign Users to a Community

  1. Login to WebSynergy as Admin user.

  2. Click 'Add Applications' from the welcome menu.

  3. Click 'Add' against the 'Communities' portlet.

  4. Click 'Available Communities' to list all available communities.

  5. Click the 'Actions' button for the community, and select 'Assign Members' from the menu.

    All the current Users, Organizations, and User Groups are listed in their respective tabs.

  6. Click 'Available' tab under 'Users' tab to list all available users.

  7. Select the checkbox against each of the users who you want to assign as members.

  8. Click 'Update Associations' button to assign selected users as members.

  9. Click 'Current' tab to view the current members which includes the new members assigned to the community.

Organizations

Organizations are hierarchical collections of Users. They are one of the two types of portal resources that can have pages. There is also a special type of Organization called 'Location', which can define where users are specifically located.

There are two kinds of Organizations:

The organization of type Regular can have suborganizations, but an organization of type Location is not allowed to have suborganizations.

Let us consider the example of creating an organization called Admin Organization and a Suborganization called Admin Location.

Defining Organizations

This section outlines the procedure for Create an Organizationand Creating a Suborganization.

ProcedureTo Create an Organization

  1. Login to WebSynergy as Admin user.

  2. Click 'Add Applications' from the welcome menu.

  3. Click 'Add' against the 'Enterprise Admin' portlet.

  4. Click 'Organizations'.

    All the existing organizations are listed.

  5. Click 'Add' to add a new organization.

  6. Specify the 'Name' and 'Type' for the organization. For an organization of type 'Location', also specify the 'Country' and 'Region'.

  7. Click Save.

    You can specify the other attributes such as, address, phone number, email ID, and website.

  8. Click 'Return to Full Page' to navigate back.

  9. Click the 'Organizations' tab.

    You will find the just created organization in the list of all organizations.

ProcedureTo Create a Suborganization

  1. Login to WebSynergy as Admin user.

  2. Click 'Add Applications' from the welcome menu.

  3. Click 'Add' against the 'Enterprise Admin' portlet.

  4. Click 'Organizations'.

    All the existing organizations are listed.

  5. Click 'Add' to add a new organization.

  6. Specify the 'Name' and 'Type' for the organization. For an organization of type 'Location', also specify the 'Country' and 'Region'.

  7. Click 'Select' to select a parent organization.

    The resultant window lists all the Organizations of type Regular.


    Note –

    The system restricts creating a Location Organization without assigning a parent organization to it.


  8. Select an organization to make it the parent organization.

    The organization being created becomes the suborganization of the parent organization.

  9. Click Save.


    Note –

    An alternative method for selecting a parent organization for an organization is by selecting Add Regular Organization or Add Location from the menu appearing on clicking the Actions button corresponding to an organization. If you want to select a Regular Organization as the parent organization, select Add Regular Organization from the menu. If you want to select an organization of type Location as the parent organization, select Add Location from the menu.


Creating Users Under an Organizations

To be done.

ProcedureTo Create Users under an Organization

  1. Login to WebSynergy as Admin user.

  2. Click 'Add Applications' from the welcome menu.

  3. Click 'Add' against the 'Enterprise Admin' portlet.

  4. Click 'Organizations'.

    All the existing organizations are listed.

  5. Click 'Actions' button corresponding to an organization.

  6. Select 'Add User' from the menu.

    Specify the name and other details for the user. By default, the user is assigned to the same organization. To change the organization for the user, or to assign the user to more organizations, click the Organizations link under User Information.

    Figure 4–6 Selecting an organization

    Selecting an organization

    • Click 'Select' to select another organization for the user.

    • Click 'Remove' corresponding to an organization to remove user from the organization.

  7. Click Save.

    The user is created.

  8. Update the User Information, Identification, and other details of the organization.

  9. Click Save.

Users and User Roles

There are three kinds of User Roles:

What Different User Roles Mean?

A user generally has some Regular, Organization, and Community roles. You can view the roles and other attributes associated with a user by selecting a user from the User tab in the Enterprise Admin portlet.

Regular Roles

Guest, User, Power User, Owner, and Administrator are the different Regular Roles. All the user with login access to WebSynergy are assigned with the 'User' role. It defines the difference between a Guest and a person who has a user ID in the portal. By default, all users are also assigned the Power User role. This role by default gives users their own personal pages (both public and private) where they can place portlets.

To make yourself an Administrator, click the Select link. A window listing all the roles in the system pops us. Click the Administrator link from the pop-up window. You are now an administrator of the portal. Log out of the portal and then log back in with your own user ID. You can now create a private page for the administration portlets and set them up in your own space.

Organization Roles

You can assign organization roles to users who are members of a organization. Organization Administrator, Organization Member, and Organization Owner are the roles which can be assigned to a user.

Community Roles

You can assign community roles to users who are members of a community. Community Administrator, Community Member, Community Owner, Content Designer, Content Editor, and Content Publisher are the roles which can be assigned to a user.

Defining User Roles

All users are listed on clicking the Users tab in the Enterprise Admin portlet. You can assign roles to a user.

ProcedureTo Define User Roles

  1. Login to WebSynergy as Admin user.

  2. Click 'Add Applications' from the welcome menu.

  3. Click 'Add' against the 'Enterprise Admin' portlet.

  4. Click the “Users' tab.

  5. Choose a user from the list.

    You can define Regular Roles, Community Roles, and Organization Roles tabs allow assigning Regular, Community, and Organization roles for the user.

  6. Click 'Roles' under 'User Information' for the user.

    You can assign Regular roles for all users in addition to the default Regular roles. To assign Organization or Community roles, the user need to be a member of a WebSynergy organization or community. Also you can remove the roles assigned to a user.

    • Choose 'Select' under Regular Roles, Organization Roles, or Community Roles to assign more Regular, Organization, or Community roles respectively.

    • Choose 'Remove' corresponding to a role to remove the role assigned.

  7. Click Save.

Plugins

To be done.

What Are Plugins?

To be done.

Enabling Plugins

To be done.

ProcedureTo Access Plugins

  1. Login to WebSynergy as Admin user.

  2. Click 'Add Applications' from the welcome menu.

  3. Click 'Add' against the 'Enterprise Admin' portlet.

  4. Expand the Enterprise Admin portlet to view all the tabs associated with the portlet.

  5. Choose the 'Plugins' tab.

    Figure 4–7 Plugins tab of the Enterprise Admin portlet

    Plugins tab of the Enterprise Admin portlet

    You can see four tabs listing portlets of four different categories namely; Portlet Plugins, Theme Plugins, Layout Template Plugins, Web Plugins.

Working With Plugin Permissions

You can activate or deactivate a Portlet Plugin, and you can change the User Roles associated with a plugin. For example, the Admin portlet has the Administrator role associated with it. This means, a user registered as an administrator can access the portlet.

ProcedureTo Change Plugin Permissions

  1. Login to WebSynergy as Admin user.

  2. Click 'Add Applications' from the welcome menu.

  3. Click 'Add' against the 'Enterprise Admin' portlet.

  4. Expand the Enterprise Admin portlet to view all the tabs associated with the portlet.

  5. Choose the 'Plugins' tab.

  6. Click the link for a portlet.

    For example, click on the Activities portlet.

    Figure 4–8 Changing the plugin permissions

    Plugin permissions

    • Change the user access permissions for the portlet by adding or removing roles.

      For example, If the portlet has 'Power User' role, all the users who have this role can access the portlet.

    • Activate or deactivate the portlet with the 'Active' option.

  7. Click Save.