SOP-42Q-MDS0083 Label Engine Labels

42Q Home > Production > LE Labels

 

 

 

Label Engine Labels Version 42Q Work Instruction

 

This Work Instruction is 42Q's corporate standard. This document is under revision control. The latest revision is located on Intranet. Once printed it is an uncontrolled copy. All alterations to this work instruction require approval. Contact the IT Global Education and Training Department to submit suggested alterations and or updates.

This edition applies to 42Q and all subsequent releases and modifications until otherwise indicated in new revisions.

 

 

 

 

 

Label Engine Labels

Label Engine is a web application that gives plants the ability to create, update, and print-labels, without the need for IT resources. It enables plants to easily define and access various different data sources like MES, MESR, along with a variety of other database types. It allows users to map label fields to these data sources in order to create dynamic labels. It also enables plants to extract statistical information about the labels that are managed in Label Engine, as well as monitor the audit information.

Users can create a label template or layout in the design tool of their choice (i.e.: For ZPL use BarOne or CodeSoft, and for RTF use Microsoft Office or another tool that provides RTF format). Using the design tool, they export the completed template as ZPL (Zebra Printer Language) or RTF (Rich Text Format). The template is uploaded to Label Engine and the fields in the template are mapped to data sources. At print time, Label Engine combines the template with the appropriate data to produce finished labels.

The LE Labels portlet allows the user to create, edit, copy, delete, and print labels. LE Admin History, LE Version History, and LE Print History reports can be viewed and/or printed from this page. LE Statistics Excel spreadsheets can also be created from the LE Labels page.

1. To access the LE Labels page, navigate to Production>LE Labels.

 

Figure 1: Accessing Label Engine Labels 

 

LE Labels

To access the LE Labels, select the LE Labels from the Label Engine View menu.

Figure 2: LE Labels

 

Figure 3: Label Engine Labels Main Page

The main screen of the LE Labels page contains all previously created labels. The labels are sorted by name and are color-coded according to their status. The following are the colors and their statuses:

• Green=Production
• Blue=Development
• Red=Hidden
• Brown=Deprecated

Label Template File

The first step of creating a label is done outside of Label Engine. A label layout and design tool is used to create the label template such that the finished label meets the customer specifications. Typically the label specifications will cover such things as label media type, size, fonts, barcodes, etc. Many different design tools exist and the choice of design tools is outside the boundaries of Label Engine.

A suitable design tool MUST be able to produce or export ZPL code (Zebra Programming Language) for use on Zebra Printers

Or

RTF (rich text format) for use on sheet / LaserJet printers.

As such, printing labels through Label Engine are limited to supporting printers that support ZPL (i.e. Zebra printers) or RTF (i.e. LaserJet printers).

Label Engine’s main purpose is to provide a means of populating placeholder fields in labels. Label Engine keys in on values surrounded by $ (for example $partno$) to determine which label elements are mappable within the Label Engine.  At print time these placeholders are replaced with real data by Label Engine before sending the label to the printer.  Not all design software or barcode formats will allow the use of the $ character, and in such cases manually editing/cleaning the ZPL might be necessary.

The ZPL or RTF file(s) are uploaded to Label Engine as part of the label creation process.

Add New Label

1. To create a new label, select Add from the LE Labels main page.

Figure 4: Add New Label

Enter the label name and customer and save the Label. Label names can only contain lower case characters, digits, and - (dash) and _ (underscores) all other characters and disallowed. Label names can not be changed after the first publishing of a label and label names MUST be unique so choose your name wisely.

Figure 5: Save Label

A General Information screen will display. There are three tabs located to the right of the General Information form (Upload Files, Element Creation, and Label Mapping).

General Information Tab

The general information tab contains the same parameters that were on the initial creation screen so that these values can be updated. It also contains additional information in the database selection panel, and it contains additional controls to allow Parts to be associated with Labels.

Figure 6: General Information

2. The user will need to enter the following information in the General Information form:

