XML configuration

Action

Represents an action in the view of a search. It will be possible to capture the click on an action from a search extension class (afterSelectDocuments).

Example

<actions>
    <action name="myAction" label="LG_MY_ACTION_DISPLAY_LABEL"/>
</actions>

Attributs

Column

Represents a column in a View.

Example

<column name="EXTENSION" label="LG_EXTENSION" type="text"/>

Attributes

Sub-nodes

CustomTag

Exemple

<customtag name="Champlistesimple" type="text" label="LG_Champlistesimple" list="true"/>

Attributs

Sub-nodes

FacetComparator

Attributes

Faceting

A “faceting” mode can be activated on searches (note: the fullText search must be activated).

It is currently not possible to combine faceting and another filtering source. Inconsistent operation occurs if, for example, faceting and filterGroups are combined.

This mode will allow us filtering assistance as the user performs these filters, the spectrum of corresponding documents is reduced. Thus, the filters with choice (lists, checkbox, trees, …) will be reduced automatically.

Example

<faceting sortOrder="byHits" displayHitCount="true" autoExecuteSearch="false"/>

Attributes

Filter

This is a filtering element in a filtergroup (corresponds to filtering, as it could have been done in the interface).

Example

<filter name="myCustomtag" type="text" operator="contents" value="valuetotest" customValue="false" format=""
        normalized="false"/>

Attributes

FilterGroup

The filtergroups allow you to establish “pre-filters” in your searches and therefore to reduce the spectrum of your searches. Filters placed in filtergroups will be added to standard filters and cannot be removed by the user from your searches.

It is currently not possible to combine faceting and another filtering source. Inconsistent operation occurs if, for example, faceting and filterGroup are combined.

Example

<filterGroups>
    <filterGroup default="true" name="myFilterGroup" label="LG_MY_FILTERGROUP">
        <filter.../>
    </filterGroup>
</filterGroups>

Attributes

Sub-nodes

Foreign

It is possible to make links (1..N) between several indexes when you build an index.

It is therefore possible to perform a join to another “sub-index” thanks to a join on the “custom tags” of the 2 indexes.

We have 2 indexes, an index relating to the documents of a process and another index relating to the history of the documents of this process.

We want to find all the documents in which Mr. BERNARD intervened.

We are therefore going to integrate a “customtag” in the main index, pointing to the “intervenor” field of the history index.

In this case the join can be done on the ID of the parent document.

Remark :

• This node is entered in the index concerned (not in the search)
• Customtags resulting from join can be used as filters but not in the columns of search results

Example

<customtag name="Champlistesimpletableau" type="text">
    <foreign indexName="foreignIndexName" localKey="ID" foreignKey="PARENTID" />
</customtag>

<fullText>
<foreigns>
    <foreign indexName="foreignIndexName" localKey="ID" foreignKey="PARENTID" />
</foreigns>
</fullText>

Attributes

FullText

Used for fulltext search definition on a linked index (foreign).

Example

<fullText>
    <foreigns>
        <foreign indexName="foreignIndexName" localKey="ID" foreignKey="PARENTID"/>
    </foreigns>
</fullText>

Sub-nodes

IFormulaSupport

ITooltipsSupport

Index

Represents the index, the storage “table” for your indexed items.

Example

<index name="myIndexUniqueName"
       label="LG_myIndexUnique"
       controller="com.axemble.axvdocsearch.core.controllers.implementation.LuceneController"
       extension="CLASSE D'INDEXATION"
       indexStorePath="vdocsearch\myIndexUniqueName"
       updateOnIndexedDocuments="true"
       locales="fr">

    <parameters>
        <!-- Input parameters for my indexing class -->
        <parameter key="PARAM1" value="VALUE1"/>
        <parameter key="PARAM2" value="VALUE2"/>
    </parameters>
    ...
</index>

Attributes

Sub-nodes

Job

This use allows you to declare your own jobs.

Let’s imagine the following case: I have 3 indexes in my XML; for the first 2, the data source is updated at night and the amount of data being large, indexing is quite long.

On the other hand, my 3rd index is very small but the source data is constantly updated. If I schedule my agent every hour (what it would take for my 3rd index), I will unnecessarily reindex my first 2 indexes, which will greatly slow down my Process instance.

Example

<job name="caseBaseDirectoryUserIndexExtension" agent="caseBaseDirectoryUserIndexExtension">
    <index name="caseBaseDirectoryUserIndexExtension"/>
    <index name="caseBaseFileCenterIndexExtension"/>
</job>

Attributes

Sub-nodes

LifeCycleStatus

Attributes

MoreLikeThis

Can be activated on a search.

Search for related documents from a search result.

If you activate this mode, on a search result, the user can request a search for the documents of the index closest to a given result.

Example

<moreLikeThis countDocuments="5"/>

Attributes

ResultGroups

This node will allow us to work on the search results: it is a question of grouping them according to a logic; this logic is encoded in extension classes.

Process offers two classes of resultgroups by default:

Example

<resultGroups
        extension="com.axemble.axvdocsearch.extensions.implementation.IResultGroupsExtension.CustomTagResultGroupsExtension">
    <parameters>
        <parameter key="customTagKey" value="Champlistesimple"/>
    </parameters>
</resultGroups>

<resultGroups
        extension="com.axemble.axvdocsearch.extensions.implementation.resultgroups.CustomTagResultGroupsExtension">
    <parameters>
        <parameter key="customTagKey" value="Champlistesimple"/>
    </parameters>
</resultGroups>

Attributes

Sub-nodes

Search

Design of advanced search interfaces (= search form).

Example

<search name="SEARCH NAME"
        label="SEARCH_LABEL"
        sourceIndexes="INDEX_NAME"
        securityExtension="com.axemble.axvdocsearch.extensions.implementation.ISecurityExtension.VDocSecurityExtension"
        fullTextInput="true"
        defaultViewRowsPerPage="10">
    ...
</search>

<search name="SEARCH NAME"
        label="SEARCH_LABEL"
        sourceIndexes="INDEX_NAME"
        securityExtension="com.axemble.axvdocsearch.extensions.implementation.security.VDocSecurityExtension"
        fullTextInput="true"
        defaultViewRowsPerPage="10">
    ...
</search>

Attributes

Sub-nodes

Section

Used to order the CustomTag. If we use Section all CustomTags must be in sections.

Example

<section name="1" label="LG_VDOC_SECTION">
    <customtag name="login" type="text" label="LG_LOGIN" />
</section>

<section name="2" label="LG_USER_SECTION">
<customtag name="FirstName" type="text" label="LG_FIRST_NAME" />
<customtag name="LastName" type="text" label="LG_LAST_NAME" />
</section>

Attributes

Sub-nodes

Template

Allows you to modify the rendering of the view using the Process template system. You can use a formula with the @LOC function to retrieve translations ex : ${@LOC(“LG_TRAD_KEY”)} Template can also be enhanced with extensions : Using formula extension in XML

Example

<templates>
    <template name="myTemplate">
        <![CDATA[
            <div>
                <div class="creation-date">
					<h2>${@LOC("LG_TRAD_KEY")} - ${TITLE}</h2>
					$CREATIONDATE$
                </div>

                <div class="typname">
                    $TYPNAME$
                </div>
            </div>
        ]]>
    </template>
</templates>

Attributes

View

We will define here the structure of the search results. What information do we need to show to the user?

Example

<view linksTarget="_blank">
    <column name="EXTENSION" label="LG_EXTENSION" type="text"/>
</view>

Attributes

Sub-nodes

Source : https://wiki.myvdoc.net/xwiki/bin/view/Dev+Floor/XtendedSearchDocumentationXML