PDF417 Font & Encoder User Manual

1. Extract the files provided with the product and run the installation executable to install the required files in the Application folder.
2. Open the VB editor in Excel or Access:
   Access 2000-2003: select Tools - Macro - Visual Basic Editor.
   Access 2007-2010: select the Database Tools tab - Visual Basic.
   Excel 1997-2003: select Tools - Macro - Visual Basic Editor.
   Excel 2007: Add Developer tab, if not already there. Right click on the Office Button in upper left corner of Excel screen and choose "Customize Quick Access Toolbar". Click on "Popular" at the top of the list on the left and then Click "Show Developer Tab in the Ribbon" and save. Now go to Developer - Visual Basic - File - Import File
   Excel 2010: Add Developer tab, if not already there. Go to File - Options - Customize Ribbon, Select "Developer" under Main Tabs on the right hand side and click ok. Now go to Developer - Visual Basic - File - Import File
3. If importing the IDAutomation_PDF417_Macro.bas module, select Tools - References - IDAutomation PDF417 Barcode and then click ok.
4. In the VB editor, select File - Import File and choose the module to import from the VBA folder. The native IDAutomation_Native_PDF417_Macro.bas module is only supplied in the purchased version of the product.
5. If Excel or Access is being used, close the VB editor by selecting File - Close, then choose File - Save.
6. After the file has been imported, the IDAutomation_PDF417 function may be called according to the chart below. The zero digit is the default for all parameters, which are optional, and is used for automatic mode or a false setting. The one digit is used for a true setting. Parameters of the functions are defined in the API section of this manual.
    

   IDAutomation_Native_PDF417_Macro.bas
   IDAutomation_PDF417(DataToEncode As String, Optional EccLevel As Integer, Optional ColumnSpecify As Integer, Optional RowSpecify As Integer, Optional Truncate As Integer, Optional ForceBinary As Integer) As String	Access Example =IDAutomation_PDF417([Test Data.data]) or =IDAutomation_PDF417([Test Data.data],2,4,0,0,1)
   IDAutomation_PDF417_Macro.bas
   IDAutomation_PDF417(DataToEncode As String, Optional EcLevel As Integer, Optional TotalColumns As Integer, Optional TotalRows As Integer, Optional Truncated As Integer, Optional PDFMode As Integer, Optional ApplyTilde As Integer) As String	Example =IDAutomation_PDF417([Test Data.data],2,4,0,0,0,0)

1. Run the .exe file in the package and follow the steps to install the product.
2. Open an Access report in design mode.
3. Select Insert - ActiveX Control and choose the IDAutomation PDF417 control.
4. Adjust and size the control as necessary. To change the properties of the control such as height and symbology type, right-click on the control and select Properties.
5. To bind the control to a data source, enter the table and field or formula in the control source field. The proper barcode will display after the report is saved and executed.
   
   Please review the ActiveX Barcode Control User Manual for more about ActiveX barcode generation in Access.

1. Run the .exe file in the package and follow the steps to install the product.
2. Import the VBA module into the Access database.
3. Open an Access report in design mode.
4. Add a text field to the report where the barcode will be positioned. Size the field appropriately so that it is large enough to display the barcode. Change the field's font point size to 8.
5. Right-click the text field and enter the function call as a formula in the control source property. For example:
   

   =IDAutomation_PDF417([Test Data.data])

   The following formula combines 2 fields into a single symbol and inserts a tab function between them:
   

   =IDAutomation_PDF417([Test Data.TextData] & Chr(9) 
   & [Test Data.NumberData])

6. Save the report and run it. A special data string should appear in the text field, and this is the data that will create a correct barcode when combined with the PDF417 Font.
7. Open the report in design mode and select the appropriate IDAutomation PDF417 font for the text field.
8. Save the report and run it; a correct PDF417 barcode symbol should display in the text field.

• The Native Linear + 2D Barcode Generator for Access is an object that lives in the Access report itself, thus eliminating the need to install fonts or components such as ActiveX Controls or plug-ins. This product is not available as part of the PDF417 font and encoder packages, and must be purchased separately.

