Generating Barcodes in Oracle XML BI Publisher (BIP)

NOTE: IDAutomation supports and guarantees that the barcode fonts and Java encoders provided for BIP are fully functional and will function as intended. Barcode integration in BIP is a complex process and should only be performed by developers with knowledge of BIP report design, XML and Java. Because of the complexity involved, IDAutomation will support the Java barcode product with the examples provided in the package from IDAutomation. For troubleshooting purposes, it is recommended to get the examples provided in the licensed Java package working first and then proceed to implement integration with BIP. Issues with BIP should be directed to Oracle Support when the Java product is working properly.

The implementation tutorial presented here creates barcodes in Oracle XML Publisher with RTF templates using the QR Code Font and Encoder. This example is a summary taken from a barcoding blog written by Tim Dexter at the Oracle Website. For assistance with this BIP tutorial and technical support, please refer to the examples provided on the Oracle site:

• Oracle blogs about BI Publisher
  • QR Code
  • Code 128
  • PDF417


• BI Publisher Barcode Font Tutorial Applications and Components
  
  • QR Code Font and Encoder Package (Developer License and up)
  • BI Publisher
  • Microsoft Word
  • BarcodeUtil.java file. Download an example from Tim Dexter's article or download a copy from IDAutomation.
  • Collection of Jar files from the jlib folder of the BI Publisher Desktop install.

1. Install all required applications and components for Word and BI Publisher.


2. Purchase, download, extract, and install the QR Code Font and Encoder (Developer License and up).
   


3. A Java Font Encoder class file is included as .jar with the license. Extract this file and retrieve the .jar.
   


4. Set up the .jar file in your environment. View Oracle's documentation for additional help.


5. Access Tim Dexter's BarcodeUtil.java file available in the qrbarcodes-2.zip.


6. Because the Quick Quips tutorial was created in 2012, the BarcodeUtil.java available in Tim's article has a few outdated parameters. The Encoder section of the tutorial provides an example of the parameters. Open the BarcodeUtil.java file and verify that it is updated to this:
   

   /* Import the idautomation encoder class */
   import com.idautomation.fontencoder.qrcode.QRCodeEncoder;

   QRCodeEncoder qre = new QRCodeEncoder();
   boolean ApplyTilde = false;
   String EncodingMode = "Byte";
   int Version = 0;
   String ErrorCorrectionLevel = "M";
   boolean BestMask = false;
   return qre.FontEncode(DataToEncode, ApplyTilde, EncodingMode, ErrorCorrectionLevel,Version,BestMask);

7. Within the BarcodeUtil.java file, include an encoder call to the IDAutomation_QRCode_JavaFontEncoder.jar :

Class[] clazz = new Class[] { "".getClass() };  
      //ENCODERS.put("code128a",mUtility.getClass().getMethod("code128a", clazz));
      //ENCODERS.put("code128b",mUtility.getClass().getMethod("code128b", clazz));
      //ENCODERS.put("code128c",mUtility.getClass().getMethod("code128c", clazz));
      ENCODERS.put("qrcode",mUtility.getClass().getMethod("qrcode", clazz)); 

This entry will register the encoder method.


8. Verify the IDAutomation_QRCode_JavaFontEncoder.jar is in the classpath.


9. Access the jlib path and place the following jar files in the classpath: xdocore.jar, xmlparserv2.jar, collections.jar, aolj.jar, share.jar, xdoparser.jar, jewt4.jar, 18nAPI_v3.jar.


10. Compile the BarcodeUtil.java file to create a new class. If there are errors, contact Tim Dexter directly.


11. After creating the BarcodeUtil.class, create a jar file to store it in. In the example, Tim Dexter names it barcodejar.jar.


12. Copy the IDAutomation_QRCode_JavaFontEncoder.jar and the barcodejar.jar to the jlib folder within the Template Builder for Word.
    


13. So that BI Publisher can find the wrapper class, all the jars required for the project must be put into  the RTF2PDF.jar which is located in the jlib folder.


14. Make a back up of the RTF2PDF.jar file.


15. Open the RTF2PDF.jar using Winzip or 7zip and access the META-INF directory. Open and edit the MANIFEST.MF to include the jars at the end of the classpath list:
    

    Manifest-Version: 1.0
    Class-Path: ./activation.jar ./mail.jar ./xdochartstyles.jar ./bicmn.jar ./jewt4.jar 
    ./share.jar ./bipres.jar ./xdoparser.jar ./xdocore.jar ./xmlparserv2.jar 
    ./xmlparserv2-904.jar  ./i18nAPI_v3.jar ./versioninfo.jar 
    ./barcodejar.jar ./IDAutomation_JavaFontEncoder_QRCode.jar
    Main-Class: RTF2PDF

16. In order to render the barcode in a PDF report, it must be embedded by referencing the font within a config file in the BI Publisher config folder. Open the xdo example.cfg file located:

17. Add an entry for the IDAutomation2D font in the code area under the font setting:

    
    

    <!--IDAutomation 2D QR Code Font-->
    <font family="IDAutomation2D" style="normal">
    <truetype path="C:\windows\fonts\IDAutomation2D.ttf"/>
    </font>
    

18. Return to Word and access the BI Publisher file. Double-click the field to barcode and choose Add Help Text to open the Form Field.


19. In the Status Bar tab, enter the first command:

    <?register-barcode-vendor:'ENCODER WRAPPER CLASS'; 'ENCODER NAME'?>
    

    
20. In the Help Key (F1), enter the second command:

    <?format-barcode:DATA_TO_ENCODE;'ENCODER_METHOD_NAME';'ENCODER_NAME'?>
    

    
21. To ensure the data is encoded, view the document (PDF,RTF,HTML):
22. Return to the project and select the IDAutomation2D font from the font list. View the document.

• Barcode Integration Guide for Oracle Reports
• IDAutomation Java Barcode Package
• Installing Barcode Fonts on Unix or Linux for Oracle Reports