Grouper UI Properties

As of Grouper 2.2, most of the Grouper UI configuration (for the Grouper Admin (legacy) UI, LITE UI and new Grouper 2.2 UI) is now in grouper-ui.base.properties, and you can override it in grouper-ui.properties. See the Configuration Overlay page for details. Some configuration that you generally will not need to change in upgrading to Grouper 2.2 is in media.properties. You can see what is in each here: (click download on the top file)

https://github.com/Internet2/grouper/blob/master/grouper-ui/conf/grouper-ui.base.properties

https://github.com/Internet2/grouper/blob/master/grouper-ui/conf/resources/grouper/media.properties

grouper-ui.properties

The file grouper-ui/conf/grouper-ui.properties controls many aspects of the Grouper UI appearance and behavior. The settings in media.properties apply to the Grouper Admin UI, LITE UI's, and new Grouper 2.2 UI.

• #Simple Look and feel
• #Menu Configuration
• #Miscellaneous UI configuration
• #Membership Import and export
• #Displaying lists
• #Searching
• #Sorting
• #Audit query
• #Plugin browse / search
• #Dynamic tiles
• #ObjectAsMap Implementations
• #Infodots
• #Lite UI settings

Simple Look and feel

How to change logos and CSS

#You may specify a logo for your organisation and for Grouper. Off-the-shelf
#your organisation logo appears on the left of the header and the Grouper logo
#appears on the right. Typically you would make the logos the same height.

#A space separated list of one or more .css files which are inserted into the
#HEAD of all Grouper pages. The .css files are referenced in order and after
#any Grouper CSS files. This means that your CSS files can override any
#Grouper style definition

#You can omit the Grouper CSS files completely by setting grouper-css.hide=true

#Include link to new prototype of a Lite ui on login page

#Enable links (new window) to lite UI i.e. from GroupSummary page

Menu Configuration

Out-of-the-box Grouper defines a standard set of menu items. It is possible to add
additional menu items and to change the order in which they appear

#space separated list of files - see default for format - which define menu items

#space separated list of menu item names (which must exist in 'menu.resource.files'

#space separated list of MenuFilters - in the order they are tested

#Determines if the menu is processed once at the start of a user session or whether
#it is processed with each request. Use 'true' for production and 'false' if you
#are actively developing the menu and want to see changes immediately

Miscellaneous UI configuration

#Specifies whether the error page should include a ticket. The ticket appears
#in the errror log and can be used to filter relevant messages

#Specifies whether Grouper should display a logout link. Not all authentication
#schemes allow logout, including Basic authentication.
#This value can be set in the Grouper UI build.properties file

##Set this to 'all' to remove all cookies, or set to a comma or space separated list of
##cookie names to delete. Java code will do a Cookie.getName().equals or .matches
##so valid regular expressions may be used

#If you have admin priviliges this is where you go initially

#When creating a group, which access privs will be granted to GrouperAll?
#groups.create.grant.all allows the UI to override the defaults in grouper.properties

#If not set, the defaults from the grouper.properties file will be used
#NB in the QuickStart, no privs are automatically assigned - grouper.properties was
#modified so that all 'groups.create.grant.all.<priv>' are false,

#If true, on the 'Subject Search' page there will be a link to your 'Subject Summary'

#Unless otherwise configured, the UI starts browsing at the ROOTstem. set default.browse.stem
#to start browsing from a different stem

#Grouper has no formal notion of 'personal' stems vs 'institutional' stems, however, setting
#personal.browse.stem, will trim this portio of the hierarchy when a user is browsing in 'All' mode
#TODO members of Wheel group / GrouperSystem should be able to browse regardless.

#The UI has a 'Saved Groups' feature intended to make it easier to find groups of interest
#and used when ceating comosite groups. This property, if true, causes any new or updated group
#to be automatically added to your list of saved groups

#The UI has a 'Saved Stems' feature intended to make it easier to find stems of interest
#This property, if true, causes any new or updated stem
#to be automatically added to your list of saved stems

#Turn off the debug functionality (true/false)
#Can be set in the Grouper UI build.properties file

#If debug is on then restrict to named group. Disable if group does not exist
#Can be set in the Grouper UI build.properties file

#Enables user to specify arbitrary exsecutable as HTML editor on the server
#Do not enable unless you absolutely trust users
#Can be set in the Grouper UI build.properties file

#The directory where preferences are saved

Membership Import and export

As of V1.2 the UI provides a framework for allowing users to export membership lists
to flat files i.e. comma separated files, including in Excel compatible format. It is also
possible to import simple delimited files.
Both import and export require configuration and appropriate configuration will vary from
site to site. For this reason, the UI does not come pre-configued for import/export, however,
sample files are provided (see Enabling import / export of group memberships)

If the user does not select a file to import allow text to be typed / pasted into textarea
Since version 1.2.1