The Crystal Reports UFL is designed to work with Crystal Reports 6.0 and above. However, because of a Crystal Reports limitation prior to Version 9, only limited information (up to about 40 ASCII characters or 30 binary characters, which allows up to 254 characters in a string) may be encoded with the ECC level set to 1 and the number of columns set to 10. Approximately 50 ASCII characters may be encoded if the truncate option is selected, as shown in this example formula:

IDAutomationPDF417EncoderPDFSet({Table.Field}, 
1, 10, 0, 1, 1, 0 )

If the PDF417 symbol exceeds 10 columns or 3 rows, the barcode will be damaged because of the formula truncation. To overcome this limitation, version 9 or greater is required.

Crystal Reports versions 9 and later resolve the 254-character limitation by using a formula that retrieves the data encoded in 254-byte chunks. A simple example of creating a PDF417 barcode in Crystal is included in the Font and Encoder package.

1. After installing the PDF417 Font and Encoder for Windows, the IDAutomationPDF417Encoder functions will be available in Crystal Reports.
2. The IDAutomationPDF417EncoderPDFSet function returns the number of data segments contained in the barcode, and sets up the barcode for retrieval. All fields passed to the encoder set function must be text fields, or they must be converted to text.
3. The IDAutomationPDF417EncoderPDFGet function returns a string for the designated data segment. A correct barcode string is achieved when all data segments are combined.
4. When the barcode string is combined with the appropriate font, it will produce a PDF417 barcode.

1. Select View - Field Explorer, then Formula Fields. Right-click and select New. Enter a name to identify the formula created and choose OK.
2. The Formula Editor should now appear.
    
   • If using the Native Formula, change the Formula Syntax to Basic Syntax. Copy and paste the text from the Native Formula for IDAutomation PDF417 Fonts.txt file into the Formula Editor dialog box. The Native Crystal Report Example.rpt file is provided in this package as an example, and may be referred to for troubleshooting purposes.
      
   • If using the UFL Formula, copy and paste the code below into the Formula Editor dialog box. The Crystal Reports Example.rpt file is provided in this package as an example, and may be referred to for troubleshooting purposes:
     

     stringVar CompleteBarcodeString:="";
     stringVar DataToEncode:= {Table.Field};
     numberVar i:=0;
     numberVar Segments:= IDAutomationPDF417EncoderPDFSet(DataToEncode,0 
     ,0 ,0 ,0 ,0 ,0 );
     For i:=0 to Segments Do
     (
     CompleteBarcodeString := CompleteBarcodeString + 
     IDAutomationPDF417EncoderPDFGet(i);
     );
     CompleteBarcodeString

   Change the DataToEncode = section of the formula so it encodes fields from a database. Save the formula.
3. The field where the PDF417 barcode is to be placed on the report must allow multiple lines, because the formula draws the symbol line-by-line. Format the field so that all borders are removed; borders will usually cause scanning problems. Size the field so that it is large enough to contain the barcode.
4. Choose File - Print Preview or the Preview tab. A series of many numbers will be visible in the text field; this is normal.
5. After the font of the field is changed to one of the PDF417 fonts (such as IDAutomationPDF417n3) a correct barcode will be created.

(Enter zeros for defaults in all integer fields.)

Int DataSegments=DAutomationFontEncoderPDF417Set(DataToEncode As String, EcLevel As Integer, TotalColumns As Integer, TotalRows As Integer, Truncated As Integer, PDFMode As Integer, ApplyTilde As Integer)

There are a number of ways the data-to-encode can be formatted. It is also possible to combine multiple fields and place functions in a single barcode. Here are some examples:

• The following formula combines two fields in a single barcode and places a tab function between them:
  

  stringVar DataToEncode:= {Table1.DataField1} & 
  CHR(9) & {Table1.DataField2};

  Use CHR(9) for tab.
• The following formula places a tab function and a return function after the barcode:
  

  stringVar DataToEncode:= {Table1.DataField1} & 
  CHR(9) & CHR(13);

  Use CHR(9) for tab and CHR(13) for a return.
• The formula below combines two fields with the date function:

  stringVar DataToEncode:= {Table1.DataField1} & CHR(9) & {Table1.DataField2} 
  & CHR(13) & CurrentDate;

  Use CHR(9) for tab and CHR(13) for a return.

The following is an example using the font encoder to obtain the data, that when printed with IDAutomation's PDF417 Font, will create a correct barcode. The source code for this font encoder example is provided in the package for testing and reference.