• Name - the unique name for the label. Each label must have a unique name. Label names can only contain lower case letters, numbers, and underscore and the name is limited to 30 characters. Spaces are not permitted. The name is the key to printing labels using external web services.
• Version – Defines the current label version.
• Size- Enter the size of the label.
• Resolution – choose resolution based on the printer that will be used.
• Customer – select a customer for the label from the drop-down list.
• Kind of Material – Choose the material that the label will be printed: Kapton, paper, or polyester.
• Comments – label comments for any additional information.
• Duplicate Prevention - Use this to specify if the label should prevent printing this label more than once for any given "entry".  This may be disabled due to administrative settings that are explained in the LE Admin SOP {put link and proper name}

Default Database Mapping

By filling out the Default Database section it will allow the user to use the option Part Must be Mapped in the case to the selected database is a MES Database. Moreover, it will provide the user autocomplete part of the creation of an element. Once a database is selected, the Table and Column lists will become available. Using these drop-down lists, define which database element will be provided at print time. This is also referred to as the default "entry" value.

Figure 7: Default Database

 

Part Number Mapping

Part number mapping allows the label to be associated with some Part Numbers. By having Part Number informed in the Label Engine Print screen, it is very easy to find the label(s) that need to be printed by a Part Number.  Depending on the Administrative configuration, Part Number mappings may be optional.  Toggle "Part Must Be Mapped" selection if the label should enforce part mapping at print time.  If enabled and if the print time entry corresponds to a part that is NOT mapped to the label, the printing will be prevented.  Note.  This may be disabled due to administrative settings that are explained in the LE Admin SOP {put link and proper name} 

Enter the Part Number in the Part field and select Add to add the part in the Part Number list. To delete parts, select it, and select Delete.

 

Figure 8: Part Number Mapping

Once you have provided all of the information on the General Information tab, select Save to commit your changes to the system and then select Next. The user can also select the Upload Files tab.

NOTE: Clear functionality will remove any data provided so you can start fresh.

 

Upload Files Tab

The Upload Files tab allows the user to manage the files that will be used on the label. The right side of the screen lists the files that are already added to the label.

There are four types of files that can be associated with a label:

• Template Files (ZPL or RTF)
• Font Files
• Images
• Label Preview Images (GIF, JPEG, PNG)
• URL - This allows users to link documentation about the label (specs, etc)  This file type is NOT functional and thus is not involved in label printing, it is just to allow LE to be a more complete label management tool.

Figure 9: Upload Files

Most files will be uploaded from the user's local computer. However, if the font was already uploaded to the server for use in a different label it will be possible to reference the existing font instead of uploading it again.

Add File

1. To add a file to the label from your local computer, select Add from the Upload Files tab.

Figure 10: Add File

2. Select Browse to browse and select the file to add to the label.

3. Add a description of the file.

4. Select Save to confirm the addition, Reset to clear the fields, or Cancel to cancel.

Edit File

For labels with attached files, these files can be edited as long as the label has not yet been published.

1. To edit a file, select the checkbox to the left of the file and then select Edit.

Figure 11: Edit File

2. Once the Edit button is selected, the Edit Files Uploaded pop-up displays to edit.

3. Only the Description portion of the file is available to edit.

4. Change the description and then select OK to save changes or Cancel to exit.

Delete File

1. To delete an attached file, select the checkbox to the left of the file name and select Delete.

Figure 12: Delete File

2. A confirmation message will be displayed. Select Yes to confirm or No to exit.

Download File

Under the Upload files tab, the user can download the files attached to a label to retain the information from the label.

1. To download the file, select the checkbox to the left of the file name and select Download.

Figure 13: Download File

2. The download will be started automatically.

View Label Sample

The user can view a sample of the file that is attached to the label from the Upload Label tab.

1. To preview a sample of the file, select the checkbox to the left of the file name, and select View Label Sample.

Figure 14: View Label Sample

2. A sample of the file displays in a new screen.

Element Creation Tab

The element creation tab is where users will create the "elements" of data that will be injected into the template at the print time via the label mapping.

Figure 15: Element Creation Tab

On this tab, the user can create the elements. Elements are built up of 'blocks' of data, and elements are what is ultimately injected into the template file at the print time replacing the $place_holder$ fields.

The application provides five functionalities ('Constant Value, Date/Time, Database, Custom function, and Entry' Value Block), from where the user is able to customize the elements.

Add Element

To add an element, in the Element Creation tab, select Add Element button.

Figure 16: Element Editor

The Element Editor is displayed and the user can input the necessary information to the new element.

Fill the available fields:

Element Name: the name of the element;

