Annotation of loncom/html/adm/help/tex/Institutional_Integration_User_Categories.tex, revision 1.3
1.1 raeburn 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,
1.2 raeburn 7: (c) whether a user can self-enroll in a course.
8:
9: Prior to LON-CAPA 2.11.0 the possible institutional types in a domain
10: were defined by \emph{inst\_usertypes()}. Examples of institutional
11: types might be: Faculty, Adjunct, Staff, Student etc.
12: In addition to any types defined in \emph{inst\_usertypes()}, a type
1.1 raeburn 13: {}``other'' will also be available for assignment to users who do
14: not fall in any of the recognized categories of user. In the absence
15: of any defined user categories, the type {}``other'' applies to
16: all users from a domain.
17:
1.2 raeburn 18: Starting with LON-CAPA 2.11.0 use of the inst\_usertypes()
19: subroutine is deprecated. The domain configuration web GUI
20: accessible to Domain Coordinators is now used to
21: manage institutional types. If you have previously
22: customized the inst\_usertypes() routine, then values set there
1.3 ! raeburn 23: will be used when displaying the ``Institutional user types''
! 24: section in the domain config screen for:
! 25: Default authentication, language, timezone, portal and types.
1.2 raeburn 26:
27: Once a Domain Coordinator has visited that screen and saved the
28: settings, configuration thereafter will be via the web GUI of
29: values stored in the domain's configuration.db file on
30: the primary library server in the domain, and values in
31: inst\_usertypes() will no longer be consulted. However, if you have
32: created other custom routines in localenroll.pm which call
33: inst\_usertypes() internally, you will likely want to continue to
34: maintain it.
35:
1.1 raeburn 36: \textbf{\large inst\_usertypes}{\large \par}
37:
1.2 raeburn 38: The routine accepted three arguments:
1.1 raeburn 39:
40: \begin{enumerate}
41: \item \$dom - domain
42: \item \$usertypes - reference to hash which will contain key = value, where
43: keys are institution affiliation types (e.g., Faculty, Student etc.)
44: and values are titles (e.g., Faculty/Academic Staff)
45: \item \$order - reference to array which will contain the order in which
46: institutional types should be shown when displaying data tables (e.g.,
47: default quotas or updateable user fields (see Domain Configuration
48: menu)
49: \end{enumerate}
50: The routine returns 'ok' if no errors occurred.
51:
52: At MSU there are six different categories of users.
53:
54: \begin{quotation}
55: \texttt{sub inst\_usertypes \{}
56: \begin{quotation}
57: \texttt{my (\$dom,\$usertypes,\$order) = @\_;}
58:
59: \texttt{my \$outcome = 'ok';}
60:
61: \texttt{\%\{\$usertypes\} = (}
62: \begin{quotation}
63: \texttt{Faculty => 'Faculty/Academic Staff',}
64:
65: \texttt{Staff => 'Support Staff',}
66:
67: \texttt{Student => 'Student',}
68:
69: \texttt{Assistant => 'Assistant',}
70:
71: \texttt{StaffAff => 'Affiliate',}
72:
73: \texttt{StuAff => 'Student Affiliate'}
74: \end{quotation}
75: \texttt{);}
76:
77: \texttt{@\{\$order\}=('Faculty','Staff','Student','Assistant','StaffAff','StuAff');}
78:
79: \texttt{return \$outcome;}
80: \end{quotation}
81: \texttt{\}}
82: \end{quotation}
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>