The barcode servlet feature is deprecated and has been replaced with Barcode Generator. For more information, contact your account manager.

Goal​

To generate a barcode in Engage based on a value. The barcode is generated during sendout or in an attribute.

Prerequisite​

  • Access to the barcode servlets is a billable feature that must be activated for your system. To access the barcode servlets, contact your customer service representative.

  • The string of characters that is transformed into a barcode is saved in an attribute or related data set.

Background Information​

Each barcode servlet is hosted on a separate website and can be manually used there to create a barcode graphic (see Generate a Barcode on a Website​).

Alternatively, the barcode servlets can be contacted from within Engage via a hyperlink. A hyperlink generated this way can be stored in an attribute or is inserted into an HTML image tag. The hyperlink contains all of the information that the generator needs to create a barcode image from the characters. This process makes it possible to create an unlimited number of different barcodes in Engage. For general information about barcode structures, see http://barcode4j.sourceforge.net/2.1/barcode-xml.html#General+structure.

The barcodes must be tested before sendout with the barcode scanning devices available in the stores. The sensitivity of scanning devices varies. The readability of the barcode depends on the graphic format, the recipient's printer or print format, resolution, etc.

How To​

Quick Response Code (QR code)

  1. Create a new message in the editor or with the CMS.
    The message can be an email or fax message.

  2. Add a placeholder to the message at the place in the message where the barcode is displayed.
    ⇒ The barcode is inserted with an HTML tag that is constructed as follows:
    <img src="<systemdomain>/ec-qr/qrservlet?c=xx123xx&w=800&h=800&f=jpg" />
  3. The following parameters need to be adjusted to connect to your system:
    <systemdomain> Enter your system address. For example, https://secure.eCircle-ag.com/MyMail.net.

  4. For the character string given as the QR code, the following parameters must be adapted:

    • c= Here, create a placeholder for an attribute or the fixed character string from which the barcode is created.

  5. The following parameters must be changed to define the layout of the QR code:

    • w= This is the width of the QR code image The width is entered in pixels and includes the white space around the code.

    • h= This is the height of the QR code image The width is entered in pixels and includes the white space around the code.

    • f= This is the format in which the barcode image is generated. You can select one of the following: jpg, png, gif or bmp

  6. In the link, insert the placeholder for the value that is turned into a barcode:
    In the QR code, replace "xx123" (in c=) with a placeholder for an attribute (see Attribute References​) or a placeholder from a related data set (see ​Inserting Data From a Related Data Set Into a Message​)

  7. Send the message.
    ⇒ A barcode is created for each value and added to each message during sendout.

For all other barcodes, the tag for the image is built as follows:

  1. Create a new message in the editor or with the CMS.
    The message can be an email or fax message.

  2. Add a placeholder to the message at the place in the message where the barcode should be displayed.
    For all other barcodes, the tag for the image is built as follows:
    <img src="<systemdomain>/barcode?type=upc-a&msg=xxx123xxx&height=10&mw=0.4&wf=3&qz=disable&hrp=bottom&fmt=png&hrsize=8pt&hrfont=Arial&res=700&gray=true" />
  3. The following parameters need to be adjusted to connect to your system:
    <systemdomain> Enter your system address. For example, https://newsletter/MyMail.net.

  4. For the character string given as the barcode, the following parameters must be adapted:

    • msg= Here, create a placeholder for an attribute or the fixed character string from which the barcode is created.

  5. The following parameters must be changed to define the layout of the barcode:

    • type= This is the barcode type. For a list of the barcode types, see Barcode types and formats.

    • height= This is the height of the barcode image in cm. The size displayed in the internet depends on the selected resolution.

    • mw= This is the module width, i.e. the size of the individual barcode components / modules. Generally, the width of the narrowest module is entered here.

    • qz= This is the size of the area of the imagine in which no barcode is displayed. For example: 10mw generates an area that is ten times the size of the module width. With disable, no white space is created.

    • fmt= This is the format. Supported formats are: svg, eps, jpg, tiff, png, gif.

    • res= This is the resolution of the barcode. The resolution is only necessary for bitmap formats (jpg, png, etc.)

    • gray= Here, select whether the image is depicted only in greyscale. The resolution is only necessary for bitmap formats (jpg, png, etc.)

    • hrp= Here, enter whether a manually readable code should be included as a part of the barcode. If the information and all resulting information for readability are deleted, then no human-readable code is created. None suppresses the readable code. Top positions of the code over the image. Bottom positions of the code beneath the image.

    • hrsize= This is the font size of the human-readable part of the barcode.

    • hrfont= This is the font of the readable code.

  6. In the link, insert the placeholder for the value that is turned into a barcode:
    In a barcode, replace "xx123" (in msg=) with a placeholder for an attribute (see Attribute References​) or a placeholder from a related data set (see ​Inserting Data From a Related Data Set Into a Message​) or with another unchanging text.

  7. Send the message.
    ⇒ A barcode is created for each value and added to each message during sendout.