Manufacturing Execution System (MES)

Service

User Guide

Version 6.0
June, 2018
© 2018 AVEVA Group plc or its subsidiaries. All rights reserved.
The Schneider Electric industrial soft ware business and AVEVA have merged to trade as AVEVA Group
plc, a UK listed company. The Schneider Electric and Life is On trademarks are owned by Schneider
Electric and are being licensed to AVEVA by Schneider Electric.
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, AV EVA 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 license agreement. This soft ware may be used or copied only in
accordance with the terms of such license agreement.
ArchestrA, Aquis, Avantis, DYNS IM, eDNA, EYESIM, InBatch, InduSoft, InStep, IntelaTrac, InTouch,
PIPEPHASE, PRiSM, PRO/II, PROV IS ION, 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: 6/29/2018
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 OHB. 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 Service User Guide

Contents
Chapter 1 Getting Started..................................................................................................... 5
Introduction to MES Service....................................................................................................... 5
MES Service Scheduled Tasks .................................................................................................. 5
The Minutely Task and Utilization E vents .............................................................................. 7
Installing MES Service............................................................................................................... 7
Disabling MES Service from Running Aut omatically ............................................................... 7
Starting and Stopping MES Service ............................................................................................ 8

Chapter 2 Sample Generation and Status Update for Quality Specifications .............. 9
Introduction to MES Service and Sample Generation .................................................................. 9
QM Functions ........................................................................................................................... 9
Generating Samples ............................................................................................................... 10
Order of Specificity.................................................................................................................. 11
Frequency Type Shift .............................................................................................................. 11
Frequency Type Calendar Time ............................................................................................... 12
Interval Unit Is Hours ......................................................................................................... 12
Interval Unit Is Days .......................................................................................................... 13
Interval Unit Is Weeks........................................................................................................ 13
Frequency Type Production Unit Count .................................................................................... 14
Entity Context ......................................................................................................................... 15
Shift Change ..................................................................................................................... 16
Cont ext Other Than Entity.................................................................................................. 16
Generating Sample Names by Using Replaceable Parameters .................................................. 17
Readying Samples .................................................................................................................. 18
Updating Sample Status .......................................................................................................... 18

Chapter 3 Shift Generation................................................................................................. 21

Introduction to MES Service and Shifts ..................................................................................... 21
Changing Shifts ...................................................................................................................... 21

Chapter 4 Database Maintenance .................................................................................... 23

MES Service Database Services .............................................................................................. 23
Deleting Information Aut omatically ........................................................................................... 23
Archiving Data Automatically ................................................................................................... 25
Archiving Process ............................................................................................................. 25

Appendix A System Parameters ....................................................................................... 27

System Parameter Groups ...................................................................................................... 27

Version 6.0 3
MES Service User Guide Contents

System Parameters Reference ................................................................................................ 27

Index ......................................................................................................................................... 47

4 Version 6.0
 MES Service User Guide

C HAPTER 1
Getting Started
In This Chapter
Introduction to MES Service ............................................................................................................ 5
MES Service Scheduled Tasks ........................................................................................................ 5
Installing MES Service .................................................................................................................... 7
Starting and Stopping MES Service ................................................................................................. 8

Introduction to MES Service

The Manufacturing Execution System (MES) Service is a program that is set up to run continuously as a
service, and does not require you to log in to Windows. The MES Service manages the background tasks
in MES that are not done by:
 An application object
 A program that you are running
 An MES control embedded in an InTouch symbol
The MES Service performs several functions, such as the foll owing:
 Generat es samples and updat es status for quality specifications. For more information, see Sample
Generation and Status Update for Qualit y Specifications .
 Generat es shifts for any set of entities. For more information, see Shift Generation.
 Maintains tables in the MES database. For more information, see Database Maintenance.
The MES Service is notified if you make the following configuration changes within MES Client:
 Altering sample plan frequencies
 Unlinking frequencies from sample plans
 Changing the sample plans that are linked to Quality Management (QM) specifications or t heir linked
characteristics
In case of the above configuration changes, all future samples related to the old context are deleted.
The future samples are regenerated to accommodate the new context, interval, characteristics, and
frequencies.

MES Service Scheduled Tasks

The MES Service performs the following scheduled tasks.
Every Minute (Starting Within Half a Second)
The MES Service performs the following tasks every minute:
 Updates the current shifts for each entity if the shift changes, which may generate new samples.
 Checks for the beginning or end of Daylight Saving Time, and automatically adjusts the Report time
zone difference from GMT (min) general parameter.

Version 6.0 5
MES Service User Guide Getting Started

 Runs the sp_BG_Minutely_Tasks stored procedure to do the following:

o End stale sessions.
o Update the projected finish time for jobs.
o Record any data set to be collected on a periodic basis.
o Complete steps that have a fixed time duration, after the time has elapsed.
 Performs Supply Chain Connector imports and exports based on time (that have a trigger type of
daily, weekdays, weekly, or every N minutes), the existence of a file (for imports), the existence of
data in a table (for imports), or a change in int ernal MES dat a (for exports).
 Performs Supply Chain Connector exports bas ed on the ending of a job or a shift. The exports are
queued up and processed every minute by the MES Service, and not by the process causing these
events.
Every Hour
The MES Service performs the following tasks at the start of every hour:
 Runs the sp_B G_Hourly_Tasks stored procedure to ready the first jobs of a work order if its release
