Training Guide: "When Printed" Data Sources

 Product: LABELVIEW, CODESOFT

Version: All Versions

What is a When Printed data source?
A When Printed data source allows you to set up one or more fields in which the user can enter values at the time the label is printed. At print time, the form can be displayed for the user to enter values in the fields.

Why use a When Printed data source?
Forms can be used to apply a product name, part number or any other type of information that may vary, but which cannot be populated by an automatic data source (such as a database, clock or counter).
 
Creating a When Printed data source

Properties of When Printed data source
You can set the following properties for When Printed data sources:

• Input properties define the parameters of the values that can be entered into the form
• Output properties define how the When Printed data sources will be printed
• Counter properties allow you to attach an incrementing value to your output

Procedure
To create a When Printed data source:

 

Defining Input Properties
Input properties
When Printed data source input properties govern the limits and formats of the user input that will be allowed at print time.

Procedure
To define the input properties for a When Printed data source:
 

In the Input tab, review these properties:

• Name allows you to assign a unique name to the variable (to replace the system-assigned name).
• Value data box, you have the option of entering a default value for this field. The default value is the initial value of the field; the value that will be printed first. This is the normal mode of operation.

 NOTE: If you do not define a default value and you select the Restore after printing check box, then the variable value will be set to empty after each print job.

• Local identifies a variable that is internal to the label (i.e., linked to this document only).
• Shared identifies a variable that is saved in an external file each time after printing. This means that the value can be used in other documents.
• Delete spaces automatically eliminates all spaces encountered before and after the variable value.
• Restore after printing resets the variable to its default value. The value may be changed during user input, but will always be restored to its initial value after printing.

 

In the When printed tab, review these properties:

• The Prompt box allows you to enter a message to be displayed in the form. This message is often used to prompt the user for the appropriate input value (e.g., “Part Number” or “Product Name”).
•  The Minimum length box allows you to set a value for the minimum number of characters to be input. A zero value means there is no check.
  • If the user enters a value that does not meet the minimum length, an error message appears when printing is launched.
• The Input mask box allows you to enter characters that limit the types of characters that can be manually entered. Each character the user types must correspond to a character in the input string. For example, if the value should be a five-digit number, enter ##### in the Input mask box.

         
         It is also possible to insert separator characters into the format string, which will be included in the input mask
        
        NOTE: Input format characters appear in the form to assist user input, but do not appear in the output (printed label).

• Force data to come from the list makes it mandatory to use a value from the Pick list. If this option is not enabled, a new value can be entered or it can be selected from the list.
• The Pick list drop-down list allows you to set up a list of valid input values on the form. Input is then limited to the items on this list. You can select from a list of shared values, if applicable, or select the Local option if you want the values to be applied to this variable only.

        

• The Pick list button displays the Pick list dialog box, which allows you to enter values linked to the variable.

         

Defining Output Properties
Output properties
When Printed data source output properties define the limits and formats of the form field output (what actually appears on the label).

Procedure

In the Output tab, review these properties:

• Maximum length represents the maximum number of characters allowed in the When Printed data source field.

          NOTE: Input values that exceed the maximum length are truncated. For counter variables, maximum length is calculated automatically by the reset value of the counter.

• Prefix allows you to define one or more characters to precede the variable.
• Suffix allows you to define one or more characters to follow the variable.
• Output mask is used to format the variable as you want it displayed.
  • Data Format Output Mask Form Display

                  

• Display decimals indicates that you want the variable to be formatted with decimal places.
• Number of decimals allows you to specify places to the right of the decimal point.
• Decimal separator allows you to specify a character to represent the decimal point.
• Thousand separator allows you to enter a thousand separator.
• A Pad with character can be appended to the left of a variable to ensure the variable occupies the maximum length of the field. For example, if the field length is 4 characters, and you specify a padding character of (X=) 0, then a variable value of 12 will print like this: 0012.
  • up to X characters allows you to specify the maximum number of padding characters. If you have a counter, this value is set at the number of characters in the maximum counter value.
• Include in the log file causes the When Printed data source to be recorded in the printing logfile.
• Accumulate value stores the value of the variable in a separate file. The value is added to the value already stored in the file. To select the file, click the button to access the folder containing these files.

Defining Counter Properties
Counter properties
When Printed data source counter properties govern the content and format of counters included in your form. You can learn more about counter variables here.

Procedure

In the Counter tab, review these properties:

• Counter allows you to define counter properties. A counter is a value that increments from one label to the next during printing, according to an initial value, an increment value, and a reset value.
• ISO counter specifies that each label printed is counted, regardless of whether it is an original or a duplicate.
• Type identifies the type of counting base. Decimal (base 10 calculation) is the default. See the online Help for a complete description of the available counting bases and instructions for creating a customized base.
• Current value allows you to specify the counter value to be printed on the first label. For counter variables, this value is established when the variable characteristics are determined.
• Increment defines the value by which the counter is incremented. It can be a positive or negative value.
• Min/Max Value allow you to set the initial value and maximum value of the counter. The counter resets to the minimum value each time the maximum value is reached.

         NOTE: The increment value is decimal. Adding an asterisk (*) at the end of the increment forces it to match the base of the counter.

• Increment after allows you to print multiple labels before incrementing the counter. These options are not available if you chose ISO counter.
• Having printed is the number of labels to be printed before incrementing the counter.
• Each reset of allows you to specify that incrementing occur based on the reset of another counter variable. Multiple counters can be cascaded to carry out complex counting.
• Reset after variable value change allows the counter to be reset at the end of a regular cycle (e.g., weekly or monthly).