Static Promotion Rules

The following table shows all the fields that you must include in the IDX file for static promotion rules.

NOTE: The rule format described in this table assumes that the documents that you want to promote exist in your IDOL Server data index. OpenText recommends that you promote only indexed content. However, if required, you can also add promotion items into your static promotion IDX. See Promote Non-Indexed Content.

Required IDX fields for static promotion rules

Field Description Content type or value
#DREREFERENCE The reference for the rule. String
#DRETITLE The title of the rule. String
QMSTYPE The type of the QMS rule. 2
QMSAGENTBOOL The AgentBoolean expression used to match the original query text. Boolean matching expression
QMSFIELDTEXT The FieldText rules to match the original query text. FieldText expression
QMSVALUE1 The references of the promotion documents. Comma-separated list of strings
PROMOTION_NAME

The value that QMS must return in the autn:promotionname element. IDOL Data Admin uses this field value as the promotion type. Use one of the following values:

  • Top Promotions. A list of documents that are being promoted internally. Top Promotions are not advertisements.
  • Sponsored. A paid advertisement.
  • Hotwire. Promoted documents that are shown at the top of a results list for a particular keyword, but are noticeably distinct from the list.
String
QMSUSERTYPE The value that QMS must return in the autn:usertype element. String
FIELD_CRITERIA_DATABASEMATCH (Optional) The Content databases that this rule matches. If you include this field, QMS returns the promotions for this rule only if the original query includes a DatabaseMatch parameter with at least one database that matches the FIELD_CRITERIA_DATABASEMATCH.
QMS applies this field only when the original query includes the DatabaseMatch action parameter.
String
QMS_SCOPE_RULE (Optional) You can use this field with the PromotionsScope query parameter to return only promotions that match the text that you specify as the scope rule. This allows you to filter the list of returned promotions by user-defined criteria such as a specific department or job function. String list. Separate items in the list with a comma.
DRECONTENT Terms to match the query text. String

You must also add either:

  • the ALWAYSACTIVE field with the value True.
  • a SCHEDULE field with iCalendar data.

See Schedules for QMS Rules.