date and time has passed. The MES Service archives the stored procedures, when it is time to do so.
For more information on archiving, see Archiving Data Automatically.
The MES Service only checks for jobs to ready (where the release date/time has elaps ed) during
hourly background tasks. So, if at 8:05 you create a job to be released at 8:20, the job will not go to
ready right at 8:20; it will go to ready sometime bet ween 8:20 and 9:19, whenever hourly tasks run.
For all the jobs that are currently running on the entities, the MES Service updat es the statistics
(runtime, downtime, idletime, qty_good, qty_reject) in the job_hour_history table for the hour that is
two hours in the past from the current UTC time.
 Asks the License Manager for the current licensing and updates the internal licensing structures. If
any licenses are activat ed, deactivated, or expired, this allows any operational actions that touch on
those licenses to be correctly carried out or denied.
Every Day
The MES Service performs the following tasks at the start of every day:
 Runs the sp_BG_Daily_Tasks stored procedure to project the entities' shift schedules for the next
few days.
 Runs the sp_BG_Daily_Tasks_Custom stored procedure if it exists.
 Delet es historical data records that are older than the value specified in the Days to k eep data
0=never delete general parameter.
 The MES Service cleans up the QM context data, whic h is older than the value specified in the How
long to k eep old cont ext information (in days) general parameter.
Interval Specified by the General Parameter
The MES Service performs the following tasks at the interval specified by the Frequenc y to call sample
updates (in seconds) general parameter:
 Runs the sp_u_Sample_ReadySamples stored procedure to change the status of QM samples. The
future samples in the sample_to_go table with request time in the past, are moved to the sample
table, and the status is set to Ready.
 Runs the sp_u_S ample_UpdateStatus stored procedure to perform the following tasks:
o Updates the status of QM samples that are Re ady and the warning time (requested time and
warning interval) has expired and the new status is Ready Warning.

6 Version 6.0
Getting Started MES Service User Guide

o Updates the status of QM samples that are Ready or Ready Warning and the expiration time
(requested time and expiry interval) has passed and the new status is Missed.
o Updates the status of QM samples that are In Progress and the expiration time has passed and
the new status is Late.
 Runs the sp_u_S ample_GenerateSamples stored procedure to create additional fut ure samples
required by the passage of time. All fut ure s amples are regenerated as per the current date and time,
if any of the following configuration data changes:
o A QM specification
o The set of characteristics linked to a QM specification
o A sample plan
o A sample plan frequency
If one action takes an inordinately long time, a separate thread starts for the tasks at each frequency so
that the effect on other actions is minimized.

The Minutely Task and Utilization Events

The minutely task checks for current utilization reasons that are elapsed. If the current reason has a
non-null maximum duration and a non-null new reason code configured and it elapses (that is, the
duration of the current utilization event related to the reason has passed its configured maximum
duration), then the current reas on is changed to the configured new reas on.

Installing MES Service

The MES Service is installed on a node by selecting the MES Service component during the MES
installation. For more information on installation, see the MES Installation Guide or online help.
There should be only one MES Service running in a system. Also, it is recommended to have a dedicated
MES middleware service running on the same node as the MES Service.

Disabling MES Service from Running Automatically

There should be only one instance of the MES Service running per system. For example, if you install the
MES Service on more than one system, without choosing a custom installation, you must disable the
Service to avoid it starting automatically. You can control this using the Services applet inside the
Admini strative Tool s on the Windows' Control Panel.
To disable MES Service from running automatically
1. Right -click MES Service and click Properties.

Version 6.0 7
MES Service User Guide Getting Started

The MES Service Properties dialog box appears.

2. On the Startup Type list, select Disabled.

You can do this for any computer which has the MES Service installed, but you do not want to run it
in that system.
The MES Service is disabled and stops running automatically.

Starting and Stopping MES Service

By default, the MES Service Windows service will start automatically. There might be times when it has
to be stopped and restarted; for example, when upgrading the MES middleware.
To start, stop, or restart MES Service
1. Right -click the System Monitor icon on the system tray, shown below.

2. Click MES Service and then click Start, Stop, or Re start.

When you start the MES Service, it logs in with the user name specified in the User ID for back ground
task s general parameter. This starts up a special session. The MES Service tries connecting up to 12
times every 10 seconds, and displays an error if it fails to connect. This happens because both the MES
middleware host and the MES Service run as Windows services. The MES Servic e depends on, and
therefore starts after, the MES middleware servic e. When both are set t o start automatically, Windows
reports the starting of the MES middleware service before it manages to connect to the MES database,
and this allows the MES Servic e to start.
The MES Service connects to the MES middleware host but it might not be able to successfully establish
its session, which requires communication to the MES database. Thus, it allows up to 120 seconds for
the database communication to be established.

8 Version 6.0
 MES Service User Guide

C HAPTER 2
Sample Generation and Status Update for
Quality Specifications
In This Chapter
Introduction to MES Service and Sample Generation ........................................................................ 9
QM Functions ................................................................................................................................. 9
Generating Samples ..................................................................................................................... 10
Order of Specificity ....................................................................................................................... 11
Frequency Type Shift .................................................................................................................... 11
Frequency Type Calendar Time..................................................................................................... 12
Frequency Type Production Unit Count .......................................................................................... 14
Entity Context ............................................................................................................................... 15
Generating Sample Names by Using Replaceable Parameters ........................................................ 17
Readying Samples ........................................................................................................................ 18
Updating Sample Status ................................................................................................................ 18