##for large files, give a temp dir so they arent stored in memory or the system temp dir

##users must be in this group to be able to login to the UI

Displaying lists

#When browsing or searching the UI will present lists of various objects. The following settings
#allow sites to control default page sizes and a list of user-selectable page sizes

#Typically, when browsing it is sufficient to show the extension/displayExtension for a group/stem
#as the parent stems are aleady shown and are common. When searching, however, this context is lost
#so sites can configure which field to display in the context of a search where results may come from
#different locations

#By setting the 'result-field-choice' properties, sites can alow users to select which
#field to use for displaying serach resuts

#Prior to V1.2 sites could do little to control how subjects, groups or stems were displayed
#in the UI, beyond the display of stem/group search results, unless they created dynamic tiles
#It is now possible to control the display of stems, groups and subjects in different contexts
#In the case of subjects, an attribute can be configured based on the subject's SourceAdapter

#Provides backwards compatability - it was assumed that all Subjects woud have a 'description' attribute

#Used for groups when displayed as a subject i.e. when displayed as member of another group

#Used for internal Grouper subjects i.e. GrouperAll and GrouperSystem

#Default attribute to display for groups

#Attribute to use when browsing and the user has selected to hide the hierarchy -
#thus losing context

#Default attribute for stems

Searching

#Configuration affecting how simple default group/stem searches are carried out

#Determines if the name or extension field (or neither) are searched

#Determines if the display name or display extension (or neither) is searched

#On the advanced groups search screen determines how many search fields are displayed

#On the advanced groups search screen determines how many group type select lists are displayed

#On the advanced stems search screen determines how many search fields are displayed

#Control whether default search can search any attribute. Valid values=only or true or false

#Control default search option

#Allow filtering of membership lists by subject source

#Displays source specific form elements using keys:
#subject.search.form-fragment.<sourceId>

Sorting

As of V1.2 the Grouper UI allows sorting of various lists of objects
See Sort order of lists for explanation

#Sorting large lists can be computationally expensive - and slow. Use this property to turn off sorting for
#large lists

To control the order in which subject attributes are listed on the Subject Summary page:#subject.attributes.order.<SOURCE_ID>=comma separated list of case sensitive attribute names

Audit query

Date format likely to be locale dependent + may need to turn on/off

##SimpleDateFormat format strings

##If no date specified show results for audit.query.default-since days

Plugin browse / search

The UI has a pluggable interface for browsing and searching. See Customising Browsing and Searching for explanation

Dynamic tiles

The UI uses dynamic tiles to determine, at run time, how to display various objects
See Defining Custom Dynamic Templates for more details

##for subject searches which arent groups, this is the view (to put the subject image)

ObjectAsMap Implementations

Allow sites to provide local implementations of Map wrappers of Grouper objects

Infodots

##if the little yellow "i" images that show help should be enabled

Lite UI settings

 #### Lite UI settings
#cant be subjectId, sourceId, name, description, screenLabel, memberId, or attribute name which is single valued
#comma separated.  will be sorted by sourceId, then the sort field (recommended to be screenName)
simpleMembershipUpdate.exportAllSubjectFields=sourceId, screenLabel, entityId, name, description
simpleMembershipUpdate.exportAllSortField=screenLabel
simpleMembershipUpdate.groupComboboxResultSize=200
simpleMembershipUpdate.filterComboMinChars=3
simpleMembershipUpdate.filterMaxSearchSubjects=1000
#max subjects in drop down
simpleMembershipUpdate.subjectComboboxResultSize=50

# customizer class to customize common things (extend GrouperUiCustomizer)
grouperUiCustomizerClassname =

# kill all cookies with these prefixes on logout (comma separated)
grouperUi.logout.cookie.prefix =

# images (must be in assets/images dir) for subject source id
grouperUi.subjectImg.sourceId.0 = jdbc
grouperUi.subjectImg.image.0 = user.png
#e.g. Chris Hyzer, mchyzer, IT Services
# grouperUi.subjectImg.screenEl.0 = ${subject.name}, $subject.getAttributeValue("netId"), $subject.getAttributeValue("dept")
grouperUi.subjectImg.screenEl.0 = ${subject.description}

grouperUi.subjectImg.sourceId.1 = g:gsa
grouperUi.subjectImg.image.1 = group.png
grouperUi.subjectImg.screenEl.1 = ${grouperUiUtils.convertSubjectToLabel(subject)}

grouperUi.subjectImg.sourceId.2 = g:isa
grouperUi.subjectImg.image.2 = application.png
grouperUi.subjectImg.screenEl.2 = ${grouperUiUtils.convertSubjectToLabel(subject)}

grouperUi.logHtmlDir =
grouperUi.logHtml = false

#if comma separated email addresses are here, then errors will trigger emails (ui-lite)
errorMailAddresses =

See Also

Customizing the Grouper UI