History indexing

We will present here a simple example of history indexing in a process.

Configuration

Indexing class

com.axemble.axvdocsearch.extensions.base.implementation.BaseVDPJProcessResourceHistoryIndexExtension

Custom Tags « system »

CustomTag	Description
ID
REFERENCE
PARENTID	Identifier of the parent document
NAME	System name of the triggered action
LABEL	Title of the triggered action
SOURCE	Label of the original step
FULFILLER	User
DESCRIPTION	History Comment
DONEBY	Label of the role involved

Required input parameters

Parameter Name	Description
CONTEXT_LOGIN	Login used to browse the data to be indexed
ORGANIZATION_NAME	System name of the organization attached to the project
PROJECT_NAME	System name of the project (Starting with VDoc 11 versions)
CATALOG_NAME	System name of the application (From VDoc 11 versions onwards, it will be called “process group” instead)
RESOURCE_DEFINITION_NAME	Collection of the system names of the process versions to be indexed (separated by “\|”)

The customtag

It allows you to declare the fields (of the history) to be indexed.

An example of XML configuration

<index name="WorkflowInstanceHistory"
       label="LG_WorkflowInstanceHistory"
       controller="com.axemble.axvdocsearch.core.controllers.implementation.LuceneController"
       extension="com.axemble.axvdocsearch.extensions.base.implementation.BaseVDPJProcessResourceHistoryIndexExtension"
       indexStorePath="axvdocsearch\WorkflowInstanceHistory"
       updateOnIndexedDocuments="true"
       locales="fr" >

    <parameters>
        <parameter key="CONTEXT_LOGIN" value="sysadmin" />
        <parameter key="ORGANIZATION_NAME" value="DefaultOrganization" />
        <parameter key="PROJECT_NAME" value="Project" />
        <parameter key="CATALOG_NAME" value="Group" />
        <parameter key="RESOURCE_DEFINITION_NAME" value="Process_1.0" />
    </parameters>

    <customtag name="PARENTID" type="text" />
    <customtag name="NAME" type="text" />
    <customtag name="LABEL" type="text" />
    <customtag name="SOURCE" type="text" />
    <customtag name="FULFILLER" type="text" />
    <customtag name="DESCRIPTION" type="text" />
    <customtag name="DONEBY" type="text" />
</index>

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