Introduction to MES Service and Sample Generation

The MES Service periodically checks all entities that can capture QM data to determine if new future
samples need to be creat ed. It also checks if existing future samples can be changed to ready samples.
It updates the state of previously readied samples, if they are canceled or not c omplete, once the
warning time or expiration time is reached.
The purpos e of collecting a sample is to measure the quality of a produc ed item or a process parameter.
Future samples are generated at defined intervals till the end of a shift, or the configured time period in
the future. This allows you to view the projected samples of a shift and to measure the quality of samples
when they are ready.

QM Functions
The MES Service performs the following QM -related functions:
 Generat es future samples for frequency types shift and calendar time by entity
 Adjusts future sample times from a production count frequency when the reported production falls
behind the ex pected rate.
 Determines which QM specifications are active
 Determines the order of specificity of active applicable QM specifications based on context
 Generat es sample names, potentially using replaceable paramet ers
 Readies samples
 Updates sample status

Version 6.0 9
MES Service User Guide Sample Generation and Status Update for Quality Specifications

Generating Samples
The MES Services initiates a stored procedure to generate future samples in the database. The future
sample generation logic is complex and depends on the configuration of the MES Client. If the MES
Service is not running, samples are not created. The Service does not create samples in the past if it
loses connection with the database or is shutdown for a period of time.
The frequency of sample generation is based on the Frequency to call sample updates (in seconds)
system parameter, which is located in the Dat a Entry group. This system parameter has a default value
of 30 seconds.
First, this functionality determines which entities are eligible to have samples generated for them.
You can collect samples for an entity if its Can collect QM dat a setting is selected in the entity Properties
pane. For more information on the Can collect QM data capability, see the MES Client User Guide or
online help. The corresponding sample plan frequency and QM characteristics are ignored if the Can
collect QM data setting has not been selected for the entity.
A QM specification can have multiple versions. But at a given time, only one version can be active and
generate fut ure samples. If there are more than one version of a QM specification (and all share the
same specification name and context information), the active version is the one that has the following:
 The start effectivity is either current or in the past, and it is the highest (most recent) specification with
the same specification name and context.
 The end effectivity is either Null or in the future.
The samples are generated for an entity using the active QM specification in the following scenarios:
 If the Can capture QM data entity setting is set to True for an entity and an active QM specification is
directly assigned to this entity, samples are generated from an active QM specification.
 If the Can capture QM data entity setting is set to True for an entity and there is no QM specification
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 generat e the samples for an entity.
If no such active QM specification is found, no future samples will be generated by using the
specifications at the current time.
For each QM specification with a sample frequency of Shift or a Calendar, Equipment run time, or
Equipment production count linked to it, the MES Service generates future samples for the entity. The
sample frequency is linked through the sample plan at the QM specification level or characteristic
override level.
If the value of the current shift is none (0), the system cannot gen erat e future or ready samples for the
Shift frequency type. Samples are generated based on the Future Sample Generation parameter for the
Calendar, Equipment run time, or E quipment production count frequencies:
 If the setting is Null, then no fut ure samples are generated when no shift is defined.
 If the setting has some value, then future samples are generated up to the time limit specified even
when no shift is defined.
When defined, a shift frequency generates samples up to the end of the current shift. If the setting for
Future Sample Generation is Null for the Calendar, Equipment run time, or Equipment production count
frequencies, then future samples are generated up to the end of the current shift, otherwise they are
generated up to the setting for Future Sample Generation.
If multiple QM specifications have the same sample plan at a given time, a sample is generat ed with all
characteristics of the specifications.

10 Version 6.0
Sample Generation and Status Update for Quality Specifications MES Service User Guide

Order of Specificity
If t here is a QM specification that has all the characteristics already linked to other QM specifications with
higher precedenc e, no samples will be generated for that QM specification.
When multiple active QM specifications for an entity have the same characteristic(s) within them, then
the system determines which QM specification takes precedence. Each sample is linked to certain QM
specifications, which are considered in the order of specificity of their contexts. The context fields are as
follows, listed in order of increasing specificity:
 Entity/Entity class (ent_id).
 Item (item_id).
 Item Category (item_category_id).
 Process and Operation (process_id and oper_id). The process_id is only considered for work orders
instantiated from a process.
For the purpose of determining specificity, the process and operation are collectively considered as a
single field, which is referred as operation in the following discussion. The order of specificity is based on
the following criteria.
Context Fields
Specifications with more context fields with non-null values are preferred over specifications with
fewer context fields with non-null values. For example, a specification with three context fields is
always more specific than a specification with two context fields.
Operation
Operation is considered more specific than entity, item, or item category.
Item
Item is considered more specific than item category.
Item/Item Category
Item or item category are considered more specific than the entity.
Enti ty
Lower-level entities are considered more specific than the higher -level entities, such as entity
classes.
Combination Contexts with No Common Elements
The levels of specificity of combinations of two fields, where one in common is decided by the one
that is not common. For example, a combination of operation and item is considered more specific
than a combination of item and entity, because the operation is more specific than the entity.
Operation and Item Category
The levels of specificity of combinations of two fields, where none are in common are decided by the
single field which is the most specific. For example, a combination of operation and item category is
considered more specific than a combination of item and entity, because the operation is more
specific than the item or entity.
The point in determining the precedence of QM specifications is that any given characteristic can only be
represented by a single QM specification when it is time to actually capture data, whichever one is linked
to it that has the greatest specificity.

