Skip to content

DS Archive Support Website

Sections
Personal tools
You are here: Home » Product Manuals DS 3.x » DataSplice 3.0 Administration Client Manual » DataSplice Barcode Printing Plug-in

DataSplice Barcode Printing Plug-in

The DataSplice barcode printing plug-in provides the ability to print barcode labels on a connected barcode printer from the DataSplice Remote Client application. The barcode printing plug-in is a separate DataSplice component. As such, it must be installed separately. For detailed information about the installation of the barcode printing plug-in, please refer to the DataSplice barcode printing plug-in manual.

General Plug-in Information

The Plug-in Details screen shows details about the DataSplice barcode printing plug-in. It also displays the features provided by the plug-in.

  1. Browse to the Server Settings and Configuration screen.
  2. Expand the Server Plug-ins section by clicking the plus sign.
  3. Select DataSplice Barcode Printing Plug-in from the list of available plug-ins.

    Server Plug-ins

  4. The general plug-in details should be displayed in the right panel of the screen.

DataSplice Barcode Printing Plug-in Details

Configuring the Barcode Printing Plug-in

The barcode printing plug-in options in the Administration Client allow for various important settings to be defined.

  1. Browse to the Server Settings and Configuration screen.
  2. Expand the Server Plug-ins section by clicking the plus sign.
  3. Select DataSplice Barcode Printing Plug-in from the list of available plug-ins.

    Server Plug-ins

  4. In the Configuration Section drop-down list, select Edit Options. The options screen for the plug-in will be displayed in the right side panel of the screen.

DataSplice Barcode Printing Plug-in Options

Available Printers Section

The Available Printers section allows for various barcode printers to be defined for DataSplice visibility.

Setting Name Description
Printer Name The unique name used to identify the printer for DataSplice. This name will later be used in the view when setting up the event chain for a printing action (for server-side printing actions) or in the custom view attributes (for client-side printing actions).
Printer Type The printing language driver to use to communicate with the printer. Possible choices include DPL, EPL, IPL, PL4, and ZPL.
Printer Location This specifies how to connect to the printer, which can be either a network address (for a networked printer) or a COM port (for a Bluetooth/serial printer).
  • Network printers - Network addresses should typically be defined as the printer's host name or IP address. This will use the default port, which is typically 9100. A different port can be specified by using the following format - hostname:port.
  • Bluetooth/serial printers - Printers that are connected with a serial connection, such as a Bluetooth printer, should be defined using the COM port for that connection with the device.
Miscellaneous Settings This section allows for additional settings to be provided to the printer driver. Multiple settings can be defined by separating them with a semi-colon (;). The following settings can be specified.
  • DPI - Specifies the dots-per-inch setting for the printer. Each driver supports a different set of values (the default is italicized).
    • DPL - 203, 300, 406, 600
    • EPL - 203, 300
    • IPL - 203, 300, 400
    • ZPL - 203, 300
  • BaudRate - Specifies the baud rate to use for serial connections (19200).
  • ByteSize - The byte size to use for serial connections (8).
  • Parity - The parity to use for serial connections (none, even, odd, mark, space).
  • StopBits - The stop bits setting to use for serial connections (1, 1.5, 2).

Label Templates Section

The Label Templates section defines the formatting for the labels that will be sent to the barcode printer. The formatting is handled by XML code.

Setting Name Description
Template Name The unique name used to identify the template for DataSplice. This name will later be used in the view when setting up the event chain for a printing action (for server-side printing actions) or in the custom view attributes (for client-side printing actions).
Template Body The XML code used to define the formatting of the template. This code also determines what fields of information will be printed along with the label. When the small pop-up icon in the field is clicked, a dialog box will open, allowing for easy code review and revision.

Refer to the barcode label template body formatting guidelines section for an overview of some common formatting principles. For additional formatting information, please refer to the documentation provided by the printer manufacturer.

Defining Network Printers

