Query Manipulation Server 24.2

# Promote Non-Indexed Content

In most cases, OpenText recommends that you set up promotions that promote content that exists in your IDOL Server data index. However, in some cases you might need to promote a document that you do not want to index.

To promote content that does not exist in an index, you can use the same rule format as for other static promotions, except:

- you exclude the `QMSVALUE1` field.

- you include the fields described in the following table.

  Additional IDX fields for static promotion rules that promote non-indexed content

  Field | Description | Content type or value
  --- | --- | ---
  `QMS_PROMOTION_ITEMS` | Data for promotions that do not exist in the Content database. | String list with document fields. Separate items in the list with `\n` and then percent-encode the list.
  `QMS_PROMOTION_ITEM_COUNT` | The number of promotions included in the `QMS_PROMOTION_ITEMS` field. | Number

The `QMS_PROMOTION_ITEMS` field contains the promotion content (percent-encoded).

The promotion items have a similar structure to an IDX document, except that field names do not have a hash (#) at the start.

Each promotion item must contain a `DOCREFN` field., where `N` is the number of the promotion item (starting from zero).

Promotion items can also optionally contain the fields listed in the following table. Each field in the promotion item must start on a new line.

`DOCSUMMARYN` | A document summary.
`DRETITLEN` | The document title.
`DOCIMAGEN` | A reference to an image file to use in the document.
`DREFIELDN SubFieldName` | A document field. These fields use the same format as fields in an IDX document.

TIP: In query results, you can hide or display these fields in the same way as normal document fields, by using appropriate options in the `Print` query parameter.

## Example Promotion for Non-Indexed Content

The following QMS rule returns when you send a query for promotions that contains one or more of the terms cat, dog, or pet in the query text. QMS then returns two promotion items, which are shown below the text.

    #DREREFERENCE static_promotion
    #DRETITLE pet_promotion
    #DREDBNAME ACTIVATED
    #DREOUTPUTENCODING UTF8
    #DRELANGUAGETYPE englishUTF8
    #DREFIELD QMSAGENTBOOL="cat OR dog OR pet"
    #DREFIELD PROMOTION_NAME="static_promotion_2"
    #DREFIELD QMSTYPE="2"
    #DREFIELD QMS_PROMOTION_ITEMS="DRETITLE0%20All%20Your%20Pet%20Needs%0D%0ADOCREF0%20http%3A%2F%2Fwww.example.com%2Fpets.html%0D%0ADREFIELD0%20TYPE%20advert%0D%0ADREFIELD0%20PETLISTING%20cats%20and%20dogs%0D%0ADRETITLE1%20How%20to%20Look%20after%20Your%20Pet%0D%0ADOCIMAGE1%20http%3A%2F%2Fwww.example%2Fcom%2Fkittem.jpg%0D%0ADOCREF1%20http%3A%2F%2Fwww.example%2Fcom%2Fpetcare.html%0D%0ADREFIELD1%20TYPE%20instructional%0D%0ADREFIELD1%20PETLISTING%20cats%20and%20dogs%0D%0A"
    #DREFIELD QMS_PROMOTION_ITEM_COUNT="2"
    #DREFIELD ALWAYSACTIVE="True"
    #DRECONTENT
    CAT DOG PET
    #DREENDDOC

The two unencoded promotion documents are:

    DRETITLE0 All Your Pet Needs
    DOCREF0 http://www.example.com/pets.html
    DREFIELD0 TYPE advert
    DREFIELD0 PETLISTING cats and dogs

    DRETITLE1 How to Look after Your Pet
    DOCIMAGE1 http://www.example/com/kittem.jpg
    DOCREF1 http://www.example/com/petcare.html
    DREFIELD1 TYPE instructional
    DREFIELD1 PETLISTING cats and dogs

Copyright 2024 Open Text
Version 24.2 | Last updated March 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Query Manipulation Server 24.2

Topic Title: Promote Non-Indexed Content