From: Chris Hyzer
Sent: Sunday, September 21, 2008 2:44 PM
To: Grouper Dev
Subject: end-to-end scenario help
I opened this jira issue. I was hoping to put this
into 1.4 since it is not that time consuming. Thoughts?
Thanks!
Chris
https://bugs.internet2.edu/jira/browse/GRP-170
To address issues with users not knowing how to high level
tasks, Jen and I wrote some instructions for end-to-end scenarios. I was
thinking of adding them to the existing help page with some hide/show links,
but I am still discussing the implementation with Jen. Here is our current
text:
1. Find a folder or a group by navigation
(requires VIEW privilege or greater)
a. Click "Explore" in the "My Tools" segment of the left
menu
b. Click any folder name in the "Browse or list groups" panel to show
the contents of that folder. Continue clicking through folder names to move
through the folder hierarchy.
• If your current location is
not "Root", you can click the Root
folder label to go to the top folder
• If you cannot see a folder or
group, you may lack permission to
view any of its contents, or the folder could be in a different
location. Try searching for a specific group contained in that
folder, or contact your administrator.
• Note that clicking a folder
name may advance you
c. Click any group name in the "Browse or list groups" panel to see
the Group Summary screen for that group
2. Find an entity or a group by searching
(requires VIEW privilege or greater)
a. Click "Search" in the "My Tools" segment of the left
menu
b. In the "Search people or groups" panel, type a search term
• Permissible search sequences
for names are firstname [space]
lastname, using "%" to denote any wildcard characters -- IS THIS AN
ARTIFACT OF OUR SETUP? IT'S A BIT ODD.
c. Click the "Search" button, or press the Return key, to submit. A
search results screen will appear.
d. In the results list, click an entity name or a group path to view
the Entity Details screen for your selection.
• If you have selected a group,
you can click "View Group Summary"
near the bottom of the summary panel to go to the Group Summary screen, which
includes additional options for working with information related to that group.
(The options shown will be based upon your privilege level for the group.)
• If you cannot see an entity
or group, you may lack permission to
view it. Try modifying your search, or contact your administrator.
3. Read a group's membership list
(requires READ privilege or greater)
a. Find the Group Summary screen for the group by navigating or
searching (links to above).
b. Click "Manage members" near the bottom of the summary panel. The
Members screen will appear.
• You may choose to view
indirect, direct, or all members of the list
by selecting the appropriate radio button at the top of the "Membership
list" panel and then clicking the "Change display" button
4. Add a member (entity or group) to a group
(requires UPDATE privilege or greater)
a. Go to the group's membership list page (link to flow above)
b. Click "Add member" at the bottom of the "Membership
list" panel.
The "Assign privileges / Add members" screen will appear.
c. In the field in the "Search people or groups" panel, type the
search criteria for the member you want to add, then click the
"Search" button. Your search results will appear.
• Note that in the privileges
portions of the results panel, the
MEMBER privilege is selected by default. You may use the neighboring checkboxes
to assign additional privileges to the entities you select.
d. Select each member you want to add by clicking the checkbox next to
the member listing, then click the "Assign privileges" button at the
bottom of the panel.
5. Remove a member from a group
(requires UPDATE privilege or greater)
a. Go to the group's membership list page (link to flow above)
b. Select the member(s) you want to remove by clicking the checkbox
next to the member listing(s).
c. Click the "Remove selected members" button
6. Assign someone to be able to manage a group
(requires ADMIN privilege or greater)
a. Go to the group's membership list page (link to flow above)
b. Click "Add member" at the bottom of the "Membership
list" panel.
The "Assign privileges / Add members" screen will appear.
c. In the field in the "Search people or groups" panel, type the
search criteria for the member you want to add, then click the
"Search" button. Your search results will appear.
d. In the privileges portions of the results panel, select the
checkbox for "update" [can modify group membership] or
"admin" [can modify group membership, change group name, or delete
the group].
• Choose the simplest
permission that will suffice, keeping in mind
that anyone with ADMIN privilege can rename or delete the group, whether
intentionally or accidentally.
• If the user can manage the
group, but is not a member of the group,
unselect the checkbox for "member".
e. Select each entity you want to receive the designated privilege by
clicking the checkbox next to the entity listing, then click the "Assign
privileges" button at the bottom of the panel.
7. Create a new group
(requires CREATE GROUP privilege or greater)
a. Find a parent folder for the group (link to above flow). This
should place you on the Browse Groups Hierarchy screen
• If you have permissions to
create a group in this folder, you will
see the "Manage folders" panel at the bottom of the page. If you do
not see this panel, contact your administrator.
b. Click "Create Group" at the bottom of the "Manage
folders" panel.
The Create Group screen will appear.
• You can mouse over the field
labels to learn more about what to
enter in each field
c. Fill the fields in the panel, then click "Save" to create the
group.
• If you click the "Add
members" button, your new group will be
saved and you will be taken to step 4c.
8. Create a composite group.
(requires CREATE GROUP privilege or greater) Grouper allows you to use two
existing groups (called "factors") to define a third (composite)
group. You may combine two groups in the following ways:
-- UNION includes all members of the two original (factor) groups
-- "adding"
-- INTERSECTION includes entities that belong to both of two
original (factor) groups -- "members-in-common"
-- COMPLEMENT includes entities that belong to the primary
("left) factor group who are not also members of the secondary
("right") factor group -- "left minus right"
To create a composite group:
a. Place each of your two factor groups in the Group Workspace
(1) Find or create each factor
group
•
Find a group by navigating or searching (link to above), and
proceed to the Group Summary page.
•
Create a factor group using the steps above to (links) create a
group and assign members to it. After you assign new members, click "Group
Summary" at the bottom of the "Assign Privileges/Add Members"
page to proceed.
(2) Click "Add to Group
Workspace" at the bottom of the summary panel.
(3) Confirm that both factor
groups are in the Group Workspace by
clicking "Group Workspace" in the "My Tools" segment of the
left menu.
b. Combine the factor groups to make a new, third group (composite)
(1) Find a parent folder for
the group (link to above flow). This
should place you on the Browse Groups Hierarchy screen
•
If you have permissions to create a group in this folder, you will
see the "Manage folders" panel at the bottom of the page. If you do
not see this panel, contact your administrator.
(3) Click "Create
Group" at the bottom of the "Manage folders"
panel. The Create Group screen will appear.
•
You can mouse over the field labels to learn more about what to
enter in each field
(4) Fill the fields in the
panel, then click "Make composite" to
begin creating a composite group. The "Create composite group" panel
will appear.
(5) Use the pulldown lists to
select the two factor groups and how
you wish to combine them.
•
The groups appearing in the pulldown lists are those in your Group
Workspace
•
Assigning "Left group" and "Right group" will only matter
if you
are using COMPLEMENT ("left minus right") to combine the groups.
(6) Click the "Create
composite group" button at the bottom of the
panel to create the new composite group.
9. Create a new folder
(requires CREATE FOLDER privilege or greater)
a. Find a parent folder for the folder you will be creating (link to
above flow). This should place you on the Browse Groups Hierarchy screen
• If you have permissions to
create a folder in this folder, you will
see the "Manage folders" panel at the bottom of the page. If you do
not see this panel, contact your administrator.
b. Click "Create Folder" at the bottom of the "Manage
folders" panel.
The Create Folder screen will appear.
• You can mouse over the field
labels to learn more about what to
enter in each field
c. Fill the fields in the panel, then click "Save" to create the
group.
• If you click the "Add
members" button, your new group will be
saved and you will be taken to step 4c.
10. Assign someone to be able to create new folders or groups within a
parent folder
(requires CREATE FOLDER privilege or greater)
a. Find a parent folder for the folder you will be creating (link to
above flow). This should place you on the Browse Groups Hierarchy screen
• If you have permissions to
assign privileges in this folder, you
will see the "Manage folders" panel at the bottom of the page. If you
do not see this panel, contact your administrator.
b. Click the "Show Entities with" at the bottom of the "Manage
folders" panel. The "Current entities with [Create Group]
privilege"
screen will appear.
c. Click "Assign this privilege" at the bottom of the "Entity
list
filtered by privilege" panel. The "Assign creation privileges for
[group name]" screen will appear.
d. In the field in the "Search people or groups" panel, type the
search criteria for the member you want to add, then click the
"Search" button. Your search results will appear.
• Note that in the privileges
portions of the results panel, the
CREATE GROUP privilege is selected by default. You may also use the CREATE
FOLDER checkbox to assign privileges to the entities you select.
• The creation privileges you
grant apply to the parent folder only,
and not to any subfolders contained within it (i.e. there is no hierarchical
inheritance of creation privileges)