Oracle Portal-to-Go Implementation Guide Release 1.0.2.2 A86635-02 |
Library | Service | Contents | Index

# 6
Managing Users and Groups

This document describes how you can create and modify Portal-to-Go users and user groups. Topics include:

- User Roles

- Portal-to-Go Users

- User Groups

- Integrating Users with Existing Provisioning Systems

## User Roles

Portal-to-Go users can be granted the following roles:

- Administrator

- Designer

- Anonymous

Users assigned to the Administrator role can change the Portal-to-Go configuration and can start and stop any component, even the entire server. In addition, users with the Administrator role can update privileges on any part of the Portal-to-Go repository and can install and remove any service.

Users assigned the Designer role can create and modify any service or adapter.

Users having the Anonymous role are Portal-to-Go end users who have access only to the objects they own.

## Portal-to-Go Users

This section describes how you use the Portal-to-Go Service Designer to accomplish the following user-related tasks:

- Creating Users

- Adding Agent Information to a User

- Deleting Users

- Modifying Users

### Creating Users

You use the Create New User form to create users in the Portal-to-Go repository. To invoke the form:

1. Click Users in the Portal-to-Go repository tree view. The Query Users form displays in the right panel.

2. Click Add to display the Create New User form.

The form includes the following parameters:

Parameter | Value
--- | ---
Name | A unique name for the user.
External ID | The user's unique identifier in an external provisioning system, such as a telephone or an account number.
Display Name | The name displayed in the service tree.
Password | The user's password.
Password Hint | A hint that helps the user remember a forgotten password.
User Root Parent | The root folder in which the Service Designer creates the user's folder.
Group | The group to which the user belongs. Any service that is available to the selected group will be available to the new user.
Enabled | Select this check box to make the user valid.
Administrator | Select this check box to grant the user administrator privileges.
Designer | Select this check box to grant the user designer privileges.
Anonymous | Select this check box to grant the user access to only public Portal-to-Go services.

### Adding Agent Information to a User

Once Portal-to-Go administrators create new users, they can add agents to user properties. Agents associate a user with a channel for delivering asynchronous requests. For example, when a user schedules an asynchronous request, its result can be sent to either an SMS-enabled phone or to an email inbox. Each agent uses a logical device definition to transform the result of the user request for output to the appropriate channel. An agent has an address, which is a protocol-specific parameter required to deliver the result to a channel of the user's choice, such as an email address. Adding agent information to a user's properties enables a user to receive notifications.

To add agent information for a user:

1. Select Users in the Portal-to-Go repository tree. The Query Users form appears.

The form includes the following fields:

Field | Enter
--- | ---
Name | A string for querying the user's name.
Disp. Name | A string for querying the user's display name.

1. Enter values in the Name or Disp. Name field and click Find. The query form returns a list of users that match your search criteria.

2. Select the user to which you want to add agent information.

3. Click Properties to display the Properties form for that user.

4. In the Properties form, click the Agents tab to display the Agents panel. The panel is blank if you have just created a new user.

The Agents tab includes the following attributes:

Attribute | Value
--- | ---
Name | A unique name for the user agent. This name appears at the Personalization Portal.
Default | When selected, makes that agent the user's default agent. Only one agent can be selected as default.
Address | Address of the user's device. This can be an email address for notifications, or a phone number for SMS (Short Message Service) notifications.
Address Type | The Service Designer generates this parameter's value based on the value of the Device parameter.
Device | The name of the logical device.

1. Click Add to display the Create New Agents form.

The Create New Agents form includes the following parameters:

Parameter | Description
--- | ---
Name | A unique name for the user agent. This name appears at the Personalization Portal.
Address | Address of the user's device. This can be an email address for notifications, or a phone number for SMS (Short Message Service) notifications.
Device | The name of the logical device. Click Browse to display a list of available devices.

1. Provide values for the new agent parameters and click Finish to complete the user agent configuration.

