Free-text load and index plugin and message transport

PolicyCenter provides the free-text load and index message transport to send changed policy data to the Guidewire Solr Extension for loading and incremental indexing. In the base configuration of PolicyCenter, the plugin is disabled.

The primary components of this message transport are:

  • A MessageTransport plugin implementation with the following qualities:
    • The implementation class is gw.solr.PCSolrMessageTransportPlugin.
    • The plugin name in the Plugins Registry in Studio is SolrMessageTransportPlugin
    • This class implements the interface called ISolrMessageTransportPlugin, which is a subinterface of MessageTransport with additional methods. In the base configuration, in the Plugins Registry, this plugin implementation specifies its interface name as ISolrMessageTransportPlugin instead of MessageTransport.
  • A messaging destination

Generally, you do not need to modify the PCSolrMessageTransportPlugin implementation if you add or remove free-text search fields.

To edit the Plugins Registry item for the PCSolrMessageTransportPlugin interface, in the Project window in Studio, navigate to configuration > config > Plugins > registry, and then open ISolrMessageTransportPlugin.gwp.

See also

Message destination for free-text search

The implementation of PCSolrMessageTransportPlugin depends on the PCSolrMessageTransport message destination. If the message destination is not enabled or is enabled but not started, the plugin cannot send index documents to the Guidewire Solr Extension. Use the Messaging editor in Studio to enable the PCSolrMessageTransport destination. Use the Event Messages page on the Administration tab in the application to start and stop the destination.

If you enabled the free-text search feature, enable the message transport implementation. The implementation class is gw.solr.PCSolrMessageTransportPlugin, which is an implementation of the MessageTransport plugin interface.

The plugin is enabled in the Plugins Registry in the base configuration. However, you must enable the relevant messaging destination in the Messaging editor in Studio.

Enable the message destination for free-text search

Procedure

  1. In the Project window in Studio, navigate to configuration > config > Messaging, and then open messaging-config.xml.
  2. In the list on the left, select the row for message ID 69.
  3. Ensure that the following fields are set to the following values.

    Field

    Value

    Enabled

    The check box is selected.

    Destination ID

    69

    Name

    Java.MessageDestination.SolrMessageTransport.Policy.Name

    Transport plugin

    ISolrMessageTransportPlugin

    This value is not the fully-qualified name. This value is the name for the plugin in the Plugins Registry editor.

    Poll interval

    1000

    Events

    • ContactChanged
    • ContactAdded
    • ContactRemoved
    • JobPurged
    • PolicyAddressChanged
    • PolicyPeriodAdded
    • PolicyPeriodChanged
    • PolicyPeriodPurged
    • PolicyPeriodRemoved
    • PolicyPurged
    • PreemptedPeriod

    Chunk Size

    100000

    Poll Interval

    1000

    Max Retries

    3

    Initial Retry Interval

    1000

    Message Without Primary

    The Single Threaded option is selected.

ISolrMessageTransportPlugin plugin parameters

The Plugins Registry item with name ISolrMessageTransportPlugin has the following plugin parameters.

Plugin parameter

Description

Default value

commitImmediately

Whether the Guidewire Solr Extension indexes and commits each new or changed index document before receiving and indexing the next one.

If you set this parameter to false, the Guidewire Solr Extension receives a batch of index documents from PolicyCenter before it indexes and commits them. You configure the batch size in the autocommit section of the solrconfig.xml file.

false

debug

For development servers only, specifies whether to generate messages on the server console and in the server log to help debug changes to free-text search fields.

For production, always set to false.

true