Manifest Group and Folder Naming Advice and Philosophy

A quick guide to why folders (stems) in Manifest are named as they are, and advice on naming groups and folders.

Jump to: Folders - Groups - Character In Names

Folders

In Manifest, groups are located in folders (also known as a "Naming Stem" in Grouper -- the underlying software -- documentation). The only technical meaning of a folder is a place to put a group. Folder structures do not directly relate to permissions and do not create relationships between groups (if you are admin for a folder, you can have a group in it that you cannot see or manage).

Folders have a name (Department of Computer Sciences), an ID (cs.wisc.edu) and an ID Path (uw:domain:cs.wisc.edu). The full ID Path uniquely identifies the folder.

At UW-Madison, we desire to have the folder structures in Manifest describe -- as best they can -- the general organization of the University of Wisconsin and who is responsible for a group, making it easier to find a group or it's owning organization. Of course, UW-Madison is a large and complicated organization and has many parts with complicated relationships, so this is not always simple.

As such, two main root folders exist for groups to live in:

uw:domain or uw:dom
The structure of DNS on campus gives relatively easy insight into to whom a set of groups belong, and by using DNS names we can reduce confusion and disagreement about what the name of a stem should be. For example, uw:domain:cs.wisc.edu (Department of Computer Sciences) or uw:domain:chtc.cs.wisc.edu (Center for High Throughput Computing).
uw:org
Groups that cross department/division boundaries that define organizationally interesting cohorts. For example, uw:org:morgridge_institute (Morgridge Institute for Research) or uw:org:whs (Wisconsin Historical Society).

There are no hard-and-fast rules for what belongs where, and luckily no technical penalty for something being in the "wrong" place, other than perhaps confusing ourselves in the future.

It is desirable to reduce confusion and understand organizational relationships that we try to reduce the number of top level stems to make browsing more understandable. For example, conceptually separate items make sense to separate ( uw:domain:chtc.cs.wisc.edu doesn't have to be part of cs.wisc.edu), but we don't want to proliferate stems that are logically part of another (we wouldn't want to create uw:org:comp_sci_firewall_acls, but perhaps uw:org:cs_building_network_admin does make sense, as DoIT and Computer Sciences staff both have roles.)

Groups

Like folders, group names (CSL Staff) and IDs (csl) and full ID Path (uw:domain:cs.wisc.edu:csl) are arbitrary and serve only to uniquely identify the group, and really only need to be meaningful to you. However, other people may see your group name without easy visibility to the folder it is in, so giving it a name that helps reduce confusion is the neighborly thing to do (CS Affiliates instead of simply Affiliates).

Character In Names and IDs

While all characters are allowed in group names and IDs (including spaces, quotes and accented characters), using characters other than letters, numbers, underscore, period, and hyphen in IDs can cause problems with some applications or make for confusing communication about group names. It is recommended that IDs be relatively short (but understandable) for ease of use.

Names are intended for human consumption and are shown in the UI and some other interfaces. Names do not need to match the ID, but care should be taken to try to make them not confusing.

Need Help? Have Questions?

Middleware and Manifest Support are available to help you.

If you realize you accidentally placed a group in the wrong location, or named a group in a way you regret, contact support for help moving and renaming!

(Adapted from UW-Madison Stem and Group Naming Standards in the Internet2 Spaces Wiki. NB it was created for another purpose and is not literally accurate.)

See Also:




Keywords:manifest stem folder group naming standard advice   Doc ID:84828
Owner:Jon M.Group:Middleware
Created:2018-08-10 16:48 CDTUpdated:2018-08-10 17:30 CDT
Sites:Middleware
Feedback:  0   0