Historique de la page

...

• Maven 2.2.1
• Apache ant 1.8.0
• Tomcat 5.5.27
• A text editor (ex : Notepad)

...

• Step 3 : If you want to install ESCO­Grouper in Portlet mode (uPortal 2.6 + https), edit Tomcat "server“server.xml" xml” file and add "emptySessionPath“emptySessionPath=true" true” for all the <connector> tags :

...

Warning : if BUILD SUCCESSFUL shows up at the end of Ant script, it doesn't necessarily mean that the build is successfully completed. To be sure that all was fine, you must check that no "BUILD FAILED" “BUILD FAILED” appears in the Maven tasks.

...

If the application is already installed, the derby database already exists, and you just want to modify some files in the "properties" “properties” directory which are not derby ones (strategies for example), you must do the following :

...

This task can start cleaning projects in order to return to a pristine state before any new compilation.

ant init

This task runs a "dbinit"“dbinit”, copies the generated files in the project, and build the project.

...

This task generates the SQL file (from the properties files and the i18n files) which will be used to fill the DERBY database.

Some warnings concerning "duplicate keys" “duplicate keys” could show up. Often, this is normal because some keys are used for the same attribute on different pages.
For example, the "extension" “extension” attribute is used in the group property page and in the folder property page. The same label (extension.label) is used.

Cette tâche permet de générer le fichier sql permettant d'alimenter d’alimenter la base de données mémoire à partir des fichiers de paramétrage ainsi que les fichiers d'internationalisationd’internationalisation.

ant deploy

This task deploys the war created on your Tomcat.

...

All the config files are located in the " “ ESCO­Grouper/properties" properties” directory.

Ancre
build.properties build.properties

build.properties

...

...

It's ESCO­Grouper properties' file.

Ancre
ParametrageApplicatif ParametrageApplicatif

Application's settings (Derby database)

...

The files are referenced in the "build“build.xml" xml” file.
You can edit that file, and change the properties' file names or even add some others files.

...

• Parameters required by the database generation step.
• Parameters required by the whole application.

"“global.lang" ” allows to define the application's languages. It can be used to check, during the internationalization files generation step, that all labels are filled in each language.

"“default.rule.regexp.*" ” defines the regular expression used if no expression is defined for fields validation.

...

Example :
The default behavior when the ESCOGroupNotSaveException is fired is to display the message : "Le “Le groupe n'a pas été enregistré"enregistré”.
You can change that message by changing the corresponding key. For example, if you wanna change that message for the group's properties summary screen, you just have to create the following key in the Error_XX file :

...

Contextual help labels are located in the internationalization files and have their keys ending with "“_TITLE"TITLE”.
If the key is missing, something like "“???KEY???" ” will shows up.
If you don't wanna display the contextual help for an element, simply remove the value of the key. For example :

...

Ancre
Strategies Strategies

Stratégies

Persons Search

The "grouper­api­strategy“grouper­api­strategy.xml" xml” file allows to define the persons search strategy to use depending on an evaluated expression.

...

• term : the search term, which could contain joker characters ;
• path : the path from which the search is run ;
• person : the person executing the search.

Groups search

The "grouper­client­strategy“grouper­client­strategy.xml" xml” file allows to define the groups search strategy to use depending on an evaluated expression. This file is located in "ESCO­Grouper“ESCO­Grouper/ext/grouper­client.fragment/src/main/ressources/spring" spring” directory.

<bean id="defaultStrategyGroupLocator" class="org.esco.grouperui.services.grouper.internal.locator.DefaultStrategyGroupLocator">
	<property name="evaluator" ref="evaluator" />
	<property name="defaultSearchStrategies" >
		<map>
			<entry key="evaluator.regexp('(.*)', term)" value-ref="defaulStrategyGroupSearch"></entry>
		</map>
	</property>
</bean>

...

• field : the attribute on which the user is searching. (values can be "name", "displayName" and "extension"“name”, “displayName” and “extension”) ;
• type : search type (simple or for adding purpose). Values can be "SIMPLE" or "ADD" “SIMPLE” or “ADD” ;
• path : the path from which the search is run ;
• term : the search term, which could contain joker characters ;
• subject : the person executing the search.

Default rule displayed when creating a dynamic group

The "group­dynamic­strategy“group­dynamic­strategy.xml" xml” file allows to define the default rule which will be displayed when creating a dynamic group. Again, it's based on a regular expression which will be evaluated.

...

The profile mechanism is explained in « ESCO­Grouper ­ Manuel de développement v1.00.pdf ».
The important thing to know is that there are some "“*Profile.xml" ” files you can modify to allow or deny features depending on users.

...

This example file will create a "“testProfile" ” profile which will allow users to access folders properties in ESCO­Grouper.
You'll find at the end of that document all the available keys that could be used to define your profiles.

...

The SMTP server is used to send mails when technical errors occurs.
The "smtp“smtp.xml" xml” file should only be modified when you want to use several SMTP servers with ESCO­Grouper.
If you only have one SMTP server, the configuration should be done in "ESCOGrouper“ESCOGrouper.properties" properties” file.

Ancre
AideEnLigne AideEnLigne

Online Help

The Help_XX.properties file, located in "ESCOGrouper“ESCOGrouper/metier/escoweb/src/main/resources/properties/i18n/bundles/screen"screen”, is in charge of the mapping between the screen aliases and the files containing the help contents.
For example, here is the key associated to the navigation's area online help :

...

This file contains filters used to create Grouper's configuration's files ("grouper­client“grouper­client.properties"properties”, "sources“sources.xml"xml”, "grouper“grouper.hibernate.properties" properties” and "log4j“log4j.properties"properties”). When you'll compile the project with Maven, these variables will be replaced in the corresponding files.

Environment variables required in

...

“grouper.client.

...

properties”

Environment variables required in

...

“sources.

...

xml”

Environment variables required in

...

“grouper.hibernate.

...

properties”

Environment variables required in

...

“log4j.

...

properties”

...

This is the main Spring beans definition file. It allows to define the authentication type for the application (local with specific users or CAS). The users in local authentication are defined in "auth­form“auth­form.xml" xml” file.

Dynamic groups

The "dynConfig“dynConfig.properties" properties” file of the dynamic group project must be configured to setup the dynamic group feature. It's located in "ESCOGrouper“ESCOGrouper\metier\esco­module\dynamique­groupe\src\main\resources\properties" properties” directory

Summary table of possible keys for the profile management

...