Uploaded image for project: 'Sakai'
  1. Sakai
  2. SAK-24423

Additional Joinable Site Settings

    XMLWordPrintable

    Details

    • Type: (Deprecated) Contributed Patch
    • Status: CLOSED
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 2.9.3
    • Fix Version/s: 10.0
    • Component/s: Site Info
    • Property addition/change required:
      Yes

      Description

      This patch contains a collection of new settings for when a site is made joinable. Any/all of these new settings can be enabled/disabled system-wide (disabled is the default) via sakai.properties. The features being introduced are:

      • joiner group (places the joining user into a group specified by the maintainer)
      • join notification (maintainer(s) receive an email when a user joins the site)
      • exclude from public list of joinable sites
      • limit by account type(s) (maintainers select the account types that are able to join the site)
      • join from Site Browser (ability for users to join sites through the Site Browser)

      The 'exclude from public list...' setting controls whether or not users will see the site in their list of 'Joinable Sites' in the Membership tool, as well as if users are able to join the site through the Site Browser (if that feature is enabled as well). It does not replicate or over-lap the existing 'Site Visibility' function ('private' or 'display in public site list'), as the existing feature controls whether or not the site will appear in the Site Browser at all.

      NOTE: the join notification aspect of this feature was not accepted by the community, and as such is not in the community code base. The sakai.property for join notification is therefore not respected/implemented.

      The sakai.properties introduced by this patch are:

      • sitemanage.join.joinerGroup.enabled=[true/false]
      • sitemanage.join.notification.enabled=[true/false]
      • sitemanage.join.excludeFromPublicList.enabled=[true/false]
      • sitemanage.join.limitAccountTypes.enabled=[true/false]
      • sitebrowser.join.enabled=[true/false]
      • sitemanage.join.allowedJoinableAccountTypeCategories (count + list)
      • sitemanage.join.allowedJoinableAccountTypes (count + list)
      • sitemanage.join.allowedJoinableAccountTypeLabels (count + list)

      The sakai.properties used in the 'screenshots.pdf' example are as follows:

      1. Master switch for all new joinable sites settings
        sitemanage.join.joinerGroup.enabled=true
        sitemanage.join.notification.enabled=true
        sitemanage.join.excludeFromPublicList.enabled=true
        sitemanage.join.limitAccountTypes.enabled=true
        sitebrowser.join.enabled=true
      1. -------- Begin limit joinable sites by account type ------------ #
      1. The following three lists are intended to make up a "join table" of
      2. category, account type, and display label, since category - account type
      3. is a many-to-many relationship.
      1. The count for each must be the same,
      2. otherwise nothing will display under this option. If any value is left
      3. empty, unexpected results may occur.
      1. Joinable sites - joinable account types categories to organize account types
      2. This is the top level of the tree in the UI
        sitemanage.join.allowedJoinableAccountTypeCategories.count=9
        sitemanage.join.allowedJoinableAccountTypeCategories.1=Student
        sitemanage.join.allowedJoinableAccountTypeCategories.2=Student
        sitemanage.join.allowedJoinableAccountTypeCategories.3=Student
        sitemanage.join.allowedJoinableAccountTypeCategories.4=Student
        sitemanage.join.allowedJoinableAccountTypeCategories.5=Student
        sitemanage.join.allowedJoinableAccountTypeCategories.6=Faculty
        sitemanage.join.allowedJoinableAccountTypeCategories.7=Staff
        sitemanage.join.allowedJoinableAccountTypeCategories.8=Staff
        sitemanage.join.allowedJoinableAccountTypeCategories.9=Staff
      1. Joinable sites - account types that are selectable for joinable sites to be limited by
      2. These values are not displayed in the UI
        sitemanage.join.allowedJoinableAccountTypes.count=9
        sitemanage.join.allowedJoinableAccountTypes.1=student
        sitemanage.join.allowedJoinableAccountTypes.2=gradstudentandstaff
        sitemanage.join.allowedJoinableAccountTypes.3=ugrdstudentandstaff
        sitemanage.join.allowedJoinableAccountTypes.4=cstudiesstudent
        sitemanage.join.allowedJoinableAccountTypes.5=applicant
        sitemanage.join.allowedJoinableAccountTypes.6=faculty
        sitemanage.join.allowedJoinableAccountTypes.7=staff
        sitemanage.join.allowedJoinableAccountTypes.8=gradstudentandstaff
        sitemanage.join.allowedJoinableAccountTypes.9=ugrdstudentandstaff
      1. Joinable sites - labels displayed to the maintainer selecting limited roles for official joinable members on Site Access page
      2. This list corresponds with the sitemanage.join.allowedJoinableAccountTypes list for order and count (1 to 1)
      3. These values are the leaves of the tree in the UI
        sitemanage.join.allowedJoinableAccountTypeLabels.count=8
        sitemanage.join.allowedJoinableAccountTypeLabels.1=Graduate and Undergraduate Students
        sitemanage.join.allowedJoinableAccountTypeLabels.2=Graduate Students who are also Staff
        sitemanage.join.allowedJoinableAccountTypeLabels.3=Undergraduate Students who are also Staff
        sitemanage.join.allowedJoinableAccountTypeLabels.4=Continuing Studies Students
        sitemanage.join.allowedJoinableAccountTypeLabels.5=Applicant Students
        sitemanage.join.allowedJoinableAccountTypeLabels.6=Faculty
        sitemanage.join.allowedJoinableAccountTypeLabels.7=Staff
        sitemanage.join.allowedJoinableAccountTypeLabels.8=Staff who are also Graduate Students
        sitemanage.join.allowedJoinableAccountTypeLabels.9=Staff who are also Undergraduate Students
      4. -------- End limit joinable sites by account type -------------#

        Gliffy Diagrams

          Attachments

          1. KNL-1202_kernel.patch
            16 kB
          2. KNL-1202_sakai-mock.patch
            0.8 kB
          3. KNL-1202_site-manage.patch
            16 kB
          4. KNL-1202_sitestats.patch
            0.8 kB
          5. SAK-24423_kernel_rev2.patch
            5 kB
          6. SAK-24423_kernel.patch
            42 kB
          7. SAK-24423_site-manage.patch
            93 kB
          8. screenshots.pdf
            273 kB

            Issue Links

              Activity

                People

                • Assignee:
                  maintenanceteam Core Team
                  Reporter:
                  bjones86 Brian Jones
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  10 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Time Tracking

                    Estimated:
                    Original Estimate - Not Specified
                    Not Specified
                    Remaining:
                    Remaining Estimate - Not Specified
                    Not Specified
                    Logged:
                    Time Spent - 20 minutes
                    20m

                      Git Source Code