Frequency Type Shift

If a sample plan frequency is configured to generate future samples for a shift, the active QM
specification using this frequency generates future samples up to the end of the shi ft. If a QM
specification becomes effective during a shift, samples are generated based on the shift frequency
definition, but no samples are generated in the past.

Version 6.0 11
MES Service User Guide Sample Generation and Status Update for Quality Specifications

Shift samples are calculated based on the following:

 The shift start and end times.
 The frequency configuration options of start offset and end offset.
 The time bet ween samples and number of samples.
The first sample is based on the shift start time and the start offs et setting. No samples are generated at
the end of the shift minus the end offset time.
 If the number of samples is provided and the time between samples is not provided (Null), then the
available shift time is split equally among the number of samples. For example, if the number of
samples is 1, then only the first sample is created. If the number of samples is 2, then only the first
and final samples are creat ed.
 If the time bet ween samples is provided and the number of samples is not provided, the first sample
is created and future samples are created adding the time interval unt il the end of the shift.
 If the number of samples and time interval are both provided, the first sample is generated. The
following samples are generated by adding the time bet ween samples to the previous sample time. If
the number of samples is small enough that this number of samples is reached before the end of the
shift, the set of samples in this shift ends early. Regardless of how large the number of samples
becomes, though, no samples are generated beyond the shift end.
For more information, see the MES Client User Guide or online help.

Frequency Type Calendar Time

If a sample plan frequency is configured to generate future s amples for a calendar time frequency, the
active QM specification using t his frequency generates future samples either to the end of t he shift or the
time specified in the future sample generation property. If no previous sample is available for an entity in
this context, then a Ready sample is immediat ely generat ed.
If a calendar frequency has no offset start value, samples are generated at the defined frequency. The
reference time for the first sample is based on the time at which the MES Service starts. If the MES
Service is shutdown for a time period greater than the interval time, the sample generation starts when
the Service is restarted and not at the previously defined frequency. Samples are not generated in the
past.
If the offset start is configured for a frequency, the samples can be generated at a time relative to
midnight (local time) of any day or midnight (local time) of that Sunday. Subsequent, samples can be
timed relative to this sample time; otherwise, the sample request times are calculat ed as described
previously.

Interval Unit Is Hours

If the interval unit for a calendar frequency is set to hours (enumeration value of 2), and if the offset start
and the offset start unit configured for this frequency is not null, then the first sample for a day is offset
from the midnight of that day. This offset is generated using the value in the offs et_start and
offset_start_unit configured for that frequency. If the interval time between samples goes past the end of
that day (that is, 11:59:59pm), then the first sample for the following day is again offset from the midnight
(12:00am) of the following day.

12 Version 6.0
Sample Generation and Status Update for Quality Specifications MES Service User Guide

Interval Unit Is Days

If t he interval unit for a calendar frequency is set to days (enumeration value of 3), and the offs et start and
offset start unit configured for this frequency is not null, then the first sample for a week is offset from the
midnight of the Sunday of that week. The offset is generat ed using a value in the offset_start and
offset_start_unit configured for that frequency. If the interval time between samples goes past the end of
Saturday (that is, 11:59:59pm) of that week, then the first sample for the following week is again offset
from the midnight (S unday, 12:00am) of the following week.

Interval Unit Is Weeks

If the interval unit for a calendar frequency is set to weeks (enumeration value of 4), and offset start and
offset start unit configured for this frequency is not null, then the first sample for a week is offset from the
midnight of Sunday of that week. The offset is generated using the offs et_start and offset_start_unit
configured for that frequency.
A sample is generated when the time between the last sample (collected for the entity with the frequency)
and the offset from midnight Sunday of the current week is greater than the interval tim e configured for
the frequency. The sample is generated for the current week, at the time specified by the offset.
The following table shows how sample times (in local time) are calculat ed with different offset units
corresponding to an interval unit.

Interval Offse t Offse t Start

Frequency ID Interval Unit Start Unit Sample Times

1 3 2 (hours) 10 1 (minut es) 12:10am, 03:10am, 06: 10am,

09:10am, 12:10pm, 03: 10pm,
06:10pm, 09:10pm, 12:10am (day+1),
03:10am (day+1), and so on.

2 1 2 (hours) 20 2 (hours) 08:00pm, 09:00pm, 10: 00pm,

11:00pm, 08:00pm (day+1), 09:00pm
(day+1), 10:00pm (day+1), 11: 00pm
(day+1), 11:00pm (day+2), and so on.

3 1 3 (days) 25 1 (minut es) 12:25am (Sun), 12: 25am (Mon),

12:25am (Tue), 12:25am (Wed),
12:25am (Thu), 12:25am (Fri),
12:25am (Sat ), 12:25am (Sun,
week+1), 12:25am (Mon, week+1),
and so on.
4 1 3 (days) 62 2 (hours) 02:00pm (Tue), 02:00pm (Wed),
02:00pm (Thu), 02:00pm (Fri),
02:00pm (Sat ), 02:00pm (Tue,
week+1), 02:00pm (Wed, week+1),
02:00pm (Thu, week+1), and so on.

