<BANNER>

Use the <BANNER> command in the START:, DOCUMENT:, PRESORTED:, or FINISH: section of the rules to specify placement of the banner pages defined in the Banner tag group. EngageOne™ Enrichment places banner pages in the order in which it processes <BANNER> commands in the rule file.

Note: When presorting, you must add banners in the PRESORTED: section of the rules (for those outputs being presorted). If you add banners for presorted documents in the DOCUMENT: section, they are lost when presort occurs.

The <BANNER> command is similar to the <APPEND> command but it only adds objects defined by the <BANNER> tag group before or after the current document.

If you use the <BANNER> command within the START: or FINISH: section of the rules, there is no current document so no documents are written when you use the <OUTPUT> command there. However, you should still specify an <OUTPUT> command as an indicator of where to direct the banner. If you don’t specify an <OUTPUT> command, EngageOne™ Enrichment adds the banner to all non-empty Output groups. For example, the code shown below will add banners to the beginning of three outputs. 

START:
 <OUTPUT> Output1
 <BANNER> TrayBreakBanner BEFORE
 <OUTPUT> Output2
 <BANNER> TrayBreakBanner BEFORE
 <OUTPUT> Output3
 <BANNER> TrayBreakBanner BEFORE
Note: For each of the outputs above, EngageOne™ Enrichment will write the banner when the first document is added. EngageOne™ Enrichment will write no banner for Output4. If an output stream contains no documents, EngageOne™ Enrichment won't write banner pages for it.

Syntax

The <BANNER> command syntax is:

<BANNER> name [place]

name identifies the banner pages to add, duplicating the value of a Banner group <NAME> tag.

[place] is one of the following:

  • B[EFORE] Add the banner immediately before the current document. If B[EFORE] is used in the Finish section and there is a reject file, the banner is added at the end of the output file.
  • A[FTER]Add the banner immediately after the current document. If A[FTER] is used in the Finishsection and there is a reject file, the banner is added at the end of the reject file. A[FTER] is the default
  • P[RIOR] Add the banner immediately after the previous document
Note: Setting place to PRIOR will not cause a banner to follow a document that is in a different output group than the current document.
Note: EngageOne™ Enrichment will not add banners to an empty output file unless <BANNER> is used with <FILEBREAK> in the FINISH section of the rule file.

For example:

IF CHANGED(%%ZIPCODE) THEN
 <BANNER> banner1 BEFORE
ENDIF

This example adds a banner page between each ZIP Code™.

The <BANNER> command can be used in any section of the rule file except the PAGE section.