### Deleting Users

Follow these steps to delete a user:

1. Select Users in the Portal-to-Go repository tree view to display the Users form.

2. Enter the name of the user you wish to delete in the Name field or enter the user's identifier in the External ID field.

3. Click Find to display users that match your search criteria. To display all users, leave the Name and External ID fields blank and then click Find.

4. Select the user you want to delete.

5. Click Delete.

6. Confirm the action by clicking the Yes button in the Confirm Delete dialog.

### Modifying Users

Follow these steps to modify a user's information:

1. Select Users in the Portal-to-Go repository tree view to display the Users form.

2. Enter the name of the user you wish to delete in the Name field or enter the user's identifier in the External ID field.

3. Click Find to display users that match your search criteria. To display all users, leave the Name and External ID fields blank and then click Find.

4. Select the user whose information you want to modify.

5. Click Properties to display the Properties form for this user.

6. Modify the desired parameters on the General and Agents tabs as described in "Adding Agent Information to a User", and click the Apply button to save your changes.

## User Groups

This section describes how you can create, modify, or delete user groups using the Portal-to-Go Service Designer:

- Creating User Groups

- Deleting Groups

- Adding Users to a Group

- Adding Services to a Group

- Removing Users from a Group

- Removing Services from a Group

- Changing a User's Group

### Creating User Groups

Portal-to-Go users can be organized into groups, with each Portal-to-Go user belonging to a single group. Services can also be assigned to these user groups and can be made available to all users in that group. To create a group:

1. Right-click Groups in the Portal-to-Go repository tree view.

2. Click Create New Group to display the Create New Group form.

The Create New Group form includes the following parameters:

Parameter | Value
--- | ---
Name | A unique name for the group.
Available Users: Name | A string for querying the user's name from the list of available users.
Available Users: Disp. Name | A string for querying the user's display name from the list of available users.
Group Members: Name | A string for querying the user's name from the group members.
Group Members: Disp. Name | A string for querying the user's display name from the list of selected users.

1. Enter the name of the new user group in the Name field at the top of the screen.

2. In the Available Users section of the Create New Group form, enter the name of the user you wish to add in the Name field or enter the user's display name.

3. Click Find. To display all available users, leave the Name and Disp. Name fields blank and click Find. Results of the search criteria are displayed by user name and display name in the Available Users section.

Note: Searching the Name and Disp. Name fields in the Available Users section returns only users who are not assigned to any group.

1. Select the user you want to add to the group. You can select multiple users by holding the CONTROL key.

2. Click the right arrow (>) to move users from the Available Users section to the Group Members section. Clicking the double right arrows (>>) adds all available users to the new group.

3. Click Next.

After creating the group, you can make services available to the group members by assigning service folders to the group. You can only assign services by folder; you cannot assign individual services to a group. To assign services to a group:

1. If not already selected, select the group from the Portal-to-Go tree view.

2. Click the Service Folders tab.

3. Expand, if necessary, the root service folders shown to display the folder you want to make available to the group.

4. Select the folder you want to assign to the group. Holding the CONTROL key enables you to select multiple folders.

5. Click the right arrow (>) to move folders to the Selected Service Folders field. Clicking the double right arrows (>>) moves all folders to the Selected Services Folder field.

6. Click Finish.

### Deleting Groups

To delete a group:

1. Expand the Groups folder in the Portal-to-Go repository tree view.

2. Select the group you want to delete by clicking the right mouse button.

3. Click Delete.

4. Click Yes in the Confirm Delete dialog.

### Adding Users to a Group

To add a user to a group:

1. Expand the Groups folder in the Portal-to-Go repository tree view.

2. Select the group to which you want to add users. The Group Properties form appears in the right frame. Select the General tab, if it does not already appear.

3. In the Available Users section, enter the name of the user you wish to add in the Name field or enter the user's display name.