5 1 4 (weeks) 40 1 (minut es) 12:40am (Sun), 12: 40am (Sun,

week+1), 12:40am (S un, week+2),
and so on.
6 1 4 (weeks) 66 2 (hours) 06:00pm (Tue), 06:00pm (Tue,
week+1), 06:00pm (Tue, week+2),
and so on.

Version 6.0 13
MES Service User Guide Sample Generation and Status Update for Quality Specifications

Interval Offse t Offse t Start

Frequency ID Interval Unit Start Unit Sample Times

7 2 4 (weeks) 66 2 (hours) 06:00pm (Tue), 06:00pm (Tue,

week+3), 06:00pm (Tue, week+5),
and so on.

Frequency Type Production Unit 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. If the production
count frequency is configured to count any setting other than units, then it behaves as an event trigger
frequency and no future samples are generated. For samples to be generat ed 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.
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 generated 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 future sample are generated and the frequency behaves as an event
frequency generating samples with the production of a sufficient quantity of units.
Unlike the calendar and shift frequencies, future production unit count samples are readied (moved to
the sample table) only when the required number of units have been produc ed instead of based on the
future 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 cont ext 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 Frequenc y to call sample updates (in seconds), which has a
default of 30 seconds. Using the above example of a frequency with 50 units:

Production Units Context Table Sample

Time Reported Count Generated

10:03 10 10 No

10:06 10 20 No

10:09 10 30 No

10:12 10 40 No

10:15 10 0 Yes

14 Version 6.0
Sample Generation and Status Update for Quality Specifications MES Service User Guide

Once a sample is generated, it cannot be deleted through a reduction of production. In this case, the
context table becomes negative and the following sample will be readied once the additional amount has
been produced. A production transaction that amounts to a total count that exceeds the frequency
interval, even if it exceeds it by a factor of 2 or more, will still only generate a single ready sample. Using
the same example, a production transaction of 100 units will only generate a single ready sample, not
two, and the excess multiple of the interval (50 in this case) will be ignored.
Prediction of the request time for the first sample may take into consideration production counts from
previous jobs. The context of the active QM S pecification is used to determine if any existing quantities in
the context table should be used in predicting the initial requested time. In a simple case, the previous
example of a job with 225 units is run and, at the completion of the job, there are 25 units remaining in the
context table. Another job is started following the first for 225 more units using the same QM
specification. The leftover 25 units will be used in the estimation of the first sample, so the first sample
request time will be 7.5 minutes in the fut ure instead of the normal 15 minut es since 25 of the required 50
units have already been produc ed by the previous job and are used in the estimation of this job. The
usage of previous context information is configurable based on the Production Reset option in the
production count frequency definition. The available Production Reset options choices are described
below.
Never
Always use all applicable context records matching the context of the active 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
All applicable context records are set to 0 if eit her of the follow occurs:
o A new job is started on an entity that is producing a different item from the previous item run on
the entity.
o Production is reported against a substitute item for the same job.
Shift changes on entity
At the completion of a shift change, all applicable c ont ext records are set to 0. This will impact the
sample request times for samples based on the current job.
If the quantity of all previous context records applicable to the context of a new job started on an entity is
equal to or greater than the production count frequency interval, then the first predicted sample is based
on the amount of time it will take to produce enough units to match the maximum setting for all the
included characteristic’s minimum sample size.
As production is recorded, sample request times will be updated for future samples outside of the MES
Service. However, if production is not recorded, then the MES Service will adjust sample request times
based on the setting of the system parameter Sample wait time for delayed production (in minutes).
 If this parameter is set to 0, then there are no adjustments to fut ure sample request times and it is
possible for a "future" request time to have a value in the past. When there are two future samples
with a request time in the past, then the first one will be deleted by the MES Service.
 If t his paramet er is set to a non-zero value, then when a future sample’s requested time is in the past,
all sample_t o_go rec ords for the entity and for the production count frequency will have their
requested times increased by the specified number of minutes. If this causes any samples to be
pushed forward into the next shift and the Future sample generation setting is Null, those samples
pushed into the next shift will be deleted.

Entity Context
The future samples for an entity are generated only if all of the following conditions are satisfied:
 Cont ext field ent_id cont ains a non-null value

Version 6.0 15
MES Service User Guide Sample Generation and Status Update for Quality Specifications

 The item_id, item_category_id, process_id, and oper_id context fields contain null values
 There are no future samples already generated for this entity and characteristic
The future samples are generat ed for a characteristic at each interval time defined per the sample plan
frequency. However, a characteristic is ignored if it has already been us ed for a certain time period by
some other frequency linked to a sample plan.
If an entity identified in the context is an entity class, or has descendant entities, then a separate sample
request is generated for each descendant entity whose Can Collect QM Data setting is selected. S ample
requests are generat ed for each entity at regular time int ervals defined in the frequency definition.
The future samples generated in the context of an entity may be deleted in the future. This is done if a job
is started on this entity has a QM specification applicable to its context that has a higher specificity than
the current QM specification.

Shift Change
Future samples in the previous shift are delet ed. This also includes the samples wit h specificity other
than entity.
Future samples are generated if the entity is linked to a sample plan frequency and QM specification. The
samples are generated for an entity till the end of the current shift, using the entity specific context
information.
If there is a job running on the entity, and a QM specification that matches the job's context, the QM
specification, and not the one whose context is solely that of the entity, is used to generate future
samples. This is because the entity-only context has the lowest possible specificity, so a specification
matching any other context information must necessarily have a higher specificity than this. The future
samples are generated up to the end of the current shift in the following cases:
 If the sample plan frequency and QM specification have context information other than an entity,
which includes or excludes the entity context information.
 If t here is a job running on the entity whose operation or the item is equal to the cont ext information in
the QM specification.
 If there are no future samples for the sample plan frequency and QM specification.

Context Other Than Entity

The future samples generat ed from this category are related to an action performed on a job.
Job Start
Future samples are generat ed for a job when it is started. If there exists an effective QM specification
that,
o if the item context is not null, matches the main item being produced by the job, and
o if the operation cont ext is not null, matches the job's operation, and
o if the item category context is not null, has a context of item category to which the main item the
job produces belongs, and
o if the process context is not null and the work order to which the job belongs was instantiated
from a process, has a process context of the proc ess from which the work order was
instantiated, and
o if the entity context of the QM specification it is not null, has an entity context matching either
the entity on which the job is being run or one of its ancestors.

16 Version 6.0
Sample Generation and Status Update for Quality Specifications MES Service User Guide

The future samples are generat ed for each QM specification at each interval time defined, and the
context directly or indirectly matches the operation, item, and/or entity of a running job. If a
characteristic is already accounted for by some other QM specification context having higher
specificity than the current context, then it is ignored.
If a sample exists for a time frame linked to a QM specification context that has a lower specificity
than the current context, then the existing samples are deleted before the new samples are
generated for the current context.
When a shift change occurs, the future samples for the next shift are regenerated up to the end of the
next shift. The regenerated samples are generat ed for item that is linked to a sample plan frequency
and QM specification, and the context has the highest specificity than others.
Job End, Job Paused, or Job Status Change from Running to Another State
When a job is ended, paused, or the status is changed to any other state except running, the future
samples for the sample plan frequency and QM specifications for the operation or item are deleted
for the current shift. This is done as long as the operation and item are not used by other jobs on the
same entity.
If the fut ure samples related to the current context are deleted, new future samples are generated for
the current shift. To generate the future samples for the current shift, the sample plan frequency and
QM specification needs to have the closest specificity preceding the current context.

Generating Sample Names by Using Replaceable Parameters

To easily identify the group of samples by a template name in a report, a Replaceable Parameter is used
to generate sample names. When a sample is generated, the actual sample 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.
Sample names are generated as a frequency type is evaluated in the sample generation code. In the
order of evaluation, shift frequencies are evaluated before calendar frequencies. If sample names have
an increment al octothorpe, and samples are generated for shift and calendar frequencies, the sample
name numbering will not be in time order.
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

Version 6.0 17
MES Service User Guide Sample Generation and Status Update for Quality Specifications

Replaceable Parameter (Case

Insensiti ve) Value Returned Example

[WorkOrderID] Work Order ID WO123456

[OperationID] Operation ID BlendingOperation

[SequenceNumber] Job Sequence Number 0

[ItemID] Item ID Item123456

