Variables Export File Definition – Lighthouse for MAX

This section gives a structural overview of the elements and their attributes in a .NLVR variables export file. To understand the role of individual elements, see their definitions below.

.NLVR File Definition

<Variables> and <Variable>: list of all prompt label variables, each defined in a separate Variable element. Prompt variables are listed in the data entry table of the printing form. If there are no prompt variables defined in the label, the element Variables is empty.

Name: variable name.
Description: variable description.
Data Type: defines what type of data is stored in a variable.
Initial value: starting value that is assigned to a variable when created.
Initial value: starting value that is assigned to a variable when created.
Provisional value: defines a custom placeholder variable value in an object while designing labels or forms.
IsProvisionalValueAutoGenerated: provisional value is auto-generated by the application.
IncrementType: information if the variable is defined as counter, and if it is, what kind of counter it is.
IncrementStep: information about the counter step. Counter value increments/decrements using this value on the next label.
IncrementCount: information about the point of incrementing/decrementing the counter value. Usually, the counter changes its value on every label, but that can be changed.
Format: type of content (characters) that can be accepted by the variable.
IsPrompted: defines is the variable is prompted at a print time or not.
PromptText: text that is displayed to the print operator at print time.
IsValueRequired: defines if the variable value should be defined or not.
IsDynamicValue: information if the value is dynamically defined.
PrinterCounterType: defines the counter type if enabled.
AllowedCharactersForCustomFormat: defines if there is a specific character format allowed for the variable.
Length: maximum number of characters a variable can contain.
MinLength: minimum number of characters a variable can contain.
IsFixedLength: the variable must contain the exact given number of characters.
HasMinimumValue: defines if the minimum value is set for the variable.
MinimumValue: minimum variable value.
HasMaximumValue: defines if the maximum value is set for the variable.
MaximumValue: maximum variable value.
InputFormat: allowed input value format.
OutputFormat: allowed output value format.
OutputLanguage: language selection and regional variable value formatting.
InputFormatDecimalDelimiter: data input format of character that separates the integer part from the fractional part of a number written in decimal form.
InputFormatDecimalPlaces: data input definition for a number of decimal places to be included in the variable value.
InputFormatDecimalSeparator: data input format of separator (character) that groups the thousands into groups.
InputFormatCurrencySymbol: data input symbol that represents the selected currency.
InputFormatCurrencySymbolPosition: specifies the data input position of the currency symbol.
OutputFormatDecimalDelimiter: number of decimal places to be included in the variable value on the printed label.
OutputFormatDecimalPlaces: number of decimal places to be included in the variable value on the printed label.
OutputFormatDecimalSeparator: separator (character) that groups the thousands into groups on the printed label.
OutputFormatCurrencySymbol: a symbol that represents the selected currency on the printed label.
OutputFormatCurrencySymbolPosition: specifies the position of the currency symbol on the printed label.
HasPickList: defines if the pick list is enabled or not.
PickListValues: the selection of pick list values.
HasRolloverOnMinimumMaximumValue: defines if the counter is reset after the minimum or maximum value is reached.
Prefix: prefix value that is added to the variable.
Suffix: suffix value that is added to the variable.
PaddingType: defines if the variable has padding characters added or not.
PaddingValue: padding character.
HasMultilineEnabled: divides text into multiple lines.
MultilineNumberOfLines: maximum number of lines for a variable value.
MultilineLineLength: maximum number of characters in a single line.
HasMultilineWordWrap: divides the text into multiple lines at space character locations

Note

All measurement values are expressed in 1/1000 mm units.

