View Source

GROUPER: About FAQ Software Documentation Contribute WG Contact

This is an archived page. To view the current page, please see UI Building and Configuration. Thanks!

Configuring and Deploying the Grouper UI v1.0

In this section we describe how to configure, build, and deploy the Grouper UI.

Section	Description
Lightweight UI Configuration	Just a few easy bits, leaving in-depth coverage of the UI's extensive customization capabilities to the Grouper UI Guide.
Building & Deploying	All about building and deploying the UI.

Lightweight UI Configuration

In this subsection we'll describe how to replace the logo image included in the Grouper UI tarball and highlight a couple of settings in the grouper-ui/resources/grouper/media.properties file that control how the UI uses subject attributes.

Using Your Own Logo Image

Place the image file in grouper-ui/webapp/grouper/images/.
Replace the "image.organisation-logo" property in grouper-ui/resources/grouper/media.properties with the name of the file emplaced in the previous step.

Controlling the Use of Subject Attributes in the UI

Subjects are presented in the UI in various contexts. The Grouper UI supports a limited capability to control which subject attributes are displayed in which contexts. Here's a list of associated properties in the grouper-ui/resources/grouper/media.properties file and how to use them.

Property Name	Description	Possible Values
subject.default.attribute	The default attribute used to identify any subject. Might be superseded by other configuration declarations.	Any subject attribute common to all subjects presented by source adapters. The minimum set available by default is determined by the Subject API. Under Subject API v0.2.1, those values are: name, description, and subjectId.
group.default.attribute	The default attribute used to identify any group. Might be superseded by other configuration declarations.	Any group naming attribute: name, displayName, extension, displayExtension, id.
stem.default.attribute	The default attribute used to identify any stem. Might be superseded by other configuration declarations.	Any stem naming attribute: name, displayName, extension, displayExtension.
search.group.result-field	The name of the group naming attribute displayed in search results and on the "saved groups" page.	Any group naming attribute: name, displayName, extension, displayExtension, id.
search.stem.result-field	The name of the stem naming attribute displayed in search results.	Any stem naming attribute: name, displayName, extension, displayExtension.

In the case of groups or stems displayed in search results, the media properties above only determine defaults. UI users are enabled to change the default for a UI session. The range of options they are presented are given in the following table.

Property Name	Description	Possible Values
search.group.result-field-choice	The set of choices of naming attributes that a UI user is presented with for display of groups in search results. If the set is empty, the user cannot change the default.	Space-separated list of zero or more of any of the group naming attributes: name, displayName, extension, displayExtension, id.
search.stem.result-field-choice	The set of choices of naming attributes that a UI user is presented with for display of stems in search results. If the set is empty, the user cannot change the default.	Space-separated list of zero or more of any of the stem naming attributes: name, displayName, extension, displayExtension.

Building & Deploying

Copy grouper-ui/build.properties.template to grouper-ui/build.properties.
Review grouper-ui/build.properties.
- If you want the build script to automatically install the UI in your Tomcat instance, uncomment and set the appropriate value for deploy.home. If you do not set this you will need to copy the UI to your Tomcat installation's webapps directory. You will probably want to define the default.webapp.folder to suit how you intend to develop or customise the UI. See the Grouper UI Development Environment for options.
- Make sure you set the grouper.folder property to the location of your Grouper installation.
Copy grouper-ui/template-tomcat-context.xml to grouper-ui/tomcat-context.xml (or the value of the property deploy.context.xml if you have changed this).
- Tomcat specific configuration can be added in this file e.g., container managed data sources.
Change directory to grouper-ui and type "ant".
- A list of build targets is displayed. If you have set deploy.home enter "default". Otherwise type "dist" or "war". If the former copy <dist.home>/grouper to <TOMCAT_HOME>/webapps, or if the latter, copy <dist.home>/grouper.war to <TOMCAT_HOME>/webapps.
- If you want to take advantage of the 'nice' targets you must uncomment and set appropriate values for all the deploy properties in grouper-ui/build.properties.
  
  Note: The build process will attempt to create a directory peer to the grouper-ui directory. Hence, the directory grouper-ui/.. must be writable.

Questions or comments? Contact us.

GROUPER: About FAQ Software Documentation Contribute WG Contact