[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.

Readying Samples
For calendar, shift, and equipment runtime frequencies, the MES Service readies a sample by moving
future samples from the sample_to_go and sample_char_link _to_go tables to the sample and
sample_c har_link tables. This happens when the current time (UTC) is greater than or equal to the
requested_time_utc in the sample_to_go table.
For production unit count frequencies, samples will either be pushed further into the future or will be
skipped based on the system parameter setting Sample wait time for delayed production.

Updating Sample Status

The MES Service sets the status of a sample based on the following conditions.

18 Version 6.0
Sample Generation and Status Update for Quality Specifications MES Service User Guide

Ready Warning
When the current time is equal to or greater than the requested sample time and the warning interval
for a ready sample, the pulled_time_utc is Null and no data is collected for the sample.
Missed
When the current time is equal to or greater than the requested sample time and the expiry interval
for a sample, and the pulled_time_utc is Null and no data is collected for the sample.
Late
When the current time is equal to or greater than the requested sample time and the expiry interval
for a sample, and the pulled_time_utc is Not Null or data is collected for the sample but not all.
When a measurement data is recorded in the dat abas e, the status is updated based on the following
conditions.
In Progress
Specifies the current time is between the requested and expiration time, and that at least one
measurement is recorded in the result table for the sample.
Complete
Specifies the meas urement time for all the characteristics for a sample that are less than the sample
expiration time, and the sample size for each characteristic within the sample is at least equal to the
defined minimum sample size.
Complete Late
Specifies at least one measurement time that is greater than the expiration time, and the sample size
for each characteristic within the sample is at least equal to the minimum sample size.

Version 6.0 19
 MES Service User Guide

C HAPTER 3
Shift Generation
In This Chapter
Introduction to MES Service and Shifts........................................................................................... 21
Changing Shifts ............................................................................................................................ 21

Introduction to MES Service and Shifts

Shifts are defined in MES Client. The start and end time of each shift can be determined independently
for any set of entities. The shifts in MES are not directly associated with personnel.
The following shift schedules are available:
 The ability for a shift schedule to be defined for an entity is controlled by the Can Schedule Shifts
capability of the entity.
 Entities for which no shifts are scheduled inherit the shift schedule of the closest ancestor entity that
is not an entity class. This allows all entities within a plant to have a common shift schedule, except
for the particular department.
 The shift schedules are generally defined on a weekly basis. They can also be defined per entity as
follows:
o Subtractive shift schedules (holidays or ot her planned work outrages )
o Additive shift schedules (overtime)
The one-time exception events are combined with the weekly shift information. These events are applied
to each entity that has or inherits a shift schedule. This is done so that event time or event schedules are
attributed to the correct shift.

Changing Shifts
The MES Service runs the sp_U_Ent_DoA utoShiftChanges stored procedure every minute to check if it
is time to change the shifts.
The shift change process is handled as follows:
 For each entity that has a shift schedule defined, the MES Service checks if it is time to change
shifts. If it is, then each entity that inherits the shift from the parent shift will change shifts. If there are
many entities changing shifts at the same time, the MES Service might take several seconds to
complete the shift change process.
 If a shift ends on an entity and there is no following shift, then the MES Service changes the entity
shift property to No Shift (which has an ID of 0).
A separate table that contains the start and end times of the subsequent shifts is maintained, to quicken
the shift change process. Entities with inherent shift schedule are not included in this tabl e. The shift
change information is updated daily.
The shift information of all the entities, with own schedule or inherited schedule, is recorded in the Shift
History table. This table is updated automatically as a part of the shift change proc ess. If a shift schedule
is changed, the MES server still recovers the shift information for current event.

Version 6.0 21
MES Service User Guide Shift Generation

The MES Service also does the following:

 If an entity that captures utilization reasons is changing to a non-z ero shift and there is a shift start
reason code configured for the entity, then a new utilization event is generat ed for the entity. The
new utilization event will us e the configured shift start reason code and the shift start time as the
event start time.
 If an entity that captures utilization reasons has a shift end reason code configured, the shift end
reason code is used in the following c onditions when a new utilization event is creat ed with the event
timestamp equal to the shift start time:
o The entity is changing to a non-zero shift and there is no shift start reason code configured.
o The entity is changing to a zero shift (no shift).
 If a shift start or shift end reason code is not configured for an entity that captures utilization events,
the utilization reason that was generated earlier is continued in the current shift. That is, a new
utilization event is not generated for the change of shift.
 Generat es new QM samples that are based on the shift, where either the sample plan frequency
type is Shift, or no value is specified for generating future samples. Shift change takes more time
allowing samples to be generated up to 5 minutes in the past. This ensures that events scheduled at
the beginning of the shift are generated before the shift change process is complete.
When the MES Service starts, it checks whether all the shifts are generated, by running the
sp_U_Ent_DoPastShiftChanges stored procedure. It updates the table of upcoming shifts, and checks
for the shift changes that are due (because the period, during which the MES Service was off, may have
exceeded the time for which future shift had been projected).
The MES Servic e terminates in t he following cases because shift generation depends on t he correct shift
information:
 If updating the past shift fails.
 If the normal shift change fails 15 times in a row.

22 Version 6.0
 MES Service User Guide

C HAPTER 4
Database Maintenance
In This Chapter
MES Service Database Services ................................................................................................... 23
Deleting Information Aut omatically ................................................................................................. 23
Archiving Data Automatically ......................................................................................................... 25

MES Service Database Services

In addition to the archive, purge, and restore mechanisms to maintain tables in the MES database, the
MES Service allows you to:
 Automatically delete information
 Automatically archive data

Deleting Information Automatically

The MES Service deletes information that is older than the value sp ecified in the Days to k eep data
0=never delete general parameter. The MES Servic e updates this daily.

The Days to k eep data 0= never delet e general parameter will be deprecated in a future release.

If a value other than 0 is specified, the following information that is older than the value is deleted from the
MES databas e:

Value Used to Decide Whether to

Information Deleted Table Name Delete

Error history. error_log When the error was logged

Shift exceptions (holidays/overtime). shift_exc When the exception ended

Upcoming shift schedules. shift_to_go When the shift ended

Under normal circumstances, this
information is automatically removed
before the mechanism deletes it.

History of movements of invent ory. item_transfer When the transfer occurred

History of shipments to customers, shipment When the shipment was made

including breakdown by lots shipped.
shipment lot

History of Supply Chain Connector dx_log When the transfer completed

transfers.

Version 6.0 23
MES Service User Guide Database Maintenance

The following work order related data is deleted only if bot h the Archive dat abase server name and
Archive database name general parameters are not defined, during a new installation. If the time
mentioned in the Value Used to Decide Whether to Delet e column is different from the time when the
work order associated with the data is completed, the data with the older value i s deleted.

Note: The Archive database server name and Arc hive database name general parameters will be
deprecated in a future release.

Value Used to Decide Whether to

Information Deleted Table Name Delete

History of performance metrics tpm_stat When the shift to which they relate
started
This information is deleted when the start
time of the related shift is not the current
one. The end time of the related work order
is not considered.
Item production history item_prod When the work order that caused
the production finished
Item consumption history item_cons When the shift in which the
consumption occurred started
Entity utilization history, including affected util_log, When the utilization event started
jobs job_util_log_link

Labor usage history labor_usage When the labor usage started

History of sign-offs cert_audit_log When the sign-off occurred

Data log information up to and including 16 data_log_16 When the information was recorded
values per event

Data log information over 16 values per data_log_48 When the information was recorded
event

Definitions of material flows between jobs job_route When the work order finished
of a work order

Jobs and their: attributes, bills of material job, job_attr, When the work order of which the
and related information, event history, job_bom, job is a part finished
specifications, resource requirements, and job_bom_step
planned inventory moves job_bom_subst,
job_event, job_s pec,
job_step_grp,
res_job_link,
spc_char_job,
transfer_list

Work orders wo When the work order finished

24 Version 6.0
Database Maintenance MES Service User Guide

Archiving Data Automatically

The MES Service can automatically archive data. This mechanism is controlled by the Day to archive
data and Time to archive data HH: MM general parameters. It is different from the archiving, purging, or
restoring mechanisms that are defined in the Database Maintenance section of the MES Client User
Guide or online help.

Note: The Day to archive data and Time to archive data HH: MM general parameters will be deprec ated
in a future release.

To archive data
1. The MES Service executes a database job to call the sp_Arc hive_Wo stored procedure.
2. You can populate the job, which is initially empty, with the mechanism that you want to use for
archiving.
3. You must configure the Archive database server name and Archive database name general
parameters.
You do not need to define the parameter names to delete work order-related information.

Archiving Process
The SQL server checks, every hour, if the day of the week is correct. It also checks if the hour part of the
value for Time to archive data HH: MM general parameter is the same as the current UTC hour (current
local hour).
The SQL server does the following tasks:
 If the date and time are correct, the server searches for a job named MES arc hiving for
<database_name>, where <database_name> is the name of the database t o which the MES Service
is connected.
 If the server does not find a job, the job is created through the following steps:
o Execute msdb..sp_add_job to creat e the job.
o Execute msdb..sp_add_jobserver to set the instance where this job executes to the local server.
o Execute msdb..sp_add_jobstep to create a job that invokes sp_Archive_Wo.
The msdb..sp_start _job is called to execut e the creat ed job.

Version 6.0 25
 MES Service User Guide

A PPENDIX A
System Parameters
In This Appendix
System Parameter Groups ............................................................................................................ 27
System Parameters Reference ...................................................................................................... 27

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. Defines the time span (in hours) us ed to chunk
(hours) the archiving and purging of historical time-stamped records.
This is done to adjust the database activity for performance
requirements.

Version 6.0 27
MES Service 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.

28 Version 6.0
System Parameters MES Service 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.0 29
MES Service 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 clic ks
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.

30 Version 6.0
System Parameters MES Service 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.0 31
MES Service 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 least 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 sample 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 no res ults collected for the
sample.

32 Version 6.0
System Parameters MES Service 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.
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.
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.

Version 6.0 33
MES Service User Guide System Parameters

System Parameters Value Description

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 to
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.
Default Unit of Measure for Free-form text field. Det ermines the default UOM for an item.
Items

34 Version 6.0
System Parameters MES Service User Guide

System Parameters Value Description

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.0 35
MES Service 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, …

36 Version 6.0
System Parameters MES Service 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.0 37
MES Service 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.)

