[LON-CAPA-cvs] cvs: loncom /html/adm/help/tex Institutional_Integration_User_Categories.tex

raeburn lon-capa-cvs-allow@mail.lon-capa.org
Tue, 29 Jul 2008 18:01:22 -0000

raeburn		Tue Jul 29 14:01:22 2008 EDT

  Added files:                 
  - Document Institutional User Categories/Affiliations.

Index: loncom/html/adm/help/tex/Institutional_Integration_User_Categories.tex
+++ loncom/html/adm/help/tex/Institutional_Integration_User_Categories.tex
Users in a domain can be assigned one or more institutional affiliations
by the Autoupdate process which reconciles user information in LON-CAPA
with institutional directory information. User type (or affiliation)
can determine such things as (a) default portfolio quota, (b) the
types of user information which may be updated in different contexts,
(c) whether a user can self-enroll in a course. The possible institutional
types in a domain are defined by \emph{inst\_usertypes()}. Examples
of institutional types might be: Faculty, Adjunct, Staff, Student
etc. In addition to any types defined in \emph{inst\_usertypes()}, a type
{}``other'' will also be available for assignment to users who do
not fall in any of the recognized categories of user. In the absence
of any defined user categories, the type {}``other'' applies to
all users from a domain.

\textbf{\large inst\_usertypes}{\large \par}

The routine accepts three arguments:

\item \$dom - domain
\item \$usertypes - reference to hash which will contain key = value, where
keys are institution affiliation types (e.g., Faculty, Student etc.)
and values are titles (e.g., Faculty/Academic Staff)
\item \$order - reference to array which will contain the order in which
institutional types should be shown when displaying data tables (e.g.,
default quotas or updateable user fields (see Domain Configuration
The routine returns 'ok' if no errors occurred.

At MSU there are six different categories of users.

\texttt{sub inst\_usertypes \{}
\texttt{my (\$dom,\$usertypes,\$order) = @\_;}

\texttt{my \$outcome = 'ok';}

\texttt{\%\{\$usertypes\} = (}
\texttt{Faculty => 'Faculty/Academic Staff',}

\texttt{Staff => 'Support Staff',}

\texttt{Student => 'Student',}

\texttt{Assistant => 'Assistant',}

\texttt{StaffAff => 'Affiliate',}

\texttt{StuAff => 'Student Affiliate'}


\texttt{return \$outcome;}