GenerateLabel
Description:
Generates a *.dd file used by the Seagull Scientific BarTender label generation software to print labels.
Input Properties
keyid1
Description:
Identifiers of the SDIs.
Required:
See Additional Information below.
keyid2
Description:
Identifiers of the SDIs.
Required:
See Additional Information below.
keyid3
Description:
Identifiers of the SDIs.
Required:
See Additional Information below.
printeraddresstype
labelmethodid
Description:
Identifier of the Label Method for the label being generated.
Required:
See Additional Information below.
labelmethodversionid
Description:
If you specify a labelmethodid, this is the identifier of the Label Method Version.
Required:
See Additional Information below.
labelmethodtype
Description:
If you specify a labelmethodid, this is the type of Label Method (such as Bartender or Jasper).
Required:
See Additional Information below.
controlledflag
Description:
If you specify a labelmethodid, and the Label Method is controlled, a label event is generated and information is inserted into the LabelEvent table. Specify Y to indicate a controlled Label Method, N for uncontrolled.
Required:
See Additional Information below.
labelformat
Description:
Full path and name of the Bartender format file (BTW).
Required:
Yes
numcopies
Description:
Number of copies of the label to print.
Required:
Yes
labelsdcid
Description:
Identifier of the SDC.
Required:
See Additional Information below.
selectclause
Description:
The query in the Label Maintenance page defines how data is retrieved for the label. Use this property to build a fully qualified SQL statement for the data that will be printed on the label.
Required:
See Additional Information below.
fromclause
Description:
The query in the Label Maintenance page defines how data is retrieved for the label. Use this property to build a fully qualified SQL statement for the data that will be printed on the label.
Required:
See Additional Information below.
whereclause
Description:
The query in the Label Maintenance page defines how data is retrieved for the label. Use this property to build a fully qualified SQL statement for the data that will be printed on the label.
Required:
See Additional Information below.
orderbyclause
Description:
The query in the Label Maintenance page defines how data is retrieved for the label. Use this property to build a fully qualified SQL statement for the data that will be printed on the label.
Required:
See Additional Information below.
exportlocation
Description:
Destination of the *.dd file.
Required:
Yes
labeleventid
Description:
Identifiers of the Label Events, which are used to regenerate or reprint the label (accepts multiple semicolon-separated values).
Required:
See Additional Information below.
labeldata
Description:
XML string in the form of sapphire.util.Dataset.toXML(). Information for the label is extracted from this prepared XML string.
Required:
See Additional Information below.
printeraddressid
Description:
Identifier of the Printer that will print the label.
Required:
Yes
Output Properties
exportfilepath
Description:
Full path and name of the generated *.dd file.
Required:
Yes
newlabeleventid
Description:
Identifiers of the newly generated Label Events.
Required:
Yes
Additional Information
Additional information concerning this Action:

This Action is typically called from the 'Print Label' button of a List page.

Mandatory Properties

You have three options for specifying properties to generate labels. You must therefore specify one of the following three combinations of properties (they are mutually exclusive):

  • Specify SDI Keys
    keyid1, keyid2, keyid3
    labelmethodid
    versionid
  • Specify Label Method
    labelmethodid
    labeldata
  • Specify Label Events
    labeleventid
  • Label Method Overrides
    These properties are defined in the LabelMethod SDC (LV_LabelMethodMaint page), and can be overridden from the configuration. If your configuration provides a value for any of these properties, it will override the value defined in the LabelMethod SDC for that property:
    • labelmethodtype
      fromclause
      controlledflag
      whereclause
      labelformat
      orderbyclause
      numcopies
      exportlocation
      labelsdcid
      printeraddressid
      selectclause
Copyright © 1999-2016 LABVANTAGE Solutions, Inc.