To define a printer that is on an existing network, use the following steps.

  1. Click the Add Configuration Section button Add Configuration Section next to the Available Printers section.
  2. In the Printer Name field, enter a name to identify this printer.
  3. In the Printer Type field, select the printer driver type supported by the printer. If this information is not readily known, please refer to the documentation provided by the printer manufacturer.
  4. In the Printer Location field, enter the host name or IP address of the printer on the network. If a port other than the default is used, specify it after the location with a colon followed by the port number.
  5. In the Miscellaneous Settings field, enter any appropriate settings, if desired.
  6. Click the Save Changes button .

Defining Bluetooth/Serial Printers

To define a printer that is not on the existing network, such as one that uses a Bluetooth or serial connection, use the following steps.

  1. Click the Add Configuration Section button Add Configuration Section next to the Available Printers section.
  2. In the Printer Name field, enter a name to identify this printer.
  3. In the Printer Type field, select the printer driver type supported by the printer. If this information is not readily known, please refer to the documentation provided by the printer manufacturer.
  4. In the Printer Location field, enter the COM port being used for communication between the client device and the printer, such as COM4.
  5. In the Miscellaneous Settings field, enter any appropriate settings, if different than the default values.
  6. Click the Save Changes button .

Defining Barcode Label Templates

To specify a template for the labels to be sent to the printer, use the following steps.

  1. Click the Add Configuration Section button Add Configuration Section next to the Label Templates section.
  2. In the Template Name field, enter a name to identify this template.
  3. Click the small pop-up icon in the Template Body field.
  4. An Edit Text Value dialog box will be displayed, allowing for the template XML code to be reviewed and altered as desired.

    Edit Text Value Dialog Box

  5. Edit the template XML code as desired. Refer to the barcode label template body formatting guidelines section for an overview of some common formatting principles. For additional formatting information, please refer to the documentation provided by the printer manufacturer.
  6. Click OK to save the template code.
  7. Click the Save Changes button .

Configuring Server-side Printing Actions

Print jobs can be initiated when certain actions take place, without the need for the user to explicitly initiate a print job. Such actions are said to be server-side printing actions. These actions are defined in the event chains of the views intended to initiate the print job. For example, if a label should be printed every time an item is issued, a plug-in function action can be added to the Insert Chain of the issue view in question. This behavior is accomplished by defining the parameters and details of a Call Plug-in Function action for the barcode printing plug-in.

Configuring Client-side Printing Actions

In contrast to the aforementioned server-side printing actions, it is also possible for the user to explicitly initiate print jobs, independent of the DataSplice Server. Such actions are said to be client-side printing actions. These types of actions are often used when a Bluetooth or serial printer is being used, rather than a printer on the network. To configure client-side printing actions, use the following steps.

  1. Select Edit Views from the main navigation area.
  2. Select the view of interest.
  3. In the Configuration Section drop-down, select Settings and Attributes.
  4. Scroll down to the Custom Attributes section.
  5. Define attribute names and associated values for the following attributes:
    • DS_REMOTE_PRINTERS - Specifies the list of printers that can be used. If this is not defined, the print action will not be available to the user. As such, this attribute should only be defined in views in which labels should be printed. Multiple printers can be specified by separating the names with commas.
    • DS_LABEL_TEMPLATES - Controls which templates the user can select from when printing a label. Multiple templates can be specified by separating the names with commas. If this field is not specified, the user will be able to select from all available templates.
    • DS_PRINT_COUNT - Specifies the number of labels to print. This can either be specified as a fixed value, such as 1, or as a range of values, such as 1-5. This allows the user to select from the count range. The default value is 1-10.

    Attributes for Client-side Printing Actions

  6. Click the Save Changes button .
  7. When a user is in a view in the Remote Client that has been defined with the attributes above, a menu item will be available to initiate the print job.
    Note: The client device must have the necessary client files as specified in the barcode printing plug-in manual.
  8. The user can click File > Display Plug-in Functions to initiate the print job.

  9. A dialog box will be displayed, allowing for printer settings to be chosen.

  10. The user can then make the desired selections from the dialog box and click OK for the print job to be sent to the printer.

 


Last modified 2006-09-26 04:27 PM
 

Powered by Plone

This site conforms to the following standards: