Manufacturing Execution System (MES)

Client

User Guide

Version 6.1
March, 2019
© 2019 AVEVA Group plc and its subsidiaries. All rights reserved.

No part of this documentation shall be reproduced, stored in a ret rieval system, or transmitted by any
means, electronic, mechanical, photocopying, rec ording, or otherwise, without the prior written
permission of AVEVA. No liability is assumed with respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this documentation, AVE VA assumes no
responsibility for errors or omissions. The information in this documentation is subject to change without
notice and does not represent a commitment on the part of AVEVA. The soft ware described in this
documentation is furnished under a lice nse agreement. This soft ware may be used or copied only in
accordance with the terms of such license agreement.
ArchestrA, Aquis, Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, Int elaTrac,
InTouch, OASyS, PIPEPHASE, PRiSM, PRO/II, PROV ISION, ROMeo, SIM4ME, SimCentral, SimSci,
Skelta, SmartGlance, Spiral Software, Termis, WindowMaker, WindowViewer, and Wonderware are
trademarks of AVEVA and/or its subsidiaries. An extensive listing of AVEVA trademarks can be found at:
https://sw.aveva.com/legal. All other brands may be trademarks of their respective owners.
Publication date: Wednesday, March 13, 2019
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 0HB. UK
https://sw.aveva.com/
For information on how to cont act sales, customer training, and technical support, see
https://sw.aveva.com/contact.
 MES Client User Guide

Contents
Chapter 1 Getting Started................................................................................................... 15
Introduction ............................................................................................................................ 15
About MES Client.................................................................................................................... 15
Installing MES Client ............................................................................................................... 16
Starting MES Client for the First Time ....................................................................................... 16
Starting MES Client ................................................................................................................. 17
Navigating in MES Client ......................................................................................................... 17
Closing a Module .............................................................................................................. 18
Switching Between Modules in the Tabbed Workspac e ....................................................... 19
Working with Ent ries ............................................................................................................... 19
Creating an Entry .............................................................................................................. 19
Undoing Changes ............................................................................................................. 19
Saving Changes ................................................................................................................ 19
Cutting, Copying, and Pasting Information .......................................................................... 20
Deleting an E ntry............................................................................................................... 20
Customizing Quick Access Toolbar .......................................................................................... 20
Archiving, Purging, and Restoring Dat a .................................................................................... 21
Switching Languages at Run Time ........................................................................................... 21
Viewing Error Information ........................................................................................................ 21
Customizing What You See in MES Client ................................................................................ 21
Showing/ Hiding the Status Bar ........................................................................................... 21
Showing/ Hiding the Navigation Pane, Properties Pane, and Error List Pane .......................... 22
Docking Windows .............................................................................................................. 22
Customizing the Columns Shown in the Tabbed Workspace ................................................ 23
Sorting Information ............................................................................................................ 24
Filtering Data in the Editor Window ..................................................................................... 25
Showing a Window as a Tabbed Document in the Tabbed Workspac e ................................. 26
Adding and Removing Groups in the Navigation Pane ............................................................... 27

Chapter 2 Groups and Modules ........................................................................................ 29

Introduction to Groups and Modules ......................................................................................... 29
Master Data Config Modules .................................................................................................... 29
Product Definition Modules ...................................................................................................... 30
Operations Management Modules ............................................................................................ 30
Order Management Modules ................................................................................................... 31
System Management Modules ................................................................................................. 31
Quality Management Modules.................................................................................................. 31

Version 6.1 3
MES Client User Guide Contents

Chapter 3 General Parameters ......................................................................................... 33

Introduction ............................................................................................................................ 33
System Parameters ................................................................................................................. 33
Cont rolling How the System Parameters Are Listed ............................................................. 36
Managing General Parameters ................................................................................................ 36
Modifying a System Parameter........................................................................................... 36

Chapter 4 User Groups and Users ................................................................................... 37

Introduction to User Groups and Users ..................................................................................... 37
Security Modes ....................................................................................................................... 38
The FactAdmin User Group and Unassigned Users List ............................................................ 39
Creating the Initial MES User or OS Group with the Minimum Required Privileges ...................... 39
Setting Up User Groups and Users in Native Security Mode ...................................................... 40
Setting Up User Groups and Users in OS User Security Mode ................................................... 41
Setting Up User Groups and Users in OS Group Security Mode ................................................. 45
Importing ArchestrA Users into the MES Database .................................................................... 49
Assigning Privileges to User Groups ........................................................................................ 49
Assigned Privileges Example ............................................................................................. 50
Providing Entity Access to User Groups ................................................................................... 51
Providing Line Access to User Groups...................................................................................... 52
MES Web Portal User Aut hentication and Privileges ................................................................. 52
User Authentication ........................................................................................................... 52
Using OS Group vs. OS User Sec urity Mode ................................................................. 52
MES Web Portal OS Group Security and Multiple Active Directory Domains.................... 53
Authentication Checks Performed When a User Logs In ................................................ 53
Privilege and Access Settings ............................................................................................ 54
Example Roles and Privilege Settings ........................................................................... 56

Chapter 5 Language Strings .............................................................................................. 59

Introduction to Languages Strings ............................................................................................ 59
Creating a Language............................................................................................................... 59
Editing a Language’s Strings ................................................................................................... 60
Finding and Replacing a Language String ................................................................................. 60
Viewing Language Details ....................................................................................................... 61

Chapter 6 Physical Entities ................................................................................................ 63

Introduction to Physical Entities................................................................................................ 63
Restrictions on Entities Assigned to Lines in MES Web Portal .................................................... 65
Applying Filters ....................................................................................................................... 65
Creating a Physical Entity ........................................................................................................ 66
Entity Classes......................................................................................................................... 66
Entity Properties ..................................................................................................................... 67

4 Version 6.1
Contents MES Client User Guide

Capabilities ....................................................................................................................... 67
Schedule Jobs .................................................................................................................. 68
Jobs ................................................................................................................................. 68
Utilization.......................................................................................................................... 71
Labor................................................................................................................................ 73
OEE ................................................................................................................................. 73
Understanding Batches and Lots for OEE and Estimated Times ..................................... 74
Storage ............................................................................................................................ 75
Class Membership............................................................................................................. 76
Files ................................................................................................................................. 76
Adding Files and Web Pages to an Entity ...................................................................... 77
Directories ........................................................................................................................ 80
Adding Directories to an Entity...................................................................................... 80
Miscellaneous ................................................................................................................... 81
Assigning Item Reason Groups to an Entity ........................................................................ 81
Assigning Attributes to an Entity ............................................................................................... 82
Parent Entities and Inheritance ................................................................................................ 83
Associations Inherited from a Parent Entity ......................................................................... 83
Entities with Multiple Parents ............................................................................................. 84
Resolving Inheritance for Entities with Multiple Parents .................................................. 84

Chapter 7 Sites..................................................................................................................... 85
Introduction to Sites ................................................................................................................ 85
Creating a Site ........................................................................................................................ 85

Chapter 8 Shifts and Shift Schedules ............................................................................... 87

Introduction to Shifts and Shift Schedules ................................................................................. 87
Filtering the Entities in the Navigation Tree ............................................................................... 88
Creating a Shift ....................................................................................................................... 89
Creating an Entity Shift Schedule ............................................................................................. 89
Creating a Shift Schedule for an Entity That Cannot Schedule Shifts .......................................... 90
When Shift Changes Are Applied ............................................................................................. 91

Chapter 9 Utilization States................................................................................................ 93

Introduction to Utilization States ............................................................................................... 93
Creating a Utilization State ...................................................................................................... 94

Chapter 10 Utilization Reasons and Reason Groups .................................................... 95

Introduction to Utilization Reasons and Reason Groups ............................................................ 95
Creating a Utilization Reason Group ........................................................................................ 96
Creating a Utilization Sub-Reas on Group ................................................................................. 96
Creating a Utilization Reason................................................................................................... 96
Utilization Reason Properties ............................................................................................. 97
Moving and Copying a Utilization Reas on to Another Group ...................................................... 97

Chapter 11 Categories ........................................................................................................ 99

Introduction to Categories ........................................................................................................ 99

Version 6.1 5
MES Client User Guide Contents

Category Module Layout.......................................................................................................... 99

Creating a Category .............................................................................................................. 100
Linking Items to an It em Cat egory .......................................................................................... 100
Linking Caus e Groups to Characteristics ................................................................................ 101
Deleting Category Links ........................................................................................................ 102
Deleting Categories ............................................................................................................... 103

Chapter 12 Job and Step States ..................................................................................... 105

Introduction to Job and Step States ........................................................................................ 105
A vailable Job and Step States ............................................................................................... 105
Modifying a Job or Step State ................................................................................................ 106

Chapter 13 Attributes ........................................................................................................ 107

Introduction to Attributes ........................................................................................................ 107
Understanding Attribute Data Types ....................................................................................... 108
Creating an Attribute ............................................................................................................. 109
Assigning (Linking) Attributes ................................................................................................. 110
Understanding Lot Attributes .................................................................................................. 111

Chapter 14 File Extensions .............................................................................................. 113

Introduction to File Extensions ............................................................................................... 113
Adding a File Extension ......................................................................................................... 114

Chapter 15 Items................................................................................................................ 117

Introduction to Items .............................................................................................................. 117
Applying Filters ..................................................................................................................... 118
Arranging Columns.......................................................................................................... 119
Creating an It em ................................................................................................................... 119
Item Properties................................................................................................................ 119
Assigning Certifications to an It em ......................................................................................... 122
Adding Files and Web Pages to an Item ................................................................................. 125
Creating a BOM for an Item ................................................................................................... 128
BOM Properties .............................................................................................................. 129
Specifying BOM Components ................................................................................................ 131
BOM Component Properties ............................................................................................ 131
Creating an It em Substitute ................................................................................................... 133
Item Substitute Properties ................................................................................................ 133
Viewing the Proc esses Linked to an Item ................................................................................ 135
Viewing the Relationship Diagram .......................................................................................... 135
Assigning a Storage Entity for an Item .................................................................................... 136
Assigning Attributes to an Item ............................................................................................... 136

Chapter 16 Item Classes .................................................................................................. 137

6 Version 6.1
Contents MES Client User Guide

Introduction to Item Classes................................................................................................... 137

Creating an It em Class .......................................................................................................... 137
Item Class Properties ...................................................................................................... 138
Linking an Item Reason Group to an Item Class...................................................................... 139
Copying an Item Class .......................................................................................................... 139
Viewing the Relationship Diagram .......................................................................................... 139
Assigning Attributes to an Item Class ..................................................................................... 140

Chapter 17 Units of Measure ........................................................................................... 141

Introduction to Units of Measure............................................................................................. 141
Creating a Unit of Meas ure .................................................................................................... 141
Creating an It em-Specific Unit of Measure Conversion ............................................................ 142
Viewing the Relationship Diagram .......................................................................................... 142

Chapter 18 Item Grades ................................................................................................... 145

Introduction to Item Grades ................................................................................................... 145
Creating an It em Grade ......................................................................................................... 145

Chapter 19 Item States ..................................................................................................... 147

Introduction to Item States ..................................................................................................... 147
Creating an It em State........................................................................................................... 147

Chapter 20 Item Reasons................................................................................................. 149

Introduction to Item Reasons ................................................................................................. 149
Creating an It em Reason Group............................................................................................. 150
Creating an It em Reason ....................................................................................................... 151

Chapter 21 Global Specifications .................................................................................... 153

Introduction to Global Specifications ....................................................................................... 153
Creating a Global Specification .............................................................................................. 156
Using Specifications in the Operations Capability Object ......................................................... 157
Understanding Specification Capabilities ................................................................................ 159

Chapter 22 Labor Departments ....................................................................................... 161

Introduction to Labor Departments ......................................................................................... 161
Creating a Labor Department ................................................................................................. 161

Chapter 23 Labor Categories........................................................................................... 163

Introduction to Labor Categories ............................................................................................ 163
Creating a Labor Category..................................................................................................... 163

Chapter 24 Certifications .................................................................................................. 165

Introduction to Certifications................................................................................................... 165
How Access Certifications Work ....................................................................................... 166
How Audit Certifications Work .......................................................................................... 166

Version 6.1 7
MES Client User Guide Contents

Certification Levels .......................................................................................................... 167

Creating a Certification .......................................................................................................... 167
Certification Properties .................................................................................................... 168
Assigning a Certification to Users ........................................................................................... 169
Assigning Certifications to Actions.......................................................................................... 170
Deleting a Certification .......................................................................................................... 170

Chapter 25 Processes....................................................................................................... 171

Introduction to Processes ...................................................................................................... 171
Applying Filters ..................................................................................................................... 173
Arranging Columns.......................................................................................................... 174
Workflow for Creating Processes ........................................................................................... 174
Creating a Process Class ...................................................................................................... 175
Creating a Process .......................................................................................................... 176
Process Properties .......................................................................................................... 176
Setting the Process Level ...................................................................................................... 177
Setting the Process Status..................................................................................................... 177
Assigning Items to a Process ................................................................................................. 178
Assigning an Attribute to a Process ........................................................................................ 179
Adding an Operation to a Process .......................................................................................... 180
Operation Properties ....................................................................................................... 180
Adding a File or Web Page to an Operation ................................................................. 181
Assigning a BOM to an Operation ............................................................................... 182
Assigning Certifications to an Operation ...................................................................... 184
Assigning Data Log Groups to an Operation................................................................ 187
Assigning an Entity to an Operation .................................................................................. 189
Assigning Steps to an Operation ...................................................................................... 190
Creating an Operation Step Group.............................................................................. 191
Creating an Operation Step ........................................................................................ 192
Operation Step Properties .......................................................................................... 192
Assigning Certifications to an Operation Step .............................................................. 194
Adding Files and Web Pages to an Operation Step ...................................................... 197
Assigning Data Log Groups to an Operation Step ........................................................ 200
Copying a Step.......................................................................................................... 203
Assigning Specifications to an Operation .......................................................................... 204
Creating a Specification ............................................................................................. 204
Adding a BOM Specification ....................................................................................... 205
Adding an Entity Specification .................................................................................... 206
Adding an It em Specification ...................................................................................... 207
Specification Properties ............................................................................................. 208
Adding a File or Web Page to a Specification Being Added to an Operation .................. 209
Assigning Attributes to an Operation ................................................................................. 210
Cloning an Operation....................................................................................................... 211
Adding a Standard Operation to a Process ............................................................................. 211
Creating a Route Map ........................................................................................................... 212
Checking Out and Checking In a Process ............................................................................... 213
Closing the Process Window with Processes Checked Out ................................................ 214

8 Version 6.1
Contents MES Client User Guide

Cloning a Process ................................................................................................................. 214

Copying a Process ................................................................................................................ 214
Verifying a Proc ess ............................................................................................................... 215

Chapter 26 Dynamic Routing ........................................................................................... 217

Introduction to Dynamic Routing ............................................................................................ 217
Dynamic Routing Codes ........................................................................................................ 217
The Dynamic Routing Workspace .......................................................................................... 218
Creating a Dynamic Routing Usage ........................................................................................ 219

Chapter 27 Standard Operations .................................................................................... 221

Introduction to Standard Operations ....................................................................................... 221
Creating a Standard Operation .............................................................................................. 222
Standard Operation Properties ............................................................................................... 222
Assigning Entities to a Standard Operation ............................................................................. 223
Assigning Steps to a Standard Operation ............................................................................... 224
Adding a Specification Version to a Standard Operation .......................................................... 225
Assigning Attributes to a Standard Operation .......................................................................... 227
Cloning a Standard Operation ................................................................................................ 227

Chapter 28 Job Queue...................................................................................................... 229

Introduction to the Job Queue ................................................................................................ 229
Job and Step States .............................................................................................................. 229
Applying Filters to the Job Queue........................................................................................... 230
Job Queue Filter Options ................................................................................................. 231
Arranging Columns in the Job Queue ..................................................................................... 232
Viewing a Job’s Route Diagram ............................................................................................. 232
Creating a Work Order from a Process from the Job Queue Module ......................................... 233
Splitting Jobs ........................................................................................................................ 233
Editing Selected Jobs ............................................................................................................ 234
Creating Links for a Job Queue.............................................................................................. 234
Deploying a Queue Sequence ............................................................................................... 235

Chapter 29 Work Orders and Jobs ................................................................................. 237

Introduction to Work Orders and Jobs .................................................................................... 237
Restrictions on Work Orders and Jobs Created in MES Web Portal .......................................... 238
Organizing Work Orders and Jobs ......................................................................................... 238
Applying Filters to the Work Orders List .................................................................................. 239
A vailable Work Order Filters ............................................................................................ 239
Arranging Columns of the Work Order List .............................................................................. 240
Workflow for Creating Work Orders and Jobs.......................................................................... 241

Version 6.1 9
MES Client User Guide Contents

Creating a Work Order from a Process ................................................................................... 241

Work Order from Process Properties ................................................................................ 242
Creating a Work Order .......................................................................................................... 243
Work Order Properties ..................................................................................................... 243
Adding Files and Web Pages to a Work Order .................................................................. 246
Assigning Attributes to a Work Order ...................................................................................... 249
Creating a Job ...................................................................................................................... 249
Job Properties ................................................................................................................. 249
General P roperties .................................................................................................... 249
Setup Properties........................................................................................................ 252
Schedule Properties .................................................................................................. 253
Status Properties ....................................................................................................... 253
DataLog Property ...................................................................................................... 254
Creating a Job BOM .............................................................................................................. 257
Job BOM Property Settings .............................................................................................. 258
Substitutes Settings......................................................................................................... 259
Assigning Steps to a Job ....................................................................................................... 260
Creating a Step Group ..................................................................................................... 260
Creating a Job Step......................................................................................................... 261
Job Step Properties ................................................................................................... 261
Configuring the BOM Consumption Amount for the Job Step ........................................ 264
Adding Files and Web Pages to a Job Step ................................................................. 264
Assigning Data Log Groups to a Job Step ................................................................... 268
Assigning Specifications to a Job ........................................................................................... 270
Adding a File or Web Page to a Job Specification .............................................................. 272
Assigning Attributes to a Job.................................................................................................. 273
Creating a Route Map ........................................................................................................... 273
Adding a Standard Operation to a Job .................................................................................... 274
Cloning Work Orders and Jobs .............................................................................................. 275
Cloning a Work Order ...................................................................................................... 275
Cloning a Job.................................................................................................................. 276
Canc eling All Jobs in a Work Order ........................................................................................ 277
Setting Job Priorities to the Work Order Priority....................................................................... 277
Splitting Jobs ........................................................................................................................ 277

Chapter 30 Database Information ................................................................................... 279

Introduction to Database Information ...................................................................................... 279
Viewing Dat abas e Information ............................................................................................... 280

Chapter 31 Database Maintenance ................................................................................ 281

Introduction to Database Maintenance .................................................................................... 281
Managing the MES Database ................................................................................................ 282
Specifying the Archive Query Window, Root Directory Path, and Server Host ........................... 282
Creating an Archive Job ........................................................................................................ 283
Creating a Purge Job ............................................................................................................ 284

10 Version 6.1
Contents MES Client User Guide

The Purge Process.......................................................................................................... 284

Creating a Restore Job.......................................................................................................... 285
Viewing the List of APR Jobs ................................................................................................. 286
Viewing the APR Job Configuration Details ............................................................................. 286
Viewing the APR Job Log ...................................................................................................... 287
Removing an APR Job .......................................................................................................... 287
Running an APR Job Manually .............................................................................................. 287
Running an Archive or Purge Job Automatically ...................................................................... 288

Chapter 32 Rejected Message Viewer ........................................................................... 289

Introduction to the Rejected Message Viewer .......................................................................... 289
Viewing and Editing a Rejected MES Command Message ....................................................... 290
Resubmitting a Rejected MES Command Message ................................................................. 290
Deleting a Rejected MES Command Message ........................................................................ 291

Chapter 33 Serialization ................................................................................................... 293

Introduction to Serialization.................................................................................................... 293
Setting up Serialization in MES .............................................................................................. 293
Configuring Item Classes ................................................................................................. 294
Configuring Items ............................................................................................................ 294
Configuring BOMs ........................................................................................................... 295
Configuring Processes..................................................................................................... 296
Configuring Operations .................................................................................................... 297
Creating a Process Route Map......................................................................................... 298
Creating a Work Order That Produces Serializ ed Items ..................................................... 299
Producing Serialized Items in Operator................................................................................... 299
Cont rolling the Serial Numbers Flow................................................................................. 300
Linear Flow ............................................................................................................... 300
Manual Transfer of Serial Numbers .................................................................................. 300
First Operation Production ............................................................................................... 300
Intermediate Operation Production ................................................................................... 300
Last Operation Production ............................................................................................... 301

Chapter 34 Sample Plan Frequency............................................................................... 303

Introduction to Sample Plan Frequency .................................................................................. 303
Applying Filters ..................................................................................................................... 304
Creating a Sample Plan Frequency ........................................................................................ 304
Sample Plan Frequency Properties .................................................................................. 305
Required Properties ................................................................................................... 305
Optional Properties for Any Frequency Type ............................................................... 305
Optional Properties for Shift Frequency ....................................................................... 306
Optional Properties for Calendar Frequency ................................................................ 306
Optional Properties for P roduction Frequency ............................................................. 307
Determining Frequency Type Shift ......................................................................................... 307
Determining Frequency Type Production Count ...................................................................... 308
Data Change Frequency........................................................................................................ 309

Version 6.1 11
MES Client User Guide Contents

Chapter 35 Sample Plans................................................................................................. 311

Introduction to Sample Plans ................................................................................................. 311
Applying Filters to the List of Sample Plans ............................................................................ 312
Creating a Sample Plan......................................................................................................... 312
Sample Plan Properties ......................................................................................................... 312
Sample Naming Conventions and Replaceable Parameters ..................................................... 313
Replaceable Parameters ................................................................................................. 314
Linking a Sample Plan Frequency to a Sample Plan ................................................................ 315

Chapter 36 Variable and Attribute Characteristic Definitions ..................................... 317

Introduction to Variable and Attribut e Characteristic Definitions ................................................ 317
Applying Filters to the List of Characteristics ........................................................................... 318
Managing Characteristics ...................................................................................................... 318
Cont rolling the Amount of Data Used in Calculating Process Statistics ..................................... 320
Creating a Characteristic ....................................................................................................... 321
Characteristic Properties .................................................................................................. 322
Variable Characteristic Properties ............................................................................... 323
Binary Attribute Characteristic Properties .................................................................... 324
Counted Attribute Characteristic Settings .................................................................... 325
Linking an Attribute to a Characteristic.................................................................................... 326

Chapter 37 QM Specifications ......................................................................................... 327

Introduction to QM Specifications ........................................................................................... 327
Applying Filters to the List of QM Specifications ...................................................................... 328
Managing QM Specifications ................................................................................................. 329
Creating a QM Specification .................................................................................................. 329
QM Specification Properties ............................................................................................. 329
Linking a Characteristic to a QM Specification ......................................................................... 330
Properties for a Characteristic Linked to a QM Specification ............................................... 332
Linking a Control Rule to a QM Specification .......................................................................... 334
Linking an Attribute to a QM Specification ............................................................................... 335

Chapter 38 Causes............................................................................................................ 337

Introduction to Causes........................................................................................................... 337
Creating a Cause Group........................................................................................................ 338
Adding a Cause to a Cause Group ......................................................................................... 339
Arranging the Order of Cause Groups and Causes.................................................................. 339
Copying Causes to Another Cause Group .............................................................................. 340
Deleting Cause Groups and Causes ...................................................................................... 340

Appendix A System Parameters ..................................................................................... 341

System Parameter Groups .................................................................................................... 341

12 Version 6.1
Contents MES Client User Guide

System Parameters Reference .............................................................................................. 341

Appendix B User Privileges.............................................................................................. 361

User Privilege Groups ........................................................................................................... 361
User Privileges Reference ..................................................................................................... 361

Appendix C Historical Database Tables......................................................................... 371

Index ....................................................................................................................................... 377

Version 6.1 13
 MES Client User Guide

C HAPTER 1
Getting Started
In This Chapter
Introduction .................................................................................................................................. 15
About MES Client ......................................................................................................................... 15
Installing MES Client ..................................................................................................................... 16
Starting MES Client for the First Time ............................................................................................ 16
Starting MES Client....................................................................................................................... 17
Navigating in MES Client ............................................................................................................... 17
Working with Ent ries ..................................................................................................................... 19
Customizing Quick Access Toolbar ................................................................................................ 20
Archiving, Purging, and Restoring Dat a .......................................................................................... 21
Switching Languages at Run Time ................................................................................................. 21
Viewing Error Information .............................................................................................................. 21
Customizing What You See in MES Client ...................................................................................... 21
Adding and Removing Groups in the Navigation Pane .................................................................... 27

Introduction
The Manufacturing Execution System (MES) Client application provides a us er int erface to configure and
monitor your plant model and production processes.
The MES Client application gives you the ability to configure items, operations, proc esses,
specifications, labor, certific ations, work orders, and jobs. You can configure the collection of data
related to the plant floor equipment performance information for determining the Overall Equipment
Effectiveness (OEE) and its components—A vailability, Performance, and Quality. You can also
configure sample frequencies, characteristics, and test plans to collect quality -related data.
The information configured in the MES Client application is used t o collect your plant process information
from operators and production equipment on the plant floor. The information collected and stored from
your production processes gives you the information needed to control and improve the overall operation
management and performance of the plant.

About MES Client

The MES Client application is a collection of modules, grouped by function and role of the user, to allow
the configuration and monitoring of your plant operations.
You can use the MES Client application to:
 Define users and user groups. This includes assigning passwords, privileges, user certifications, and
entity access rights to different users to limit their access to different areas of the MES Client
application
 Define global system parameters.
 Configure language strings.
 Configure physical entities.
 Configure sites.

Version 6.1 15
MES Client User Guide Getting Started

 Configure shifts and shift schedules for machines.

 Define utilization states for machines (such as Running or Idle) and the utilization reasons for those
states (such as Meal Break).
 Define categories for use with quality management (QM) specifications and causes.
 Modify the names and colors associated with job and step states.
 Define custom attributes.
 Define file extensions for document files and web pages that can be assigned to MES components
such as entities, work orders, and jobs to provide information and instructions to operators.
 Configure items and item classes.
 Specify units of measure (UOMs) for items and characteristics.
 Specify item states, grades, and reasons.
 Configure global specifications that can be assigned to an operation, process, or job.
 Define labor departments and labor categories to provide context for entities that can track labor
data.
 Define certifications that can be assigned to items, operations, operation steps, and job steps to
restrict user access to related tasks or require sign-offs to complete those tasks for auditing
purposes.
 Configure a process, operation, standard operation, and dynamic routing processes.
 Configure work orders and jobs.
 Manage jobs in the job queue.
 Maintain the MES database.
 Edit and resubmit rejected messages.
 Configure serialization to assign specific serial numbers to produced items.
 Configure QM sample plan frequencies.
 Configure QM sample plans.
 Configure variable and attribute characteristic definitions for QM to allow an aspect of an item,
process, or entity to be measured.
 Configure quality specifications
 Define causes, and caus e groups, to allow a cause to be assigned to a characteristic sample.

Installing MES Client

The MES Client application is installed during the complete installation. For more information on
installation, see the MES Installation Guide or help.

Starting MES Client for the First Time

If you are starting the MES Client application for the first time, the login dialog box does not appear
because users are not yet defined in the MES dat abas e.
The first task you must perform after starting MES Client for the first time is to c reate a user or an OS user
group wit h the security privileges May run configuration tools and May edit user settings enabled. This
user or a member of the OS us er group can subsequently log into MES Client and other MES
applications with configuration privileges.

16 Version 6.1
Getting Started MES Client User Guide

For more information, see Creating the Initial MES User or OS Group with the Minimum Required
Privileges.

Starting MES Client

1. On the Start menu, click the MES Client tile.
The Loading MES Client screen appears. Then, if your Windows user account has been configured
as an MES user and the Automatic Login system parameter has been set to Yes, MES Client opens
without prompting for user authentication. Otherwise, the login di alog box appears.

2. In the Language list, click the language in which you want the login dialog box to appear.
You can select only those languages that are configured in the MES Client application. If you restart
the application, the language setting resets to the default language. The defa ult language is set by
the Display system parameter Default Language. For more information on the Display system
parameters, see System Parameters Reference on page 341.
3. In the User Name and Password boxes, type your username and password.
o If the MES user Security mode is set to Native, you can obtain the username and password from
the MES administrat or who set up users in MES Client.
o If the Security mode is set to OS User or OS Group, enter your Windows username, including the
domain.
4. Click Logon.
The MES Client application opens.

Note: If the MES user Security mode is set to OS Group and the username you entered is not a member
of a Windows user group that has been added to the MES database, the following error message
appears: OS User group is not configured. For more information, see Setting Up User Groups and Users
in OS Group Security Mode on page 45.

Navigating in MES Client

The MES Client application can display large amount of data in an organized way. You can modify the
application workspace as per your requirements, such as docking and und ocking the panes, switching
between opened editors, showing/hiding the panes, and so on.

Version 6.1 17
MES Client User Guide Getting Started

The following figure shows the layout MES Client window.

Navigation Pane
You can select a group in the Navigation pane to show the associated modules underneath. For
more information on working with groups, see Groups and Modules on page 29.
Tabbed Workspace
When you click a module from the Navigation pane, the configuration workspac e appears in the
Tabbed Workspace.
Properties Pane
When you click an item in the workspace, its properties appear in the Properties pane and can be
configured here.
Error Li st Pane
The Error List pane shows the errors occurred during configuration.
The Navigation pane, Properties pane, and Error Li st pane are dockable panes. You can undock and
move them to the top, bottom, right, or left of the Tabbed Workspace.

Closing a Module
You can close a selected module or all open modules in the MES Client application.
To close a window

 Click the Application button , and then click Close.

18 Version 6.1
Getting Started MES Client User Guide

To close all windows

 Click the Application button , and then click Close All.

Switching Between Modules in the Tabbed Workspace

If you have multiple edit ors open, the Tabbed Workspace shows a tab for every edit or.
To switch between editors, do either of the following
 Click the tab you want to select.
 On the ribbon, click the View tab. In the Window group, click the name of the module you want
to switch to.

Working with Entries

An entry is a specific element that is maintained in the modules of MES Client application. For example,
an ent ry could be a machine, an item, a user, a process, a work order, or an attribute.

Creating an Entry
When you create a new entry, you can type the details for the new entry in the Properties pane.
To create an item
 On the ribbon, click the Home tab. In the Main group, click New.

Undoing Changes
You can undo multiple actions and revert to the original state before saving the changes. This
functionality will not work once the changes are saved.
To undo the last change
On the ribbon, click the Home tab. In the Clipboard group, click Undo.
To undo all changes
 On the ribbon, click the Home tab. In the Clipboard group, click Undo All.

Saving Changes
You can save the changes that you have made to a single module or all modules that are open ed in the
Tabbed Workspace.

Version 6.1 19
MES Client User Guide Getting Started

To save changes for a module, do any one of the following:

 Click the Application button , and then click Save.

 On the ribbon, click the Home tab. In the Main group, click Save.
To save changes for all modules, do any one of the following:

 Click the Application button , and then click Save All.

 On the ribbon, click the Home tab. In the Main group, click Save All.

Cutting, Copying, and Pasting Information

You can cut, copy, and paste information within a module. For example, you can copy an existing item
state and modify the state as per your requirements to create a new item state.
To cut information
1. Select the text that you want to cut.
2. On the ribbon, click the Home tab. In the Clipboard group, click Cut.
To copy information
1. Select the text that you want to copy.
2. On the ribbon, click the Home tab. In the Clipboard group, click Copy.
To paste information
1. Click the location where you want to paste the information.
2. On the ribbon, click the Home tab. In the Clipboard group, click Paste.

Deleting an Entry
To delete an entry
 On the ribbon, click the Home tab. In the Main group, click Delete.

Customizing Quick Access Toolbar

You can click the menu icon on the top left of application to access the menu options available in the
Application button menu. For more information on menu options, see Work ing with Entries on page 19.

To customize the quick access toolbar

 Click the menu icon , and then select the option you want to include in the quick access toolbar.

20 Version 6.1
Getting Started MES Client User Guide

To change the location of the quick access toolbar

 Click the menu icon , and then click Show Below the Ribbon.
If the quick access toolbar is placed below the ribbon, you can click Show Above the Ribbon to
replace the quick access toolbar above the ribbon.
To minimize the ribbon
 Click the menu icon , and then click Minimize the Ribbon.

Archiving, Purging, and Restoring Data

You can archive, purge, and restore the data saved in the MES database. For more information on
database maintenance, see Database Maintenance on page 281.
For more information on list of Historical database tables that you can archive, purge, or restore, see
Historical Database Tables on page 371.

Switching Languages at Run Time

You can change the language for the MES Client application at run time.
1. On the ribbon, click the Tools tab.
2. In the Language group, click Languages.
3. In the Language list, click the language that you want to apply to the MES Client application.
Languages that are configured in the language string table are displayed in the Languages list. For more
information on configuring languages, see Language Strings on page 59.

Viewing Error Information

Only configuration errors are shown in the Error List pane. All run time errors are shown in the ArchestrA
Logger. The following information is shown:
Type
Describes the type of error.
Instance
Describes the reason for the error.
Description
Shows the description for the error.
Extension
Shows the name of the module of the error.
Error Level
Shows the severity level of the error. For example, whet her the error is critical or it is warning.

Customizing What You See in MES Client

You can customize the MES Client application per your requirements.

Showing/Hiding the Status Bar

To show the status bar
 On the ribbon, click the View tab. In the Show/Hide group, click Status Bar so that a check mark
appears.

Version 6.1 21
MES Client User Guide Getting Started

To hide the status bar

 On the ribbon, click the View tab. In the Show/Hide group, click Status Bar to clear the check mark
that appeared.

Showing/Hiding the Navigation Pane, Properties Pane, and Error List

Pane
You can hide the Navigation pane, Propertie s pane, and Error Li st pane completely from the MES
Client application.
You can also click the Auto Hide button, shown below, to reduce the panes down to a tab that appears on
the side of the application.

When you show a hidden pane or list, it appears in the position it was in when it was hidden.
To hide a pane or list
1. Select the pane or list that you want to hide.
2. Click the Window Position menu icon (on the top of Navigation Bar, Error Li st, and
Properties pane), and then click Hide.
To show a hidden pane or list
 On the ribbon, click the View tab. In the View group, click either Navigation pane, Propertie s pane,
or Error li st.
To auto hide a pane or list
1. Select the pane or list that you want to auto hide.
2. On the top of Navigation Bar, Error Li st, and Propertie s pane, click the Auto Hide icon .
To show a pane or list that has been automatically hidden
 Click the tab along the side of the application.

Docking Windows
Dockable allows you to dock the selected pane in any of the four window position that is left, right, top,
and bottom.
To dock a window
1. Select the window that you want to dock.
2. Do one of the following:
 Click the Window Position menu icon (on the top of Navigation Bar, Error Li st, and
Properties pane), and then click Dockable.

22 Version 6.1
Getting Started MES Client User Guide

 Right -click the title bar, and click Dockable.

Arrows appear in the application where you can choose to dock the window.
3. Drag the window onto an arrow.

.
You will be able to see the arrows when you drag a window.

Customizing the Columns Shown in the Tabbed Workspace

You can rearrange the columns in the Tabbed Workspace.
To rearrange a column
 Drag and drop a column in the workspace to arrange the columns. You can rearrange the columns
when the up and down arrows appears on top and bottom of the selected column, as shown below.

For example, the Process Class ID column is dragged bet ween Status and Process ID columns in
the dialog box shown below. Once the columns are arranged the Process Class ID column appears
between Status and Process ID columns.

Version 6.1 23
MES Client User Guide Getting Started

To stack and order columns

 Drag and drop a column on another column. The columns are stacked when the left and right arrows
appears on both sides of the selected column, as shown below.

The data grid appears in the order you stack the columns. For example, columns user ID, language,
active, and description are stacked and information related to these columns is also stacked in the
same order in the dialog box shown below.

To change width of a column

 Drag a column boarder to left or right to change width of a column.
Changing width of a column in the workspace does not save the configuration of filter and column width.
The configuration is saved if you do one of the following: change a columns position, add or remove a
column, apply grouping to the grid, or change the sort order.

Sorting Information
You can sort information in the workspace based on different columns.

24 Version 6.1
Getting Started MES Client User Guide

To sort a column
 Select a column and click the sort icon to sort a column in ascending or descending order.

To group information
1. Click Filter Bar in the Editor window.

Group By Area appears in the Edit or window.

2. Drag and drop a column on Group by Area in the E ditor window. The information is sort ed based on
the selected column. For example, in the following dialog box the item data grid is grouped by the
Item Class ID column.

Filtering Data in the Editor Window

You can filter dat a that is shown in the Editor Window.
To filter data
1. In the filt er bar (in the Editor window), select or clear the Status check box to view the modified or not
modified items.
2. Click the filter icon to close the search result.

3. Click the filter condition icon and select a condition from the list to configure the search. By
default, the starts with option is selected.

Version 6.1 25
MES Client User Guide Getting Started

4. Select Custom to do a custom search. The Custom Filter Selection dialog box appears.

5. Enter the filter criteria, which are described below.

Add Condition
Click Add Condition to add a condition for the search. You can add more than one condition for the
search.
Operator
Select the required condition.
Operand
Select or type the operand value.
’And’ Group
Click ’And Group’ to add the selected condition to the And group. The ‘And’ Group shows the
result that fulfills all the search conditions available in the group.
’Or’ Group
Click ‘Or’ Group to add the selected condition in the Or group. The ‘Or’ Group shows the result that
fulfills any one of the search conditions available in the group.
Toggle
Click Toggle to move the search from ‘And’ Group to ‘Or Group’ and vice versa.
Ungroup
Click Ungroup to ungroup the search condition.
Remove Condition(s)
Click Remove Condition(s) to remove the selected condition.
6. When you have finis hed entering the search criteria, click OK.
7. Select Blanks to view the list of items that have a blank space.
8. Select NonBlanks to view the list of items that do not have a blank space.

Showing a Window as a Tabbed Document in the Tabbed Workspace

To show a window as a tab
1. Select the window that you want to show as tabbed.
2. Click the Window Position menu icon (on the top of Navigation Bar, Error Li st, and
Properties pane), and then click Tabbed Document.

26 Version 6.1
Getting Started MES Client User Guide

3. To show the window back in its original position, right-click the tabbed document in the Tabbed
Workspace, and then click Dockable.

Adding and Removing Groups in the Navigation Pane

You can add or remove a group in the Navigation pane.
To add or remove a group
1. Click the menu icon at bottom right of the Navigation pane.

2. Point to Add or Remove Buttons, and then click the group you want to add or remove from the
Navigation pane.
To move up and down a group
1. Click the menu icon at the bottom right of the Navigation pane.
2. Click Navigation Pane Options.
The Navigation Pane Options dialog box appears.

3. Select a group, and then click Move Up or Move Down to move a group up or down.
4. Click Reset to revert to the default settings.
5. Click OK to save the changes.
To show and hide groups
 Click the icon at the bottom right of the Navigation pane, and then do the following:
 Click Show More Buttons to view all groups in the Navigation pane.
 Click Show Fewer Buttons to hide some groups in the Navigation pane.

Version 6.1 27
 MES Client User Guide

C HAPTER 2
Groups and Modules
In This Chapter
Introduction to Groups and Modules ............................................................................................... 29
Master Data Config Modules ......................................................................................................... 29
Product Definition Modules ............................................................................................................ 30
Operations Management Modules ................................................................................................. 30
Order Management Modules ......................................................................................................... 31
System Management Modules....................................................................................................... 31
Quality Management Modules ....................................................................................................... 31

Introduction to Groups and Modules

The MES Client application includes modules that enables you to configure and maintain plant
information. The modules in the MES Client application are grouped based on thei r functionality.
The following are the module groups available in the MES Client application:
 Master Data Config
 Product Definition
 Operations Management
 Order Management
 System Management
 Quality Management

Master Data Config Modules

General Parameters
Allows you to specify the system parameters for the MES applications.
User Groups and Users
Allows you to configure users and user groups and provide privileges and access rights to the
specified user groups.
Languages
Allows you to configure languages for the MES applications.
Physical Entitie s
Allows you to create and maintain entity definitions in the system.
Site
Allows you to configure sites and the region details for an entity.
Shift and Shift Schedule
Allows you to configure the shift days, timings, and shift breaks for an entity on the plant floor.
Utilization States
Allows you to define possible utilization states that can be applied to entities on the plant floor.

Version 6.1 29
MES Client User Guide Groups and Modules

Utilization (Reason Groups and Reasons)

Allows you to define utilization reasons for an entity entering a utilization state and associate the
state to its possible reasons. Reas ons are organiz ed into reason groups.
Category
Allows you to assign items to item categories. This enables the same QM specification to be shared
by multiple items that are in the same category.
Job and Step States
Allows you to view the job and step states that are available in the system, and to change their name
and associated color.
Attribute s
Allows you to specify the attribute of an item, item class, work order, job, and so on. You can also
specify its data and entry types.
File Extensions
Allows you to define file extensions for document files and web pages that can be assigned to MES
components such as entities, work orders, and jobs to provide information and instructions to
operators.

Product Definition Modules

Items
Allows you to specify an item. You can also apply filters to the item classes.
Item Classe s
Allows you to configure an item class and specify det ails of an item class, such as produced,
consumed, and obsolete.
Units of Measure
Allows you to specify the units of meas ure for an item.
Item Grades
Allows you to specify various grades of an item, such as approved, on hold, or rejected. You can
select and apply different colors to each grade.
Item States
Allows you to specify the state of an item, such as work in progress and finished goods. You can
select and apply different colors to each state.
Item Reasons
Allows you to configure item reason for an item. You can link BOM version, BOM item, and entities to
the specified reason. You can also create a group of item reasons and link the classes and entities to
the item reas ons group.
Attribute s
Allows you to specify the attribute of an item and item class. You can also specify its data and entry
types.

Operations Management Modules

These modules require an Operations license for them to be enabled.
Global Specifications
Allows you to specify global specifications for an entity class, item class, entity, or item.
Labor Departments
Allows you to create labor departments that can be assigned to MES users and job operations. Labor
departments can provide contextual information about the time that MES users spend working on
entities that have the ability to track labor.

30 Version 6.1
Groups and Modules MES Client User Guide

Labor Categories
Allows you to create labor categories that can be assigned to MES users and job operations. Labor
categories can provide cont extual information about the time that MES users spend working on
entities that have the ability to track labor.
Certifications
Allows you t o define certifications that can be assigned to items, operations, operation steps, and job
steps to restrict user access to related tasks or require sign-offs to complete those tasks for auditing
purposes.
Processe s
Allows you to configure a processes, operation, and data log properties. You can link processes to
items. You can specify specification, steps, and attributes for an operation. You can also assign
certification to an operation.
Dynamic Routing Usage
Allows you to configure a dy namic routing process.
Standard Operations
Allows you to configure a standard operation and dat a log properties. You can specify specification,
steps, and attributes for a standard operation. You can also assign certification to a standard
operation.
Attribute s
Allows you to specify the attributes for operations and processes.

Order Management Modules

Work Orders and Jobs
Allows you to configure a work order and job state. You can add files and URLs to a work order. You
can also configure steps and step groups for a job.
Queue (Job)
Allows you to view all jobs configured in MES in their desired order of execution, and to change that
ordering. You c an split jobs and view a flow diagram. You can also link different jobs so they start and
end together.
Attribute s
Allows you to specify the attributes for the work order and jobs. You c an also select its data and entry
type.

System Management Modules

Database Information
Allows you to maintain the MES database version det ails, historical table det ails, and database
server.
Database Maintenance
Maintains the MES dat abas e. Creates and executes archive, purge, and restore jobs.
Rejected Message (Viewer)
Allows you to view, edit, resubmit, and delete MES command messages that are rejected by the
middleware while using the Without Response communication mode.

Quality Management Modules

These modules require a Quality license for them to be enabled.
Sample Plan Frequency
Allows you to define sample plan frequencies, which are used to det ermine when the samples are
collected.

Version 6.1 31
MES Client User Guide Groups and Modules

Sample Plan
Specifies a group of sample plan frequencies that apply to one or more QM specifications.
Characteristic (Definition, for Variables and Attribute s)
Allows you to define characteristics, the paramet ers of a product or process that has to be measured.
Two types of characteristics include variables and attribut es.
Variables are measurements that can assume any value, limited by an upper and/or lower bound.
Attributes always occur in integer amounts.
QM Specification
Specifies a set of values that applies to characteristics with a defined context in which thes e values
are applicable.
Causes
Allows you to define cause groups and causes. This module allows you to define the values of a
sample.
Attribute s
Allows you to specify sample attributes that can be linked to a QM specification and result attributes
that can be linked to a QM characteristic.

32 Version 6.1
 MES Client User Guide

C HAPTER 3
General Parameters
In This Chapter
Introduction .................................................................................................................................. 33
System Parameters ...................................................................................................................... 33
Managing General Parameters ...................................................................................................... 36

Introduction
You can use the General Parameters module to modify the existing system parameter values of the
MES applications.
The General Parameters module is grouped under the Ma ster Data Config group in the Navigation
pane. For information on groups and modules, see Groups and Modules on page 29.

System Parameters
The system parameters contain the settings and actions that the MES applic ations can perform. For
more information on definition and explanation of the values for each parameter, see S ystem
Parameters Reference on page 341. The paramet ers are separated into the following groups:
Archi ve
In the Archive group, you can define the archive query window size (in hours ), archive root directory
path, and archive server host.
Data Editor
In the Data Editor group, you can define the system paramet ers for item production, item
consumption, labor usage, item lots, job steps, and entity utilization.
You can specify the following warnings and alerts for users:
o Whether you want the system to display a prompt message before deleting dat a in the dat a
editor.
o Whether a user should restrict the number of work orders that can be displayed in a list.
o Whether you want to use the previously saved edit or filter settings for entity usage, item
consumption editor filter settings, item production, job step data, and labor usage in the data
editor.
o The warning level for opening a specified number of records in the Item Lot, Entity Usage, Item
Cons, Item P rod, Job Step Data, and Labor Usage editors.
Data Entry
In the Data Entry group, you can define the system parameters for the data entries in the MES
database.
You can do the following:
o Specify when the database data should be archived.
o Specify a different consumption or production record whenever the data is changed.

Version 6.1 33
MES Client User Guide General Parameters

o Specify how frequently the MES Service should generate new samples and when to remove old
sample context data.
o Specify the work order that should be archived and when it should be arc hived.
o Specify the quantity provided by the us er to be verified whenever a new ent ry is added in the
MES Client application.
Di splay
In the Di splay group, you can define system paramet ers to display the MES applications.
You can do the following:
o Specify the colors for common errors, critical errors, informational messages, and warning
messages.
o Specify whether to display the details about customers, items, item classes, and users.
o Specify the default language for the MES Client application.
o Specify whether a user must filter the items.
o Specify colors used within the Sample Viewer cont rol for different sample states and result
states.
o Specify whether to display the file extension along wit h the file name.
o Specify whether to allow a user to restrict the number of storage entities that are displayed in a
list.
Dynamic Routing
In the Dynamic Routing group, you can do the following:
o Specify whether to combine rework from multiple work orders into a new common work order.
o Specify whether all the remaining jobs from the original work order must be copied to the end of
the new rework work order.
o Define a description for the rework jobs or work order.
o Specify whether the rework count should be differentiated based on the item reason, job
sequence number, operation ID, rework process, and work order ID.
o Specify whether the lot number for the rework work order should change.
A rework work order is created when rework for a job is identified.
Folders
In the Folders group, you can do the following:
o Specify whether changes to the date, time, and size of any of t he files in the folder should put the
folder on design hold.
o Specify whether all files or only download files be copied to the manufacturing directory when a
folder Copy Cont ents action is performed.

Note: Downloading folders to a physical entity is no longer supported, so this system parameter
no longer applies.

o Specify whether the system must log the file type or description changes.
o Specify the revision justification for the folder, so that they are ord ered properly.
General
In the General group, you can do the following:
o Specify whether to pass the time zone information to the middleware.
o Specify whether a user can report less than or more than the total amount of time he is pres ent.

34 Version 6.1
General Parameters MES Client User Guide

o Specify the entity access to inventory.

o Specify whether a user can delete a certification data, log data, physical entities, folders, items,
item classes, spec data, users, and work orders.
o Specify the general settings for the MES Client application. For example, job priority, labor rate,
email attachment root, log consumption and production count ers, and so on.
These are examples and not the complete list.
Operator
In the Operator group, you can do the following:
o Specify whet her a user can log on to an inactive entity from a different PC than the one originally
used.
o Specify whether a user can minimize the MES Operator window.
o Specify whether the job should start automatically when a user logs on to the MES application by
identifying the job rat her than the entity.
o Specify whether the subscribed data must be refreshed whenever the current labor information,
current OEE information, current job information, storage status or characteristics, or current
utilization information for an entity is modified.
o Specify whether the child entity inherits the current utilization reason from its parent entity.
o Specify whether and how utilization events can be merged.
o Specify the general settings for the MES Operator, such as file information display, tab
orientation, auto bypass a step, and so on.
Reports
In the Reports group, you can specify what is considered to be the start of the production day for
MES Intelligenc e Reports. The production day start can be specified as the 24 hours from t he start of
a shift, the end of a shift, or a particular time of day. For more information, see the MES Intelligence
Reports User Guide.
Security
In the Security group, you can do the following:
o Specify whether log on by default to selected entities.
o Specify whether you want a specific user to log in by default.
o Specify the security mode for a user and user group.
o Specify automatic log on for a OS user and us er group.
o Define the default privilege level for BOM substitutions.
o Define the default document download level, print level, and view level.
o Define the default reports view level and specification access level.
o Specify whether the user password should be unique or non-unique and specify the minimum
password length.
o Specify the number of days for which user’s password will be active.
o Specify the number of unsuccessful log on attempts for users before they are automatically
deactivated.
You cannot change the security settings for a user if a process is checked out.
Supervisor
In the Supervi sor group, you can do the following:
o Specify the number of days that you want to display of the supply chain connector information.

Version 6.1 35
MES Client User Guide General Parameters

o Specify whether jobs are instantiat ed from a process that end up with 0 quantity (usually
because there is nothing flowing into them from an upstream job).
o Specify whet her you want the system to prompt you for c heck -in the checked out process before
closing.
o Specify whether you want to view an entity tree in the Supervi sor’ s Queue dialog box.
o Specify the display for the file information.
You need to refresh the MES Supervisor application to reflect the changes done in the system
parameters.

Controlling How the System Parameters Are Listed

When you open the General Parameters module, the Current View menu appears on the ribbon.
The following commands are available:
By Category
Displays the System Parameter list by category in the Editor Window (for example, by DataE ditor).
Alphabetical List
Displays the System Parameter list in an alphabetical order in the Editor Window.
By default, the system parameters are displayed By Category.

Managing General Parameters

The workspace displays a list of all the existing system paramet ers.
You can modify the values of a system parameter in the workspace.
You cannot add or delete a system parameter.

Modifying a System Parameter

Each parameter has a different type of dat a entry field.
To modify system parameters
 Select a system parameter and modify the value.
To view the last modified system parameters
 Select the Status check box.
For the information on filtering the data, see Filtering Data in the Edit or Window on page 25.

36 Version 6.1
 MES Client User Guide

C HAPTER 4
User Groups and Users
In This Chapter
Introduction to User Groups and Users........................................................................................... 37
Security Modes ............................................................................................................................. 38
The FactAdmin User Group and Unassigned Users List .................................................................. 39
Creating the Initial MES User or OS Group with the Minimum Required Privileges ............................ 39
Setting Up User Groups and Users in Native Security Mode ............................................................ 40
Setting Up User Groups and Users in OS User Security Mode ......................................................... 41
Setting Up User Groups and Users in OS Group Security Mode ...................................................... 45
Importing ArchestrA Users into the MES Database ......................................................................... 49
Assigning Privileges to User Groups .............................................................................................. 49
Providing Entity Access to User Groups ......................................................................................... 51
Providing Line Access to User Groups ........................................................................................... 52
MES Web Portal User Aut hentication and Privileges ....................................................................... 52

Introduction to User Groups and Users

You use the User Groups and Users module to provide access to the MES system to users, and to
assign to the users their appropriate application privileges and entity access rights.
Application privileges and entity access are assigned through user groups. Every user is a member of at
least one user group or is in the Unassigned Users list. A user can be a member of multiple groups.
Users inherit the application privileges and entity access rights of the user groups to which they belong.
Application privileges and entity access rights are additive. This means that a user will have the
privileges available in all the groups and will have the maximum entity access rights of all the group s of
which they are a member.
When you open the User Groups and Users module, a list of all the existing user groups is shown in the
Editor window. A user group shows a list of all the us ers assigned to that group.

Version 6.1 37
MES Client User Guide User Groups and Users

The User Groups and Users module is grouped under the Ma ster Data Config group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.

When you open the User Groups and Users module, the Current View tab appears on the ribbon.

In the View group, the following commands are available:

Group Order
Shows a list of all the users by group. When you click Group Order, the group ID and description for
all the available groups is shown in the Editor window. Click the plus (+) symbol to expand and view
the list of users under a group.
User Order
Shows a list of all the users in the Editor window. When you click User Order, the status, user name,
description, language, and active status are shown in the Editor window. Click the plus (+ ) symbol to
expand and view the groups assigned to a user.
In the Privileges group, the following command is available:
Set default privileges
Selects all the privilege check boxes and sets access level for all access level entries.

Security Modes
There are three sec urity modes that determine the basis for MES application user logins. The mode is set
by the Security Mode system parameter in the Security group of the General Parameters module.
Native
The user groups and users are created in MES Client. This is the default security mode.

38 Version 6.1
User Groups and Users MES Client User Guide

OS User
The user groups are created in MES Client, and existing Windows Active Direc tory (AD) user
accounts are added to the native MES user groups.
OS Group
Existing Windows AD user groups are added to the MES database. This allows any existing
Windows AD us er accounts within eac h user group to have access to MES, according to the
privileges and entities assigned to the user group.
In OS Group security mode, a user logging into MES Client must be a member of a Windows user
group that has been added to the MES database. Otherwise, the following error message appears:
OS User group is not configured. For more information about logging in to MES Client, see Starting
MES Client on page 17.
For the most secure configuration, the security mode should be set to one of the Operating System (OS)
options. One of the OS options is also required for using the MES Web Portal. When deciding bet ween
OS User and OS Group, consider whether or not individual users need different default language
settings. When in OS Group mode, all users will have the default language set by the global system
parameter.

The FactAdmin User Group and Unassigned Users List

The following user group and user list are included by default. These apply when using Native and OS
User security modes.
FactAdmin
This group is intended for users who are MES administrators, such as users who will use MES Client
to set up the MES system. By default, this user group is assigned all application privileges.
Una ssigned Users
This list is intended for adding users who will be assigned to user groups that have not been created
yet or whose user group is undetermined. Users in this list have no application privileges and no
access to entities.
For example, if you want to begin adding users before creating user groups, you can do so by adding
them to this list.

Creating the Initial MES User or OS Group with the Minimum

Required Privileges
When the MES Client applic ation is opened for the first time, the login dialog box does not appear
because users are not yet defined in the MES dat abas e.
The first task you must perform after opening MES Client for t he first time is to create a user or OS Group
with the following Configurator security privileges enabled:
 May run configuration tools. If this privilege is not enabled, you will not be able to log in to MES
Client.
 May edit user settings. If this privilege is not enabled, you will be able to log in to MES Client but you
will not be able to create any other users or user groups. You will also not be able to assign entity
access to any users.
With these privileges enabled, the initial us er or a member of the OS us er group can subsequently log
into MES Client and other MES applications with configuration privileges.

Note: If the initial user or OS Group is added without the privileges May run configuration tools and May
edit user settings enabled, you will have to ask the database administrator to delete the user or OS
Group from the users table in the MES dat abas e. You can then open MES Client without being prompted
to log in and create a user or OS Group with these minimum required privileges.

Version 6.1 39
MES Client User Guide User Groups and Users

The procedure you use to creat e the initial MES user depends on the Security mode you plan to use for
MES application user logins. For more information on the available Security modes, see Security Modes
on page 38.
Creating the Initial MES User if Using Native or OS User Security
1. In the Security group of the General Parameters module, set the Security Mode system parameter
to Native (the default ) or OS Us er.
2. Depending on the Security mode selected, do one of the following:
 Create a native us er in a user group. See Setting Up User Groups and Users in Native Security
Mode on page 40.
 Add a Windows user account to a user group. See Setting Up User Groups and Users in OS
User Security Mode on page 41.
3. In the User Groups and Users module Editor window, select the user group to which you want to
assign the privileges.
4. On the Privileges tab, expand the Configurator privileges group.
5. Make sure the May run configuration tools and May edit user settings check boxes are selected to
enable them. For more information, see Assigning Privileges to User Groups on page 49.
Creating the Initial MES User Group if Using OS Group Security
1. In the Security group of the General Parameters module, set the Security Mode system parameter
to OS Group.
2. Add a Windows user group. See Setting Up User Groups and Users in OS User Security Mode on
page 41.
3. In the User Groups and Users Edit or window, select the user group t o which you want to assign the
privileges.
4. On the Privileges tab, expand the Configurator privileges group.
5. Make sure the May run configuration tools and May edit user settings check boxes are selected to
enable them. For more information, see Assigning Privileges to User Groups on page 49.

Setting Up User Groups and Users in Native Security Mode

In Native security mode, you create user groups and users in MES Client. Thes e users and user groups
are not Windows AD user accounts, but are specific to MES.
You can first create the user groups and then create users and assign them to groups. Or, you can create
the users and then create user groups and assign users to the group.
To create a user group in Native security mode
1. In the User Groups and Users module, do one of the following:
 On the ribbon, click New User Group in the New list.
 In the blank space below the Unassigned Users group entry, right-click and click New User
Group.
A new user group record appears in the workspace.
2. In the user group's Propertie s pane, complete the following settings:
Description
A unique name for the user group.
User ID
Lists all the users currently in the MES database. Select or clear the check box next to the user's
name to add or remove a user from the us er group.

40 Version 6.1
User Groups and Users MES Client User Guide

3. On the ribbon, click Save in the Main group to save the changes.
To create a user in Native security mode
1. In the User Groups and Users module, select a user group to which you want to assign the new
user.
2. Do one of the following:
 On the ribbon, click New User in the New list.
 Right -click the user group name and click New User.
The user is added to the user group.
3. In the user's Properties pane, complete the following settings:
User ID
A unique ID for the user; for example, the employee ID of the user. The user will use this ID to log in
to MES applications.
Description
A description of the user; for example, the user's full name.
Language
The language for the user. The default is English.
Acti ve
Specifies whether the user is active. It allows you to deactivate the user without deleting the user
from the dat abas e.
Department
The default labor department to which to assign the us er.
Category
The default labor category to which to assign the user.
Hourly Cost
The hourly cost to assign the user.
User_Name spare 1 to 4
Additional information about this user account.
NewPassword
A new password for the user.
RepeatPassword
The new password, entered again to confirm that is is entered correctly. If the new password and
repeat password values are not the same, you will be prompted to re-enter them.
Groups
Lists all the user groups currently in the MES database. Select one or more user groups to which to
assign the user. User group members hip determines a user’s access privileges in the MES system.
4. On the ribbon, click Save in the Main group to save the changes.
Assigning Privileges and Entity Access to User Groups
After setting up user groups, you can assign user privileges and entity access to them. See Assigning
Privileges to User Groups on page 49 and Providing Entity Access to User Groups on page 51.

Setting Up User Groups and Users in OS User Security Mode

In OS Us er security mode, you create native user groups in MES Client and add Windows AD us er
accounts to the user groups.

Version 6.1 41
MES Client User Guide User Groups and Users

You can first create the user groups and then add Windows users and assign them to groups. Or, you
can add the Windows users and then create user groups and assign users to the group.
To create a user group in OS User security mode
1. In the User Groups and Users module, do one of the following:
 On the ribbon, click New User Group in the New list.
 In the blank space below the Unassigned Users group entry, right-click and click New User
Group.
A new user group record appears in the workspace.
2. In the user group's Propertie s pane, complete the following settings:
Description
A unique name for the user group.
User ID
Lists all the Windows user accounts that have been added to the MES database. Select or clear the
check box next to the user's name to add or remove a user from the user group.
3. On the ribbon, click Save in the Main group to save the changes.
To add Windows users to a user group in OS User security mode
1. In the User Groups and Users module, select a user group to which you want to assign the new
user.
2. Do one of the following:
 On the ribbon, click New User in the New list.
 Right -click the user group name and click New User.
The Select Users dialog box appears. This is a Microsoft control and as such will not reflect the MES
language switching option.

3. Click the Locations button.

42 Version 6.1
User Groups and Users MES Client User Guide

The Locations dialog box appears.

4. Select the location (domain) of the users to be added and click OK.
The selected loc ation appears in the From thi s location box on the Select Users dialog box.
5. Do one of the following:
 If you know the names of the users to be added, enter them in the Enter the object name to
select box, separated by semicolons.
To verify that the users you entered are actually in the domain, click the Check Names button. If
more than one user name matches your entry, a Multiple Names Found dialog box appears.
You can select one or more names in this dialog box to add to the Enter the object name to
select box.
When you have finis hed entering us ers from the selected domain, go to step 9.
 To search for users, click the Advanced button.
The Select Users advanced dialog box appears.

Version 6.1 43
MES Client User Guide User Groups and Users

6. Use the Common Queries Name or De scription box to filter the searc h results for the users to
retrieve. Leave thes e boxes empty to return all us ers in the domain.
7. Click the Find Now button.
The available us ers appear in the Search results list box.

8. Select one or more users to add and click OK.

The dialog box closes. The selected users are added to the Enter the object names to select box.

9. To add users from another domain, select the new loc ation (domain), then enter the users from this
domain as you did before.
If you enter user names directly in the Enter the object names to select box, you must click the
Check Names button (whic h verifies the existing entries) to enable the Locations button.
10. When you have finis hed entering the users to add, click OK.

44 Version 6.1
User Groups and Users MES Client User Guide

The users appear in the User Groups and Users module under the selected user group.

11. Select each user and, in the Properties pane, complete the following settings:
Description
A description of the user. Defaults to the Windows full name of the user.
Language
The language for the user. The default is English.
Acti ve
Specifies whether the user is active. Clearing this option allows you to deactivate the us er without
deleting the user from the database.
Department
The default labor department to which to assign the us er.
Category
The default labor category to which to assign the user.
Hourly Cost
The hourly cost to assign the user.
User_Name spare 1 to 4
Additional information about this user account.
Groups
Lists all the user groups currently in the MES database. Select one or more user groups to which to
assign the user. User group members hip determines a user’s access privileges in the MES system.
12. On the ribbon, click Save in the Main group to save the changes.
Assigning Privileges and Entity Access to User Groups
After setting up user groups, you can assign user privileges and entity access to them. See Assigning
Privileges to User Groups on page 49 and Providing Entity Access to User Groups on page 51.

Setting Up User Groups and Users in OS Group Security

Mode
In OS Group security mode, you add Windows user groups to the MES database. This provides MES
application access to all Windows AD user accounts that are members of those user groups.
The management of which users are in the user groups is handled using Wi ndows user security tools,
not within MES Client.

Version 6.1 45
MES Client User Guide User Groups and Users

Windows users who are members of one of the added user groups are added to the MES database the
first time they log into an MES application.
Unlike MES Native or OS User user accounts, OS Groups cannot be assigned default labor
departments, default labor categories, hourly costs, or spare fields. However, OS Group users can select
labor departments and labor categories in any application that uses the MES .NE T Labor control, such
as MES Operat or.
To add a Windows user group and its users in OS Group security mode
1. In the User Groups and Users module, do one of the following:
 On the ribbon, click New User Group in the New list.
 In the blank space below the Unassigned Users group entry, right-click and click New User
Group.
The Select Groups dialog box appears. This is a Microsoft control and as such will not reflect the
MES language switching option.

2. Click the Locations button.

The Locations dialog box appears.

3. Select the location (domain) of the user groups to be added and click OK.
The selected loc ation appears in the From thi s location box on the Select Groups dialog box.
4. Do one of the following:
 If you know the names of the user groups to be added, enter them in the Enter the object name
to select box, separated by semicolons.
To verify that the us er groups you entered are actually in the domain, click the Check Names
button. If more than one user group matches your ent ry, a Multiple Names Found dialog box
appears. You can select one or more names in this dialog box to add to the Enter the object
name to select box.
When you have finis hed entering us er groups, go to step 8.

46 Version 6.1
User Groups and Users MES Client User Guide

 To search for user groups, click the Advanced button.

The Select Groups advanced dialog box appears.

5. Use the Common Queries Name or Description box to filter the search results for the user groups
to retrieve. Leave these boxes empty to return all user groups in the domain.
6. Click the Find Now button.

Version 6.1 47
MES Client User Guide User Groups and Users

The available us er groups appear in the Search results list box.

7. Select one or more user groups to add and click OK.

The dialog box closes. The selected user groups are added to the Enter the object names to
select list box.

8. To add user groups from another domain, select the new location (domain), then enter the user
groups from this domain as you did before.
If you enter user group names directly in the Enter the object names to select box, you must click
the Check Names button (which verifies the existing ent ries) to enable the Locations button.
9. When you have finis hed entering the user groups to add, click OK.

48 Version 6.1
User Groups and Users MES Client User Guide

The user groups appear in the User Groups and Users module.

10. On the ribbon, click Save in the Main group to save the changes.
Assigning Privileges and Entity Access to User Groups
After setting up user groups, you can assign user privileges and entity access to them. See Assigning
Privileges to User Groups on page 49 and Providing Entity Access to User Groups on page 51.

Importing ArchestrA Users into the MES Database

Although Entity Model Builder is not a comprehensive user/role synchronization tool, you can use it to
export ArchestrA users and roles into corresponding MES users and groups in the MES database. For
more information, see the MES Entity Model Builder User Guide.

Assigning Privileges to User Groups

Privileges define the actions that a user can p erform. Privileges are assigned at the user group level.
A user group must have the specific privileges to access the corresponding component in MES
applications such as MES Web Portal, MES Operator, MES Supervisor, and MES Data E ditor. There are
also general privileges that define privileges such as file, view, edit, and download levels.
Application privileges are additive. This means that a user will have the privileges available in all the
groups of which they are a member.
The Privileges tab in the User Groups and Users module shows a list of all the available privileges and
their associated values. For more information on user privileges, see User Privileges on page 361.
To assign privileges to a user group
1. In the User Groups and Users module Editor window, select the user group to which you want to
assign the privileges.
2. Click the Privileges tab.

3. To assign a privilege, do one of the following:

 Select the required check box to assign a privilege.
 On the ribbon, click Set default privileges in the Privileges group to select all the privilege
check boxes and set the access level for all access level ent ries.
4. On the ribbon, click Save in the Main group to save the changes.

Version 6.1 49
MES Client User Guide User Groups and Users

Assigned Privileges Example

Suppose you want to allow certain users to be able to create or modify work orders but have no other
privileges in MES Client.
A solution would be to create a user group that has only the privileges that are required for those tasks
and assign the users to that user group. Those privileges would be:
 Access to MES Client.
 Access to the Order Management group in the Navigation pane, which includes the Work Order
and Jobs module.
 The ability to create and modify work orders.
To create a user group that can only create or modify work orders
1. Create a new us er group and enter a descriptive name for the user group, such as "Order
Management," in its Description box (see Creating a User Group).
2. Select the new user group.

3. In the Privileges tab, do the following:

o To give the user group access to MES Client, in the Configuration section, select the May run
configuration tool s check box.

o To give the user group access to the Order Management group in the Navigation pane, in the
Supervisor section, select the May run supervi sor check box.

50 Version 6.1
User Groups and Users MES Client User Guide

o To allow the user group to create and modify work orders, in the Supervi sor section, select the
May create jobs check box.

4. On the ribbon, click Save in the Main group to save the changes.
Now, when a user who is only a member of this user group logs into MES Client, they will be able to
create and modify work orders in the Order Management group in the Navigation pane, shown below.
However, they will only have access to this feature.

Providing Entity Access to User Groups

An entity refers to a component within the system that a user logs into and manipulate its data. An entity
can be a building, a location within a building, a single machine, an assembly line, and so on.
You can det ermine the entities that the members of a user group can access in the MES applic ations,
specifically the Inventory window in MES Supervisor, the Queue module in MES Client, and the Entity
Login window in MES Operator application. You c an provide entity access only to a user group and not to
an individual user.

Version 6.1 51
MES Client User Guide User Groups and Users

Entity access rights are additive. This means that a user will have the maximum entity access rights of all
the groups of which they are a member.
The Entity Acce ss tab shows all the entities that are defined in the MES Client application. The entities
are displayed in a tree structure in the Editor window.
To provide entity access to a user group
1. Select the user group to which you want to provide entity access rights.
2. Click the Entity Acce ss tab.

3. Select the required check box to provide entity access to a user group.
If you have provided access to a parent entity, the user can access all the child entities under that
parent entity.
4. On the ribbon, click Save in the Main group to save the changes.

Providing Line Access to User Groups

The creation, configuration, and operation of lines is supported in MES Web Portal.
A line is an ordered set of entities that models a production line, manufacturing line, or assembly line.
You can det ermine the lines that the members of a user group can access in MES Web Portal. For
information about how t o assign user group access to lines, see the configuration t opics in the MES Web
Portal User Guide or help.

MES Web Portal User Authentication and Privileges

The following topics include conceptual and configuration information specific to MES Web Portal user
authentication and privileges for MES Web Portal functionality.

User Authentication
The default Security Mode for MES installations is Native mode. However, MES Web Portal requires the
use of your system’s Windows Active Directory (AD) user groups or us er accounts for logging in.
Therefore, to support MES Web Portal users, the Security Mode must be changed to either OS Group or
OS User. Also, AD user groups or users must be added to the MES database using MES Client,
depending on the security mode.

Using OS Group vs. OS User Security Mode

Refer to the following descriptions to help you determine which Security Mode—OS Group or OS
User—to use for MES Web Portal user authentication in your system environment:

52 Version 6.1
User Groups and Users MES Client User Guide

 In OS Group mode, the AD groups to which a user belongs are checked and the user’s AD user
account is checked to verify their authentication to log in to an MES Web Portal session. If the user
belongs to an AD group that has also been configured as an OS group in the MES database, then
the user is allowed to open a session. If an MES user account does not already exist for that user,
then one is automatically created. For information about adding AD user groups as OS groups in the
MES databas e, see Configuring an OS User Group.
 In OS User mode, the user’s AD user account is checked to verify their authentication to log in to an
MES Web Portal session. If the user’s AD user account has also been configured as an OS us er in
the MES dat abase, then the user is allowed to open a session. For information about adding AD user
accounts as OS users in the MES database, see Configuring an OS User.

Note: If you change the security mode, you have to restart the MES Web Portal service in Internet
Information Services (IIS).

MES Web Portal OS Group Security and Multiple Active Directory Domains
If your network is configured with multiple Windows AD domains, and you intend to use OS Group
security with MES Web Portal, you must select only Global and Univers al domain groups when
configuring MES groups. This is because MES Web Portal will not authenticate users in local groups if
the system is part of multiple domains.
As an example, say your network has multiple domains and you pick a local domain group to be an MES
group. You configure that group to have access to an entity, to run Operator, and to not allow editing of
entity settings. A user who belongs to that local domain group (and does not belong to any other groups
configured to be an MES group) would be able to log into the entity in MES Operator and perform
operations on that entity. However, the same user would not see the entity in MES Web Portal because
MES Web Portal will not authenticate the user from that domain local group.
You should only select local domain groups if you are sure that your network has only one domain.
Cons ult your net work administrator if you are unsure about whet her your network has multiple domains
or if you are unsure about whether a domain group is local, global, or universal.

Authentication Checks Performed When a User Logs In

The following conditions are checked when a user attempts to log in to MES Web Portal:
1. The user’s AD username and password are checked by the web browser.
2. The MES Security Mode must be either OS Group or OS User. If it is MES Native mode, the login will
fail.
3. The user’s AD user group or user account, depending on whether the MES Security Mode is set to
OS Group or OS User, must be mapped t o an MES user group or user account in the MES database.
One or more of the user’s AD user groups can be mapped to MES groups.
4. If OS User mode is being used, the user’s AD user account must map to an MES user account in the
MES databas e.
If OS Group mode is being used and the AD user group maps to at least one MES user group, an
MES user account for the user is automatically added to t he MES database.
5. The MES user account must be active. (MES Client includes an Inactive check box option to allow a
user account to be made inactive.)
6. The user has to be a member of at least one MES user group that has at least one privilege setting
assigned to it.
If no privileges are assigned to any of the MES user groups to which the user belongs, a message
indicating insufficient privileges to use the application appears. The only available tasks that the user
can perform are accessing the online help and logging out.

Version 6.1 53
MES Client User Guide User Groups and Users

If at least one privilege for one of the MES user groups to which the user belongs is set, then even if
that privilege is not related to MES Web Portal functionality, the user will be able to access the MES
Web Portal application. However, only the Work Orders tile will be shown in the home page and only
the Work Order option will appear in the navigation menu.
7. MES licensing is checked. If the appropriate licensing is not available, a licensing message appears
and the user will not have access to the application.
8. Once logged in, the user will see the MES Web Portal pages and functionality as defined by their
MES user groups’ privilege and access settings.

Privilege and Access Settings

MES Web Portal uses MES user groups to check for user privileges to perform tasks or view information
and to allow user access to lines and entities. Except for line access, which is set in MES Web Po rtal, all
MES user group privilege and access settings are set in MES Client.
 Privilege settings allow configuration and operation tasks to be performed, such as creating lines,
entities, utilization states, and utilization reason groups and reasons; assi gning work orders to lines;
and changing work order status. These tasks are controlled through the privileges assigned to MES
user groups.
 Access settings allow operation tasks to be performed on a line or entity. This includes viewing and
performing operation tasks related to work orders and jobs, entities, and utilization events. These
tasks are controlled by assigning line or entity access to MES user groups.
A user will inherit all privileges and access that are permitted inclusively in all MES user groups of which
they are a member. So, if a user is a member of more than one MES user group and any of those MES
user groups has a particular privilege (for example, May edit lines), the user will have that privilege even
if other user groups of which they are a member do not have that privilege.
The following table describes the privilege and access settings that are available.

Setting Setting Type Where Specified Allows Users to:

May edit lines Configuration MES Client, Create, configure, modify, and delete any
in the MES user lines, regardless of line access settings.
group’s Privileges
If this privilege is not assigned, the user will
tab, Configurator
see only those lines to which they have line
group.
access. And for those lines, the user will not
See Assigning see the line Configuration tab or subt abs.
Privileges to User
If this privilege is assigned but the user has
Groups on page
not been assigned access to a line, the user
49.
can configure the line but will not see the
line’s Work Orders or Entitie s tabs. So the
user will not be able to view the line or its
entities and work orders.

54 Version 6.1
User Groups and Users MES Client User Guide

Setting Setting Type Where Specified Allows Users to:

Line access Operation MES Web Portal, View lines, including their work orders and
in the line’s entities.
Configuration
Line access is assigned individually for
tab, Line Access
each line.
subtab.
If access to a particular line is not assigned,
See the topic
the user will be able to see work orders on
"Assigning Line
the Work Orders collection page, even if
Access to Users"
those work orders are assigned to that line.
in the MES Web
However, any links in MES Web Portal to
Portal User Guide
that line’s pages will be disabled.
or help.
If a user cannot edit lines and has not been
assigned access to any lines, they will not
see the Lines tile on the home page or the
Lines option in the navigation menu.

May edit entity Configuration MES Client, Create, configure, modify, and delete any
settings in the MES user entities, regardless of the user’s line access
group’s Privileges setting for the line to which an entity is
tab, Configurator assigned.
group.
If this privilege is not assigned, the user will
See Assigning see only those entities to which they have
Privileges to User been assigned access. And for those
Groups on page entities, the user will not see the entity
49. Configuration tab or subt abs.

Entity access Operation MES Client, The user will be able to see and perform
in the MES user operation tasks for only those entities that
group’s Entity have been assigned to the MES user
Acce ss t ab. groups of which the user is a member.
See Providing If a user cannot edit entities and has not
Entity Access to been assigned access to any entities, they
User Groups on will not see the Enti ties tile on the home
page 51. page or the Entities option in t he navigation
menu. On the line Enti ties page, they will
see the entity tiles and bottleneck
information, but the entity tiles will not
include operation-related icons.
One exception is that, even if the user does
not have access to an entity, if that entity
has the Can Store capability selected, the
user can select that entity in the To Storage
Location list in the Add Production and
Reduce Production dialog boxes.

Version 6.1 55
MES Client User Guide User Groups and Users

Setting Setting Type Where Specified Allows Users to:

May assign a work Operation MES Client, Assign a work order to any line, regardless
order to a line in the MES user of the user’s line access authorization.
group’s Privileges
If a user cannot assign work orders to a line,
tab, Supervisor
then they cannot create work orders,
group.
because the line assignment is required for
See Assigning a new work order. The user can edit an
Privileges to User existing work order, but regarding the line
Groups on page assignment, the user can only reassign the
49. work order to no line.

May change work Operation MES Client, Change the status of a work order,
order state in the MES user regardless of the us er’s line access
group’s Privileges authorization for the line to which the work
tab, Operator order is assigned.
group.
If a user cannot change the status of work
See Assigning orders, then they cannot create work
Privileges to User orders, because the status assignment is
Groups on page required for a new work order. The user can
49. edit an existing work order, but cannot
change its status.
May edit utilization Configuration MES Client, Create, configure, modify, and delete
states in the MES user utilization states. This privilege applies to
group’s Privileges MES Web Portal only.
tab, Configurator
group.
See Assigning
Privileges to User
Groups on page
49.
May edit utilization Configuration MES Client, Create, configure, modify, and delete
reasons and in the MES user utilization reason groups and reasons. This
groups group’s Privileges privilege applies to MES Web Portal only.
tab, Configurator
Typically, the two utilization edit
group.
authorizations are either both set or not set
See Assigning for a user group.
Privileges to User
If a user has neither of the two utilization
Groups on page
edit authorizations, they will not see the
49.
Utilization tile on the home page or the
Utilization option in the navigation menu.
However, if they have entity access, they
will be able to assign utilization reasons to
events for those entities.

Example Roles and Privilege Settings

The table below shows suggested privilege settings for the following example MES Web Portal user
roles:

56 Version 6.1
User Groups and Users MES Client User Guide

 An Application Engineer who is configuring the system but does not require access to operations
related to lines, work orders, entities, and entity events.
 An Operations Supervisor who needs requires access to all lines, work orders, and entities but no
access to configuration tasks.
 An Operator who requires access to specific lines and entities.

Application Operations
Setting Engineer Supervisor Operator

May edit lines Yes No No

Line access No Yes, to all lines Yes, but only to lines on which they will
perform tasks

May edit entity settings Yes No No

Entity access No Yes, to all entities Yes, but only to those entities on which
they will perform tasks

May assign a work No Yes Optional, depending on whether

order to a line operators for your site are allowed to
start work orders

May change work No Yes Optional, depending on whether

order state operators for your site are allowed to
change work order status

May edit utilization Yes No No

states

May edit utilization Yes No No

reasons and groups

Version 6.1 57
 MES Client User Guide

C HAPTER 5
Language Strings
In This Chapter
Introduction to Languages Strings .................................................................................................. 59
Creating a Language .................................................................................................................... 59
Editing a Language’s Strings ......................................................................................................... 60
Finding and Replacing a Language String ...................................................................................... 60
Viewing Language Details ............................................................................................................. 61

Introduction to Languages Strings

You can use the Languages module to define language strings in MES Client and display plant -specific
information. You can als o create language and dialect variations for the shop floor operators. You can
define unlimited number of languages, and the individual strings to customize the MES applications.

Note: The first 100,000 string IDs are res erved for MES internal use.

When you open the Languages module, a list of all the existing languages is shown in the Editor
window.
The Languages module is grouped under the Master Data Config group in the Navigation pane. For
information on groups and modules, see Groups and Modules on page 29.
The Languages module allows you to define and customize individual text strings in the language table.
The language table cont ains all the words and phrases that are utilized in the four core programs of the
system. Every user is assigned one language or dialect in the User Groups and Users module. For
more information on user groups and users, see User Groups and Users on page 37.

Creating a Language
You can create a new language in the MES Client application and delete an existing language.
You can also change the default language in the MES Client application. You cannot delete and edit
default languages. For more information on switching default languages, see S witching Languages at
Run Time on page 21.

Version 6.1 59
MES Client User Guide Language Strings

To create a new language

1. Do one of the following:
 Right -click in the workspace and click New.
 On the ribbon, click New Language in the New list.
A new language record appears in the Editor window. The language ID appears in the Language
box.
2. In the Language box, enter the name of the language.
3. Click Save.

Editing a Language’s Strings

1. In the Editor window, right -click the language whose strings you want to edit, and then click Edit.
The language’s string tab appears.

2. In the Current View tab, select a reference language in the Reference Language list.

The reference language allows you to choose which language to use as a reference when making
changes in the new language. The reference language string is the original word or phrase. Strings
for the reference language are shown in the Reference column in the tab and, for the selected string
record, in the Reference box in the Properties pane.
3. Select the language string that you want to edit.
4. In the Edit box in the Propertie s pane, type the new language string that corresponds to the
reference language string shown in the Reference box.
5. To save your language string edits, on the ribbon, click Save in the Main group.

Finding and Replacing a Language String

1. In the Current View tab, click Replace in the Edit group.

60 Version 6.1
Language Strings MES Client User Guide

The Replace dialog box appears.

The Current View tab appears on the ribbon when you edit a language.
2. In the Replace dialog box, complete the following settings:
Find what
Type the text that you want to search.
Replace
Type the text with which you want to replace the old text.
Match ca se
Specifies whether to enable a case-sensitive search.
3. Click Replace All. The text is replaced at all occurrences.
4. On the ribbon, click Save in the Main group to save the changes.

Viewing Language Details

1. Go to the Current View tab.
The Current View tab appears on the ribbon when you edit a language.
2. In the Categories group, do one of the following:
 Select the General check box to view the strings used in MES Client, MES Supervisor, and MES
.NET controls.
 Select the Compact check box for a compact view.
3. On the ribbon, click Save in the Main group to save the changes.

Version 6.1 61
 MES Client User Guide

C HAPTER 6
Physical Entities
In This Chapter
Introduction to Physical Entities ..................................................................................................... 63
Restrictions on Entities Assigned to Lines in MES Web Portal ......................................................... 65
Applying Filters ............................................................................................................................. 65
Creating a Physical Entity.............................................................................................................. 66
Entity Classes .............................................................................................................................. 66
Entity Properties ........................................................................................................................... 67
Assigning Attributes to an Entity..................................................................................................... 82
Parent Entities and Inheritance ...................................................................................................... 83

Introduction to Physical Entities

You can use the Physical Entities module to creat e and maintain entity definitions in the system. You can
also create entities from Entity Model Builder (EMB) in the Application Server for objects containing a
Utilization Capability Object (UCO), Operation Capability Object (OCO), or Sample Recording Object
(SRO).

Note: If you updat e MES Client, the changes are not reflected on the objects in the Application Serve r. A
re-synchronization of the server from EMB might overwrite changes made in MES Client. See the MES
Entity Model Builder User Guide for more information.

Version 6.1 63
MES Client User Guide Physical Entities

When you open the Physical Entitie s module, the entity tree pane on the left contains a tree diagram of
all defined entities. The Propertie s pane on the right displays detailed information, capabilities, and
capability parameters of specific entities. The Attribute s tab allows you to assign attributes to the
selected entity.

Physical entities are the components of the system that y ou log on to. An entity might be a building, a
location within a building, a production line, a single machine, a storage location or a bin. It can be
defined in a tree structure with child entities that inherit default values (like shift schedules) from t he
parent.
The entity tree allows you to define all the entities, along with any detailed information and
inter-relationships specific to those entities.
The entity tree can include t wo types of entity nodes:
 A standard entity node, indicated by a gear icon: .

 An entity class node, indicated by a folder icon: . For more information about the difference
between standard and entity class entities, see Entity Classes on page 66.
The root node Entitie s is neither an entity class or an entity. It serves as the starting point for the rest of
the entity tree.
When you select an entity node, the following options can be available:
Undo
Canc els any change that has been made in the right pane, unless they are already saved.
Paste
Inserts the cut or copied entity under the selected entity.

64 Version 6.1
Physical Entities MES Client User Guide

Clone
Creates an exact duplicate of the selected entity. To clone an entity, you need to select the entity
under which you want the cloned entity to be located. Select the entity that you want to clone,
right-click and then select Clone.
Insert
Adds a new entity under the checked entity.
The entity name must be unique as it identifies the entity in t he data records.
Delete
Delet es the selected entity.
Cut
Removes the link between the selected entity and its parent, and allows you to paste it in anot her
location on the entity tree. If you do not paste it, the link is restored.
Copy
Creates another reference to the selected entity, and allows you to paste this new reference int o
another location in the entity tree. Both the entity nodes access the same physical entity. If you do not
paste it, the copy is terminated.
The Propertie s pane includes several group of properties that can be accessed by expanding them. See
Entity Properties on page 67.
To modify an entity's properties, select the entity in the entity tree, make the required changes, and save
the changes.
By default, the Physical Entitie s module is grouped under the Master Data Config group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.

Restrictions on Entities Assigned to Lines in MES Web Portal

Entities can be assigned to lines in MES Web Portal. Not e the following MES Client restrictions for
entities that have been assigned to a line in MES Web Portal:
 You cannot delet e an entity that is assigned to a line.
 You cannot change entity capabilities that are required when they are assigned to a line (Can
Schedule Jobs, Can Run Jobs, Can Capture Utilization, Can Track OEE).
 You cannot remove the ent ries for the Default Production Rat e, Default Batch Size, or Default
Standard Item parameters.

Applying Filters
The Apply Filter function allows you to view a list of physical entities which match the filter options that
you enter.

To filter a physical entity

1. In the Navigation pane, click the Physical Entitie s module.
Version 6.1 65
MES Client User Guide Physical Entities

2. Select the required filter options from the Physical Entitie s Filter section.
Name
Name of the physical entity.
Description
Description of the physical entity.
Show Entity Classe s
Specifies whether entity classes to which other entities are grouped s hould be displayed. Select the
option to include entity classes and entities in the result set.
Parent Entities
Parent of the physical entity. Select the Entitie s option in this section.
Capabilities
Capability of an entity. You can select one or more capabilities.
3. Click Apply Filter. The list of physical entities matching the filter is shown.

Creating a Physical Entity

You can create a physical entity to maintain entity definitions in the system. You can also delet e a
physical entity from the database. To perform these tasks, you must have the privileges to edit physical
entity settings.
To create a physical entity
1. On the Ribbon, click New Physical Entity in the New list. A new physical entity displays in the
workspace.
2. In the Properties pane, complete the following settings:
Enti ty Name
A unique name for the physical entity.
Enti ty De scription
A description of the physical entity.
This item is an entity cla ss
Specifies whether to define the entity as an entity class. An entity class is indicated in the entity tree
by a folder icon: . For more information about using entity classes, see Entity Classes on page 66.
3. On the ribbon, click Save in the Main group to save the changes.

Entity Classes
Unlike entities that are created using MES Client, entities that are created using an ArchestrA IDE model
and Entity Model Builder have only one direct parent. If you would like to organize entities from an
ArchestrA IDE model into groups in the same way as parent entities can be used to group entities
created directly in MES Client, you can create entity classes. You can then copy the entities from
ArchestrA IDE model to entity class branches in the MES Client entity tree.
An entity class is an additional hierarchy for grouping like entities together even though they might reside
in different locations within the entity hierarc hy. For example, you might have multiple cartoners that you
want to group together within an entity class called "Cartoners." While the cartoners might exist in
different areas or work centers in the entity hierarchy, including them in the Cartoner entity class provides
an easy way to find them all. For more information about the uses for grouping entities by assigning them
to multiple parents, see Entities with Multiple Parents on page 84.

66 Version 6.1
Physical Entities MES Client User Guide

Entity classes that are created in MES Client are just like any other parent entities. They can be assigned
the same properties and can be parents and children of other entities. However, unlike standard parent
entities, entity classes are prot ected from being altered by Entity Model Builder. If an entity class has the
same name as an ArchestrA IDE model entity, Entity Model Builder is prevented from importing that
entity or otherwise changing the similarly-named entity class.

Entity Properties
The Entity Properties pane consists of several configuration groups, which are described in the
following topics.

Capabilities
The Capabilities configuration group defines the functions an entity can perform.

Can Schedule Jobs

Specifies whether the entity can schedule jobs.
Can Run Jobs
Specifies whether the entity can run jobs.
Can Capture Util
Specifies whether the entity can capture utilization dat a.
Can Capture Labor
Specifies whether the entity can capture labor dat a.
Can Track OEE
Specifies whether the entity can capture OEE statistics.
Can Schedule Shifts
Specifies whether the entity can schedule shifts.
Can Store
Specifies whether the entity can serve as a storage location.
Can Log Data
Specifies whether the entity can log dat a.
Can Ship
Select the check box if you want to enable the entity for shipment.
Can Receive
Select the check box if you can rec eive materials at this entity.

Version 6.1 67
MES Client User Guide Physical Entities

Can Copy Folders

Specifies whether, in MES Supervisor, the contents of an entity's folders can be copied to one of the
entity's download folders.

Note: Downloading files to physical entities is no longer supported. So the Can Copy Folders
capability no longer applies to the system.

Can Capture QM Data

Specifies whether the entity can capture QM data.

Schedule Jobs
When the Can Schedule Jobs capability is selected, the Schedule Jobs group becomes available in
the Properties pane.

Queue Time (Hours)

Additional time in hours allocated to the entity when scheduling, for tasks such as preparation work
or moving material.
Operation Type
A brief description of the type of operation performed at this entity.

Jobs
When the Can Run Jobs capability is selected, the Jobs group becomes available in the Properties
pane.
The Jobs configuration group allows the selected entity to run jobs, and is available in MES Operator's
Enti ty Logon window.

68 Version 6.1
Physical Entities MES Client User Guide

Identical Job Execs

The number of jobs that you can run simultaneously on an entity. The value of 0 or 1 indicates that
only one job is running at a time.
Allow only next job to be started
Specifies whether to start and complet e jobs in the sequence of the job queue.
Confirming Prompt

Note: This functionality has not yet been implemented.

Store output in
The default storage location for produced items.
Receive input from
The default storage location for consumed items.

Version 6.1 69
MES Client User Guide Physical Entities

Default production reason

The default production reason in the Production tab of the operator.
Default consumption reason
The default consumption reason in the BOM tab of the operator.
Default lot number
The default value for the lot that is used during production.
Default sublot number
The default value for the sublot that is used during production.
Automatically load job specification
Select the check box so that job specifications are automatically loaded when a job starts.
Start next sequence for current w/o and op
Specifies how the next operation in the current work order starts. You can do this manually using the
MES Operator. You can do it automatically if the created jobs have the s ame sequence numbers and
operation numbers.
Start next job
Specifies how the next job starts. In MES Operator, click the Start Job button in the Work Queue tab
to manually start the next job when a running job is completed. If you select As soon a s ready, the
next job that is ready in the entity’s queue starts automatically after a running job is completed.
End job
Specifies when the job ends. In MES Operat or, click the Stop Job button in the Work Queue tab to
manually change the job’s status when the job is completed. If you select When quantity done
meets required quantity, the job’s status is automatically set to Complete after the required quantity
is produc ed.
Show both item class and entity reasons
Specifies whether to show item class reasons and the entity reasons for the jobs.
Must all steps be completed/bypassed to end job
Specifies whether to ensure that all the steps are completed or bypassed before the job is marked
Complete.
Must required quantity be produced to end job
Specifies whether to ensure the required quantity that is produced before the job is marked
Complete.
Run without operator
Specifies whether an operator needs to remain logged on while a job is running. By default, no
operator needs to remain logged on while a job is running.
Suppress ‘S tart Some Quantity’ prompt
Specifies whether a dialog box should appear for entering quantities while performing a job. If this
option is selected, the dialog box does not appear, and by default the value of start quantity becomes
1. If the Allow zero quantity split option is selected, by default the value of start quantity becomes
0.
Allow zero quantity split
Specifies whether to allow the creation of a job wit h 0 quantity when you split it.
Auto-allocate quantity to running job
The overages in reported quantities that are to be covered by moving the job from a scheduled to a
running job. An error appears if there are no available overages in the scheduled job.
Job_Exec spare1, Job_Exec spare2, Job_Exec spare3, Job_Exec spare4
For additional information about the job.

70 Version 6.1
Physical Entities MES Client User Guide

Utilization
When the Can Capture Util capability is selected, the Utilization group becomes available in the
Properties pane.
The Utilization configuration group includes the utilization reason settings for the entity.

Allowable Reasons
Specifies the allowable reasons when you attempt to change the current utilization reason for an
entity. By default, all the reasons are available.
Utilization From I/O

If utilization reasons are being collected in the form of raw reason codes from external sources (like
PLC) through a Utilization Capability Object, then select this option.

Version 6.1 71
MES Client User Guide Physical Entities

With this option selected, you can define a default final reason to which the enti ty changes
automatically when that raw reason occurs. However, you can and typically should define other
utilization reasons to map to the raw reason code as options from which the operat or can select in
case that default reason is not applicable. This is especially true for downtime, for whic h the PLC
might not be able to identify everything that can go wrong, but the operator can. When you assign
multiple utilization reasons for a raw reason code, they will be listed as options in a selection dialog
box that appears for the operator when that raw reason occurs.
For each raw reason code, add one or more entries by doing the following:
a. Click the + button.
b. In the Reason Selection dialog box, select a utilization reason to whic h the raw reason code will
be mapped, and then click OK.
c. In the Raw Reason Code column, ent er the raw reas on code.
d. In the Prompt column, select the check box if you want the operat or to be prompted to manually
select a utilization reason from the list of allowable reasons when a new raw reason code
becomes active.
If there is no raw reason code coming from the PLC, then do not select the Utilization From I/O
option. When changing the entity's utilization reason, an operat or will be able to select from the
reasons that are defined using the Allowable Reasons button.
Target utilization%
Specifies the target utilization percentage identified for an entity.
Default reason when job starts
Specifies the default utilization reas on for the entity when a job starts.
Default reason when job ends
Specifies the default utilization reas on for the entity when a job ends.
Default reason when shift starts
Specifies the default utilization reas on for the entity when a shift starts.
Default reason when shift ends
Specifies the default utilization reas on for the entity when a shift ends.
Default unknown reason
Specifies the default reason when the entity utilization reason is unknown.
Util_Exec spare1, Util_Exec spare2, Util_Exec spare3, Util_Exec spare4
For additional information about the entity utilization.

72 Version 6.1
Physical Entities MES Client User Guide

Labor
When the Can Capture Labor capability is selected, the Labor group becomes available in the
Properties pane.

Department
The default labor department for a user working on this entity.
Labor Category
The default labor category for a user working on this entity.
Number of Simultaneous Operators (0 = unlimited)
The total number of users allowed to be active, at the same time, on this entity.
Labor_Exec spare 1 to 4
For additional information about labor for this entity.

OEE
When the Can Track OEE capability is selected, the OEE group bec omes available in the Properties
pane.
The OEE (Overall Equipment Efficiency) configuration group allows you to establish targets that are to
be achieved during production, and compare the actual results with the targets.

Production Data from

Specifies an entity that contains production data for calculating the overall equipment efficiency. If
you select an entity, you will receive the production data for OEE calculation from that entity.

Version 6.1 73
MES Client User Guide Physical Entities

Utilization Data from

Specifies an entity that contains utilization data for calculating the overall equipment efficiency. If you
select an entity, you will receive the utilization data for OEE calculation from that entity.
The OEE items are as follows:

OEE Item s Target% Actual %

OEE Specifies the target OEE Specifies the actual OEE

percentage identified for an percentage for a selected
entity. entity.

Performance Specifies the target Specifies the actual

performance percent age performance percent age for a
identified for an entity. selected entity.

Quality Specifies the target quality Specifies the actual quality

percentage identified for an percentage for a selected
entity. entity.

Default Production Rate

Specifies the default production rate for the entity.
The estimated production rate must be greater than 0. An ent ry of 0 will cause an error.

Understanding Batches and Lots for OEE and Estimated Times

It is important to understand the difference between batches and lots so that your OEE results are within
expected ranges.
 A lot is generally used to uniquely identify a group of consumed or produced items for tracking
purposes.
 A batch is an amount of product that is processed simultaneously. A batch is used to determine the
standard production time for a given amount of product. Standard production times are expressed
either in time per batch, or batches per time.
For example, assume that you want to track all of the cookies that are baked during a shift as a group,
and that you want to det ermine the cookie production’s OEE. A unique lot number can be assigned to the
group of cookies produced during the shift. But the lot size has nothing to do with the OEE calculation.
That calculation would be based on the batch size and the batch production rate. If a batch size is 100
cookies and it takes 20 minutes to bak e a batch of cookies, then up to 24 batches of cookies could be
baked during an 8-hour shift, or a maximum of 2,400 cookies in a lot.
Also, note that the amount of production might not be an integral number of batches. This is because the
standard production time for a batch will be constant, regardless of whether the batch actually includes
the maximum number of items for the batch. For example, if the oven capacity, and thus a batch, is 100
cookies, it takes as long to bake 90 cookies as it does to bake 100. The performance component of OEE
factors in t his nonlinear behavior. So, for OEE to be reported accurately, it is important that t he batch size
be set according to the way production actually occurs.
The other usage of batch size is with estimated job start and end times. When creating a work order with
a required finish time, the batch size and production rate is used to determine t he start and end times for
each operation in the process to determine the required start time of the initial job. Incorrect batch size
and production rates can create unattainable start times and even overflow date/time calculations in the
database.

74 Version 6.1
Physical Entities MES Client User Guide

Storage
When the Can Store capability is selected, the Storage group becomes available in the Properties
pane.
The Storage configuration group defines the capabilities of the storage entity.

Type
Specifies the type of entity.
Delete inventory when quantity reaches 0
Specifies whether the inventory record in the database is deleted when the remaining quantity of an
item reaches zero.
Allow negative quantities
Specifies whether the storage entity can store negative quantity for an item in an entity.
The Allow negative quantities paramet er will not have an effect if the Storage parameter Multiple
lots/items stored here become indistinguishable has also been selected and there are still items
available in other lots. This is because subtracting an item from a lot will never allow the quantity to
fall below zero if there are enough items in other lots to meet the quantity used. Instead, the item
quantity will be removed proportionately from the other lots. (That is, the system prorates the
subtraction of quantities across all of the lots, so the quantities in a given lot will not become negative
unless there are no items remaining in any other lot.)
Allow multiple items
Specifies whether the storage entity stores different items at the same time.
Allow multiple lots
Specifies whether the storage entity stores different lots for an item at the same time.
Moveable
Specifies whether you can relocate an entity. If you select this option, the Location field is enabled.

Version 6.1 75
MES Client User Guide Physical Entities

Location
Identifies where a movable entity is currently located. You can modify this field when the Moveable
option is selected.
Scannable ID
This field can be used primarily with movable storage entities that may be barcoded (e.g., a pallet). It
provides an alternative way to uniquely identify a storage entity, such as a pallet.

Note: Currently the base product does not contain any interface to barcode scanners, so there is no
internal use for this field.

Allow a dirty state

Specifies whether you can select the current status of a storage entity as Dirty. You cannot use this
entity for storage until you change its status to available.
Multiple lots/items stored here become indistingui shable
Specifies an item cannot be distinguished from other items when you select it.
The Multiple lots/items stored here become indistinguishable parameter can be used with the
General system parameter Minimum traceable invent ory amount in the following way: If the Multiple
lots/items stored here become indistinguishable parameter is selected and the Minimum traceable
inventory amount parameter has a value entered, then once the quantity for a lot drops below that
value, the balance of the item quantity for that lot (that is, the quantity set as the minimum traceable
inventory ) will be distributed across the other lots, and the quantity for that lot will be set to 0.
Status
Specifies the current status of the storage entity, whether it is available, used or dirty.
Maximum Capacity
Specifies the maximum quantity of an item that can be stored in an entity.
Storage_Exec spare1, Storage_Exec spare2, Storage_Exec spare3, Storage_Exec spare4
For additional information about the entity storage.

Class Membership
The Cla ss Membership configuration group displays the list of entity classes associated with the entity
being configured.

The entity classes are the parents of the selected entity. For more information about entity classes, see
Entity Classes on page 66.

Files
You can add files and web pages to an entity to support the operator using that entity during production.
For example, a file or web page can contain information relative to setting up, operating, or maintaining
the entity. When a user is recording the execution of jobs on the entity using an application such as MES
Operator, the files and web pages will be available to them for viewing.
See Adding Files and Web Pages to an Entity on page 77.

76 Version 6.1
Physical Entities MES Client User Guide

Adding Files and Web Pages to an Entity

To add files to the entity
1. In the Files property group, click the Configure Files button.

The Files dialog box appears.

2. Right -click in the dialog box, and then click Add files.
The Open dialog box appears.
3. In the file type list, select All files.
4. Navigate to and select the files to be added, and then click Open.
The selected files are listed in the Files dialog box.

5. Optionally, add a description for each file in the De scription column.

6. Add other files (or web pages) as needed.
7. When you are finished adding files, click Close.

Version 6.1 77
MES Client User Guide Physical Entities

The files are listed in the Files property group.

8. Save the changes.

To add a web page to the entity
1. In the Files property group, click the Configure Files button.

The Files dialog box appears.

2. Right -click in the dialog box, and then click Add URL.
The Add URL dialog box appears.

78 Version 6.1
Physical Entities MES Client User Guide

3. Enter the URL for and a description of the web page.

Instead of manually entering the URL, you can click the Browse button at the right of the URL box
and use the mini-browser window that appears to navigate to the web page.

Click OK and that web page's URL is entered on the Add URL dialog box.
4. When you have finis hed entering the URL and description, click Close.
The URL is listed in the Files dialog box.

5. Add other web pages (or files) as needed.

6. When you are finished adding web pages, click Close.
The web page URLs are listed in the Files property group.

7. Save the changes.

To remove a file or URL
1. In the Files property group, click Configure Files.
The Files dialog box appears.
2. Right -click the file or URL, and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.

Version 6.1 79
MES Client User Guide Physical Entities

Directories
You can add directories to an entity to support Folders functionality. Using the Folders function in MES
Supervisor, you can copy the contents of a folder to an entity directory. You can then use a custom
application to allow users to access the copied files. This allows users to edit the local files in the entity
directories without affecting the master source files that are kept in Folders.
See Adding Directories to an Entity on page 80.

Adding Directories to an Entity

To add a directory to an entity
1. Open the Directories group.

2. Click the + button.

The Browse for Folder dialog box appears.

3. Navigate to and select the folder to be added, and then click OK.
The folder is added to the list in the Directorie s group.

4. Save the changes.

If there are multiple directories in the list, you can change their order by dragging and dropping them.
To remove a directory
1. Select the directory.
2. Click the – button.

80 Version 6.1
Physical Entities MES Client User Guide

You are prompted to confirm the deletion.

3. Click Yes.
4. Save the changes.

Miscellaneous
The Mi scellaneous configuration group contains additional options.

Allowable Item Reason Groups

Specifies the allowable item reason groups for the entity. This allows you to restrict the reasons that
can be applied to item production or consumption for jobs running on this entity. See Assigning Item
Reas on Groups to an Entity on page 81.
Default Parent Entity
Specifies the preferred parent of the entity, relative to inheriting a parent’s associations. See Entities
with Multiple Parents on page 84.
Hourly Cost
Specifies the cost to run the entity for an hour.

Assigning Item Reason Groups to an Entity

To restrict the reasons that can be applied to item production or consumption for jobs running on the
entity, you can specify the allowable item reason groups for the entity.
If no allowable item reason groups are specified, then all item reasons will be available when producing
or consuming items while running jobs on the entity.
To assign reason groups to the entity
1. In the Mi scellaneous group, click Allowable Item Reason Groups.

Version 6.1 81
MES Client User Guide Physical Entities

The Rea sons Groups dialog box appears.

2. Select the item reason groups, and then click OK.

3. Save the changes.

Assigning Attributes to an Entity

An attribute is an additional user-defined property. You can assign attributes to an entity that allows
operators to provide additional information about the entity.
Physical entity attributes must first be created using the Attribute s module. See Attributes on page 107.
To assign attributes to an entity
1. In the Editor window, select the entity.
2. Click in the Attribute s tab.
3. Do one of the following:
 On the Current View ribbon, click Add.
 Right -click in the Attribute s tab, and then click Add.

82 Version 6.1
Physical Entities MES Client User Guide

The Add attribute s dialog box appears. Entity attributes that have not been assigned to the entity
are listed.

4. Select the attributes to assign to the entity, and then click OK.
The attributes are added to the Attribute s tab.

5. For each attribut e, enter a value specific to this entity and optionally add a note.
6. Save the changes.
To remove an attribute from the entity
1. Right -click the attribute and click Delete.
You are prompted to confirm the deletion.
2. Click Yes.

Parent Entities and Inheritance

The entity tree structure in the Physical Entitie s module allows you to create a hierarchical model of the
entities in your organization that represents the actual relationships of entities in your plant.
In addition to allowing you to model the structure and locations of the entities in your plant, the
parent–child relationship between entities also provides an inheritanc e of certain associations of the
parent entity to its child entities. This allows you to control aspects of your entities more easily by simply
changing the association at the parent level—which changes will be inherited by its child
entities—instead of having to make the changes individually for each child entity. It can also allow jobs
that are queued to a parent entity to be run on any of its available child entities.

Associations Inherited from a Parent Entity

An entity can inherit the following associations from a parent entity:
 Shift schedule, if the entity does not have the Can Schedule Shifts capability.
 Jobs queued to run on the parent

Version 6.1 83
MES Client User Guide Physical Entities

 If a specification has been assigned to a parent entity, and the same operation is assigned to the
parent and child but with 0% flow to the parent (and so no job is created for the parent), the child
entity will inherit the specifications of the parent operation
 If a QM specification has been assigned to a parent entity, any child entity that has the Can Capt ure
QM Data capability will inherit the QM specification.
 Serial numbers, if the entity is producing serialized items

Entities with Multiple Parents

In the entity tree, entities can have multiple parents under the following conditions:
 The entity’s tree branch includes ancestors; that is, the child’s immediate parent and any other
parent entities higher up in the same branch of the hierarchy.
 The entity has been copied to one or more parents in addition to the parent under which it was
originally created.
Copying an entity to another parent is different than cloning the entity. Copying the entity does not create
a new entity. It is the method used to assign an additional parent to the entity to either better model the
plant entity structure, to make it easier to identify similar entities, or so that the new parent’s associations
can be inherit ed. Cloning an entity creates a completely new entity with the same properties as the
source entity.
The ability to copy entities to other parent entities allows entities to be grouped by common attributes for
operational purposes. For example, say you have a machine shop with a number of lat hes that are
located in three distinct areas of a shop floor. To model the physical layout in the MES Client entity tree,
an entity is created for each shop floor area and the lathe entities are created under the shop floor area
entity in which they are located. However, you also want to group lathes by length, throw, or horsepower
so that jobs that require a certain value for one of these attributes can be run on any of the lathes that
meet that requirement, regardless of its location. In this case, you would create parent entities for each
classification of attributes that is required and then copy the lathe entities to the parent entities whose
requirements they meet.
Note that entity classes or standard entities can be used to provide this grouping functionality.

Resolving Inheritance for Entities with Multiple Parents

If an entity has more than one parent, certain inheritance co nflicts are resolved as follows:
 The preferred parent is specified by the entity’s Default Parent Entity setting in the Mi scellaneous
configuration group. The system will look at this parent first when determining the entity’s inherited
associations.
 For shift schedules, only the preferred parent or the preferred parent’s preferred ancestors can be
the source for the child entity’s shift schedule. Therefore, if neither the entity nor any of its preferred
ancestors have their own shift schedule, then the entity does not get a shift schedule, even if a
non-preferred ancestor has one.
 For operation specifications, if the preferred parent does not have a specification of the same name,
the system goes up through the preferred parent’s ancestors and uses the first specification that it
finds with the same name.
 If an entity has the capability Can Capture QM Data and there is no QM specific ation assigned or if
the assigned one is not active, the next higher ancestor entity in the hierarchy (which has an active
QM specification) is used to generate the samples for the entity.

84 Version 6.1
 MES Client User Guide

C HAPTER 7
Sites
In This Chapter
Introduction to Sites ...................................................................................................................... 85
Creating a Site.............................................................................................................................. 85

Introduction to Sites
You can use the Sites module to specify location of an entity as per the time zone. An entity can belong
to one site and all the child entities of that entity also belongs to the same site.
The site information is used while saving information about an event that happened on an entity. The
system stores the GMT dat e and local date for the entity.
When a shift starts on an entity using the MES Client application, system records the start time of the shift
in UTC and local time, but the background process is not in the same time zone as the entity. The loc al
start time that should be recorded for the shift should be the local time of the entity, not the background
processes local time. The Site s module provides the time zone information of the entity and this
information is used to record the correct local time for the entity into the database.
When you open the Sites module, a list of all the existing sites is shown in the Edi tor window.
By default, the Sites module is grouped under the Ma ster Data Config group in the Navigation pane.
For more information on groups and modules, see Groups and Modules on page 29.

Creating a Site
You can assign a site specification to an entity. Children entities inherit the parent entity sites.
To create a site
1. On the ribbon, click New Site in the New list. A new site record is shown in the Editor window.
2. In the Properties pane, enter the following settings:
Enti ty Name
Click the Brow se button. The Enti ty Window dialog box appears. Select the entity for which you
want to create the site from the entity tree.

Version 6.1 85
MES Client User Guide Sites

Site Name
A unique name for the site. This is an optional field.
Region
The time zone to which this entity belongs.
Enti ty De scription
A brief description of the selected e ntity.
3. On the ribbon, click Save in the Main group to save the changes.

86 Version 6.1
 MES Client User Guide

C HAPTER 8
Shifts and Shift Schedules
In This Chapter
Introduction to Shifts and Shift Schedules ....................................................................................... 87
Filtering the Entities in the Navigation Tree ..................................................................................... 88
Creating a Shift ............................................................................................................................. 89
Creating an Entity Shift Schedule................................................................................................... 89
Creating a Shift Schedule for an Entity That Cannot Schedule Shifts ................................................ 90
When Shift Changes Are Applied ................................................................................................... 91

Introduction to Shifts and Shift Schedules

You can use the Shift and Shift Schedule module to define shift names, shift timings, and shift breaks
for an entity on the plant floor. You can define unlimited shifts to customize work schedule of your
organization. The shifts are used to schedule work and can include regular and overtime shifts.
When you open the Shift and Shift Schedule module, the following are displayed in the Editor window:
 List of all the existing shifts
 List of entities that can have shift schedules defined for them
 Shift schedule for the selected entity
You can define only one shift schedule for an entity. Shift schedules are inherited by child entities. You
should define shifts on top in the entity hierarchy so that you need to change only in the parent entity to
update the children entities.
By default, the Shift and Shift Schedule module is grouped under the Master Data Config group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.
The workspace shows information about the status, ID, and shift description of all the existing shifts. For
example, day, morning, aft ernoon, and night. A shift shows the schedule for an entity on the plant floor.
You can define shifts for entities on the plant floor in the shift editor section. Then, you can set up the
schedules for the entities using the shift schedule editor section.

Version 6.1 87
MES Client User Guide Shifts and Shift Schedules

You must create entities before creating shift schedules. See Creating a Physical Entity on page 66.

When you open the Shift and Shift Schedule module, the Current View tab appears on the ribbon.
In the Current View tab, the following commands are available:
Toggle View
Allows you to flip the rows and columns bet ween days of the week and times the Shift Schedule
Editor section.

Zoom
Allows you to zoom in or zoom out in the shift schedule editor.
Add Schedule
Allows you to assign a shift schedule to an entity.

Filtering the Entities in the Navigation Tree

The tree on the Navigation pane initially shows all the entities that can have their own shift schedule,
along with the other entities that are necessary to allow you to navigate to them. The entity selected in the
tree is the one whose schedule is displayed in the grid.
You can use the Filter feature to filter the entities that are listed in the tree.
To filter the list of entities in the navigation tree
1. In the Filter box on the Navigation pane, type the criteria by which to filter the entities.

88 Version 6.1
Shifts and Shift Schedules MES Client User Guide

2. Click Apply Filters. Only the entities whose names match the filter criteria are displayed.

Creating a Shift
You can create shifts for the entities to organize work at the plant floor. For example, a conveyor line can
be scheduled to work in two shifts a day, the day shift and the night shift.
By default, three shifts are defined, Day, Afternoon, and Night.
To create a shift
1. On the ribbon, click New Shift in the New list. A new shift record is shown in the Editor window.
2. In the Properties pane, complete the following settings:
Description
A name for the shift.
ID
A unique ID for the shift. The shift ID identifies the shift in the data records, so must be unique and is
not editable after the shift definition is first saved.

Note: If you delet e a shift and then you create a new shift with the same s hift ID as that of the deleted
shift, the MES application shows data of the deleted shift and the deleted shift schedule appears in
the Shifts module.

3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing shift in the Propertie s pane.

Creating an Entity Shift Schedule

The Entity Shift Schedule shows the time duration when an entity is available. You can also assign a shift
schedule to an entity.
The workspace shows the shifts and break periods that are defined for an entity.
You can toggle the day and time view in the current schedule.

The workspace shows an hourly grid and labels on the left to represent the day of the week. Each shift
and break period appears as a block within the appropriat e weekday extending from the start time to the
end time.
To create an entity shift schedule
1. In the Navigation pane, select the entity. For more information on filtering entities, see Filtering the
Entities in the Navigation Tree on page 88.
2. In the Shift Schedule Editor, specify a shift by doing one of the following:

Version 6.1 89
MES Client User Guide Shifts and Shift Schedules

 Right -click the cell for the day and time of the start of the shift and select a predefined shift name.
The shift duration defaults to 8 hours. To modify the shift period, click and drag the handles at
either end of the shi ft block.
 To directly specify the shift period, click and drag to highlight the shift's time period within the
day, right-click the highlighted area, and select a shift name.
 Cut and paste one of the existing shifts in the grid.
You cannot create an entity shift schedule that exceeds 24 hours.
3. In the Properties pane, complete the following settings, as needed:
Shift Name
The name of the shift.
Start Time and End Time
The start time and end time for the shift.
Start day of Week
The start day for the shift.
Break 1, 2, 3
The start time and end time for a break in the shift. The times entered must be within the Start Time
and End Time values for the shift. A shift can have up to three breaks specified.
4. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing shift schedule in the Propertie s pane.

Creating a Shift Schedule for an Entity That Cannot Schedule

Shifts
An entity that does not have the Can Schedule Shifts capability will inherit its shift schedule from its
parent entity. However, you can assign this capability to such an entity and create a shift schedule for it
from the Shift and Shift Schedule module.
1. Click Add Schedule in the Entity Tool s group. The Add Scheduling capabilities to Entity dialog
box appears.

90 Version 6.1
Shifts and Shift Schedules MES Client User Guide

2. Select the entity for which you want to create a shift schedule.
Only entities that do not have the Can Schedule Shifts capability will cause the OK button to be
available when they are selected.
3. Click OK.
The entity is added to the Shift and Shift Schedule entity tree and is assigned the Can Schedule
Shifts capability.
4. Select the entity in the entity tree and add shifts to its shift schedule.
5. On the ribbon, click Save in the Main group to save the changes.

When Shift Changes Are Applied

If you change a shift that is currently active, the changes are not applied immediately if any of the
following dat a has been recorded for the affected entities during the current shift:
 Labor usage
 Log 16 or log 48 data
 Item consumption
 Item production
Instead, the shift changes will be applied at the next instance of that shift.
For more information on shift changes, see the MES Service User Guide.

Version 6.1 91
 MES Client User Guide

C HAPTER 9
Utilization States
In This Chapter
Introduction to Utilization States ..................................................................................................... 93
Creating a Utilization State ............................................................................................................ 94

Introduction to Utilization States

You can use the Utilization States module to define possible utilization states of an entity on the plant
floor. You can assign a utilization state to a reason in the Utilization Reason Groups and Reasons
module. For more information on reas ons and reason groups, see Utilization Reasons and Reason
Groups on page 95.
When you open the Utilization States module, it shows a list of all the existing utilization states in the
Editor window.
By default, the Utilization States module is grouped under the Ma ster Data Config group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.
The workspace shows information about the state color and a descript ion of all the existing utilization
states.
A utilization state shows the status of an entity. For ex ample, Running, Idle, or Down. You can define any
number of utilization states for an entity.

Utilization states can also be configured in MES Web Portal, which supports other configuration settings
in addition to those described here. When using MES Client to configure utilization states, the additional
configuration settings are set to NULL when creating a utilization state and are left unmodified when
updating a utilization state. For more information about configuring utilization states in MES W eb Portal,
see the MES Web Portal User Guide or help.

Version 6.1 93
MES Client User Guide Utilization States

System paramet ers that control the behavior of utilization functions are configured in MES Client. See
the "Operator" section of the table in System Parameters Reference on page 341.

Creating a Utilization State

You can define a utilization state for entities. For example, you can define states such as Downtime and
Running.
To create a utilization state
1. On the ribbon, click New Utilization State in the New list. A new utilization state record is shown in
the Editor window.
2. In the Properties pane, complete the following settings:
Description
The name of the utilization state.
State Color
The color used to indicate the utilization state.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing utilization state in the Propertie s pane.

94 Version 6.1
 MES Client User Guide

C HAPTER 10
Utilization Reasons and Reason Groups
In This Chapter
Introduction to Utilization Reasons and Reason Groups .................................................................. 95
Creating a Utilization Reason Group .............................................................................................. 96
Creating a Utilization Sub-Reas on Group ....................................................................................... 96
Creating a Utilization Reason ........................................................................................................ 96
Moving and Copying a Utilization Reas on to Another Group ............................................................ 97

Introduction to Utilization Reasons and Reason Groups

You can use the Utilization module to define a utilization reason for a state and associate a state to the
reason. Utilization reasons and utilization states are used to monitor and report activities of each entity.
Utilization reasons describe the current condition of an entity and associate eac h reason with a utilization
state. A reason group is a category of reasons. For ex ample, the reason "Bottle Jam" can belong to the
reason group "Bottle Descrambler Down", and results in a "Downtime" utilization state. On the production
floor, a reason can be set by the Utilization Capability Object (UCO) from a PLC or I/O, set by code
through an API call, or set by a user through MES Operat or, MES Web Portal, or a .NE T control.
The reasons are grouped by reason groups. You must create a new utilization reason group before
creating a utilization reason.
By default, the Utilization module is grouped under the Ma ster Data Config group in the Navigation
pane. For more information on groups and modules, see Groups and Modules on page 29.
When you open the Utilization module, a list of the reas on groups is shown in the Editor window.

The order of the reason groups in the reason tree, and the order of the reasons within each group, is
used in the MES Operator application when a user selects a utilization reason.

Version 6.1 95
MES Client User Guide Utilization Reasons and Reason Groups

Utilization reason groups and reasons can also be configured in MES Web Portal, which supports other
configuration settings in addition to those described here. When using MES Client to configure utilization
reason groups and reasons, the additional configuration settings are set to NULL when creating a reason
group or reason and are left unmodified when updating a utilization reason group or reason. For more
information about configuring and using utilization reason groups and reasons in MES Web Portal, see
the MES Web Portal User Guide or help.
System paramet ers that control the behavior of utilization functions are configured in MES Client. See
the "Operator" section of the table in System Parameters Reference on page 341.

Creating a Utilization Reason Group

A utilization reason group contains reasons wit h similar attributes.
To create a utilization reason group
1. On the ribbon, click New Reason Group in the New list. A new reason group rec ord is shown in the
Editor window.
2. In the Properties pane, type the name of the reas on group in the De scription box.
The reason group name describes the grouping of utilization reasons and identifies the utilization
reason group in the dat a records, so it must be unique.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of a utilization reas on group in the Propertie s pane.
You can also create utilization sub-reason group within a reason group. For more information on creating
utilization sub-reason groups, see Creating a Utilization Sub-Reason Group on page 96.

Creating a Utilization Sub-Reason Group

You can create up to 10 sub-levels of a utilization reason group. For example, you can have a utilization
reason group with nine ancestor groups. You can define reasons for a reason group at any level. For
more information on creating utilization reason group, see Creating a Utilization Reas on Group on page
96.
1. On the ribbon, click New Sub Reason Group in the New list. A new sub reason group record is
shown in the Editor window.
2. In the Properties pane, type the name of the sub reason group, in the De scription box.
3. On the ribbon, click Save in the Main group to save the changes.

Creating a Utilization Reason

You can assign multiple reasons to a utilization state.
To create a utilization reason
1. In the Editor window, select the reason group under which you want to create a utilization reas on.
2. On the ribbon, click New Reason in the New list. A new reason record is shown in the Editor
window.
3. In the Properties pane, complete the property settings. See Utilization Reas on Properties on page
97.
4. On the ribbon, click Save in the Main group to save the changes.

96 Version 6.1
Utilization Reasons and Reason Groups MES Client User Guide

Utilization Reason Properties

Description
The name of the utilization reas on. The reason description describes the utilization condition of an
entity and identifies the utilization reason in the data records, so it must be unique within its reason
group.
Utilization State
Select an existing utilization state or click Browse button to create a new utilization state. The
utilization state indicates the state that is appropriate for this utilization reason. For more information
on creating a new utilization state, see Creating a Utilization State on page 94.
Include: Teardown Time
If selected, specifies that an event with this utilization reason counts toward teardown time.
Include: Setup Time
If selected, specifies that an event with this utilization reason counts toward setup time.
Include: Failure
If selected, specifies that any time that the entity spends in the utilization reason is considered failure
time. Failure time is used in the calculation of Mean Time Between Failures (MTBF) and Mean Time
to Repair (MTTR).
OEE Time: Runtime
If selected, specifies that an event with this utilization reason counts toward runtime. Runtime events
contribut e to the calculation of A vailability and Performance.
OEE Time: Downtime
If selected, specifies that an event with this utilization reason counts toward downtime. Downtime
events contribut e to the calculation of A vailability.
OEE Time: Neither
If selected, specifies that an event with this utilization reason does not count toward runtime or
downtime. Therefore, this utilization reason time is excluded from the calculation of OEE.
Production Time: Fixed
If selected, specifies that an event with this utilization reason is costed as fixed time.
Production Time: Variable
If selected, specifies that an event with this utilization reason is costed as variable time.
Production Time: Neither
If selected, specifies that an event with this utilization reason is not costed as fixed time or variable
time.

Moving and Copying a Utilization Reason to Another Group

You can move an existing utilization reason from one group to another group, copy a reason to multiple
reason groups, and change the order of reasons in a group.
To move an existing utilization reason to another group
 Do one of the following:
 Cut the utilization reason and paste it on the destination utilization reason group.
 Drag the utilization reas on to the destination reason group to make it the first reason in the
group, or to the reas on in the group that should precede it.
To copy an existing utilization reason to another group
 Copy the utilization reason and paste it on the destination utilization reason group.

Version 6.1 97
MES Client User Guide Utilization Reasons and Reason Groups

To change the order of a utilization reason within a group

 Drag the utilization reas on to the reason in the group that should precede it.

98 Version 6.1
 MES Client User Guide

C HAPTER 11
Categories
In This Chapter
Introduction to Categories ............................................................................................................. 99
Category Module Layout ............................................................................................................... 99
Creating a Category .................................................................................................................... 100
Linking Items to an It em Cat egory ................................................................................................ 100
Linking Caus e Groups to Characteristics ...................................................................................... 101
Deleting Category Links .............................................................................................................. 102
Deleting Categories .................................................................................................................... 103

Introduction to Categories
You can use the Categories module to configure categories. Categories are used with QM
specifications and causes.
There are two types of categories:
Item Categories
Link items to a category so that different items can share the same QM specification. If an item
category has been selected in a QM specification, then at run time samples will be collected for an
entity that is producing an item in that item category.
Characteristics and Cause Group Categories
Link cause groups with characteristics. The cause groups that are linked to a characteristic will be
the cause groups and causes that are presented to an SPC chart user when they select an SPC
chart point to assign a cause for that characteristic’s samples.
For information about selecting an item category in a QM specification, see Creating a QM Specification
on page 329.
For information about assigning a cause to a sample characteristic in the SP C chart control, see the topic
"Working with the Characteristics Tab" in the Sample Recording Object User Guide or help.

Category Module Layout

By default, the Categories module is grouped under the Ma ster Data Config group in the Navigation
pane. For more information on groups and modules, see Groups and Modules on page 29.

Version 6.1 99
MES Client User Guide Categories

When you open the Categories module, the t op grid lists all of the categories in the workspace. The tabs
in the bottom grid list the items, cause groups, and characteristics for the category that is currently
selected.

Creating a Category
You can create a category to group items or to link cause groups to characteristics.
You must have the privileges to edit categories.
To create a category
1. On the ribbon, click New Category in the New list. A new category displays in the workspace.
2. In the Properties pane, complete the following settings:
Category Name
A unique name for the category.
Category De scription
A brief description for the category.
Category Spare1–Spare4
User-defined information about the category.
3. On the ribbon, click Save in the Main group to save the changes.
An error message appears if the category cannot be created. Modify the category, as needed, to correct
the error.

Linking Items to an Item Category

An item is a material that is produced or consumed in MES. An item can belong to multiple categories.
It is recommended that you use a given category to only link items or to only link cause groups to
characteristics.
To link items to a category
1. In the workspace, select the category to which you want to assign the items.
2. In the lower grid, click the Items tab.

100 Version 6.1

Categories MES Client User Guide

3. On the ribbon, click Add Link in the Items group. The Select Item dialog box appears.

4. Select an item you want to assign to the category and click OK.
5. Continue adding the other items that are to be included in the item category.
6. On the ribbon, click Save in the Main group to save the changes.

Linking Cause Groups to Characteristics

Caus es can be assigned to characteristic samples. Relat ed causes are organized into cause groups.
When a cause group is linked to a characteristic by linking both of them to the same category, an SPC
chart user will be able to select from that group’s causes when assigning a cause to a sample of that
characteristic.
You can link one or more cause groups to one or more characteristics using one category. Also, a cause
group or characteristic can be included in multiple categories.
It is recommended that you use a given category to only link items or to only link cause groups to
characteristics.
To link cause groups to characteristics
1. In the workspace, select the category to which you want to assign a cause group.
2. In the lower grid, click the Cause Groups tab.

Version 6.1 101

MES Client User Guide Categories

3. On the ribbon, click Add Link in the Cause Groups group. The Add Cause Group dialog box
appears.

4. Select the cause groups you want to link to characteristics and click OK.
5. In the lower grid, click the Characteristics tab.
6. On the ribbon, click Add Link in the Characteristics group. The Add Characteristic Links dialog
box appears.

7. Use the filter criteria to list the set of characteristics from which you want to choose.
8. Select the characteristics to which you want to link the cause groups and click OK.
9. On the ribbon, click Save in the Main group to save the changes.

Deleting Category Links

Item, cause group, or characteristic links in a category can be delet ed.

102 Version 6.1

Categories MES Client User Guide

To delete category links

1. In the workspace, select the category whose links you want to delete.
2. In the lower grid, click the tab on which the links are located.
3. Select the links to be deleted.
4. On the ribbon, click Delete Link in the link type group. A confirmation dialog box appears.
5. To continue with the deletion, click Yes.

Deleting Categories
To delete a category
1. In the workspace, select the category that you want to delete.
2. Select the links to be deleted.
3. On the ribbon, click Delete in the Home group. A confirmation dialog box appears.
4. To continue with the deletion, click Yes.

Version 6.1 103

 MES Client User Guide

C HAPTER 12
Job and Step States
In This Chapter
Introduction to Job and Step States.............................................................................................. 105
A vailable Job and Step States ..................................................................................................... 105
Modifying a Job or Step State ...................................................................................................... 106

Introduction to Job and Step States

A job represents an operation being performed on an entity, and a step represents a phase of a job. For
more information about jobs and steps, refer to Work Orders and Jobs on page 237.
Job and step states indicate the status of jobs and steps that are being performed at an entity. For
example, a job that has been started is in the Running state, and a step that is waiting to be started is in
the Ready state.
The available job and step states are predefined in the system and a re identified by a unique code.
These predefined states cannot be deleted, and new states cannot be added. However, you can modify
the names of the states and their associated color.
You can view and modify the states in the Jobs and Step States module. This module is grouped under
the Master Data Config group in the Navigation pane. For more information on groups and modules,
see Groups and Modules on page 29.
When you open the Job and Step States module, a list of the job and step states is shown in the Editor
window.

Available Job and Step States

There are four states available to both jobs and steps.

Version 6.1 105

MES Client User Guide Job and Step States

New
A job in the New state indicates that the job is scheduled to be run but is not yet ready to start for one
of the following reasons:
o Upstream jobs need to be complet ed first.
o For the first job of a work order that is assigned to a line, the work order is still in the New state.
Depending on the us er’s privileges, this state might restrict a user from starting the job in MES
Operator.
A step in the New state indicates that the step is preceded in the job step sequence by a step that is
in the Ready or Running state.
Ready
The job or step is capable of being started. This indicates that the requirements for running this job or
step have been met. For example, this can indicate that a upstream job has met the pieces produced
requirement to start this job, or t hat this is the first job of a work order and all consumable BOM (Bill of
Material) components are available.
Running
The job or step is currently running.
Complete
The job or step has finished running. For example, for a job this can indicate that required quantity t o
be produced has been met, that all steps have been complet ed, and that all required data has been
entered.
There are three states available only to jobs.
Suspended
The job is paused temporarily. For example, a user at a shift change can suspend a job so that the
next shift user can log in and continue running the job.
Onhold
The job is paused indefinitely. For example, this can indicate that there are material or machine
issues.
Canceled
The job was started but then stopped before completion. For example, this can indicate that a
customer canceled a work order for a job that had already been scheduled and started running.
There are two states available only to steps, to record the atypical execution of job steps.
Bypa ssed
The step within a job was skipped, allowing the next step to run. For example, if a setup step is not
needed on a particular machine, it can be bypassed and the next step can be started.
Superseded
The step within a job was reopened to run again. For example, this can indicate that the produced
item needed to be reworked. This would allow the dat a from the original attempt to be retained and
not over-written by the new production data.

Modifying a Job or Step State

1. Open the Job and Step States module.
2. Select the state.
3. In the Properties pane, change the name or color associated with the state.
4. Save your changes.

106 Version 6.1

 MES Client User Guide

C HAPTER 13
Attributes
In This Chapter
Introduction to Attributes ............................................................................................................. 107
Understanding Attribute Data Types ............................................................................................. 108
Creating an Attribute ................................................................................................................... 109
Assigning (Linking) Attributes ...................................................................................................... 110
Understanding Lot Attributes ....................................................................................................... 111

Introduction to Attributes
You can use the Attribute s module to create and maintain attributes for reporting or conveying
information to the plant floor.
You can create attributes for the following:
 Items
 Item Classes
 Physical Entities
 Lots
 Jobs
 Work Order
 Operation
 Process
 Sublots
 Sample
 Result
 Shifts
Attributes for all objects can be displayed at one time, or displayed by logical application groupings
provided on the ribbon or within specific Navigation groups.
You can access the Attribute s module from the following groups in the navigation pane:
 Master Data Config
 Product Definition
 Operations Management
 Order Management
 Quality Management

Version 6.1 107

MES Client User Guide Attributes

By default, the Attribute s module is grouped under the Master Data Config group in the Navigation
pane. For more information on groups and modules, see Groups and Modules on page 29.

You can access the Attribute s module from within the Master Data Config group or from the Product,
Operations, Order, or Quality Management groups.
You can view all the attribut es available in the MES Client ribbon or select specifi c attribute sets:
 Item: Items and Item Classes
 Operations: Operations and Processes
 Work Order: Jobs and Work Orders
 Quality: Sample and Result
The following groups are available on the Current View tab on the ribbon:
 All Attributes: Show attribut es assigned to all the groups.
 Item Attributes: Show all the attributes assigned to Items and Item classes.
 Process Attributes: Show all the attributes assigned to Operation and Process items.
 Work Order Attributes: Show all the attributes assigned to Jobs and Wo rk Orders.
 Quality Attributes: Show all the attribut es assigned to Sample and Result.

Understanding Attribute Data Types

The attribut e definitions are grouped by modules according to the type of object with which the attributes
may be used. The modules include the Item s, Item Classe s, Physical Enti ties, Lots, Jobs, Work
Orders, Operations, Processe s, QM Specifications, and Characteri stics.
Attribute definitions contain the following details:
Attribute s
Specifies a name or description of the attribute. An attribute must be unique within its group because
it identifies the attribute in the data records.
Data Type
Specifies the type of data that is associated with the attribute. The description of data types is as
follows:

108 Version 6.1

Attributes MES Client User Guide

o Currency: A monetary value.

o Date: A date and time value.
o Drop Down: The value is selected from a drop-down list. The possible values are defined in the
adjoining field. The Possible Values pane lists the text entries that are available as value
choices for an attribute of drop-down type. The values in the list can be reordered by dragging
and dropping a value to a new sequence position in the list.
o Floating Point: A decimal value.
o Integer: A whole, numeric value.
o Item Reason: An item reason is only available for Lot Attributes. For more information on lot
attributes, see Understanding Lot Attributes on page 111. The Limit to reasons in group box
indicates which reas ons for the item reason group are available as value choices. If you do not
enter a value, no limitations are placed on the item reasons available as value choices.
o Text: A user-defined string.

Entry Type
Specifies whether the user defines a value for the attribute.
o Value only: Contains the value assigned to the attribute for this item class. This field is
inaccessible if the attribute is defined as a Notes Only type.
o Note s only: Contains user-defined information about the attribute for this item class. This field is
inaccessible if the attribute was defined as a Value Only type.
o Value/Notes: Contains the value assigned to the attribute or the user-defined information about
the attribute for this item class.

In Queue Grid
Select this check box to display the attribute as a column in the queue. This option is available only
for item, job, and work order attributes.
In Inventory Grid
Select this check box to display the attribute as a column in the inventory. This option is available
only for item and lot attributes.

Creating an Attribute
The workspace shows the status and the description of existing attribut es.
To create an attribute
1. In the Navigation pane, open the Attribute s module from the respective group.
2. In the Editor window, select the attribute type that you want to create.
3. On the ribbon, click New Attribute in the New list. A new attribute record is shown in the Editor
window.
4. In the Properties pane, complete the following settings:
Attribute s
The name of the attribute.
DataType
The data type for the attribute.

Version 6.1 109

MES Client User Guide Attributes

Entry Type
Edit information and select the applicable configuration options for the data type selected. For more
information on data type, see Understanding Attribute Data Types on page 108.
5. On the ribbon, click Save in the Main group to save the changes.

Assigning (Linking) Attributes

Assigning, or linking, an attribute allows you to assign values or notes to the following groups:
 Items. See Assigning Attributes to an Item on page 136.
 Item classes. See Assigning Attributes to an Item Class on page 140.
 Entities. See Assigning Attributes to an Entity on page 82. Entities can also be assigned attributes in
MES Web Portal and using the Core.EntAttr class methods in the MES Stateless API.
 Lots. Lots can be assigned attributes from client applications using MES .NE T cont rols, such as MES
Operator.
 Jobs. See Assigning Attributes to a Job on page 273.
 Work order. See Assigning Attributes to a Work Order on page 249.
 Operation. See Assigning Attributes to a Standard Operation on page 227 and Assigning Attributes
to an Operation on page 210.
 Process. See Assigning an Attribute to a Process on page 179.
 Sublots. Sublots can be assigned attributes using the Prod.SubLotAttr class methods in the MES
Stateless API.
 Samples. See Link ing an Attribute to a QM Specification on page 335.
 Results. See Link ing an Attribute to a Characteristic on page 326.
 Shift. Shifts can be assigned attributes using the Core.ShiftAttr class methods in the MES Stateless
API.
Cert ain linked attributes are then available based on the definition of the attribut e in the In Queue (item,
job, and work order attributes) or In Inventory grids (item and lot attributes).

110 Version 6.1

Attributes MES Client User Guide

Understanding Lot Attributes

Lot attributes are used to implement multiple hold reasons for an item lot. During production, the
produced items, organized by lot number, are assigned to an item grade and state through the use of an
item reason. This grade and state information is used to determine if that lot meets the defined minimal
shipping requirements. At the same time, attributes may be added to the production lot. An attribute of
type Item Reason allows the assignment of another grade and state to the same lot. Both grade and
state combinations are considered before shipment of an item from which production lot is permitted. If
used as a Hold Reason, whenever the Hold situation is corrected, the lot attribute can be changed or
removed by a user of the Supervis or module (in the In Invent ory grid), thereby allowing the grade and
state originally assigned to the lot to take precedence.

For example, a lot can be produced with the item reas on of Good Production, which is linked to an item
grade of Approved and an item state of Finished Goods. Both of these values have a preference of 1.
The lot attribute Hold Reason can be assigned to the lot and given the value of Hold for Customer, which
is linked to an item grade of Hold -Good and an item state of Finis hed Goods. The Hold for Customer
state has a preference of 10. If the minimal shipping grade of this item is defined as 2, the lot attribute
prevents this lot of the item from being shipped. When the customer is ready for the shipment, the lot
attribute can be removed and the item grade of Approved becomes relevant.

Version 6.1 111

 MES Client User Guide

C HAPTER 14
File Extensions
In This Chapter
Introduction to File Extensions ..................................................................................................... 113
Adding a File Extension............................................................................................................... 114

Introduction to File Extensions

MES facilitates the distribution of online document ation to the shop floor. The system also supports
URLs for web-based documentation. For example, files and web pages can include instructions about
how to prepare an entity for running a job, checklists when performing preventive m aintenance, or details
about how to execute an operation or step.
The system supports any file type that can be associated with a program on the client’s Windows
machine to view, edit, or print files of that type.
Components That Can Be Assigned Files and Web Pages
Files and web pages can be assigned to:
 Entities (see Adding Files and Web Pages to an Entity on page 77)
 Folders (see Directories on page 80 and the Folders chapter of the MES Supervisor User Guide)
 Items (see Adding Files and Web Pages to an Item on page 125)
 Operations (see Adding a File or Web Page to an Operation on page 181)
 Operation steps (see Adding Files and Web Pages to an Operation Step on page 197)
 Work orders (see Adding Files and Web Pages to a Work Order on page 246)
 Jobs (see Adding a File or Web Page to a Job on page 251)
 Job steps (see Adding Files and Web Pages to a Job Step on page 264)
 Job specifications (see Adding a File or Web Page to a Job Specification on page 272)
 Entity, BOM, and item specifications that are being added to a operation (See Adding a File or Web
Page to a Specification Being Added to an Operation on page 209)
How to Open Files and Web Pages That Are Assigned to a Component
Files and web pages that are assigned to the following components can be opened in MES Operator:
 Entities
 Entity folders
 Items
 Job steps
To open files and web pages for the remaining components, and also for those whose files and web
pages that can be opened in MES Operator, you can use the following MES Stateful API Documents
class methods in a custom application:

Version 6.1 113

MES Client User Guide File Extensions

 EditFile()
 PrintFile()
 ViewFile()
Adding File Extensions
For a file to be viewed, edited, or printed from within MES, its file extension must be added to the system.
This can be done in the following ways:
 By manually adding the file extension in the File Extensions module.
 When assigning a file to an MES component, if the file extension has not already been defined, it is
automatically added. The extension is determined by the characters that follow the last period in the
file name or URL. The file extension can then be viewed and its properties edited in the File
Extensions module. By default, the file extension's Edit and View Levels are set to 1, and all other
properties are blank.
When a user selects a file to view, edit, or print, the default Windows application that is associated with
that file type will launch and perform the corresponding operation with the file. URLs will be opened in the
default Windows web browser.
When adding a file extension, you can manage which users have permission to view or edit files of that
file type. This is implement ed using the File edit level and File view level user privileges parameters.
The File Extensions module is grouped under the Ma ster Data Config group in the Navigation pane.
For more information on groups and modules, see Groups and Modules on page 29.
When you open the File Extensions module, a list of all the existing file extension entries is shown in the
Editor window.

Adding a File Extension

1. From the Ma ster Data Config group in the Navigation pane, open the File Extensions module.
2. Do one of the following:
 In the tab, right-click and click New.
 Press Ctrl+N.
 On the Home ribbon group, click New and then click New File Extension.
A new file extension record appears.
114 Version 6.1
File Extensions MES Client User Guide

3. In the Properties pane, complete the property settings.

Extension
The file extension, including the leading period. For example, .doc would be ent ered for a Word
document. The extension entry is not editable after the file extension definition is first saved.
Description
A description of the file type related to this file extension.
Edit Level
Defines the minimum File edit level value required for a user to edit a file of this type. The user’s user
group privilege, assigned in MES Client in the Users Privileges:General group, must be set to this
value or higher.
View Level
Defines the minimum File view level value required for a user to view a file of this type. The user’s
user group privilege, assigned in MES Client in the Users Privileges:General group, must be set to
this value or higher.
Edit, View, and Print Arguments
The arguments to be passed to the default application for the file extension.
4. Save your changes.
To delete a file extension
1. Right -click the file extension, and then click Delete.
You are prompted to confirm the deletion.
2. Click Yes.

Version 6.1 115

 MES Client User Guide

C HAPTER 15
Items
In This Chapter
Introduction to Items ................................................................................................................... 117
Applying Filters ........................................................................................................................... 118
Creating an It em ......................................................................................................................... 119
Assigning Certifications to an It em ............................................................................................... 122
Adding Files and Web Pages to an Item ....................................................................................... 125
Creating a BOM for an Item ......................................................................................................... 128
Specifying BOM Components ...................................................................................................... 131
Creating an It em Substitute ......................................................................................................... 133
Viewing the Proc esses Linked to an Item ..................................................................................... 135
Viewing the Relationship Diagram ................................................................................................ 135
Assigning a Storage Entity for an Item .......................................................................................... 136
Assigning Attributes to an Item .................................................................................................... 136

Introduction to Items
You can use the Item s module to create and maintain an item.
By default, the Items module is grouped under the Product Definition group in the Navigation pane.
For more information on groups and modules, see Groups and Modules on page 29.

Version 6.1 117

MES Client User Guide Items

Items are the basic units produced or consumed during production. Items can be referred to as a part,
component, piece, and so on in different manufacturing environments.

You must define all products, components, and by -products as items for use in the MES system.

Applying Filters
The Filter option in the Navigation pane lists all the available items.
Changing width of a column in the workspace does not save the configuration of filter and column width.
The configuration is saved if you do one of the following: change a columns position, add or remove a
column, apply grouping to the grid, or change the sort order. For more information, see Customizing the
Columns Shown in the Tabbed Work space on page 23 and Sorting Information on page 24.
To filter an item
1. In the Navigation pane, click the Items module.
Text filters will search for any string that contains the supplied characters.
2. Select the required filter option:
Item section
o Item ID: Unique ID of the item
o Item Description: Name or brief description of the item

Item Class Filters section

o Item Class ID: Unique ID of the item class
o Description: Name or brief description of the item class

118 Version 6.1

Items MES Client User Guide

3. Click Apply Filter. The list of items and item classes matching the filter is shown.
You can also filter within the result grid on any additional columns.

Arranging Columns
You can arrange the items information. The field chooser option limits and organizes the display of data
fields from all qualifying rec ords. Field chooser allows you to choose what information about each item is
shown in the Items module.
To change the selection of fields to be displayed
1. Click the Field Chooser icon at the top of the Editor window. The Available Fields dialog box
appears.

2. Select or clear a check box to display or hide the columns.

Selected fields show the dat a fields from each record that are currently displayed in the Editor window.

Creating an Item
You can create an item and assign it to an item class. You can also move an item from one class to
another and define certifications for an item.
You can associate a file with an item. These files are available to the users of the MES Operator
application on the Folders tab. You can also assign a certification to an item.
To create a new item
1. On the ribbon, click New Item in the New list. A new item record appears in the Editor window.
2. In the Properties pane, complete the settings as described in Item Properties on page 119.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing item in the Properties pane.

Item Properties
General Properties
Item ID
A unique ID or name for the item. The item ID identifies the item in the MES data records, so it must
be unique and is not editable aft er the item definition is first saved.
Item Class ID
The item class ID to which you want to assign the item.

Version 6.1 119

MES Client User Guide Items

You can also create a new item class. For more information on creating a new item class, see
Creating an Item Class on page 137.
Item Description
A brief description or a name for the item.
Units
The unit of measure (UOM) for the item. UOMs are defined in the Units of Measure module. For
more information on creating a new UOM, see Creating a Unit of Measure on page 141.
Num Decimals
The number of decimals allowed when entering quantity of an item.
BOM
Use the BOM tab to create a BOM for the item. See Creating a BOM for an Item on page 128.
Substitutes
Use the Substitutes tab to create substitutes for the item. See Creating an Item Substitute on page 133.
Processes Linked to Item
Use the Proce sse s Linked to an Item tab to view the processes that can produce t he item. See Viewing
the Processes Link ed to an Item on page 135.
States and Grades
Minimum Shippable State
The minimum state of the item, which allows the item to be shipped. For more information on item
states, see Item States on page 147.
Minimum Shippable Grade
The grade for the item. For more information on item grade, see Item Grades on page 145.
Inventory Handling
Lifetime
The lifetime of item in number of days. This value is used when receiving shipments in the Inventory
window in the MES Supervisor application. For more information on inventory, see MES Supervis or
User Guide.
Serial Number Level
A serial level for the item. This indicates that the item is serialized. Select Lot Number if you want the
serial number to be the sam e as lot number.
Lot Number Format
A default string for generating lot numbers.
Sub Lot Number Format
A default string for generating sub-lot numbers.
Inventory i s unique by job
Specifies whether the inventory assigned to a job can be used only with that job. The Inventory is
Unique by Job check box is disabled if the inventory is not licensed.
User Defined
Item spare 1 to Item spare 4
User-defined information about the item.
You can modify the Spare field name in the Languages module by editing its language string. For
more information on language strings, see Editing a Language’s Strings on page 60.

120 Version 6.1

Items MES Client User Guide

Advanced
Unit Cost
The unit cost of the item. Unit cost defines the cost of one unit of the item.
Template
o Actual: The item is a specific item.
o Template: The item can be us ed as a template or pattern for creating other item.

Obsolete
Specifies whether the item is obsolete. This indicates that this item cannot be used in any job or
process.
Must Complete All Steps
Specifies whether the item must complete all the required steps to complete the job during
production. This indicates that all steps defined in production proc ess of the item must be completed
and should marked as Complete in the MES Operator application. This is for produced items only.
Must Produce Reqd Qty
Specifies whether the required quantity must be produced to complete the job during production.
This indicates that the quantity produced must be equal to or greater than the required quantity for a
job producing this item to be marked Complete in the MES Operator application. The Quantity
deviation above start quantity system parameter in MES Client application must be greater then 0%
for this to take effect. This is for produced items only. For more information on general system
parameters, see the "General" section of the table in System Parameters Reference on page 341.
Notes
Additional information or not es about the item.
Automatic Reordering
Min. Inventory Level
The minimum invent ory level for the item. Minimum inventory level defines the smallest amount of
the item that should be in inventory or currently scheduled to be made through a work order. This is
for produced items only.
Min. Reorder Amount
The minimum amount of the item that can be reordered. Minimum reorder amount defines the
smallest amount of the item that should be made or reordered. This is for produced items only.
Automatically Reorder
Select this check box to have MES Client application create a work order or purchase order for the
specified Min. Reorder Amount whenever the inventory quantity falls below the Min. Inventory Level.
If an existing work order is there for this item but its quantity is below the Min. Reorder Amount, the
new work order amount is the difference between the existing work order amount and the Min.
Reorder Amount. This is for produced items only.
Certification
For assigning certifications to the item.
Certifications can be assigned to an item. If an access certification is assigned to an item, any users
who have been assigned to the certi fication and have the required certification level for the item can
run a job that produc es the item. If audit certifications are assigned to the item, all sign-offs required
by the certification must be performed to allow a job that has produced the item to be ended.
For more information, see Assigning Certifications to an Item on page 122.

Version 6.1 121

MES Client User Guide Items

Files
For adding files and web pages to an item to support the operator during production. For example, a
file or web page can contain material handling information or specific packaging instructions that are
relative to the item being produced. When a user is recording the production of the item from an
application such as MES Operator, the files and web pages will be available to them for viewing (for
example, from the MES Operator Folders tab).
For more information, see Adding Files and Web Pages to an Item on page 125.

Assigning Certifications to an Item

You can assign certifications to an item to manage who can run jobs that produce the item and whet her
a sign-off is required to complet e the recording of the item's production.
If an acce ss certification has been assigned to an item, a user cannot start a job that produces the item
unless the following conditions have been met:
 The user has been assigned to the certification.
 The user's certific ation level is at or higher than the level specified when the certification was
assigned to the item.
If an audit certification has been assigned to an item, then one or more user sign-offs will be required to
end a job that is producing the item. Only users whose certification level is at or higher than the level
specified when the certification was assigned to the item can perform a sign -off. The Audit tab in MES
Operator (and the MES .NE T Audit control) will list any audit certifications that are assigned to the item
being produc ed by the currently running job.
For information about certifications and how to create them, see Certifications on page 165.
To assign certifications to an item
1. In the Editor window, select the item.
2. In the Certification group In the Propertie s pane, click Configure Certification.

122 Version 6.1

Items MES Client User Guide

The Certi fications dialog box appears.

3. Right -click in the Certifications dialog box, and then click Add.
The Add Certifications dialog box appears. Any certifications that have been configured to be
applicable to items are listed.
The Audit column is read-only. If the c heck box is selected, the certification is an audit certification. If
not, it is an access certification.

4. Select the certifications that you want to assign to the item and click OK.

Version 6.1 123

MES Client User Guide Items

The selected certifications are listed on the Certifi cations dialog box.

5. For each certification, select the level required for this item in the Value list.
If the level is Yes or No, it is not editable because the certification has only one level. Instead, these
values indicate whet her the current user has been assigned to the certification.
6. Click Close to close the Certifications dialog box.
The selected certifications are listed in the Certification group.

7. Save the changes.

To edit the level of certifications
1. Click the Configure Certifi cation button to open the Certifications dialog box.
2. Modify the levels as needed, then click Close.
3. Save the changes.
To remove a certification assignment from the item
1. Click the Configure Certifi cation button to open the Certifications dialog box.
2. Right -click the certification and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.

124 Version 6.1

Items MES Client User Guide

4. Click Close to close the Certifications dialog box.

5. Save the changes.

Adding Files and Web Pages to an Item

You can add files and web pages to an it em to support the operator during production. For example, a file
or web page can contain material handling information or specific packaging instructions that are relative
to the item being produced. When a user is recording the production of the item from an application such
as MES Operat or, the files and web pages will be available to them for viewing (for example, from the
MES Operator Folders tab).
To add files to an item
1. In the Files property group, click the Configure Files button.

The Files dialog box appears.

2. Right -click in the dialog box, and then click Add files.
The Open dialog box appears.
3. In the file type list, select All files.
4. Navigate to and select the files to be added, and then click Open.

Version 6.1 125

MES Client User Guide Items

The selected files are listed in the Files dialog box.

5. Optionally, add a description for each file in the De scription column.

6. Add other files (or web pages) as needed.
7. When you are finished adding files, click Close.
The files are listed in the Files property group.

8. Save the changes.

To add web pages to an item
1. In the Files property group, click the Configure Files button.

126 Version 6.1

Items MES Client User Guide

The Files dialog box appears.

2. Right -click in the dialog box, and then click Add URL.
The Add URL dialog box appears.

3. Enter the URL for and a description of the web page.

Instead of manually entering the URL, you can click the Browse button at the right of the URL box
and use the mini-browser window that appears to navigate to the web page.

Click OK and that web page's URL is entered on the Add URL dialog box.
4. When you have finis hed entering the URL and description, click Close.

Version 6.1 127

MES Client User Guide Items

The URL is listed in the Files dialog box.

5. Add other web pages (or files) as needed.

6. When you are finished adding web pages, click Close.
The web page URLs are listed in the Files property group.

7. Save the changes.

To remove a file or URL
1. In the Files property group, click Configure Files.
The Files dialog box appears.
2. Right -click the file or URL, and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.

Creating a BOM for an Item

A Bill of Material (BOM) contains the basic information and production details for the selected BOM
version. A BOM item represents any component or by -product of the production of parent item. These
components and by-products must be defined as an item and assigned to an item to be a part of the
BOM.
A BOM version specifies the components that are consumed to produce the parent item, any
by-products of that production, and default values for s everal production settings. BOM item adds
production-specific details for usage of the item in the current BOM version.
An item can contain multiple BOM versions, but you can define only one version as the preferred version.
The preferred BOM version is used automatically whenever a process is defined to produce the parent
item.

128 Version 6.1

Items MES Client User Guide

To create a BOM
1. In the Editor window, click the item for which you want to create a BOM.
2. In the Properties pane, click BOM, and then click Configure BOMs. The BOM tab appears in the
Editor window.

You can specify the components and by-products for a BOM. For more information on specifying
BOM components, see Specifying BOM Components on page 131.
3. Right -click in the Editor window, and then click New.
4. Complete the property settings for the BOM. See BOM P roperties on page 129.
5. On the ribbon, click Save in the Main group to save the changes.

BOM Properties
General Properties
Version ID box
A unique version for the BOM. BOM version ID identifies the BOM version in the MES dat a records,
so must be unique, within the current item, and is not editable aft er the version information is first
saved.
Date
The date and time when the BOM was created.
Preferred Version
Specifies whether this version is a preferred version.
Once a BOM is specified as being a preferred version, you cannot clear the Preferred Version
check box. You can clear this check box by selecting another BOM version as the preferred version.
Description
A brief description for the BOM.
Production Details
Default Prod Code
The default production code for the BOM. The default production code indicates the default reason
for producing the parent item in MES Operator. An operator can select other production reasons for
this item.

Version 6.1 129

MES Client User Guide Items

Default Lot
The default value for the parent item’s lot number. This lot number is also used to report the
production of the item in the MES Client application.
Required Grade
The minimum grade (or physical condition) that the parent item must have to report the status as
consumed, WIP, or produced.
To Storage Location
Click the Browse button. The Entity dialog box appears. Select the entity and click OK. The storage
location that you select here is the default storage entity to place produced quantities of this
produced item.
Scaling Factor
The multiplier used to calculate the consumed/ produced quantity of the item. For example, if the
inventory tracks "pieces" but an operator work with "cases", the scaling factor might be 12. In case
when a user reports consuming/producing 2 "cases", inventory records is updated by 24 "pieces".
Backflush
Specifies whether the consumption of the WIP parent item must be recorded automatically in the
MES Operator application. For example, to make a bottled water bottle, if backflush for the BOM is
enabled, the consumption of the bottle, bottle cap, wrap label, and water is automatically posted. If
the Update Inventory check box is selected, then the invent ory record for the parent item will update
automatically.
May Create New Lots
Specifies whether a user can create new lot numbers while reporting the production of the parent
item.
May choose alternate inventory location
Specifies whether an operator can select an inventory location for this item other than the default
inventory.
Update Inventory
Specifies whether the records must update when a user reports production of this item.
Must Consume From Inventory
Specifies whether the WIP parent item, required grade, lot number, and quantity must exist in the
inventory records before an operator reports the consumption of t he item (or production of the parent
item if the Backflush option is enabled).
Must Consume From WIP
Specifies whether to restrict consumption of the work in progress (WIP) parent item to previously
produced work order and associated work orders.
Advanced Production Details
Instructions
Additional instructions for the B OM version or instructions for assembly/fabrication that is available to
an operator.
BOM_Item spare 1–4
User-defined information about the BOM.
Substitutes
Create a new item substitute. For more information on creating a n item substitute, see Creating an
Item Substitute on page 133.

130 Version 6.1

Items MES Client User Guide

Specifying BOM Components

To specify BOM components
1. In the Editor window, select the BOM for which you want to specify the components.

2. Right -click in the Components window, and then click Insert Component/ByProduct. A new BOM
component record appears in the Components window.
3. In the Properties pane, complete the BOM component’s property settings. See BOM Component
Properties on page 131.
4. On the ribbon, click Save in the Main group to save the changes.

BOM Component Properties

BOM Position
The position of this BOM in the BOM list.
You cannot edit a BOM position aft er the BOM item definition is saved. When you add an item to a
BOM, select a positive position number to indicate a component, which needs to be consumed; and
a negative position number to indicate a by-product, which needs to be produced. 0 is reserved to
indicate the final product.
Items
Click the Brow se button to locate the item for this BOM.
Required Grade
The minimum grade that this substitute item must have to allow consumption of the parent item
Default Reason
The default reason for the BOM position.
Quantity box
The quantity of the substitute item to be consumed or produced for each unit of the parent item t hat is
produced using this version.
To Storage Location
Click the Brow se button to locat e the entity or entity group to which you want to assign the item. This
indicates the default storage entity to place the produced quantities of this substitute item.
You can select the entity in the To Storage location box only for the produc ed items.
Min Quantity
The minimum consumption amount of this consumed item that is required for producing a unit of the
parent item.
You can select minimum consumption amount only for the consumed items. The Must Consume
Before Production Allowed check box gets enabled only when you specify the minimum
consumption amount in the Min Quantity box.
Max Quantity
The maximum consumption amount of this consumed item that is permitted for producing a unit of
the parent item.

Version 6.1 131

MES Client User Guide Items

You can select minimum consumption amount only for the consumed items.
Backflush Consumption
Specifies whether the consumption of the consumed item is recorded automatically whenever the
production of t he parent item is recorded. For example, to make a bottled water bottle, if backflush for
the BOM is enabled, the consumption of the bottle, bottle cap, wrap label, and wat er is automatically
posted.
You should not report consumption manually if you select the Backflush Consumption check box.
You should only report exceptions to standard consumption as defined by the BOM. When Update
Inventory check box is selected, inventory records for the WIP parent item automatically updates.
Update Inventory
Specifies whether the records must update when a user reports production of this substitute item.
Must Consume Before Production Allowed
Specifies whether a user must report cons umption of this consumed item before reporting production
of the parent item.
You can select this check box only for the consumed items.
Must Consume From Inventory
Specifies whether the consumed item, required grade, lot number, and quantity must exist in the
inventory records before a user reports the consumption or production of the parent item.
May Create New Lots
Specifies whether a user can create new lot numbers when reporting the production of this
consumed item. A user can create new lots only for the produced items.
Must Consume From WIP
Specifies whether to restrict the consumption of WIP parent item to pre viously produced work order
and associated work orders.
May Choose Alternate Inventory Location
Specifies whether a user can select an inventory location for this consumed item other than the
default inventory.
Constant Quantity
Specifies whether the consumption quantities of this consumed item depends on the number of
produced parent items.
Cons umed quantity value is absolute, as defined in the Quantity box. You can select the Constant
Quantity check box only for the consumed items.
Default Lot
The default value for the consumed item’s lot number. This refers to the lot from which items must be
consumed. This lot number is also used to report the production of an item.
Instructions
Additional notes or instructions for using the item consumed.
Units
The unit of measure used by this consumed item. For more information on UOM, see Units of
Measure on page 141.
Scaling Factor
The multiplier used to calculate the consumed/ produced quantity of the item. For example, if the
inventory tracks pieces but the users of MES work with cases, the scaling factor might be 12. If a user
reports consuming/producing 2 cases, inventory records are updated by 24 pieces.
BOM_Item_Spare1–4
User-defined information for this BOM.

132 Version 6.1

Items MES Client User Guide

Creating an Item Substitute

You can specify items that can be used in place of the selected item, and also any restrictions on their
usage. Substitutions specified for a BOM version are available to a user whenever its parent item is
produced using the same BOM version.
To create an item substitute
1. In the Editor window, click the item for which you want to create a BOM.
2. In the Properties pane, click Substitute s, and then click + to add a substitute. The Substi tute s
dialog box appears.

3. Complete the property settings in the Substitute s dialog box. For a description of the properties, see
Item Substitute Properties on page 133.
4. On the ribbon, click Save in the Main group to save the changes.

Item Substitute Properties

Items box
Click the Brow se button to locate the item for which you want to create a substitute.
Preference
A preference for the item substitute. It indicates the priority of this item during a substitution. A value
of 1 is the most preferred. Substitute items are shown in the BOM tab of the MES Operator
application in the sequence of most desirable to least (smallest preference number to largest).
Substitute Level
The substitute level to limit the usage of this substitute.
Only those whose user privileges have a BOM substitution level greater than or equal to this value
can report consumption or production of this substitute item in place of the selected item.

Version 6.1 133

MES Client User Guide Items

Required Grade
The minimum grade that this substitute item must have to report as consumed or produced as a W IP.
Default Prod Code
The default reason for producing this substitute item. An operator can select other production
reasons for the item.
You can select the default production code only for the produced items.
Quantity
The quantity of the substitute item to be consumed or produced when us ed in place of the selected
item.
To Storage Location
Click the Brow se button to loc ate the default storage entity at which to place the produced quantities
of this substitute item.
You can select the entity in the To Storage Location box only for the produced items.
Min Quantity
The minimum consumption amount of this substitute item that is required for producing a unit of the
parent item.
You can select minimum consumption amount only for the consumed items. The Must Consume
Before Production Allowed check box is available only when you specify the minimum
consumption amount in the Min Quantity box.
Max Quantity
The maximum consumption amount of this substitute item that is permitted for producing a unit of the
parent item.
You can select minimum consumption amount only for the consumed items.
Backflush Consumption
Specifies whether the consumption of the consumed item must record automatically whenever the
production of this substitute parent item is recorded. For example, to make a bottled water bottle, if
backflush for the BOM is enabled, the consumption of the bottle, bottle cap, wrap label, and water is
automatically posted.
Users should not report the consumption of the substitute item manually. When the Update
Inventory check box is selected, inventory records for the W IP parent item will update automatically.
Update Inventory
Specifies whether the records must update when a user reports production of this substitute item.
Select the Must Consume Before Production Allowed
Specifies whether a user must report consumption of this substitute item before reporting production
of the parent item.
You can select this check box only for the consumed items.
Must Consume From Inventory
Specifies whether the WIP parent item, required grade, lot number, and quantity must exist in the
inventory records before a user reports the consumption or production of the parent item.
May Create New Lots
Specifies whether you can creat e new lot numbers when reporting the production of this substitute
item. You can create new lots only for the produced items.
Must Consume From WIP
Specifies whether to restrict the consumption of WIP parent item to previously produced work order
and associated work orders.

134 Version 6.1

Items MES Client User Guide

May Choose Alternate Inventory Location

Specifies whether a user can select an inventory location for this substitute item other than the
default inventory.
Constant Quantity
Specifies whether the consumption quantities of this substitute item do not depend on the number of
produced parent items.
Cons umed quantity value is absolute, as defined in the Quantity box. You can select the Constant
Quantity check box only for the consumed items.
Default Lot box
The default value for the substitute item’s lot number. This refers to the lot from which items must be
consumed. This lot number is also used to report the production of an item.
Instructions
Additional notes or instructions for using the item substitute.
Units
The unit of measure used by this substitute item. For more information on UOM, see Units of
Measure on page 141.
Scaling Factor
The multiplier used to calculate the consumed/ produced quantity of the item. For example, if the
inventory tracks pieces but the users of the MES Client application work with cases, the scaling
factor might be 12. If a user reports consuming/producing 2 cases, inventory records are updated by
24 pieces.
Item_Subst Spare1–4
User-defined information for this item substitute.

Viewing the Processes Linked to an Item

You can view the processes that linked to an item. This indicates that the process can produce the item.
For how to link an item to a process, see Assigning Items to a Process on page 178.
To view processes linked to an item
1. In the Editor window, select the item for which you want to view the linked proc ess.
2. In the Properties pane, open the Proce sse s Linked To Item tab.
A list of processes linked to the selected item appears.

Viewing the Relationship Diagram

You can view a graphical representation of the relationship between an item, an item class, and a unit of
measure.
To view the relationship diagram
1. In the Editor window, right -click an item, and click View Relationships. The Relationship View
window appears in the Edi tor window.
2. Click the item, item class, or UOM diagram to view the properties.
To collapse and expand the relationship
 Click the – icon to collapse the relationship groups within the relationship view.
 Click the + icon to expand the relationship groups within the relationship view.

Version 6.1 135

MES Client User Guide Items

Assigning a Storage Entity for an Item

A storage entity can be a building, a location within a building, a movable bin or container, and so on. You
can assign multiple storage entities to an item and also specify the inventory requirements for an item per
storage entity.
To define and assign a storage entity to an item
1. In the Editor window, click the item for which you want to assign a storage entity, and then click
Storage tab.
2. On the ribbon, click the Current View tab.
3. In the Storage group, click Insert Storage. A new storage record is shown in the S torage window.

4. In the Properties pane, complete the following settings:

Enti ty
Click the Brow se button to locate the entity or entity group to which you want to assign the item.
Min. Inventory Level
The minimum amount of the item that should be available in the inventory at this storage entity or
currently scheduled to be made through a work order.
You can define the minimum inventory level only for the produced items.
Min. Reorder Amount
The minimum amount of the item that should be reordered for this storage entity.
5. On the ribbon, click Save in the Main group to save the changes.

Assigning Attributes to an Item

An attribute is an additional user-defined property. You can assign attributes to an item that allows
operators to provide additional information about the item.
Item attributes must first be created using the Attribute s module. See Attributes on page 107.
To assign attributes to an item
1. In the Editor window, select the item.
2. Click in the Attribute s tab.
3. Do one of the following:
 On the Current View ribbon, click Add.
 Right -click in the Attribute s tab, and then click Add.
The Add attribute s dialog box appears.
4. Select the attributes to assign to the item and click OK.
5. Save the changes.

136 Version 6.1

 MES Client User Guide

C HAPTER 16
Item Classes
In This Chapter
Introduction to Item Classes ........................................................................................................ 137
Creating an It em Class ................................................................................................................ 137
Linking an Item Reason Group to an Item Class ........................................................................... 139
Copying an Item Class ................................................................................................................ 139
Viewing the Relationship Diagram ................................................................................................ 139
Assigning Attributes to an Item Class ........................................................................................... 140

Introduction to Item Classes

You can use the Item Classe s module to create and maintain an item class.
When you open the Item Classe s module, a list of all the existing item classes is shown in the Editor
window.
By default, the Item Classe s module is grouped under the Product Definition group in the Navigation
pane. For more information on groups and modules, see Groups and Modules on page 29.
An item class is a logical grouping of items that share common charac teristics, such as physical
properties and whet her they are produced, consumed, or bot h.
An item class contains all similar items. For example, the class Packaging Material can contain all items
that are packed in Area 1 at the plant floor.

Creating an Item Class

All items in a class share the same produced/consumed status and the same production/consumption
reasons.

Version 6.1 137

MES Client User Guide Item Classes

To create item classes, you must have the General privilege May edit items.
To create an item class
1. On the ribbon, click New Item Class in the New list. A new item class record is shown in the Editor
window.
2. In the Properties pane, complete the settings. For a description of the properties, see Item Class
Properties on page 138.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing item class in the Properties pane.

Item Class Properties

Item Class ID
The item class ID to which you want to assign the item.
You can also create a new item class. For more information on creating a new item class, see
Creating an Item Class on page 137.
Item Class De scription
A brief description or a name for the item class.
Produced
Specifies whether items in this item class are to be produced by a production process in your
company. For more information on processes, see Processes on page 171.
Consumed
Specifies whether items in this item class are to be consumed in a production process in your
company. The items in this item class are consumed in a BOM. For more information, see Creating a
BOM for an Item on page 128.
An item class may be both produced and consumed.
Obsolete
Specifies whether the item class is obsolete. Specifying a class as obsolete marks all items within the
class as obsolete. This indic ates that the items will not be available for BOMs or processes
configuration.
Inventory Handling: Inventory i s unique by job
Specifies whether the inventory assigned to a job can be used only with that job. This check box is
not available if the inventory is not licensed.
If inventory is being transferred to another storage entity and the following conditions are true:
o The destination item is configured to identify the inventory quantities uniquely by job
o The inventory is being moved to a downstream job
o The work order’s Override Serialization option is not selected

Then the inventory information of the job that produced the serial number will be updated to match
those of any job immediately preceding the first job identified by the work order and operation that
produces the item being transferred. If there are no suc h upstream jobs, then the inventory
information for the job that produced the serial number are left unchanged.
Inventory Handling: Serial Number Level
A serial number level for the item class. Select Lot Number if you want the serial number to be the
same as lot number.
Inventory Handling: Lot number format and Sublot number format
The format of the lot number and sub -lot number for the items in the item class.

138 Version 6.1

Item Classes MES Client User Guide

For example, Lot -AB# is displayed as Lot -AB1, Lot-AB2, and so on.
User Defined: Spare1–4
User-defined information about the item class.

Linking an Item Reason Group to an Item Class

Item reasons are used to define the condition of an item. For example, item grade and state (physical
condition/status). Item reas on groups are used in the MES Operator application for reporting
consumption and production. Item classes are organized into related item reason groups.
You can link an item reason group to an item class. You can specify which reason group (and its
reasons) are most appropriate for the selected item class. For more information on creating an item
reason group, see Item Reasons on page 149.
To link an item reason group to an item class
1. In the Editor window, click the item class to which you want to assign an item reason group.
2. In the ItemReasonGroup Linked To ItemClass section of the Propertie s pane, click +. The Add
Item Reason Group dialog box appears.

3. Select the item reason group that you want to assign to the item class and click OK.
You can assign multiple item reason groups to an item class.
4. On the ribbon, click Save in the Main group to save the changes.

Copying an Item Class

Copying an item class does not copy the items of the original item class or the attribut es and reason
groups associated with the original item class.
To copy an item class
 Select the item class that you want to copy, and click Copy on the ribbon.

Viewing the Relationship Diagram

You can view a graphical representation of the relationship between an item, an item class, and a unit of
measure.

Version 6.1 139

MES Client User Guide Item Classes

To view the relationship diagram

1. In the Editor window, right -click an item class, and click View Relationships. The Relationship
View Item Class tab appears.

2. Click the item, item class, or UOM diagram to view the properties.
To collapse or expand the relationship
 Click the – symbol to collapse the relations hip groups within the relationship view.
 Click the + symbol to expand the relationship groups within the relationship view.

Assigning Attributes to an Item Class

An attribute is an additional user-defined property. You can add attributes to an item class that supplies
more information about the item class.
You must create attribute for an item class in the Attribute s module before assigning attribute t o an item.
For more information on attributes, see Attributes on page 107.
To add a attribute to an item class
1. In the Editor window, click the item class to which you want to add an attribute.
2. Right -click the Attributes window, and then click Add. The Add attributes dialog box appears.
3. Select the attribute you want to add and click OK.
You can add multiple attributes to an item class.
4. On the ribbon, click Save in the Main group to save the changes.

140 Version 6.1

 MES Client User Guide

C HAPTER 17
Units of Measure
In This Chapter
Introduction to Units of Measure .................................................................................................. 141
Creating a Unit of Meas ure .......................................................................................................... 141
Creating an It em-Specific Unit of Measure Conversion .................................................................. 142
Viewing the Relationship Diagram ................................................................................................ 142

Introduction to Units of Measure

You can use the Units of Measure module to create and maintain the Units of Measure (UOM). The
UOM describes the quantities of items or the measurement units of characteristics in the MES Client
application. You can also define a conversion method bet ween two UOMs.
When you open the Units of Measure module, a list of all the existing UOMs is shown in the Edi tor
window.
By default, the Units of Measure module is grouped under the Product Definition group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.

Creating a Unit of Measure

You can define the UOMs that are used to describe quantities of the items in the MES Client application.
By default, the pieces UOM is included in the UOM list.
To create a UOM
1. On the ribbon, click New Units of Measure in the New list.
A new UOM rec ord is shown in the Editor window.

Version 6.1 141

MES Client User Guide Units of Measure

2. In the Properties pane, complete the following settings:

Description
A description for the UOM. Because this description identifies the UOM in the data rec ords, it must
be unique.
Abbreviation
An abbreviation for the unit of measure.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing UOM in the Properties pane.

Creating an Item-Specific Unit of Measure Conversion

A conversion method can be defined bet ween any two UOMs. For example, you can convert Fahrenheit
to Centigrade.
To create an item-specific UOM conversion
1. In the Editor window, select the UOM for which you want to do a conversion.
2. In the Configure Unit of Measure s Conversions For section, click the + icon to add a new row.
3. Complete the following settings:
To Unit
The UOM that you want to use for conversion.
Factor
The number by whic h the quantity should be multiplied for converting the initial UOM to the target
UOM.
Offse t
The value that should be added or deducted from the conversion total. It can be a negative value.
Update Inverse Conversion
Specifies whether to reverse the conversion. For example, if the conversion for Yards to Feet is
defined and this option is selected, the Feet to Yards UOM is also converted.
If the quantity to be converted is x, the factor is F, and the offset is O, then the resulting conversion is
Fx + O.
Conversion
Shows the converted UOM value.
Uom_Conv spare 1–4
Additional information about the conversion.
4. Click Select Item(s) for specific UOM Conversion.
5. Select the item class for which you want to create a UOM.
6. Click OK.
7. On the ribbon, click Save in the Main group to save the changes.

Viewing the Relationship Diagram

You can view a graphical represent ation of the relationship between an item, an item class, and a UOM.
To view the relationship diagram
1. In the Editor window, right-click an item, and then click View Relationship. The Relationship View
window appears.
2. Click the item, item class, or UOM diagram to view the properties.

142 Version 6.1

Units of Measure MES Client User Guide

To collapse or expand the relationship

 Click the – icon to collapse the relationship g roups within the relationship view.
 Click the + icon to expand the relationship groups within the relationship view.

Version 6.1 143

 MES Client User Guide

C HAPTER 18
Item Grades
In This Chapter
Introduction to Item Grades ......................................................................................................... 145
Creating an It em Grade ............................................................................................................... 145

Introduction to Item Grades

You can use the Item Grades module to create and maintain item grades. Item grades are used in MES
to restrict the consumption and shipment of materials. Item grades are closely related to item states and
item reasons.
When you open the Item Grades module, a list of all the existing item grades is shown in the Editor
window.
By default, the Item Grades module is grouped under the Product Definition group in the Navigation
pane. For more information on groups and modules, see Groups and Modules on page 29.
An item grade defines the physical condition of an item. Y ou can define unlimited number of item grades.
This allows you to increase the flexibility of tracking the quality of an instances of an item produced
and/or consumed, such as a lot. For example, a process that produces an item must be tested to
determine its grade. You can define grades as A, B, and C for the produced item.

Creating an Item Grade

The names and colors of an item grade are user-defined.
You can create multiple grades for an item. For example, if production of an item is stopped becaus e the
consumed items were spoiled, you can give an item grade Spoiled to the consumed item class.

Version 6.1 145

MES Client User Guide Item Grades

To create an item grade

1. On the ribbon, click New Item Grade in the New list. A new item grade record is shown in the Editor
window.
2. In the Properties pane, complete the following settings:
Description
A brief description for the item grade. Because the description identifies the item grade in the data
records, it must be unique.
Production
The production grade for the item. The production grade indicates whether the produced item grade
is Good or Rejected. The grade assigned to a produced lot can be used to prevent downstream
consumption or shipment from inventory.
Consum ption
The consumption type for the item. The consumption type indicates whether the item was Normal
(consumed as expected) or Waste (not consumable).
Color
The color to assign to the item grade.
Preferences
A preference for the item grade in the numeric value. This indicates the relative quality of this grade
when produced and/or consumed. Smaller numbers are considered better than larger numbers. This
is used to determine the minimal shippable grade of a product and the minimal consumable grade of
a component.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing item grade in the Properties pane.

146 Version 6.1

 MES Client User Guide

C HAPTER 19
Item States
In This Chapter
Introduction to Item States ........................................................................................................... 147
Creating an It em State ................................................................................................................ 147

Introduction to Item States

You can use the Item States module to create and maintain item states.
An item state defines the possible state for an instance of an item that determines its minimal shippable
and/or consumable standards.
When you open the Item States module, a list of all existing item states is shown in the Editor window.
By default, the Item States module is grouped under the Product Definition group in the Navigation
pane. For more information on groups and modules, see Groups and Modules on page 29.
For example, a Finished Goods state indicates that an item is produced successfully, and a WIP (work in
progress) state indicates that the item is still under production.

Creating an Item State

The names and colors of item states are user -defined. You can create as many item states as required.
To create an item state
1. On the ribbon, click New Item State in the New list.
A new item state record is shown in the Editor window.
2. In the Properties pane, complete the following settings:

Version 6.1 147

MES Client User Guide Item States

Item State
A name or brief description for the item state. Because the description identifies the item state in the
data records, the state name be unique.
You can create multiple states for an item. For example, if production of an item is stopped, you can
assign the Stopped item state to that item.
Color
The color to be associated with the item state.
Preference
A preference for the item state in the numeric value. This indicates the relative quality of this state.
Smaller numbers are considered better than higher numbers. This is used to determine the minimal
shippable state of a product.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing item state in the Properties pane.

148 Version 6.1

 MES Client User Guide

C HAPTER 20
Item Reasons
In This Chapter
Introduction to Item Reasons ....................................................................................................... 149
Creating an It em Reason Group .................................................................................................. 150
Creating an It em Reason............................................................................................................. 151

Introduction to Item Reasons

You can use the Item Reasons module to create and maintain item reason groups and reasons. An item
reason defines a reason for an item to be in any state and grade. Item reason groups are used to
organize similar reasons. An item reason is selected when production or consumption of an item is
reported and then this reason determines the state and grade of the lot of an item. A reason can be
selected by PLC, I/O, or an operator.
The item reason group and the reas ons associated to that reason group are assigned to item classes
and entities to specify which reasons are applicable to different item classes or entities.
When you open the Item Reasons module, a list of all the existing item reason groups is shown in the
Editor window.
By default, the Item Reasons module is grouped under the Product Definition group in the Navigation
pane. For more information on groups and modules, see Groups and Modules on page 29.

When you open the Item Reasons module, the Current View tab appears on the ribbon.
The Current View tab includes the View group, the Sequence group, and the View Relationships
group.
In the View group, the following commands are available:
 Default View: Shows a list of all the existing item reason groups and reasons.

Version 6.1 149

MES Client User Guide Item Reasons

 Group By Item Classe s: Shows a list of all the reasons by group. When you click Group By Item
Classe s, the group name and description of all the available reason groups class is shown in the
Editor window.
 Group By Entitie s: Shows a list of all the reasons grouped by entities. When you click Group By
Enti ties, the name and description of all the available entities is shown in the Editor window.
If you are using Group by Item Class or Group by Enti ties option, item reason groups and item
reasons that are not associated wit h an item class or entity does not appear in the filtered list.
In the Sequence group, the following commands are available:
 First: Changes the selected item reason to the first item reason.
 Up: Moves the selected item reason up.
 Down: Moves the selected item reason down.
 Last: Changes the selected item reason to the last item reason.
In the View Relationships group, the following command is available:
 View Relationships: Shows a graphical representation of the relationship between an item group,
an item class, and entities.

Creating an Item Reason Group

An item reason group contains similar item reasons. You can assign multiple item reas on groups to an
item class.
If no item reason group is selected, the default item reason group is assigned to an item class.
Item reason groups are user-defined groups. You can create as many item groups as required.
To create an item reason group
1. On the ribbon, click New Item Reason Group in the New list. A new item reason group record is
shown in the Editor window.
2. In the Properties pane, complete the following settings:
Group De scription
A brief description for the item reason group. The description describes the grouping of item reasons
and identifies the item reason group in the data records, so must be unique.
Group Type
The group type. The group type indicat es the situation in which the reasons in this group is used.
This limits the reason choice, when reporting the consumption or production of an item to only those
appropriate for the situation. For example, only reason groups (and their reasons) of type Production
are available when successful production quantities are reported. You can select the following group
types:
o Production: Used for reporting production.
o Consum ption: Used for reporting consumption.
o Manual Waste/Rejects: Used for reporting rejected quantities or waste production.

Classe s Linked To Group

The item classes linked to this reason group. For more information on linking an item reas on group to
an item class, see Link ing an Item Reason Group to an Item Class on page 139.
Enti ties Linked To Group
The entities linked to this item reason group.

150 Version 6.1

Item Reasons MES Client User Guide

To restrict the reasons that can be applied to item production or consumption for jobs running on an
entity, allowable item reason groups can be selected for the entity. If an item reason group has been
assigned to any entities as an allowable reason group, those entities are listed here. See Assigning
Item Reason Groups to an Entit y on page 81.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing item reas on group in the Propertie s pane.

Creating an Item Reason

You cannot define a reason for an item before defining possible resultant states and grades for that item.
For more information on item states and item grades, see Item States on page 147 and Item Grades on
page 145.
To create an item reason
1. On the ribbon, click New Item Reason in the New list. A new item reason record is shown in the
Editor window.
2. In the Properties pane, complete the following settings:
Reason Description
A brief description for the item reason. This describes the reason for the manner in which an item is
handled and identifies the reason in the dat a records, so it must be unique within its reason group.
You can create a new item reason group if the existing item reason groups in the list do not fulfill the
parameters of the new item reason. To create a new item reason group, see Creating an Item
Reas on Group on page 150.
Item Grade
The defined item grade for the selected item. By default, the first item grade in the list is shown. For
more information on item grade, see Item Grades on page 145.
Item States
The defined item state for the selected item. By default, the first item state in the list is shown. For
more information about item states, see Item States on page 147.
Reason Code
The reason code. The code associated with this reason identifies the reason in the data records, so
it must be unique and is not editable aft er the reason definition is first saved.
Default Consumption
Specifies whether to define the item reason as the default reason for the consum ed items. The
selected reason is specified as the default reason when reporting consumption of an item in MES. An
operator can change the default reason for the item class.
Default Production
Specifies whether to define the item reason as default reason for the produced items. The selected
reason is specified as the default reason when reporting production of an item in MES. An operator
can change the default reason for the item class.
BOM Version Linked To Reason
The BOM versions that use this reason as their default production reason. For more information, see
Creating a BOM for an Item on page 128.
BOM Item Linked To Reason
The BOM items that use this reason as their default reason for production or consumption. For more
information, see Creating a BOM for an Item on page 128.
Enti ties Linked to Reason
The entities that use this reas on as their default reason for item production or c onsumption. For more
information, see Jobs.

Version 6.1 151

MES Client User Guide Item Reasons

3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing item reas on in the Propertie s pane.

152 Version 6.1

 MES Client User Guide

C HAPTER 21
Global Specifications
In This Chapter
Introduction to Global Specifications ............................................................................................ 153
Creating a Global Specification .................................................................................................... 156
Using Specifications in the Operations Capability Object ............................................................... 157
Understanding Specification Capabilities ...................................................................................... 159

Introduction to Global Specifications

You can use the Global Specifications module to create and maintain global specifications. You can use
the specifications defined in the Global Specifications module in the Processes and Work Orders
modules to add specifications to a specification version of an operation, a process, and a job.
Global Specifications are not used for capturing quality data. See QM S pecifications on page 327 for
quality functionality.
Specifications represent a collection of values for settings that can be used during an operation for a
process when producing an item for a work order. Specifications are used for setting values (with an
optional minimum and maximum) that should be used at run time during the ex ecution of an operation.
These are also known as operating setpoints. For example: When you run a job on an entity doing a
mixing operation, the specifications for the operation can be used by the Operation Capability Object
(OCO) to load the setpoints in a P LC where the setpoints are different when different items are produced.
You can assign multiple specification versions to an operation. For more information on specification
versions, see Assigning Specifications to an Operation on page 204. However, you can define only one
version as the preferred version. The preferred specification version is used when a work order is created
from a process. All operations in a process use that same specification version.

Version 6.1 153

MES Client User Guide Global Specifications

A specification version can contain multiple specifications. When you c reat e a work order from a process,
the preferred version is chosen for the job. You can also change the specification version for the job if you
have the privilege to edit the specification version.

When you open the Global Specifications module, a list of specifications is shown in the Editor window.
The Global Specifications module is in the Operations Management group in the Navigation pane.
For more information on groups and modules, see Groups and Modules on page 29.

154 Version 6.1

Global Specifications MES Client User Guide

A global specification group organizes specifications, which are defined template -style. When a
specification is assigned to an operation’s specification version, it is given the specific values relevant to
that item/operation/ entity combination.

The global spec groups display no detailed information bec ause they exist in name only, to organize the
specifications.

Version 6.1 155

MES Client User Guide Global Specifications

Creating a Global Specification

A global specification group organizes specifications that have a pre -defined template style. When a
specification is assigned to an operation’s specification version, it is given the specific values relevant to
that item, operation, or entity combination. These specifications are assigned to specific ation groups that
are valuable when the specifications are used for a Process or in the Operation Capability Object (OCO).

When a specification is assigned to an Operation’s Specification Version, it is given the values relevant
to that Item, Operation, Entity, or Bill of Material (BOM) combination. For more information, see Adding a
Specification Version to a Standard Operation on page 225.
You must have the privileges to configure a specification.
To create a global specification
1. On the ribbon, click New Global Specification in the New list. A new global specification record is
shown in the Editor window.
2. In the Properties pane, complete the following settings:
Group
The group name for the global specification.
Spec
The name of the global specification. The specification name identifies the specification in all MES
records, so a specification must be unique and is not editable after the specification is saved.
Description
The description of the global specification.
Data Type
The data type for the global specification that indicates the data type of the selected specificati ons’
values.
o String: User-definable text string.
o Floating point: User-definable decimal value.

156 Version 6.1

Global Specifications MES Client User Guide

Units
The units to be used for the global specification.
Di splay Sequence
Indicates the position in which the selected spec appears within the global spec group in the
specification tree.
Spec spare 1–4
User-defined information for the global specific ation.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing global specification in the Propertie s pane.

Using Specifications in the Operations Capability Object

In the Operation Capability Object (OCO) in ArchestrA, you can use the Specifications tab to browse
and select the globally configured specifications from the MES database.

In the OCO, when you enable the Specifications tab in the object editor via the Enable Specifications
check box in the General tab, it allows you to map the specification properties such as value, minimum
value, and maximum value with object attributes.

When you execute the specifications commands in the OCO, the specifications that have been mapped
as attributes in the galaxy are made available for the OCO at the run time. The mapped specification
values are retrieved from the database for the OCO’s currently running job or a future job.

Version 6.1 157

MES Client User Guide Global Specifications

When you execute the Load Running Job Specs command in the OCO, the specifications for the
currently running job on the parent entity of an OCO are loaded. In case of the Load Job Specs
command, the OCO uses the values of work order, operation, and sequence number for a job that might
be run in future to setup the specifications for later use on that job.

The step number is used to enable loading of the s pecifications for a single step, if a number greater t han
0 is in the attribute or the number -1 causes the OCO to retrieve the specific ations for all steps for an
operation on a job.
Inside the OCO, two sets of attributes are created for every specification. The shop floor user can change
specification properties after loading them from the database and before uploading them to external
input or output sources. The attributes are as follows:
 The Working attributes, which are used to let a shop floor user change the setpoints value within the
maximum and minimum limit values specified.
 The Target attributes, which are us ed to represent the values currently loaded into a device like a
PLC on the shop floor.

158 Version 6.1

Global Specifications MES Client User Guide

Understanding Specification Capabilities

The OCO Specifications tab displays specification commands during the run time.

You can trigger the following specification commands during the run time:
Load Job Specs
Loads the specifications for a job that is not necessarily running on the parent entity of an OCO.
When you trigger this command, the OCO us es the values of work order, operation, and sequence
number in the run time job filter to load the specifications.
Load Running Job Specs
Loads the specifications for the currently running job on the parent entity of an OCO. You must
specify the job position to retrieve the specifications. When you trigger this command, the OCO uses
the values of the work order, operation, and sequence number for the job position instead of the
values in the run time job filter to load the specifications.
Download
Copies the values of the working attributes to the target attributes while applying the Scaling Factor
DB To IO for eac h specification.
Save
Writes the working value of specifications for each specification to the MES database.
Upload
Reads the value that is configured for the Actual Specification Value attribute and updates the Target
Specification Value at the run time. The target attribut e value is written to the working attribute
Work ing Spec Value Actual while applying the scaling factor Scaling Factor IO To DB.
Load Download Job Specs
Executes both the Load Job Specs command and the Download command.
Load Download Running Job Specs
Executes both the Load Running Job Specs command and the Download command.

Version 6.1 159

 MES Client User Guide

C HAPTER 22
Labor Departments
In This Chapter
Introduction to Labor Departments ............................................................................................... 161
Creating a Labor Department ...................................................................................................... 161

Introduction to Labor Departments

If your MES has entities with the ability to track labor, you can us e labor departments to provide
contextual information about the time that MES users spend working on those entities. Labor
departments are assigned to MES users in the User Groups and Users module. In MES Operator, labor
departments can also be changed from the user's default department for the current operation running
on an entity.
You use the Labor Departments module to create and maintain labor departments. This module is
grouped under the Operations Management group in the Navigation pane. For more information on
groups and modules, see Groups and Modules on page 29.
When you open the Labor Departments module, a list of all the existing labor departments is shown in
the Editor window.

Creating a Labor Department

1. Open the Labor Department module.
2. Do one of the following:
 In the tab, right-click and click New.
 Press Ctrl+N.

Version 6.1 161

MES Client User Guide Labor Departments

 On the Home ribbon group, click New and then click New Labor Department.
A new labor department record appears.
3. In the Properties pane, complete the settings.
Department ID
A unique ID for the labor department. The ID is not editable after the labor department record is first
saved.
Description
A brief description of this labor department.
4. Save your changes.
You can modify the properties of an existing labor department in the Properties pane.

162 Version 6.1

 MES Client User Guide

C HAPTER 23
Labor Categories
In This Chapter
Introduction to Labor Categories .................................................................................................. 163
Creating a Labor Category .......................................................................................................... 163

Introduction to Labor Categories

If your MES has entities with the ability to track labor, you can use labor categories to provide contextual
information about the time that MES users spend working on t hose entities. Labor categories are
assigned to MES users in the User Groups and Users module. In MES Operator, labor categories can
also be changed from the user's default category for the current operation running on an entity.
You use the Labor Categories module to create and maintain labor categories. This module is grouped
under the Operations Management group in the Navigation pane. For more information on groups and
modules, see Groups and Modules on page 29.
When you open the Labor Categories module, a list of all the existing labor categories is shown in the
Editor window.

Creating a Labor Category

1. Open the Labor Categories module.
2. Do one of the following:
 In the tab, right-click and click New.
 Press Ctrl+N.

Version 6.1 163

MES Client User Guide Labor Categories

 On the Home ribbon group, click New and then click New Labor Category.
A new labor category record appears.
3. In the Properties pane, complete the settings.
Code
The unique identifier for the labor category. This code is not editable after the labor category record is
first saved.
Description
A brief description of this labor category.
Color
The color to assign to this category.
Time
Specifies how to classify time associated with the labor category:
Fixed
Labor actions for which the exact time for completion is known.
Variable
Labor actions for which the exact time for completion is not known.
Neither
Labor time that is neither Fixed nor Variable.
Standard Crew Size
The standard crew size for this labor category.
4. Save your changes.
You can modify the properties of an existing labor category in the Propertie s pane.

164 Version 6.1

 MES Client User Guide

C HAPTER 24
Certifications
In This Chapter
Introduction to Certifications ........................................................................................................ 165
Creating a Certification................................................................................................................ 167
Assigning a Certification to Users................................................................................................. 169
Assigning Certifications to Actions ............................................................................................... 170
Deleting a Certification ................................................................................................................ 170

Introduction to Certifications
Certifications can be applied to certain MES actions to control whic h users can perform t hose actions and
which actions require a sign-off to complete the action. The actions include operations, operation steps,
item production and consumption, and data logging.
There are two types of certifications:
 Access, or non-audit, certifications, which can restrict access to the actions to which they are
assigned
 Audit certific ations, which require one or more user sign -offs to c omplet e the action to which they are
assigned
You use the Certifications module to create certifications and assign users to them. You then use other
modules to assign the certifications to the target actions.
The Certi fications module is grouped under the Operations Management group in the Navigation
pane. For more information on groups and modules, see Groups and Modules on page 29.

Version 6.1 165

MES Client User Guide Certifications

When you open the Certifications module, a list of all the existing certifications is shown in the Editor
window.

How Access Certifications Work

Access (non-audit) certifications can be applied to actions to require that only users at or above a
predefined certification level can perform the action. Access certifications can restrict access to the
following actions:
 Running a job that has been instantiated from an operation to which the certification has been
assigned
 Running a job that will produce an item to whic h the certification has been assigned
 Performing a job step that has been instantiated from an operation s tep to which the certification has
been assigned

How Audit Certifications Work

Audit certifications can be assigned to certain actions to require that one or more us ers at or above a
predefined certification level sign off on the action to complete it. Sign-offs can be required to:
 Approve running a job t hat has been instantiated from an operation to which an audit certification has
been assigned.
 Approve performing a job step that has been instantiated from an operation step to which an audit
certification has been assigned.
 End a job if the item it is producing has been assigned an audit certification.
 Approve the rec ording of a data log. Data log certifications can be assigned to a data log group that
is being assigned to:
o An operation, to enable dat a logging for any jobs that are instantiated from the operation
o An operation step, to enable dat a logging for any job steps that are instantiated from the
operation step

166 Version 6.1

Certifications MES Client User Guide

o A job directly. Such a job could have been instantiated from an operation that does not have a
data log group assigned to it, or a job that was manually added to a work order.
o A job step directly. Such a job step could have been instantiated from an operat ion step that
does not have a dat a log group assigned to it, or a job step that was manually added to a job.

Certification Levels
Certification levels work as follows:
 A maximum level is defined for a certification. This value determines how many certification levels
there are for the certification. A value of 5 means that us ers can be assigned a level of 1 through 5 for
the certification.
 Each user that is assigned to a certification is assigned a level for that certification.
 When a certification is assigned to an action, the certification level that is required to perform that
action (for an access certification) or to sign off on the action (for an audit certification) is defined.
For example, say level 2 is defined for an access certification when it is assigned to an item that can
be produced. Only users who are at level 2 or higher for that certification will be able to run a job that
can produce that item.
Or, say level 3 is defined for an audit certification when it is assigned to an operation step. Only users
who are at level 3 or higher for that certification will be able to sign off on a job step that is instantiated
by the operation step to complete it.
To illustrate with a practical example, let's say there is an Goods Inspection audit certification for item
production and that there are three levels of users who could possibly perform the inspection, depending
on the item: Associate Operator (level 1), Operator (level 2), and Senior Operator (level 3).
 When the Goods Inspection certification is assigned to items for which the inspection is less critical,
the level might be set at 1. This would allow Associate Operators, Operators, or Senior Operators t o
sign off on the production.
 When the Goods Inspection certification is assigned to items for which the inspection is more critical,
the level might be set at 2. This would allow only Operators or Senior Operators to sign off on the
production.
 When the Goods Inspection certification is assigned to very critical items, the level might be set at 3.
This would require that a Senior Operator sign off on the production.

Creating a Certification
1. From the Operations Management group in the Navigation pane, open the Certifications module.
2. Do one of the following:
 In the tab, right-click and click New.
 Press Ctrl+N.
 On the Home ribbon group, click New and then click New Certification.
A new certification record appears.
3. In the Properties pane, complete the property settings.
For a description of the properties, see Certification Properties on page 168.
4. Save your changes.

Version 6.1 167

MES Client User Guide Certifications

Certification Properties
Name
The unique name for the certification.
The name cannot be edited once the certification is added and saved.
Max level
Defines the maximum number of qualification levels for this certification.
A value of 1 means that there is one level: any users that are assigned to the certification are
qualified. This is because any user that is assigned to a certification must have at least the minimum
value of 1 defined as their level.
A value of 2 or more means that different levels of user qualification can be applied to an action that
has the certification.
Audit
Cont rols whether the certification is an access or audit certification.
If not selected, the certification is an access certification. It restricts user access to performing
certain actions, as described in How Access Certifications Work on page 166.
Also, if the Audit option is not selected, the sign-off properties are hidden, the Available to
Attribute s property is available, and the Available to Log Data property is not available.
If selected, the certification requires that the action to which it is assigned requires one or more
users to perform a sign-off to complete the action, as described in How Audit Certifications Work on
page 166.
Also, if the Audit option is selected, the sign-off properties appear, the Available to Attribute s
property is not available, and the Available to Log Data property is available.
Permanent
If selected, the qualification for any users who are assigned to this certification never expires.
If not selected, the Expires after property appears.
Expires after (days)
Appears only if the Permanent option is not selected.
The maximum number of days at which the certification expires for a us er once the certific ation is
assigned to the user.
The actual expiration date for the user is entered in the user's Expiry column on the Users tab. The
actual dat e can be any date between the current dat e and the date that is the number of days entered
here after the current date. For example, if the value entered here is 365, then the certification's
expiry date for a user that is assigned on May 1 can be any date from May 1 to April 30 of the
following year.
Available to Operations
If selected, this certification can be assigned to operations.
Available to Operation Steps
If selected, this certification can be assigned to operation steps.
Available to Producing Items
If selected, this certification can be assigned to items that are produced.
Available to Consuming Items
If selected, this certification can be assigned to items that are consumed.

Note: Consuming Items certifications are currently not implemented.

Available to Attribute s
A vailable only if the Audit option is not selected.

168 Version 6.1

Certifications MES Client User Guide

Note: Attribute certifications are currently not implemented.

Available to Log Data

A vailable only if the Audit option is selected.
If selected, this certification can be assigned to a data log group when it is assigned to an operation,
operation step, or job step created for a job.
Number of Signoffs Required
Appears only if the Audit option is selected.
Defines how many qualified users must sign off on an action to which this certification is assigned for
the action to be completed.
Requires Signoff Comment
Appears only if the Audit option is selected.
If selected, a user that is signing off on an action to which this certification is assigned must ent er
comments to complete the certification sign-off.
Signoff Note s
Appears only if the Audit option is selected.
Enter notes here that will be displayed in the certification sign-off window for the user to read prior to
signing off. An example is a description of the requirements that must be met to qualify the action for
sign-off.
Cert_Type spare 1 to Cert_Type spare 4
Optional, user-definable fields for this certification.

Assigning a Certification to Users

1. In the Certifications module, select the certification to be assigned.
2. Do one of the following:
 In the Users tab, right-click and click Add Link.
 On the Current View ribbon group, click Add Link.
The Select User dialog appears. The MES users who have not already been assigned to the
certification are listed.
If using OS Group security mode, you can add other users to this list by clicking the Add button. This
function is similar to the functionality for adding users as described in Setting Up User Groups and
Users in OS Group Securit y Mode on page 45. The selected user will be added to the MES
database. However, there is no verification that the us er belongs to a valid MES OS Group. If the
selected user is not a member of an OS Group defined in the MES database, the user will not be able
to log into any MES application.
3. Select the users to which to assign the certification.
4. Click OK.
The selected users are listed in the Users tab.
5. For each user entry, complete the property settings.
Level
Defines the user’s qualification level for this certification.
Expiry
Defines the date when the user’s certification expires. The date entered can be from the current date
up to the number of days from the current date, specified by the Expires after (days) property entry
for the certification.

Version 6.1 169

MES Client User Guide Certifications

This property is blank for permanent certifications.

6. Save your changes.
To remove a certification from a user
 Right -click the user in the Users tab and click Delete Link.

Assigning Certifications to Actions

Once certific ations have been added and assigned to users, you can assign them to the following:
 Operations. See Assigning Certifications to an Operation on page 184.
 Operation steps. See Assigning Certifications to an Operation Step on page 194.
 Items that are produced or consumed. See Assigning Certifications to an Item on page 122.
 For audit certifications only, data logging for an operation, operation step, or job step. See Assigning
Data Log Groups to an Operation on page 187, Assigning Data Log Groups to an Operation Step on
page 200, or Assigning Data Log Groups to a Job Step on page 268.

Deleting a Certification
Deleting a certification also removes it from any ope ration, operation step, item, or data log group to
which it is assigned.
1. Select the certification
2. Do one of the following:
 Right -click the certification and click Delete.
 Press Delete.
 On the Home ribbon group, click Delete.
You are prompted to confirm the deletion.
3. Click Yes.
You are notified that the certification record was deleted from the system.
4. Click OK.

170 Version 6.1

 MES Client User Guide

C HAPTER 25
Processes
In This Chapter
Introduction to Processes ............................................................................................................ 171
Applying Filters ........................................................................................................................... 173
Workflow for Creating Processes ................................................................................................. 174
Creating a Process Class ............................................................................................................ 175
Setting the Process Level ............................................................................................................ 177
Setting the Process Status .......................................................................................................... 177
Assigning Items to a Process....................................................................................................... 178
Assigning an Attribute to a Process .............................................................................................. 179
Adding an Operation to a Process................................................................................................ 180
Adding a Standard Operation to a Process ................................................................................... 211
Creating a Route Map ................................................................................................................. 212
Checking Out and Checking In a Process..................................................................................... 213
Cloning a Process....................................................................................................................... 214
Copying a Process...................................................................................................................... 214
Verifying a Proc ess ..................................................................................................................... 215

Introduction to Processes
You can use the Proce sse s module to create and maintain a process and an operation. A process is a
logical representation of the performance of one or more operations utilizing one or more physical
entities for the purpose of producing an item. You can create a process to define the production met hod
to produce an item, and instantiate the work orders.
A process describes operations and steps required to manufacture an item. Processes are not used
directly to manufacture an item. Processes are used to create work orders that are instances of a
process. Work orders are used to manufacture an item. The use of processes in MES is optional as you
can creat e a work order directly using the Work Orders and Jobs module. Processes are required in the
MES Client application to assign certifications as y ou cannot assign a certification to a work order.
By default, the Processe s module is grouped under the Operations Management group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.

Version 6.1 171

MES Client User Guide Processes

A process is a method of producing an item. A process links an item that needs to be produced with
operations, steps, specifications, entities, and routings. A process determines the flow of material
between entities and operations.

When you open the Proce sse s module, the Current View tab appears on the ribbon.
The Current View tab includes the View group and the Diagrams group.
In the View group, the following commands are available:
Standard View
Shows the standard view. When you click Standard View, a list of all the available processes is
shown in the Editor window.
Group By Item
Shows a list of all the processes by item. When you click Group By Item, a list of item IDs of all the
available items is shown in the Edi tor window. Click the plus (+) symbol to expand an item and view
the list of processes assigned to that item.
Group By Proce ss Class
Shows a list of all the processes by class. When you click Group By Proce ss Cla ss, a list of the
process class IDs of all the available process classes is shown in the Editor window. Click the plus
(+) symbol to expand a process class and view the list of processes assigned to that class.
Group By Level
Shows a list of all the processes grouped by their level. Three levels are available for a process,
General, Site, or Master. You can assign group level t o a process while creating a process. For more
information on creating a process, see Creating a Process on page 176.
Group By Status
Shows a list of all the processes grouped by their status. Four statuses are available for a process:
Disabled, Experimental, Approved, or Certified. You can assign status to a process while creating a
process. For more information on creating a process, see Creating a Process on page 176.
In the Diagrams group, the following commands are available:

172 Version 6.1

Processes MES Client User Guide

View Relationships
Shows a graphical representation of the relationship between a process, an operation, a standard
operation, an item, and a process class.
View Route Map
Shows a graphical representation of the process with box es for Operations, entities within the
Operations, and the associated entities. For more information on viewing job route diagram, see
Viewing a Job’s Route Diagram on page 232.

Applying Filters
The Filter option in the Navigation pane lists the available processes, item classes, items, and
operations.
To filter a process
1. In the Navigation pane, click the Processe s module.
2. Select the required filter options from the Processe s, Operation Filters, Item Class Filter, and
Item Filter sections.
In the Proce ss section, the following filter options are available:
Process ID
Unique ID of the process.
Process Level
Level of the process.
Process Status
Status of the process.
Creator
Name of the operat or who created the process.
Checked out by
Name of the operat or who checked out the process.
Dynamic Routing
Type of proc esses to display. The following options are available:
o All: All processes including dynamic routing processes and normal processes.
o True: All dynamic routing processes.
o False: All normal processes.

In the Operation Filters section, the following filter options are available:
Operation ID
The unique ID of an operation within a proc ess.
Enti ty
An entity assigned to an operation of a process.
In the Item Class Filter section, the following filter options are available:
Item Class ID
The unique ID of the produced item class that is linked to a process.
Item Class De scription
A description of the produced item class that is linked to a process.
In the Item Filters section, the following filter options are available:

Version 6.1 173

MES Client User Guide Processes

Item ID
The unique ID of the produced item that is linked to a process.
Item Description
A description of the produced item that is linked to a process.
3. Click Apply Filter. The list of processes matching the filter is shown.

Arranging Columns
You can arrange the process information. The Field Chooser option limits and organizes the display of
data fields from all qualifying records. Field Choos er allows you to choos e what information about each
process is shown in the Proce ss module.
Changing width of a column in the workspace does not save the configuration of filter and column width.
The configuration is saved if you do one of the following: change a columns position, add or remove a
column, apply grouping to the grid, or change the sort order. For more information, see Customizing the
Columns Shown in the Tabbed Work space on page 23 and Sorting Information on page 24.
To change the selection of fields to be displayed
1. Click the Field Chooser icon at the top of the Editor window. The Field Chooser dialog box
appear.

2. Select or clear a check box to display or hide the columns.

Selected fields shows the data fields from each record that is currently displayed in the Editor window.

Workflow for Creating Processes

The workspace shows the process ID, process description, process class, and so on, for all the existing
processes.
Following is the work flow to create a new proc ess:
1. Creating a Process Class on page 175
2. Creating a Process on page 176
a. Setting the Process Level on page 177
b. Setting the Process Status on page 177
3. Assigning Items to a Process on page 178
4. Assigning an Attribute to a Process on page 179
5. Adding an Operation to a Process on page 180
6. Adding a Standard Operation to a Process on page 211

174 Version 6.1

Processes MES Client User Guide

7. Assigning an Entity to an Operation on page 189

8. Adding a File or Web Page to an Operation on page 181
You do not need to perform this step if you are adding a file or web page.
9. Assigning a BOM to an Operation on page 182
You do not need to perform this step if you are creating an item with no BOM.
10. Assigning Certifications to an Operation on page 184
You do not need to perform this step if you are not using certifications.
11. Assigning Data Log Groups to an Operation on page 187
You do not need to perform this step if you are not collecting dat a.
12. Assigning Steps to an Operation on page 190
You do not need to perform this step if you are not using steps.
13. Assigning Specifications to an Operation on page 204
You do not need to perform this step if you are not assigning operation specifications.
14. Assigning Attributes to an Operation on page 210
You do not need to perform this step if you are not assigning operation attributes.
15. Creating a Route Map on page 212
Repeat 7 to 14 for each operation in your proc ess. Steps 8 to 14 are optional.

Creating a Process Class

A process class contains processes with similar attributes.
You can create a new process class while creating a new process by specifying a process class ID for a
process. For more information on creating a process, see Creating a Process on page 176.
To create a process class
1. In the Navigation pane, click the Processe s module.
2. On the ribbon, click the Current View tab.
3. In the Standard View list, click Group By Proce ss Class.

A list of all the existing process classes is shown in the Editor window.
4. Right -click on the Editor window, and then click Insert Proce ss Cla ss. A new process class record
is shown in the Editor window.
5. In the Proce ss Cla ss ID box, type a unique ID for the process.
6. On the ribbon, click Save in the Main group to save the changes.

Version 6.1 175

MES Client User Guide Processes

Creating a Process
A process is a plan or template, which can be used to creat e work orders. For more information on work
order, see Work Orders and Jobs on page 237.
To create a process
1. On the Navigation pane, click the Processe s module.
2. On the ribbon, click New Process in the New list. A new process record appears in the Editor
window.
3. In the Properties pane, complete the property settings. See Process Properties on page 176.
4. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing process in the Properties pane.

Process Properties
Process Cla ss ID
The ID of the process class to which you want to assign the process. You can also type a new
process class name.
Process ID
A unique ID for the process. Process ID identifies the process in all MES data records, so must be
unique and is not editable after the process definition is first saved.
Description
A brief description or common name for the process.
Version
A version for the process. This property is used only in conjunction with the process class ID to
implement versioning.
Type the name that identifies your process in the Process Cla ss ID box, and then enter the required
version in the Version box. Select the Process I D box and MES combines those two values into a
unique process ID.
Level
The level at which to organize the processes. For more information on levels, see Setting the
Process Level on page 177.
Status list
The status for the process. For more information on statuses, see Setting the Process Status on
page 177.
Note s
Additional information about this process.
Dynamic Routing
Specifies whether this process is for produced items that require dynamic routing.
A dynamic route process is used to create jobs and work orders required to handle dynamic routing.
Dynamic routing processes are normally not complete processes that can creat e a product from
beginning to end, but rather "mini-processes" aimed at correcting a specific sort of defect from one or
more specific operations in the normal process used to create a product. For more information on
dynamic routing, see Dynamic Routing on page 217.
Once the process is saved, the Other Proce ss Property section is available. It includes the following
properties:
Creator
The name of the user who created the proc ess.

176 Version 6.1

Processes MES Client User Guide

Approver
The name of the person who approved the process.
Created At
The date and time when the process was created.
Last Editor
The name of the user who last edited the process.
Last Edit At
The date and time when the process was last edited.
Last user to change status
The name of the user who last changed the status of the process.
Last status change at:
The date and time when the status of the process was last changed.
Checked out by
The name of the user who currently has the process checked out.

Setting the Process Level

 In the Properties pane, select the level at which to organize the processes in the Level list.
Process levels are predefined. The following options are available in the list:
General
For processes with no limitations (top -level and overall usage). By default, General is selected.
General level proc esses consists of operations and steps with no entities assigned to the operation.
You can clone the General operations and assign entities to them to create site level processes. You
can also assign other entity specific properties to the process such as entity specification.
Site
For site-specific variations (plant, region, and so on). You can clone the Site level Processes and
assign items to the process to create master level processes that can be instantiat ed into jobs.
Master
For equipment-s pecific variations (cell, manufacturing line, set of entities, and so on).

Note: General and Site processes should not be instantiated into work orders.

Setting the Process Status

To set the status for a process
 On the Propertie s pane, select the status for the proc ess in the Status list.
Process statuses are predefined. This also determines, whether this process can be us ed as a work
order in conjunction with system parameters (Lowest level process that can be used). By default,
Di sabled is selected. For more information, see the descripti on for the General system parameter
Lowest level proc ess that can be instantiated in the table in System Parameters Reference on page 341.
The following options are available in the list:
Di sabled
Status level that cannot instantiate a work order. When you create a process, the default status of a
process is Disabled. You cannot instantiate a disabled process.
Experimental
Lowest status level that can instantiate a work order. Instantiation can be excluded by the system
settings.

Version 6.1 177

MES Client User Guide Processes

Approved
Middle status level that can instantiate a work order. Instantiation can be excluded by the system
settings.
Certified
Highest status level that can instantiate a work order at all installations. System parameter settings
can prevent editing and deletion of certified processes and limit a process class to one certified
process.
You can configure the following General system paramet ers that are related to the process certification
level:
 May not delet e or modify the components of a certified process
 Disallow deletion of a process that derives from a certified process
 May only have one certified process in a process class
 Cloned certified process status if only one certified process is allowed
 How t o automatically downgrade a certified process version
For more information on General system parameters, see the table in System Parameters Reference on
page 341.

Assigning Items to a Process

A process can be instantiat ed into a work order. A process must have the following:
 At least one linked item
 At least one operation with one entity assigned to the oper ation
 A routing specified if there is more than one entity
Each item that is linked to a process has its own process status. By default, the status of a linked item is
the same as the status of a process. The status of an item must have the minimum required status before
a work order is created from the process to produce the item as defined in the Lowest level process that
can be instantiated parameter. An item can have the status as certified for t he process while another item
has the status as experimental.
You can link multiple items to a process to produce an item.
To add an item to a process
1. On the Editor window, check out the process to which y ou want to link an item. For more information
on checking out a process, see Check ing Out and Check ing In a Process on page 213.

178 Version 6.1

Processes MES Client User Guide

2. On the Item s to Produce section of the Propertie s pane, click the + icon to add an item to the
process. The Add Item dialog box appears.

3. On the upper pane, create a filter to limit the number of items returned and then click Apply Filters.
To reset the filters, click Clear Filters.
4. On the lower pane, select an item and then click OK to set the item produced by the work order.
5. Click OK. The selected item is shown in the Item to Produce section.
6. In the Status list, click the status for the added item.
By default, status of a process is assigned to an item. You cannot assign a higher status to an item
than the status of linked process. If the status of a process is lower than status of the linked item,
then status of all items that have higher status is lowered to match the status of the process. For
example, if you change status of the process from Approved to Disabled, then status of all the items
associated to that process is changed to Disabled regardless of the original status.
7. In the Proce ss Rank list, click the rank for the process.
A process rank specifies the capability of a process to produce an item. If an item is linked to more
than one process, the process with lowest rank for that item is considered as the most preferred
process for producing the item.
8. On the ribbon, click Save in the Main group to save the changes.

Assigning an Attribute to a Process

An attribute is an additional user-defined property. You can add attributes to a process to provide more
information about the process to the users of the MES system.
To add an attribute to a process
1. On the Editor window, click the process to which you want to add an attribute, and then click
Attribute s tab.
2. On the ribbon, click the Current View tab.
3. On the Attribute s group, click Add Attribute s.

Version 6.1 179

MES Client User Guide Processes

The Add attribut es dialog box appears.

4. Select the attribute you want to add and click OK.
You can add multiple attributes to a process.
5. In the Value box, type the value for the added attribut e.
6. In the Note s box, type any additional information for the attribute.
7. On the ribbon, click Save in the Main group to save the changes.

Adding an Operation to a Process

An operation represents a phase of a proc ess and specifies the consumption and production proportion.
One or more entities are utilized to perform an operation. An operation can have specifications and
sub-operation step groups.
To create an operation
1. On the Editor window, check out the process for which you want to create an operation.
For more information on checking out a process, see Check ing Out and Check ing In a Process on
page 213.
2. Select the process.
3. On the ribbon, click New Operation on the Process Management group.
A new operation record is shown on the Editor window.

4. In the Properties pane, complete the properties. See Operation Properties on page 180.
5. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing operation in the Propertie s pane.

Operation Properties
Operation ID
A unique ID for the operation. Operation ID identifies the operation in the MES data records, so must
be unique within operations. Operation ID is not editable after the operation definition is first saved.

180 Version 6.1

Processes MES Client User Guide

Description
A brief description or a name for the operation.
Type
Additional information to classify the operation.
Default reject rate%
The percentage of the production quantity that is estimated to be rejected during this operation (that
is, the percentage of produced mat erial that fails to meet production requirements). This percent age
is used to calculate the jobs’ starting quantity given the work order starting quantity. A value of 10 is
interpreted as 10%.
File
You can add a file or a web page to an operation to support the operator during production. For
example, a file or web page can contain information relative to performing the jobs that are
instantiated from the operation. When a user is running a job using an application such as MES
Operator, the files and web pages will be available to them for viewing.
See Adding a File or Web Page to an Operation on page 181.
Note s
Additional notes about this operation.
Operation Cost
The cost for this operation. Operation cost defines the estimated cost of completing this operation in
monetary units.
Oper spare 1 to Oper spare 4
User-defined information about the operation.
Dynamic Routing Code
The dynamic routing code for this operation. The dynamic routing code of the operation is used to
re-introduce the rework ed product into the originating process. You can also type a new dynamic
routing code.
Di splay Sequence
The sequenc e in which you want to display this operation within the proc ess diagram.
BOM
You can configure the BOM information for an operation if you have an item or items assigned to the
process that have BOMs associated with them. You can select the item being produced by the
operation, which can be different from the item produced by the process.
See Assigning a BOM to an Operation on page 182.
Certification
You can assign certifications to an operation to manage who can run jobs that are instanti at ed from
the operation and whether a sign-off is required to complete a job.
See Assigning Certifications to an Operation on page 184.
DataLog Property
You can assign one or more dat a log groups to an operation to allow users to collect measurement
data about production when running jobs that are instantiated from the operation.
See Assigning Data Log Groups to an Operation on page 187.

Adding a File or Web Page to an Operation

You can add a file or a web page to an operation to s upport the operator during production. For example,
a file or web page can contain information relative to performing the jobs that are instantiated from the
operation. When a user is running a job using an application such as MES Op erator, the files and web
pages will be available to them for viewing.

Version 6.1 181

MES Client User Guide Processes

To add a file
1. Click the Browse button to the right of the File property box.
The File or URL dialog box appears.

2. Click Add File.

The Open dialog box appears.
3. In the file type list, select All files.
4. Navigate to and select the file to be added, and then click Open.
The file is entered in the File property box.

To add a web page

1. Click the Browse button to the right of the File property box.
The File or URL dialog box appears.

2. Click Add URL.

A mini-web browser appears.

3. Enter or navigat e to the web page, and then click OK.

The URL is entered in the File property box.

Assigning a BOM to an Operation

You can configure the BOM information for an operation if you have an item or items assigned to the
process whic h have BOMs associated with them. You can select the item being produc ed by the
operation, which can be different from the item produced by the process.

Note: The last operation in t he process must produce the item as defined to be produced by the process.

182 Version 6.1

Processes MES Client User Guide

You can also configure the consumption information for an operation. You can specify consumed items
and the consumed quantity of an item during an operation. If more than one item is linked to the process,
then you need to set up the BOM information for each item separately.
You can link a BOM item to an operation to specify where the BOM components are consumed. When
you link a BOM item to an operation, all pr oduced items, BOM versions, and BOM components of that
BOM item are linked to that operation. You can link multiple BOM items to an operation.
You must create a BOM in the Items module before configuring the BOM in the Proce sse s module. For
more information on creating a BOM, see Creating a BOM for an Item on page 128.
You cannot delet e a BOM component from the Proce sse s module. If you want to delete a BOM
component, you can use the Items module. For more information on items, see Items on page 117.
To configure an operation BOM
1. On the Editor window, check out the process to which the operation is assigned. For more
information on checking out a process, see Check ing Out and Check ing In a Process on page 213.
2. Select the operation of which you want to change the properties of the BOM item.
3. On the Propertie s pane, click BOM, and then click Configure Operation Output.
The BOM Items dialog box appears. The BOM Item s dialog box shows the BOM items that are
linked to the selected process.
You must link an item to the process in the Processe s module before configuring an operation BOM
link. For more information on linking an item to a process, see Assigning Items to a Process on page
178.
4. Right -click a BOM item on the BOM Item s dialog box, and then click Set as Produced Item.

You must have more than one produced item in the BOM tree.
5. On the Propertie s pane, click Configure Operation BOM.
The BOM dialog box appears.

6. On the BOM dialog box, complete the following settings:

Version 6.1 183

MES Client User Guide Processes

Item Produced in this Operation

The item and BOM version that you want to configure. All the item and BOM version combinations
shown in the list are linked to the operation.
Percent to Start
The percent age quantity of items that must be reported as produced by the previous operation
before this operation’s job state is set to Ready.
BOM Position
The BOM position of the components or by-products for the selected item or BOM version.
Quantity
The quantity of the BOM item to be consumed or produced during the selected proc ess per unit of
production.
Qty at Operation
The quantity of the BOM item to be consumed or produced during the selected operation per unit of
production.
Remaining
The quantity of the BOM item that can be cons umed or produced by other operations per unit of
production.
7. On the ribbon, click Save in the Main group to save the changes.

Assigning Certifications to an Operation

You can assign certifications to an operation to manage who can run jobs that are instantiat ed from the
operation and whether a sign-off is required to complete a job that is instantiated from the operation.
If an acce ss certi fication has been assigned to an operation, a user cannot start a job that is
instantiated from the operation or start a work order that is created from a process that includes the
operation unless the following conditions have been met:
 The user has been assigned to the certification.
 The user's certific ation level is at or higher than the level specified when the certification was
assigned to the operation.
If an audit certification has been assigned to an operation, then one or more use r sign-offs will be
required to complete any jobs instantiated from the operation. Only users whose certific ation level is at or
higher than the level specified when the certification was assigned to the operation can perform a
sign-off.
For information about configuring certifications, see Certifications on page 165.
To assign a certification to an operation
1. In the Editor window, select the operation.
2. Open the Certifi cation group in the Properties pane.

184 Version 6.1

Processes MES Client User Guide

3. Click the Configure Certifi cations button.

The Certi fications dialog box appears.

4. Right -click in the Certifications dialog box, and then click Add.
The Add Certifications dialog box appears. Any certifications that have been configured to be
applicable to operations are listed.
The Audit column is read-only. If the c heck box is selected, the certification is an audit certification. If
not, it is an access certification.

5. Select the certifications to be assigned to the operation and click OK.

Version 6.1 185

MES Client User Guide Processes

The selected certifications are listed on the Certifi cations dialog box.

6. For each certification, select the level required for this operation in the Value column list.
If the level is Yes or No, it is not editable because the certification has only one level. Instead, these
values indicate whet her the current user has been ass igned to the certification.
7. Click Close to close the Certifications dialog box.
The selected certifications are listed in the Certification property group.

8. Save the changes.

To edit the level of certifications
1. Click the Configure Certifi cations button to open the Certi fications dialog box.
2. Modify the levels as needed, then click Close.
3. Save the changes.
To remove a certification assignment from the operation
1. Click the Configure Certifi cations button to open the Certi fications dialog box.
2. Right -click the certification and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.

186 Version 6.1

Processes MES Client User Guide

4. Click Close to close the Certifications dialog box.

5. Save the changes.

Assigning Data Log Groups to an Operation

You can assign one or more data log groups to an operation to allow users to collect measurement data
about production. Data log groups are created and managed using the MES Supervisor application.
When assigning a data log group to an operation, you can c onfigure the group to acquire periodic data.
You can also assign an audit certification to a data log group to require one or more qualified users to
sign off on the data being logged.
To assign data log groups to an operation
1. In the Editor window, select the operation.
2. Open the DataLog Property group in the Properties pane.

3. Click the Edit button.

The Data Log Group dialog box appears.

4. Right -click in the Data Log Group dialog box, and then click Add.

Version 6.1 187

MES Client User Guide Processes

The Add Data Log Groups dialog box appears. A vailable data log groups are listed. Groups that
have been previously assigned to the operation are already selected.

5. Select the groups to be assigned to the operation and click OK.

The selected groups are listed on the Data Log Group dialog box.

6. For each group, complete the property settings.

Periodic Data Collection
Specifies whether periodic updates of data are enabled. If selected, data is collected periodically at
the trigger period that is defined.
Trigger Type
A vailable only if the Periodic Data Collection check box is selected.
The trigger type for periodic data collection. Select whether the collection period is in minutes or
hours (hourly).
Trigger Detail
A vailable only if the Periodic Data Collection check box is selected.
The number of minutes or hours to wait between each periodic data collection operation.
Data Confirmation Required
Specifies whether data collection requires a certification for sign-off.
Certification
A vailable only if the Data Confirmation Required option is selected. Select the audit certification for
the data log group.
If an audit certification is selected here, then one or more qualified users will be required to sign off to
complete the data logging.

188 Version 6.1

Processes MES Client User Guide

7. Click Close to close the Data Log Group dialog box.

The selected groups are listed on the DataLog Property property group.

8. Save the changes.

To edit data log group properties
1. Click the Edit button to open the Data Log Group dialog box.
2. Modify any of the group properties as needed, then click Close.
3. Save the changes.
To remove a data log group from the operation
1. Click the Edit button to open the Data Log Group dialog box.
2. Right -click the group and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.
4. Click Close to close the Data Log Group dialog box.
5. Save the changes.

Assigning an Entity to an Operation

You must assign at least one entity to an operation.
You must also set the estimated production rat e for each entity assigned to an operation.

Note: The estimated production rate must be greater than 0. An entry of 0 will caus e an error.

The estimated production rate is used with the batch size to schedule an entity while creating a work
order from a process. The required finish date is assigned to the jobs in the last operation and then the
estimated production rat e, batch size, and work order quantity are used to determine the start time of a
job. The same process runs until all jobs get a start and finish date. If an operation is the first operation in
a process, the batch size specifies the initial amount that is sent to an entity if there is more than one
entity in the operation. For additional information about batch size, see Understanding Batches and Lots
for OEE and Estimated Times on page 74.
To assign an entity to a operation
1. In the Editor window, select the operation to which you want to assign an entity.
2. Right -click the Entity tab, and then click New.

Version 6.1 189

MES Client User Guide Processes

A new entity record is shown in the Entity window.

3. In the Properties pane, complete the following settings:

Enti ty
Click the Brow se button to locate the entity that you want to assign to the operation.
Estimated Production Rate
The estimated production rate for this job. It defines the estimated production rat e of entity usage
required by this operation to produce a single batch of the item on this entity. You also set the
production rate UOM that can be in hours/batch, minutes/batch, and seconds/batch, or
batches/hour, batches/minute, and batches/second format.
The estimated production rate must be greater than 0. An ent ry of 0 will cause an error.
Estimated Labor Rate
The estimated number of labor hours required to produce a single batch of the item in the selected
entity.
Estimated Entity Setup Hours
The estimated number of hours for setting up the entity.
Estimated Entity Teardown Hours
The estimated number of hours required to tear down this entity after a production run.
Estimated Fixed Labor Hours
The estimated number of fixed labor hours required to produce a single batch of the item in the
selected entity. This fixed rate is the work required that does not depend on the number of batches.
Estimated Transfer Time
The estimated number of hours required to move the produced items from the selected entity to the
next entity.
Batch Size
The batch size. The batch size defines the number of production units in a single batch for this item,
based on the company standards. For additional information about batch size, see Understanding
Batches and Lots for OEE and Estimated Times on page 74.
Initial Production% Required
The percentage of the initial quantity of material that will be allocated to this entity for a production to
run.
The total percentage for all entities assigned to the first operation should be equal to 100%. A value
of 25 in this field means 25%.
4. On the ribbon, click Save in the Main group to save the changes.

Assigning Steps to an Operation

You can assign steps to an operation so that tracking of the discrete operator work or actions within an
operation can be controlled and sequenced.

190 Version 6.1

Processes MES Client User Guide

Individual steps are assigned to step groups. Thes e step groups can be defined as repeatable so that an
operator is allowed to perform the steps multiple times if necessary and the system will track the events
for the individual steps within the step group. Non -repeatable step groups contain steps that only need to
be performed once in the operation, such as setup and teardown steps. Repeatable step groups contain
steps that must be performed for every batch or group of work against a job at an operation.

An additional feat ure of the steps functionality is a sequence number for the steps and the step groups.
You must specify an order by providing the sequence number for the step groups and steps. This
sequence number controls the order that the work must be performed. A higher numbered step cannot
start until a lower numbered step within a step group is completed. This sequence also controls the same
control of ordering for step groups. In the case where step groups have the same sequence number,
then steps in the groups can be performed in any order. The same applies to the case where steps have
the same sequence number; the steps can then be performed in any order.

Creating an Operation Step Group

A step group repres ents a set of one or more sub-operation steps. You can define multiple step groups
for an operation.
To create an operation step group
1. In the Editor window, select the operation for which you want to create a step group.
2. Right -click the Steps tab, and then click New Step Group. A new step group record is shown in the
Steps tab.
3. In the Properties pane, complete the following settings:
ID
The unique ID of the operation step.
Description
A brief description for the step group.
Sequence
The sequenc e for the step group. The sequenc e number determines the order in which step groups
are exec uted. All steps in a lower number step group must be completed or bypassed before any
step in a higher number step group starts. You can assign the same sequence number to step
groups that can be performed simultaneously.
Repeatability
Specifies whether the steps contained in this step group can be repeated for each lot produced.
4. On the ribbon, click Save in the Main group to save the changes.

Version 6.1 191

MES Client User Guide Processes

Creating an Operation Step

A step represents a phase of an operation. A step definition can include the production of a by -product,
consumption of a component, a data collection, an attached file, a certification, or instruct ions to exclude
a step when the operation is running on a specific entity, and so on.
Steps are added to step groups, so you must create a step group before creating a step. For more
information, see Creating an Operation Step Group on page 191.
To create a step
1. In the Editor window, click the operation for which you want to creat e a step.
2. On the Steps tab, right-click the step group to which you want to add the step and then click New
Step. A new step record is shown in the Steps tab.
3. In the Propertie s pane, complete the property settings. See Operation Step Properties on page 192.
4. On the ribbon, click Save in the Main group to save the changes.

Operation Step Properties

Number
The unique number for the step.
Name
A unique name for the step.
Sequence
The sequence number for the step. The sequence number determines the order in which the step is
performed within the step group.
SPC Char
The SPC characteristic that needs to be meas ured at this step.
Form Name
Click the Brow se button to locate the name of the form linked to this step, if any.
Reorder Step Sequence
Specifies whether to reorder the current step sequence automatically. The reorder step sequence
allows you to insert a step into an existing set of steps. All steps with a sequence number equal to or
greater than this step will have their sequence number inc reased by one.
Description
A brief description for the step.
Action Type
The action that this step needs to perform. The following options are available in the list:
o Normal: No specific action is performed.
o Log Data: Selects the Data Log tab to facilitate data collection.
o Add Production: Allows you to add production details for this step to facilitate the reporting of
production quantities.
o Add Consumption: Allows you to add consumption details for the first component assigned to
this step.
o Operator Acknowledge: Displays the step description and requires the operator to
acknowledge this prompt before continuing work.
o Enter Form Data: Allows you to fill details in a specific form.
o Enter SPC Data: Allows an operator to add SPC data when the operator logs onto this step.

192 Version 6.1

Processes MES Client User Guide

Complete When
The circumstance in which the current step are automatically marked as Complete. The following
options are available in the list:
o Standard Time Elapsed: When the time entered in the Standard Time box is elapsed counting
from the beginning of the step.
o Operator Accepts: When an operator marks the step as Accepted/Complete.
o Di smi ss Me ssage: This option is available if the Action is set to Operator Acknowledge. The
step ends when the operator dismisses the dialog.

Standard Time
The standard completion time for this step.
Step Occurrence %
The number how many times the step must be done for a run of production. For an operation’s step,
it is percent because there is no fixed amount of production you are doing. For a job’s step, the step
occurrence is a fixed number. When a work order is created from a process, the required quantity is
multiplied by the step occurrence percentages to get the step occurrences for the job.
Step Grp ID
The step group ID to which you want to assign the step.
Allow Bypass
Specifies whether this step can be skipped.
Enter Data
Specifies whether the user must enter text into the Data box before changing the state of the step as
Accepted or Complete. If you select this option, you must also specify how the data will be entered in
the Advanced Options section.
Advanced Options: Select Way Data Is Entered
The method to use to enter the required data: text box, radio buttons, check box, or combo box.
This setting is enabled if the Enter Data check box is selected.
Depending on which element is selected, anot her property setting appears for specifying the data
entry choices.
o If Text Box is selected, the Select Data Type list appears. It has the following options:
String/ Text, Analog, and DateTime.

If you select the Analog, you also need to define the high and low limits to specify whether an
alert should be issued when the value is outside these limits.
o If Check Box is selected, the Specify Label box appears. Type the label for the check box
option.

Version 6.1 193

MES Client User Guide Processes

o If Radio Buttons is selected, the Define Buttons section appears. Type a name for a radio
button option and then click the + button to add that option. Multiple radio button options can be
included. To remove an option, select it and then click the – button.

o If Com bo Box is selected, the Define List section appears. Type the name of an entry to add to
the combo box list and then click the + button to add that entry to the list. Multiple list entries can
be included. To remove an ent ry, select it and then click the – button.

Spare Fields: Spare1–6

User-defined information about the step.
Certification
You can assign certifications to an operation step to manage who can perform the job steps that are
instantiated from the operation step and whether a sign-off is required to complete a job step.
For more information, see Assigning Certifications to an Operation Step on page 194.
Exclusions
The entities that you want to exclude from this step. When you creat e a work order from a process,
jobs are creat ed for each entity linked to an operation and job steps are created for all the jobs for all
the steps assigned to the operation. If you specify that an entity is excluded from a step, that step is
not included in a job for the excluded entity.
Files
You can add files and web pages to an operation step to support the operator during production. For
example, a file or web page can contain information relative to performing the job steps that are
instantiated from the operation step. When a user is performing the job step using an application
such as MES Operator, the files and web pages will be available to them for viewing.
For more information, see Adding Files and Web Pages to an Operation Step on page 197.
DataLog Property
You can assign one or more dat a log groups to an operation step to allow users to collect
measurement data about production when performing job steps that are instantiated from the
operation step.
For more information, see Assigning Data Log Groups to an Operation Step on page 200.

Assigning Certifications to an Operation Step

You can assign certifications to an operation step to manage who can perform the job steps that are
instantiated from the operation step and whether a sign-off is required to complete a job step.

194 Version 6.1

Processes MES Client User Guide

If an acce ss certi fication has been assigned to an operation step, a user cannot start or work on the
instantiated job step unless the following conditions have been met:
 The user has been assigned to the certification.
 The user's certific ation level is at or higher than the level specified when the certification was
assigned to the step.
If an audit certification has been assigned to an operation step, then one or more user sign-offs will be
required to complete the instantiated job step. Only us ers whose c ertification level is at or higher than the
level specified when the certification was assigned to the step can perform a sign-off.
For information about configuring certifications, see Certifications on page 165.
To assign a certification to an operation step
1. In the Editor window, select the operation step.
2. Open the Certifi cation group in the Properties pane.

3. Click the Configure Certifi cation button.

The Certi fications dialog box appears.

4. Right -click in the Certifications dialog box, and then click Add.
The Add Certifications dialog box appears. Any certifications that have been configured to be
applicable to operation steps are listed.

Version 6.1 195

MES Client User Guide Processes

The Audit column is read-only. If the c heck box is selected, the certification is an audit certification. If
not, it is an access certification.

5. Select the certifications that you want to assign to the operation step and click OK.
The selected certifications are listed on the Certifi cations dialog box.

6. For each certification, select the level required for this operation step in the Value column list.
If the level is Yes or No, it is not editable because the certification has only one level. Instead, these
values indicate whet her the current user has been assigned to the certification.
7. Click Close to close the Certifications dialog box.

196 Version 6.1

Processes MES Client User Guide

The selected certifications are listed on the Certifi cation property group.

8. Save the changes.

To edit the level of certifications
1. Click the Configure Certifi cation button to open the Certifications dialog box.
2. Modify the levels as needed, then click Close.
3. Save the changes.
To remove a certification assignment from the operation step
1. Click the Configure Certifi cation button to open the Certifications dialog box.
2. Right -click the certification and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.
4. Click Close to close the Certifications dialog box.
5. Save the changes.

Adding Files and Web Pages to an Operation Step

You can add files and web pages to an operation step to support the operator during production. For
example, a file or web page can contain information relative to performing the job steps that are
instantiated from the operation step. When a user is perfo rming the job step using an application such as
MES Operator, the files and web pages will be available to them for viewing.
To add files to an operation step
1. In the Files property group, click the Configure Files button.

Version 6.1 197

MES Client User Guide Processes

The Files dialog box appears.

2. Right -click in the dialog box, and then click Add files.
The Open dialog box appears.
3. In the file type list, select All files.
4. Navigate to and select the files to be added, and then click Open.
The selected files are listed in the Files dialog box.

5. Optionally, add a description for each file in the De scription column.

6. Add other files (or web pages) as needed.
7. When you are finished adding files, click Close.
The files are listed in the Files property group.

8. Save the changes.

198 Version 6.1

Processes MES Client User Guide

To add web pages to an operation step

1. In the Files property group, click the Configure Files button.

The Files dialog box appears.

2. Right -click in the dialog box, and then click Add URL.
The Add URL dialog box appears.

3. Enter the URL for and a description of the web page.

Instead of manually entering the URL, you can click the Browse button at the right of the URL box
and use the mini-browser window that appears to navigate to the web page.

Click OK and that web page's URL is entered on the Add URL dialog box.

Version 6.1 199

MES Client User Guide Processes

4. When you have finis hed entering the URL and description, click Close.
The URL is listed in the Files dialog box.

5. Add other web pages (or files) as needed.

6. When you are finished adding web pages, click Close.
The web page URLs are listed in the Files property group.

7. Save the changes.

To remove a file or URL
1. In the Files property group, click Configure Files.
The Files dialog box appears.
2. Right -click the file or URL, and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.

Assigning Data Log Groups to an Operation Step

You can assign one or more data log groups to an operation step to allow users to collect measurement
data about production when performing job steps that are instantiated from the operation step. Dat a log
groups are creat ed and managed using the MES Supervisor application.
When assigning a data log group to an operation step, you can configure the group to ac quire periodic
data. You can also assign an audit certification to a data log group to require one or more qualified users
to sign off on the data being logged.
To assign data log groups to an operation step
1. In the Editor window, select the operation step.

200 Version 6.1

Processes MES Client User Guide

2. Open the DataLog Property group in the Properties pane.

3. Click the Edit button.

The Data Log Group dialog box appears.

4. Right -click in the Data Log Group dialog box, and then click Add.
The Add Data Log Groups dialog box appears. A vailable data log groups are listed. Groups that
have been previously assigned to the operation step are already selected.

5. Select the groups that you want to assign to the operation step and click OK.

Version 6.1 201

MES Client User Guide Processes

The selected groups are listed on the Data Log Group dialog box.

6. For each group, complete the property settings.

Periodic Data Collection
Specifies whether periodic updates of data are enabled. If selected, data is collected periodically at
the trigger period that is defined.
Trigger Type
A vailable only if the Periodic Data Collection check box is selected.
The trigger type for periodic data collection. Select whether the collection period is in minutes or
hours (hourly).
Trigger Detail
A vailable only if the Periodic Data Collection check box is selected.
The number of minutes or hours to wait between each periodic data collection operation.
Data Confirmation Required
Specifies whether data collection requires a certification for sign-off.
Certification
A vailable only if the Data Confirmation Required option is selected. Select the audit certification for
the data log group.
If an audit certification is selected here, then one or more qualified users will be required to sign off to
complete the data logging.
7. Click Close to close the Data Log Group dialog box.
The selected groups are listed on the DataLog Property property group.

8. Save the changes.

202 Version 6.1

Processes MES Client User Guide

To edit data log group properties

1. Click the Edit button to open the Data Log Group dialog box.
2. Modify any of the group properties as needed, then click Close.
3. Save the changes.
To remove a data log group from the operation step
1. Click the Edit button to open the Data Log Group dialog box.
2. Right -click the group and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.
4. Click Close to close the Data Log Group dialog box.
5. Save the changes.

Copying a Step
You can copy multiple steps from one operation to another.
To copy steps
1. On the Editor window, select the operation to which you want to paste steps.
2. On the ribbon, click the Current View tab.
3. On the Proce ss Management group, click Copy Steps From in the New Operation list.
The Copy Steps dialog box appears.

4. On the upper pane, select the operation from which you want to copy the steps.
5. On the lower pane, select the step you want to copy, and then click OK.
6. On the ribbon, click Save in the Main group to save the changes.

Version 6.1 203

MES Client User Guide Processes

Assigning Specifications to an Operation

You can assign multiple specification versions to an operation. However, you can de fine only one version
as the preferred version. The preferred specification version is used when a process is started. All
operations in a process use that same specification version. A specification version can cont ain multiple
specifications. While creating a work order from a process, the specifications from a specification version
are used to creat e a job specification for the jobs.
By default, the specification version marked as the preferred version is used for an operation in the
process. You can change a specification version if you have the May override preferred spec. version
privilege.
You must create a global specification before assigning specification to a specification version.
You can assign the following specifications to an operation:
 Entity specifications
 BOM specifications
 Item and item class specifications
For more information on specifications, see Global Specifications on page 153.
You can assign an entity specification to an entity. An entity specification changes to a job specification
while creating a job for that entity or for a descendant of that entity. If the same specification is assigned
to both a parent and a child entity, then the specific ation assigned to the child entity overrides the
specification assigned to a parent entity while creating a job specification.
You can assign a BOM specification to a BOM position for a BOM version of an item. BOM specification
changes to job specification while creating a job that uses the specified BOM version to create the
specified item.
You can assign an item or item class specification to an item that is produced or consumed during an
operation. You can also assign an item to an item class. Item or item class specification changes to job
specification while creating a job that produces or consumes that item or an item in that item class. If the
same specification is assigned to both an item and an item class, the item overrides the item class. If the
same specification is assigned to both a BOM item and an item, the BOM item overrides the item.
You can add specific ations for BOM items, entities, and item classes. If an operation is inserted from a
standard operation and you have defined the entity specification for the standard operation, you are able
to view the entity specifications in the P roce sse s module. You must add specifications for a BOM or item
class in the Process module once the operation is associated to a process as a standard operation does
not contain BOM or item class specifications.

Creating a Specification
1. On the Editor window, check out the process to which the operation belongs. For more information
on checking out a process, see Check ing Out and Check ing In a Process on page 213.
2. Select the operation for which you want to create a specification.
3. On the ribbon, click the Current View tab.
4. On the Specs tab, click New Specification Version. A new operation specification version record is
shown in the Specs tab.

5. On the Propertie s pane, complete the following settings:

204 Version 6.1

Processes MES Client User Guide

Version
A version number for the specification.
Preferred Version
Specifies whether to make this version of the specification the preferred version.
Description
A brief description for the specification version.
6. Click Save to save the specification.

Adding a BOM Specification

1. On the Specs tab, select a specification.
2. Do one of the following:
o On the Propertie s pane, click BOM Spec in the BOM Spec section.
o On the ribbon, click the Current View tab and then in the Specification group click BOM
Specification.
The BOM Specifications dialog box appears.

3. Right -click the upper pane of the BOM Specifications dialog box, and then click Add. The BOM
Items dialog box appears.

Version 6.1 205

MES Client User Guide Processes

You can select a BOM item in the upper pane and the specification assigned to the selected BOM
item in the lower pane. Specifications are linked to the BOM position.

4. Select the BOM item, and then click OK.

You can select the BOM items that are highlighted in the list.
5. Right -click the lower pane of the BOM Specifications dialog box, and then click
AddSpecifications. The Add Specifications dialog box appears.
6. Select the specification in the Add Specifications dialog box, and then click OK.
You can select multiple specifications for a BOM position.
7. In the BOM Specifications dialog box, complete the property settings. See Specification Properties
on page 208.
8. When you have complet ed the property settings, click Close.
9. On the ribbon, click Save in the Main group to save the changes.

Adding an Entity Specification

1. On the Specs tab, select a specification.
2. Do one of the following:
o On the Propertie s pane, click Entity Specifications in the Entity and Step Specification
section.
o On the ribbon, click the Current View tab and then in the Specification group click Entity
Specifications.

206 Version 6.1

Processes MES Client User Guide

The Entity Specifications dialog box appears.

3. Right -click the Entity Specifications dialog box, and then click New Specifications. The Add
Specification dialog box appears.

4. Select the specification, and then click OK.

5. In the Entity Specifications dialog box, complete the property settings. See Specification
Properties on page 208.
6. When you have complet ed the property settings, click Close.
7. On the ribbon, click Save in the Main group to save the changes.

Adding an Item Specification

To add an item specification
1. On the Specs tab, select a specification.
2. Do one of the following:

Version 6.1 207

MES Client User Guide Processes

o On the Propertie s pane, click Item Specifications in the Item Class and Item Specification
section.
o On the ribbon, click the Current View tab and then on the Specification group click Item
Specifications.
The Item Specifications dialog box appears.

3. Right -click the upper pane of the Item Specifications dialog box, and then click Add. The
Add/Delete Specification dialog box appears.

4. Select the item or item class, and then click OK.

5. Right -click in the lower pane of the Item Specifications dialog box, and then click New
Specification. A new item specification version record is shown in the Item Specifications dialog
box.
6. In the Item Specifications dialog box, complete the property settings. See Specification Properties
on page 208.
7. When you have complet ed the property settings, click Close.
8. On the ribbon, click Save in the Main group to save the changes.

Specification Properties
Enti ty
For an entity specification, the entity to which the specification applies.
Step No
The step number of the step to which to optionally link the specification.

208 Version 6.1

Processes MES Client User Guide

You must specify the step number for the specification or select No Step if this specification applies
to the complete operation.
Group
The specification group.
Specification
The specification ID.
Description
The description of the specification.
Data Type
The data type for the specification.
Value
The value for the specification.
Min Value
The minimum value for the specific ation.
Max Value
The maximum value for the specification.
Units
The units for the specification.
File
You can add a file or web page to a specification to support an operat or during production. For
example, the file or web page can contain information relative to a BOM, entity, or item specification,
such as how to set the setpoint value (represented by the specification) for the entity.
See Adding a File or Web Page to a Specification Being Added to an Operation on page 209.
Comments
Comments about this specification.
Acce ss Level
The security access level required to modify the specification.
To edit a specification, you must have Specification access level user privilege greater than or equal
to the level set for the specification.
Spec spare 1–4
User-defined information for this specification.

Adding a File or Web Page to a Specification Being Added to an Operation

You can add a file or web page to a specification to support an operator during production. For example,
the file or web page can contain information relative to a BOM, entity, or item specification, such as how
to set the setpoint value (represented by the specification) for the entity.
To allow users to open a file or web page that has been added to a specification, you can use the
following MES Stateful AP I Documents class methods in a custom application:
 EditFile()
 PrintFile()
 ViewFile()
To add a file
1. In the Specification dialog box, click the Browse button in the specification's File column.

Version 6.1 209

MES Client User Guide Processes

The File or URL dialog box appears.

2. Click Add File.

The Open dialog box appears.
3. In the file type list, select All files.
4. Navigate to and select the file to be added, and then click Open.
The file is entered in the File column.

To add a web page

1. In the Specification dialog box, click the Browse button in the specification's File column.
The File or URL dialog box appears.

2. Click Add URL.

A mini-web browser appears.

3. Enter or navigat e to the web page, and then click OK.

The URL is entered in the File column.

Assigning Attributes to an Operation

An attribute is an additional user-defined property that provides additional information about the
operation.
You must first create operation attribut es in the Attribute s module so that they can be assigned to a
standard operation. For more information on creating attributes, see Attributes on page 107.
An attribute that is assigned to an operation changes to an attribute on a job created from an operation if
there is a corresponding job attribute. Attributes are not used directly in a process but can be used to sort
and search a work queue.

210 Version 6.1

Processes MES Client User Guide

To assign an attribute to an operation

1. In the Editor window, select the operation.
2. Right -click the Attributes window, and then click Add.
The Add attribut es dialog box appears. Operation attribut es that have not been assigned to this
operation are listed.
3. Select the attributes to be assigned and click OK.
4. On the ribbon, click Save in the Main group to save the changes.

Cloning an Operation
You can clone an existing operation to create a copy of the operation on which to base a new one. The
operation BOM and steps linked to the existing operation are inherited by the new operation.
To clone an operation
1. In the Editor window, click the operation that you want to clone.
2. On the ribbon, click the Current View tab.
3. In the Proce ss Management group, click Clone in the New Operation list.
The Clone Oper To dialog box appears.
4. In the Clone Oper To dialog box, complete the following settings:
Process ID
The process ID for the operation.
Operation ID
A unique operation ID for the operation.
Operation Description
A brief description for the operation.
5. Click OK.

Adding a Standard Operation to a Process

You can add a standard operation to a proc ess. It creates an operation, using a standard operation as a
template, for the selected process.
To add a standard operation to a process
1. On the Editor window, check out the process for which you want to add a standard operation. For
more information on checking out a process, see Check ing Out and Check ing In a Process on page
213.
2. On the ribbon, click the Current View tab.

Version 6.1 211

MES Client User Guide Processes

3. On the Proce ss Management group, click Insert Standard Operations in the New Operation list.
The Insert Standard Operations dialog box appears.

4. On the Insert Standard Operations dialog box, click the standard operation ID you want to add to
this process in the Standard Operation ID list.
5. In the New Operation ID box, type a unique operation ID for the operation.
6. In the New Operation Description box, type a brief description or name for the operation.
7. In the Di sp Seq box, type the display sequence for the operation.
To add multiple operations to a process, press Enter, and then add another operation.
8. Click OK when all standard operations are configured. For more information on operation, see
Adding an Operation to a Process on page 180.
You must create a standard operation before adding standard operation to a process. For more
information on creating a standard operation, see Creating a Standard Operation on page 222.

Creating a Route Map

You can view route map for a proc ess with multiple operations. You can also view the flow of material
from entities within an operation to entities within other operations. You can drag and drop an entity from
one operation to the next and modify the percentages, if required.
You need to create a route map if a process contains more than one operation. A route map describes
the flow of material through a process. You can creat e a route by drawing lines from the entities in a
source operation to the entities in a destination operation. You must draw a line from every entity in the
source operation to every entity in the destination operation.
Each routing line has a percentage associated with it that determines the amount of material that flows
from one entity to another. You can change the percentage of any line to any number between 0 and
100, but the total of all the lines leaving an entity must add up t o 100 percent. If you have a source
operation with two entities and a destination operation with two entities, you would draw four route lines.
If one of the destination entities is faster, you may need to adjust the percentages leaving your source
entities so that 60 percent of the material from each of the source entities goes to the faster destination
and 40 percent of the material from the source entities goes to the slower entity.

212 Version 6.1

Processes MES Client User Guide

You can have multiple source operations linked to one destination operat ion. For example, if you have a
process to make filled cookies, you may have an operation to make the top of the cookie, an operation to
make the filling, and an operation to make the bottom of the cookie. All thes e operations to make cookies
run in parallel. These three operations can send their output to an operation that combines them t o make
a cookie.
You can also have one source operation linked with multiple destination operations. If you had a process
to build wagons, you may have an operation to produce wheels that feed another operation to produce
the front wheel assembly and anot her operation that produces the rear wheel assembly.

Note: You must create a route map for a process before creating a work order from it.

To create a route map

1. Select the process of to view its route map on the Editor window.
2. On the ribbon, click the Current View tab.
3. In the Diagrams group, click View Route Map.
The route map appears in a tab in the Editor window.

4. Create a route map bet ween two jobs in entities operations by selecting the entity in the source
operation and dragging to the entity in the destination operation.
All entities in the source operation must be link ed to all entities in the destination operation. If an
operation sends output to more than one entity in a destination operation, you can edit the percentage of
material for each route line by:
 Clicking on the box in the route line and changing the number
 Clicking on the source entity and changing the values in the grid.
The total value for all the route lines leaving an entity should be 100 percent.

Checking Out and Checking In a Process

The General system parameter Use check -in/check -out for process? must be selected to enable the
check in or check out feature. If it is selected, then the process must be checked out to edit it. For more
information on General system parameters, see the table in S ystem Parameters Ref erence on page 341.
A new process is automatically checked out by the current user.
To check out a process
1. In the Editor window, click a process that you want to check out.
2. On the ribbon, click the Current View tab.
3. In the Change Management group, click Check Out.
The green icon appears in the Check Out column that indicates that the selected process is checked
out.
To check in a process
1. In the Editor window, click a process that you want to check in.

Version 6.1 213

MES Client User Guide Processes

2. On the ribbon, click the Current View tab.

3. In the Change Management group, click Check In.
The green icon is removed from the Check Out column that indicates that the selected process is
checked in.

Closing the Process Window with Processes Checked Out

When closing the Proce ss window, if the Supervisor system parameter Prompt for check in when closing
Process window? is selected and a process is checked out, a message appears telling you to check -in
any checked-out processes. By default, this parameter is selected. For more information on Supervisor
system parameters, see the table in S ystem Parameters Reference on page 341.

Cloning a Process
You can clone an existing process to create a new process. A cloned process contains all the process
properties, operations, operation steps, jobs, attributes, certifications, BOM, entities, and links
associated with the parent process. You can change the values as required.
You can also copy a process. However, copying a process copies only the process properties, not the
operations, operation steps, jobs, attributes, certifications, BOM, entities, and links associated with the
parent process. See Copying a Process on page 214.
To clone a process
1. In the Editor window, check out the process that you want to clone. For more information, see
Check ing Out and Check ing In a Process on page 213.
2. Select the process that you want to clone in the Editor window.
3. On the ribbon, click the Current View tab.
4. In the Proce ss Management group, click Clone in the New Operation list.
The Clone Proce ss dialog box appears.
5. In the Clone Process dialog box, complete the following settings:
Process ID
A unique process ID for the process. The process ID identifies the process in the MES data records,
so it must be unique and is not edit able after the process definition is first saved.
Description
A brief description or name for the process.
Di ssociate Items
Specifies whether to clone the process without item linkage.
If the Di ssociate Items check box is selected, the items linked to the original process are not be
linked to the cloned process.
6. Click OK.
7. On the ribbon, click Save in the Main group to save the changes.
8. Check in the process.

Copying a Process
You can copy an existing process to create a new process. A copied process contains all of the process
properties. These are the properties that are included as columns in t he Proce sse s tab. Y ou can change
the property values as required.

214 Version 6.1

Processes MES Client User Guide

Copying a process does not copy the operations, operation steps, jobs, attributes, certifications, BOM,
entities, and links associated with the parent process. However you can copy these components of a
process by cloning the process. See Cloning a Process on page 214.
To copy a process
1. In the Editor window, check out the process that you want to copy. For more information, see
Check ing Out and Check ing In a Process on page 213.
2. Select the process that you want to copy in the Editor window.
3. On the ribbon, click Copy in the Home group, then click Paste.
A copy of the process is opened in a New Process tab.
4. Change the process properties as needed.
5. On the ribbon, click Save in the Main group to save the changes.
6. Check in the process.
The new process is added to the list in the Processe s tab.

Verifying a Process
You can verify the selected process for any invalid or circular links that allow you to create a work order
properly.
1. On the Editor window, click a process that you want to verify.
2. On the ribbon, click the Current View tab.
3. On the Proce ss Management group, click Verify Process.
A confirmation message appears for the successful verified process.
An error message appears in the Error Li st pane if the process is not valid. You must fix any invalid or
circular links to create a valid process.

Version 6.1 215

 MES Client User Guide

C HAPTER 26
Dynamic Routing
In This Chapter
Introduction to Dynamic Routing .................................................................................................. 217
Dynamic Routing Codes .............................................................................................................. 217
The Dynamic Routing Workspace ................................................................................................ 218
Creating a Dynamic Routing Usage ............................................................................................. 219

Introduction to Dynamic Routing

You can use the Dynamic Routing Usage module to correct the production by routing to rework
operations. The dynamic routing processes are configured to accommodate rework, to rectify a defect.
The additional rework operations are organized into dynamic routing processes. A dynamic routing
process is used dynamically at run time based on the report ed production.
Rework jobs are created during the operation of the dynamic routing process.
You can use the dynamic routing process to correct any defects that occurs while executing operations in
either a normal process, or a dynamic routing process. A dynamic routing process is not used to
manufacture a product from beginning to end.
You can use the following criteria to use dynamic routing process to create dynamic routing jobs and the
amount of current production to be allocat ed for such jobs:
 Item reason reported for the production (a reason that represents a defect)
 Routing code associated wit h the current job
 Item that is manufactured by the current job
 Process from which a work order is created

Dynamic Routing Codes

A routing code identifies an instance in the manufacturing process where you need to include a dynamic
routing process. Routing codes are associated with a process, a work order that is created from the
process, and jobs that are created from the work order. If multiple operations or jobs contain similar
defects, you can use the same routing code for all such operations or jobs.
The choic e of the dynamic routing process depends on the routing code of the producing job and the item
reason entered for production. This choice can also depend on the originating process and/or the item
that is produc ed.
The routing code also defines an operation or job that corresponds to a process from which the dynamic
routing has initiated. The output of the last operation or job in the dynamic route is returned to this
process.
Definition of an operation or a job depends on the type of the dynamic routing process. If a dynamic
routing process is complete, the output is not returned to the originating proc ess. Example, a proces s
used to produce a final item.

Version 6.1 217

MES Client User Guide Dynamic Routing

If the item produced by the last job in the dynamic route is not the final output, the item must be
reintroduced into the work order, subsequent to the job from whic h the dynamic route is originated. The
routing code identifies such jobs.
Dynamic routing processes are configured in the Processe s module. You can also define the number of
times the dynamic routing process can be performed for an identifiable unit of production.
You must do the following to use the dynamic routi ng functionality:
 Select the Dynamic Routing check box in the Proce sse s module to specify a process as a dynamic
routing process. For more information on processes, see Creating a Process on page 176.
 Select or create a Dynamic Routing Code while configuring an operation within a process to
specify the dynamic routing process to start at run time. For more information on operation, see
Adding an Operation to a Process on page 180.
The Dynamic Routing Usage module lists the combinations of item reasons, and originating routing
codes that initiate the dynamic routing process. It also includes the item ID that is produced and the
process from which the work order is originated. The item re asons describe reasons for the dynamic
routing process.
By default, the Dynamic Routing Usage module is grouped under the Operations Management group
in the Navigation pane. For more information on groups and modules, see Groups and Modules on
page 29.

The Dynamic Routing Workspace

The workspace shows the status, reason description, originating routing code, originating process ID,
item ID, dynamic routing processes ID.

The Filter option in the Navigation pane lists the available dynamic routing processes.
To filter a dynamic routing process
1. In the Navigation pane, click the Dynamic Routing Usage module. The following filter options are
available:
Reason Description
A brief description of the work order.
Originating Routing Code
The originated dynamic routing code.

218 Version 6.1

Dynamic Routing MES Client User Guide

Orig. Process I D
The process ID of the process from which the dynamic routing originated.
Item ID
The unique ID of the item.
2. Click Apply Filter. The list of dynamic routing processes matching the filter is shown.

Creating a Dynamic Routing Usage

You can create a new dynamic routing process to be implemented, if a product is produced with defect,
or requires alternative processing. You can also creat e a new dynamic routing process based on th e
criteria identified in the Dynamic Routing Usage module.
One or more jobs are started from the relevant dynamic routing process for a defective product or from a
portion of the production that requires alternative processing. If started the job matches with an identical
set of existing stopped rework jobs for dynamic routing, the processing of new produced product may be
added to these existing dynamic routing jobs depending on the dynamic routing system parameters. For
more information on dynamic routing system paramet ers, see the "Dynamic Routing" section of the table
in System Parameters Reference on page 341.
You can add the remaining jobs of the originating process to the new process for dy namic routing, if
required.
To create a dynamic routing usages
1. On the ribbon, click New Dynamic Routing Usage in the New list. A new dynamic routing us age
record is displayed in the workspace.
2. In the Properties pane, complete the following settings:
Reason Description
The reason that triggers the dynamic routing process. Click the Browse button to select a reason
from a list of available reasons.
Originating Routing Code
The originating routing code. Leave this setting blank to create a new originating routing code.
Routing codes are substitutes for operation IDs and are used to group routing activities. A routing
code can be applied to multiple operations.
Orig Proce ss ID
The ID of t he process on whic h this routing code is dependent. The originating process ID defines the
process from which the dynamic routing process originates.
Item ID
Click the Brow se button to locate the item that the process uses.
You must link at least one item to a dynamic routing proc ess before using the process in the
Dynamic Routing Usage module. This is required because the system cannot create jobs from a
process that does not produce any items. For more information on linking an item to a process, see
Assigning Items to a Process on page 178.
Dynamic Routing Proce ss ID
The dynamic routing process ID for the new routing code.
Max Dynamic Routes
The maximum dynamic routes value. The maximum dynamic routes times defines the number of
times the same dynamic routing process can be performed on a unit of production.
If a dynamic routing process exceeds the Max Dynamic Routes value, the user is notified that the
production cannot be processed alternatively. If the selected item reason is not a scrap reason, the
transaction to add production fails and rolls back and the user must select another reas on.

Version 6.1 219

MES Client User Guide Dynamic Routing

Re-entry Route Code

The dynamic routing code of the operation to whic h you want to reint roduce the current product.
If the system is configured to identify a dynamic route as a separate work order, the dynamic route
reason codes must be set up as scrap reasons. These dynamic route parts are not processed further
in the original work order. If the system is configured to identify dynamic route as part of the original
work order, the dynamic route reas on codes must be set up as good production reasons. These
dynamic route parts are processed further in the original work order.
3. On the ribbon, click Save in the Main group to save the changes.

220 Version 6.1

 MES Client User Guide

C HAPTER 27
Standard Operations
In This Chapter
Introduction to Standard Operations ............................................................................................. 221
Creating a Standard Operation .................................................................................................... 222
Standard Operation Properties .................................................................................................... 222
Assigning Entities to a Standard Operation ................................................................................... 223
Assigning Steps to a Standard Operation ..................................................................................... 224
Adding a Specification Version to a Standard Operation ................................................................ 225
Assigning Attributes to a Standard Operation ................................................................................ 227
Cloning a Standard Operation...................................................................................................... 227

Introduction to Standard Operations

You can create standard operations for those operations that are used frequently for different operations.
The standard operation can than be added to any process in whic h it is used (see Adding a Standard
Operation to a Process on page 211). This allows you to avoid having to recreate the operation for each
process and to maintain the standard operation in one place.
You use the Standard Operations module to create and maintain a standard operation.
With a standard operation, you can:
 Assign entities, attributes, specification versions, entity specifications, and certifications to an
operation.
 Define step groups and steps for an operation.
 Edit the data log group values.
Standard operations do not have items associated with them, so you cannot assign BOM definitions,
BOM item specifications, or item specifications to a standard operation.
The Standard Operations module is grouped under the Operations Management group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.
Standard operations are used as templates to quickly and easily create similar operation definitions
throughout a process.
You can add an operation directly to a process without referring to a standard operation. Standard
operations save configuration time when the same operation is used multiple times within a process or
the same operation is used by multiple processes.

Version 6.1 221

MES Client User Guide Standard Operations

The workspace shows the operation ID, description, class, and so on for all the existing standard
operations.

Creating a Standard Operation

A standard operation contains the same information as an operation, except a standard operation is not
attached to a specific process and does not contain a Bill Of Materials (BOM).
You can use a standard operation in the Proce ss module aft er defining a standard operation. For more
information on inserting a standard operation in a process, see Adding a Standard Operation to a
Process on page 211.
To create a standard operation
1. On the ribbon, click New Standard Operation in the New list.
A new standard operation is shown in the Editor window.
2. In the Properties pane, complete the properties. See Standard Operation Properties on page 222.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing standard operation in the Propertie s pane.

Standard Operation Properties

Operation ID
A unique ID for the operation. The operation ID identifies the operation in the MES data records, so it
must be unique within standard operations. The operation ID is not editable after the operation
definition is first saved.
Description
A brief description for the operation. It can be a common name for the operation.
Type
An optional operation type grouping. This is used in custom reporting.

222 Version 6.1

Standard Operations MES Client User Guide

Default reject rate%

The percentage of the production quantity that is estimated to be rejected during this operation (that
is, the percentage of produced mat erial that fails to meet production requirements). This percent age
is used to calculate the jobs’ starting quantity given the work order starting quantity. A value of 10 is
interpreted as 10%.
File
You can add a file or a web page to an operation to support the operator during production. For
example, a file or web page can contain information relative to performing the jobs that are
instantiated from the operation. When a user is running a job using an application such as MES
Operator, the files and web pages will be available to them for viewing.
Adding a file or web page to a standard operation is similar to adding it to an operation. S ee A dding a
File or Web Page to an Operation on page 181.
Note s
Additional notes for the standard operation. This is an optional field.
Operation Cost
The cost for this operation. This value specifies the estimated cost of completing an operation in
monetary units.
Oper spare 1 to Oper spare 4
Additional information about the operation.
Certification
For assigning certifications to the operation.
If an access certification is assigned to an operation, any operators who have been assigned to the
certification and have the required certification level for the operation are allowed to start or work on
jobs that have been instantiated from the operation. If audit certifications are assigned to the
operation, all sign-offs required by the certi fication must be performed before the any of the jobs
instantiated from it can be complet ed.
Assigning certifications to a standard operation is similar to assigning them to an operation. For more
information, see Assigning Certifications to an Operation on page 184.
DataLog Property
For assigning data log groups to the operation. When a data log group is assigned to an operation, a
user can record data for the group's values.
Assigning dat a log groups to a standard operation is similar to assigning them to an operation. For
more information, see Assigning Data Log Groups to an Operation on page 187.

Assigning Entities to a Standard Operation

You must assign at least one entity to a standard operation.
You must also set the estimated production rat e for each entity assigned to an operation.

Note: The estimated production rate must be greater than 0. An entry of 0 will caus e an error.

The estimated production rate is used with the batch size to schedule an entity while creating a work
order from a process. The required finish date is assigned to the jobs in the last operation and then the
estimated production rat e, batch size, and work order quantity are used to determine the start time of a
job. The same process runs until all jobs get a start and finish date. If an operation is the first operation in
a process, the batch size specifies the initial amount that is sent to an entity if there is more than one
entity in the operation. For additional information about batch size, see Understanding Batches and Lots
for OEE and Estimated Times on page 74.
To assign an entity to a standard operation
1. In the Editor window, select the standard operation to which you want to assign an entity.

Version 6.1 223

MES Client User Guide Standard Operations

2. Right -click the Entity tab, and then click New. A new entity record is shown in the Entity window.

3. In the Properties pane, complete the following settings:

Enti ty
Click the Brow se button to locate the entity that you want to assign to the operation.
Estimated Production Rate
The estimated production rate for this job. It defines the estimated production rat e of entity usage
required by this operation to produce a single batch of the item on this entity. You also set the
production rate UOM that can be in hours/batch, minutes/batch, and seconds/batch, or
batches/hour, batches/minute, and batches/second format.
The estimated production rate must be greater than 0. An ent ry of 0 will cause an error.
Estimated Labor Rate
The estimated number of labor hours required to produce a single batch of the item in the selected
entity.
Estimated Entity Setup Hours
The estimated number of hours for setting up the entity.
Estimated Entity Teardown Hours
The estimated number of hours required to tear down this entity after a production run.
Estimated Fixed Labor Hours
The estimated number of fixed labor hours required to produce a single batch of the item in the
selected entity. This fixed rate is the work required that does not depend on the number of batches.
Estimated Transfer Time
The estimated number of hours required to move the produced items from the selected entity to the
next entity.
Batch Size
The batch size. The batch size defines the number of production units in a single batch for this item,
based on the company standards. For additional information about batch size, see Understanding
Batches and Lots for OEE and Estimated Times on page 74.
Initial Production% Required
The percentage of the initial quantity of material that will be allocated to this entity for a production to
run.
The total percentage for all entities assigned to the first operation should be equal to 100%. A value
of 25 in this field means 25%.
4. On the ribbon, click Save in the Main group to save the changes.

Assigning Steps to a Standard Operation

You can assign steps to an operation so that tracking of the discrete operator work or actions within an
operation can be controlled and sequenced.

224 Version 6.1

Standard Operations MES Client User Guide

Individual steps are assigned to step groups. Thes e step groups can be defined as repeatable so that an
operator is allowed to perform the steps multiple times if necessary and the system will track the events
for the individual steps within the step group. Non -repeatable step groups contain steps that only need to
be performed once in the operation, such as setup and teardown steps. Repeatable step groups contain
steps that must be performed for every batch or group of work against a job at an operation.
Assigning steps to a standard operation is similar to assigning steps to an operation. For more
information, see Assigning Steps to an Operation on page 190.

Adding a Specification Version to a Standard Operation

An operation can have multiple specification versions, but only one version can be defined as the
preferred version. The preferred version is used by default to create job specification when a work order
is created from a process. You must create a global set of specifications in the Global Specifications
module before adding a specification to an operation. For more information on specifications, see Global
Specifications on page 153.
To add a specification version to a standard operation
1. In the Editor window, click the standard operation for which you want to create a specification.
2. Right -click the Specs tab, and then click New Specification Version.
A new operation specification version record is shown in the Specs tab.

3. In the Properties pane, complete the following settings:

Version
The version number for the specification.
Preferred Version
Specifies whether this version is the preferred version of the specification.
Description
A brief description for the specification.
4. Click Save to save the spec version.
5. In the Entity and Step Specification section, click Entity Specifications.

Version 6.1 225

MES Client User Guide Standard Operations

The Entity Specifications dialog box appears.

6. Right -click the Entity Specifications dialog box, and then click New Specification.
The Add Specification dialog box appears.
7. Select the specification you want to add to this standard operation, and then click OK.
8. For the specification entry, complete the following settings:
Enti ty
The entity to which the specification applies.
Step No
The step number to optionally link a specification to a step. Select No Step to specify that the
specification applies to complete operation.
Group
The specification group.
Specification
The specification ID.
Data Type
The data type for this specification.
Value
The value for the specification.
Min Value
The minimum value for the specific ation.
Max Value
The maximum value for the specification.
Units
The units for the specification.
File
You can add a file or web page to a specification to support an operat or during production. For
example, the file or web page can contain information relative to a BOM, entity, or item specification,
such as how to set the setpoint value (represented by the specification) for the entity.
Assigning a file to a specific ation that is being added to a standard operation is similar to performing
this task for an operation. See Adding a File or Web Page to a Specification Being A dded to an
Operation on page 209.
Comments
Comments for this specification.

226 Version 6.1

Standard Operations MES Client User Guide

Acce ss Level
The security access level for modifying the specification.
To edit a specification, you must have Specificatio n access level user privilege greater than or equal
to the Edit level of that specification. For more information, see Assigning Specifications to an
Operation on page 204.
9. On the ribbon, click Save in the Main group to save the changes.

Assigning Attributes to a Standard Operation

An attribute is an additional user-defined property that provides additional information about the
operation.
You must first create operation attribut es in the Attribute s module so that they can be assigned to a
standard operation. For more information on creating attributes, see Attributes on page 107.
To add an attribute to a standard operation
1. In the Editor window, select the standard operation.
2. Right -click the Attributes window, and then click Add.
The Add attribut es dialog box appears. Operation attribut es that have not been assigned to this
operation are listed.
3. Select the attributes to be assigned and click OK.
4. On the ribbon, click Save in the Main group to save the changes.

Cloning a Standard Operation

You can clone an existing standard operation to create a copy of t he standard operation on which t o base
a new one.
To clone a standard operation
1. Right -click the standard operation you want to clone, and then click Clone.
The Clone Standard Operation dialog box appears.
2. In the Operation ID list, click the operation ID for the operation.
3. In the Operation Description box, type a brief description for the operation.
4. On the ribbon, click Save in the Main group to save the changes.

Version 6.1 227

 MES Client User Guide

C HAPTER 28
Job Queue
In This Chapter
Introduction to the Job Queue...................................................................................................... 229
Job and Step States.................................................................................................................... 229
Applying Filters to the Job Queue ................................................................................................ 230
Arranging Columns in the Job Queue ........................................................................................... 232
Viewing a Job’s Route Diagram ................................................................................................... 232
Creating a Work Order from a Process from the Job Queue Module .............................................. 233
Splitting Jobs .............................................................................................................................. 233
Editing Selected Jobs.................................................................................................................. 234
Creating Links for a Job Queue ................................................................................................... 234
Deploying a Queue Sequence ..................................................................................................... 235

Introduction to the Job Queue

You can use the Queue module to maintain jobs.
By default, the Queue module is grouped under the Order Management group in the Navigation pane.
For more information on groups and modules, see Groups and Modules on page 29.
Each row in the job queue displays a job. A job is a unique combination of work order, operation, and
sequence number. A step represents a phase of a job. The Queue module is used to modify properties of
a job, such as limited modification of the available job states and step states.

Job and Step States

Job states report the status of a job, such as running and ready. Step states report the status of a job step
or execution of job steps. The job queue is also used to prioritize work and order the list of work available
to an operat or.
The job state is utilized in MES Client, MES Web Portal, and MES Operator. The step state is utilized in
MES Operator.
The following states are available to both jobs and steps in the MES applications:
New
A job that is new and not started yet. Depending on the user’s privileges, this might restrict a user
from starting the job in the MES Operator application. A step in the job’s step sequence that follows
the current, Ready or Running, step.
Ready
A job/step that is ready to start. This indicates that the requirements for running this job/step are met.
For example, this may indicate that a upstream job has met the pieces produced requirement to start
this job, or that this is the first job of a work order and all consumable BOM (Bill of Material)
components are available.
Running
A job/step that is currently running in production.

Version 6.1 229

MES Client User Guide Job Queue

Complete
A job/step that is finished. For example, this may indicate t hat required quantity is produced, all steps
are complete, and all required data is entered.
The following states are available only to jobs:
Suspended
A job that is paused temporarily. For example, a user at a shift change suspends a job so that the
next shift user can log in and continue running the job.
OnHold
A job that is paused indefinitely. For ex ample, this may indicate that there are material or machine
issues.
Cancelled
A job that was creat ed and then stopped before completion. For example, this may indicate a
customer canceled a work order for a job that is scheduled and start ed running.
Job queue provides visibility to all scheduled jobs in the system. You can find details about eac h job,
including start and required quantities, physical entity on which a job is scheduled, and job status.

When you open the Queue module, the Current View tab appears on the ribbon.
In the View group, the following commands are available:
Save as default
You can save the configured job queue lay out as default for all users.
Save to logged-in
You can save the configured job queue lay out as default for the logged in user.
Revert to default
Click Revert to default to revert to the default settings.

Applying Filters to the Job Queue

The Apply Filter allows you to cont rol and limit the jobs shown in the job queue. Changes to this filter are
saved for the current us er, so that each user can easily access the required information. The Filter option
in the Navigation pane lists the available jobs in the workspace.
To filter an entity
1. In the Navigation pane, click the Queue module.
2. Select the required filter options from the Queue, Filters, and/or Job States section. See Job
Queue Filter Options on page 231.
3. Click Apply Filter. The list of jobs that match the filter is shown in the Queue module.
You can refresh the filter tree by collapsing and expanding it.

230 Version 6.1

Job Queue MES Client User Guide

Job Queue Filter Options

You can specify filter options from the Queue, Filters, and/or Job State s section of the filter.
In the Queue section, the following filter options are available:
Set per Operator
Shows the entities to which the operator has access rights.
Enti ties
When one or more entities are selected in the entity tree, job queues are shown for the jobs created
for the selected entity in the Editor window. If no entity is selected in the entity tree, jobs from all the
entities’ job queues are shown.
In the Filters section, the following filter options are available:
Work Order ID
Unique ID of the work order wit hin a job.
Operation ID
Unique ID of the operation within a job.
Sequence No
Sequence number of the job.
Item ID
Unique ID of the produced item within a job.
Item Description
Description of the produced item within a job.
Show first jobs only
Jobs marked as the first job (initial operation).
In the Job State s section, the following filt er options are available:
New
Shows new jobs.
Running
Shows running jobs.
Suspended
Shows suspended jobs.
Cancelled
Shows canceled jobs.
Ready
Shows ready jobs.
Complete
Shows complete jobs.
On Hold
Shows jobs that are on hold.
Number of hours the jobs were last Cancelled
Shows the jobs where the time of job cancelation is less than the number of hours specified from the
current time. Jobs that have there state as Cancelled appear in the filter.
Number of hours the jobs were last Completed
Shows the jobs where the time of job completion is less than the number of hours specified from the
current time. Jobs that have there state as Complete appear in the filter.

Version 6.1 231

MES Client User Guide Job Queue

If you select more than one job state, jobs currently in those states are shown in the Editor window. If no
state is selected, jobs in all states are shown.

Arranging Columns in the Job Queue

You can arrange the job queue information.
Changing width of a column in the job queue does not save the configuration of filter and column width.
The configuration is saved if you do one of the following: change a column’s position, add or remove a
column, apply grouping to the grid, or change the sort order. For more information, see Customizing the
Columns Shown in the Tabbed Work space on page 23 and Sorting Information on page 24.
The Field Chooser option limits and organizes the display of data fields from all qualifying records. Field
Chooser allows you to choose what information about each job is shown in the job queue.
Attributes assigned to items and/or jobs are available for display in the job queue. The attribute names
will appear in the Arrange Columns window for you to display in the location of your choice, if required.
To change the selection of fields to be displayed
1. Click the Field Chooser icon at the top of the Editor window. The Field Chooser dialog box
appears.

.
2. Select or clear a check box to display or hide the columns.
Selected fields shows the data fields from each record that is currently displayed in the window.
To change the order in which the selected fields are displayed
 Drag and drop a column in the workspace to rearrange the order of the columns. See Customizing
the Columns Shown in the Tabbed Work space on page 23.
To change the column settings to default
 Right -click in the workspace and then click Restore Column Settings.

Viewing a Job’s Route Diagram

The job rout e diagram is the vis ual representation of the entire work order route in the MES Client
application. A job route consists of jobs (operation and physical entity combinations ), route links, and
items. Jobs are color-coded based on the current job state.

232 Version 6.1

Job Queue MES Client User Guide

To view a job route diagram

 On the workspac e, right-click the job queue for which you want to view the job route diagram, and
then click View Flow Diagram. The Job Route tab appears on the Editor window.

Creating a Work Order from a Process from the Job Queue

Module
You can create a work order from an existing proc ess. All links and BOM versions that are part of a
process are linked to a work order aut omatically.
To create a work order from Process
 Right -click the workspace, and then click Create Work Order from Process. The Create Work
Order from Proce ss dialog box appears. For more information on creating a work order from a
process, see Adding Files and Web Pages to a Work Order on page 246.

Splitting Jobs
You can split a job associated with an operation. When you split a job, a new job is created for the
operation and you can specify the quantities to be produced by the new job.
The specified quantities are deducted from the existing job and allocated to the new job. Splitting is done
to increase efficiency and utilization of entities that execute jobs.
To split a job
1. Right -click the job that you want to split and click Split Jobs. The Split Job dialog box appears.
2. In the Split Job dialog box, complete the following settings for the new job:
New Sequence Number
The sequenc e number for the new job.
State
The state of the new job. For more information on job states, see Job and Step States on page 229.
Split Quantity
The production quantity you want to specify for the new job.

Version 6.1 233

MES Client User Guide Job Queue

Start Qty
The starting quantity of the production for the new job.
Finish Time
The end time for the new job.
Target Entity
Click the Brow se button to locate the entity on which the new job will run.
Note s
Additional information about new job.
3. Click OK.

Editing Selected Jobs

You can change job state, job priority, and/or required finish date/time for all the selected jobs at once.
You can change the state of only those jobs that are not running, completed, or canceled.
To change a selected job
1. Right -click the job of which you want to change the properties in the workspace, and then click
Change Selected Jobs. The Change Jobs dialog box appears.

2. In the Change Jobs dialog box, complete the following settings:

Job State
The job’s state.
Job Priority
The job’s scheduling priority.
Required Finish Date/Time
The date and time when this job will be finished.
Apply to all associated jobs
Specifies whether to apply these changes to the jobs associated with the selected job.
3. Click OK.
4. On the ribbon, click Save in the Main group to save the changes.
You can modify properties of a job in the Properties pane.

Creating Links for a Job Queue

You can link multiple jobs together, so that when the job state of one is changed to Running, all other
linked jobs also change to Running state at the same time.
 Ctrl+click to select more than one job, and then right -click and select Create Links.

234 Version 6.1

Job Queue MES Client User Guide

All selected jobs will be assigned the same link number.

Deploying a Queue Sequence

You can apply the current job queue sequence (sort order) and filter (of states, work orders, and son on)
to all of the entities selected in the entity tree. Queue sequence is used to control the work queue for the
selected entities in the MES Operator application and MES Web Portal. For more information on sorting
and filtering information, see Customizing the Columns Shown in the Tabbed Work space on page 23,
Sorting Information on page 24, and Filtering Data in the Editor Window on page 25.
If you are sorting by a column that does not exist in MES Operator’s Work Queue tab, you will receive a
warning indicating that the specified sort order cannot be displayed.
 Right -click a job in the job queue and click Deploy Queue Sequence and Filter.

Version 6.1 235

 MES Client User Guide

C HAPTER 29
Work Orders and Jobs
In This Chapter
Introduction to Work Orders and Jobs .......................................................................................... 237
Restrictions on Work Orders and Jobs Created in MES Web Portal ............................................... 238
Organizing Work Orders and Jobs ............................................................................................... 238
Applying Filters to the Work Orders List........................................................................................ 239
Arranging Columns of the Work Order List.................................................................................... 240
Workflow for Creating Work Orders and Jobs ............................................................................... 241
Creating a Work Order from a Process ......................................................................................... 241
Creating a Work Order ................................................................................................................ 243
Assigning Attributes to a Work Order............................................................................................ 249
Creating a Job ............................................................................................................................ 249
Creating a Job BOM ................................................................................................................... 257
Assigning Steps to a Job ............................................................................................................. 260
Assigning Specifications to a Job ................................................................................................. 270
Assigning Attributes to a Job ....................................................................................................... 273
Creating a Route Map ................................................................................................................. 273
Adding a Standard Operation to a Job .......................................................................................... 274
Cloning Work Orders and Jobs .................................................................................................... 275
Canc eling All Jobs in a Work Order.............................................................................................. 277
Setting Job Priorities to the Work Order Priority ............................................................................ 277
Splitting Jobs .............................................................................................................................. 277

Introduction to Work Orders and Jobs

You can use the Work Order and Jobs module to create and maint ain the following:
 Work orders
 Jobs
 Job step groups
 Job steps
A work order is a collection of jobs that produce an item. A job is a list of steps or procedures that is
executed to produce an item or a version of an item. Multiple jobs can be performed to produce a single
item.
It is recommended to create a work order from a process or import a work order from a MRP system
instead of creating the work order from scratch. After importing a work order from a MRP or creating the
work order from a process, you may need to customize the work order for production. However, y ou can
also use the Work Order and Jobs module to create a work order with a process or MRP information.
When you open the Work Order and Jobs module, a list of all the existing work orders is shown in the
workspace. Expand the work orders to see the job assigned to each of them.

Version 6.1 237

MES Client User Guide Work Orders and Jobs

By default, the Work Order and Jobs module is grouped under the Order Management group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.

Restrictions on Work Orders and Jobs Created in MES Web

Portal
Work orders can also be creat ed and assigned to lines in MES Web Portal. Note the following MES Client
restrictions for work orders and jobs when the work order is created and assigned to a line in MES Web
Portal:
 You cannot add jobs to or delete jobs from a work order created for a line in MES Web Portal.
 You cannot reassign a job to another entity for a work order creat ed for a line in MES Web Portal.
 You cannot change or delet e the job route for a route related to a line.

Organizing Work Orders and Jobs

The Current View tab allows you to organize the contents of the proc ess tree. The following commands
are available in the Views group to organize work orders:
Standard View
Click Standard View to view all properties of a work order. By default, standard view is shown in the
Editor window.
Group By Item
Click Group By Item to organize work orders by item. The item nodes are found in the workspac e
when the Group By Item command is selected. You can access and define related work orders by
locating the appropriate produced item in the It em tree.

238 Version 6.1

Work Orders and Jobs MES Client User Guide

Group By Mfg.Order
Click Group By Mfg.Order to organiz e work orders by manufacturing order. Work orders are
grouped together if they are assigned to the same manufacturing order. Related work orders may be
accessed and defined by locating the appropriate manufacturing number in the job tree.

Applying Filters to the Work Orders List

The Filter option in the Navigation pane allows you to filter the work orders list by jobs, job states,
processes, item classes, items, and operations.
Changing the width of a column in the workspace does not save the configuration of filter and column
width. The configuration is saved if you do one of the following: change a columns position, add or
remove a column, apply grouping to the grid, or change the sort order. For more information, see
Customizing the Columns Shown in t he Tabbed Work space on page 23 and Sorting Information on page
24.
To filter a work order
1. In the Navigation pane, click the Work Order And Jobs module.
2. Select the required filter options. See Available Work Order Filters on page 239.
3. Click Apply Filters. The list of work orders matching the filter selection is shown in the Editor
window.

Available Work Order Filters

In the Work Orders and Jobs section, the following filter options are available:
Work Order ID
Unique ID of the work order.
Release Date
Date and time for the release of the first job.
Due Date Time
Planned work order completion dat e and time.
Work Order Priority
Priority for the work order.
Customer
Name or account number of the customer.
Manufacturing Order
Manufacturing order ID.
Work Order State
State of the work order.
In the Job Filters section, the following filt er options are available:
Operation ID
Unique ID of the operation within the work order.
Scheduleable Entity
Entity to which job is initially scheduled.
Scheduled Entity
Entity to which job is actually scheduled.
Last entity run on
Entity on which job was executed.
In the Item Class Filters section, the following filter options are available:

Version 6.1 239

MES Client User Guide Work Orders and Jobs

Item Class ID
Unique ID of the produced item class.
Item Class De scription
Description of the produced item class.
In the Item Filters section, the following filter options are available:
Item ID
Unique ID of the produced item.
Item Description
Description of the produced item.
Item spare1
User–defined information.
Item spare2
User–defined information.
Item spare3
User–defined information.
Item spare4
User–defined information.
In the Proce ss Filters section, the following filter options are available:
Process ID
Unique ID of the process.
In the Job State section, the following filter options are available:
New
New jobs.
Suspended
Jobs that are stopped.
Complete
Jobs that are complete.
On Hold
Jobs that are on hold.
Running
Jobs that are running.
Cancelled
Jobs that are canceled.
Ready
Jobs that are ready.

Arranging Columns of the Work Order List

You can arrange the work order information. The field chooser option limits and organizes the display of
data fields from all qualifying records. Field choos er allows you to choos e what information about each
work order is shown in the Work Orders and Jobs module.

240 Version 6.1

Work Orders and Jobs MES Client User Guide

To change the selection of fields to be displayed

1. Click the Field Chooser icon at the top of the Editor window. The Field Chooser dialog box
appears.

2. Select or clear a check box to display or hide the columns.

Workflow for Creating Work Orders and Jobs

You can create and manage work orders, jobs, job step groups, and job steps. The workspace shows the
work order ID, process ID, description, and other det ails of an existing work order.
Following is the work flow to create and configure new work order:
1. Creating a Work Order from a Process on page 241
2. Creating a Work Order on page 243
3. Adding Files and Web Pages to a Work Order on page 246
4. Assigning Attributes to a Work Order on page 249
5. Creating a Job on page 249
6. Assigning a Data Log Group to a Job
7. Creating a Job BOM on page 257
8. Creating a Job BOM on page 257
9. Assigning Steps to a Job on page 260
10. Assigning Specifications to a Job on page 270
11. Assigning Attributes to a Job on page 273
12. Creating a Route Map on page 273

Creating a Work Order from a Process

You can create a work order from an existing proc ess. All links and BOM versions that are part of a
process are linked to a work order aut omatically.

Version 6.1 241

MES Client User Guide Work Orders and Jobs

To create a work order from a process

1. On the ribbon, click New Work Order From Process in the New list. The Create Work Order from
Process dialog box appears.

2. In the Create Work Order from Process dialog box, complete the property settings. See Work
Order from P rocess Properties on page 242.
3. Click OK.

Work Order from Process Properties

Process ID
The ID of the process from which you want to create a work order.
Specification Version
The specification version for the work order.
You must have the May override preferred spec. version privilege and all the operations in the
process must have the same spec versions for this to be available.
Work Order ID
The unique ID for the work order.
The work order ID is generated aut omatically if you define the work order ID format using the Work
order ID format system parameter.
Description
A brief description of the work order.
Item list
The item that you want to add to this work order.
You must define an item as a produced item in the Items module. If the selected process is linked to
only one item, then the item is automatically selected in the Work Order module. For more
information, see Creating an Item on page 119.
BOM Version
The BOM version for the work order.

242 Version 6.1

Work Orders and Jobs MES Client User Guide

Starting Quantity
The starting quantity is the amount of product that is intended to be made, if there were no rejects.
The last operation in t he work order starts with the starting quantity. If t he starting quantity is left at its
default of 0, and a required quantity is specified, the starting quantity will be changed to be equal to
the required quantity. The maximum value that can be ent ered is 999,999.
Required Quantity
The required quantity of the produced items. Required quantity is the quantity that the last operation
in the work order must produce to complete t he operation. The maximum value that can be entered is
999,999.
Release Date/Time
The date and time for the releas e of the first job. Click the Browse button to select the date and time
from the calendar. Release date and time is used by the system to change the first job in the work
order from new to ready. It is also used to set the required dat es for the jobs. The work order required
date is assigned to the jobs during the last operation.
Due Date/Time
The planned work order completion date and time. Click the Brow se button to select the date and
time from the calendar.
Priority
The priority for the work order. It prioritizes all jobs creat ed for the work order.
Customer
The name or account number of the customer.
Manufacturing Order
The manufacturing order ID.
Note s
Additional information about the work order.

Creating a Work Order

A work order indicates the task assigned by a customer t o produce some quantity of an item on or before
a due dat e. You can also create work orders for internal use, such as restocking invent ory for an item that
can be later used as a component for another item.
You can also create a work order from a process. Processes are templates for work orders. All entities,
step groups, steps, BOM, folders, data log and certifications linked to the process becomes a part of the
new work order. For more information on creating a work order from a proc ess, see Adding Files and
Web Pages to a Work Order on page 246.
To create a work order
1. On the ribbon, click New Work Order in the New list. A new work order record is shown in the
workspace.
2. In the Properties pane, complete the property settings. See Work Order Properties on page 243.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing work order in the Properties pane.

Work Order Properties

Work Order ID
The unique ID for the work order. Identifies the work order in all MES data records, so must be
unique and is not editable after the work order definition is first saved.
The work order ID is generated aut omatically if you define the work order ID format using the Work
order ID format system parameter.

Version 6.1 243

MES Client User Guide Work Orders and Jobs

Description
The work order name or a brief description of the work order.
Item
Click the Brow se button to locate the item that you want to add to this work order.
The Choose Produced Item dialog box appears.
You must define an item as a produced item in the Items module. If the selected process is linked to
only one item, then the item is automatically selected in the work order module. For more
information, see Creating an Item on page 119.

In the upper pane, create a filter to limit the number of items returned, and then click Apply Filters.
Click Clear Filters to reset the filters.
In the lower pane, select an item, and then click OK to set the item produced by the work order.
Status
The status of the overall work order. The system automatically controls the status until it reaches
Completed.
You must have the May change work order status user privilege to change the status of a work order.
The work order statuses are:
o Released: Indicates that the work order is complete and ready for release.
o Started: Indicates that the work order is in progress.
o Completed: Indicates that the work order is complet e and delivered to the customer.
o Closed: Indicates that the work order is stopped or interrupted due to some reason. The work
order cannot be edited if the work order status is Closed.

Note that this status is different than the work order status that is displayed in MES Web Portal. The
work order status in MES Web Portal is derived from the statuses of the work order's jobs.

244 Version 6.1

Work Orders and Jobs MES Client User Guide

Starting Quantity
The starting quantity is the amount of product that is intended to be made, if there were no rejects.
The last operation in t he work order starts with the starting quantity. If t he starting quantity is left at its
default of 0, and a required quantity is specified, the starting quantity will be changed to be equal to
the required quantity. The maximum value that can be ent ered is 999,999.
Required Quantity
The required quantity of produced items. Required quantity is the total quantity that must be
produced by all jobs in the last operation of a work order. The maximum value that can be entered is
999,999.
Customer
The name or account number of the customer who placed this order.
Manufacturing Order
The manufacturing order ID. Manufacturing order ID identifies the manufacturing order to which this
work order belongs. A manufacturing order ID can be used to access related work orders (common
customer, purpose, and so on) in the job tree while creating a job.
Release Date/Time
The date and time for the releas e of the first job. Click the Browse button to select the date and time
from the calendar. Release date and time is used by the system to change the first job in the work
order from new to ready. It is also used to set the required dates of the jobs. The work order required
date is assigned to the jobs in the last operation.
Due Date/Time
The planned work order completion date and time. Click the Brow se button to select the date and
time from the calendar.
Priority
The priority for the work order. For example, for value 1, the priority of the work order will be highest.
It allows you to set the priority of all jobs in the work order.
Note s
Additional information about the work order.
Not Deletable
Specifies whether the work order is locked and so cannot be deleted from the system.
May Override Route
Specifies whether the sequence of operations defined in a work order route can be overridden. If
selected, an operator can work on jobs in downstream operation before completing or starting the
jobs in an upstream operation.
Override Serialization
Specifies whether the serial number of the items in a work order can be overridden. If selected, you
can produce a serialized item without using serialization. It is used to handle the transition phase
when you first mark an item as serialized, but you already have work orders in process. You can
override serialization in a work order to continue producing items without a serial number.
This option is available only if the item produc ed by the work order is a serialized item.
Files
You can add files and web pages to a work order to provide instructions about the work order for an
operator. When a user is recording the execution of the work order from an application such as MES
Operator, the file or web page will be available to them for viewing.
See Adding Files and Web Pages to a Work Order on page 246.

Version 6.1 245

MES Client User Guide Work Orders and Jobs

Adding Files and Web Pages to a Work Order

You can add files and web pages to a work order to provide instructions about the work order for an
operator. When a user is recording the execution of the work ord er from an application such as MES
Operator, the file or web page will be available to them for viewing.
To add files to a work order
1. In the Files property group, click the Configure Files button.

The Files dialog box appears.

2. Right -click in the dialog box, and then click Add files.
The Open dialog box appears.
3. In the file type list, select All files.
4. Navigate to and select the files to be added, and then click Open.
The selected files are listed in the Files dialog box.

5. Optionally, add a description for each file in the De scription column.

246 Version 6.1

Work Orders and Jobs MES Client User Guide

6. Add other files (or web pages) as needed.

7. When you are finished adding files, click Close.
The files are listed in the Files property group.

8. Save the changes.

To add web pages to a work order
1. In the Files property group, click the Configure Files button.

The Files dialog box appears.

2. Right -click in the dialog box, and then click Add URL.

Version 6.1 247

MES Client User Guide Work Orders and Jobs

The Add URL dialog box appears.

3. Enter the URL for and a description of the web page.

Instead of manually entering the URL, you can click the Browse button at the right of the URL box
and use the mini-browser window that appears to navigate to the web page.

Click OK and that web page's URL is entered on the Add URL dialog box.
4. When you have finis hed entering the URL and description, click Close.
The URL is listed in the Files dialog box.

5. Add other web pages (or files) as needed.

6. When you are finished adding web pages, click Close.
The web page URLs are listed in the Files property group.

248 Version 6.1

Work Orders and Jobs MES Client User Guide

7. Save the changes.

To remove a file or URL
1. In the Files property group, click Configure Files.
The Files dialog box appears.
2. Right -click the file or URL, and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.

Assigning Attributes to a Work Order

An attribute is an additional user-defined property. Attributes are not used directly in the manufacturing
process they provide extra information about the work order. You must create an attribute for a work
order in the Attribute s module before assigning an attribute to a work order. For more information on
attributes, see Attributes on page 107.
To add an attribute to a work order
1. In the Editor window, select the work order to which you want to add an attribute.
2. On the ribbon, click the Current View tab.

3. In the Attribute s group, click the Add Attribute icon. The Add Attributes dialog box appears.
4. In the Value box, type the value for the added attribut e.
5. In the Note s box, type any additional information for the attribute.
6. Select the attribute that you want to add, and then click OK.
You can add multiple attributes to a work order.
7. On the ribbon, click Save in the Main group to save the changes.

Creating a Job
A job is an instance of an operation for a work order that is scheduled for a particular entity and produces
an item. A job is an operation and entity combination to produce a specified quantity of an item. A job
consists of steps, specifications, and comp onents that are necessary for a particular phase of the
production. Multiple jobs can be used to produce an item.
To create a job
1. On the ribbon, click New Job in the New list. A new job record appears in the workspace.
2. In the Properties pane, complete the property settings. See Job Properties on page 249.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing job in the Properties pane.

Job Properties
There are several groups of job properties.

General Properties
Operation ID
The ID of the operation to be associated with the job.

Version 6.1 249

MES Client User Guide Work Orders and Jobs

Sequence Number
The sequence to divide a job. For example, a job can be divided into three sequence numbers so that
three entities can work on that job simultaneously. The sequence number is used to differentiat e
multiple jobs for the same operation.
Item
Click the Browse button to locate the item that you want to add for this job. You must define an item
as a produced item in the Items module. If the selected process is linked to only one item, then the
item is automatically selected in the work order module. For more in formation, see Creating an Item
on page 119.
The last operation in the work order must produce the item as defined in the work order.
After clicking the Browse button, the Select Item dialog box appears.

In the upper pane, create a filter to limit the number of items returned, and then click Apply Filters.
Click Clear Filters to reset the filters.
In the lower pane, select an item and then click OK to set the item produced by the work order.
Starting Quantity
The starting quantity. Starting quantity is the number of units that are produced during the job.
Quantity Required
The required quantity of produced items for the job.
Can Schedule To
Click the Brow se button to locate the entity or entity group on which this job can also be scheduled to
run. The Entity Window dialog box appears.
Select the entity on which the job can also be scheduled, and then click OK.
To schedule a job on an entity, the entity’s Can schedule jobs property must be selected. See
Capabilities on page 67.
Scheduled To
Click the Browse button to locate the entity or entity group on which this job is scheduled to run. The
Enti ty Window dialog box appears.

250 Version 6.1

Work Orders and Jobs MES Client User Guide

Select the entity on which to schedule the job, and then click OK.
To schedule a job on an entity, the entity’s Can schedule jobs property must be selected. See
Capabilities on page 67.
Job State
The job state, which is New by default. You can change the status as Ready to make the job
available on the plant floor.
File
You can add a file or web page to a job to support an operator during production. For example, the
file or web page can contain information relative to performing the job. When a user is recording the
execution of the job from an application such as MES Operator, the file or web page will be available
to them for viewing.
See Adding a File or Web Page to a Job on page 251.
Batch Size
The size of the batch. Batch size defines the number of production units in a single batch for this job.
For additional information about batch size, see Understanding Batches and Lots for OEE and
Estimated Times on page 74.

Adding a File or Web Page to a Job

You can add a file or web page to a job to support an operator during production. For example, the file or
web page can contain information relative to performing the job. When a user is recording the execution
of the job from an application such as MES Operat or, the file or web page will be available to them for
viewing.
To add a file
1. Click the Browse button to the right of the File property box.
The File or URL dialog box appears.

2. Click Add File.

The Open dialog box appears.
3. In the file type list, select All files.
4. Navigate to and select the file to be added, and then click Open.
The file is entered in the File property box.

To add a web page

1. Click the Browse button to the right of the File property box.
The File or URL dialog box appears.

Version 6.1 251

MES Client User Guide Work Orders and Jobs

2. Click Add URL.

A mini-web browser appears.

3. Enter or navigat e to the web page, and then click OK.

The URL is entered in the File property box.

Setup Properties
Job De scription
A brief description of the job.
Di splay Sequence
The position of the operation, in which this job is shown. Display sequence is used to specify where
the job will appear in the job route diagram.
Note s
Additional information, if any, for the job.
Folder Revision
The version of an existing folder that contains associated files assigned to this job.
For information about the Folders function and folder versions, see the Folders chapter in the MES
Supervisor User Guide.
Dynamic Routing
The Dynamic Routing check box if the job requires rework. For example, a job requires rework if the
produced item is defective. You can als o type a new dynamic routing code. For more information,
see Dynamic Routing on page 217.
Dynamic Routing Code
The dynamic routing code for the job. A dynamic routing code indicates the process and operation
that are used to do the rework, if required. For more information, see Dynamic Routing on page 217.
Job Cost
The estimated cost for completing this job.
First Job
Indicates whether this is the first job in the work order. The first job does not receive inputs from a
previous operation. This is a read -only field.
Final Job
Indicates whether this is the last job in the work order. The final job does not send its production to
another operation. This is a read-only field.
The work orders may have multiple first jobs and/or last jobs; however, at least one first job and one
last job must be present for eac h work order. If there is only one job in the work order, that job is
marked as both the first and the final job.
Job spare1–4
Type additional information for this job, if any.

252 Version 6.1

Work Orders and Jobs MES Client User Guide

Schedule Properties
Schedule Start Date/Time
The scheduled start date and time for the job. Schedule start date and time defines the dat e and time
that the Scheduler module has found efficient for this job to start its production.
Latest Start Date/Time
The latest date and time when the job start ed. Latest start date and time defines the dat e and time
that the Scheduler module has found to be the latest that this job can begin its production.
Schedule Finish Date/Time
The scheduled end time for the job. Scheduled end time defines the date and time that the Scheduler
module has determined as the appropriate finishing time for this job.
Required Finish Date/Time
The required time to finish the job. Required finish time defines the date and time by which this job
needs to be complet ed. It is used to order job queue in the MES Operat or application.
Schedule Pinned
Specifies whether the start time of this job cannot be changed.
Priority
The priority for this job to determine the job execution order. Priority is used to rate jobs, for example,
which job is most important. You can also use this information for scheduling jobs.
Est. Setup Time
The estimated number of hours for setting up an entity to run this job.
Est. Production Rate
The estimated production rate for this job.
The estimated production rate must be greater than 0. An ent ry of 0 will cause an error.
Prod. Unit of Measure
The unit of measure (UOM) that is used for the production process.
Est. Variable Labor Rate
The estimated number of variable labor hours required to produc e a single batch of the item on the
selected entity.
Labor Unit of Measure
The UOM that is used for the labor involved with the production process.
Est. Teardown Time
The estimated number of hours required to teardown the selected entity after the production.
Est. Transfer Time
The estimated number of hours required to move the produced items from the selected entity to the
next entity.
Est. Fixed Labor Hours
The estimated number of fixed labor hours required to produce a single batch of the item on the
selected entity.

Status Properties
Status Note s
The status of the job.
Run On
The entity ID on which this job is scheduled to run.
Actual Start Date/Time
The time when the job started. This is a read -only field.

Version 6.1 253

MES Client User Guide Work Orders and Jobs

Actual Finish Date/Time

The time when the job was complet e. This is a read-only field.
Quantity Produced
The quantity of the item that is produced.
Quantity Produced to ERP
The produced quantity of the item that is uploaded to ERP.
Quantity Rejected
The quantity of the item that is rejected.
Quantity Rejected to ERP
The produced quantity of the item that is uploaded to ERP.
Edited By
The name of the user who last edited this job.

DataLog Property
You can assign one or more dat a log groups to a job to allow users to collect measurement dat a about
production. Data log groups are created and managed using the MES Supervisor application.
When assigning a data log group to a job, you can configure the group to acquire periodic data. You can
also assign an audit certification to a data log group to require one or more qualified users to sign off on
the data being logged.
To assign a data log group to a job
1. In the Editor window, select the job.
2. Open the DataLog Property group in the Properties pane.

3. Click the Edit button.

254 Version 6.1

Work Orders and Jobs MES Client User Guide

The Data Log Group dialog box appears.

4. Right -click in the Data Log Group dialog box, and then click Add.
The Add Data Log Groups dialog box appears. A vailable data log groups are listed. Groups that
have been previously assigned to the job are already selected.

5. Select the groups to be assigned to the job and click OK.

The selected groups are listed on the Data Log Group dialog box.

6. For each group, complete the property settings.

Version 6.1 255

MES Client User Guide Work Orders and Jobs

Periodic Data Collection

Specifies whether periodic updates of data are enabled. If selected, data is collected periodically at
the trigger period that is defined.
Trigger Type
A vailable only if the Periodic Data Collection check box is selected.
The trigger type for periodic data collection. Select whether the collection period is in minutes or
hours (hourly).
Trigger Detail
A vailable only if the Periodic Data Collection check box is selected.
The number of minutes or hours to wait between each periodic data collection operation.
Data Confirmation Required
Specifies whether data collection requires a certification for sign-off.
Certification
A vailable only if the Data Confirmation Required option is selected. Select the audit certification for
the data log group.
If an audit certification is selected here, then one or more qualified users will be required to sign off to
complete the data logging.
7. Click Close to close the Data Log Group dialog box.
The selected groups are listed in the DataLog Property property group.

8. Save the changes.

To edit data log group properties
1. Click the Edit button to open the Data Log Group dialog box.
2. Modify any of the group properties as needed, then click Close.
3. Save the changes.
To remove a data log group from the job
1. Click the Edit button to open the Data Log Group dialog box.
2. Right -click the group and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.
4. Click Close to close the Data Log Group dialog box.
5. Save the changes.

256 Version 6.1

Work Orders and Jobs MES Client User Guide

Creating a Job BOM

A job BOM represents a logical grouping of the bill of material components that are associated with a
particular job. A job BOM consists of produced items, consumed items, and by -products.
When you create a job from scratch, an ent ry is made for BOM position 0 for the produced item.
Additional BOM information is not included even if there is a BOM is defined for the item being produced.
You can add BOM components and by products to the job BOM. There is no check required for the
produced BOM items.
To create a job BOM
1. In the workspace, click the job for which you want to create a job BOM, and then click Job BOM tab.
2. On the ribbon, click the Current View tab.
3. In the Job BOM group, click New Job BOM. A new job BOM record is shown in the Job BOM tab.
4. In the Propertie s pane, click JobBOM, and complet e the property settings. See Job BOM Property
Settings on page 258.
5. Click Substitute s, and then click + to add a new job BOM substitute. The Substi tute s dialog box
appears.

6. On the Substitutes dialog box, complete the settings. See Substitutes Settings on page 259.
There can be multiple substitute materials to be cons umed or produced for all configured job BOM
items in place of the configured BOM items.
7. On the ribbon, click Save in the Main group to save the changes.

Version 6.1 257

MES Client User Guide Work Orders and Jobs

Job BOM Property Settings

BOM Position
The position number (used as an ID) of this BOM item for the BOM of the current job. A negative
number indicates by product, a positive number indicates a consumable item and 0 indicates items
produced by the job.
Item Description
Click the Brow se button and select the item that is consumed or produc ed in the current job.
Required Grade
The minimal grade that this item must have to be consumed or produced.
Instruction
Additional instructions about this item, if any.
Quantity
The quantity of this item to be consumed or produced in this BOM per unit of the produced item.
Min Quantity
The minimum consumption quantity of this item required per unit of the produced item.
Max Quantity
The maximum consumption quantity of this item required per unit of the produced item.
You can define the maximum and minimum quantity per parent item only for the consumed items.
Required Start Value Is%
Specifies whether the value in the Required Start Value box should be interpreted as a percentage
rather than an absolute value.
Required Start Value
The quantity of this item that must be available before this job state is set to Ready.
Default Reason
The default reason for consuming/producing this item.
Default Lot Number
The default value for the lot number of the item.
Default Storage Entity
Click the Brow se button and select the default storage entity for this product or by -product.
Scaling Factor
The multiplier for scaling the consumption and/or production quantity of the item.
Backflush Consumption
Specifies whether the consumption of the consumed item is recorded automatically whenever the
production of t he parent item is recorded. For example, to make a bottled water bottle, if backflush for
the BOM is enabled, the consumption of the bottle, bottle cap, wrap label, and wat er is automati cally
posted.
Update Inventory
Specifies whether the inventory records must update when you report production of this item.
Must Consume from Inventory
Specifies whether the item must be consumed from the inventory.
Must Consume From WIP
Specifies whether to restrict consumption of the item to lots produced by this work order.
May Choose Alternative Inventory Location
Specifies whether you can select an alternative inventory location for this item.
May Create New Lots
Specifies whether you can creat e new lots.

258 Version 6.1

Work Orders and Jobs MES Client User Guide

Must Consume Before Production Allowed

Specifies whether the item must be consumed before production.
Constant Quantity
Specifies whether the amount consumed for this item is fixed and does not depend on the number of
parent items produced.
Job BOM Spare1–4
User-defined information for this job BOM.

Substitutes Settings
Item
Click the Brow se button and select the item that will be produced in the current job.
Preference
The preference for the job BOM substitute. A value of 1 indicates the most preferred.
Substitution Level
The substitution level for this job BOM. This is the security setting that limits the usage of this
substitute item.
You must have a BOM substitution level greater than or equal to the substitutes level to use the
substitute.
Required Grade
The grade for the job BOM substitute.
Default Prod Code
The default production code for the job BOM. This indicates the default reas on for producing this
substitute item in the MES Operator application. An operator can select other production reasons for
this substitute item.
Quantity
The quantity of this item to be consumed or produced in this BOM per unit of the produced item.
To Storage Location
Click the Brow se button and select the storage location for produced items. This indicates the
default storage entity to place produced quantities of this substit ute item.
Min Quantity
The minimum consumption quantity of this item required per unit of the produced item. This is for
consumed items only.
Max Quantity
The maximum consumption quantity of this item required per unit of the produced item.
Required Start Value Is%
Specifies whether the value in the Required Start Value box should be interpreted as a percentage
rather than an absolute value.
Required Start Value
The required start value.
Backflush Consumption
Specifies whether the consumption of the WIP parent item must record automatically whenever
production of this substitute parent item is recorded. For example, to make a bottled water bottle, if
backflush for the BOM is enabled, the consumption of the bottle, bottle cap, wrap label, and water is
automatically posted. If Update Inventory is selected, inventory records for this BOM item updates
automatically.
Update Inventory
Specifies whether the inventory records must update when you report production of this substitute
item.

Version 6.1 259

MES Client User Guide Work Orders and Jobs

Must Consume Before Production Allowed

Specifies whether the item must be consumed before production.
Must Consume From Inventory
Specifies whether the item must be consumed from the inventory.
May Create New Lots
Specifies whether you can creat e new lots. This indicates that an operat or can create new lot
numbers when reporting the production of this substitute item. This is for produced items only.
Must Consume from WIP
Specifies whether to restrict consumption of the item to lots produced by this work order.
May Choose Alternative Inventory Location
Specifies whether you can select an alternative inventory location for this item. This indicates that an
operator can select an inventory location for this substitute item other than the one supplied by
default.
Constant Quantity
Specifies whether consumption quantities of this substitute item are not dependent on the number of
produced parent items.
Default Lot number
The default value for the lot number of the selected substitute item.
Instruction
Additional instructions about this item, if any.
Units
The units for the job BOM substitute.
Scaling Factor
The multiplier for scaling the consumption and/o r production quantity of the item.
Job_BOM_Subst spare 1–4
User-defined information about this job substitute.

Assigning Steps to a Job

You can assign steps to a job. Steps decompose an operation into discreet parts. You must create step
groups before creating steps. Step groups can be repeatable or non -repeatable. Non-repeat able step
groups contain steps that only need to be performed once in the operation such as, setup and teardown
steps. Repeatable step groups contain steps that must be performed for every batch that is produced in
a job. You must specify an order for the step groups by providing sequence number. The higher
numbered step must start after the lower numbered step for a group is completed. If two groups have the
same sequence number, the steps in both groups can be performed in any order. You can define
multiple step groups and steps for a job.

Creating a Step Group

1. In the workspace, do the following:
a. Select the job for which you want to create a step group.
b. On the ribbon, click the Current View tab.
c. In the Steps group, click New Step Group. A new step group record is shown in the Steps
window.
2. In the Properties pane, complete the following settings:
ID
The unique ID for the step group.

260 Version 6.1

Work Orders and Jobs MES Client User Guide

Description
A brief description for the step group.
Sequence
The sequence number for the step group. The sequence number determines the order in which step
groups are execut ed. All steps in a lower number step group must be completed or bypassed before
any step in a higher number step group starts. You can assign the same sequence number to step
groups that can be performed simultaneously.
Repeatability
Specifies whether steps contained in this step group are repeated for each lot produced by the job.
3. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing step group in the Properties pane.

Creating a Job Step

1. Make sure that at least one step group has been created. See Creating a Step Group on page 260.
2. On the ribbon, click the Current View tab.
3. In the Steps tab, click New Step. A new step record is shown in the Steps tab.
4. In the Properties pane, complete the property settings. See Job Step Properties on page 261.
5. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing step in the Properties pane.
For more information on configuring operation BOM, see Assigning a B OM to an Operation on page 182.
For more information on adding files to a work order, see Adding Files and Web Pages to a Work Order
on page 246.
For more information on editing data log group value, see Assigning a Data Log Group to a Job.

Job Step Properties

General Properties
Number
The unique number for the step.
Name
The unique name for the step. This is an optional field.
Sequence
The sequenc e number for the step. The sequence number indicat es the position of the step in the
current operation in the process tree. Sequence numbe r specifies the order in which this step is to be
performed.
SPC Char
The Statistical Process Control (SPC) characteristic that needs to be measured at this step.
Form Name
Click the Brow se button to locate the name of the form linked to this step, if any.
Description
A brief description or instructions for production.
Action Type
The action that this step needs to perform. The following options are available in the list:
o Normal: No specific action is performed.
o Log Data: Selects the Data Log tab to facilitate data collection.

Version 6.1 261

MES Client User Guide Work Orders and Jobs

o Add Production: Allows you to add production details for this step to facilitate the reporting of
production quantities.
o Add Consumption: Allows you to add consumption details for the first component assigned to
this step.
o Operator Acknowledge: Displays the step description and requires the operator to
acknowledge this prompt before continuing work.
o Enter Form Data: Allows you to fill in det ails in a specific form.
o Enter SPC Data: Allows an operator to add SPC data when the operator logs onto this step.

Complete When
The circumstances in which the current step is automatically marked as complete. The following
options are available in the list:
o Standard Time Elapsed: When the time specified in the Standard Time (In hours) box has
elapsed. This option is enabled only if you provide the elapse time in the Standard Time (In
hours) box.
o Operator Accepts: When the operator marks the step as accepted/complete. This option is
available when Operator Acknowledge is selected as action type in the Action Type list.

Standard Time (In hours)

The standard completion time in hours for this step.
Step Occurrence
The number of lots/sublots for which this step must be performed. 0 (the default) means it should be
performed for all lots/sublots. This property applies only if the maximum lot or sublot size is 1 and the
step group is repeatable.
Step Grp ID
The step group ID to which this step belongs.
Allow Bypass
Specifies whether you can skip this step.
Enter Data
Specifies whether you need to enter text into the Data box before changing the state of the step as
Accepted/Complete.
Advanced Options
Select Way Data Is Entered
The method to use to enter the required data: text box, radio buttons, check box, or combo box.
This setting is enabled if the Enter Data check box is selected.
Depending on which element is selected, anot her property setting appears for specifying the data
entry choices.
o If Text Box is selected, the Select Data Type list appears. It has the following options:
String/Text, Analog, and DateTime.

262 Version 6.1

Work Orders and Jobs MES Client User Guide

If you select Analog, you also need to define the high and low limits to specify whether an alert
should be issued when the value is outside these limits.
o If Check Box is selected, the Specify Label box appears. Type the label for the check box
option.

o If Radio Buttons is selected, the Define Buttons section appears. Type a name for a radio
button option and then click the + button to add that option. Multiple radio button options can be
included. To remove an option, select it and then click the – button.

o If Com bo Box is selected, the Define List section appears. Type the name of an entry to add to
the combo box list and then click the + button to add that entry to the list. Multiple list entries can
be included. To remove an ent ry, select it and then click the – button.

Spare Fields
Step Spare1 to Step Spare6
User-defined information for this step.
BOM
The amount of consumption for the BOM to apply for this step.
See Configuring the BOM Consumption Amount for the Job Step on page 264.
Files
You can add files and web pages to a job step to support an operator during production. For example, the
file or web page can contain information relative to performing the job step. When a user is recording the
execution of the job step from an application such as MES Operator, the file or web page will be available
to them for viewing.
See Adding Files and Web Pages to a Job Step on page 264.

Version 6.1 263

MES Client User Guide Work Orders and Jobs

DataLog Property
You can assign one or more dat a log groups to a job step to allow users to collect measurement data
about production.
See Assigning Data Log Groups to a Job Step on page 268.

Configuring the BOM Consumption Amount for the Job Step

If consumption for the BOM is going to occur over multiple job steps, you can specify the amount of BOM
consumption to apply to eac h job step.
To specify the amount of BOM consumption for this job step
1. In the BOM group, click Configure Operation BOM.

The BOM dialog box appears.

2. In the Qty at Step column, ent er the amount of BOM consumption for this step.
3. Click Save.
4. Click Cancel to close the dialog box.

Adding Files and Web Pages to a Job Step

You can add files and web pages to a job step to support an operator during production. For example, the
file or web page can contain information relative to performing the job step. When a user is recording the
execution of the job step from an applicatio n such as MES Operator, the file or web page will be available
to them for viewing.

264 Version 6.1

Work Orders and Jobs MES Client User Guide

To add files to the job step

1. In the Files property group, click the Configure Files button.

The Files dialog box appears.

2. Right -click in the dialog box, and then click Add files.
The Open dialog box appears.
3. In the file type list, select All files.
4. Navigate to and select the files to be added, and then click Open.
The selected files are listed in the Files dialog box.

5. Optionally, add a description for each file in the De scription column.

6. Add other files (or web pages) as needed.
7. When you are finished adding files, click Close.

Version 6.1 265

MES Client User Guide Work Orders and Jobs

The files are listed in the Files property group.

8. Save the changes.

To add a web page to the job step
1. In the Files property group, click the Configure Files button.

The Files dialog box appears.

2. Right -click in the dialog box, and then click Add URL.
The Add URL dialog box appears.

266 Version 6.1

Work Orders and Jobs MES Client User Guide

3. Enter the URL for and a description of the web page.

Instead of manually entering the URL, you can click the Browse button at the right of the URL box
and use the mini-browser window that appears to navigate to the web page.

Click OK and that web page's URL is entered on the Add URL dialog box.
4. When you have finis hed entering the URL and description, click Close.
The URL is listed in the Files dialog box.

5. Add other web pages (or files) as needed.

6. When you are finished adding web pages, click Close.
The web page URLs are listed in the Files property group.

7. Save the changes.

To remove a file or URL
1. In the Files property group, click Configure Files.
The Files dialog box appears.
2. Right -click the file or URL, and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.

Version 6.1 267

MES Client User Guide Work Orders and Jobs

Assigning Data Log Groups to a Job Step

You can assign one or more dat a log groups to a job step to allow users to collect measurement data
about production. Data log groups are created and managed using the MES Supervisor application.
When assigning a data log group to a job step, you can configure the group to acquire periodic data. You
can also assign an audit certification to a data log group to require one or more qualified users to sign off
on the data being logged.
To assign data log groups to a job step
1. In the Editor window, select the job step.
2. Open the DataLog Property group in the Properties pane.

3. Click the Edit button.

The Data Log Group dialog box appears.

4. Right -click in the Data Log Group dialog box, and then click Add.

268 Version 6.1

Work Orders and Jobs MES Client User Guide

The Add Data Log Groups dialog box appears. A vailable data log groups are listed. Groups that
have been previously assigned to the job step are already selected.

5. Select the groups that you want to assign to the job step and click OK.
The selected groups are listed on the Data Log Group dialog box.

6. For each group, complete the property settings.

Periodic Data Collection
Specifies whether periodic updates of data are enabled. If selected, data is collected periodically at
the trigger period that is defined.
Trigger Type
A vailable only if the Periodic Data Collection check box is selected.
The trigger type for periodic data collection. Select whether the collection period is in minutes or
hours (hourly).
Trigger Detail
A vailable only if the Periodic Data Collection check box is selected.
The number of minutes or hours to wait between each periodic data collection operation.
Data Confirmation Required
Specifies whether data collection requires a certification for sign-off.
Certification
A vailable only if the Data Confirmation Required option is selected. Select the audit certification for
the data log group.
If an audit certification is selected here, then one or more qualified users will be required to sign off to
complete the data logging.

Version 6.1 269

MES Client User Guide Work Orders and Jobs

7. Click Close to close the Data Log Group dialog box.

The selected groups are listed in the DataLog Property property group.

8. Save the changes.

To edit data log group properties
1. Click the Edit button to open the Data Log Group dialog box.
2. Modify any of the group properties as needed, then click Close.
3. Save the changes.
To remove a data log group from the job step
1. Click the Edit button to open the Data Log Group dialog box.
2. Right -click the group and click Delete.
You are prompted to confirm the deletion.
3. Click Yes.
4. Click Close to close the Data Log Group dialog box.
5. Save the changes.

Assigning Specifications to a Job

Job specifications represent one or more specifications or setpoints that are referenced during a job.
Specifications are organized within global specification groups. You can add a specification to the job or
to a step within the job. You must create a global set of specifications in the Global Specifications
module before adding a specification. For more information on specifications, see Global Specifications
on page 153.
To edit a specification you must have Specification access level user privilege greater than or equal to a
specification.
To add a job specification
1. In the workspace, click the job for which you want to create a specification, and then click Specs tab.
2. On the ribbon, click the Current View tab.

270 Version 6.1

Work Orders and Jobs MES Client User Guide

3. In the Specs group, click the New Specification icon . The Add Specification dialog box
appears.

4. Select the specification that you want to add to the job and click OK. A new specification record is
shown in the Specs window.
5. In the Properties pane, complete the following settings:
Step No
The step number to allow a spec to optionally link to a step.
Select No Step if the specification applies to the complete job.
Group
The specification group.
Specification
The specification ID.
Data Type
The data type for this specification.
Specification Value
The value for the specification.
Min Value
The minimum value for the specific ation.
Max Value
The maximum value for the specification.
Units
The unit of measure for the specification value.
Actual
The actual value of the specification as collected while the job is running.
File
You can add a file or web page to a job specification to support an operator during production. For
example, the file or web page can contain information relative to how to set the setpoint value
(represented by the specification) for the entity.
See Adding a File or Web Page to a Job Specification on page 272.
Comments
Comments about this specification.
Acce ss Level
The security access level for modifying the specification.
To edit a specification you must have Specification access level user privilege greater than or equal
to a specification.
Spec Spare 1–4
User-defined information for this specification.
6. On the ribbon, click Save in the Main group to save the changes.

Version 6.1 271

MES Client User Guide Work Orders and Jobs

Adding a File or Web Page to a Job Specification

You can add a file or web page to a job specification to support an operator during production. For
example, the file or web page can contain information relative to how to set the setpoint value
(represented by the specification) for the entity.
To allow users to open a file or web page that has been added to a specification, you can use the
following MES Stateful AP I Documents class methods in a custom application:
 EditFile()
 PrintFile()
 ViewFile()
To add a file
1. Click the Browse button to the right of the File property box.
The File or URL dialog box appears.

2. Click Add File.

The Open dialog box appears.
3. In the file type list, select All files.
4. Navigate to and select the file to be added, and then click Open.
The file is entered in the File property box.

To add a web page

1. Click the Browse button to the right of the File property box.
The File or URL dialog box appears.

2. Click Add URL.

A mini-web browser appears.

3. Enter or navigat e to the web page, and then click OK.

272 Version 6.1

Work Orders and Jobs MES Client User Guide

The URL is entered in the File property box.

Assigning Attributes to a Job

An attribute is an additional user-defined property. Attributes are not used directly in the manufacturing
process. They provide extra information about the job to the run time operator or to rec ord more
information from the operat or during execution of a job. You must creat e an attribute for a job in the
Attribute s module before assigning an attribut e to a job. For more information on attributes, see
Attributes on page 107.
Attributes assigned to a job changes to attributes on the jobs created from an operation if there is a
corresponding job attribute.
To add an attribute to a job
1. In the workspace, click the job to which you want to add an attribute, and then click Attribute s.
2. On the ribbon, click the Current View tab.
3. In the Attribute s group, click the Add Attribute icon . The Add Attribute s dialog box appears.

4. Select the attribute you want to add and click OK. A new attribute appears in the Attribute s window.
You must create attributes for a job in the Attribute s module before adding an attribute to a job in the
Work Orders and Jobs module. You can add multiple attributes to a job. For more information on
attributes, see Attributes on page 107.
5. On the ribbon, click Save in the Main group to save the changes.

Creating a Route Map

You can view rout e map for a work order with multiple operations. You can also view the flow of material
from jobs within an operation to jobs within ot her operations. You can drag and drop a job from one
operation to the next and modify the percentages, if required.
You need to create a route map if a work order contains more than one operation. A Route map
describes the flow of material through a work order. You can creat e a route by drawing lines from jobs in
a source operation to the jobs in a destination operation. You must draw a line from every job in the
source operation to every job in the destination operation.

Version 6.1 273

MES Client User Guide Work Orders and Jobs

Each routing line has a percentage associated with it that determines the amount of material that flows
from one job to another. You can change the percentage of any line to any number between 0 and 100,
but the tot al of all the lines leaving an job must a dd up to 100 percent. If you have a source operation with
two jobs and a destination operation with two jobs, you would draw four rout e lines. If one of the
destination jobs is faster, you may need to adjust the percentages leaving your source jobs so that 60
percent of the material from each of the source jobs goes to the faster destination and 40 percent of the
material from the source jobs goes to the slower job.
You can have multiple source operations linked to one destination operation. For example, if you have a
work order to make filled cookies, you may have an operation to make the top of the c ookie, an operation
to make the filling, and an operation to mak e the bottom of the cookie. All these operations to make
cookies run in parallel. These three operations can send their output to an operation that combines them
to make a cookie.
You can also have one source operation linked with multiple destination operations. If you had a work
order to build wagons, you may have an operation to produce wheels that feed anot her operation to
produce the front wheel assembly and anot her operation that produc es the rear wheel assembly.
To create a route map
1. Select the work order to view its route map in the workspace.
2. On the ribbon, click the Current View tab.
3. In the Diagrams group, click View Route Map.

4. Create a route map bet ween two jobs in two operations by selecting the job in the source operation
and dragging to the job in the destination operation.
All jobs in the source operation must be linked to all jobs in the destination operation. If an operation
sends output to more than one job in a destination operation, you can edit the percentage of mat erial for
each route line by:
 Clicking on the box in the route line and changing the number
 Clicking on the source job and changing the values in the grid.
The total value for all the route lines leaving a job should be 100 perc ent.

Adding a Standard Operation to a Job

A standard operation is an operation definition that can be used as a template to create a job in a work
order.
To add a standard operation to a job
1. Make sure that the standard operation has already been created. For more information on creating a
standard operation, see Creating a Standard Operation on page 222.
2. In the workspace, select the work order to add a standard operation.
3. On the ribbon, click the Current View tab.
4. In the Jobs group, click Insert Standard Operations in the Split Job list. The Insert Standard
Operations dialog box appears.

274 Version 6.1

Work Orders and Jobs MES Client User Guide

5. In the Insert Standard Operations dialog box, complete the following settings:
Standard Operation ID
The ID of the standard operation that you want to add to this job.
New Operation ID
The unique operation ID for the operation.
Seq No
The sequenc e number for the operation.
Job De scription
The description or name of the job.
Di sp Seq
The display sequence for the operation.
Start Qty
The quantity of mat erial available to the first job for the final number of units to be produced.
Reqd Qty
The required quantity of produced items.
Enti ty
The entity associated with the job.
State
The state for the operation.
6. To add multiple operations to a job, press Enter and then add another operation.
7. Click OK once all standard operations are configured. For more information on operation, see
Adding an Operation to a Process on page 180.
8. On the ribbon, click Save in the Main group to save the changes.

Cloning Work Orders and Jobs

You can clone an existing work order or job to create a new work order or job.
A cloned work order contains the same configured information as that of the parent work order, such as
operations, entities, steps, and specifications.
A cloned job contains all the specifications, job steps, job step groups, document attachments that are
associated with the parent job. For more information on creating a work order and Job, see Creating a
Work Order on page 243 and Creating a Job on page 249.
You must specify a different ID for a cloned work order or a job.

Cloning a Work Order

To clone a work order
1. Select the work order you want to clone.
2. On the ribbon, click the Current View tab.
3. In the Jobs group, click Clone in the Split Job list.
The Clone Work Order dialog box appears.
4. In the Clone Work Order dialog box, complete the following settings:
Work Order ID
The unique ID for the new work order.

Version 6.1 275

MES Client User Guide Work Orders and Jobs

Description
A brief description for the work order.
Required Quantity
The required quantity. The maximum value that can be entered is 999,999.
Starting Quantity
The starting quantity is the amount of product that is intended to be made, if there were no rejects.
The last operation in t he work order starts with the starting quantity. If t he starting quantity is left at its
default of 0, and a required quantity is specified, the starting quantity will be changed to be equal to
the required quantity. The maximum value that can be ent ered is 999,999.
Priority
The priority for the work order.
Release Date/Time
The date and time to release the work order.
Due Date Time
The due dat e and time for the work order.
Customer
The customer name.
Manufacturing Order
The manufacturing order that is associated with the work order.
Note s
Additional comments related to the work order.
5. Click OK.

Cloning a Job
To clone a job
1. Select the job that you want to clone.
2. On the ribbon, click the Current View tab.
3. In the Jobs group, click Clone in the Split Job list. The Clone Job dialog box appears.
4. In the Clone Job dialog box, complet e the following settings:
New Work Order
The destination work order.
New Operation ID
The operation ID associated with the job.
New Sequence No
The sequenc e number to specify the position number of the job within the operation.
State
The current state of the job.
Required Quantity
The required quantity.
Starting Quantity
The starting quantity.
Finish Time
The date and time the job is scheduled to end.
Target Entity
Click the Brow se button and select the entity to which to schedule the job.

276 Version 6.1

Work Orders and Jobs MES Client User Guide

Note s
Additional comments related to the job.
5. On the ribbon, click Save in the Main group to save the changes.

Canceling All Jobs in a Work Order

You can change the job state of all jobs associated to the selected work order to Cancelled.
To cancel all jobs in a work order
1. In the Editor window, select the work order for which you want to change the job state as Cancelled.
2. On the ribbon, click Current View tab.
3. In the Jobs group, click Cancel All Jobs in the Split Job list.
The job state of all jobs associated to the selected work order changes to Cancelled.

Setting Job Priorities to the Work Order Priority

You can change the job priority of all jobs associated to the selected work order to match the work order
priority.
To set job priorities to the work order priority
1. In the Editor window, select the work order for which you want to change the job priority.
2. On the ribbon, click Current View tab.
3. In the Jobs group, click Set Job Priority to WO Priority in the Split Job list.
Priority of all jobs associated to the selected work order changes as per the work order priority.

Splitting Jobs
You can add a job to the current operation by copying the dat a from the selected job and splitting the
required production quantity between the two.
To split jobs
1. In the workspace, select the job that you want to split.
2. In the Jobs group, click Split Job. The Split Job dialog box appears.
3. In the Split Job dialog box, complete the following settings:
New Sequence Number
The new sequence number for the job.
State
The state of the job. For more information on job states, see Job Queue on page 229.
Split Quantity
The production quantity you want to specify for the new job.
Start Qty
The starting quantity of the production.
Finish Time
The end time for the job.
Target Entity
Click the Brow se button to locate the entity assigned for this job.
Note s
Additional information about this job, if any.

Version 6.1 277

MES Client User Guide Work Orders and Jobs

4. Click OK.

278 Version 6.1

 MES Client User Guide

C HAPTER 30
Database Information
In This Chapter
Introduction to Database Information ............................................................................................ 279
Viewing Dat abas e Information ..................................................................................................... 280

Introduction to Database Information

You can use the Database Information module to view the database information details of the MES
database.
The Databa se Information module provides a summary of the target MES database that is retrieved
from the Archive, Purge, and Restore (AP R) server. The DB Maintenance Service points to the target
database that is configured through its local Database Connection Editor utility.
The databas e information includes the following:
 Database server, instance, and catalog/us er name
 Database version
 Record counts for each type of historical table a vailable for archiving/purging
 Minimum/Maximum timestamps for each of the historical tables
By default, the Database Information module is grouped under the System Management group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.

Version 6.1 279

MES Client User Guide Database Information

Viewing Database Information

The Databa se Information tab shows the current DB Maintenance Service host information.
To view the database information
 Click Database Information.
The Databa se Information tab includes the following information:
Database Version
The MES database version
Hi storical Table Name
The name of the historic al table.
Record Count
The record count for the given historical table.
Min Timestamp
The minimum timestamp for the historical table.
Max Timestamp
The maximum timestamp for the historical table.

280 Version 6.1

 MES Client User Guide

C HAPTER 31
Database Maintenance
In This Chapter
Introduction to Database Maintenance ......................................................................................... 281
Managing the MES Database ...................................................................................................... 282
Specifying the Archive Query Window, Root Directory Path, and Server Host ................................. 282
Creating an Archive Job .............................................................................................................. 283
Creating a Purge Job .................................................................................................................. 284
Creating a Restore Job ............................................................................................................... 285
Viewing the List of APR Jobs ....................................................................................................... 286
Viewing the APR Job Configuration Details .................................................................................. 286
Viewing the APR Job Log ............................................................................................................ 287
Removing an APR Job ................................................................................................................ 287
Running an APR Job Manually .................................................................................................... 287
Running an Archive or Purge Job Automatically ............................................................................ 288

Introduction to Database Maintenance

You can use the Database Maintenance module to archive, purge, and restore the MES Dat abase. This
module allows you to create, run, delete, modify, and view the Archive, Purge, and Restore (AP R) jobs.
By default, the Database Maintenance module is grouped under the System Management group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.

Version 6.1 281

MES Client User Guide Database Maintenance

Managing the MES Database

The transactional tables within the MES databas e grow rapidly and continuously. To keep the size of the
MES databas e within manageable limits, you should archive and/or purge the MES database at regular
time intervals. You can archive all the dat a of large tables and the associated (dependency) tables and
then restore them. In some selected cases, you might even purge the data from the MES database.
You can create and manage archive, purge, and restore jobs using the Database Maintenance module.
The Databa se Maintenance module allows you to:
 Create new jobs
 Run jobs
 View jobs
 Modify jobs
 Delet e jobs
 Access job logs

Specifying the Archive Query Window, Root Directory Path,

and Server Host
The Archive system parameters group in the General Parameters module allows you to set the
following properties for archive, purge, and restore jobs.

Archi ve query window size (hours)

The time s pan (in hours) used to divide the amount of records being archived and purged at one time
into smaller sets. This strategy helps to reduce the amount of data that is being retrieved and so
lessen the impact of archiving and purging on database performance for production.
The queries that are used to retrieve the data records to archive or purge will ask only for data within
the hourly window, based on the last_edit_at datetime in the data records. For example, if the
window value is set to 6 hours, the first data retrieval will retrieve the first 6 hours of data records and
archive or purge them. When that operation is complete, the next 6 hours of data records will be
retrieved and processed, and so on until the final records are reached.
The default value is 6 and the minimum value is 1. If there are large amounts of dat a to be arc hived
within the 6-hour window, you can lower the value so that smaller amounts of data are archived at a
given time. This should help prevent performance issues such as timeouts.
Archi ve root directory path
The root directory path (relative t o the server) to which archived data is saved and from which archive
data is restored.

282 Version 6.1

Database Maintenance MES Client User Guide

The default path is C:\Program Files\Wonderware\MES\Archive s.

Note the following:
o The archive root directory path must be the absolute path, including the drive letter.
o The path cannot be c:, c:\, or blank. If it is, it will revert to the default pat h.
o Make sure that any users who are performing archive and restore jobs have access to the
archive directory.

Archi ve server host

The name of the archive server host where the archive files are located.
If blank, the local host is assumed.
Granting MES Middleware Access to the Archive Root Directory or Server Host
When the MES DB/MW Communication component is configured in the post -install Configurator after
the initial MES installation, access to the archive root directory pat h is granted to the MES middleware's
Windows user account. If the archive directory or ser ver host is changed, configure the MES DB/MW
Communication component again to grant the MES middleware's Windows user account access to the
new directory location. For more information, see the MES Installation Guide or online help.

Creating an Archive Job

You can create a new archive job to execut e a defined archive operation. This job will retrieve selected
records from the MES database and record them in an archive file. You can also configure the archive
jobs to execute a purge operation on the archived records following the successful completion of the
archive operation.
To create an archive job
1. Click Database Maintenance.
2. On the ribbon, click New. A new job record is added in the Database Maintenance tab.
3. In the Properties pane, complete the following settings:
Name
The unique name for the job.
Description
A description for the job.
Type
Select Archive.
Details icon
Click the Details icon to view and select the tables to arc hive from an available list.
The tables in the Details list are the top-level tables in the MES database and so they are
independent of each other. Selecting any of thes e tables will not include any of the others listed here.
Therefore, make sure that you select each independent table that you want to include in the archive
operation. To see which dependent and related tables are included in the archive with each of these
independent tables, see Historical Database Tables on page 371.
You can select the Work Order State Filter status from the available options, such as Released,
Started, Complet ed, and Closed. In case of the Sample table, you can only archive samples that
have their status set to Missed, Complet e, Complete Late, or Canceled or samples that have the final
flag set to True.
Date Filter
Do any one of the following:

Version 6.1 283

MES Client User Guide Database Maintenance

 Click Relative and specify the number of days to select the data for archiving the records. If the
number of days defined is 30, it will archive the data older than 30 days from the current date.
 Click Absolute and then specify the From and To date to select the data for archiving the
records.
Purge
Specifies whether to purge the archived data.
4. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing archive job in the Propertie s pane.

Creating a Purge Job

You can create a purge job to execute a purge operation. This job will remove records from an active,
production MES dat abas e to free-up resources on the database server. The purge operation can be
done independently or as a follow-up to an archive job.
To create a purge job
1. Click Database Maintenance.
2. On the ribbon, click New. A new job record is shown in the Database Maintenance editor.
3. In the Properties pane, complete the following settings:
Name
The unique name for the job.
Description
A description for the job.
Type
Select Purge.
Select the categories of data to purge from a predefined list.
Details icon
Click the Details icon to view and select the tables to purge from an available list.
The tables in the Details list are the top-level tables in the MES database and so they are
independent of each other. Selecting any of thes e tables will not include any of the others listed here.
Therefore, make sure that you select each independent table that you want to include in the purge
operation. To see which dependent and related tables are included in the purge with each of these
independent tables, see Historical Database Tables on page 371.
In case of the Sample table, you can only purge samples that have their status set to Missed,
Complete, Complet e Late, or Canceled or samples that have the final flag set to True.
Date Filter
Do any one of the following:
 Click Relative and then specify the number of days to select the data for purging the records. If
the number of days defined is 30, it will purge the data older than 30 days from the current date.
 Click Absolute and then specify the From and To date to select the dat a for purging the records.
4. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing purge job in the Propertie s pane.

The Purge Process

The following steps occur during the purge process:

284 Version 6.1

Database Maintenance MES Client User Guide

1. Determine the time range for each deletion cycle based on the requested time range broken into
subsets, as defined by the system attribute Archive query window size (hours). This is performed to
avoid long-running trans actions against the database.
2. Determine if the first main table has relat ed tables. If no related tables are found, then steps 3 and 4
are skipped.
3. Copy the primary key from the main table into memory (that is, to a temporary table). For example,
for the wo table, the primary key is wo_id an d the timestamp used is last_edit_at.
4. Delet e the related table information for which the primary key matches the records in the temporary
table. There is no check on the related table timestamp.
5. Delet e the main table records. For example, when purging work order records, the records in the wo
table would be deleted.
6. If no exception occurs, move on to the next main t able (if more than one t able was selected as part of
the purge).
If an exception occurs, drop the temporary table, roll back deletions of any data in dependent tables
(deletions of data in relat ed tables cannot be rolled back), and move on to the next main table (if
more than one table was selected as part of the purge). If a purge is run again with the same
parameters and the error has been corrected, the new purge operation will pick up what was missed
on the previous purge during which the exception occurred.

Creating a Restore Job

You can create a restore job to execute a restore operation. This job will insert records from an archive
file into the MES restore database.
Before starting a restore job, the MES restore database must already exist. It is not creat ed as part of the
restore operation. To creat e an MES restore database, from the post -Install Configurator application:
 Create the restore database using the MES DB Setup component.
 Specify the restore database connection string using the MES DB/MW Communication component.
For more information about these MES components in the post -install Configurator application, see the
MES Installation Guide or online help.
Before creating a restore job, make sure that an archive file is available from a previously executed
archive job.
Note: Y ou can only perform a Restore from an archive that was created with the version of MES that you
are currently running. Restores using an archive from a previous version of MES are not supported and
might fail.

To create a restore job

1. Click Database Maintenance.
2. On the ribbon, click New. A new job record is shown in the Database Maintenance editor.
3. In the Properties pane, complete the following settings:
Name
The unique name for the job.
Description
A description for the job.
Type
Select Restore.
Details icon
Click the Details icon and do the following:

Version 6.1 285

MES Client User Guide Database Maintenance

o In the Available Archive s list, select the archived dataset zip file from the Databa se
Maintenance folder where the archived data will be restored from.
o Select the Abort when inserting duplicate check box if you want to abort the restore process
when duplicate data is inserted in the restore database.

Note: Make sure that you do not restore to the original MES database as it will have serious
performance implications.

Date Filter
Do any one of the following:
o Click Relative and then specify the number of days to select the data for restoring the records. If
the number of days defined is 30, it will restore the data older than 30 days from t he current date.
o Click Absolute and then specify the From and To date to select the data for restoring the
records.
4. On the ribbon, click Save in the Main group to save the changes.
You can modify the properties of an existing restore job in the Properties pane.

Viewing the List of APR Jobs

You can view the list of jobs defined (archive, purge, and restore) from the Database Maintenance
module. It shows the list of the current set of configured and previously executed database maintenance
jobs.
To view the list of APR jobs
 Click Database Maintenance. The Database Maintenance tab appears.
The Databa se Maintenance tab includes the following columns:
Status
The status of the job. The green icon indicates that the job has been modified and the red icon
indicates that the job definition has an error.
Name
The name of the job.
Description
A description for the job.
Type
Indicates whether the job is an archive, purge, or restore job.
Current Status
Indicates the current status of the job, whether the job is running. A blank value indicates that the job
is not running.
Last Execution
The date and time when the job was last executed.
You can sort the list on the available jobs using various criteria defined in the Database Maintenance
tab.

Viewing the APR Job Configuration Details

You can view the configuration details of an existing APR job.
To view the APR job configuration
1. Click Database Maintenance. The Database Maintenance tab appears with the list of jobs.

286 Version 6.1

Database Maintenance MES Client User Guide

2. Select the job. The configuration details of the job is shown in the Propertie s pane.

Viewing the APR Job Log

You can view the list of the available arc hived log files on the configured AP R server using the Database
Maintenance Log editor.
To view the APR job log
1. Click Database Maintenance. The Database Maintenance tab appears with the list of jobs.
2. Select a job and then click View Logs on the ribbon. The list of all available logs for the selected job
appears in the Database Maintenance Log editor.
You can view the details of the selected job log using the Log Viewer editor. You can also select and
copy the text from the log but cannot modify the content of the log.

Removing an APR Job

You can remove an existing job using the Databa se Maintenance module. Before removing the job,
make sure that the job is not running.
To remove a job
1. Click Database Maintenance. The Database Maintenance tab appears with the list of jobs.
2. Select the job and then on the ribbon click Delete.
If the selected job is an archive job, you can also remove the archived data sets.

Running an APR Job Manually

You can manually run the archive and purge jobs on the MES database to archive and/or purge the data
and run the restore jobs on the non-production database. You can manually select one of the APR jobs
currently defined in the MES database for execution. When you select a job, all configuration information
for that specific job is shown. You can review and modify the specifications for the job before executing it.
If you run an archive job or an arc hive purge job, the following is created on the DB Maintenance Service
(at the configured root path):
 A directory is created with the job name, if it doesn't exists already
 Under the job directory, a time-stamped ZIP file is created that contains a CSV file for eac h archived
table. The ZIP file also contains a manifest file. A log file with the same name is created alongside the
ZIP file.
If you run a purge job or a restore job, the following is created on the DB Maintenance Service (at the
configured root path):
 A directory is created with the job name, if it doesn't already exist
 Under the job directory, a time-stamped log file is created

Note: If you run a restore job, the following warning is shown: Restoring to an operational production
database is not supported. Executing this type of restore will lik ely cause performance issues and
possible transaction failures. Do you wish to proceed?.

To run an APR job manually

1. Click Database Maintenance. The Database Maintenance tab appears with the list of APR jobs.
2. Right -click the job that you want to execute, and then click Run.
The execution status of the job is changed to running until the job is complete or aborted.
You cannot execute an already running job.

Version 6.1 287

MES Client User Guide Database Maintenance

Running an Archive or Purge Job Automatically

You can schedule an Archive or Purge job using the Windows Task Scheduler on the APR server. This
allows the Archive or Purge job to run automatically at a pre-determined time or on a regular basis, such
as daily, monthly, and so on.
Restore jobs cannot be run automatically. They must be run manually.
You must configure the scheduled job on the same computer as the AP R server using the Windows Task
Scheduler.
The proxy must be configured to send requests to this service in order for the command line program to
send its requests.
To run an Archive or Purge job automatically
1. On the Database Maint enance Service computer, open the Task Scheduler for Windows from the
Control Panel.
2. Double-click Add Schedule Task. The Schedule Task Wizard appears.
3. Click Next, and then click the APRSchedule.exe to run from Windows.
4. Click Next, and then specify the option to run this task:
If you want to run this task at a particular date and time, only then select One time only.
If you want to run this task at a recurring date and time, click any one of the following:
o Daily
o Weekly (and specify the day of week and time)
o Monthly (and specify the date of month and time)
5. Click Next.
6. In the User Name box, type your user name.
7. In the Pa ssword box, type your password to configure the task.
8. Click Next
9. Select the Open advanced properties for thi s ta sk when I click Finish check box.
10. Click Finish. The Advance Options dialog box appears.
11. Type the Job ID as a command line parameter.
12. Save and close all the windows. The job is scheduled to run.
You can manually remove any of the scheduled tasks that are not required.

288 Version 6.1

 MES Client User Guide

C HAPTER 32
Rejected Message Viewer
In This Chapter
Introduction to the Rejected Message Viewer ............................................................................... 289
Viewing and Editing a Rejected MES Command Message ............................................................. 290
Resubmitting a Rejected MES Command Message ...................................................................... 290
Deleting a Rejected MES Command Message .............................................................................. 291

Introduction to the Rejected Message Viewer

You can use the Rejected Messages module to view, edit, resubmit, and delete MES command
messages that are rejected by the middleware while using the Without Response communication mode.
When the Without Response communication mode is used, the MES command messages, such as add
production or add consumption are stored in the Message Queue table. The stored messages in the
Message Queue table are sent to the middleware without waiting for any responses from the
middleware.
The middleware can reject an MES command message due to errors, such as network errors or invalid
inputs. All the rejected MES command messages are stored in the Rejected Message table in the MES
database. When you open the Rejected Message s module, a list of all the rejected messages appears
in the Edi tor window.
By default, the Rejected Messages module is grouped under the System Management group in the
Navigation pane.
For more information on groups and modules, see Groups and Modules on page 29.

Version 6.1 289

MES Client User Guide Rejected Message Viewer

Viewing and Editing a Rejected MES Command Message

You can view and edit the following information of a rejected MES command message:
Status
Shows the status of a message. The green icon indicates that the message is modified, and the red
icon indicates that the message contains an error.
ID
Shows the unique identifier number of a message.
Time stamp
Shows the date and time when a message was recorded.
Object
Represents an entity object that is created by configuring the OCO. The OCO sends messages to
the middleware. The messages that are rejected by the middleware are shown in the Rejected
Message Viewer.
Error Message
Shows the reason for a rejected message.
Current Status
Shows the current status of the rejected messages, such as resubmitted with success or resubmitted
with error.
Users with the relevant privilege can view and edit the rejected MES command messages. For more
information on providing privileges to users, see User Groups and Users on page 37.
To view a rejected message
 Click Rejected Message s. A list of rejected messages is shown in the Editor window.
You can edit a rejected MES command message as per the error details and resubmit the message to
the middleware.
To edit a rejected message
1. In the workspace, click the message you want to edit.
The Propertie s pane shows the command name and attributes of the message. The following text
boxes are shown for each attribute.
Non-editable
Shows the default attribute value.
Editable
Shows the blank text box.
2. In the editable text box, type the new value for the attribute.
The Status check box changes to the green icon.
You cannot edit and resubmit a message with the status as Resubmitted with Success. This message
indicates that the message is already resubmitted successfully.

Resubmitting a Rejected MES Command Message

You can resubmit a rejected MES command message after y ou edit the message as per t he error details,
such as invalid inputs. You can also resubmit a rejected message without any editing if the message was
not submitted earlier due to net work errors such as connectivity problems.
You can simultaneously resubmit multiple rejected messages that do not require any editing, if
messages were rejected due to system errors such as database connection error.

290 Version 6.1

Rejected Message Viewer MES Client User Guide

When you resubmit multiple messages, each message is submitted in a sequence using the "With
Response" communication mode. The Rejected Messages module waits for a response for each
resubmitted message and then submits the next message in a sequence to the middleware. Th e status
of all the messages is updated in the MES database, and you can see the new status in the workspace.
To resubmit a rejected message
1. Click Rejected Message s.
2. Select the messages that you want to resubmit.
3. Right -click one of the messages and then click Resubmit.
The rejected message is resubmitted to the middleware.
If the message is successfully sent to the database, the Current Status column shows the Resubmitted
with Success status. If the message delivery fails, a new error message appears in the Error Li st pane.
You must fix any invalid errors to successfully resubmit a message.

Deleting a Rejected MES Command Message

You can delete a rejected message from the MES database regardless of the message status. You can
select multiple messages for deletion.
To delete a rejected message
1. Click Rejected Message s.
2. Select the messages that you want to delete.
3. Right -click one of the selected messages and then click Delete.
A confirmation message appears.
4. Click Yes. The selected message is removed from the MES database.

Version 6.1 291

 MES Client User Guide

C HAPTER 33
Serialization
In This Chapter
Introduction to Serialization ......................................................................................................... 293
Setting up Serialization in MES .................................................................................................... 293
Producing Serialized Items in Operator ........................................................................................ 299

Introduction to Serialization
Serialization is the process of assigning specific serial numbers to the produced items. These serial
numbers are associated with an item in the production process through lots. The lots that are assigned in
the production process contain only one item. The resulting serial number for an item is then transferred
automatically or manually in the production process (route).
Serial numbers are either used for a particular work order (hard-pegged) or they can be interchanged
between work orders as per the flow of the manufacturing process (soft -pegged).
To manage and track a serialized manufacturing proc ess, you must have privileges to create and edit:
 Items
 Processes
 Work orders and jobs
Serial number functionality requires specific configuration settings within the following MES applications:
 MES Client:
o To configure entities in the manufacturing process to store and receive materials, and for
auto-t rans fer operations to move the stored materials.
An auto-t rans fer operation automatically trans fers produced serial numbers to the next entity in
the routing based on an assumption that the storage capability of the entity is enabled.
o To configure item classes, items, BOMs, processes, operations, and work orders to define the
type of serialization for your manufacturing environment and how it is processed on t he plant
floor.
 MES Operator: To execute t he production proc ess using work orders and operations that are defined
in the MES Client to carry out the serialization process.
Once you set up the required user access and create the required entities to model the production
equipment, you can then define the specific ways to serialize the produced items.

Setting up Serialization in MES

To setup the Serialization, you must configure the following in the MES Client application:
 Item classes (see Configuring Item Classes on page 294)
 Items (see Configuring Items on page 294)
 Processes (see Configuring Processes on page 296)

Version 6.1 293

MES Client User Guide Serialization

 Rout e Map (see Creating a Process Route Map on page 298)

 Work Orders (see Creating a Work Order That Produces Serialized Items on page 299)

Configuring Item Classes

You can create item classes in the Product Definition Group to define the serialization proc ess that is
controlled by the produced items.
To set up an item class to define item serialization, you must configure the following attributes:
Produced (Required)
Serial Number Level
The S erial Number Level for an item class is the default value to use for an item that is creat ed under
that item class.
You can create a non-serialized item under an item class with the serial number level set to Lot
Number, or you can create a serialized item under an item class where the serial number level is set
to None.

For more information on configuring item classes, see Item Classes on page 137.

Configuring Items
You can create items for the production process and assign the item class that is created for the
serialization proc ess in the Product Definition Group. Also, you can define the format of the serial
number that is generated during an operation.
To configure items
1. Select the item class that is defined for serialization in the Item Class ID list. When you select an
item class, the Lot Number is automatically assigned to Serial Number Level.
If an item class is assigned a Serial Number Level as Lot Number, then the items under that item
class are automatically assigned t he same Serial Number Level. If the S erial Number Level is not set
to Lot Number for an item class, you can set the Serial Number Level of an item as Lot Number to
indicate the item as a serialized part.
294 Version 6.1
Serialization MES Client User Guide

2. In the Inventory Handling section, type a format for the lot number or serial number in the Lot
Number Format text box. This is an optional field that provides a default format to the lots when
creating the serial numbers.
The product-specific identifier must be followed by the -### attribute for the aut omatic serial number
sequence generation.
For example: Std_Kitchen-### would produce the following serial number sequence:
o Std_Kitchen-001
o Std_Kitchen-002
o Std_Kitchen-003
o Std_Kitchen-004

For more information on configuring items, see Creating an Item on page 119.

Configuring BOMs
After you configure items for serialization, you can create a BOM item that adds production-specific
details for the usage of the produced item.
To configure an item BOM
1. In the To Storage Location box, browse and select a storage location for the item from the entities
that are configured for the production process. This attribute is optional.
2. Select the Must Consume from Inventory check box. This is a required attribute.
3. Select Must Consume from WIP check box. WIP is Work-in-progress. This attribute is optional.
If this attribute is selected (hard-egged), a given serial number is processed only for jobs that belong
to a particular work order.

Version 6.1 295

MES Client User Guide Serialization

If this attribute is not selected (soft-pegged), a given serial number can be interchanged between
work orders as it flows through the manufacturing process.

For more information on configuring BOMs, see Creating a BOM for an Item on page 128.

Configuring Processes
You can create a process to define the production method to produce an item and instantiate the work
orders for the item from the Proce sse s module in the Operations Management group.
1. Create the process and define a process class ID.
2. Type a brief description about the process.
3. In the Status list, click the required status for the process except Di sabled.
The following options are available in the Status list:
o Di sabled
o Experimental
o Approved
o Certified
You must set the status of a process and an item linked to that process to at least the mi nimum
required by the system attribute Lowest level process that can be instantiated before creating a work
order for an item.

296 Version 6.1

Serialization MES Client User Guide

4. Add an item that is to be produced.

For more information on configuring processes, see Creating a Proc ess on page 176.

Configuring Operations
After you configure the process for the item that you are creating for serialization, you can define the
operations to produce the end product.
1. Select the process that you have created and configure required operations in sequence to produce
the end product.
2. After you configure the required operations, select and assign the entity that is associated with each
operation.

For more information on configuring operations, see Adding an Operation to a Process on page 180.

Version 6.1 297

MES Client User Guide Serialization

Creating a Process Route Map

After you configure the required operations, create a rout e map to link the operations with the process.

For more information on configuring the route map, see Creating a Route Map on page 273.

298 Version 6.1

Serialization MES Client User Guide

Creating a Work Order That Produces Serialized Items

After you configure the item class, items to be serialized, BOM, process, operations, and rout e map, you
can create the work order from the process that you have created to produce the serialized items.

For more information on creating a work order from a process, see Creating a Work Order from a
Process on page 241.
You can set whether you are doing hard-pegged or soft-pegged based on a work order. You can edit the
BOM 0 settings for each job and change the Must Consume from WIP setting.

Producing Serialized Items in Operator

After you have created the work orders in the MES Client, the work orders are available for production
through the MES Operator application. The MES Operator application provides the necessary
production controls to create and manage the serial numbers of the defined items.
Additional buttons become available for the MES Operator button bar after a work order that produces
serialized items is selected in the queue. The additional buttons in the MES Operator button bar allow an
operator to create and assign serial numbers and transfer serialized parts from one inventory location to
another.
The following are the additional controls:

 Add/Assign Serial Numbers : This button is enabled when the item produced by the selected
job is serialized and the job is not in a Completed or Canceled state. When you click this button, the
Add/Assign Serial Numbers dialog box appears. In the Add/Assi gn Serial Numbers dialog box,
you can assign serial numbers to jobs per the defined required quantity.
You can use this button to add new serial numbers and assign them to a work order before starting
the first operation.

Version 6.1 299

MES Client User Guide Serialization

 Transfer Serial Numbers : This button is enabled when the item produced by the selected job
is serialized and the job is not in a Completed or Canceled state. When you click this button, the
Transfer Serial Numbers dialog box appears. In the Transfer Serial Numbers dialog box, you can
select a source and destination inventory location to trans fer serialized items. You can select one or
all of the items in the source inventory location and move them to the destination location.

Controlling the Serial Numbers Flow

By default, linear flow is enabled for both hard and soft pegged methods of serialization. The produced
serial numbers continue to flow in a linear order through the rout e. The linear flow does not prohibit the
ability to transfer produced serial numbers to other operations within the same work order or different
work orders based on system configuration settings.

Linear Flow
Linear flow enables the movement of produced serialized items through the route. The serial numbers
that are produced prior to the operation are available for production.
If you configure the BOM to consume from WIP, only serial numbers that are produced and are in
inventory at the next operation storage entity, are available to return to the operation where they were
produced. The previous and next operations in a job route are identified using the job route links.

Manual Transfer of Serial Numbers

You can use the Transfer Serial Numbers dialog box to find and trans fer serial numbers to run on entity
based on the serialization method and the level of control over the flow of serial numbers through the
process routing.

First Operation Production

A work order routing contains at least one designated first job. If you do not require linear flow f or the
work order, production can start through the work order at any job that uses that item.
When an item is soft pegged, MES Operator checks the loc al inventory for available serial numbers. If no
serial numbers are found, MES Operator checks for the serial numbers that are assigned to a work order
and are not in process in the Lot table. The Add Production dialog box lists all the serial numbers in
local inventory and all the serial numbers in the assigned Lot table that are not started.
If an operator has permission to create a new serial number and no serial number is assigned to a work
order, an operator can add serial numbers and assign them to a work order.

Intermediate Operation Production

The Add Production dialog lists all incomplete serial numbers at the entity running the job or at its
parent entity for the produced item. If a job is hard pegged, you can see the serial numbers produced for
a work order to which the job is associated. You can see the serial numbers that are complet e for an
operation but you cannot see the list of incomplete serial numbers. This does not include serial numbers
that are cons umed in a downstream operation.
If the job BOM storage locations are defined as the downstream entity for the next operation or i ts parent
for each operation in the route, the produced serial numbers are transferred by default to the entity that is
scheduled to run the next job in the work order.
If the serial numbers are not stored at the entity or its parent entity on which you ar e running a job, you
must use the Transfer Serial Numbers button to manually trans fer the produced serial numbers to the
current job location.

300 Version 6.1

Serialization MES Client User Guide

Last Operation Production

The last operation in a process is flagged and considered as last for all serialization methods and
respective functionalities. When a serial number is completed in the last operation, the status field in the
assigned lot table record changes to complete.

Version 6.1 301

 MES Client User Guide

C HAPTER 34
Sample Plan Frequency
In This Chapter
Introduction to Sample Plan Frequency ........................................................................................ 303
Applying Filters ........................................................................................................................... 304
Creating a Sample Plan Frequency .............................................................................................. 304
Determining Frequency Type Shift ............................................................................................... 307
Determining Frequency Type Production Count ............................................................................ 308
Data Change Frequency ............................................................................................................. 309

Introduction to Sample Plan Frequency

You can use the Sample Plan Frequency module to create, maintain, and remove sample plan
frequency definitions.
When you open the Sample Plan Frequency module, a list of all the existing sample plan frequencies is
shown in the workspace.
A sample plan frequency is the given interval for collecting samples for measuring quality. A sample plan
frequency can be associated with multiple sample plans and a sample plan can have multiple sample
plan frequencies.
Sample plan frequencies are defined based on the following:
 Calendar or clock time
 Time pattern within current shift
 Production unit count
 Occurrence of specific events (job start or end, lot number change for t he main item being produc ed)
There can be multiple sample plan frequencies at any given time.
By default, the Sample Plan Frequency module is grouped under the Quality Management group in
the Navigation pane. For more information on groups and modules, see Groups and Modules on page
29.
You can modify an existing sample plan frequency, except under the following conditions:
 You cannot modify the type of a sample plan frequency if it is linked to a sample plan.
 You cannot modify the Dat a Change event type of a sample plan frequency if it is linked to a sample
plan.
You can delete an existing sample plan frequency from the MES database if it is not linked to any sample
plan. For more information on deleting, see Deleting an Entry on page 20.

Version 6.1 303

MES Client User Guide Sample Plan Frequency

Note: An error message appears if the sample plan frequency cannot be saved. Modify the sample plan
frequency, as needed, to correct the error and save to clear the error.

Applying Filters
The Apply Filter function allows you to view a list of sample plan frequencies, whic h matches the filter
options you enter.
To filter a sample plan frequency
1. In the Navigation pane, click the Sample Plan Frequencies module.
2. Select the required filter option from the Sample Plan Frequency Filter section.
In the Sample Plan Frequency Filter section, the following filter options are available:
Name
Name of the sample plan frequency. You can type any character within the sample plan frequency
name.
Description
Description of the sample plan frequency. You can type any character within the sample plan
frequency description.
Type
Type of frequency.
3. Click Apply Filter. The list of sample plan frequencies matching the filter is shown.

Creating a Sample Plan Frequency

A sample plan frequency is created to determine the interval for generating samples. You can create
multiple sample plan frequencies.

304 Version 6.1

Sample Plan Frequency MES Client User Guide

If y ou have the privileges to edit sample plan frequency settings, you can create a s ample plan frequency
in the Sample Plan Frequencies tab. If the editor is open, a new sample plan frequency is added to the
editor. If the editor is not open, you need to open the editor first and then add a new sample plan
frequency to the editor.
To create a sample plan frequency
1. On the ribbon, click New Sample Plan Frequency in the New list.
2. In the Properties pane, complete the property settings. See Sample Plan Frequenc y Properties on
page 305.
3. On the ribbon, click Save in the Main group to save the changes.
An error message appears if the sample plan frequency cannot be creat ed. Modify the sample plan
frequency, as needed, to correct the error, and save to clear the error.

Sample Plan Frequency Properties

There are required and optional sample plan frequency properties that apply to any sample sample plan
frequency type. There are also additional optional properties that are associated with t he Shift, Calendar,
and Production frequency types.

Required Properties
Sample Plan Frequency Name
The unique name for the sample plan frequency.
Sample Plan Frequency Type
The type of frequency. You can select any of the following:
o Shift
o Calendar Time, the default
o Production
o Job start
o Job end
o The lot number of the main item produced changes
o Manual

Optional Properties for Any Frequency Type

Sample Plan Frequency Description
A description of the sample plan frequency.
Enabled
Specifies whether to enable the sample plan frequency definition.
Sample Expiry Time: Value and Unit
The time that specifies the interval for collecting samples befo re the status is changed to Missed.
Sample Warning Time: Value and Unit
The time that specifies the interval for collecting samples before the status is changed to Ready
Warning.
Sample_Freq Spare–4
User-defined information about the sample plan frequency.

Version 6.1 305

MES Client User Guide Sample Plan Frequency

Optional Properties for Shift Frequency

Interval: Value and Unit
The time interval for sampling.
You can link a sample plan frequency to QM specifications, as definitions of shifts are tied to entities,
either directly or by inheritance. The QM specification must have at least the context of an entity,
entity class, or item that has a shift schedule, so that the start and end of the shift can be determined.
The unit of the interval. You can select any of the following:
o Seconds
o Minutes
o Hours
o Days
o Weeks

For example, an int erval of 2 hours and a shift that runs from 8:00:00 AM to 3:59:59 PM will have
samples at 8, 10, 12, and 2 assuming that there are no start or end offset, and no samples per shift.
Offse t Start: Value and Unit
The amount of time calculated from the start of a shift when the first sample is generat ed. For
example, if the shift starts at 8:00 AM and the Offset Start is 15 minutes, then the first sample occurs
at 8:15 AM.
Offse t End: Value and Unit
The amount of time calculated from the end of a shift when the last sample is generated. For
example, if the shift ends at 4:00 PM and the Offset End is 15 minutes, then the last possible sample
occurs at 3:45 PM.
Depending on other settings of the shift frequency definition, there is no guarantee that a sample will
occur at this time.
Samples Per Shift
The number of samples that are generated in every shift. The minimum value that you can type is 2.
For example, a value of 2 for samples per shift, and no setting for the interval creat es a sample at
shift start and offset start, and a sample at shift end minus offset end.
For more information on run time sample generation, refer the MES Service User Guide.

Optional Properties for Calendar Frequency

Interval: Value and Unit
The time for which future sample requests are generated.
The available units are:
o Seconds
o Minutes
o Hours
o Days
o Weeks

Offse t Start: Value and Unit

The time interval for generating samples at a specific time of day. This option is only available if the
interval unit is hours, days, or weeks.

306 Version 6.1

Sample Plan Frequency MES Client User Guide

If the interval unit is hours, this setting is the time offset from midnight for the first sample of the day.
If the interval unit is days or weeks, this setting is the time offset from midnight on Sunday for the first
sample.
Future Sample Generation: Va lue and Unit
The time interval for the MES Service to predict future samples for this frequency. If this field is
empty, the MES Service predicts future samples up to the end of the current shift.

Optional Properties for Production Frequency

Production Re set Option
The appropriate production reset option for production.
For a production frequency, prediction of the request time for the first sample may take into
consideration production counts from previous jobs within the context of the active QM specification.
This option determines when the production counts from previous jobs will be reset to 0. The choices
are:
Never
Always use all applicable context records matching the context of the QM specification. In
certain cases, this will be more than one record.
The job changes
When a new job is run on an entity, all applicable cont ext records are set to 0.
Main item produced changes
When a new job is started on an entity that is producing a different item from the previous item
run on the entity, all applicable cont ext records are set to 0.
Shift changes on entity
At the completion of a shift change, all applicable cont ext records are set to 0. This will impact
the sample request times for samples based on the current job.
Production: Value and Units
The number of units produc ed that will trigger the creation of a sample.
Future Sample Generation: Value and Unit
The time interval for the MES Service to predict future samples for this frequency. When samples are
generated for a specific time in the future, it does not matter whet her the sample request time falls
beyond the current shift’s end or not. If this field is empty, the MES Service predicts future samples
up to the end of the current shift.
For more information about using the production type sample plan frequency, refer to Determining
Frequency Type Production Count on page 308.

Determining Frequency Type Shift

If a sample plan frequency is configured to generate future samples for a shift, then the QM specification
that uses this sample plan frequency and has the highest specificity (and is currently effective), is used to
generate fut ure samples up to the end of the shift. If a QM specification is effective during a shift rather
than at the beginning, the exact sample time is delayed until the sample frequency becomes effective.
The conditions to generate a sample plan based on the shift start offset and shift end offset are as
follows:
 If the sample plan frequency contains a value for the shift start offset, then the first future sample for
the current shift is generated. In this case, the sample request time is equal to the offset start from
the current shift start time. Further samples are generated based on the effective time between
samples.

Version 6.1 307

MES Client User Guide Sample Plan Frequency

 If the sample plan frequency contains a value for the shift end offset, then the last future sample for
the current shift is generated. In this case, the sample request time is equal to the offset end from the
current shift end time. The sample request time also includes the offset end from the current shift end
time.
 If the number of times to take samples in a shift is specified instead of time bet ween samples, the
effective time between samples is calculated as:

 Before determining the effective time between samples, the offset_start value and offset_end value
are added to the current shift start time and current shift end time, respectively. For example, the first
sample is always requested at the beginning of the shift, if there is no offset, or at the offset start time
from the beginning of the shift.
 The last sample is requested at the end of the shift, if there is no offset, or at the offset time from the
end of the shift.
 The remaining sample requests are divided at equal intervals between the first sample requested
time and the last sample time.
 The minimum number of samples requested for a shi ft must be at least 1, which will generate a
single sample at the offset start time regardless of any other settings.
 If the number of times per shift and the interval are both specified, then the first sample is generated
at the offset_start value. Additional samples are generated at the time interval up to a maximum of
the number of times per shift or the shift end time minus the offset_end, whichever comes first.

Determining Frequency Type Production Count

If a sample plan frequency is configured to generate future samples for a production count
frequency—that is, the sample plan frequency type is Production—and the frequency is configured to
count individual units, the active QM specification using this frequency generates future samples either
to the end of the shift or the time specified in the future sample generation property. For samples to be
generated for this frequency, a job must be running on the entity.
The job’s production rate is used to estimate the time when future samples will be generated. For
example, a production unit count frequency of every 50 units in effect when a job wit h a production rate of
10 batches per hour and a batch size of 20 units per batch will create future samples 15 minut es apart
(for additional information about batch size, see Understanding Batches and Lots for OEE and Estimated
Times on page 74).
50 units / (10 batches/hour * 20 units/batch) * 60 minutes / hour = 15 minut es
Samples will be predicted when the job starts on the entity and any remaining future samples will be
deleted when the job stops. Future samples will be predicted to the end of the shift if there is no Future
sample generation setting; otherwise, samples will be generat ed up to the "future sample generation"
interval. In either case, samples will be predicted to cover only the starting quantity of the job plus one
additional sample for over production. Using the above frequency example, if a job is started with a start
quantity of 225 units, then 5 samples will be generated every 15 minutes apart. If the Future sample
generation setting is 0, then no fut ure sample are generated and the frequency behaves as an event
frequency generating samples with the production of a sufficient quantity of units.

308 Version 6.1

Sample Plan Frequency MES Client User Guide

Unlike the calendar and shift frequencies, future production unit count samples are readied only when
the required number of units have been produced instead of based on the fut ure sample request time.
Both good and bad counts of production are considered when readying a sample. As production counts
are recorded against the job, the total is maintained in a context table in the database. This includes
when the production quantity is reduced. When a production transaction causes the total to equal or
exceed the frequency interval units, then the next available future sample will be readied by the MES
Service during the next update of sample status. This might take up to the time period specified by the
system parameter Frequency to call sample updates (in seconds), which has a default of 30 seconds.

Data Change Frequency

Data change frequencies are not processed by the MES Service. These frequencies generate samples
with the corresponding event through the middleware. In general, these are MES Operations type
transactions that generates a new sample for an entity when the call is processed by the middleware.
Job Start/Job End
Both these frequencies are based on a job running on an entity. When a QM specification has the
context of an item and/or operation, then a job must be active on the entity for t he QM specification t o
be active.
o If the QM specification has a sample plan that contains a job start frequency, the job start
transaction generat es a new sample on the entity.
o If the QM specification has a sample plan that contains a job end frequency, the job end
transaction generat es a new sample on the entity.
Lot number of main item produced changes
This frequency is based on a job running on an entity. When the call is made to change the lot
number of the main item produced (JobExec.SetCurLotDat a API call for BOM Position 0 which is the
main item produced), a new sample is generated on the entity. This event happens when the lot
number is set for the job, not when the job produce transaction is called. The lot number produced is
different from the previous lot number.
This event frequency is applicable only to QM specifications that have item/item category and/or
process/operation contexts. A QM specification with only an entity context will not have samples
generated for this frequency type.
Manual
This frequency definition is provided as a mechanism to indicate that the Sample.GenerateSample
API call will be used at run time to generate an ad-hoc sample. It is not associated to any other MES
Operations or performance transaction. Since a QM specification must include a sample plan and a
sample plan must include a sample plan frequency, the manual frequency is provided so that a
manual QM specification can be defined in the system and used by the call.

Version 6.1 309

 MES Client User Guide

C HAPTER 35
Sample Plans
In This Chapter
Introduction to Sample Plans ....................................................................................................... 311
Applying Filters to the List of Sample Plans .................................................................................. 312
Creating a Sample Plan .............................................................................................................. 312
Sample Plan Properties ............................................................................................................... 312
Sample Naming Conventions and Replaceable Parameters .......................................................... 313
Linking a Sample Plan Frequency to a Sample Plan ..................................................................... 315

Introduction to Sample Plans

You can use the Sample Plan module to configure and to associate sample plan frequencies to the
sample plan. Sample plans are constructed to generate samples at run time.
When you open the Sample Plan module, a list of all the existing sample plans is shown in the
workspace.
This module is grouped under the Quality Management group in the Navigation pane. For more
information on groups and modules, see Groups and Modules on page 29.
A sample plan is a collection of sample frequencies and the templat e for naming samples at run time.
The sample plan frequency is the given interval to generate samples. It is also used to define the given
time when samples are collected.

Version 6.1 311

MES Client User Guide Sample Plans

Applying Filters to the List of Sample Plans

The Apply Filter function allows you to view a list of sample plans, which matches the filter options that
you enter.
To filter the list of sample plans
1. In the Navigation pane, click the Sample Plans module.
2. Select the required filter option from the Sample Plan Filter section.
In the Sample Plan Filter section, the following filter options are available:
Plan Name
Name of the sample plan. You can type any character wit hin the sample plan name.
Plan Description
Description of the sample plan. You can type any character within the sample plan description.
3. Click Apply Filter. The list of sample plans matching the filter is shown.

Creating a Sample Plan

A sample plan is created to collect user inputs at a given time. You can save multiple sample plans
simultaneously. To save a sample plan, you need to link at least one sample plan frequency to it.
You can delete a sample plan if there is no active quality management specification linked to it.
You must have the privileges to create a sample plan.
To create a sample plan
1. On the ribbon, click New Sample Plan in the New list.
2. In the Properties pane, complete the settings. See Sample Plan Properties on page 312.
3. On the ribbon, click Save in the Main group to save the changes.
An error message appears if the sample plan cannot be creat ed. Modify the sample plan, as needed, to
correct the error, and save to clear the error.

Sample Plan Properties

Sample Plan Name
The unique name for the sample plan.
Sample Plan Desc
A description of the sample plan.

Note: In the MES 2014 SP1 releas e, the Verified Write setting is not enforced within the Sample
Viewer control.

Verified Write
Specifies whether a confirmation from an operator is required before saving a set of characteristics
for a sample. By default, this option is not selected.
Sample Naming Convention
The template for naming the samples when they are created at run time. The naming convention for
sample plan at run time consists of replaceable parameters enclosed in square braces and/or literal
text. For more information, refer to Sample Naming Conventions and Replaceable Parameters on
page 313.
Numbering Re set Option
The ordinal number used in a sample plan name. A vailable only when the sample plan name
contains an ordinal number.

312 Version 6.1

Sample Plans MES Client User Guide

The available options are:

o Never: The default. The number will be continually updated for every sample generated by the
sample plan.
o Change in Local Date: The number will be reset to 1 for each day change.

Sample Plan Spare1–4

User-defined information about the sample plan.

Sample Naming Conventions and Replaceable Parameters

The naming convention for the sample plan at run time consists of replaceable parameters enclosed in
square braces and/ or literal text.
An example sample naming format is:
[SamplePlanName][YYYY][MM][DD][####]
where
 [YYYY][MM][DD] represents the date
 [####] represents the unique ordinal number, when the rest of the name (except the dat e) is the
same
 The SamplePlanName is taken from the plan_id field in the database.
The available database fields that can be referenc ed are:
plan_name
Specifies the name of the sample plan that is used for collecting samples.
ent_ name
Specifies the entity at which samples are being collected.
wo_id
Specifies the work order of the job for which samples are being collected.
oper_id
Specifies the operation for which samples are being collected.
seq_no
Specifies the sequence number of the job for whic h samples are being collected.
segment_requirement_id
Specifies the segment requirement of the samples collected.
segment_re sponse_id
Specifies the segment response of the samples collected.
item_id
Specifies the item to which the samples collected are assigned.
char_name
Specifies the characteristic of a QM specification to which the sample plan is associated. If there are
more than one characteristic linked to the sample, only the first characteristic in the sample is used.
qm_spec_name
Specifies a QM specification associated with the sample plan.
freq_name
Specifies a frequency that is linked to the sample plan.

Version 6.1 313

MES Client User Guide Sample Plans

Replaceable Parameters
To easily identify the group of samples by a templat e name in a report, a replaceable parameter is used
to generate sample names. When a sample is generated, the actual sam ple name (sample. sample
name) is derived from the templat e sample name (sample_plan.sample_name) that is configured for the
sample plan from which the sample is generated.
Replaceable parameters must be enclosed in square brackets []; for example, as a date string
[yy]-[mm]-[dd] would create a sample name of 15 -01-01 on January 1, 2015. This indicates that the
characters can be replaced. [YYYY][MM][DD] represents date information and these must come from the
requested_time_local field of the sample table.
The replaceable parameter that is configured inside the square brackets for the template sample name is
resolved only if the replaceable parameter exactly matches the replaceable parameter that is defined in
the table below and the result contains a non-null value. Otherwise, the replaceable parameter is used
exactly as it is configured in the template sample name. If the replac eable parameter cont ains a date
parameter, the date value is resolved to the local date (sample.requested_time_local).
If a replaceable parameter is nested inside other replaceable parameters, the replaceable parameters
that exactly match with the replaceable parameters listed in the table below are replaced. However, the
replaceable parameters will not recursively resolve other replaceable parameters when a value returned
from one of the replaceable parameter is same as the replaceable parameter listed in the table below.
The following table shows a list of replaceable parameters that can be successfully replaced from the
template sample name. The following table shows examples that use the current date by default
(10/27/2015 local date).

Replaceable Parameter (Case

Insensiti ve) Value Returned Example

[YYYY] Year 2015

[MM] Month of the year (integer) 10 (with leading zeros)

[MONTH] Name of the month October

[DD] Day of the mont h 27 (includes leading zeros)

[WW] Week of the year 44 (includes leading zeros)

[DAY] Day (in full) of the week Tuesday

[WD] Day of the week 3

[DY] Day of the year 298 (includes leading zeros)

[EntityName] Name of the entity Blender

[WorkOrderID] Work Order ID WO123456

[OperationID] Operation ID BlendingOperation

[SequenceNumber] Job Sequence Number 0

[ItemID] Item ID Item123456

314 Version 6.1

Sample Plans MES Client User Guide

Replaceable Parameter (Case

Insensiti ve) Value Returned Example

[CharacteristicName] Characteristic Name Viscosity

If a sample cont ains more than
one characteristic, the name
from the first characteristic that
is added to this sample is
returned.

[QMSpecName] QM Specification Name QMSpecA

[FrequencyName] Frequency Name FrequencyA

[SamplePlanName] Sample Plan Name SamplePlanA

[Segment RequirementID] Segment Requirement ID SegmentRequirement

[Segment ResponseID] Segment Response ID SegmentRes ponse

[####] Integer value returning the next 0001 (includes leading zeros)
highest number. If none is
found, it returns 1, including
leading zeros. If the maximum
is reached, then the maximum
value is retained.
The number of octothorpes is
not limited for a template
sample plan name.

Linking a Sample Plan Frequency to a Sample Plan

A sample plan frequency can be linked to a sample plan. Only one sample plan frequency of a given type
may be linked to the sample plan, except for data change events, multiple data change events may be
linked to the same sample plan.
You can add single frequencies for shift time, calendar time, entity run time, and entity production. You
can add multiple frequencies for data change events to a sample plan as long as the data change events
are for different events.
The Frequencies pane shows a list of all the sample plan frequencies linked to the selected sample
plan.
To link a sample plan frequency to a sample plan
1. In the workspace, select the sample plan to which you want to assign a sample plan frequency.
2. On the ribbon, click Add Link in the Current View group.
The Sample Plan Frequency Links dialog box appears.
3. Select any filter to limit the result set and click Apply Filters to retrieve a list of available sample plan
frequencies.
4. Select the sample plan frequencies you want to assign to the sample plan and click OK.

Version 6.1 315

MES Client User Guide Sample Plans

5. On the ribbon, click Save in the Main group to save the changes.
You can delete the sample plan frequencies assigned to a sample plan.

316 Version 6.1

 MES Client User Guide

C HAPTER 36
Variable and Attribute Characteristic
Definitions
In This Chapter
Introduction to Variable and Attribut e Characteristic Definitions ...................................................... 317
Applying Filters to the List of Characteristics ................................................................................. 318
Managing Characteristics ............................................................................................................ 318
Cont rolling the Amount of Data Used in Calculating Process Statistics ........................................... 320
Creating a Characteristic ............................................................................................................. 321
Linking an Attribute to a Characteristic ......................................................................................... 326

Introduction to Variable and Attribute Characteristic

Definitions
You can use the Characteri stic module to create, maint ain, and remove variable and attribute
characteristic definitions.
When you open the Characteri stic module, a list of all the existing variable and attribut e characteristics
is shown in the workspace.
A characteristic is an aspect of an item, process, or physical entity that can be measured. You can
configure characteristics for variables and attributes, and associate them with categories.
By default, the Characteristic module is grouped under the Quality Management group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.
You can modify one or several characteristics, but you cannot modify its type such as variable, count ed
attribute, and binary attribute. This is because when the characteristic type is changed, the
corresponding information also changes making it invalid. Once saved, you cannot modify the
characteristic type.
You can delete a characteristic if it is not linked to any QM specification that is currently effective. For
more information on deleting, see Deleting an Entry on page 20.

Version 6.1 317

MES Client User Guide Variable and Attribute Characteristic Definitions

An error message appears if the characteristic cannot be saved. Modify the characteristic, as needed, to
correct the error and save to clear the error.

Applying Filters to the List of Characteristics

The Apply Filter function allows you to view a list of characteristics, which matches the filter options that
you enter.
To filter the list of characteristics
1. In the Navigation pane, click the Characteristic module.
2. Select the required filter option from the Characteri stic section.
In the Characteristic section, the following filter options are available:
Name
Name of the characteristic. You can type any character within the characteristic name.
Description
Description of the characteristic. You can type any character within the characteristic description.
Type
Type of the characteristic.
Severity
Severity of the characteristic.
3. Click Apply Filter. The list of characteristics matching the filter is shown.

Managing Characteristics
The workspace shows the name, description, type, severity, and other details of the variables and
attributes. You can create, modify or delete a characteristic.
You must provide the following information to save either a variable or an attribute characteri stic:

318 Version 6.1

Variable and Attribute Characteristic Definitions MES Client User Guide

Name
The name of the characteristic.
Type
The type of the characteristic:
o Variable: Supports a floating point number to record product or process data such as
temperature, pressure, diameter, etc.
o Counted Attribute: Used to enter a count of defects found on a unit.
o Binary Attribute: Used to det ermine whether a condition exists or whether the unit being
inspected is defective. This is a count of defective units for a specific flaw.

Unit of Measure
The unit of measure of a characteristic.
Severity
The severity options can be modified through language strings. The default options are:
o Unused: Specifies the characteristic is not available for data entry at run time and is not included
in the new samples that are generat ed. It is retained for historical reasons.
o Not Monitored: Specifies the characteristic is available for recording data at run time, but no run
rule violations are evaluated.
o Non-Key: Specifies the characteristic is available for recording values and checking run rules.
o Key: Specifies the characteristic is available for recording values and checking run rules. If a run
rule is violated and there are no out -of-control conditions for a critical characteristic nor
out-of-spec conditions for either a key or critical characteristic, the result is Out Of Control -
Key.
o Critical: Specifies the characteristic is available for recording values and checking run rules. If a
run rule is violated and there are no out-of-spec conditions for a critical characteristic, the result
is Out Of Control - Critical.

Default Chart Type

The SPC charting to be used while evaluating run rule violations. The options depend on the type of
characteristic.
If the characteristic type is variable, then the default chart type can have X-B ar, X-Individual, and
Moving A verage. If the characteristic type is binary attribute, then the default chart type c an have p or
np. If the characteristic type is counted attribut e, then the default chart type can have c, u, and
DPMO.
Number of Decimals
The number of decimals allowed for entering variable characteristic results and the number of
decimals displayed in a chart for fields like control limits (applicable to both variables and attribut es).
If the characteristic type is attribute, then the decimals apply only to p, u, DPMO charts, and
statistics.
Automatic Characteristic Collection
Enables the automatic collection of data within the Sample Recording Object (SRO) and the time
interval between measurements within a sample. When a sample transitions to the ready state, at
run time, the SRO records all characteristics marked for automatic collection. If multiple
measurements are required, an initial measurement is immediately recorded. This is followed by the
measurements recorded at a specified time interval. If you select this option, you cannot manually
enter data for this characteristic available in the Sample Viewer .Net control.
Filter by options
You can filter by:

Version 6.1 319

MES Client User Guide Variable and Attribute Characteristic Definitions

o Entity ID
o Item ID
o Work Order ID
o Operation ID
o Process ID
o Segment Requirement ID
o Segment Response ID
o Spare1, Spare2, Spare3, and Spare4

These options determine the following:

o Data that is to be ret urned while analyzing rule violations when new data is saved.
o Data that is to be displayed in a chart of the characteristic.

For example, if an operator enters new data for a characteristic, t he new data will have contextual
information of the entity and possible cont ext of item that is produced, work order running on the
entity, process and operation currently being performed, the S95 data or spare fields provided by the
user. When the characteristic data is evaluat ed for a rule violation such as 4 of 5 outside 1 standard
deviation, the software retrieves prior results for the characteristic. The filter_by fields filter the
returned values to only include those records which have the same value as the specified filter_by
fields. If entity and item are enabled as filter fields, then the query retrieves historical records having
the same entity and item as the record being saved.
The optional information for defining a characteristic are: descript ion, run rule exceptions, spare fields,
and filter_by options.

Controlling the Amount of Data Used in Calculating Process

Statistics
In addition to a characteristic’s Filter by options settings, described in the previous topic, the following
system parameters can be used to control the amount of sample dat a that is inc luded in the calculation of
process statistics. These parameters are included in the Di splay group of the General Parameters
module.
Cut-off time in days to limit the number of samples while calculating process stati stics from
the samples (0 = Include all samples)
Upper bound on the age of sample data used to calculate process statistics. This time range is
applied to the sample’s requested time. Us e this parameter to exclude sample data that is
considered too old to be relevant. For example, setting this parameter to a value of 2 would mean
that only the last 2 days of sample data would be used to calculate process statistics.
Number of samples to consider calculating process stati stics
Maximum number of samples to include when calculating process statistics. Use this parameter to
tune the performance of the system so that there is not too much dat a being analyzed.
These two parameters do not affect the calculation of control limits from the data, which is based on the
Samples for Cont rol Limit setting in the characteristic configuration.

320 Version 6.1

Variable and Attribute Characteristic Definitions MES Client User Guide

These two parameters are used when calculating the statistics that are recorded in the stats table. They
can help you to control system performance and ensure that statistic calculations use only recent dat a.
The Cut-off time in days parameter allows you to exclude data that is no longer relevant. The Number of
samples to consider parameter allows you to tune the performance of the system by placing a cap on
how much data will be included in the process statistics calculation. Logically, they would be used
together as follows:
 Perform the process statistics calculations on the top < Number of samples to consider> samples
from those that were recorded in the last <Cut-off time in days> days.
For example, if 10 samples per day are being recorded, the cut -off time is set to 2 days, and the number
of samples to consider is set to 12, then only the most recent 12 samples will be included in the process
statistics calculation. However, if the number of samples to consider is set to 30, and there are 2 days
wort h of samples recorded, then the most recent 20 samples will be included in the process statistic s
calculation.

Creating a Characteristic
You must have the privileges to create a characteristic.
To create a characteristic
1. On the ribbon, click New Characteristic in the New list.
A new characteristic record is created.

2. In the Propertie s pane, complete the property settings. See Characteristic Properties on page 322.
3. On the ribbon, click Save in the Main group to save the changes.
An error message appears if the characteristic cannot be created. Modify the characteristic, as needed,
to correct the error, and save to clear the error.

Version 6.1 321

MES Client User Guide Variable and Attribute Characteristic Definitions

Characteristic Properties
Name
The unique name for the characteristic.
Description
A description for the characteristic.
Type
The type of the characteristic.
For more information about the characteristic types and the additional property settings related to
them, see Variable Characteristic Properties on page 323, Binary Attribute Characteristic Properties
on page 324, and Count ed Attribute Characteristic Settings on page 325.
Unit of Measure
The unit of measure for the characteristic.
Severity
The enumerated value for the severity type.
Default Chart
The enumerated value for the default chart. The value depends on the characterist ic type.
Automatic Characteristic Collect
The characteristic that needs to be collected automatically. By default, the False option is selected.
Time Interval
The time interval between the measurements when the sample size is greater than one and the
characteristic is collected automatically. This shows the delay bet ween measurements within a
sample, and is applicable only to variable characteristics.
Time Interval Unit
The unit of the interval:
o Seconds
o Minutes
o Hours

Number of Decimals
The number of decimals that are to be displayed. By default, the number is 0.
Normal Sample Size
The normal number of measurements in a sample.
o If the characteristic type is a variable or an attribute with a fixed sample size, the normal number
of measurements in a sample is displayed.
o If the characteristic type is a variable and normal sample size is 1, the data is not grouped.

Minimum Sample Size

The minimum number of measurement required in a sample. If a sample is collected and t he number
of measurements is less than the minimum value, the subgroup is not charted in the SPC charts. The
subgroup is also not included while evaluating the run rule violations bas ed on the SPC charts.
Maximum Sample Size
The maximum number of measurement required in a sample. You cannot enter more measurements
than the maximum measurement value.

322 Version 6.1

Variable and Attribute Characteristic Definitions MES Client User Guide

Number of Defect Opportunities

The number of defect opportunities for every tested item. This is available only for counted attributes.
Samples Required Before Control Limits Are Calculated
The number of samples that are required for calculating the control limits. By default, the samples
before control limit value is 1.
Characteristic Spare1–4
User-defined information about the characteristic.

Variable Characteristic Properties

Variable characteristics are measured as floating point numbers for parameters, such as width, weight,
temperature, and hardness.
If you select a variable type characteristic, you need to provide the following additional information:
Data Grouping
 Grouped
 Individual
The grouping of data is based on the setting for normal sample size. If the normal sample size is 1, it
indicates individual data. If the normal sample size is greater than 1, it indicates grouped data. If it is
grouped data, then you can enter the minimum sample size and maximum sample size, where the
minimum sample size must be 2 or great er.
Sample Size
Normal Sample Size
Used by the Sample Viewer Control for entering manual results. The edit results dialog displays the
fields for entry. This is also used by the Sample Recording Object to record automatic data when
maximum sample size is Null.
Minimum Sample Size
Used by the evaluation of control rules stored procedure. When there are several results for the
characteristic, control rule violations are evaluated.
Maximum Sample Size
Used by the Sample Viewer Control as the maximum number of results that can be manually entered
for a characteristic. This is also used by the Sample Rec ording Object for recording automatic data.
The Sample Recording Object records up to the maximum sample size.
Moving Average Span
The number of individual results that are included in a single Moving A verage point. The size is displayed
in the Moving A verage chart.

Note: The optional information for defining a variable type characteristic are: sample size, trend limits,
standard error of regression, X Bar charts, and moving average charts.

Sigma Estimate
Specifies whether the estimated sigma used in control limit calculations and Cp/Cpk calculations use the
within subgroup standard deviation or the tables to look for factors to multiply by the range.
Control Limit Source
You can obt ain control limits in the following ways:
Automatically calculate from data
Allows MES to calculate the control limits. This enables the options to enter the following:

Version 6.1 323

MES Client User Guide Variable and Attribute Characteristic Definitions

o Samples for Control Limit: Specifies the number of samples that are to be included in the
calculation. This parameter limits the number of samples used in the calculation of control limits
and process statistics, as do the parameters Cut-off time (in days) and Number of samples to
consider calculating process stati stics. For more information, see Controlling the Amount of
Data Used in Calculating Process Statistics on page 320.
o Samples required before Control Limits are calculated: Specifies the minimum number of
samples that must exist before applying the calculated control limits to evaluate rule violations.

Compute from standard values

Specifies standard mean and standard deviation values that are used to calculat e control limits
adjusted for sample size (standard mean +/- 3 * standard deviation / square root of sample size).
Selecting this option makes the following parameters available:
o Standard Mean (Center Line) includes x-bar, x-individual, and moving average.
o Standard Mean Is Target, if selected, indicates that the target is used as the Center Line for the
standard mean and the standard mean of the characteristic is not used.
o Standard Deviation (Variability Measure) includes range, and sigma.

Use preset values

Includes center line and upper and lower control limit values for Xbar, Range Sigma, IX (Individual),
IR (Individual Range), Moving A verage, Moving Range, and Moving Sigma charts. Enables the user
to set control limits for each chart through the Chart and its limits list. For each chart component, you
must enter the lower control limit, center line, and upper control limit. Select the Use preset value s
option to enter values for all the chart types.

Binary Attribute Characteristic Properties

Binary attribute characteristics are measured by using integer numbers.
If you selected Binary attribute in the Characteri stic Type menu, then provide the following information:
Sample Size Source
Specifies how the sample size is determined for the attribute. The values are as follows:
Fixed
Specifies the fixed sample size value in the normal sample size property.
Entered
Enables the option to set the minimum and maximum data entry limits for the sample size.
Copied from previous
Specifies the same value that is entered. At run time, the Sample Viewer .Net control resets the
sample size to the value that was previously saved for the characteristic. This value uses the
minimum and maximum sample size properties to set the data entry limits.

Note: The optional information for defining a binary attribute characteristic are control limits for
preset values.

Control Limit Source

You can obt ain control limits in the following ways:
Automatically Calculate from Data
Allows MES to calculate the control limits. This enables the options to enter the following:

324 Version 6.1

Variable and Attribute Characteristic Definitions MES Client User Guide

o Samples for Control Limit: Specifies the number of samples that are to be included in the
calculation. This parameter limits the number of samples used in the calculation of control limits
and process statistics, as do the parameters Cut-off time (in days) and Number of samples to
consider c alculating process statistics. For more information, see Controlling the Amount of Data
Used in Calculating Process Statistics on page 320.
o Samples required before Control Limits are calculated: Specifies the minimum number of
samples that must exist before applying the calculated control limits to evaluate rule violations.

Compute from standard values

Specifies standard mean and standard deviation values, which are used to calculate control limits
adjusted for sample size. This includes the following:
o Standard Average Proportion: (Center Line) includes p and np charts. Enter the value as a
fraction, such as 0.10 for 10%.
o Standard Average Proportion Is Target, if selected, indicates that the target is used as the
Cent er Line for the standard average proportion and the standard average proportion of the
characteristic is not used.

Use preset values

Includes center line and upper and lower control limit values for p and np charts. Enables the user to
set control limits for eac h chart through the Chart and its limits list. For each chart component, you
must enter the lower control limit, center line, and upper control limit.
Select the Use preset values option to enter values for all the chart types.

Counted Attribute Characteristic Settings

Counted attribute characteristics are measured by using integer numbers.
If you selected Counted attribute in the Characteristic Type menu, then provide the following
information:
Sample Size Source
Specifies how the sample size is determined for the attribute. The values are as follows:
Fixed
Specifies the fixed sample size value in the normal sample size property.
Entered
Enables the option to set the minimum and maximum data entry limits for the sample size.
Copied from previous
Specifies the same value that is entered. At run time, the Sample Viewer .Net control resets the
sample size to the value that was previously saved for the characteristic. This value uses the
minimum and maximum sample size properties to set the data entry limits.
Number of Defect Opportunities
This field is enabled for counted attributes. You must enter the number of possible defects on a single
unit. For example, if a unit is inspected for a defect on each face of a box with one defect allowed per
face, then the number of defect opport unities is 6.

Note: The optional information for defining an attribute type characteristic are defect opportunities and
control limits for preset values. If the optional information is of a count ed attribute type, then you must set
the number of defect opportunities.

Version 6.1 325

MES Client User Guide Variable and Attribute Characteristic Definitions

Control Limit Source

You can obt ain Control Limits in the following ways:
Automatically Calculate from Data
Allows MES to calculate the control limits. This enables the options to enter the following:
o Samples for Control Limit: Specifies the number of samples that are to be included in the
calculation. This parameter limits the number of samples used in the calculation of control limits
and process statistics, as do the parameters Cut-off time (in days) and Number of samples to
consider c alculating process statistics. For more information, see Controlling the Amount of Data
Used in Calculating Process Statistics on page 320.
o Samples required before Control Limits are calculated: Specifies the minimum number of
samples that must exist before applying the calculated control limits to evaluate rule violations.

Compute from standard values

Specifies standard mean and standard deviation values, which are used to calculate control limits
adjusted for sample size. This includes the following:
o Standard Average Number per Unit: (Center Line) includes c, u, and DPMO charts. Enter the
value as a count per unit. For example, if you take 20 samples and enter the standard average
number per unit as 5, then a c chart of the data would have a center line at 100.
o Standard Average Number per Unit Is Target, if selected, indicat es that the target is used as
the Cent er Line for the standard average number per unit and the standard average number per
unit of the characteristic is not used.

Use preset values

Includes center line and upper and lower control limit values for c an d u charts. DPMO charts use the
same settings as the u chart and are scaled accordingly. Enables the user to set control limits for
each chart through the Chart and its limits list. For each chart component, you must enter the lower
control limit, center line, and upper control limit.
Select the Use preset values option to enter values for all the chart types.

Linking an Attribute to a Characteristic

An attribute is an additional user-defined property. You can link result attributes to a characteristic to
provide more information about the characteristic to the users of the MES system. For information about
attributes, see Introduction to Attributes.
To assign result attributes to a characteristic
1. On the Editor window, click the characteristic to which you want to assign the attributes, and then
click the Attribute s tab.
2. On the ribbon, click the Current View tab.
3. On the Attribute group, click Add Link.
The Add attribute s dialog box appears.
4. Select one or more attribut es to link to the characteristic and click OK.
5. On the ribbon, click Save in the Main group to save the changes.

326 Version 6.1

 MES Client User Guide

C HAPTER 37
QM Specifications
In This Chapter
Introduction to QM Specifications ................................................................................................. 327
Applying Filters to the List of QM Specifications ............................................................................ 328
Managing QM Specifications ....................................................................................................... 329
Creating a QM Specification ........................................................................................................ 329
Linking a Characteristic to a QM Specification .............................................................................. 330
Linking a Control Rule to a QM Specification ................................................................................ 334
Linking an Attribute to a QM Specification .................................................................................... 335

Introduction to QM Specifications
You can use the QM Specification module to create, maintain, and remove quality management
specifications.
When you open the QM Specification module and apply a filter, a list of the filtered QM specifications
are shown in the workspace.
By default, the QM Specification module is grouped under the Quality Management group in the
Navigation pane. For more information on groups and modules, see Groups and Modules on page 29.
A QM specification is the specification for Statistical Process Control (SPC) analysis of various
characteristics linked to it. It also specifies the way sampling has to be carried out for each of the linked
characteristics.
The context data of a QM specification decides how a linked characteristic is going to be measured
during run time. For example, a characteristic, such as temperature can be measured in various contexts
like item, entity or operation. This means different samples have to be taken for different contexts for the
same characteristic. A QM specification may have the combinati on of the contexts mentioned above that
specifies how the samples are to be collected.
You can configure QM specifications associated to variables and attributes. You can modify QM
specifications that are currently effective, and also those that are no lon ger effective.
You can delete a QM specification from the database. An error message appears if you delete a QM
specification that is currently effective. An error message also appears if there is a sample or
characteristic linked to the QM specification. This message shows the number of sample/characteristic
combinations that are assigned to the QM specific ation. If bot h the error messages appear, they are
combined into a single message. The error message allows you to delete the QM specific ation. For more
information on deleting, see Deleting an Entry on page 20.

Version 6.1 327

MES Client User Guide QM Specifications

An error message appears if the QM specification cannot be saved. Modify the QM specification, as
needed, to correct the error and save to clear the error.

Applying Filters to the List of QM Specifications

The Apply Filter function allows you to view a list of QM specifications, which match the filter options
that you enter.
To filter the list of QM specifications
1. In the Navigation pane, click the QM Specification module.
2. Select the required filter option from the QM Specification Filter section.
In the QM Specification section, the following filter options are available:
Name
Name of the QM specification. You can type any character within the QM specification name.
Description
Description of the QM specification. You can type any character within the QM specification
description.
Version
Version of the QM specification. You can type any alpha -numeric character of the version.
Start Date
Effective start date of the QM specification.
End Date
Effective end date of the QM specification.
Enti ty
Entity configured as the context in which the QM specification is to be used. You can select the entity.

328 Version 6.1

QM Specifications MES Client User Guide

Item classes and Items

Item class configured as the context in which the QM specification is to be used. You can select
either an item class, or an item in the tree.
Process and Operation
Operation configured as the context in which the QM specification is to be used. You can select an
operation in the tree.
3. Click Apply Filter. The list of QM specifications matching the filter is shown.

Managing QM Specifications
The workspace shows the name, description, version, category, and other details of the QM
specification. You can create, modify or delete a QM specification. A QM specification can have multiple
versions, where the active version is based on the start and end effective dates. A version is considered
active if the start effective date is among the QM specification versions of same name and context and is
equal to or less than the current time, and the end effective date is greater than the current time. The
active QM specification must have the recent start effective date that is less than the current date.
Multiple QM specifications can be applied to various contexts, such as an entity, item, operation, or a
combination of any of these. Thes e QM specificatio ns can be active, and samples can be generated for
any of them.

Creating a QM Specification
You can create a QM specification to define the list of variables and attribute characteristics, the control
limits, and the sampling required.
You must have the appropriate privileges to edit QM specification settings.
To create a QM specification
1. On the ribbon, click New QM Specification in the New list. A new QM specification displays in the
workspace.
2. In the Properties pane, complete the property settings. See QM Specification Properties on page
329.
3. On the ribbon, click Save in the Main group to save the changes. If you want to save a QM
specification, you must link it to at least one characteristic.
An error message appears if the QM specification cannot be created. Modify the QM specification, as
needed, to correct the error, and save to clear the error.

QM Specification Properties
Name
The name for the QM specification.
Description
A description of the QM specification.
Edit Level
The number for the required level to edit the current QM specification. The E dit Level is set within the
user's group permissions. By default, the edit level value is 1.
Version
The version of the QM specification.
The combination of name and version number, and the combination of name and start date, must be
unique. The purpose of the Version box is to help you organize t he data. It does not indicate whether
the QM specification is active or not. The start date and end date of the QM specification determine
whet her it is active or not.

Version 6.1 329

MES Client User Guide QM Specifications

Start Date
The effective start date of the specification. By default, the start date is the current date and the start
time is the current time. You can also change t he start date to a value ot her than the current date and
time.
End Date
The date on which the specification ceases to be effective. By default, the end date is blank.
A QM specification must have an entry in at least one of the context properties: Entity, Item Category and
Item, Process and Operation. You can also have entries in multiple context properties.
Enti ty
Click the Brow se button and select the entity context at which the samples are goin g to be taken.
The selected context can be an entity class, an entity parent, or an end entity. The options available
include all entities with the Can Capture QM Data capability as well as parents of those entities and
entity classes of those entities.
Item Category and Item
Click the Brow se button and select the item context to define the quality samples. The samples are
to be collected when an entity with the Can Capture QM Data capability is running a job (work order)
and producing an item that matches the selected item or item category.
Process and Operation
Click the Browse button and select the operation context for the QM specification. You can use this
option to create quality samples when an entity is running a job (work order) at the specified
operation.
Sample Plan Name
The default sample plan used by the characteristics within the QM specification. The sample plan
has the list of sample frequencies that the MES Service uses to generate samples against an entity
within the QM specification.
Number of Points Per Page
The number of samples per SPC chart page. This is to ensure that all the SPC charts are displayed
consistently. The value of this field must be between 5 and 800. The default value is 18.
The number that must be entered in this field is determined by the resolution of your monitor. If there
are too many samples displayed on a page, the chart will not be readable.
QM Specification Spare1–4
User-defined information about the QM specification.
Note: The De scription box, Edit Level list, End Date, and Spare fields are optional.

Linking a Characteristic to a QM Specification

A QM specification determines the characteristics that are to be sampled and analyzed for various SPC
charts and rules.
You can assign or link multiple characteristics to a QM specification.

330 Version 6.1

QM Specifications MES Client User Guide

If you want to save a QM specification, you must link it to at least one characteristic.

You can link a characteristic to a QM specification from the Detail pane.

To link a characteristic to a QM specification
1. On the ribbon, click Add Link in the Current View QM Specification Characteristic Link group.
2. In the Add Characteristic Links dialog box, enter the filtering options for Name, Description,
Type, Severity, and Category and click Apply Filters.

3. Select the characteristics you want to link to the QM specification and click OK.

Version 6.1 331

MES Client User Guide QM Specifications

You need to specify the target value, lower specification limit, and upper specification limit of a
characteristic while linking it. The lower and upper specification limits are optional. You cannot save
a linked characteristic without the target value.
4. To modify the characteristic, you must select:
o QM specification in the workspace.
o Characteristic in the lower pane.
The details of the characteristic are displayed in the Propertie s pane.
5. Modify the characteristic property settings as needed. See P roperties for a Characteristic Link ed to a
QM S pecification on page 332.
6. On the ribbon, click Save in the Main group to save the changes.
You can delete the characteristics assigned to a QM specification when multiple characteristics are
linked to it. However, you cannot delete a characteristic when there is only one characteristic linked to a
QM specification.

Properties for a Characteristic Linked to a QM Specification

QM Specification Name
The name of the QM specification.
Characteristics Name
The name of the characteristics.
Characteristics Type
The characteristics type.
Target
The target value of the characteristic. This is a required field.
Specifications/Limits
The specifications and limits of the characteristics. Specification limits are customer driven values
and are applied to individual result values. You must provide at least one of the following
specification limits for the MES Client to calculate capability statistics (Cp, Cpk, Pp, and Ppk):
o Lower Specification Limit: Specifies the lower specification limit of the characteristic.
o Lower Specification Is: Specifies whether the limit entered in the previous field is a fixed value,
an offset from target, or a percent offs et from target. Click to select the lower specification value
from the list.
o Upper Specification Limit: Specifies the upper specification limit of the characteristic.
o Upper Specification Is: Specifies whet her the limit entered in the previous field is a fixed value,
an offset from target, or a percent offset from target. Click to select the upper specification value
from the list.
Fixed value is the value that is used as the Lower Specification Limit or Upper Specification
Limit. Offset refers to the value that is subtracted or added from the target value. For example, a
Lower Specification Limit offset of 10 will evaluate to an actual Lower S pecification Limit of 40
when the target is 50 (i.e., 50 - 10 = 40). Offs et percent refers to the specification that is
calculated as a percent below or above the target. For example, a Lower Specification Limit
percent offset of 10 will evaluat e to an actual Lower Specification Limit of 45 when the target is
50 (i.e., 50 - 0.10*50 = 45). Specification limits are optional, so it is possible to define single sided
limits.
o Lower Data Entry Limit: Specifies the lower data entry limit of the characteristic. Data entry
limits are used to express the range of possible values that the characteristic can accept. Data
entry limits are used within the Sample Viewer control which does not accept a manually entered
value outside the dat a entry limits.

332 Version 6.1

QM Specifications MES Client User Guide

o Lower Data Entry Limit Is: Specifies whether the limit entered in the previous field is a fixed
value or a multiplier of the specification limit and target. Click to select the value of the lower data
entry limit from the list.
o Upper Data Entry Limit: Specifies the upper dat a entry limit of the characteristic. Data entry
limits are used to express the range of possible values that the characteristic can accept. Data
entry limits are used within the Sample Viewer control which does not accept a manually entered
value outside the dat a entry limits.
o Upper Data Entry Limit Is: Specifies whether the limit entered in the previous field is a fixed
value or a multiplier of the specification limit and target. Click to select the value of the upper data
entry limit from the list.
For single sided specifications, the Upper Data Entry Limit and Lower Data Ent ry Limit is
calculated from the provided specification limit. For example, Lower Specification Limit is 10,
Target is 20, Upper Specification Limit is 35 and the multiplier is 1.5. The Upper Data Entry Limit
is 1.5 * (Upper Specification Limit – Target) + Target = 42.5. And the Lower Dat a Entry Limit is
1.5 * (Lower Specification Limit – Target) + Target = 5. For one sided specifications, the upper
and lower data entry limit is calculated from the provided specification limit. For example, Target
is 20, Upper Specific ation Limit is 35 and the multiplier is 1.5. The Upper Data Entry Limit is 42.5
as before, and the Lower Data Ent ry Limit is -2.5.

Severity
The severity of the characteristic. Click to select the severity of the characteristic. The available
options are:
o Unus ed
o Not Monit ored
o Non-key
o Key
o Critical

The remaining fields are optional overrides for the settings at the characteristic level (or QM
specification level for the sample plan name). For more information on these settings, see Variable
and Attribute Characteristic Definitions on page 317.
Default Chart
The default chart type of the characteristic.
Control Limit Source
How the control limits will be provided to the system.
Samples for Control Limit
The samples for control limits. This field is enabled only when you select Automatically calculate
from data in the Control Limit Source property.
Samples required before Control Limits are calculated
The number of samples that are required before calculating the control limits. This is an optional field.
By default, the samples before cont rol limit value is Null.
The field is enabled only when you select select Automatically calculate from data in the Control
Limit Source property. The Samples for Control Limit and Samples required before Control
Limits are calculated properties are disabled for automatic calculation from data.
Standard Mean
The standard mean for control limits. This field is enabled only when you select Compute from
standard values in the Control Limit Source property.

Version 6.1 333

MES Client User Guide QM Specifications

Standard Deviation
The standard deviation for control limits. This field is enabled when you select Compute from
standard values in the Control Limit Source property.
Charts and Its Limits
The various charts available for a characteristic with its available limits. This field is enabled only
when you select Preset Values in the Control Limit Source property.
o Chart: Specifies the type of chart associated with a characteristic. Click to selec t the chart that
you want to associate with a characteristic.
o Lower Control Limit: Specifies the lower control limit of the chart.
o Center Line: Specifies the center line of the chart.
o Upper Control Limit: Specifies the upper control limit of the chart.

Sample Size Source

The sample size source for the characteristic. This property is only enabled for attribute
characteristics.
Normal Sample Size: Specifies the normal size of a sample. This field is only enabled when you
select Fixed in the Sample Size Source property.
Minimum Sample Size: Specifies the minimum size of a sample. If you select Entered in the
Sample Size Source property, you need to enter this information at run time.
Maximum Sample Size: Specifies the maximum size of a sample. If you select Entered in the
Sample Size Source property, you need to enter this information at run time.

Auto Collection
Specifies whether the characteristic will be collected automatically.
o Characteristic Auto Collected: Select Yes to specify that the characteristic will be collected
automatically by the system. By default, the Characteri stic Auto Collected property is set to
Use Characteri stic Setting.
o Collection Time Interval: Specifies the time delay between the collections of the
characteristics. This field is enabled only if the characteristic is auto collected and the sample
size is greater than 1.
o Time Interval Unit: Specifies the unit of time interval for collection of the characteristics.

Linking a Control Rule to a QM Specification

The set of control rules linked to a QM specification represents the maximum set of control rules that you
can apply to a characteristic linked to the QM specification.
The cont rol rules are link ed in a grid in the Detail pane. The status of the new linkages is marked as Dirty.
You need to save them.
You must have the privileges to link a control rule to a QM specification.
The rule_desc value must be displayed for the control rule linkage. You cannot modify the rule_desc
value.
To link a control rule to a QM specification
1. In the workspace, select the QM specification to which you want to assign a control rule.

334 Version 6.1

QM Specifications MES Client User Guide

2. On the ribbon, click Add Link in the Current View QM Specification Rule Links group. The Rules
Picker dialog box appears.

3. In the Rules Picker dialog box, select the rule group to add all the rules within the group or select
individual rules, and click OK.
4. On the ribbon, click Save in the Main group to save the changes.
When you confirm the selection of the new rules, the new rule linkages are added to the MES dat abase
and to the Editor window. If you select a control rule linkage more than onc e, only one link is created.

Linking an Attribute to a QM Specification

An attribut e is an additional us er-defined property. You can link sample attributes to a QM specification to
provide more information about the specification to the users of the MES system. For information about
attributes, see Introduction to Attributes.
To assign sample attributes to a QM specification
1. On the Edi tor window, click the QM specific ation to which you want to assign the attributes, and t hen
click the Attribute s tab.
2. On the ribbon, click the Current View tab.
3. On the Attribute Links group, click Add Link.
The Add attribute s dialog box appears.
4. Select one or more attribut es to link to the specification and click OK.
5. On the ribbon, click Save in the Main group to save the changes.

Version 6.1 335

 MES Client User Guide

C HAPTER 38
Causes
In This Chapter
Introduction to Causes ................................................................................................................ 337
Creating a Cause Group ............................................................................................................. 338
Adding a Cause to a Cause Group............................................................................................... 339
Arranging the Order of Cause Groups and Causes ....................................................................... 339
Copying Causes to Another Cause Group .................................................................................... 340
Deleting Cause Groups and Causes ............................................................................................ 340

Introduction to Causes
Caus es can be assigned to characteristic samples. Causes are organized into relat ed cause groups, and
cause groups are then linked to characteristics through c ategories. The cause groups that are linked to a
characteristic will be the cause groups that are presented to an SP C chart us er when they assign a cause
for that characteristic’s samples. For information about how to link cause groups to categories, see
Link ing Caus e Groups to Characteristics on page 101.
You use the Causes module to create and maintain causes. This module is grouped under the Quality
Management group in the Navigation pane. For more information on groups and modules, see Groups
and Modules on page 29.

Version 6.1 337

MES Client User Guide Causes

When you open the Cause s module, a list of all the existing caus e groups and causes is shown in the
Editor window.

Creating a Cause Group

You can create a cause group and then add causes to the group.
You must have the appropriate user privilege to edit causes.
Only one user at a time can make changes to a cause or cause group. If a user is changing a cause or
cause group, other users will see an error message if they attempt to change the same cause or cause
group.
The Cause module is grouped under the Quality Management group in the Navigation pane. For more
information on groups and modules, see Groups and Modules on page 29.
To create a cause group
1. Do one of the following:
 In the workspace, right -click and click New Cause Group.
 In the Main group on the ribbon, click New and then click New Cause Group.
A new cause group displays in the workspace at the end of the existing list of cause groups.
2. In the Properties pane, enter a brief description for the cause group and, optionally, user-defined
information in the spare fields about the group.
3. On the ribbon, click Save in the Main group to save the changes.
An error message appears if the cause group cannot be created. Modify the cause group, as needed, to
correct the error, and save to clear the error.

338 Version 6.1

Causes MES Client User Guide

Adding a Cause to a Cause Group

1. In the workspace, select the cause group or a cause within the group to which you want to add a
cause.
2. Do one of the following:
 Right -click the selected group or cause and click New Cause.
 In the Main group on the ribbon, click New and then click New Cause.
A new cause displays at the end of the cause group's list of causes.

3. In the Properties pane, enter a brief description for the cause and, optionally, user -defined
information in the spare fields about the cause.
4. On the ribbon, click Save in the Main group to save the changes.
An error message appears if the cause cannot be created. Modify the cause, as needed, to correct the
error, and save to clear the error.

Arranging the Order of Cause Groups and Causes

In the Cause tab, the order of the cause groups and the causes in a cause group is the order that will be
presented to an SPC chart user when they assign a c ause to a characteristic sample. You can rearrange
the order of the cause groups or causes by using drag-and-drop or cut-and-paste.
To rearrange the order of cause groups or of a cause in a group using drag-and-drop
 Click and drag the cause group or caus e to the new location in the hierarchy.
To move one or more causes from one cause group to another using cut-and-paste
1. Select the causes.
2. On the ribbon, click Cut.
3. Select the destination cause group.
4. On the ribbon, click Paste.
The moving of a cause behaves as follows:
 If the cause is pasted to or dropped on a cause higher in t he list of causes within t he same group, the
moved cause is placed above the target cause.
 If the cause is pasted to or dropped on a cause lower in the list of causes within the same group, the
moved cause is placed below the target cause.

Version 6.1 339

MES Client User Guide Causes

 If t he cause is pasted t o or dropped on a cause in a different cause group, the moved cause is placed
above the target cause.
 If the cause is pasted to or dropped on a different cause group, the moved cause is placed at the
bottom of the target cause group.

Copying Causes to Another Cause Group

1. Select the causes to be copied.
2. On the ribbon, click Copy.
3. Select the destination cause group or a cause in that cause group.
4. On the ribbon, click Paste. The cause is added at the bottom of the target cause group.

Deleting Cause Groups and Causes

1. Select the cause groups or causes to be deleted.
2. On the ribbon, click Delete. A confirmation dialog box appears.
3. To continue with the deletion, click Yes.

340 Version 6.1

 MES Client User Guide

A PPENDIX A
System Parameters
In This Appendix
System Parameter Groups .......................................................................................................... 341
System Parameters Reference .................................................................................................... 341

System Parameter Groups

The system parameters are organized in the following groups:
 Archive
 Data Editor
 Data Entry
 Display
 Folders
 General
 Operator
 Reports
 Rework
 Security
 Supervisor

System Parameters Reference

System Parameters Value Description

Archi ve

Archive query window size Numeric field. The time span (in hours) used to divide the
(hours) amount of records being arc hived and purged at one time into
smaller sets. This strategy helps to reduce the amount of data
that is being retrieved and so lessen the impact of archiving
and purging on database performance for production.
The queries that are used to ret rieve the data records to
archive or purge will ask only for dat a within the hourly window,
based on the last_edit_at datetime in the data records. For
example, if the window value is set to 6 hours, the first data
retrieval will retrieve the first 6 hours of data records and
archive or purge them. When that operation is complete, the
next 6 hours of data rec ords will be ret rieved and proc essed,
and so on until the final records are reached.

Version 6.1 341

MES Client User Guide System Parameters

System Parameters Value Description

Archive root directory path Free-form text field. Contains the root directory path (relative to
the server) to which archived data is saved and from which
archive data is restored.
The default path is C:\Program
Files\Wonderware\MES\Archive s.
Note the following:
 The arc hive root directory path must be the absolut e path,
including the drive letter.
 The path cannot be c:, c:\, or blank. If it is, it will revert to
the default path.
 Make sure that any users who are performing archive and
restore jobs have access to the archive directory.
 If the archive directory is changed, configure the MES
DB/MW Communication component again with the
post-install Configurator to grant the MES middleware's
Windows user account access to the new directory
location.
Archive server host Free-form text field. Contains the name of the archive server
host where the archive files are located.
If blank, the local host is assumed.
If the archive server host is changed, configure the MES
DB/MW Communication component again with the post-install
Configurator to grant the MES middleware's Windows user
account access to the new directory location.
Data Editor

Perform auxiliary updat es in Update inventory, consumption, and/or performance

Item Production Edit or information (whatever would have been normally updated by
the equivalent action in Operator) in addition to production.

Prompt for confirmation of Yes/No drop-down list. If Yes, provides a dialog box requesting
deletions in Data Editor confirmation before a deletion requested in Data Editor is
executed in the database.
Require filter for work orders? If Yes, the user is prompted to restrict the number of work
orders displayed in a list if there is no filtering by default.

Use saved filters in Entity If Yes, the previously saved Entity Usage Edit or filter settings
usage Editor will be used for the current user.
Use saved filters in Item If Yes, the previously saved Item Consumption Editor filter
Cons umption Editor settings will be used for the current user.
Use saved filters in Item If Yes, the previously saved Item Production Editor filter
Production Editor settings will be used for the current user.
Use saved filters in Job Step If Yes, the previously saved Job Step Data Editor filter settings
Data Editor will be used for the current user.
Use saved filters in Labor If Yes, the previously saved Labor Usage Editor filter settings
Usage Editor will be used for the current user.

342 Version 6.1

System Parameters MES Client User Guide

System Parameters Value Description

Warning level (number of When applying a filter setting, if the number of nodes that will
nodes) for filt er in It em Lot be ret urned exceeds this number, the user is warned that a
Editor large set of data will be displayed in the Item Lot Editor.

Warning level (number of When applying a filter setting, if the number of nodes that will
records) for filter dialog in Entity be ret urned exceeds this number, the user is warned that a
Usage Editor large set of data will be displayed in the Entity Usage Editor.

Warning level (number of When applying a filter setting, if the number of records that will
records) for filter dialog in Item be ret urned exceeds this number, the user is warned that a
Cons Editor large set of data will be displayed in the Item Consumption
Editor.
Warning level (number of When applying a filter setting, if the number of records that will
records) for filter dialog in Item be ret urned exceeds this number, the user is warned that a
Prod Editor large set of data will be displayed in the Item P roduction E ditor.

Warning level (number of When applying a filter setting, if the number of records that will
records) for filter dialog in Job be ret urned exceeds this number, the user is warned that a
Step Data Editor large set of data will be displayed in the Job Step Data Editor.

Warning level (number of When applying a filter setting, if the number of records that will
records) for filter dialog in be ret urned exceeds this number, the user is warned that a
Labor Us age Editor large set of data will be displayed in the Labor Usage Editor.

Data Entry

Day to archive data Drop-down list containing the days of the week and Daily.
Defines on which day the archiving process will execute.

Days to keep dat a (0=never Numeric field. Defines the total number of days the system will
delete) maintain data. An ent ry of 0 means the data is never deleted;
in that case, it would be up to the system administrator to
control the removal of obsolete data.
Ex: 365

Frequency to call sample Specifies the int erval at which sample information (creating
updates (in seconds) new future samples, readying samples, or updating the sample
state), is updated. The default is 30 seconds.

How long to keep old context Specifies the number of days to keep context information that
information (in days) is no longer current. In case the context information becomes
current again (e. g., as may happen when a suspended job is
restarted), sampling may pick up where it left.

Maintain distinct consumption Yes/No drop-down list. If Yes, writ es a new record in the
records Item_cons table for any changes made to consumption
records.
Maintain distinct good Yes/No drop-down list. If Yes, writ es a new record in the
production records Item_P rod table for any changes made to good records.

Version 6.1 343

MES Client User Guide System Parameters

System Parameters Value Description

Maintain distinct reject Yes/No drop-down list. If Yes, writ es a new record in the
production records Item_P rod table for any changes made to reject records.
Required WO status for Drop-down list containing Complet e and Closed. Determines,
archiving by status, which work orders will be archived.

Sample wait time for delayed For samples based on a units-of-production frequency, the
production (in minut es) MES Service will adjust sample request times based on the
setting of this parameter.
If this parameter is set to 0, then there are no adjustments to
future sample request times and it is possible for a future
request time to have a value in the past.
If this parameter is set to a non-zero value, then when the time
for a future sample passes without there being enough
production reported to warrant it, all future samples for the
entity and for the production count frequency will have their
requested times increas ed by the specified number of minutes,
thereby keeping them in the fut ure.

Time to archive data (HH:MM) Time field. Defines what time of day the archive process
should start.
Verify quantity entry Yes/No drop-down list. If Yes, the quantities entered by a user
of the Operator module will be verified by a Yes/No prompt.

Di splay

Color for automatic collection Allows you to set/modify the column heading colors in Sample
column Viewer, for characteristics that are collected automatically.

Critical error color Selection field. Allows you to set/modify the color used for
critical errors throughout the system.
Customer display Drop-down list. Defines which combination of Customer ID
and/or Customer Name will be displayed in the Customers
window.
Default language The language that appears on the initial log on screen before a
user logs in.
Dismiss production dialog upon Yes/No drop-down list. If Yes, the Add Production dialog in the
entry Operator module closes automatically after the user clicks
Save and the production is successfully recorded. If No, the
user of the Operator module must click Close to dismiss the
Add Production dialog.
Error color Selection field. Allows you to set/modify the color used for the
text of error messages throughout the system.
Information message color Selection field. Allows you to set/modify the color used for
informational messages throughout the system.

344 Version 6.1

System Parameters MES Client User Guide

System Parameters Value Description

Item class display Drop-down list. Defines which combination of Item Class ID
and/or Item Class Desc(ription) will be displayed.
Item display Drop-down list. Defines which combination of Item ID and/or
Item Desc(ription) will be displayed.
Items require filtering If Yes, a user will first be prompted to restrict the number of
items displayed in a list. If No, the user will not be prompted to
restrict the number of items displayed in a list.

Cut-off time in days to limit the Upper bound on the age of sample data used to calculate
number of samples while process statistics. This time range is applied to the sample’s
calculating process statistics requested time. Use this parameter to exclude sample data
from the samples (0 = Include that is considered too old to be relevant. For example, setting
all samples) this parameter to a value of 2 would mean that only the last 2
days of sample data would be used to calculate process
statistics.

Number of samples to consider Maximum number of samples to include when calculating

calculating process statistics process statistics. Use this parameter to tune the performance
of the system so that there is not too much data being
analyzed.
Re-use concurrent link values Yes/No drop-down list. Refers to the 16 colors used to
to aid color coding color-code link #s in the Supervisor/Queue window. If Yes,
new links will be given an unused number between 1 & 16, to
simplify color-coding. If No, a new link will be given the next
highest number (a color will still be reused).

Sample Result Good Color For the .NE T Sample Viewer control, indicates a sample
characteristic with all variables and attributes within normal
range.
Sample Result OOC Color For the .NE T Sample Viewer control, indicates a sample
characteristic with at least one variable or attribut e out of the
SPC control, and no variables or attributes out of specification.
Sample Result OOC Critical For the .NE T Sample Viewer control, indicates a sample
Color characteristic with at least one variable or attribut e with a
severity setting of critical, that is out of the SPC control, and no
critical variables or attributes out of specification.
Sample Result OOC Key Color For the .NE T Sample Viewer control, indicates a sample
characteristic with at least one variable or attribut e with a
severity of key out of the SPC control, no critical or key
variables or attributes out of specification, and no critical
variables or attributes out of control.
Sample Result OOS Color For the .NE T Sample Viewer control, indicates a sample
characteristic result with at least one variable or attribute out of
specification. This color indicates individual variable
characteristics.
Sample Result OOS Critical For the .NE T Sample Viewer control, indicates a sample
Color characteristic result with at least one variable or attribut e with a
severity setting of critical, that is out of specification.

Version 6.1 345

MES Client User Guide System Parameters

System Parameters Value Description

Sample Result OOS Key Color For the .NE T Sample Viewer control, indicates a sample
characteristic result with at l east one variable or attribut e with a
severity setting of key, that is out of specification.
Sample Result Pending Color For the .NE T Sample Viewer control, indicates a sample
characteristic with some variables and attributes that are
waiting to be collected. The collected variables and attributes
are within normal range.
Sample Stat us Cancelled Color For the .NE T Sample Viewer control, indicates a sample for
which measurements are not taken.
Sample Status Complet e Color For the .NE T Sample Viewer control, indicat es a sample where
the recorded time at which the minimum number of original
results in the sample is less than or equal to the sample
expiration time, and there are enough results for every
characteristic linked to the sample.

Sample Status Complet e Late For the .NE T Sample Viewer control, indicat es a sample where
Color the recorded time for at least one original result in the sample
at or below the minimum number is greater than the sample
expiration time, and there are enough results for every
characteristic linked to the sample.
Sample Status Future Color For the .NE T Sample Viewer control, indicates a sample for
which measurement res ults are to be collected at a future date.
Sample Status In Progress For the .NE T Sample Viewer control, indicates a sample that
Color has a requested time less than or equal to the current time,
and an expiration time greater than or equal to the current
time. The sample does not have enough res ults for at least one
of the characteristics linked to it. The sample pulled time is
either Not Null or there is at least one result.

Sample Status Late Color For the .NE T Sample Viewer control, indicates a sample that
has an expiration time less than or equal to the current time,
and does not have enough results for every characteristic
linked to it. Either the sample pulled time is Not Null or there is
at least one result.
Sample Status Missed Color For the .NE T Sample Viewer control, indicates a s ample that
has an expiration time less than or equal to the current time,
the sample pulled time is Null, and there are no results.
Sample Status Ready Color For the .NE T Sample Viewer control, indicat es a sample where
the current time is great er than or equal to the requested time
of the sample, and less than or equal to the expiration time of
the sample. If the warning interval is Not Null, or less than the
sample requested time and the warning interval, the sample
pulled time is Null, and there are n o res ults collected for the
sample.

346 Version 6.1

System Parameters MES Client User Guide

System Parameters Value Description

Sample Status Ready Warning For the .NE T Sample Viewer control, indicat es a sample where
Color the current time is great er than or equal to the requested time
of the sample, and less than or equal to the expiration time of
the sample. If the warning interval is Not Null, and the current
time is greater than the sample requested time, the sample
pulled time is Null, and there are no res ults collected for the
sample.
Serious error color Selection field. Allows you to set/modify the color used for
serious errors throughout the system.
Show only file name Yes/No drop-down list. If Yes, shows only the name of a file
and not the complet e path in all modules that display file
information.
Storage entities require filtering If Yes, a user will first be prompted to restrict the number of
storage entities displayed in a list. If No, the us er will not be
prompted to restrict the number of storage entities displayed in
a list.
User display Drop-down list. Defines which combination of user ID and/or
user description will be displayed.
Warning color Selection field. Allows you to set/modify the color used for
warnings throughout the system.
Warning level number of Specifies the maximum number of records to be returned in
records for the Sample this dialog, before the operat or is prompted to narrow the filter
Characteristic filter dialog in criteria.
SRO
Folders

Check file date/time/size for Yes/No drop-down list. If Yes, allows the user to check folder
design hold date, time and size for putting on design hold.
Copy to manufacturing Drop-down list containing All files in folder and Download
directories files only. Determines which files in a folder are copied to the
manufacturing directory.

Note: Downloading folders to a physical entity is no longer

supported, so this system parameter no longer applies.

Log changes to file type or Yes/No drop-down list. If Yes, the system will log changes to
description file types or file descriptions.
Revision justification Drop-down list containing Right and Left. Determines the
justification of a revision to a folder.
General

Allow clients from multiple time If Yes, time zone information must be passed to the
zones on the same Middleware Middleware server from each client. If No, the middleware
server server’s time zone is assumed to be the same as that of its
clients.
Allow user to account for less Yes/No drop-down list. If Yes, allows a user to account for less
than 100% of his time than his complet e shift.

Version 6.1 347

MES Client User Guide System Parameters

System Parameters Value Description

Allow user to account for more Yes/No drop-down list. If Yes, allows a user to account for
than 100% of his time more than his complete shift.
Apply entity access to inventory Yes/No drop-down list. If Yes, limits the logged in user to "view
only" for those invent ory locations that the user has not been
granted access. This would apply to both Supervisor inventory
window and operator invent ory control.

Apply grade code preference Yes/No drop-down list.

when consuming from
inventory
Automatically generate Yes/No drop-down list. If Yes, automatically generates a
process version numbers version number when a new process is created.
Automatically update Yes/No drop-down list. If Yes, automatically updates the
scheduled finish time for scheduled finish time for running jobs, to reflect the expected
running jobs time to produce the remaining required quantity, every minute.
If No, the scheduled finish time, once determined, is not
recalculat ed.
May not delet e or modify Yes/No drop-down list. If Yes, a user would not be permitted to
components of a certified make any changes or deletions of certified processes.
process
Category for labor not to be Specifies the labor category that will always have a percent t o
applied apply value of 0 to captures of applied labor for inactive jobs. If
the No value is specified, then no labor category will take on
this characteristic.
Cloned certified process status Drop-down list containing Experimental and Approved.
if only one certified process is Determines the status given to a process that is cloned from a
allowed certified process, if only one certified process is allowed in a
process class.
Days to keep SCC logs –0 = no Numeric field. Defines the total number of days the SCC log
logging file will be maint ained. An entry of zero 0 means the log file is
never created.
Ex: 10
Default Item Class ID Free-form text field. Det ermines the default item class ID.

Default Item ID Free-form text field. Det ermines the default item ID.
Default job priority Numeric field. Defines the default priority of a job if the priority
is not set in Supervisor when the job is created.
Default labor rate Currency field. Defines the default labor rate for a user if No
labor rate is entered.
Ex: $15
Default Operation ID Free-form text field. Det ermines the default operation ID.
Default percent to start Numeric field. Assume an operator is going to produce 1,000
of an item in operation 10. If this default percentage is set to
50, then when 500 parts have been completed in operation 10,
operation 20 (or the next operation) may begin.

348 Version 6.1

System Parameters MES Client User Guide

System Parameters Value Description

Default Unit of Measure for Free-form text field. Det ermines the default UOM for an item.
Items
Default Work Order ID Free-form text field. Det ermines the default work order ID.

Description for Free-form text field. Det ermines the standard description for
automatically-generated automatically-generated work orders.
(Kanban) work orders
Disallow deletes of BOMs and Yes/No drop-down list. If Yes, a user would not be permitted to
BOM dependent data delete BOMs or data that is dependent on the BOM.

Disallow deletes of certification Yes/No drop-down list. If Yes, a user would not be permitted to
data delete certification data that was previously entered int o the
system.
Disallow deletes of data log Yes/No drop-down list. If Yes, a user would not be permitted to
data delete any Data Log data that was previously entered into the
system.
Disallow deletes of entities Yes/No drop-down list. If Yes, a user would not be permitted to
delete physical entities.
Disallow deletes of folder data Yes/No drop-down list. If Yes, a user would not be permitted to
delete Folders data that was previously entered int o the
system.
Disallow deletion of items and Yes/No drop-down list. If Yes, a user would not be permitted to
classes delete items or item classes from the system.

Disallow deletion of spec data Yes/No drop-down list. If Yes, a user would not be permitted to
delete spec data that was previously entered into the system.

Disallow deletion of users Yes/No drop-down list. If Yes, a user would not be permitted to
delete (other) us ers previously entered int o the system.

Disallow deletes of WO created Yes/No drop-down list. If Yes, a user would not be permitted to
from a certified process delete a work order created from a certified process.

Error log level 0 (highest) to 4 Numeric field. Determines the error log level setting, logging
errors of the specified value and more critical.
0 = Critical errors - significant, may crash system
1 = Serious errors - will affect operation and data
2 = Partial errors - some data will be wrong
3 = Trivial errors - small adverse effect on some data
4 = Events - will not affect data or operation, information only
How to automatically Drop-down list containing Experimental and Approved.
downgrade a certified process Indicates what level a certified process should be set to when a
version new certified process is added to a process class and the
process class may have only one certified process in it.

Version 6.1 349

MES Client User Guide System Parameters

System Parameters Value Description

Limit schedulable entities on Yes/No drop-down list. Defines which entities are display ed
Jobs window when changing the Schedule to or Can Schedule to fields. If
Yes, the user will only be able to select from entities defined in
the process, including the entities’ child entities. If No, the user
may select from all defined entities.

Limit schedulable entities on Yes/No drop-down list. Defines which entities are display ed
Queue Window when changing the Schedule to or Can Schedule to fields. If
Yes, the user will only be able to select from entities defined in
the process, including the entities’ child entities. If No, the user
may select from all defined entities.

Log certification sign off as job Yes/No drop-down list. If Yes, job event records are inserted
events into the job_event table when an audit certification is
approved.
Log cons umption transactions Yes/No drop-down list. If Yes, job event records are inserted
as job events into the job_event table when an item is consumed during a
job.
Log inventory transfers Yes/No drop-down list. If Yes, records are inserted into th e
item_transfer table when an inventory item is transferred,
shipped, or received.

Log job state changes as job Yes/No drop-down list. If Yes, job event records are inserted
events into the job_event table when a job state is altered from one
state to another.

Log production transactions as Yes/No drop-down list. If Yes, job event records are inserted
job events into the job_event table when an item is produced during a job.

Log spec changes during job Yes/No drop-down list. If Yes, job event records are inserted
execution as job events into the job_event table when t he value of a defined job spec is
altered.

Log step completions as job Yes/No drop-down list. If Yes, job event records are inserted
events into the job_event table when a job step’s status is changed to
Completed.

Log storage entity changes Yes/No drop-down list. If Yes, records are inserted into the
job_event table when a storage entity’s definition is changed.

Lot number format (#=number Free-form text field. Defines the format mask for
to increment) auto-incrementing lot numbers.
Example: LOT-AB#, shows as LOT-AB1, LOT-AB2, …

350 Version 6.1

System Parameters MES Client User Guide

System Parameters Value Description

Lowest level process that can Drop-down list containing Experimental, Approved, and
be instantiated Certified. Defines the minimum process level that is needed to
create a work order. Experimental is the lowest possible level.
If Experimental, processes of all 3 types may be instantiated. If
Approved, Approved and Certified processes may be
instantiated. If Certified, only Certified processes may be
instantiated.

Max. number of decimals for Numeric field. Determines the maximum number of decimal
batch size entry places that may be used when entering a batch size. The
range is 0 - 7. The default is 3.

Max. number of decimals for Numeric field. Determines the maximum number of decimal
BOM configuration places that may be used when entering BOM configuration
setting values. The range is 0 - 7. The default is 7.
Max. number of decimals for Numeric field. Determines the maximum number of decimal
good piece part entries places that may be used when reporting good production. The
range is 0 - 7. The default is 0.

May have only one certified Yes/No drop-down list. If Yes, a process class is limited to
process in a process class having only one certified process.
May start and stop multiple jobs Will be implemented in a future release.
for a WO concurrently
Minimum traceable inventory The smallest amount of inventory that is kept track of for
amount genealogy purposes when consuming from an entity in which
lots are indistinguishable.
This parameter can be used wit h the physical entities Storage
parameter Multiple lots/item s stored here become
indistingui shable in the following way: If the Multiple
lots/items stored here become indistingui shable
parameter is selected and the Minimum traceable inventory
amount parameter has a value entered, then onc e the
quantity for a lot drops below that value, the balance of the
item quantity for that lot (that is, the quantity set as the
minimum traceable inventory) will be distribut ed across the
other lots, and the quantity for that lot will be set to 0.

Path to Form program When opening a form, a flag that identifies that the first value in
the comma-s eparated list being supplied specifies the Forms
program to launc h, as a fully qualified path. This program is
used to open any defined forms attached to a step or to the
Open Form button on the various controls. The parameters to
pass are specified in the Default parameters to pass to Forms
program system parameter.
PO ID number format ( # = Free-form text field. Defines the format mask for
number to increment) auto-incrementing PO numbers.
Example: PO-AB#, shows as PO-AB1, PO-AB2, …

Version 6.1 351

MES Client User Guide System Parameters

System Parameters Value Description

Prevent automatic readying of Yes/No drop-down list. Sets the default job state for the first job
first jobs. created for a work order. If Yes, the first job will not start
automatically until manually changed.
Process approver and editor Yes/No drop-down list. If Yes, a user may not approve
must be different users processes he edited.
Process version number format Free form text field. Defines the format mask for
(# = number to increment) auto-incrementing process version numbers.
Example: P-AB#, shows as P-AB1, P-AB2, …
Prompt for job status notes Yes/No drop-down list. If Yes, provides a dialog box allowing
the user to enter notes whenever a job status is changed.

Allowable deviation above start Numeric field. This is the allowable percentage above a job’s
quantity (%); -1 if no limit starting quantity that an operat or can report as produc ed. A
value of -99 is viewed as unlimited.
Allowable deviation below start Numeric field. This is the allowable percentage below a job’s
quantity (%) starting quantity that an operat or may report as produced.

Ready all new jobs of a work Yes/No drop-down list. If Yes, the status of all jobs in a work
order together order will be changed automatically to Ready after the release
date/time. If No, only the first job’s status will be changed
automatically to Ready after the release date/time.

Ready downstream jobs If Yes, jobs receiving material from an upstream job are
automatically changed from new to ready automatically once sufficient
material has been produced upstream. If No, jobs receiving
material from an upstream job are not changed from new to
ready automatically once sufficient material has been
produced upstream.

Report time zone difference Numeric field. This is the amount, in minutes, of the difference
from GMT(min.) between your local time zone and Greenwich Mean Time.

Require notes upon proc ess Yes/No drop-down list. If Yes, provides a dialog box for the
check-in user to enter not es when checking-in a process.
Schedule work to lowest level Applies only if you have a licens e for Scheduler.

Sort job state by Drop-down list containing Code number and State description.
Determines the key field by which the job states will be sorted.

Storage entity serial number Free-form text field. Defines the format mask for
format (# = number to auto-incrementing entity serial numbers.
increment) Example: Bin #, shows as Bin 1, Bin 2.
Time window for SCC Numeric field. This is the time minutes for SCC triggers.
time-bas ed triggers (min.)

352 Version 6.1

System Parameters MES Client User Guide

System Parameters Value Description

Time zone to use for storage Drop-down list containing GMT (UTC) and Local time. If GMT
(UTC), all time data will be stored as Greenwich Mean Time
Zone values, but will be displayed in the modules as local time
(Report Time zone difference from GMT P arameter). If Local
time, all time data will be stored and display ed using local time
zone values.
Use check-in/check-out for If Yes, processes must be checked out in order to be modified.
processes If No, processes do not need to be checked out to be modified.

User ID for background tasks Free-form text field. This is the user ID which will be used for
background tasks.
Work order ID format (# = Free-form text field. Defines the format mask for
number to increment) auto-incrementing work order ID numbers.
Example: WO-AB#, shows as WO-AB1, WO-AB2, …
XML encoding style Free-form text field. Defines the enc oding standard to be used.
If blank, defaults to the U.S. standard. As an example, for
Russian: enc oding=iso-8859-1
Operator

Allow inactive entity log-on to Yes/No drop-down list. If Yes, a user that has logged on to an
move bet ween PCs entity and is inactive can then log back on to that entity from
another mac hine.
Allow to minimize Yes/No drop-down list. If Yes, the user may utilize Windows’
Minimize function for the MES Operator’s window.

Auto start jobs when using job This system attribute will only apply to users who have a
based login job-based log on. If Yes, the Start Some button and Start Job
button are disabled. Only the Log on button is enabled;
however, the Log on button will join an operator to a running
job, start jobs that are not running, and will automatically
create new split jobs if one does not exist for the selected
entity.
The Log on button will only be enabled when the selected job
can be started based on operator privileges and possible run
on entities are accessible to logged in operator.

Default parameters to pass to Defines the replaceable parameters to be used, if not

Forms program otherwise defined, when invoking a third -party form tool in the
Steps control. The entry is a comma-separated string with the
first value being the forms program to run, followed by
additional parameters such as the form name. Whether the
string includes the forms program to be launched is specified
by the Path to Form program system paramet er.

Version 6.1 353

MES Client User Guide System Parameters

System Parameters Value Description

How to handle comments when When merging two utilization events, specifies whether and, if
merging utilization events so, how the merge will occur if the comments for the two
events are different. The options are:
 Do not merge if comments differ. The events will not be
merged.
 Merge using the comment from the earlier event. The
events will be merged, and the comment from the earlier
event will be used as the comment for the merged event.
 Merge using the comment from the later event.The events
will be merged, and the comment from the later event will
be used as the comment for the merged event.

How to handle raw reas on When merging two utilization events, specifies whether and, if
codes when merging utilization so, how the merge will occur if the raw reason codes for the
events two events are different. The options are:
 Do not merge if raw reason codes differ. The events will
not be merged.
 Merge using the raw reason code from the earlier
event.The events will be merged, and the raw reason code
from the earlier event will be used as the raw reason code
for the merged event.
 Merge using the raw reason code from the later event. The
events will be merged, and the raw reason code from the
later event will be used as the raw reason code for the
merged event.

Include labor in updates to This option will be implemented in a future release.

subscribed data
Determines if changes to the current labor information for an
entity will refresh the subscribed data.
Include OEE in updates to This option will be implemented in a future release.
subscribed data
Determines if changes to the current OEE information for an
entity will refresh the subscribed data.
Include running jobs in updates This option will be implemented in a future release.
to subscribed data
Determines if changes to the current job information for an
entity will refresh the subscribed data.
Include storage in updates to This option will be implemented in a future release.
subscribed data
Determines if changes to the storage status or characteristics
of an entity will refresh the subscribed data.

Include utilization in updates to This option will be implemented in a future release.

subscribed data
Determines if changes to the current utilization information for
an entity will refresh the subscribed data.

354 Version 6.1

System Parameters MES Client User Guide

System Parameters Value Description

Logging out of the last job on Yes/No drop-down list. If Yes, logging out of the last job on an
an entity logs the user off the entity logs the user off the entity.
entity
Operator file display Drop-down list. Defines which combination of File name and/or
Description will be displayed to the user of the Operator
module.
Operator tab orientation Drop-down list, containing Top and Left. Provides a choice on
the default location of the entity tabs in Operat or’s window.

Operator tab text orient ation Drop-down list, containing Normal and Horizontal. Provides a
choice of how the entity text is shown on the entity selection
tabs in the Operator’s window.

Prevent job with unapproved Yes/No drop-down list. If Yes prevents job with unapproved
data log from being finished data log from being finished.
Prompt for alternate user Yes/No drop-down list. If Yes, log on screen will be displayed
when current user does a switch user, preventing a return to
the Windows’ interface.
Prompt for production Yes/No drop-down list. If Yes, the Add Production window
quantities on log off/exit will be displayed when a user logs out of or exits Operat or. The
user can then ent er production quantities.
Ready only downstream jobs If a job normally receives no material from an upstream job, it
that have input percent greater is never automatically readied.
than zero
Seconds bet ween checks for The number of seconds between checks for changes to an
updates to data subscriptions entity that could initiate a refresh.

Step auto bypass operator The user to which the action of bypassing a step be attributed if
name the step bypass occurs automatically.
Use original button icons Yes/No drop-down list. If Y es, the original icons will be used for
Operator.

Reports System paramet ers used by MES Intelligence Reports to

specify what constitutes the start of the production day. For
more information, see the MES Intelligence Reports User
Guide.

Version 6.1 355

MES Client User Guide System Parameters

System Parameters Value Description

Production Day Start Specifies when the 24 hours of the production day starts:
 ShiftStart: The production day starts with the first shift that
starts in the day. For example, if the first shift that starts in
the day starts at 08:00:00, then the production day starts
at 08:00:00 of the current calendar day and ends at
07:59: 59 of the next calendar day. If the current calendar
day is December 1, then the production day would be from
December 1 at 08:00:00 to December 2 at 07:59:59.
 ShiftEnd: The production day ends with the last shift that
ends in the day. For example, if the last shift that ends in
the day ends at 23:00:00, then the production day starts at
23:00: 00 of the previous calendar day and ends at
22:59: 59 of the current calendar day. If the current
calendar day is December 1, then the production day
would be from November 30 at 23:00:00 to December 1 at
22:59: 59.
 TimeOfDay: The production day starts with the first shift
that occurs after the cut-off time specified by the
Production Day Start (Hours) the Production Day Start
(Minutes ) parameters. For example, if the cut-off time is
defined to be 06:00:00 and the first shift that starts after
that time starts at 07:00:00, then the production day starts
at 07:00:00 of the current calendar day and ends at
06:59: 59 of the next calendar day. If the current calendar
day is December 1, then the production day would be from
December 1 at 07:00:00 to December 2 at 06:59:59.
Production Day Start (Hours) If the Production Day Start paramet er is set to Time of Day,
specifies the hour portion of the cut-off time for the production
day. The valid range of values is 0 (the default) to 23.
Production Day Start (Minutes) If the Production Day Start paramet er is set to Time of Day,
specifies the minute portion of the cut-off time for the
production day. The valid range of values is 0 (the default) to
59.

Rework

Combine dynamic routing from If Yes, instead of instantiating a separate rework job for
the same operations of additional production requiring rework, add it into existing
different work orders rework jobs, provided they are not started and the jobs that
would have been created differ only in the work order and
operation from those to which the rework is to be added.
This is enabled only if Dynamic Routing is a separate WO from
original is True, as otherwise rework from different work orders
stays within the original work order.

Copy remaining jobs to end of If Yes, when a job is identified as needing rework and a new
WO created for dynamic work order is created for the rework, all subsequent jobs are
routing copied to the end of the new work order.

356 Version 6.1

System Parameters MES Client User Guide

System Parameters Value Description

Differentiate rework count by If Y es, the dynamic processing count is differentiated bas ed on
item reason the item reas on.

Differentiate rework count by If Y es, the dynamic processing count is differentiated bas ed on
job sequence number the job sequence number.

Differentiate rework count by If Y es, the dynamic processing count is differentiated bas ed on
operation ID the operation ID.

Differentiate rework count by If Y es, the dynamic processing count is differentiated bas ed on
process the rework process.

Differentiate rework count by If Y es, the dynamic processing count is differentiated bas ed on
WO ID the work order ID.
Dynamic Routing is a separate If Yes, jobs from dynamic routing become associated with a
WO from original new work order with an automatically generated ID.
If No, rework jobs are associated with the original work order
and the reworked parts can be merged back into the original
flow of jobs.

Label for work orders created Defines the description used if a separate work order or job is
by a dynamic route created for dynamic routing.
Modify lot numbers of dynamic Defines whether the lot numbers of the parts to be dynamically
routes routed remain the same always, are always changed to new
automatically generated values, or are changed to new values
only if the quantity being reworked is less than the total
quantity for that lot (as defined by inventory ). This parameter
applies only if the lot numbers are not the serial numbers.

Redo job originating dynamic Defines whet her a copy of the current job is appended to the
routing at end of dynamic end of the set jobs created in the mini-process when rework or
process alternate processing is required at the current job. For
example, after reworking, items may require inspection.

Use label in dynamic routing If Yes, the operation ID for rework jobs are appended with a
work order or operation IDs dash immediately followed by the value speci fied in
Description for rework work orders immediately followed by
incremental numbers.
For example, a rework job consisting of operations A, B, and C
would create jobs identified as A-Rework1, B-Rework1, and
C-Rework1 the first time the job was added to a work order and
A-Rework2, B-Rework2, and C-Rework2 the second time the
job was added to a work order.

Security

Version 6.1 357

MES Client User Guide System Parameters

System Parameters Value Description

Allow default entity logon Yes/No list which defaults to No. If set to Yes, shows a check
box on the entity logon dialog entitled ‘Always log on to these
entities’. If checked, on subsequent logs on the entities which
are selected will be automatically logged into.

Automatic Login Cont rols whether the current Windows user will be
automatically logged in to MES Client when the Security mode
is set to OS User or OS Group.
If set to Yes and both of the following conditions are true, the
user is automatically logged in to MES Client:
 The Security Mode parameter is set to OS User or OS
Group.
 In OS Us er mode, the current Windows user has been
added to the MES database or, in OS Group mode, the
current Windows user is a member of a Windows user
group that has been added to the MES database.
If set to No, MES Client prompts for a user name and
password.
If this parameter is set to Yes, the Security Mode parameter is
set to OS Group, and the current Windows user is not a
member of one of the Windows user groups that have been
added to the MES database, the following error message
appears if the user attempts to log in to MES Client: OS User
group is not configured. After dismissing the message, the
MES Client Login window appears.
This parameter is not used for MES Web Port al auto -logins,
which is controlled by Windows system and web browser
settings.
Default BOM substitution level Numeric field. Defines the initial security level when a
substitution item is created.
Default document download Numeric field. Defines the initial security level for
level downloadable documents.
Default document edit level Numeric field. Defines the initial security level for editing
documents.
Default document print level Numeric field. Defines the initial security level for printing
documents.
Default document view level Numeric field. Defines the initial security level for viewing
documents.
Default specification access Numeric field. Defines the initial security level when a
level specification is assigned to an operation or item.
Maximum duration in minut es Numeric field. Defines the time window during which failed log
which constitutes consecutive on attempts are to be considered consecutive. For example, if
logins (0= forever) a user attempts to log on Monday and his log on attempt failed
due to an incorrect password and then he attempts to log back
in on Tuesday, this would not be considered consecutive if this
parameter were less than 1440 (that is, 1 day).

358 Version 6.1

System Parameters MES Client User Guide

System Parameters Value Description

Minimum password length Numeric field. The fewest number of characters a password
may contain.
Number of days a password is Numeric field. The number of consecutive days for which a
valid (0 = passwords are user's password will be active; after that, a new password must
always valid) be selected.
Number of failed login attempts Numeric field. The number of attempts a user may enter an
before deactivation (0= never) incorrect password before he is terminated from the program.

Passwords Drop-down list containing Unique and Non-unique. If Unique, a

user is prompted only for a password, and not the user ID. If
Non-unique, a user must enter both the user ID and password.

Note: The unique password is support ed only if you select the

Native option in the Security Mode list. For more information,
see the Securit y Mode system parameter, in the Security
section of this table.

Seconds of inactivity before Numeric field. The number of seconds of inactivity before the
automatic logoff (0=never) user is automatically logged off the module. Applies to all MES
programs a user log into except Operator.
You must restart the application after changing thes e settings.

Note: This setting is not implemented for MES Web Portal.

Seconds of inactivity before Specifies the number of seconds of inactivity before a user is
automatic switch user deactivated in Operator. The Operator displays the Switch
(Operator; 0 = never) User window and the user enters his password before
returning to the Operator screen.
You must restart the Operator after changing these settings.

Security Mode Specifies which Security Mode to use to authenticate MES

users when they attempt to log in to an MES application:
 Native: The MES database user account is used.
 OS Group: The user’s Windows Active Directory (AD) user
group is used.
 OS User: The user’s Windows AD user account is used.

You cannot change the Security Mode if a process is checked

out. Otherwise, the process will not be able to be checked in.
MES Web Portal requires either OS Group or OS User security
mode.

Switch user requires password Yes/No drop-down list. If Yes, a user must re-enter his
password before his session in Operator is reactivated.

Version 6.1 359

MES Client User Guide System Parameters

System Parameters Value Description

Supervisor

Days of SCC logs to display The number of days of Supply Chain Connector information to
display. 0 = all.
Include jobs with 0 quantity If Yes, a job with no starting quantity can be created from a
when creating work orders process. If No, a job with no starting quantity cannot be created
from a process.
Prompt for check in when Drop-down list, containing No, Yes, Default None Selected,
closing Process window? and Yes, Default All Selected. If Yes, provides a dialog box
when exiting the Process window for the user to check -in
processes that he currently has checked out, with the
requested number of processes automatically selected (All or
None). The user may change the selections before closing the
dialog box.

Show entity tree in Supervisor Yes/No drop-down list. If Yes, shows the entity tree on the
queue window left-hand side of Supervisor’s Queue window. This will allow
for filtering, and dragging and dropping of queued jobs from
one entity to another.
Supervisor file display Drop-down list. Defines the combination of file name and/ or
description that will be displayed to the user.

360 Version 6.1

 MES Client User Guide

A PPENDIX B
User Privileges
In This Appendix
User Privilege Groups ................................................................................................................. 361
User Privileges Reference ........................................................................................................... 361

User Privilege Groups

The user privileges that can be assigned to a user group are organized into the following privilege
groups:
 Supervisor
 Scheduler
 Rejected Message Viewer
 Operator
 General
 File
 Data Editor
 Configurator
 Archive

User Privileges Reference

User Privileges Value Description

Supervisor

May run supervisor Check box. Provides the ability to run the Supervisor module.

May edit QM specifications Check box. Provides the ability to add, delete, modify, or copy
QM specifications, as well as to create, update, or delete a link
from a characteristic or control rule to a QM specification.

May edit sample plan settings Check box. Provides the ability to add, delete, modify, or copy
sample plans and associate frequencies to the sample plan.

May edit sample plan Check box. Provides the ability to add, delete, or modify
frequency settings sample plan frequencies.

Version 6.1 361

MES Client User Guide User Privileges

User Privileges Value Description

May edit characteristic settings Check box. Provides the ability to add, delete, or modify
characteristics.

May edit categories Check box. Provides the ability to add, delete, or modify
categories, as well as to link items, cause groups, and
categories to a category.

May edit causes Check box. Provides the ability to add, delete, or modify cause
groups and causes.

May add sample res ults Check box. Provides the ability to add new results to a sample
for a particular characteristic.

May edit samples Check box. Provides the ability to edit sample/characteristic
link information or result information.

May set/clear sample final flags Check box. Provides the ability to mark a sample as final or to
remove the final mark from a sample.

May edit BOMs Check box. Provides the ability to create, modify, and delete
Bills of Materials (B OMs).

May edit processes Check box. Provides the ability to create, modify, and delete
processes and their operations.

May edit specs Check box. Provides the ability to create, modify, and delete
specifications and specification groups (must also have May
edit proc esses privilege).

May edit steps Check box. Provides the ability to create, modify, and delete
steps and step groups (must also have May edit processes
privilege).

May create jobs Check box. Provides the ability to create and delete work
orders from processes.

May edit queues Check box. Provides the ability to change the ent ries on an
entity’s job queue, if that entity is capable of having jobs
scheduled to it and the logged in user has access to that entity.

May edit inventory Check box. Provides the ability to edit the inventory
screen.(Receive, ship & modify existing invent ory entries,
limited by user’s entity access definitions.)

May edit folders Check box. Provides the ability to create, delete, and modify
folders.

May edit supply chain Check box. Provides the ability to edit and configure the
connector Supply Chain Connector.

362 Version 6.1

User Privileges MES Client User Guide

User Privileges Value Description

May edit data logging Check box. Provides the ability to create, delete, and edit the
Data Log group definitions.

May edit files Check box. Provides the ability to create, define, and edit files.

May edit shift schedules and Check box. Provides the ability to create, delete, and edit shift
exceptions schedules.

May delete error logs Check box. Provides the ability to delete error logs.

May copy folders to Check box. Provides the ability to manipulate manufacturing
manufacturing directories directories.

May change status of a Check box. Provides the ability to change the status of a
process process.

May save queue sequence Check box. Provides the ability to sort/filter the queue and
store the res ults.

May uncomplete a job Check box. Provides the ability to reopen a completed job,
changing the job's state back to, for example, Ready or
Running.

May edit customers Check box. Provides the ability to modify pre-defined customer
information.

May edit sales orders Check box. Provides the ability to modify pre -defined sales
orders in the Customer window.

May change work order state Check box. Provides the ability to change a work order’s
status.

May override the minimum Check box. Provides the ability to ship an item that does not
shippable grade meet minimum shippable grade requirements.

May override the minimum Check box. Provides the ability to ship an item that does not
shippable state meet minimum shippable state requirements.

May append process not es Check box. Provides the ability to add notes onto the end of
existing process notes but not edit previously entered notes.

May replace process notes Check box. Provides the ability to replace, add, and/or edit
existing process notes with new information.

May reclassify inventory Check box. Provides the ability to reclassify an invent ory items
Grade, State, and Expiry date.

May edit standard operations Check box. Provides the ability to create, modify and delete
standard operations.

May override preferred BOM Check box. Provides the ability to use a BOM version ot her
version than the preferred one.

Version 6.1 363

MES Client User Guide User Privileges

User Privileges Value Description

May override preferred Spec. Check box. Provides the ability to use a specification version
version other than the preferred one.

May change operat or’s queue Check box. Provides the ability to select Save Queue
display sequence and filter in the Queue window, which determines
how an entity’s queue is shown in the Operator module.

May assign a work order to a Check box. Provides the ability to assign and reassign work
line orders to a line in MES Web Portal.

Scheduler

The privileges in this section apply only if you have a license for Scheduler.

May run scheduler Check box. Provides the ability to run the Scheduler module.

May apply tentative schedule Check box. Provides the ability to select and apply a tentative
schedule from the Scheduler drop-down window.

May change work order priority Check box. Provides the ability to change the work order’s
and due/release dates/times priority, release/due dates/times in Scheduler’s Edit window.

May change job time standards Check box. Provides the ability to change time standards in
and whet her pinned Scheduler’s Edit window and lock in those times (pinned).

May change entity queue Check box. Provides the ability to change the entity queue
date/time duration in Scheduler’s Edit window.

May set resource availability Check box. Provides the ability to modify resource quantities
available in Scheduler.

May set job’s resource usage Check box. Provides the ability to add, modify, or delete
resources assigned to a job.

May schedule Check box. Provides the ability to select overtime and
overtime/downtime downtime wit hin Scheduler.

Rejected Message Viewer

May re-submit failed Check box. Provides the ability to re-submit the failed
asynchronous messages messages.

Operator

May run operator Check box. Provides the ability to run the Operator module.

364 Version 6.1

User Privileges MES Client User Guide

User Privileges Value Description

May configure operator Check box. Provides the ability to customize the Operator
module with respect to screen shows, buttons, switches, tabs,
etc. Screen configurations are user-specific.

May run jobs Check box. Provides the ability to start a Ready job or re-start
a Suspended job.

May override queue Check box. Provides the ability to start a job out of the
pre-defined queue sequence.

May ready job Check box. Provides the ability to change a job’s state from
New to Ready.

May append job not es Check box. Provides the ability to add on to existing job notes
while working on a job.

May append WO notes Check box. Provides the ability to add on to existing work order
notes while working on a job.

May Replace Job notes Check box. Provides the ability to replace existing job notes
with new information while working on a job.

May Replace WO notes Check box. Provides the ability to replace existing work order
notes with new information while working on a job.

May exit operat or Check box. Provides the ability to exit the Operator module. If
not checked, Operat or’s Log on screen will persist after the
user has logged out.

May use job from unrelated Check box. Provides the ability run a job scheduled on another
queue queue in Operator.

May append item notes Check box. Provides the ability to add on to existing item notes
while working on a job.

May end a job Check box. Provides the ability to change a job’s state to
Complete.

May replace item notes Check box. Provides the ability to replace existing item notes
with new information while working on a job.

May cancel a job Check box. Provides the ability to change a job’s state to
Canc elled.

May unrelease a job Check box. Provides the ability to change a job’s state to
OnHold.

May override logons Check box. Provides the ability for an operator to override a
logon by anot her operator

Version 6.1 365

MES Client User Guide User Privileges

User Privileges Value Description

Button execution level Numeric field. Determines button access in other modules. A
user in this group may use buttons assigned this execution
level value or below, and will be prevented from using buttons
with higher execution levels. Execution levels are assigned to
individual buttons in the other modules.

Queue lookahead (number) Numeric field. Determines the total number of jobs a user of
Operator would be able to see in their queue.

Allow user to change the Check box. Provides the ability to alter the way Operator
default screen configuration shows the positioning of the entity tabs, grid columns, job
summary fields, and buttons.

May edit anot her us er’s step Check box. Provides the ability to modify step data entered by
data another user.

May execute steps out of Check box. Provides the ability to complete steps within the
sequence within a step group same step group in any order.

May execute steps out of Check box. Provides the ability to complete any steps from any
sequence across step groups step group in any order.

May append folder notes Check box. Provides the ability to add on t o existing notes for a
folder while working on a job.

May replace folder notes Check box. Provides the ability to replace existing notes for a
folder with new information while working on a job.

May override manufacturing Drop-down list, containing No, Yes, local drives only, Yes,
dirs network drives only, and Yes, any drive. Provides the ability to
search directories other than MES directories when searching
for files.

May access file maintenance Check box. Provides the ability to use advanc ed file and file
functions directory creation and editing functions within Operator.

May override entity Check box. Provides the ability to download from or upload to
a different entity’s directories.

May edit specification value Check box. Provides the ability to change the minimum and
maximum specification values, and the spec value from
Operator.

Require job based login Check box. Provides the ability to log into Operator by work
order ID and/or operation ID, automatically selecting t he entity.

May log in/out as group Check box. For future release.

366 Version 6.1

User Privileges MES Client User Guide

User Privileges Value Description

BOM substitution level Numeric field. Determines the authority level of the user for
consumption of substitute items within the BOM tab.

May view other entities’ Check box. Provides the ability to access the inventory that is
inventory located on entities that the user is currently not logged into.

May override inventory Check box. Provides the ability to consume inventory from or
allocations produce inventory to an inventory location that was not
predefined for that job.

May modify batches Check box. Not yet implemented.

May re-sort the queue Check box. Provides the ability to change the pre-defined
queue sequence.

General

May edit items Check box. Provides the ability to create, modify, and delete
items.

May edit jobs Check box. Provides the ability to modify a previously -created
work order.

May modify set of lot attributes Check box. Provides the ability to modify attribute definitions
that may be assigned to lots.

May modify value of lot Check box. Provides the ability to enter and modify the values
attributes of lot attributes when entering/changing invent ory information.

May change hold status Check box. Provides the ability to change the hold status of a
job to any state except for Complet e or running.

Specification access level Numeric field. Determines the access level for specifications. If
the specification’s access level is higher than this value,
access will be denied.

May edit minimum/maximum Check box. Provides the ability to change the minimum and
specification limits maximum specification limit values.

May configure trans port Check box. Provides the ability to select the method for
communication with the MES middleware.

Version 6.1 367

MES Client User Guide User Privileges

User Privileges Value Description

May override hard pegged and Allows for drop down work order to be enabled. Provides the
linear flow ability to change the From location on the Select and Transfer
dialog box, to produce a serial number that was previously
produced on a different work order, and to override the linear
flow of serial numbers on the Select and Trans fer dialog box
and Data Editor.

May add serial numbers Add button. Provides the ability to add serial numbers on the
Add/Assign dialog box.

May uncomplete serial Provides the ability to incomplete serial num bers on the Add
numbers Production dialog box.

May assign or unassign serial Arrow buttons. Provides the ability to assign/unassign serial
numbers numbers on the Add/Assign dialog box.

May delete unassigned serial Delet e button. Provides the ability to delet e serial numbers on
numbers the Add/Assign dialog box.

File

File edit level Numeric field. The Document type Edit level for the file would
need to have a number equal to or higher than this number to
be able to make changes.

File download level Numeric field. The Document type Download level for the file
would need to have a number equal to or higher than this
number to be able to download the file. Also the Document
type for the file must be marked as downloadable.

File view level Numeric field. The Document type View level for the file would
need to have a number equal to or higher than this number to
be able to view the file.

Data Editor

May run data editor Check box. Provides the ability to run the Data Editor module.

May Edit Step Data Check box. Provides the ability to modify step data within the
Data editor Module.

May edit production data Check box. Provides the ability to modi fy production data, such
as quantity produced.

May edit consumption data Check box. Provides the ability to modify consumption data,
such as amount consumed.

May Edit Audit Log Check box. Provides the ability to modify inventory data.

368 Version 6.1

User Privileges MES Client User Guide

User Privileges Value Description

May edit utilization data Check box. Provides the ability to modify utilization data. For
example, if an operator were to forget to log off of a job, this
capability would allow for the total time he spent on the job to
be modified.

May edit labor usage dat a Check box. Provides the ability to edit labor usage from within
Data Editor.

May edit data log Check box. Provides the ability to edit the data log dat a from
within Data Editor.

May edit lot data Provides the ability to access the Item Lot Editor.

Configurator

May run configuration tools Check box. Provides the ability to run the configuration tools.

May edit system settings Check box. Provides the ability to change system settings (all
options on System menu except Languages & Resources).

May edit languages Check box. Provides the ability to create, modify, and delete
languages.

May edit user settings Check box. Provides the ability to create, modify, and delete
users, user groups, and entity access.

May edit user certifications Check box. Provides the ability to create, modify, and delete
certifications, and to change certification assignments to
users.

May edit entity settings Check box. Provides the ability to create, modify, and delete
entities (all options on the Entities menu in MES Client; all
entity configuration functionality in MES Web Portal).

May edit item settings Check box. Provides the ability to create, modify, and delete
item settings (all options on Items menu except Units of
Measure).

May edit attributes Check box. Provides the ability to create, modify, and delete
attributes. Attributes may be assigned to items, item classes,
physical entities, lots, jobs, work orders, operations, and
processes.

May edit user privileges Check box. Provides the ability to modify privileges assigned
to user groups (i.e., this menu).

May edit UOMs and Check box. Provides the ability to add, modify, and delet e units
conversions of measure and their conversions.

Version 6.1 369

MES Client User Guide User Privileges

User Privileges Value Description

May edit entity files Check box. Provides the ability to add, modify, or delete the
files associated with an entity.

May edit lines Check box. Provides the ability to add, modify, or delete lines
in MES Web Portal.

May edit utilization states Check box. Provides the ability to add, modify, or delete
utilization states in MES Web Portal. This privilege applies to
MES Web Portal only.

May edit utilization reas ons and Check box. Provides the ability to add, modify, or delete
groups utilization reason groups and reasons in MES Web Portal. This
privilege applies to MES Web Portal only.

Archi ve

May configure Check box. Provides the ability to configure archive, purge,
archive/purge/restore job and restore jobs.

May run archive/purge jobs Check box. Provides the ability to run archive and purge jobs.

May run restore jobs Check box. Provides the ability to run restore jobs.

370 Version 6.1

 MES Client User Guide

A PPENDIX C
Historical Database Tables
The following table provides a list of independent historical database tables that you can select from the
Database Maintenance Propertie s pane for archive or purge.
 When arc hiving, other dependent tables (not listed here) will be archived wit h the selected
independent tables.
 When purging, only the independent table will be purged, not its dependent tables, unless otherwise
noted in the table below.

Internal Database Table

Name Description

audit_trail Provides a generic audit trail of who ins erted, edited, or delet ed
important data, and when. Used to facilitate 21 CFR Part 11 compliance.

cert_audit_log Records certification auditing sign -offs. This table allows for sign-offs to
the operation or step level.
data_entry_log Allows for the driving of and compliance to dat a collection schedules to
be monit ored. Database or other triggers insert rows into this table with
default dat a when a trigger is detected. The values can then be updat ed
and the entries_made field compared to the entries_reqd to detect
non-compliance.
data_log_16 Stores logged data values when a log ging sample is triggered if number
of values per sample is less than or equal to 16.
data_log_48 Stores logged data values when a logging sample is triggered if the
number of values per sample is between 16 and 48.
db_delet ed_log Stores a record for any MES database table records that have been
deleted. Each stored record includes the t able name and, in XML format,
the primary key for the record that was deleted.
dx_log Supply Chain Connector log table. Captures all results and exceptions
whenever any schedule is triggered to enable audit trails, error reporting,
etc.
error_log Populates system errors and events as they occur. The system can be
configured t o log or ignore errors of different severities whic h are defined
as follows:
0 = Critical errors. Significant, might crash system.
1 = Serious errors. Affects operation and dat a.
2 = Partial errors. Some data will be wrong.
3 = Trivial errors. Small adverse effect on some dat a.
4 = Events. No affect on data or operation. Affects information only.

Version 6.1 371

MES Client User Guide Historical Database Tables

Internal Database Table

Name Description

item_cons Item consumption table. Collects component item usage and waste
quantities for each BOM item by job, shift, lot, and s o on. This table
captures component and parent item lot numbers, which provide the
genealogy breakdown by lot.
item_transfer Stores inventory transfers, except for production and consumption
transactions.
This table is also used to store received raw material and finished good
shipments, if required.
labor_usage Logs the labor time for each labor category and employee ID for each of
the standard domains.
lot Allows lots and their characteristics to be defined.
Purging this table will also purge the following dependent tables:
 assigned_lot
 inv_lot_attr
 item_inv
 lot_attr
 rework_c ount
 sublot
 sublot_attr

po Stores details for each purchase order.

Purging this table will also purge the following dependent tables:
 po_line
 receipt
 receipt_lot

so Stores details for each sales order.

Purging this table will also purge the following dependent tables:
 shipment
 shipment _lot
 so_line
 so_wo_link

372 Version 6.1

Historical Database Tables MES Client User Guide

Internal Database Table

Name Description

sample Stores quality sample records and contextual information about the
sample.
Purging this table will also purge the following dependent tables:
 result, result_attr
 sample_attr
 sample_c har_link
 sample_c har_rule_link

storage_ent_transfer Storage entity transfer table. Captures changes in the location or status
of storage entities, as well as changes in their spare field values.

util_history Capt ures utilization data and a chronological sequence of events for
each entity that can capture utilization data. This data includes entity
utilization states, utilization reasons, number of occurrences, and the
timestamps when an entity's utilization state or reason changes (that is,
when a new event occurs).
Purging this table will also purge the following dependent table:
 corr_action_log

Version 6.1 373

MES Client User Guide Historical Database Tables

Internal Database Table

Name Description

wo Cont ains header dat a for released work orders, which includes data
such as which parent item is required, what quantity and by when. This
data is common to all jobs (operations) wit hin the work order. It thus
defines what work orders are scheduled to run at the facility at various
times. It also records data for work orders that are currently running or
have been completed or suspended.
Purging this table will also purge the following dependent tables:
 assigned_lot
 cert_job_link
 cert_job_step_links
 data_log_grp_job_link
 data_log_grp_job_step_link
 item_prod
 job
 job_alloc_rule
 job_attr
 job_bom
 job_bom_step
 job_bom_subst
 job_event
 job_history
 job_hour_history
 job_prod_rule
 job_route
 job_spec
 job_step
 job_step_choice
 job_step_data
 job_step_file
 job_step_grp
 lot_attr_default
 res_job_link
 rework_c ount
 so_wo_link
 wo_attr
 wo_file

374 Version 6.1

Historical Database Tables MES Client User Guide

Version 6.1 375

 MES Client User Guide

Index
jobs, creating for • 257
A properties • 129
APR (arc hive, purge, restore) jobs • 281
specification, adding to an operation • 205
archive job, creating • 283
historical database tables • 371
C
job log, viewing • 287
categories • 99
jobs, configuration details • 286
cause groups, linking to characteristics •
jobs, removing • 287 101
jobs, running automatically • 288 creating • 100
jobs, running manually • 287 deleting • 103
jobs, viewing list of • 286 items, linking to item category • 100
purge job, creating • 284 items, use • 99
restore job, creating • 285 links, deleting • 102
attribute characteristic settings cause group and characteristic categories, use •
binary • 324 99
counted • 325 cause groups • 337
attributes causes, adding to • 339
assigning • 110 causes, copying to anot her cause group •
characteristics, linking to • 326 340

creating • 109 creating • 338

items, assigning to • 136 deleting • 340

linking • 110 linking to characteristics • 101

operations, assigning to • 210 order • 339

causes • 337
processes, assigning to • 179
cause group, adding to • 339
understanding data types • 108
copying to another cause group • 340
understanding lot attributes • 111
deleting • 340
order in a cause group • 339
B certifications • 165
binary attribute characteristic settings • 324
access certifications • 166
BOMs
assigning to an operation • 182 assigning certifications to actions • 170
assigning certifications to users • 169
components, properties • 131
audit certifications • 166
components, specifying • 131
items, creating for • 128 certification levels • 167

Version 6.1 377

MES Client User Guide Index

certification properties • 168

creating certifications • 167 E
deleting a certific ation • 170 entities • 63
characteristics attributes, assigning to • 82
binary attribute, settings • 324 batches and lots, OEE • 74
characteristics and cause group categories, Capabilities configuration group • 67
use • 99 Class Membership configuration group • 76
counted attribute, settings • 325
default (preferred) parent • 84
definitions • 317
directories • 80
filtering • 318 files and web pages, adding to • 77
linking an attribute to • 326
filtering for the Physical Entities module • 65
linking to a QM specification • 330
item reason groups, assigning to • 81
linking to a QM specification, properties • Jobs configuration group • 68
332
Labor configuration group • 73
linking to cause groups • 101
Miscellaneous configuration group • 81
managing • 318
multiple parents • 84
types of • 322
OEE configuration group • 73
variable, settings • 323, 324
parent entities and inheritance • 83
common actions
parent entities, what is inherited from • 83
copying • 20
resolving inheritance conflicts • 84
creating • 19
restrictions when assigned to a line in MES
cutting • 20
Web Portal • 65
deleting • 20
Schedule Jobs configuration group • 68
pasting • 20
shift schedule • 89
saving • 19
specification, adding to an operation • 206
undoing • 19
Storage configuration group • 75
control rules
Utilization configuration group • 71
linking to a QM specification • 334
entity classes
counted attribute characteristic settings • 325
creating attributes class membership • 76

items • 109 defining an entity as • 66

icon • 63

D
data types, attribute • 108 F
labor categories • 163 file extenstions • 113
directories, entity • 80 files
dynamic routing usage • 217 items, adding to • 125
codes • 217
creating • 219 G
general paramet ers

378 Version 6.1

Index MES Client User Guide

archive • 33 processes linked to • 135

current view tab • 36 properties • 119
data editor • 33 relationship diagram, viewing • 135
data entry • 33 specification, adding to an operation • 207
display • 33 storage entity, assigning • 136
DNC • 33 item categories • 99

dynamic routing • 33 linking items to • 100

item classes
Factory Connector • 33
copying • 139
folders • 33
creating • 137
general • 33
linking • 139
managing • 36
item grades
modifying • 36
creating • 145
operator • 33 item reason groups • 150
security • 33 item reasons • 151
supervisor • 33 item states
global specifications • 153 creating • 147
capabilities • 159
creating • 156 J
using in OCO • 157 job queue
groups and modules • 29 columns, arranging • 232
filter options • 231
H filter, applying • 230
historical database tables • 371
job states • 229
jobs, editing • 234
I jobs, splitting • 233
item
links, creating • 234
assigning to a process • 178
queue sequence, deploying • 235
attributes, assigning • 136
route diagram • 232
BOM component properties • 131
step states • 229
BOM components, specifying • 131 job states • 105
BOMs, creating • 128 available states • 105
BOMs, properties • 129 modifying • 106
certification, assigning • 122 job steps • 260
creating • 119 BOM consumption amount • 264
files, adding • 125 creating • 261
filtering • 118 data log groups, assigning to • 267
item substitutes, creating • 133 files, adding to • 264
item substitutes, properties • 133 properties • 261
linking to item category • 100 step group, creating • 260

Version 6.1 379

MES Client User Guide Index

web pages, adding to • 264 navigating • 17

jobs showing windows as tab • 26
attributes, assigning • 272 starting • 17
BOM, creating • 257 tabbed workspace • 23
creating • 249 MES databas e
editing • 234 archiving • 283
file, assigning • 251 historical database tables • 371
properties • 249 maintenance • 281, 282
restrictions when work order is created in purging • 284
MES Web Portal • 238 restoring • 285
route diagram • 232 retrieving information • 279
specifications, assigning • 270 viewing information • 280
splitting • 233 MES Intelligence Reports, production day start
standard operations, adding • 274 system parameters • 33, 341
MES Web Portal
step groups, creating • 260
OS Group security and multiple A D
domains • 53
L OS Group vs. OS User security mode • 52
labor departments • 161
language strings • 59 privileges • 54
privileges, examples • 56
creating • 59
providing line access • 52
details, viewing • 61
editing • 60 restrictions on entities assigned to a line •
65
find and replace • 60
restrictions on work orders and jobs created
switching • 21
in • 238
lines
user aut hentication • 52
providing access in MES Web Portal • 52
user aut hentication and privileges • 52
links
attributes • 110 user aut hentication checks • 53
modules and groups • 29
cause groups to characteristics • 101
deleting category links • 102
items to item category • 100
O
OEE
lots
batches and lots • 74
attributes • 111
configuration group, entities • 73
operation step groups • 191
M operation steps • 190
MES Client
certifications, assigning • 194
customizing • 22
copying • 203
filtering data • 25
creating • 192
groups and modules • 29
data log groups, assigning to • 200
installing • 16

380 Version 6.1

Index MES Client User Guide

files, adding to • 197 creating • 176

properties • 192 creating, work flow • 174
web pages, adding to • 197 filters, applying • 173
operations items, assigning • 178
assigning to a process • 180 items, linked to • 135
attributes, adding • 227 level, setting • 177
BOMs, assigning • 182 managing • 174
certifications, assigning to • 184 operations, assigning • 180
cloning • 211 operations, cloning • 211
data log groups, assigning • 187 properties • 176
entities, assigning • 223 route maps, creating • 212
file, adding to • 181 standard operations, adding • 211
specifications, assigning • 204 status, setting • 177
step groups, creating • 191 steps, copying • 203
steps, copying • 203 verifying • 215
steps, creating • 192
web page, adding to • 181 Q
QM specifications • 327
P characteristics, linking to • 330
parent entities control rules, linking • 334
default (preferred) parent • 84 creating • 329
inheritance • 83 properties • 329
multiple parents of a child entity • 84 properties, characteristic • 332
resolving inheritance conflicts • 84 Queue module • 229
what is inherited from • 83
physical entities • 63 R
entity class membership • 76 reason groups, utilization • 95
filtering • 65 reasons, utilization • 95
restrictions when assigned to a line in MES rejected message viewer
Web Portal • 65 deleting • 291
process statistics editing • 290
controlling amount of dat a used in • 320 resubmitting • 290
processes • 171 viewing • 290
attributes, adding • 179 relationship diagram • 135, 139, 142
checking in • 213 reports, MES Intelligence, production day start
checking out • 213 parameters • 33, 341
route diagram, job • 232
classes, creating • 175
route maps
cloning • 214
creating • 212, 273
copying • 214

Version 6.1 381

MES Client User Guide Index

properties • 208
S web page, adding to • 209
sample plan frequencies • 303 specifications, assigning • 204
creating • 304 specifications, global • 153
standard operations
data change frequency • 309
cloning • 227
frequency type production count • 308
creating • 222
frequency type shift • 307
jobs, adding to • 274
properties • 305
statistics
sample plan, linking to • 315
process, controlling amount of data used in
sample plans • 311
• 320
creating • 312 step groups, creating • 260
naming conventions • 313 step states • 105
properties • 312 available states • 105
replaceable parameters • 313, 314 modifying • 106
sample plan frequency, linking to • 315 steps

Verified Write setting • 312 copying • 203

serialization creating • 192
producing serialized items in operator • 299 storage entities

setting up • 293 items, assigning to • 136

shifts • 87 system parameters • 341

changes, when applied • 91

creating • 89 U
creating a shift schedule for an entity • 89 UOM

current view tab • 87 creating • 141

filtering • 88 item specific UOM • 142

showing/hiding user groups and users

error list pane • 22 current view tab • 37

navigation pane • 22 providing entity access • 51

user privileges
properties pane • 22
archive • 361
status bar • 21
sites • 85 configurator • 361

creating • 85 data editor • 361

specifications files • 361
assigning to an operation • 204 general • 361
BOM specification, adding • 205 messenger • 361
creating • 204 operator • 361
entity specification, adding • 206 scheduler • 361
file, adding to • 209, 271 supervisor • 361
item specification, adding • 207 users

jobs, assigning to • 270

382 Version 6.1

Index MES Client User Guide

authentication checks in MES Web Portal •

53
authentication in MES Web Portal • 52
privileges examples for MES Web Portal •
56
privileges in MES Web Portal • 52, 54
utilization reason groups • 95
creating • 96
utilization reasons • 95
creating • 96
moving to another group • 97
properties • 97
utilization states • 93
creating • 94

V
variable characteristics
definition • 317
settings • 323, 324
Verified Write setting • 312
sample plans • 311

W
work orders
attributes, adding • 249
creating • 243
creating from a process • 241
files and URL, adding • 246
files, adding to • 246
filtering • 239
properties • 243
restrictions to jobs • 238
route map, creating • 273
web pages, adding to • 246

Version 6.1 383