1. In a .NET project, add a reference to the DLL and place the import statement in the declarations section of the project. For example:
   
       Imports IDAutomation.Windows.Forms.PDF417Barcode
   
2. Obtain the string of data, that when printed with IDAutomation's PDF417 Font, will create a correct barcode:
   
       Dim NewBarcode As PDF417Barcode = New PDF417Barcode()
       TextBox2.Text = NewBarcode.FontEncoder(TextBox1.Text, 0, 0, 0, False, PDF417Barcode.PDF417Modes.Text, True)

Copy the PDF417Encoder.class file from the Java Class Encoder folder of the package to the root directory of the computer's classpath. If assistance is needed with the classpath, consult the Java documentation or the company from where the Java virtual machine was acquired.

After the Encoder Class Library is installed, it may be called from an application as in this example:

import java.io.*;
import IDautomationPDFE.*;

class PDFTest
{
public static void main ( String [] args )
{
String dataToEncode = "This is a test of the IDAutomation.com PDF417 Java 
Encoder.";
PDF417Encoder pdfe=new PDF417Encoder();
System.out.println( pdfe.fontEncode(dataToEncode) );
}
}

The data string returned by the FontEncode method will create a proper PDF417 symbol when displayed or printed with the PDF417 font. To install the font on an operating system, consult the operating system's documentation.

Configuration parameters and methods of the PDF417 for Java font encoder class:

• fontEncode() - the main method that formats and returns a string of data formatted to the PDF417 Font.
• PDFColumns - number of columns for PDF417 (the default is 5).
• PDFECLevel - error correction level for PDF417 (the default is 2).
• PDFMode - the PDF417 mode can be NUMERIC, TEXT or BINARY (the default is BINARY).
• truncated - if set to "true", truncated symbols will be created according to the ISO specification.

There are a variety of methods and properties available in the COM and .NET DLL PDF417 encoder components.

• TotalColumns: The number of data columns in the PDF417 barcode will control the width of the barcode. The maximum number allowed is 30, but leave at 0 for the default.
• EcLevel: The level of Reed Solomon error correction in the symbol. More error correction creates a larger symbol that can withstand more damage. Leave at 0 for the default.
• PDFMode: Binary mode encodes bytes of data; text mode encodes all characters on the US keyboard plus returns and tabs. The default of 0 is binary mode; 1 is text mode which only encodes ASCII 9, 10, 13 and 32 - 127 but takes up less space.
• TotalRows: The minimum number of total rows can be set by this. Leaving this setting at the default of 0 is suggested.
• Truncated: A truncated PDF417 symbol is more area-efficient than standard PDF417. By selecting this option, the right hand side of the PDF417 is removed or truncated. This option should only be used in clean environments because it is more susceptible to damage than standard PDF417 barcodes.
• ApplyTilde: If set to True" use the format ~ddd to specify the ASCII code of the character to be encoded. Default is off. For example, if the text ~029AB is entered in the data field, it will actually be encoding GSAB where GS is a delimiter ASCII 29 character. This can be used in a single string to encode GS and RS characters (GS = ASCII 29 and RS = ASCII 30). Other commonly used ASCII codes are ~009 for a tab and ~013 which is a return function. These are useful when encoding multiple fields in a single symbol.

FontEncode (DataToEncode As String, EcLevel As Integer, TotalColumns As Integer, TotalRows As Integer, Truncated As Integer, PDFMode As Integer, ApplyTilde As Integer, Output as String)

Example: PDF417(InputString,"0","0","0","0","0","0",OutputString)    (Enter zeros for defaults in all integer fields)

FontEncoder (DataToEncode As String, EcLevel As Integer, TotalColumns As Integer, TotalRows As Integer, Truncated As Boolean, PDFMode, ApplyTilde As Boolean)

Example: TextBox2.Text = NewBarcode.FontEncoder(DataToEncode, 0, 0, 0, False, PDF417Barcode.PDF417Modes.Text, True)

View the ASCII chart for additional details.

#include <string>
#include <iostream>
#include "PDF417FontEncoder.h"


int main ()
{
     PDF417FontEncoder PDF;
     long ECL = 3;
     PDF.setApplyTilde(true);
     PDF.setErrorCorrectionLevel(ECL);
     PDF.PDF417Mode = PDF417FontEncoder::PDF417Modes::Binary;
     PDF.setDataToEncode("IDAutomation.com");
     printf(PDF.FontEncode().c_str());

}

String fontEncodeMacroPDF(String DataToEncode, int inEccLevel, int inColumnSpecify, int inRowSpecify, boolean inTruncate, int inMode, int inMacroSegIndex, int inMacroFileId, boolean inMacroLastIndex)

FontEncodeMacroPDF(BSTR DataToEncode, int inEccLevel, int inColumnSpecify, int inRowSpecify, int inTruncate, int inMode, int inTilde, int inMacroSegIndex, int inMacroFileId, int MacroLastIndex, BSTR *ReturnVal);

Implementing the PDF417 font requires use of both the fonts and the encoders. To generate an accurate PDF417 barcode from a font, the data you wish to turn into a barcode must first be encoded into a text string that will create a readable PDF417 barcode once the appropriate font is applied to it. The purpose of the encoder is to convert the data to be encoded into proper bar and space patterns formatted to the PDF417 barcode font.

Using an encoder is necessary due to the complexity of the symbology and the required Reed Solomon error correction. Attempts to manually encode this data would be extremely complicated, and the font encoders are available to make this process much faster, easier and error-free.

PDF417 fonts are more flexible than other components such as an ActiveX control or .NET Forms Control because the fonts can be combined with these ActiveX, .NET, Java and other encoders depending on which will work best in a given environment.

Yes, it is possible to scan and encode extended characters in a PDF417 barcode, provided the following steps are taken:

1. Encode the data using BASE256. This option encodes ASCII 1 to 255 of the ASCII character set. When encoding over 1024 characters of data, ASCII 127-160 must also be encoded in the format ~ddd, with ApplyTilde set to true.
2. Scan the PDF417 barcode via the serial interface option (data bits have to be 8N) on the scanner. Normally, keyboard wedge and USB scanners do not support extended characters above ASCII 128, and can only scan characters that are on the keyboard. Contact the scanner vendor for more information on how to enable extended character recognition, as some of the scanner's internal settings might need to be modified.

Some implementations of PostScript fonts can cause a small space to appear between rows in the PDF417 symbol. The only way to resolve this issue is to confirm that the print application is not adding additional line feeds. Or, in the case of PCL fonts, change the vertical motion index as indicated below. This space will not cause problems with scanners and the barcode will still be readable.

When using 12 or 14 point PCL fonts, an adjustment to the vertical motion index is not usually necessary. However, if other sizes are used, an adjustment may be needed to close the gap between rows. To set the vertical motion index, issue the command before printing with the PDF417 font. The code for the Vertical Motion Index Command is escape "<Ec>" + "&" + lowercase L "l" + Number Index + Capital "C". Use the chart below to find the command for the specific font point size. The number may be adjusted as necessary for the printer.

PCL Font Point Sizes	Vertical Motion Index Commands
10	<Ec> &l6.5C
8	<Ec> &l5.2C
6	<Ec> &l3.9C

In the example above, the <Ec> represents the escape character for the software. In DOS Edit, Ec is represented by holding down the CTRL key and pressing the letter P, releasing both keys and then press the ESC key.

This issue may exist if there is an attempt to move the barcode to the right on the X axis using a programming language, such as Visual Basic. When using the printer.currentX specification to set the X axis, only the first line of the barcode would print in the new position and the remaining lines would print at zero, all the way to the left. This is because the printer.currentX specification is reset every time a return is performed. A return must be performed to print the font on the new line.

The best solution to this problem would be to find a command that could move the left margin so that returns will move the insertion point to the correct position. Since Visual Basic does not have a command such as this, a small piece of code must be written to set the currentX for each line.

1. Declare and initialize a variable with the desired X position. Example:

   my_x = printer.currentX

2. Replace the Printer.Print OutputString command with something similar to the following:

For i = 1 To Len(Output)
out1 = out1 & Mid(Output, i, 1)
If Mid(Output, i, 1) = Chr(10) Then
out1 = Replace(out1, Chr(10), "")
out1 = Replace(out1, Chr(13), "")
Printer.CurrentX = my_x
Printer.Print out1
out1 = ""
End If
Next i