Comments: any necessary information that the user wants;

Mandatory is a flag indicating that a non-blank / non-null value is required at print time.  If the element value is empty at print time, the printing of the label is aborted and a message about the failure is recorded in the audit log and is reported back to the user. The default message contains a reference back to the element name.  The element name is not always something that has meaning to an operator.  To provide a more meaningful message (for the audit and the user response) LE allows the user to provide a custom mandatory message that will be used instead.   When Mandatory is selected, an optional field, Custom Mandatory Message becomes available and this is where the label designer can provide the message to be used if a mandatory violation occurs.  

NOTE: This Mandatory flag will be available at some of the functionalities and will be used for the same purpose.

Figure 17: Element Editor - Selecting Mandatory

Checking Entry Point checkbox, it will be allowed to search values from two databases. It is used to set the database priority.

The available functionalities are described below:

Constant Value

Figure 18: Constant Value

This functionality allows the user to create a constant value (fixed value) used for printing the value in the label.

Block Name: this is the block title to be created;

Value: Value to be printed in the label (any value type).

Click on OK to finish.

Date/Time

This functionality will print the date/time in the label.

Figure 19: Date/Time

Block Name: Name of the block to be created;

Date/Time format: Select the format (from the available list) that will be printed in the label.

Figure 20: Date/Time Format

Block Modification Rules: It allows the user to set the rules to the selected field (date/time)

Figure 21:  Add Rule

The rules can be used to set or modify previously assigned label fields. Dynamic data, such as system date or time, can be formatted and assigned to a label field. Rules allow for data to be combined or transformed based on runtime conditions.

It is displayed the details of the business rules assigned to the selected label field in the Rules list.

Multiple business rules can be applied to any field. To add business rules to a field, follow these steps:

To add a rule, select an existing rule from the list and click on the Add button. The new rule will be added to the list.

The order in which business rules are applied can be changed using the arrows in the lower section of the details section. As well, business rules can be deleted or updated using the appropriate action icons.

Database

This function loads the database information that will be printed in the label.

Figure 22: Database

Entry Value From: This form informs where the input for the element comes from. The common value is Print Call Entry.

• Print Call Entry: comes from the value used to print the label;
• Element Name/Key: comes from the element ;
• Block Name/Key: comes from the block.

The Entry Point Definition form displays the predefined values in the General Information.

Value To Extract: The user needs to select the Table and the Column to get the information to be printed in the label.

To provide a more meaningful message (for the audit and the user response) LE allows the user to provide a custom mandatory message that will be used instead.   When a Mandatory checkbox is selected, an optional field, Custom Mandatory Message becomes available and this is where the label designer can provide the message to be used if a mandatory violation occurs.

NOTE: If the label is a Container Label, the user needs to select the Values Will Be Assigned To Different Fields option.

Figure 23: Container Label Option

The Block Modification Rule was already explained in the Date/Time topic.

Custom Function

The Custom Function allows fetching database information through a customized function.

Figure 24: Custom Function

Entry Value From: This form informs where the input for the element comes from. The common value is Print Call Entry.

To provide a more meaningful message (for the audit and the user response) LE allows the user to provide a custom mandatory message that will be used instead.   When a Mandatory checkbox is selected, an optional field, Custom Mandatory Message becomes available and this is where the label designer can provide the message to be used if a mandatory violation occurs.  

• Print Call Entry: comes from the value used to print the label;
• Element Name/Key: comes from the element;
• Block Name/Key: comes from the block.

Database: after the database is selected, the functions are displayed in the list and the user can select them and inform the Function Details.

Entry Value Block

This functionality gets the entry information used to print the label (generally, the Serial Number).

Figure 25: Entry Value Block

Select Save to finish.

 

Delete Entry Value

Figure 26: Delete Entry Value

To delete, just select the Entry Value Block in the list and select Delete. A confirmation message is displayed, Select Yes to delete or No to abort.

Edit Element

Editing elements work pretty similar to Add Element. Refer to Add Element topic for further information.

Figure 27: Edit Element

Editing elements work pretty similar to Add Element. Refer to Add Element topic for further information.

Delete Element

To delete, just select the Element Name in the list and select Delete.

Figure 28:  Delete Element

To delete, just select the Delete Element in the list and select Delete. A confirmation message is displayed, select Yes to delete or No to abort.

View Element

This functionality allows the user to view how the element was created.

It is not allowed to do any update on this page.

Figure 29: View Elements

Label Printing

One of the major features provided by Label Engine is printing labels. Users can print labels to any available printer.

This page changes based on the settings for duplicate prevention IF the entry has been printed before.

Figure 30: Print Label

Figure 31: Print Label Options

To print a label:

1. Select the box to the left of the Label Name on the main Label Engine page.

2. Select the printer icon on the far right of the screen.

3. Choose a Printer.

4. Enter with the information used to print the label into the Entry field and select Print.

View Raw Data: The user can get the raw content that will be sent to the printer.

Local Print (download): This option allows the user to download the print result locally as .PDF or .ZPL

Test Print: Duplicate prevention and Test printing.   If the label (and the plant configuration) has duplicate prevention turned on after the Entry field loses focus, the print history is checked.  If the label - entry combination has been printed, viewed, or downloaded before it can't be printed again.  It can only be reprinted (as many times as needed).  In order to perform a reprint (if the user has the permissions to reprint) the three fields (Reprint Reason, Approver, and Notes)  need to be filled before the reprint options become available.

Local Test Print (Download): Test Print / Local Test Print are always allowed.  This feature still requires a valid entry, however, the print activity does not use up the one label-entry allowed.  It is still recorded and viewable from the audit, but it is recorded as a test print.  Also, all of the elements have their value reversed before being injected into the template so, in fact, the generated label is significantly different from a regular print.