XML Schema Definition (XSD) for Label Specification XML

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="Variables">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element name="Variable" minOccurs="0">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="Name" type="xs:string" minOccurs="1" maxOccurs="1"></xs:element>
              <xs:choice minOccurs="0" maxOccurs="unbounded">
                <xs:element name="Description" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="DataType" minOccurs="0">
                  <xs:simpleType>
                    <xs:restriction base="xs:integer">
                      <!--0 -Text variable type.-->
                      <xs:enumeration value="0"/>
                      <!--1 -Date variable type.-->
                      <xs:enumeration value="1"/>
                      <!--2 -Time variable type.-->
                      <xs:enumeration value="2"/>
                      <!--3 -Floating point variable type.-->
                      <xs:enumeration value="3"/>
                      <!--4 -Currency variable type.-->
                      <xs:enumeration value="4"/>
                      <!--1 -Current date variable type.-->
                      <xs:enumeration value="5"/>
                      <!--2 -Current time variable type.-->
                      <xs:enumeration value="6"/>
                    </xs:restriction>
                  </xs:simpleType>
                </xs:element>
                <xs:element name="InitialValue" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="ProvisionalValue" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="IsProvisionalValueAutoGenerated" type="xs:boolean" minOccurs="0"></xs:element>
                <xs:element name="IncrementType" minOccurs="0">
                  <xs:simpleType>
                    <xs:restriction base="xs:integer">
                      <!--0 -None of the types used.-->
                      <xs:enumeration value="0"/>
                      <!--1 -Incremental type.-->
                      <xs:enumeration value="1"/>
                      <!--2 -Decremental type.-->
                      <xs:enumeration value="2"/>
                    </xs:restriction>
                  </xs:simpleType>
                </xs:element>
                <xs:element name="IncrementStep" type="xs:integer" minOccurs="0"></xs:element>
                <xs:element name="IncrementCount" type="xs:integer" minOccurs="0"></xs:element>
                <xs:element name="Format" minOccurs="0">
                  <xs:simpleType>
                    <xs:restriction base="xs:integer">
                      <!--0 -All characters are allowed.-->
                      <xs:enumeration value="0"/>
                      <!--1 -Numeric characters are allowed.-->
                      <xs:enumeration value="1"/>
                      <!--2 -Alphanumeric characters are allowed.-->
                      <xs:enumeration value="2"/>
                      <!--3 -Letters characters are allowed.-->
                      <xs:enumeration value="3"/>
                      <!--4 -7 bit ASCI characters are allowed.-->
                      <xs:enumeration value="4"/>
                      <!--5 -Hex characters are allowed.-->
                      <xs:enumeration value="5"/>
                      <!--7 -Digits & capitals characters are allowed.-->
                      <xs:enumeration value="7"/>
                      <!--8 -Custom characters are allowed.-->
                      <xs:enumeration value="8"/>
                      <!--9 -Code 39 characters are allowed.-->
                      <xs:enumeration value="9"/>
                      <!--10 -Code 128A characters are allowed.-->
                      <xs:enumeration value="10"/>
                      <!--11 -Code 128B characters are allowed.-->
                      <xs:enumeration value="11"/>
                      <!--12 -Code 128C characters are allowed.-->
                      <xs:enumeration value="12"/>
                      <!--13 -Code 128 characters are allowed.-->
                      <xs:enumeration value="13"/>
                      <!--14 -Codabar characters are allowed.-->
                      <xs:enumeration value="14"/>
                    </xs:restriction>
                  </xs:simpleType>
                </xs:element>
                <xs:element name="IsPrompted" type="xs:boolean" minOccurs="0"></xs:element>
                <xs:element name="PromptText" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="IsValueRequired" type="xs:boolean" minOccurs="0"></xs:element>
                <xs:element name="IsDynamicValue" type="xs:boolean" minOccurs="0"></xs:element>
                <xs:element name="PrinterCounterType" minOccurs="0">
                  <xs:simpleType>
                    <xs:restriction base="xs:integer">
                      <!--0 -Printer counter unknown.-->
                      <xs:enumeration value="0"/>
                      <!--1 -Do not use printer counter.-->
                      <xs:enumeration value="1"/>
                      <!--2 -Always use printer count.-->
                      <xs:enumeration value="2"/>
                      <!--3 -Use printer counter if possible.-->
                      <xs:enumeration value="3"/>
                    </xs:restriction>
                  </xs:simpleType>
                </xs:element>
                <xs:element name="AllowedCharactersForCustomFormat" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="Length" type="xs:integer" minOccurs="0"></xs:element>
                <xs:element name="MinLength" type="xs:integer" minOccurs="0"></xs:element>
                <xs:element name="IsFixedLength" type="xs:boolean" minOccurs="0"></xs:element>
                <xs:element name="HasMinimumValue" type="xs:boolean" minOccurs="0"></xs:element>
                <xs:element name="MinimumValue" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="HasMaximumValue" type="xs:boolean" minOccurs="0"></xs:element>
                <xs:element name="MaximumValue" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="InputFormat" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="OutputFormat" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="OutputLanguage" type="xs:integer" minOccurs="0"></xs:element>
                <xs:element name="InputFormatDecimalDelimiter" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="InputFormatDecimalPlaces" type="xs:integer" minOccurs="0"></xs:element>
                <xs:element name="InputFormatDecimalSeparator" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="InputFormatCurrencySymbol" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="InputFormatCurrencySymbolPosition" type="xs:integer" minOccurs="0"></xs:element>
                <xs:element name="OutputFormatDecimalDelimiter" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="OutputFormatDecimalPlaces" type="xs:integer" minOccurs="0"></xs:element>
                <xs:element name="OutputFormatDecimalSeparator" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="OutputFormatCurrencySymbol" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="OutputFormatCurrencySymbolPosition" type="xs:integer" minOccurs="0"></xs:element>
                <xs:element name="HasPickList" type="xs:boolean" minOccurs="0"></xs:element>
                <xs:element name="PickListValues" minOccurs="0">
                  <xs:complexType>
                    <xs:sequence minOccurs="0" maxOccurs="unbounded">
                      <xs:element name="Value" type="xs:string" minOccurs="0"></xs:element>
                    </xs:sequence>
                  </xs:complexType>
                </xs:element>
                <xs:element name="HasRolloverOnMinimumMaximumValue" type="xs:boolean" minOccurs="0"></xs:element>
                <xs:element name="Prefix" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="Suffix" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="PaddingType" minOccurs="0">
                  <xs:simpleType>
                    <xs:restriction base="xs:integer">
                      <!--0 -Padding not used.-->
                      <xs:enumeration value="0"/>
                      <!--1 -Padding on left.-->
                      <xs:enumeration value="1"/>
                      <!--2 -Padding on right.-->
                      <xs:enumeration value="2"/>
                      <!--3 -Padding surrounding-->
                      <xs:enumeration value="3"/>
                    </xs:restriction>
                  </xs:simpleType>
                </xs:element>
                <xs:element name="PaddingValue" type="xs:string" minOccurs="0"></xs:element>
                <xs:element name="HasMultilineEnabled" type="xs:boolean" minOccurs="0"></xs:element>
                <xs:element name="MultilineNumberOfLines" type="xs:integer" minOccurs="0"></xs:element>
                <xs:element name="MultilineLineLength" type="xs:integer" minOccurs="0"></xs:element>
                <xs:element name="HasMultilineWordWrap" type="xs:boolean" minOccurs="0"></xs:element>
              </xs:choice>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Note

