Implementing Barcodes as an Ancillary Output Option

Implementing a barcode involves identifying the need to apply a barcode to a document, defining requirements such as appearance, labeling, and the barcode type to apply. Then you must submit the request with the instructions for the barcode and the transaction data to process the barcode instructions.

Barcodes are only applied to PDF and RTF documents generated by the Expere Engine and are added to all generated pages; that is, each generated page in the document and document within a package. The ability to selectively apply barcodes to specific pages in a document is not supported. The barcode object can be submitted as part of the AncillaryOutputObjects on a document generation request to generate barcodes on all PDF or RTF documents in a requested package or can be submitted on the DocumentSet or Document object on a document generation request to generate unique barcodes on a document by document basis.
Note: Barcodes can be rendered with dynamic, static, and embedded PDF REQ files. However, QR Barcodes can only be rendered using an AncillaryOutputOption of "barcodeQR"

Barcodes are implemented as part of the AncillaryOutputOptions object on several operations used to generate documents, including Generate, SelectAndGenerate, SelectGenerateDeliver (where applicable), Process, SelectGenerateAndSave (where applicable), and AssembleDocuments (where applicable.).

The DocumentSet object is used to apply a unique barcode to individual documents.

To implement barcoding on a document through these API calls, you must first define the parameters of the barcode in the Barcode object and then submit that object on the AncillaryOutputOptions object submitted in the request. Following is an example of an AncillaryOutputOptions submitted on a request that will generate a barcode. 
<exp:AncillaryOutput>
 <!--Zero or more repetitions:-->
 <exp:AncillaryOutputOption>
 <exp:OutputType>Barcode</exp:OutputType>
 <exp:Barcode>
 <exp:Type>barcode128</exp:Type>
 <exp:Pattern>Page_%page%_of_%totalpages%_%date%_Doc_%docsequence%_of_%docsequencetotal%</exp:Pattern>
 <exp:UseCoverPage>True</exp:UseCoverPage>
 </exp:Barcode>
 </exp:AncillaryOutputOption>
</exp:AncillaryOutput>
The barcode is rendered on a generated document, as follows:

Specifying the barcode height; Expere supports specifying a per-document ancillary barcode height; the barcode height authored in the <Tagline/> element within the .REQ file will be applied to that document's ancillary barcode. For more information, see Requirements Editor User Guide: Implementing Barcodes as an Ancillary Output Option
Note: Consider the following:
  • Barcode height can be specified for all Expere-supported ancillary barcode types.
  • If no value is specified, then apply the default height value.
  • In scenarios where the barcode type is authored in the REQ while the ancillary specifies a different barcode type, the ancillary barcode type will take precedence.
  • If a document has a footer and a barcode height defined, it is possible the amount of space defined for the footer will need to be adjusted to get the desired output.
  • The maximum barcode height is 44 points / .61 inches. If a larger space is specified when authoring the barcode, additional white space will be reserved, but the barcode height will be 44 points/.61 inches.