Update Related Document Stage

Configuration

This index pipeline stage performs a Solr atomic update on an existing document using data pulled from the current document being processed by the pipeline.

Configuration

Tip	When entering configuration values in the UI, use unescaped characters, such as `\t` for the tab character. When entering configuration values in the API, use escaped characters, such as `\\t` for the tab character.

When using Fusion's REST API, the type for this stage is: update-existing-doc.

Property Description, Type

applyLookupCriteria

Only lookup related docs when

Optional criteria to determine if this stage should try to find related documents to update for a given input document

type: string

collection

Collection

Fusion collection to lookup the related document to update; if not set, then the collection is pulled from the index pipeline context

type: string

commitWithinOverride

Commit Within Override

Number of millis to commit the atomic update; if not provided, then the default commitWithin setting for the collection will be used

type: integer

fieldsToUpdate

Fields to Update

required

One or more fields to set on the document; the value can be pulled from the main document or simply a constant provided by this config

type: array of object

object attributes: {
  key (required) : {
    display name: Parameter Name
    type: string
    }
  value : {
    display name: Parameter Value
    type: string
    }
  }

idField

ID Field

Name of the unique key field for the related document to lookup

type: string

default value: 'id'

lookupQuery

Find Related Document (Query)

Solr query to lookup the related document to update; only the first document returned in the results will be used.

type: string

lookupSort

Sort Order

Sort order to select the top document returned for the lookup query results; not used when doing a real-time get.

type: string

realTimeGetQuery

Find Related Document (RTG)

Solr query to lookup the related document to update using a real-time get request; the query should uniquely identify the document to be updated.

type: string

secsToCacheRecentlyUpdatedDocs

Seconds to Cache Recent Updates

Number of seconds to cache recently updated docs to avoid a lookup / redundant update; keep this under a few minutes to avoid missing updates. Set to -1 to disable this behavior.

type: integer