Access

Define access to the search form.

To a team

A search form can be linked to a user team through a property that can be set via:

  • the CLM and the scope.xml file:

    Team example

    <profiles>
    	<name>ALL_USERS</name>
    	<Description>User profile</Description>
    	<principals>ou=users,dc=arondor,dc=com</principals>
    	<properties>
    		<ns3:name>search.template</ns3:name>
    		<ns3:value>RechercheAgent(fr=Agent search,en=Agent search)</ns3:value>
    	</properties>
    </profiles>

  • the administration console: in the Security > Teams > Properties section, add a Search form property


This property has the following value: <identifiant>(<langue>=<libellé>,<langue2>=<libellé2>) for example template_id(fr=form label,en=form label)



If no label is entered, the title from the search form will be used.

To a virtual folder

Filters can be configured within a virtual folder and the search used can be overloaded to add or hide columns in the list of results.

Tab

To do this, simply follow the naming convention for the search bean as follows:

  • to apply the form to all searches in the virtual folder, use the following bean name: content{VirtualFolder class id with first letter in uppercase}VirtualFolder

    Example: for the CourrierCollective virtual folder class, the name of the associated search form bean will be contentCourriercollectiveVirtualFolder

  • to apply the form to one of the searches in a virtual folder, use the following bean name: content{VirtualFolder class id with first letter capitalized}VirtualFolder{search id with first letter capitalized}

    Example:for the CourrierCollective virtual folder class with the CourrierSearch search, the name of the associated search form bean will be contentCourriercollectiveVirtualFolderCourriersearch

  • to apply the form to this search for all virtual folders, use the following bean: contentVirtualFolder{search id with first letter in uppercase}

    Example: for the CourrierSearch search, the name of the associated search form bean will be contentVirtualFolderCourriersearch


Example

	<bean id="contentCourriercollectiveVirtualFolderCourriersearch" 
		class="com.flower.docs.gui.client.search.ComponentSearchPresenter"
		scope="prototype">
		<property name="responsePresenterProvider">
			<bean
				class="com.flower.docs.gui.client.search.response.TableSearchResponsePresenterProvider" />
		</property>
		<property name="categorySelectorPresenter">
			<bean
				class="com.flower.docs.gui.client.search.criteria.item.FakeCategorySelectorPresenter">
				<property name="value">
					<value type="com.flower.docs.domain.component.Category">TASK</value>
				</property>
			</bean>
		</property>
		<property name="keywordCriteriaPresenter">
			<bean
				class="com.flower.docs.gui.client.search.criteria.KeywordCriteriaPresenter">
				<property name="enabled" value="false" />
			</bean>
		</property>
		<property name="hiddenColumns">
			<list>
				<value>status</value>
				<value>classid</value>
				<value>B_DirectionDestinataire</value>
			</list>
		</property>
		<property name="advancedCriteriaPresenter">
			<bean
				class="com.flower.docs.gui.client.search.criteria.advanced.AdvancedCriteriaPresenter">
				<property name="enabled" value="true" />
				<property name="forceOpen" value="true" />
				<property name="inline" value="false" />
				<property name="displayClassSelector" value="false" />
				<property name="addEmptyCriterion" value="false" />
				<property name="showSearchButton" value="true" />
				<property name="searchButtonTitle">
					<list>
						<bean class="com.flower.docs.domain.i18n.I18NLabel">
							<property name="language" value="EN"/>
							<property name="value" value="Filter"/>
						</bean>
						<bean class="com.flower.docs.domain.i18n.I18NLabel">
							<property name="language" value="FR"/>
							<property name="value" value="Filtrer"/>
						</bean>
					</list>
				</property>				
				<property name="fixedCriterionPresenters">
					<list>
						<ref bean="ObjetCriterion" />
						<ref bean="DateCriterion" />
						<ref bean="NomAdherentCriterion" />
					</list>
				</property>
				<property name="searchableCriteria">
					<list>
						<value>B_DateCourrier</value>
						<value>B_NomClient</value>
						<value>B_ObjetCourrier</value>
					</list>
				</property>
			</bean>
		</property>
	</bean>

Indexation

The definition of a search form for a virtual folder in indexing is very similar to the one in tabbing, you just need to respect the naming convention of the search bean as follows:

  • to apply the form to all searches in the virtual folder, use the following bean name: content{VirtualFolder class id with first letter in uppercase}VirtualFolder{Phase}

    Example: for the CourrierCollective virtual folder class under modification, the name of the associated search form bean will be contentCourriercollectiveVirtualFolderModify

  • to apply the form to one of the searches in a virtual folder, use the following bean name: content{VirtualFolder class id with first letter in uppercase}VirtualFolder{Phase}{search id with first letter in uppercase}

    Example:for the CourrierCollective virtual folder class with the CourrierSearch search, the name of the associated search form bean will be contentCourriercollectiveVirtualFolderModifyCourriersearch

  • to apply the form to this search for all indexed virtual folders, use the following bean: contentVirtualFolder{Phase}{search id with first letter in uppercase}

    Example: for the CourrierSearch search, the name of the associated search form bean will be contentVirtualFolderModifyCourriersearch

NB: The available values for the phase are: Modify and ReadOnly.