38 Version 6.0
System Parameters MES Service 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.0 39
MES Service 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 eve nts 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.

40 Version 6.0
System Parameters MES Service 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.0 41
MES Service 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.

42 Version 6.0
System Parameters MES Service 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.0 43
MES Service 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).

44 Version 6.0
System Parameters MES Service 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 implem ented 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.0 45
MES Service 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.

46 Version 6.0
 MES Service User Guide

Index
hours • 12
A weeks • 13
automatic running, disabling • 7

M
B MES Service
background tasks • 5
database services • 23
disabling automatic running of • 7
C functions performed by • 5, 9
context table • 14
installing • 7
introduction • 5
D restarting • 8
daily tasks • 5
sample generation • 9, 10
database services • 23
data, archiving automatically • 25 scheduled tasks • 5
shift generation • 21
information, deleting automatically • 23
starting • 8
stopping • 8
E
minutely tasks • 5
entity context, future samples • 15
utilization events • 7
context other than entity • 16
shift change • 16
P
production unit count, sample plan frequency •
F 14
frequency type
calender time • 12
Q
production unit count • 14
QM functions • 9
shift • 11

R
H restarting MES Service • 8
hourly tasks • 5

S
I sample generation • 9, 10
installing MES service • 7
entity context, future samples • 15
interval units
frequency type, calendar time • 12
days • 13
frequency type, production unit control • 14

Version 6.0 47
MES Service User Guide Index

frequency type, shift • 11

generating names using replaceable
parameters • 17
interval units, days • 13
interval units, hours • 12
interval units, weeks • 13
sample status, updating • 18
samples, readyinig • 18
specificity, order of • 11
sample names
generating using replaceable parameters •
17
sample plan frequency
production • 14
samples
readying • 18
status, updating • 18
scheduled tasks • 5
shifts
changing • 21
starting MES Servic e • 8
stopping MES Service • 8
system parameters • 27

U
utilization events and minutely tasks • 7

48 Version 6.0