Legacy Product

Fusion 5.10
    Fusion 5.10

    Update Related Document Stage

    Table of Contents

    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

    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.

    This stage performs an atomic update on an existing document that is related to a document currently being processed in the pipeline. For instance, you can use this stage to set the 'has_clicks' flag on a request signal when the first click signal is indexed.

    skip - boolean

    Set to true to skip this stage.

    Default: false

    label - string

    A unique label for this stage.

    <= 255 characters

    condition - string

    Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.

    realTimeGetQuery - string

    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.

    lookupQuery - string

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

    lookupSort - string

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

    applyLookupCriteria - string

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

    fieldsToUpdate - array[object]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

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

    collection - string

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

    idField - string

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

    Default: id

    commitWithinOverride - integer

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

    secsToCacheRecentlyUpdatedDocs - integer

    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.