XML Schema Definition (XSD) for Label Specification XML is by default accessible at: c:\Program Files\Lighthouse\Lighthouse for Max 10\bin.net\Configuration\Variables.xsd.

.NLVR File Example

Variables>
  <Variable>
    <Name>Sample variable</Name>
    <Description>Describes the variable</Description>
    <DataType>0</DataType>
    <InitialValue>1</InitialValue>
    <ProvisionalValue>1</ProvisionalValue>
    <IsProvisionalValueAutoGenerated>1</IsProvisionalValueAutoGenerated>
    <IncrementType>0</IncrementType>
    <IncrementStep>1</IncrementStep>
    <IncrementCount>1</IncrementCount>
    <Format>0</Format>
    <IsPrompted>1</IsPrompted>
    <PromptText>Enter the required value.</PromptText>
    <IsValueRequired>1</IsValueRequired>
    <IsDynamicValue>0</IsDynamicValue>
    <PrinterCounterType>3</PrinterCounterType>
    <AllowedCharactersForCustomFormat />
    <Length>20</Length>
    <MinLength>0</MinLength>
    <IsFixedLength>0</IsFixedLength>
    <HasMinimumValue>0</HasMinimumValue>
    <MinimumValue />
    <HasMaximumValue>0</HasMaximumValue>
    <MaximumValue />
    <HasPickList>1</HasPickList>
    <PickListValues>
      <Value>1</Value>
      <Value>2</Value>
      <Value>3</Value>
    </PickListValues>
    <HasRolloverOnMinimumMaximumValue>0</HasRolloverOnMinimumMaximumValue>
    <Prefix>pre</Prefix>
    <Suffix>post</Suffix>
    <PaddingType>1</PaddingType>
    <PaddingValue>_</PaddingValue>
  </Variable>
</Variables>