4. Click Find. To display all available users, leave the Name and Disp. Name fields blank and click Find. Results of the search criteria are displayed by user name and display name in the Available Users section.

5. Select the user you want to add to the group. You can select multiple users by holding the CONTROL key.

6. Click the right arrow (>) to move users from the Available Users section to the Group Members section. Clicking the double right arrows (>>) adds all available users to the group.

7. Click Apply.

### Adding Services to a Group

To make services available to a group:

1. Expand the Groups folder in the Portal-to-Go repository tree view.

2. Select the group name to which you want to add services.

3. Click the Service Folders tab to display the Service Folders panel.

1. Under Service Folders, expand the folders, if necessary, to display the folder that you want to assign to the group. Select the folder. You can select multiple folders by holding the CONTROL key.

2. Click the right arrow (>) button to move the folder to the Selected Service Folders field.

3. Click Apply.

### Removing Users from a Group

To remove users from a group:

1. Expand the Groups folder in the Portal-to-Go repository tree view to display the available groups.

2. Select the group from which you want to remove users. The group properties form appears in the right frame. Select the General tab, if it does not already appear.

3. In the Available Users section, enter the name of the user you wish to remove from the group in the Name field or enter the user's display name.

4. Click Find. To display all available users, leave the Name and Disp. Name fields blank and click Find. Results of the search criteria are displayed by user name and display name in the Available Users section.

5. Select the user you want to remove from the group. Hold the CONTROL key to select multiple users for removal.

6. Click the left arrow (<) to move users from the Group Members section to the Available Users section. Clicking the double left arrows (<<) removes all users from the group.

7. Click Apply.

### Removing Services from a Group

To remove services from a group:

1. Expand the Groups folder in the Portal-to-Go repository tree view to display the available groups.

2. Select the group from which you want to remove services. The group properties form appears in the right frame.

3. Click the Folders tab.

4. Under Selected Service Folders, select the folder you want to remove. You can select multiple folders by holding the CONTROL key.

5. Click the left arrow (<) to remove the folder from the Selected Service Folders field. Clicking the double left arrows (<<) removes all folders from the group.

6. Click Apply.

### Changing a User's Group

A Portal-to-Go user can only belong to one group at a time. If you wish to change a user's group, you must first remove the user from one group before adding the user to another group. See "Removing Users from a Group" and "Adding Users to a Group" for more information.

## Integrating Users with Existing Provisioning Systems

You can integrate your repository with an existing provisioning system using one of the following:

1. You can manage users with the Portal-to-Go provisioning adapter. The provisioning adapter supports Portal-to-Go services that create, update, and delete users at runtime.

2. Use the `LoadXml` utility to import users from a flat XML file that conforms to the Repository DTD. This utility enables you to create and update user information. For more information on the `LoadXML` utility, see Chapter 3, "Portal-to-Go Tools".

3. You can look up users at runtime by using the `UserAuthenticationHook` and the `ProvisioningHook` interfaces. This is similar to using the `LoadXML` utility, but with the hook interfaces you can import users one-by-one. The `LoadXML` utility operates on the entire repository. The following sections describe these interfaces.

### ProvisioningHook Interface

You use the `ProvisioningHook` interface to integrate an external provisioning system with Portal-to-Go. Portal-to-Go locates the provisioning class to use in the System.properties file as the value of the `locator.provisioning.class` parameter. The implementing class must be implemented as a singleton class. This interface has the following methods:

- `getRootFolder()`: Creates a root folder for a user.

- `getUsersRootFolder()`: Gets the common root folder for all users.

### UserAuthenticationHook Interface

Portal-to-Go calls the user authentication class when it cannot locate a user. The class must be implemented as a singleton class. This interface has the following methods:

- `authenticate()`: Authenticates a Portal-to-Go user.

- `checkUser()`: Checks if the user exists, and if it does, sets appropriate attributes.

| Copyright © 2000 Oracle Corporation. All Rights Reserved. |
Library | Service | Contents | Index