Return to Institutional_Integration_User_Categories.tex CVS log

Up to [LON-CAPA] / loncom / html / adm / help / tex

- Document Institutional User Categories/Affiliations.

    1: \label{Institutional_Integration_User_Categories}
    2: Users in a domain can be assigned one or more institutional affiliations
    3: by the Autoupdate process which reconciles user information in LON-CAPA
    4: with institutional directory information. User type (or affiliation)
    5: can determine such things as (a) default portfolio quota, (b) the
    6: types of user information which may be updated in different contexts,
    7: (c) whether a user can self-enroll in a course. The possible institutional
    8: types in a domain are defined by \emph{inst\_usertypes()}. Examples
    9: of institutional types might be: Faculty, Adjunct, Staff, Student
   10: etc. In addition to any types defined in \emph{inst\_usertypes()}, a type
   11: {}``other'' will also be available for assignment to users who do
   12: not fall in any of the recognized categories of user. In the absence
   13: of any defined user categories, the type {}``other'' applies to
   14: all users from a domain.
   15: 
   16: \textbf{\large inst\_usertypes}{\large \par}
   17: 
   18: The routine accepts three arguments:
   19: 
   20: \begin{enumerate}
   21: \item \$dom - domain
   22: \item \$usertypes - reference to hash which will contain key = value, where
   23: keys are institution affiliation types (e.g., Faculty, Student etc.)
   24: and values are titles (e.g., Faculty/Academic Staff)
   25: \item \$order - reference to array which will contain the order in which
   26: institutional types should be shown when displaying data tables (e.g.,
   27: default quotas or updateable user fields (see Domain Configuration
   28: menu)
   29: \end{enumerate}
   30: The routine returns 'ok' if no errors occurred.
   31: 
   32: At MSU there are six different categories of users.
   33: 
   34: \begin{quotation}
   35: \texttt{sub inst\_usertypes \{}
   36: \begin{quotation}
   37: \texttt{my (\$dom,\$usertypes,\$order) = @\_;}
   38: 
   39: \texttt{my \$outcome = 'ok';}
   40: 
   41: \texttt{\%\{\$usertypes\} = (}
   42: \begin{quotation}
   43: \texttt{Faculty => 'Faculty/Academic Staff',}
   44: 
   45: \texttt{Staff => 'Support Staff',}
   46: 
   47: \texttt{Student => 'Student',}
   48: 
   49: \texttt{Assistant => 'Assistant',}
   50: 
   51: \texttt{StaffAff => 'Affiliate',}
   52: 
   53: \texttt{StuAff => 'Student Affiliate'}
   54: \end{quotation}
   55: \texttt{);}
   56: 
   57: \texttt{@\{\$order\}=('Faculty','Staff','Student','Assistant','StaffAff','StuAff');}
   58: 
   59: \texttt{return \$outcome;}
   60: \end{quotation}
   61: \texttt{\}}
   62: \end{quotation}