NOTE: This section also discusses web service printing.  The new LE web service is documented with Swagger (allows the user to describe the structure of your APIs so that machines can read them.  See the details at http://p99ls9.sanmina.com:8081/lbleng-webservice/index.html. 

In addition, the Label Engine has web services that expose printing functionality to other applications.  For example, it is possible to print labels created in the Label Engine by using the SFDC Commands (!! Commands):

 !!1LABENG.<labelname>.<print queue>

where

<labelname>is the label name of the label in Label Engine, and <print queue>is the print queue defined in the Label Engine.

New Version

1. To create a new version of a label, select the box to the left of a Production, Hidden or Deprecated label, then select New Version.

NOTE: Labels in Development cannot have New Version created.

Figure 32: New Version

2. The General Information form will be displayed. All fields are available to create a New Version of the label.

3. Select Save.

Edit Label

1. To edit a label, select the box to the left of a label in Development.

NOTE: Only labels in Development are available to edit.

Figure 33: Edit Label

2. The General Information form will be displayed. All fields are available to edit.

3. The Upload Files, Element Creation, and Label Mapping tabs are also available to edit.

4. Select Save to confirm changes.

View Label

View functionality is very convenient to view how the label was created in case of the user does not have permission to edit.

1. To view a label, select the box to the left of a label in production.

2. Select View.

Figure 34: View Label

3. All tabs will be displayed.

4. The label information is available to view only.

Add/Remove PN

This functionality allows the users to add or remove Part Numbers associated with the label.

1. To add or delete a Part Number from a label, select the box to the left of a label.

Figure 35: Add/Remove Part Number

Figure 36: Part Number Mapping

2. Enter the Part Number and select Add.

3. Select Add' 'to confirm or Close to cancel.

 

Figure 37: Delete Part Number

1. To delete a Part Number, select the box to the left of the part number and select Delete.

2. A Confirm screen will display. Select Yes to confirm deletion or No to cancel.

Copy Label

1. To copy a label, select any label from the Labels list and then select Copy.

Figure 35: Copy Label

 

2. All tabs forms will be displayed. Apply the necessary changes and then, select Save at the bottom right of the screen to save the changes.

Delete Label

1. To delete a label, select the box to the left of a label in development.

NOTE: Only labels in development status can be deleted.

2. Select Delete.

Figure 36: Delete Label

3. A confirm message will be displayed. Select Yes to confirm deletion or No to cancel.

Hide/Unhide Label

Certain labels can be hidden from the list of available labels using the hide function. Labels that are currently hidden can be revealed using the unhide function.

Hide a production label, prevents the label to be printed by using SFDC Commands or any other print action from external application, such as Shop Order Print module, SIT and others.

1. To hide a label, select the box to the left of a label in production status and select Hide.

Figure 37: Hide Label

NOTE: Only labels in production can be hidden.

Unhide the label restores a previously hidden production label and it can be printed using SFDC Commands or other external applications.

2. To unhide a hidden label, select the box to the left of a hidden label and select Unhide.

Figure 38: Unhide Label

Publish Label

Publishing a development Label locks the label and makes it available for printing from other applications.

1. To publish a label, select the box to the left of a label in development status, then select Publish.

NOTE: Only labels in development can be published.

Figure 39: Publish Label

2. A confirmation message will be displayed. Select Yes to confirm or No to cancel.

View Label Sample

The user can preview an image previously uploaded using the View Label Sample functionality.

1. To preview a sample of a label, select the box to the left of a label in Production/ Development status.

NOTE: Only certain labels have previews attached to them. The only way to know which labels have previews is by selecting each one and looking for the Label Sample Preview functionality to become available.

Figure 40: Label Sample Preview

LE Reports

The available reports allow the user to mine the logs to extract usage data. There are three report options:

• LE Version History
• LE Print History
• LE Statistics

Figure 41: LE Reports

1. Select LE Version History, LE Print History or LE Statistics.

LE Version History

Figure 42: LE Version History

1. Set the filters as needed.

2. Select Filter to extract the data.

3. The results of the query will be displayed in the List.

This report displays the history of the label: who create it, when, its version and status.

 

 

LE Print History

Figure 43: LE Print History

This report displays when the labels were printed, which system or Web Service method invokes the print action, which entry value (e.g. Serial Number) was used to print the label and other information related to the print action.

---

LE Statistics

Figure 44: LE Statistics

1. To extract statistical information, select LE Statistics.

2. Select the begin and end dates using the date selectors to define the time range for the statistics that will be generated and the Statistic Type:

• Print Activities
• Created Revisions
• Created Labels

3. Select Filter.

4. The results will be displayed in the Name column.

The user is able to save the report locally by clicking on Export.

Label Request Tool

The Label Request Tool is located in 42Qnet. When this option is selected, the user is redirected to the Universal log-in page to access 42Qnet. Once the users credentials are verified, the Label Creation Tool main screen displays.

Figure 45: Label Creation Tool

1. To create a new label with the Label Creation Tool, select Create New Label.

2. A page will display with a Request Information from, a Label Setup form, a Variable Definition form, and an Attachments form.

3. The user name will be automatically generated in the Request Information form according to your log-in credentials.

4. Enter the Mandatory Information:

• Plant Location
• Server Location
• MES Server
• Project

5. The following fields are optional:

• Printer
• Due Date
• PC Division
• Customer
• Resolution
• Urgency

Figure 46: Request Information

Figure 47: Label Setup

6. In the Label Setup form, enter the Label Name.

7. In the Size fields, enter the Width and Height.

8. Enter the Test Serial #, Part Number, and Type.

9. The following fields are optional:

• ZPL
• Units
• Orientation
• Description
• Comments
• Priority
• Quanitity of Requested Labels

10. The Variable Definition and Attachements forms are optional.

Figure 48: Variable Definition

Figure 49: Attachments

Select Submit Label Request located at the bottom of the page.

Appendix A – Key Terms

C

Column

The columns are parameters present on tables. A column has a type and can represent a data type like an integer, date, string or can be a link to other table being used on relationships. Columns are often referred to as database fields.

Customer

A customer of 42Q that will be related with a label.

D

Database

Database that the label engine can be connected to retrieve data. The main parameters are described below.

• Name: The name of the database, this is the name to be used on the connection.
• Type: The type of the database: PostgreSQL, Oracle, MySQL, SQLServer or Progress.
• Address: The address of the server where the database is running.
• Port: The port on the database server that is accepting connections.
• Schema: The schema is a namespace into the database that stores data in separated logical structures into the same database. PostgreSQL and Oracle can use this kind of feature.

F

Field Number

Field numbers are all fields that can be replaced or used with the result of a query or an input data. Each field number must be related with a format file.

Format File

Format files are the templates where the field numbers are associated.

L

Label

Labels are the representation of all files, data and rules that are used to build a structure for printing a label.

P

Plant

Plants are each local 42Q factory.

Printer

The printer present on a plant. These printers are installed on a print queue of the server that is running the label engine application.

1. Print Queue name of the installed print queue of the server
2. Address the IP or name address of the server that is running the label engine
3. Port the port that the label engine is running on the server

Project

The projects are structures related with Progress databases. In this sense each project must have one database associated with it. A project identifies what MES will be used on the connection with the database to retrieve data.

Q

Query

Query is the entity used to represent how data can be retrieved from a database. A query can return values of one or more columns based on the relationships among a set of tables that can be configured by the user.

T

Table

The tables are the data structure present on databases. This table contains a set of columns and can be used to create queries.

U

User

The users of the Label Engine.

V

Variable

Variables are used as parameters of the business rules and are similar to field numbers they have a query associated with them, so the result of the query will be the data inserted on the parameters.

Appendix B – File Types

Format File

A format file keeps all the structure information to print a entire label or part of it. A label is composed of one or more format files. The system contains two types of format files:

• User Format File: A file that don ’

t contain an identifier. This file is represented by the icon User format file icon in the upload file tab.

• Printer Format File: A file that contain an identifier. This file is represented by the iconPrinter format file icon in the upload file tab.

Image

A file that represent an image that will be sent to the printer.

This file is represented by the icon Image in the upload file tab.

Font

A file that represent a font style that will be used in a label. This file will be sent to the printer. It is represented by the Font icon in the upload file tab.

Appendix C – Business Rules

UPPER

Converts all of the characters returned in the field number to upper case.

LOWER

Converts all of the characters returned in the field number to lower case.

Substring by Index

Returns a string that is a substring of this field number.

Parameters

• Initial index: the beginning index, inclusive.
• Final index: the ending index, exclusive.

Substring by Char

Returns a substring, based in the specific char position.

Parameters

• Search for value: Text
• String position: Text

Insert

Insert a string in the position informed.

Parameters

• String to be inserted: the string to be inserted.
• Position of insertion: the position where the String to be inserted parameter should be inserted.

Data Format

Return the date in the specified format.

Parameter

1. Data format: the pattern describing the date and time format.

Ends With

If the field number value ends with the specified Ending with parameter, the field number value is replaced by the string in the Change for parameter.

Parameters

2. Ending with: the pattern to be matched.

3. Change for: the value to be exchanged if the Ending with parameter is matched.

Replace

Returns a new string resulting from replacing all occurrences of Pattern to be matched parameter in the field number value with Pattern to be used parameter.

Parameters

1. Pattern to be matched: the string to be found in the field number returned.

2. Pattern to be used: the string to be replaced by the pattern found in the field number.

Between

Returns a substring that is in between the Initial character parameter and the End character.

Parameters

• Initial character: the initial character to be matched.
• End character: the end character to be matched.

No Ends With

If the field number value does not end with the specified No ending with parameter, the field number value is exchanged by the string in the Change for parameter.

Parameters

• No ending with: the pattern to be matched.
• Change for: the value to be replaced if the Ending with parameter is matched.

Equals

If the field number matches the specified If equals parameter, the field number value is replaced by the string in the Change for parameter.

Parameters

1. If equals: the pattern to be matched.

2. Change for: the value to be replaced if the If equals parameter is matched.

 

 

Document Revision History

Date	Author	Title	Version	Change Reference	Approved by
01/04/2016	Elaine Fonaro	Technical Writer	V 1.0	New LE Label
04/12/2016	Elaine Fonaro	Technical Writer	V 2.01.00	Approved by Francisco Bianchi
03/04/2016	Elaine Fonaro	Technical Writer	V 2.01.00	Update Oracle occurrences to ERP
04/28/2016	Elaine Fonaro	Technical Writer	V 2.01.00	Converted for 42Q
08/02/2016	Elaine Fonaro	Technical Writer	V 2.01.00	Added new images for Label Print and the Local Print functionality and for Print History - Print Queue filed was updated to Print Destination
11/04/2016	Benjamin Cavanaugh	Technical Writer	V 2.01.00	Minor edits
03/20/2018	Elaine Fonaro	Technical Writer	V 2.01.00	Added information about plants that has this version.
03/28/2018	Elaine Fonaro	Technical Writer	V 2.01.00	Applied new Template for the format.
03/06/2019	Elaine Fonaro	Technical Writer		Updated Print History screen.