Manufacturing Execution System (MES)

Supervisor

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 Supervisor User Guide

Contents
Chapter 1 Getting Started..................................................................................................... 7
Introduction to MES Supervisor.................................................................................................. 7
User Privileges ......................................................................................................................... 7
Logging in to MES Supervisor .................................................................................................... 7

Chapter 2 Managing Folders ............................................................................................... 9

Introduction to Managing Folders ............................................................................................... 9
Item Class Node ..................................................................................................................... 10
Item, Operation, and Entity Nodes ............................................................................................ 10
Item Files Grid .................................................................................................................. 11
Folder Version Node ............................................................................................................... 12
Folder Detail Pane............................................................................................................. 13
Create New Folder and Clone Folder Windows ................................................................... 15
Copy Contents Window ..................................................................................................... 16
Folders Window Filter.............................................................................................................. 17

Chapter 3 Managing Inventory .......................................................................................... 19

Introduction to Managing Inventory........................................................................................... 19
Add Item Window.................................................................................................................... 21
Trans fer Out Window .............................................................................................................. 22
Waste Window........................................................................................................................ 23
Reduce Window...................................................................................................................... 24
Lot Attributes Window ............................................................................................................. 25
Lot Attributes of Type Item Reason ..................................................................................... 26
Split Lot Window ..................................................................................................................... 26
Combine Lots Window............................................................................................................. 27
Reclassify Window .................................................................................................................. 29
Inventory Filters Window ......................................................................................................... 30

Chapter 4 Importing and Exporting Data Using Supply Chain Connector .................. 31
Introduction to Supply Chain Connector.................................................................................... 31
Import Schedules Node ........................................................................................................... 32
Import Schedule Summary ................................................................................................. 32
Summary Tab ................................................................................................................... 34
Trigger Tab ....................................................................................................................... 35
Data Tab .......................................................................................................................... 37
Trans port Tab ................................................................................................................... 39
Format Tab ....................................................................................................................... 40

Version 6.0 3
MES Supervisor User Guide Contents

Updates Tab ..................................................................................................................... 41

Actions Tab....................................................................................................................... 42
Logs Tab .......................................................................................................................... 43
Export Schedules Node ........................................................................................................... 44
Overview Grid ................................................................................................................... 44
Summary Tab ................................................................................................................... 45
Trigger Tab ....................................................................................................................... 46
Query Tab ........................................................................................................................ 48
Trans port Tab ................................................................................................................... 48
Format Tab ....................................................................................................................... 51
Updates Tab ..................................................................................................................... 52
Actions Tab....................................................................................................................... 52
Logs Tab .......................................................................................................................... 53
Queries Node ......................................................................................................................... 54
Query Summary ................................................................................................................ 54
Query Detail Pane ............................................................................................................. 55
Import Mappings Node ............................................................................................................ 58
Mapping Summary ............................................................................................................ 58
Import Mapping Group Detail Pane ..................................................................................... 59

Chapter 5 Managing Data Log Groups and Values ....................................................... 61

Introduction to Managing Data Log Groups and Values ............................................................. 61
Data Log Groups Node............................................................................................................ 61
Data Log Summary ........................................................................................................... 62
Data Log Group Detail Pane .............................................................................................. 63
Data Log Value Node .............................................................................................................. 64
Data Log Value Detail Pane ............................................................................................... 65

Chapter 6 Managing Shift Exceptions .............................................................................. 67

Introduction to Managing Shift Exceptions ................................................................................ 67
Entity List ............................................................................................................................... 68
System Schedule Pane ........................................................................................................... 68
Calendar ................................................................................................................................ 68
Entity Schedule Pane .............................................................................................................. 69
Shift Exceptions Pane ............................................................................................................. 69

Chapter 7 Managing Storage Entities............................................................................... 71

Chapter 8 Managing Customers ....................................................................................... 73
Introduction to Managing Customers ........................................................................................ 73
Customer Node....................................................................................................................... 74
Customer Detail Pane........................................................................................................ 75
Sales Order Node ................................................................................................................... 76
Sales Order Detail Pane .................................................................................................... 77
Line Item Node ....................................................................................................................... 78
Line Item Detail Pane ........................................................................................................ 79
Shipment Node ....................................................................................................................... 80

4 Version 6.0
Contents MES Supervisor User Guide

Shipment Detail Pane ........................................................................................................ 81

Customer Filter Window .......................................................................................................... 82

Chapter 9 MES Supervisor Menu Selections .................................................................. 85

File Menu ............................................................................................................................... 85
Edit Menu ............................................................................................................................... 85
View Menu ............................................................................................................................. 85
Tools Menu ............................................................................................................................ 85
Window Menu......................................................................................................................... 85
Help Menu.............................................................................................................................. 86

Appendix A Available Inventory Columns ........................................................................ 87

Appendix B Supply Chain Connector Imports and Exports via a COM Object.......... 89
Introduction to SCC Imports and Exports via a COM Object ....................................................... 89
Invoking a Method of a COM-Visible Object from an SCC Schedule ........................................... 89
C# COM-Visible Example ........................................................................................................ 90

Version 6.0 5
 MES Supervisor User Guide

C HAPTER 1
Getting Started
In This Chapter
Introduction to MES Supervisor ....................................................................................................... 7
User Privileges ............................................................................................................................... 7
Logging in to MES Supervisor.......................................................................................................... 7

Introduction to MES Supervisor

Manufacturing Execution System (MES) Supervis or is used to coordinate and oversee the daily activity
of your system. You can create work orders, inventory levels, and storage location data. You can set up
data collection, and link MES to other databases an d software. You can also store customer information
and process sales orders.

User Privileges
User privileges, set in MES Client, will determine the capabilities of each us er. Users may be limited to
viewing data in specific areas of MES Supervisor. They may be given permission to make changes in
some areas, but not others. They may be allowed to add dat a to or remove it from the database. Each
user’s experienc e with MES Supervisor can be customized using MES Client.
The discussion of functionality in this document assumes the ability to do everything possible with MES
Supervisor.
MES is designed to be a modular system of programs, so that only the functionality required by your
installation needs to be purc hased. Your MES license will determine which features will be available to
your users. All functionality of MES Supervisor will be described in this manual, but limitations on your
license may cause entire windows or options within windows to be unavailable.

Logging in to MES Supervisor

The MES Supervisor login window will always contain at least a Password field. Depending on your
system configuration, the window may also contain a Login Text view-only pane and/or a User Name
field.
1. On the Start menu, click the MES Supervisor tile.

Version 6.0 7
MES Supervisor User Guide Getting Started

The MES Supervisor login dialog box appears.

2. Enter your username and password.

If a keyboard is not attached to the system, click the Browse (…) button next to the User Name or
Password box to open a window that includes an online keyboard.
3. Do one of the following:
 To log in, click the Check Mark button.
 To cancel the login attempt, click the X button.
If you clicked the Check Mark button, the MES Supervisor application opens.

8 Version 6.0
 MES Supervisor User Guide

C HAPTER 2
Managing Folders
In This Chapter
Introduction to Managing Folders ..................................................................................................... 9
Item Class Node ........................................................................................................................... 10
Item, Operation, and Entity Nodes ................................................................................................. 10
Folder Version Node ..................................................................................................................... 12
Folders Window Filter ................................................................................................................... 17

Introduction to Managing Folders

In MES, folder refers to a collection of files, document ation, etc. that are relevant to an item’s production,
during a specific operation, on a specific entity (production line, machine, tool, etc.). This folder is
available to MES Operator us ers during production. MES Operat or users can access any folder defined
for the logged-onto entity, if no job is running; if a job is currently running on that entity, folder access will
be limited to those defined for that item on that entity.
The Folders window is used to create and maintain folder definitions for your system. The Folders
window is split into two panes. The tree pane, on the left, contains a tree diagram of all defined folders,
organized by produc ed item. The folder detail pane, on the right, displays the detailed information for the
node selected in the folder tree.

Version 6.0 9
MES Supervisor User Guide Managing Folders

Item Class Node

An item class is a logical grouping of items that share common characteristics, such as physical
properties and whet her they are produced, consumed, or bot h. In the folder tree, an it em class node is
only visible for the purpose of grouping items containing folders. If none of the items, in an item class,
contain folders, that item class will not appear in the folder tree. The folder detail pane contains no
information for this node.

Right -clicking an item class node opens a context menu that cont ains the following options :
Create Folder
Creates a new folder using the Create New Folder window. This window is described in detail in
Create New Folder and Clone Folder Windows on page 15.
Filter
Allows you to choos e what information appears in the folder tree. This feature is described in detail in
Folders Window Filt er on page 17.
Refre sh All
Rolls up the folder tree to the top level, and then updates the entire tree to reflect any changes made
in this window or elsewhere.

Item, Operation, and Entity Nodes

A folder can only be defined for an item, operation, and entity combination, so item nodes, operation
nodes, and entity nodes exist in the fold er tree to correctly group all defined folders. Above the folder
node level, item nodes, operation nodes, and entity nodes all provide access to the same information:
the files that are associated directly to an item (wit hout being placed in a folder first ).

In the figure above:

 An item node (Pillow Block Bearing) is selected in the folder tree.
 An operation node (30 (Inspect & Pack)) appears below the item node.
 An entity node (Assembly Station 03) appears below the operation node.
 A folder node (001) appears below the entity node.
Right -clicking an item, operation, or entity node opens a cont ext menu that contains the following
options:
Create Folder
Creates a new folder using the Create New Folder window. This window is described in detail in
Create New Folder and Clone Folder Windows.
Delete
Delet es all the folders below the selected node. The selected node will be removed from the tree
because no folders exist for it.

10 Version 6.0
Managing Folders MES Supervisor User Guide

Filter
Allows you to choos e what information appears in the folder tree. This feature is described in detail in
Folders Window Filter.
Refre sh All
Rolls up the folder tree to the top level, and then updates the entire tree to reflect any changes made
in this window or elsewhere.

Item Files Grid

The Item Files grid maintains a list of all files directly associated with an item, regardless of operation or
entity. These files will also be available to MES Operator us ers on t he Folders tab. If a file in this list is not
found on the file server, then its path is displayed in red.

Path
The path and name of the associated file.
Description
Describes the document type of this file. Document type descriptions are defined in MES
Configurator.
File Type list
The type of this file. For files to be manipulated properly, all file types, wit h their viewers and edit ors,
must be defined in MES Configurator.
Last Modified
The date and time when this file was last changed.
Size
The size of this file.
Author list
The user who creat ed this file or associated this file with the current item.
Left-clicking a column heading allows you to sort the file display by that field. Click that heading again to
reverse the sort order. Ctrl+click other headings to add secondary and tertiary sort fields.
To modify a file association, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.
Right -clicking the Item Files grid opens a context menu that contains the following options:
Add Files
Opens the Select Files to Insert window, allowing you to find the desired file on your system and
add it to the current item’s file list.
Add URL
Opens the Add URL window, requiring a valid URL address and a file type, allowing you to add a
URL to the current item’s file list.
At least one document type must be defined in MES Configurator that can accept a URL address.

Version 6.0 11
MES Supervisor User Guide Managing Folders

Update
Retrieves the latest Last Modified and File Size values for the selected file from the comput er
system.
Delete
Removes the selected file from the current item’s file list. The file itself is not deleted.
View
Allows you to view this file by invoking the viewer defined in MES Configurator for this file type. Your
user privileges will determine whet her or not you have permission to view this file.
Edit
Allows you to edit this file by invoking the editor defined in MES Configurator for this file type. Your
user privileges will determine whet her or not you have permission to edit this file.
Print
Prints the selected file on the default printer. Your user privileges will determine whether or not you
have permission to print this file.
Compare
Prompts you for a second document to compare for changes.

Note: The Compare feature is no longer supported.

Folder Version Node

Again, the term folder refers to a collection of files, material handling forms, documentation, etc. that are
relevant to an item’s production, during a specific operation, on a specific entity (production line,
machine, tool, etc.). While multiple versions of each folder may be defined, only one version can be
defined as the preferred version. The preferred folder version will be available to MES Operator users
when no folder is specifically assigned to a job. The preferred version will be indicated in the tree with an
open folder icon, while all others will have closed folder icons.
In the following figure, the preferred folder version node is selected in the folder tree.

Right -clicking folder version node opens a context menu that contains the following options:
Create Folder
Creates a new folder using the Create New Folder window. This window is described in detail in
Create New Folder and Clone Folder Windows on page 15.
Clone Folder
Creates a new folder wit h the same folder description and contents as the selected folder, requiring
you to change only item, operation, entity, or version before saving.
Set Preferred Version
The selected folder version to be the preferred version for that item/operation/entity combination,
demoting another folder version to non -preferred status if necessary.
Edit Operation De scription
Allows you to change the operation description for the cu rrent operation, above the selected folder
version. This can be us ed to further organize your folder definitions. A new operation description
creates a new operation node in the folders tree, with the selected folder as a child node. To remove
an operation/description node, select all folder versions under it, and change their operation
descriptions to another operation description. An operation/description node will be removed from
the tree when it contains no folder revision definitions.

12 Version 6.0
Managing Folders MES Supervisor User Guide

An operation cannot be added to or removed from a job/process in this window; only copies of that
operation with various descriptions may be added and deleted here, for folder organizational
purposes.
Copy Contents
Copies the selected folder files to or deletes them from the specified entity directories. This feature is
described in det ail in Copy Contents Window on page 16.
Delete
Delet es all the folders below the selected node. The selected node will be removed from the tree
because no folders exist for it.
Filter
Allows you to choos e what information appears in the folder tree. This feature is described in detail in
Folders Window Filt er on page 17.
Refre sh All
Rolls up the folder tree to the top level, and then updates the entire tree to reflect any changes made
in this window or elsewhere.

Folder Detail Pane

The folder det ail pane c ontains the basic information about a folder version and maintains the folder’s file
list.

User Defined Fields 1-2

Optional user-definable fields for this folder.
Design Hold
Not implemented at this time.
Note s
Optional, user-definable field for information about this folder that will be made available to MES
Operator users.
Path
The path and name of the associated file.
Description
Describes the document type of this file. Document type descriptions re defined in MES Configurator.
File Type list
The type of this file. For files to be manipulated properly, all file types, with their viewers and edit ors,
must be defined in MES Configurator.
Last Modified
The date and time when this file was last changed.

Version 6.0 13
MES Supervisor User Guide Managing Folders

Size
The size of this file.
Author list
The user who creat ed this file or associated this file with the current item.
Left-clicking a column heading allows you to sort the file display by that field. Click that heading again to
reverse the sort order. Ctrl+click on other headings to add secondary and tertiary sort fields.
To modify a folder version, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.
Right -clicking in the Folder Files pane opens a context menu that contains the following options:
Add Files
Opens the Select Files to Insert window, allowing you to find the desired file on your system and
add it to the selected folder’s file list.
Add URL
Opens the Add URL window, requiring a valid URL address and a file type, allowing you to add a
URL to the selected folder’s file list.
At least one document type must be defined in MES Configurator that can accept a URL address.
Update
Retrieves the latest Last Modified and File Size values for the selected file from the comput er
system.
Delete
Removes the selected file from the selected folder’s file list. The file itself is not deleted.
View
Allows you to view this file by invoking the viewer defined in MES Configurator for this file type. Your
user privileges will determine whet her or not you have permission to view this file.
Edit
Allows you to edit this file by invoking the editor defined in MES Configurator for this file type. Your
user privileges will determine whet her or not you have permission to edit this file.
Print
Prints the selected file on the default printer. Your user privileges will determine whether or not you
have permission to print this file.
Compare
Prompts you for a second document to compare for changes.

Note: The Compare feature is no longer supported.

14 Version 6.0
Managing Folders MES Supervisor User Guide

Create New Folder and Clone Folder Windows

The Create New Folder window is used to define a new folder version. Depending on where it is called
from, some of t he fields may be filled with default values. Typically, these values may be kept or changed
to suit your needs. The Clone Folder window, identical to the Create New Folder window, is used to
define a new folder version containing the same basic information and file attachm ents of another folder
version. The folder identification fields (Item, Operation, Entity, and Version) may be changed to
produce the desired res ults (and at least one of them must be changed).

The field names shown in bold type represent the minimal requirements for a folder version definition and
the combination of these fields must be unique.
Process list
The process used to produce the item.
Item list
The item for which this folder version is being defined.
Operation list
The operation for which this folder version is begin defined.
Operation Description
Describes the operation. Used to further organize your folder definitions.
Enti ty li st
The entity for which this folder version is begin defined.
Version
Identifies the folder version in all MES records, so must be unique, within the current
item/operation/entity combination, and is not editable after the folder version is first saved.
Preferred Version
When selected, indic ates this folder version should be used as the preferred version, which will be
available to MES Operator users when no folder is specifically assigned to a job.
Design Hold
Not implemented at this time.

Version 6.0 15
MES Supervisor User Guide Managing Folders

User Defined Fields 1-2

Optional, user-definable fields for this folder.
Note s
Optional, user-definable field for information about this folder that will be made available to MES
Operator users.
After providing all desired information, click OK to create the folder version or Cancel to stop.

Copy Contents Window

The Copy Contents window allows the user to copy the downloadable files of the selected folder version
to or delete them from the entity’s download directories. The download directories are defined for each
entity in MES Configurator.

Copy To pane
Lists the download directories, defined for the current entity, to which the selected folder’ s contents
may be copied. Check the boxes next to the directory names in which you want to place a copy of the
selected folder’s contents.
Uncopy From
Lists the download directories, defined for the current entity, to which the selected folder’s contents
have already been copied. Check the boxes next to the directory names from which you wish to
delete the copy of the selected folder’s contents.
Do not show results
When cleared, indicates that the results of the Copy command for each file in the selected folder
version will be shown in det ail. When selected, indicates that the results of each Copy command will
not be shown.
To copy the contents of the selected folder to one or more download directories, check the boxes next to
the desired directories and click Copy. To remove the contents of the selected folder from one or more
download directories, check the boxes next to the desired directories and click Uncopy. Click Done to
close this window.

16 Version 6.0
Managing Folders MES Supervisor User Guide

Folders Window Filter

The Folders window filt er allows you to control and limit the contents of the folder tree. Changes to this
filter will be saved for the current user, so that each user can easily access that information necessary for
his purposes. To access this feature, select the Filter option from the right-click context menu of any
node in the folder tree. The Enter Folder Filters window appears.

The folder tree can be filtered by the identifying field for each tree node, and/or by the user-defined fields
and file attachments wit hin a folder definition. Enter a value in any field which you would like to use to limit
the contents of the folder tree. Most values may be specific strings (for exact matches), or may contain
wildcards (for pattern-matches). Use the ‘%’ to match any number of characters or ‘_’ to match one
character. The entity ID may be chosen from a drop-down list of possible values. Click the Brows e (...)
button to open a file browser. Any fields, that should not be used by the filter, must be left blank.
Click Apply to apply this filter to the contents of the folder tree. The tree will be refreshed so that only the
selected folders remain.
Click Clear to clear the filter window of previous filtering values.
Click Cancel to close the Enter Folder Filters window without changing the job tree.

Version 6.0 17
 MES Supervisor User Guide

C HAPTER 3
Managing Inventory
In This Chapter
Introduction to Managing Inventory ................................................................................................ 19
Add Item Window ......................................................................................................................... 21
Trans fer Out Window .................................................................................................................... 22
Waste Window ............................................................................................................................. 23
Reduce Window ........................................................................................................................... 24
Lot Attributes Window ................................................................................................................... 25
Split Lot Window ........................................................................................................................... 26
Combine Lots Window .................................................................................................................. 27
Reclassify Window........................................................................................................................ 29
Inventory Filters Window ............................................................................................................... 30

Introduction to Managing Inventory

The Inventory window displays the current item inventory in the MES system. Items are stored in
storage entities and in specified lots, if desired. The MES invent ory system will allow you to track an
item’s remaining quantity, grade, status, and expiration date. The current work order may be associated
with produced items, to allow tracking of WIP (work in progress) items. Internal movements may be
tracked, as well as recording shipments in and out of your system.

Version 6.0 19
MES Supervisor User Guide Managing Inventory

Each inventory record reflects the storage of some quantity of a unique combination of item, lot number,
and storage entity. In that way, an item may be stored in multiple lots, in multiple locations, and in various
grades or states in each lot and/or location. Each combination of these fields will generate its own
inventory record.

The contents of the Inventory window may be customized to suit each user’s needs. The Arrange
Columns option allows you to choose which information from each inventory record should be
displayed, and in which order. The Filter option allows you to choose which inventory records should be
displayed. Both options are described more fully below. For a complete listing of the fields available for
display in the Inventory window, see Available Inventory Columns on page 87.
Left-clicking a column heading allows you to sort the inventory display by that field. Click that heading
again to reverse the sort order. Ctrl+click on other headings to add secondary and tertiary sort fields.
Left-clicking an inventory record allows you to select that record to be updated by one of the right-click
context menu options. Use Ctrl+click to select multiple records for updating.
Right -clicking in the inventory display opens a context menu that contains the following options.
Add
Adds some quantity of an item into invent ory. This option is discussed in detail in Add Item Window.
Transfer
Trans fers some quantity of the selected item to another storage entity. This option is discussed in
detail in Transfer Out Window on page 22.
Scrap
Removes some quantity of the selected item from invent ory as scrap. This option is discussed in
detail in Waste Window on page 23.
Reduce
Removes some quantity of the selected item from invent ory, for example, because it was damaged
or it was shipped as finished goods. This option is discussed in detail in Reduce Window.

20 Version 6.0
Managing Inventory MES Supervisor User Guide

Lot Attributes
Assigns attributes to the selected item and lot. This option is discussed in detail in Lot Attributes
Window on page 25.
Split Lot
Moves some quantity of the item in the selected inventory record to another lot number, storage
entity, grade, and/or status. This option is discussed in detail in Split Lot Window on page 26.
Combine Lots
Combines some quantity of the selected item from multiple inventory records into one inventory
record. This option is discussed in det ail in Combine Lots Window on page 27.
Reclassi fy
Redefines the grade, status and/or expiration date for the selected items. This option is discussed in
detail in Reclassify Window on page 29.
Filter
Allows you to choose what information appears in the Inventory window. This option is discussed in
detail in Inventory Filters Window on page 30.
Refre sh
Updates and redisplays the Inventory window to reflect any changes made in this window or
elsewhere.
Arrange Columns
Allows you to choose what information from each inventory record is displayed in the Inventory
window.
The columns available for display are described in Available Inventory Columns on page 87.
Attributes assigned to items and/or lots will be available for display in the Inventory window. The
attribute names will appear in t he Arrange Columns window for you to display in the location of your
choice, if desired.
Restore Column Settings
Restores the column settings (which fields to include and in which order) to the original system
settings.
Save Inventory Sequence
Applies the current sort order of the Inventory window to the MES Operator Inventory tab.
Set Auto Refre sh Rate
Allows you to set the Inventory window to automatically refresh itself at the specified interval.

Add Item Window

The Add Item window allows you to add some quantity of an item into the inventory records of your
system.

Version 6.0 21
MES Supervisor User Guide Managing Inventory

Enti ty Name list

The entity in which the received item will be stored.
If there is already an invent ory record for the selected entity in the Inventory window, then the
quantity entered here will be added to the current inventory total.
If there is no inventory record for the selected entity, then clicking OK after completing the properties
in this window will create a new inventory record.
Item list
The item being received.
Lot
Optional; defines the lot number/description for the received item. Often filled with serial numbers.
Grade
The grade (physical condition) of the received item.
Status
The status of the received item.
Quantity
The quantity being received, in terms of the unit of measure assigned to the selected item.
Expiry Date
When selected, indic ates the received item will have an expiration date associated with it. Click the
arrow button to select an expiration date from an on-screen calendar.
An item stored with an expiration date should also be stored with a unique lot number, to distinguish
between multiple quantities in inventory.
Click Clear All to clear all fields of default values.
Click OK to add the current item information into inventory records.
Click Cancel to close the window without changing inventory records.

Transfer Out Window

The Transfer Out window allows you to move some quantity of one or more items from their current
storage entities to another storage entity within the system. It lists information for all inventory records
selected for this transfer.

Enti ty Name
The entity at which the selected item is being stored.
Item ID
The ID of the item selected to be trans ferred.
Lot
The lot number of the selected item.

22 Version 6.0
Managing Inventory MES Supervisor User Guide

Item Grade Desc

The grade of the selected item.
Item Status De scription
The status of the selected item.
Expiry Date
The expiration date of the selected item.
Quantity Left
The current inventory quantity of the selected item.
Move Qty
The quantity of the selected item to be transferred.
Units
The unit of measure used with the selected item.
Location Status
The status of the loc ation.
To Enti ty li st
The entity to which the selected item quantities will be transferred.
Click OK to change the inventory records to reflect the selected trans fer.
Click Cancel to close the Transfer Out window without changing inventory rec ords.

Waste Window
The Waste window allows you to remove some quantity of an item from inventory, to reflect the disposal
of scrap materials/products. The quantity scrapped is recorded in the Item_Cons (item consumption)
table in the database, where it will be available for reports.

Quantity
The quantity of the selected item to be scrapped. The current quantity from the selected invent ory
record is displayed as the maximum scrap quantity.
Item
The item selected to be scrapped.

Version 6.0 23
MES Supervisor User Guide Managing Inventory

Lot No.
The lot number of the selected item.
Reason Group
The groups of waste reasons available for the selected item.
Reason
The reasons available to explain the current scrap transaction. A reason must be selected for the
scrap transaction to be completed.
Reas on groups and reas ons are defined in MES Client.
Click OK to remove the selected quantity from inventory for the selected reason.
Click Cancel to close the Waste window without changing inventory records.

Reduce Window
The Reduce window allows you to remove some quantity of one or more items from inventory, for
example, because it was damaged or it was shipped as finished goods.

Enti ty Name
The entity at which the selected item is being stored.
Item ID
The ID of the item selected to be shipped.
Lot
The lot number of the selected item.
Item Grade Desc
The grade of the selected item.
Item Status De scription
The status of the selected item.
Expiry Date
The expiration date of the selected item.
Quantity Left
The current inventory quantity of the selected item.
Ship Qty
The quantity of the selected item to be shipped.

24 Version 6.0
Managing Inventory MES Supervisor User Guide

Units
The unit of measure used with the selected item.
Click OK to change the inventory records to reflect the selected shipment of items.
Click Cancel to close the window without changing inventory records.

Lot Attributes Window

The Lot Attribute s window assigns attributes to the item in the selected inventory record (typically one
specific lot). An attribute is an additional property for an item, job, entity, etc., which can supply more
detail to other users of your system. All attributes must first be defined in MES Client. For each attribute,
a value and/or note may be assigned as well. The ability to edit t he Value and/or Notes field of a
particular attribute depends on its definition. The information defined here will be available to MES
Operator users, on the Inventory tab.

Attribute
The name of the attribute assigned to this item.
Value
The value assigned to the attribute for this item. This field will be inaccessible if the attribute wa s
defined as a Not es Only type. If the attribute’s value is of type Item Reas on, the Browse (…) button
opens a window containing the item reason tree to make reason selection easier. For more
information about attribute values of type It em Reason, see Lot Attributes of Type Item Reason on
page 26.
Note s
User-defined information about the attribute for this item. This field will be inaccessible if the attribute
was defined as a Value Only type. The Brows e (...) button opens a window for easier
viewing/ entering of longer text.
To modify an attribute assignment, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.
Right -clicking in the attribut e pane opens a context menu that contains the following options:
Add
Allows you to assign a pre-defined attribute to the selected item. Select this option to open the Add
Attribute window. Mark the check boxes next to all the available attributes that you wish to assign to
this item. Click OK to continue with the attribute assignment or Cancel to stop. All check marked
attributes will appear in the Attributes column; you must now fill in the Value and/or the Notes fields
and click Save to keep these changes or Cancel to discard them.
Delete
Removes the assignment of the selected attribute from the selected item. You will be prompted to
confirm the delete command. The attribut e itself is not deleted.

Version 6.0 25
MES Supervisor User Guide Managing Inventory

Lot Attributes of Type Item Reason

Lot attributes, of type Item Reason, can be used to implement multiple hold reasons for an item. During
production, the produced items, organized by lot number, will be assigned an item grade and state
through the use of an item reason. This grade and state information is used to determine if that lot meets
the defined minimal shipping requirements. At the same time, attributes may be added to the producti on
lot. An attribute of type Item Reason would allow the assignment of another grade and state to the same
lot. Both grade and state combinations would be considered before shipment of an item from that
production lot would be permitted. If us ed as a ‘hold’ reason, whenever the ‘hold’ situation is corrected,
the lot attribute would need to be changed or removed in this window to allow the grade and state
originally assigned to the lot to take precedence.
For example, a lot could be produced with the item reason of Good Production, which is linked to an item
grade of Approved and an item state of Finished Goods. Both of those values have a preference of 1.
The lot attribute Hold Reason could be assigned to the lot and given the value of Hold for Customer,
which is linked to an item grade of Hold - Good and an item state of Finished Goods. The Hold for
Customer state has a preference of 10. If the minimal shipping grade of this item was defined as 2, the lot
attribute would prevent this lot of the item from bei ng shipped. When the customer was ready for the
shipment, the lot attribute could be removed and the item grade of Approved would become relevant.

Split Lot Window

The Split Lot window allows you to move some quantity of an item to another lot number, storage entity,
item grade, and/or item status in the invent ory records of your MES system.

The Existing Lot Information pane includes the data for the selected inventory record.
Enti ty Name
The entity in which the selected item is being stored.
Item
The description of the selected item.
Item ID
The ID of the selected item.
Lot
The lot number of the selected item.

26 Version 6.0
Managing Inventory MES Supervisor User Guide

Grade
The grade (physical condition) of the selected item.
Status
The status of the selected item.
Quantity
The quantity and unit of measure of the selected item.
Expiry Date
The expiration date of the selected item.
The New Lot Information pane includes data for the new inventory rec ord.
Enti ty Name list
The entity in which the split quantity will be stored.
Lot
Optional; defines the lot number/description for the split quantity. Often filled with serial numbers.
Click the Browse (...) button for an on -screen keyboard.
Grade list
The grade (physical condition) of the split quantity.
Status list
The status of the split quantity.
Quantity
The quantity being split from the original quantity, in terms of the unit of measure assigned to the
selected item.
Expiry Date
When selected, indic ates the split quantity will have an expiration date associated with it. Click the
arrow button to select an expiration date from an on-screen calendar.
An item stored with an expiration date should also be stored with a unique lot number, to distinguish
between multiple quantities in inventory.
Click OK to remove the selected quantity from the current inventory record and create the new inventory
record as defined above.
Click Cancel to close the Split Lot window without changing inventory records.

Combine Lots Window

The Combine Lots window allows you to combine some quantity of the selected item from multiple
inventory records into one record. To enable this option, select one inventory record for the desired item.
The window will automatically load all inventory records for that item.

Version 6.0 27
MES Supervisor User Guide Managing Inventory

The records gird lists information from all inventory records for an item.
Enti ty Name
The entity in which the item is being stored.
Lot No.
The lot number of the item.
Grade
The grade (physical condition) of the item.
Status
The status of the item.
Expiry Date
The expiration date of the item.
Qty. Left
The current quantity of the item.
Combine Qty.
The quantity of the item from this inventory record to be combined with the other Combine Qty.
values into the new record.
Units
The unit of measure assigned to the item.
The New Lot Information pane includes the dat a for the new inventory record.
Enti ty Name list
The entity in which the combined quantity will be stored.
Lot
Optional; defines the lot number/description for the combined quantity. Often filled with serial
numbers. Click the Browse (...) button for an on-screen keyboard.
Grade list
The grade (physical condition) of the combined quantity.
Status list
The status of the combined quantity.
Expiry Date
When selected, indicates the combined quantity will have an expiration date associated with it. Click
the arrow button to select an ex piration dat e from an on-screen calendar.
An item stored with an expiration date should also be stored with a unique lot number, to distinguish
between multiple quantities in inventory.
Click OK to remove the defined quantities from the current inventory rec ords and create the new
inventory record as defined above.
Click Cancel to close the Combine Lots window wit hout changi ng inventory records.

28 Version 6.0
Managing Inventory MES Supervisor User Guide

Reclassify Window
The Recla ssify window allows you to change the grade, status, and/or expiration date of one or more
selected inventory records.

Enti ty Name
The entity in which the item is being stored.
Item ID
The item ID of the selected inventory record.
Lot
The lot number of the item.
Item Grade Desc
The current grade of the item.
Item Status De scription
The current status of the item.
Expiry Date
The current expiration date of the item.
Grade
When selected, indic ates that the grade of the selected invent ory records will be replaced with the
grade selected in the list.
Status
When selected, indic ates that the status of the selected inventory records will be replac ed with the
status selected in the list.
Expiry Date
When selected, indic ates that the expiration date of the selected inventory records will be replaced
with the expiration date selected in the list.
Click OK to make the specified changes to the selected inventory records.
Click Cancel to close the Reclassi fy window without changing the inventory records.

Version 6.0 29
MES Supervisor User Guide Managing Inventory

Inventory Filters Window

The Inventory Filters window allows you to control and limit the contents of the Inventory window. To
access this feature, select the Filter option from the right-click context menu of the Inventory window.
The Inventory Filters window appears. Changes to the inventory filter will be saved for the current user,
so that each user can easily access that information necessary for his purposes .

Enti ty tree
Entities capable of storage are indicated in this tree by boldface type. When one or more entities are
checked, inventory records for the selected entities are displayed in the Inventory window. If no
entities are checked in this tree, inventory records fo r all the storage entities will be displayed.
Filter
The field by which to filter the inventory records.
Value
The filter string for the corresponding filter field.
Enter a value in any field which you would like to use to limit the contents of the Inventory window. Most
values may be specific strings (for exact matches), or may contain wildc ards (for pattern-matches). Use
the percent (%) character to match any number of characters or the underscore (_) character to match
one character. Some values must be chosen from a list of possible values. Any fields that should not be
used by the filter must be left blank.
Click Apply to apply this filter to the contents of the Inventory window. The window will be refreshed so
that only the selected inventory rec ords remain.
Click Clear to clear the filter window of previous filtering values.
Click Cancel to close the window without changing the contents of the Inventory window.

30 Version 6.0
 MES Supervisor User Guide

C HAPTER 4
Importing and Exporting Data Using Supply
Chain Connector
In This Chapter
Introduction to Supply Chain Connector ......................................................................................... 31
Import Schedules Node ................................................................................................................. 32
Export Schedules Node................................................................................................................. 44
Queries Node ............................................................................................................................... 54
Import Mappings Node .................................................................................................................. 58

Introduction to Supply Chain Connector

Supply Chain Connector allows you to import and export dat a from MES system to third-party systems
such as ERPs. The Supply Chain Connector links your MES system to external databases and ot her
software packages. You may have an E RP system controlling inventory or creating work orders; this
information can be passed to MES through Supply Chain Connector. Information about completed work
orders and inventory changes can also be passed back to your ERP system or external database.
The Supply Chain Connector window in MES Supervisor is used to set up the communications that will
occur through Supply Chain Connector. Import schedules, export schedules, queries (used to create the
schedules ), and import mappings are all defined and maintained in this window.

Version 6.0 31
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

The window is split into two panes. The tree pane, on the left, contains a tree diagram of all schedules
and queries. The detail pane on the right displays the detailed information for the node selected in the
schedule tree, organized by tabs for easier access.

Import Schedules Node

The Import Schedule s node in the schedule tree is used to display a list of all import schedule
definitions.

Right -clicking the Import Schedules node opens a context menu that contains the following options:
Add Import Schedule
Creates a new import schedule.
Refre sh All
Updates the entire tree to reflect any changes made in this window or elsewhere.

Import Schedule Summary

When the Import Schedule s node is selected in the schedule tree, the detail pane displays a summary
of all defined import schedules.

Schedule ID
The import schedule name.

32 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

Enabled
When selected, indic ates that the import will be executed aut omatically, as determined by the
selected trigger. If this check box is not selected, the import will not be executed aut omatically, as
determined by the selected trigger.
Trigger
Displays when/how often the import will occur.
Data Type
The type of data that will be imported.
Format
The imported data’s format (delimit ed text, XML, or database table).
Transport
The source of the imported data (file or dat abase).
Post Update
The action to be taken on the sourc e file after the import has completed.
Post Action
The action to take after the import has occurred.
Last Activity
The date and time when the import last occurred.
Last Status
The completion status of the last import.
Left-clicking a column heading allows you to sort the schedule display by that field. Click that heading
again to reverse the sort order. Ctrl+click on other headings to add secondary and tertiary sort fields.
The schedule dat a in the summary pane is dis play only. To modify an import schedule, select the desired
import schedule node in the tree and change the desired values on the appropriate tabs.
An import schedule defines the circumstances for importing data from an outside data source into the
MES databas e. The import schedule node is color -coded to reflect the completion status of its last
import.

 Yellow indicates no activity, an import schedule that is ready to run or partial activity after the last
execution of the import dat a.
 Green indicates that the last data import was a success.
 Red indicates a failure.
Right -clicking an import schedule opens a context menu that contains the following options:
Delete
Delet es the selected import schedule. You will be prompted to confirm the delete.
Refre sh All
Updates the entire tree to reflect any changes made in this window or elsewhere.

Version 6.0 33
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

Summary Tab
The Summary tab displays an overview of the selected import schedule’s definition. All fields, except
Schedule ID and the Schedule Enabled check box, are read-only, reflecting values defined on the
appropriate tab or set by the system.

Schedule Enabled
When selected, indic ates that the import will be executed aut omatically. If this check box is not
selected, the import will not be executed automatically.
Schedule ID
Identifies the schedule in all MES data records. The schedule ID must be unique. You can edit this
entry only when creating a new schedule. Once the schedule is saved, the schedule ID is read-only.
Last Activity
The date and time when the import last occurred.
Last Status
The completion status of the last import.
Trigger Type
Displays when/how often the import will occur.
Data Type
The type of data that will be imported.
Format
The imported data’s format (delimit ed text, XML, or database table).
Transport
The source of the imported data (file or dat abase).
Post Updates
The action to be taken on the sourc e file after the import has completed.
Post Actions
The general action to be taken after the import has completed.

34 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

When defining a new import schedule or selecting/clearing the Schedule Enabled check box, click Save
to save your changes or Cancel to discard them. To modify other parts of an import schedule, select the
appropriate tab and change the desired values there.
Click Test to manually initiate the data import, testing the current definition.
Click Refresh to updat e the Summary tab to reflect any changes made in this window or elsewhere.

Trigger Tab
The Trigger tab defines the duration and frequency to run the import schedule.

The Trigger type list includes the event types, described below, that will initiat e the dat a import. Other
fields will appear, as needed, for each ent ry in this list.
Manual
Schedule will not run automatically.
o Test button: Initiates the data import.

Daily
Schedule will run once each day.
o Trigger Time: The starting time for the data import.

Weekdays
Schedule will run once each weekday (M, Tu, W, Th, and F).
o Trigger Time: The starting time for the data import.

Weekly
Schedule will run once each week.
o Trigger Day and Time: The day and starting time for the data import.

Every N minute s
Schedule will run repeatedly during the specified interval.
o Every How Many Minutes: The time interval bet ween data imports.
o Starting and Ending Time: Defines when the first and last data imports will occur.

File exists
Schedule will check every minute for the specified file; when the file is found, the schedule will run.
o File Path and Name: The path and name of the file triggering the data import. The Browse (...)
button opens a file browser window.

Version 6.0 35
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

Table data exists

Schedule will connect to the specified database and run the s pecified query every minut e; when data
is returned the schedule will run.
o DB Connection String: The database to connect to.
o Test button: Tests the DB Connection string, to ens ure the database is accessible.
o Query: The database query, which will generate the import data.
o Test button: Tests the query.

Completed SCC schedule

Schedule will run when anot her import or export schedule has finished running, if that schedule did
not fail.
o Import Schedules: The import schedule will run.
o Export Schedule s: The export schedule will run.
o Trigger Schedule: The import schedule after which the current import schedule will run.

Completed or failed SCC Schedule

Schedule will run when anot her import schedule has finished running, regardless of its success or
failure.
o Trigger Schedule: The import schedule after which the current import schedule will run.
To modify the trigger, select the desired field and change its value. Click Save to keep your changes or
Cancel to discard them.

36 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

Data Tab
The Data tab defines the type of data which will be imported, and how that data will update the MES
database. It also indicat es which data fields will be come from the import source and defines default
values for the others.

Import Data Type list

The type of the data that will be imported. The choices are pre-defined, based on the structure of the
MES databas e.
If you select the Import from COM object option, the If Row Exists list and the Data Table are
replaced by COM Object, Method to Call on the COM Object, and Method Context Parameter
fields.
If Rows Exi st li st
Indicates what action should be taken if the rows, being imported, already exist in the database.
o Ignore: Ignore the imported data; consider it to be a duplicate.
o Update: Update the database row to match the incoming data.
o Treat as error: Enter an error message into the log, skip that row, and continue the data import.
o Delete: Delete the row in the database.
o Delete all: Delete all rows that match with the incoming data related to the composite primary
keys from the database table.

Version 6.0 37
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

o Ignore and treat as succe ss: Ignore the import ed data and display the status as success in the
Log tab.

Data Table
If the Import Data Type is not Import from COM Object or XML Defined, displays the data fields
available for the selected data type, identifies those fields that will be included in the import data, and
allows default values to be defined for the other values. Left-clicking a column heading allows you to
sort the display by that field. Click that heading again to reverse the sort order. Ctrl+click on other
headings to add secondary and tertiary sort fields.
o Field Description: Identifies the database field into which the data will be imported. Required
field names are shown in bold type.
o Included: When selected, indicat es that data field will be found in the imported dat a.
o Default: The default value to be used if the field is not included in the imported data.

COM Object
The name of the COM object.
Method to Call on COM Object
The name of the met hod that is to be called on the COM object.
Method Context Parameter
The value of the method context parameter. It is a single variable parameter. However, you can
specify a list of values for this paramet er.
For more information about COM object method calls, see Supply Chain Connector Imports and
Exports via a COM Object on page 89.
To modify the data definitions, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.
Behavior of the Delete and Delete All Actions for Certain Import Data Types
The Delete and Delete all actions in the If Row s Exist list will be available for all import types even when
the action is not applicable. The following limitations for the listed import data types are by design.
Attribute Set
Neither Delete nor Delete all are support ed.
Enti ties
Delete all is not supported.
Languages
Delete all is not supported.
Lot Attributes
For a comma-delimited file, Delete all requires that at least the first two fields are supplied.
Operation Attribute s
For a comma-delimited file, Delete all requires that at least the first two fields are supplied.
SO
Delete all is not supported.
SO Line
Delete all is not supported.
Utilization Reasons
Delete all will delete all utilization reasons for all groups, even when a utilization reason group ID is
specified, whether the utilization reason group ID is legitimat e or not.

38 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

Import Data Types Having Only a Single Primary Key Field

For the import data types that have only a single primary key field—Customer, Item Class, Item
Reas ons, Items, Language Groups, Processes, Sites, Specs, Standard Operations, Utilization
States, Utilization Reason Group, and Work Orders (either sort)—MES Supervisor does not allow
the primary key field to be unchecked. Therefore, bot h the Delete and Delete all actions will delete
all rows in the MES database that match the primary key field of the incoming data. The fact that the
selection of the primary field for these import data types is required is intentional, as this prevents the
deletion of all records of a particular data type.
Behavior of Importing Work Orders from a Process
If Import Data Type is Work Orders (With Process) and If Row s Exist is Update, then one of the
following will occur during the import of a work order from a proc ess:
 If the work order does not exist, the work order is created.
 If the work order exists but it has jobs that are running or completed, no update is performed.
 If the work order exists and has no jobs that are running or completed, only the following work order
properties are updated: the required quantity, the release and required finish times, the description,
the priority, customer information, the manufacturing order, and not es.
For its jobs, the following updates are made:
o The job quantities are adjusted according to the quantities set for the work order.
o The required finish times for the last jobs are set to those of the work order.
o The required finish times of the rest of the jobs (other than the last jobs) are adjusted by the
amount that the required finish times of the last jobs were changed.

Transport Tab
The Transport tab identifies the sourc e (type and location) of the imported data.

The Transport type list includes the data source types, described below. Other fields will appear, as
needed, for each entry in this list.
File
The imported data will be coming from a file.
o Import From: The location of the file that cont ains the import data.
o Append Errors to: The location of the file to append the error/comments.

Database Table
The imported data will be coming from a database table. The database used is the one identified on
the Trigger tab.

Version 6.0 39
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

o DB Connection String: The database to connect to.

o Test button: Tests the DB Connection string, to ens ure the database is accessible.
o Query: Defines a valid database query, which will generate the import data.
o Test button: Tests the query.
To modify the trans port definition, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.

Format Tab
The Format tab indicates the imported data’s format and defines its row structure.

The Data Format list includes the list of format types of the data source, as described below. Other fields
will appear, as needed, for each entry in this list.
Delimited Text
Delimiter Character list
The character that will separate rows in the import data.
Import File Includes Header Row
Indicates whet her to include or ignore the first row that represents the heading in the import data file
while importing the data.
Data Table Definition
Lists all fields selected on Data tab for inclusion in import data. Left-clicking a column heading allows
you to sort the display by that field. Click that heading again to revers e the sort order.
o Field Description: Identifies the database field into which the data will be imported.
o Field Index: The order of that data value in the flat file. A flat file is a source file that you can use
for your imports. For example, a text or CSV file.
o Mapping ID: Defines what mapping import, if any, is to be used to translate the imported data.

40 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

XML Format

Field Data as XML element or attribute s list

o Standard ADO attribute based XML
o Element based XML

XML element name to contain rows

Indicates which XML element will hold the row definitions.
Data Table Definition grid
Lists all fields selected on Data tab for inclusion in import data. Left-clicking a column heading allows
you to sort the display by that field. Click that heading again to revers e the sort order.
o Field Description: Identifies the database field into which the data will be imported.
o XML attribute Name: The name used in the XML file that maps to the database field name.
o Mapping ID: Defines what mapping import, if any, is to be used to translate the imported data.
To modify the format definition, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.

Updates Tab
The Update s tab indicates the action to be taken on the source file after the data import has completed.

The After Proce ssing File list selection specifies the post-import action on the file. The options are:
None
Do nothing to the import file.

Version 6.0 41
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

Delete File
Delet e the import file.
Back File
Creates a file backup for the last imported file of this schedule by appending a date/time stamp.
To modify the update action definition, select the field and change its value. Click Save to keep your
change or Cancel to discard it.

Actions Tab
The Actions tab defines the general action to be taken after the data import has completed.

The Action after proce ssing list selection specifies the general action to be taken aft er the dat a import
has completed, as described below. Other fields will appear, as needed, for each entry in this list.
None
No action will be taken.
Send E-mail
Sends an e-mail to the recipient only if the e-mail account is configured properly for the user who is
triggering this schedule.
On Succe ss
When selected, indic ates that an e-mail should be sent when the data import is successful.
On Partial Success
When selected, indic ates that an e-mail should be sent when the data import is partially successful.
When
On Error
When selected, indic ates that an e-mail should be sent when the data import fails.
E-mail to
E-mail address or user ID to recei ve the import status e-mail.
Attachment
Path/filename to attach to the e-mail; often an error file. Click the Brows e (...) button for a file
browser.
Launch program
Execute the specified program.
On Succe ss
When selected, indic ates that the program should be executed when the data import is successful.
On Partial Success
When selected, indic ates that the program should be executed when the data import is partially
successful.

42 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

On Error
When selected, indic ates that the program should be executed when the data import fails.
Pgm. Path and Parameters
Complete path/executable, command, or batch file to run.
To modify the action definition, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.

Logs Tab
The Logs tab displays the execution history of the selected import schedule.

Acti vity At
The date and time of a data import using this import schedule.
Status
The completion status of that data import.
Triggered By
The method used to trigger that data import.
Row s Succe ssful
The number of rows imported successfully.
Row s Failed
The number of rows that could not be imported.
Comments
Displays any comments generated by the system during the data import.
Error De scription
Displays any error description generated by the system during the data import.
Left-clicking a column heading allows you to sort the history display by that field. Click that heading again
to reverse the sort order. Ct rl+click on other headings to add secondary and tertiary sort fields.
Click Refresh to updat e this tab to reflect any changes made elsewhere.
Click Clear Log to delete all log data for the selected import schedule.
Click Delete to delete the currently selected row from this import schedule’s history log.
Right -clicking on the Logs t ab opens a context menu that contains the following options:
Refre sh
Refreshes the log listing.
Clear Log
Clears the log listing.
Delete
Delet es the selected log.

Version 6.0 43
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

Export Schedules Node

The Export Schedules node in the schedule tree is used to organize all export schedule definitions.

Right -clicking the Export Schedules node opens a context menu that contains the following options:
Add Export Schedule
Creates a new export schedule.
Refre sh All
Updates the entire tree to reflect any changes made in this window or elsewhere.

Overview Grid
When the Export Schedules node is selected in the schedule tree, the detail pane displays a summary
of all defined export schedules.

Schedule ID
The export schedule name.
Enabled
When selected, indic ates that the export will be executed aut omatically, as determined by the
selected trigger. If this check box is not selected, the export will not be executed aut omatically.
Trigger Type
Displays when/how often the export will occur.
Query De scription
The name of the query that will be used to select data for the export process.
Format
The exported data’s format (delimit ed text or XML).
Transport
The target for the ex port ed dat a (file or database).
Post Update
Unavailable for export schedules.
Post Action
The action to take after the export has occurred.
Last Activity
The date and time when the ex port last occurred.
Last Status
The completion status of the last export.
Left-clicking a column heading allows you to sort the schedule display by that field. Click that heading
again to reverse the sort order. Ctrl+click on other headings to add secondary and tertiary sort fields.
The schedule data in the summary pane is read-only. To modify an export schedule, select the desired in
the tree and change the desired values on the appropriate tabs.

44 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

There is no context menu available in the summary pane for the Export Schedules node.
Creating
The Add Export Schedule option is available on the cont ext menu of the Export Schedules node.
Deleting
The Delete option is available on the cont ext menu of an export schedule node.
An export schedule defines the circumstances for exporting data from your MES database to an outside
data system. The ex port schedule node is color-coded to reflect the completion status of its last export.

 Gray indicat es that the export schedule has never been executed.
 Green indicates that the last data export was a success
 Yellow indicates that the last data export was a partial success.
 Red indicates that the last date export was a failure.

Summary Tab
The Summary tab displays an overview of the selected export schedule’s definition. All fields and
options, except Schedule ID and Schedule Enabled, are read-only, reflecting values defined on the
appropriate tab or set by the system.

Schedule Enabled
When selected, indic ates that the export will be executed aut omatically.
Schedule ID
Identifies the schedule in all MES data records. The schedule ID must be unique. You can edit this
entry only when creating a new schedule. Once the schedule is saved, the schedule ID is read-only.

Version 6.0 45
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

Last Activity
The date and time when the ex port last occurred.
Last Status
The completion status of the last export.
Trigger Type
Displays when/how often the export will occur.
Query
The name of the query that will be used to select data for the export process.
Format
The exported data’s target format (delimited text or XML).
Transport
The target for the ex port ed dat a (file or database).
Post Updates
Unavailable for export schedules.
Post Actions
The general action to be taken after the export has completed.
When defining a new export schedule or changing Schedule Enabled, click Save to save your changes
or Cancel to discard them. To modify other parts of an export schedule, select the appropriate tab and
change the desired values there.
Click Test to manually initiate the data export, testing the current definition.
Click Refresh to updat e the Summary tab to reflect any changes made in this window or elsewhere.

Trigger Tab
The Trigger tab defines when and how often the export schedule will be run.

The Trigger type list includes the event types, described below, that will initiat e the dat a export. Other
fields will appear, as needed, for each ent ry in this list.
Manual
Schedule will not run automatically.
o Test button: Initiates the data export.

Daily
Schedule will run once each day.
o Trigger Time: The starting time for the data export.

Weekdays
Schedule will run once each weekday (M, Tu, W, Th, and F).
o Trigger Time: The starting time for the data export.

46 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

Weekly
Schedule will run once each week.
o Trigger Day and Time: The day and starting time for the data export.

Every N Minute s
Schedule will run repeatedly during the specified interval.
o Every How Many Minutes: The time interval bet ween data exports.
o Starting and Ending Time: Defines when the first and last data exports will occur.

Shift End
Schedule will check every minute for a shift change on the specified entities. When a shift change
occurs, the schedule will run.
o Specify Entity Li st: The entities to check for a shift change. Click the Browse (...) button to
select the desired entities from a check list.

Job End
Schedule will check every minute for a job status change on the specified entities. When a job has
been suspended or completed, the schedule will run.
o Specify Entity Li st: The entities to check for job completion. Click the Browse (...) button to
select the desired entities from a check list.

Data Change
Schedule will connect to the MES databas e and run the query defined in the Query field every
minute. If dat a is returned, the schedule will process the data ret urned.
o Specify Query list: The query, defined under the Querie s node in the schedule tree, to be
used.
o Test Query button: Tests the query.

Completed SCC Schedule

Schedule will run when anot her export schedule has finished running, if that schedule did not fail .
o Trigger Schedule: The export schedule after which the current export schedule will run.

Completed or failed SCC Schedule

Schedule will run when anot her import or export schedule has finished running, regardless of its
success or failure.
o Import Schedules: The export schedule will run.
o Export Schedule s: The export schedule will run.
o Trigger Schedule: The export schedule after which the current export schedule will run.
To modify the trigger, select the desired field and change its value. Click Save to keep your changes or
Cancel to discard them.

Version 6.0 47
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

Query Tab
The Query tab determines the query to use to select data for the export process.

Predefined Query list

Indicates which query, defined under the Queries node in the schedule tree, will be used.
User trigger recordset a s export data
Only available when the Data Change trigger is selected on the Trigger tab. When selected,
overrides the Predefined Query field and indicates the query that is selected on the Trigger tab will
be used.
Query
The selected query definition. The query definition is read-only.
Test button
Tests the query.
To modify the query, select the desired query node in the tree and change the desired values. Click Save
to keep your changes or Cancel to discard them.

Transport Tab
The Transport tab identifies the target (type and location) of the exported data.

The Transport type list includes the data target types, described below. Other fields will appear, as
needed, for each entry in this list.
File
The exported data will be stored in a file.
48 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

If File Exists list

Action to take if the file already exists in the specified location:
o Append: Add export data to end of existing file.
– Append: Max. file size (MB): Maximum size of destination file.
– Append: If max size exceeded: Action to take if the export causes the destination file to
exceed the maximum file size.
o Overwrite: Replace existing data with export data.
o Create new file with datetime suffix: Creat e a new file, adding the current date/time to the
filename, for the export data.
o Return an error: Enter an error message int o the log and stop the data export.

File Name
Complete path/filename for the destination file. Click the Browse (...) button for a file brows er.
Call COM Object
The exported data will be sent to a user-defined object.
COM Object
Name of the COM object to call.
Method to Call on COM Object
Name of the method in the COM object.
Method Context Parameter
See Supply Chain Connector Imports and Exports via a COM Object on page 89 for det ails on the
parameters.

Version 6.0 49
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

Active Report
The exported data will build a report file.

If File Exists list

Action to take if the file already exists in the specified location.
o Overwrite: Replace existing data with export data.
o Create new file with datetime suffix: Creat e a new file, adding the current date/time to the
filename, for the export data.
o Return an error: Enter an error message int o the log and stop the data export.

File name
Complete path/filename for the destination file. Click the Browse (...) button for a file brows er.
File Type list
The format of the destination file. File types are defined in ME S Configurator.
Report Template
The desired report template, chosen from a tree of all configured system reports.
To modify the trans port definition, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.

50 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

Format Tab
The Format tab defines the destination file’s structure.
The Data Format list includes the list of format types of the destination file, as described below. Other
fields will appear, as needed, for each ent ry in this list.
XML Format

XML Type list

o Standard ADO attribute based XML
o Element bas ed XML
Delimited Text

Delimiter Character list

The character that will separate fields in the destination file.
Include Header Row
Indicates whether to ignore the first row in the import dat a file while importing the data.
Text Template
Allows you to define the format of the text file.

Version 6.0 51
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

Define Template Format

This field allows free form entry for the file structure (commonly used whe n third party systems
have a predefined file format). Any portion of the string beginning with %%, ending wit h %%, and
enclosing a valid column name, is translated as a bookmark. For each record in the out put, the
actual value of the bookmarked column will be substituted for t he %%Column_Name%% string.
To modify the format definition, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.

Updates Tab
The Updates tab is unavailable for export schedules.

Actions Tab
The Actions tab defines the general action to be taken after the data export has completed.

Action after processing list

The general action to be taken aft er the data export has completed. Other fields will appear, as needed,
for each choice in this field.
None
No action will be taken.
Send Email
Send an e-mail as defined below.
o On Succe ss: When selected, indicates an e-mail should be sent when the data export is
successful.
o On Partial Success: When selected, indicates an e-mail should be sent when the data export is
partially successful.
o On Error: When selected, indic ates an e-mail should be sent when the data export fails.
o E-mail to: E-mail address or user ID to receive the export status e-mail.
o Attachment: Path/filename to attach to the e-mail; often an error file. Click the Browse (...)
button for a file browser.

Launch program
Execute the specified program.
o On Succe ss: When selected, indicates the program should be exec uted when the dat a export is
successful.
o On Partial Success: When selected, indic ates the program should be executed when the data
export is partially successful.

52 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

o On Error: When selected, indicates the program should be executed when the data export fails.
o Pgm. Path and Parameters: Complete path/executable, command or batch file to run.
To modify the action definition, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.

Logs Tab
The Logs tab displays the execution history of the selected export schedule.

Acti vity At
The date and time of a data export using this export schedule.
Status
The completion status of that data export.
Triggered By
The method used to trigger that data export.
Row s Succe ssful
The number of rows exported successfully.
Row s Failed
The number of rows that could not be exported.
Comments
Displays any comments generated by the system during the data ex port.
Error De scription
Displays any error description generated by the system during the data export.
Left-clicking a column heading allows you to sort the history display by that field. Click that heading again
to reverse the sort order. Ct rl+click on other headings to add secondary and tertiary sort fields.
Click Refresh to updat e this tab to reflect any changes made elsewhere.
Click Clear Log to delete all log data for the selected export schedule.
Click Delete to delete the currently selected row from this export schedule’s history log.
Right -clicking on the Logs t ab opens a context menu that contains the following options:
Refre sh
Refreshes the log listing.
Clear Log
Clears the log listing.
Delete
Delet es the selected log.

Version 6.0 53
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

Queries Node
The Queries node in the schedule tree is used to display the list of all the defined database queries.

Right -clicking the Queries node opens a context menu that contains the following options:
Add Query
Creates a dat abase query.
Refre sh All
Updates the entire tree to reflect any changes made in this window or elsewhere.

Query Summary
When the Queries node is selected in the schedule tree, the detail pane displays a summary of all
defined database queries.

Query
The system identifier for the query.
Query De scription
The query descriptive name.
Query Type
The type of query (SQL, stored procedure, or middleware).
SQL
The first line of the query.
Left-clicking a column heading allows you to sort the query display by that field. Click that heading again
to reverse the sort order. Ct rl+click on other headings to add secondary and tertiary sort fields.
The query data in the summary pane is read-only. To modify a query, select the desired query node in
the tree and change the desired values.

54 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

Database queries are used for exporting data. Many pre-defined queries are included with every MES
system. These queries may be used as -is or modified to suit your needs. New queries may be easily
added to your system as well.

Right -clicking a query node opens a context menu that contains the following options:
Delete
Delet es the selected query. You will be prompt ed to confirm the delet e.
Where Used
Opens a window listing all import & export schedules in which this query is used.
Refre sh All
Updates the entire tree to reflect any changes made in this window or elsewhere.

Query Detail Pane

When a query node is selected in the schedule tree, its definition appears in the detail pane.

Query Description
Describes the purpose of the query to system users; MES automatically assigns an ID number to identify
it in the data records.
Query Type list
The type of query that will be accessing the MES database.
SQL Statement
Uses standard SQL selection syntax.
Stored Procedure
Uses a pre-defined stored proc edure.
Middleware Method
Referenc es a call to a method complied in the MES COM + application.

Version 6.0 55
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

The remaining fields will appear, as needed, depending on the chosen query type.
Query Type = SQL Statement
SQL Statement
The query using standard SQL selection syntax. The query may contain parameter names, denoted
by the @ symbol as the first character.
Parameters grid
The parameters used in the SQL query.
o Parameter: The parameter name, identified in the query by the preceding @ symbol. This
parameter substitutes the value to the inline query while exec uting the query.
o Parameter Type list: The data type of the parameter.
o Default Value: The default value to be used for a required field that is missing from the source.
Query Type = Stored Procedure

Stored Procedure
The name of the stored procedure that will be run as the query.
Parameters grid
The parameters passed, in order, to the stored procedure.
o Parameter: The stored procedure parameter name.
o Parameter type list: The data type of the paramet er.
o Size: The space to alloc ate in bytes for the parameter.
o Default value: The default value to be used for a required field that is missing from the source.

56 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

Query Type = Middleware Method

DLL list
Indicates which available MES middleware DLL will be used.
Object (Cla ss) Name list
Indicates which object, of those exposed by the selected DLL, will be used.
Parameters in XML
Lists all required and optional XML tags for the selected middleware object. Allows you to assign
values to these tags.
Running the Query
Click the Test button to run the query. The parameters will be passed with their configured default
values. The Re sult window appears, displaying the data returned by the query.

Version 6.0 57
MES Supervisor User Guide Importing and Exporting Data Using Supply Chain Connector

To modify the query, select the desired field and change its value. Click Save to keep your changes or
Cancel to discard them.

Import Mappings Node

The Import Mappings node on the schedule tree is used to organize all import mapping groups.

Right -clicking the Import Mappings node opens a context menu that contains the following options:
Add Import Mapping
Creates a new import mapping group.
Refre sh All
Updates the entire tree to reflect any changes made in this window or elsewhere.

Mapping Summary
The mapping provides a list of values that are used to map a value in the external system to the
equivalent value in the internal database. However, these mappings are not automatically mapped to an
import field. You need to explicitly configure the mapping for each field.
When the Import Mappings node is selected in the schedule tree, the detail pane displays a summary of
all defined import mappings.

Mapping ID
The mapping group name.
External Name
The external name for the mapping.
Internal Name
The internal name for the mapping.
Left-clicking a column heading allows you to sort the mapping dis play by that field. Click that heading
again to reverse the sort order. Ctrl+click on other headings to add secondary and tertiary sort fields.
The mapping dat a in the summary pane is read-only. To modify an import mapping, select the desired
import mapping group node in the tree and change the desired values.
An import mapping group organizes related import mappings, for easier access in the schedule tree.

Right -clicking an import mapping group node opens a context menu that contains the following options:
Delete
Delet es the selected import mapping group, and all its defined mappings. You will be prompted to
confirm the delete.
Refre sh All
Updates the entire tree to reflect any changes made in this window or elsewhere.

58 Version 6.0
Importing and Exporting Data Using Supply Chain Connector MES Supervisor User Guide

Import Mapping Group Detail Pane

When an import mapping group node is selected in the schedule tree, its defined mappings are dis played
and accessible in the detail pane.

Mapping ID
Identifies the import mapping group in all MES dat a records, so must be unique and is not editable
after the first mapping in that group is defined and saved.
External Name
Name used by an external system for a data value that it will send into your MES system. Identifies
the import mapping in all MES data records, so must be unique and is not editable aft er the definition
is first saved.
Internal Name
Name used by the MES system for that data value. The field names can be found in the MES
database doc ument ation.
To modify an import mapping, change the desired internal name. Click Save to keep your change or
Cancel to discard it.
Right -clicking in the import mapping definition pane opens a context menu that contains the following
options:
Add
Creates a new import mapping.
Delete
Delet es the selected import mapping. You will be prompted to confirm the delete.

Version 6.0 59
 MES Supervisor User Guide

C HAPTER 5
Managing Data Log Groups and Values
In This Chapter
Introduction to Managing Data Log Groups and Values ................................................................... 61
Data Log Groups Node ................................................................................................................. 61
Data Log Value Node.................................................................................................................... 64

Introduction to Managing Data Log Groups and Values

The Data Logger window defines and organizes the data log values that will be measured during
production.
The window is split into two panes. The tree pane, on the left, contains a tree diagram of all dat a log
groups and data log values. The data log detail pane, on the right, displays the detailed information for
the node selected in the data log tree.

Data Log Groups Node

The Data Log Groups node on the data log tree is used to organize all data log group definitions.

Right -clicking the Data Log Groups node opens a context menu that contains the following option:
Add Group
Creates a new data log group.
Refre sh Al
Updates the entire tree to reflect any changes made in this window or elsewhere.

Version 6.0 61
MES Supervisor User Guide Managing Data Log Groups and Values

Data Log Summary

When the Data Log Groups node is selected the data log tree, the detail pane displays a summary of all
defined data log groups.

Group De scription
Describes the grouping of data log values.
Max Value
The maximum number of data log values to be collected in this data log group. Determines whether
the data is stored in the Dat a_Log_16 or the Data_Log_48 table.
Trigger Type
The event which will initiate data collection for this group.
Trigger Detail
Not implemented at this time.
Obsolete
When selected, indic ates the data log group is obsolete. This means it may not be used to collect
data or its definition modified.
Data_Log_Grp spare 1-4
Optional, user-definable fields for this data log group.
The data log group information in the summary pane is read-only. To modify a data log group, select the
appropriate group node in the tree and change the desired values.
A data log group organizes related data log values that will be collected and stored t oget her in the same
data log table.

Right -clicking a data log group node opens a context menu that contains the following options:
Add Value
Creates a new data log value for the selected group.
Delete
Delet es the selected dat a log group. You will be prompted to confirm the delete.
Refre sh All
Rolls up the data log tree to the group level, and then updates the entire tree to reflect any changes
made in this window or elsewhere.

62 Version 6.0
Managing Data Log Groups and Values MES Supervisor User Guide

Data Log Group Detail Pane

When a data log group node is selected in the data log tree, its definition appears in the detail pane.

Group De scription
Describes the grouping of data log values. Does not need to be unique.
Obsolete
When selected, indic ates the data log group is obsolete. This means it may not be used to collect
data or its definition modified.
Max Value list
The maximum number of data log values to be collected in this data log group (16 or 48). This is a
space-saving measure which determines whic h size data log table is used (Data_Log_16 or
Data_Log_48).
Trigger Type list
The event which will initiate data collection.
o Manual: An MES Operator user must initiate the data collection.
o Job Change: Not implemented at this time.
o Shift Change: Not implemented at this time.
o Step Change: Not implemented at this time.
o Lot Change: Not implemented at this time.

Trigger Detail
Not implemented at this time.
Data_Log_Grp spare 1-4
Optional, user-definable fields for this data log group.

Version 6.0 63
MES Supervisor User Guide Managing Data Log Groups and Values

Enti ties grid

Lists the entities with which this data log group may be used to collect data. Right -clicking on the
entities grid opens a context menu that contains the following option:
o Add/Delete Data Log Entities: Allows you to add entities to or delete them from this list. Opens
the Add/Delete Data Log Entities window, containing a list of all entities capable of being used
for data c ollection (based on each entity’s definition in MES Client). Mark the check boxes next to
the entities that you wish to use wit h this data log group; clear the check boxes next to the
entities to be removed from this data log group’s entity list. Click OK to save the entity list
changes or Cancel to discard them.

Value detail grid

Displays a summary of all data log values defined for this group.
o Value Index: Identifies the data log value in all MES data records; automatically assigned to the
data log value definition.
o Value Name: Describes the data log value.
o Value Type: The type of data measured by this data log value.
o Editable: When selected, indic ates the data log value may be modified by an MES Operator
user.
o Current Value: The last measured value for this data log value or defines the upper or lower
limit value.
o Specification: The global specification to which this data log value is linked.
o Meaning: The purpose of this data log value, in relation to ot her data log values.
o Meaning to Value Index: The data log value, belonging to the same dat a log group, to which
this value will be applied as a limit.
o Data_Log_Value spare 1-4: Optional, user-definable fields for this data log value.
To modify a data log group definition, select the desired field and change its value. Click Save to keep
your changes or Cancel to discard them.

Data Log Value Node

A data log value is used for general data collection.

Right -clicking a data log value node opens a context menu that contains the following options:
Delete
Delet es the selected dat a log value. You will be prompted to confirm the delete.
Refre sh All
Rolls up the data log tree to the group level, and then updates the entire tree to reflect any changes
made in this window or elsewhere.

64 Version 6.0
Managing Data Log Groups and Values MES Supervisor User Guide

Data Log Value Detail Pane

When a value node is selected in the data log tree, its definition appears in the detail pane.

Value Name
Describes the data log value. Does not need to be unique.
Editable
When selected, allows the data log value to be modified by an MES Operator user.
Value Type list
The type of data measured by this data log value.
o String
o Number
o Logical
o Datetime

Current Value
The last measured value for this data log value or defines the upper or lower limit value.
Specification list
The global specification to which this data log value is linked. Global specification groups may be
defined using the Create Global Specification Group option on the context menu of a Spec. Ver.
node in the Proce ss window or a Specs node in the Jobs window.
Data_Log_Value spare1-4
Optional, user-definable fields for this data log value.
Meaning list
The purpose of this data log value, in relation to other data log values.
o None: This value is independent of other values; it represents data to be collected.
o Upper Reasonable Limit: This value will be used as the Upper Reasonable Limit for the value
indicated in the Meaning To Value Index field. If the measured value exceeds this limit, a
warning is generated by Dat a Logger.
o Lower Reasonable Limit: This value will be used as the Lower Reasonable Limit for the value
indicated in the Meaning To Value Index field. If the measured value exceeds this limit, a
warning is generated by Dat a Logger.

Version 6.0 65
MES Supervisor User Guide Managing Data Log Groups and Values

Meaning To Value Index list

The data log value, belonging to the same data log group, to which this value will be applied as a
limit.
To modify a value definition, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.

66 Version 6.0
 MES Supervisor User Guide

C HAPTER 6
Managing Shift Exceptions
In This Chapter
Introduction to Managing Shift Exceptions ...................................................................................... 67
Entity List ..................................................................................................................................... 68
System Schedule Pane ................................................................................................................. 68
Calendar ...................................................................................................................................... 68
Entity Schedule Pane.................................................................................................................... 69
Shift Exceptions Pane ................................................................................................................... 69

Introduction to Managing Shift Exceptions

The Shift Exceptions window displays all shift and break schedules defined in MES Client. It also allows
you to define exceptions to these schedules, to accommodate overtime, holidays, etc. This information
will ensure that production, utilization, labor, etc. are credited to the proper shifts for reports and OEE
calculations.
The window includes the following panes: an entity list (top left), a system schedule pane (top right), a
calendar (bottom left), an entity schedule pane (bottom center), and a shift exceptions pane (bottom
right).

Version 6.0 67
MES Supervisor User Guide Managing Shift Exceptions

Entity List
The entity list contains all entities which were defined in MES Client with the capability This entity has its
own shift schedule. All other entities will inherit a schedule from one of these entities. Each entity’s shift
schedule is pictured in the corresponding row of the system schedule.
Select an entity from this list to display its shifts’ start and end times, for the selected day, in the entity
schedule pane or to define exceptions for its schedule in the shift exceptions pane.

System Schedule Pane

The system schedule pane displays the shifts defined for each entity in the entity list, for the selected
date. Each entity’s schedule occupies the row in the system schedule opposite to its name in the list. A
green bar indic ates a defined shift period; one or more yellow bars inside the green bar indicate defined
breaks during that shift. The shift number is displayed at the beginning of each green bar. Gray
background, or the absence of a green bar, indicat es that no shift is defined for that entity, on that date,
over that time period.
Exceptions to the typical shift schedule are also displayed in this pane. Blue bars indicate additional
working time. Bracketed red lines indicate normally scheduled shifts which will not be work ed. These are
described in more detail below.
Select a dat e in the calendar to display the shifts scheduled for that date. Use the arrows above this pane
to scroll the schedule display forward or backward in time. Select a row in the system schedule to dis play
that entity’s schedule times in the entity schedule pane. Position your cursor over a shift block to display
its starting and ending times in the top right corner of this pane.

Calendar
The calendar displays the date for which the shift schedules are displayed in the system schedule pane.
Use the arrows above the calendar to scroll through the mont hs and/or years.
Click on the month name to select from a list of month names.
Click on the year to enable up/ down arrows to change the year.
Click on a day to display all defined shift schedules for that date in the system schedule pane.

68 Version 6.0
Managing Shift Exceptions MES Supervisor User Guide

Entity Schedule Pane

The entity schedule pane displays the shift numbers, start times, and end times for the normal shift
schedule for the selected entity on the selected date.

Shift Exceptions Pane

There are two types of exceptions that may be defined for a shift schedule: additive (overtime; more time
beyond what is normally defined) and subtractive (holiday or plant shutdown; less time than what is
normally defined).
Enti ty Name
The name of the entity for which this exception is defined.
Start
The starting time of the exception period. Click the Browse (...) button to open the Select Date &
Time window, to simplify the time entry.
End
The ending time of the exception period. Click the Browse (...) button to open the Select Date &
Time window, to simplify the time entry.
Additive
When selected, indic ates this exception defines additional working time (e.g., overtime), for this
entity on the selected date. The exception period will be displayed as a blue bar in this pane and the
system schedule pane. An additive exception adds time to the available schedule for this entity on
the selected dat e.
When cleared, indicates this exception defines time that is typically worked but will not be (e.g., a
holiday), for this entity on the selected dat e. The exception period will be displayed as a red bar in
this pane, and as a red line at the top of the shift block, with beginning and ending pointers, in the
system schedule pane. A subtractive exception removes time from the available schedule for this
entity on the selected date.
Add Exception
Creates a new shift exception definition. Also available as a context menu option.
Delete Exception
Delet es the selected exception definition. You will not be prompt ed to confirm the delet e. Also
available as a context menu option.
To modify an exception, select the desired field and change its value. Click elsewhere in this pane to
save your change.
All other shift information is read-only here. If a permanent change needs to be made to an entity’s shift
schedule, that change must be made in MES Client.

Version 6.0 69
 MES Supervisor User Guide

C HAPTER 7
Managing Storage Entities
The Storage Entity Status window displays detailed information about all entities that were defined in
MES Client with the capability Material can be stored at this entity. It also allows you to update the
storage status and/or current location of some entities.

Enti ty
The name of the storage entity.
Maximum Capacity
The maximum number of units that can be stored at this entity at one time.
Status list
The current storage status of this entity.
o Used: This entity is currently being used for storage, of some quantity greater than 0 of some
item. This value cannot be changed here.
o Available: This entity is available for storage; it is completely empty. If this entity’s definition in
MES Client allows for Dirty status, the status may be changed from A vailable to Dirty here, if
desired.
o Dirty: This entity is unavailable for storage; it is empty, but dirty. This entity’s status was
automatically changed to Dirty when the last item was removed from it. It may not be used again
for storage until its status is changed to A vailable, either here or in the Storage tab of MES
Operator.

Location list
The current location of a movable storage entity. This value may be changed here, if desired.
Left-clicking a column heading allows you to sort the entity display by that field. Click that heading again
to reverse the sort order. Ct rl+click on other headings to add secondary and tertiary sort fields.
To modify a storage entity’s status or location, use the list in that field to select the desired value. Click
elsewhere in this window, or close the window to save your changes.
Right -clicking in the Storage Entity Status window opens a context menu, containing the following
options:
Refre sh
Updates the window to reflect any changes made in this window or elsewhere.

Version 6.0 71
MES Supervisor User Guide Managing Storage Entities

Cancel
Canc els any unsaved changes made to the selected entity.

72 Version 6.0
 MES Supervisor User Guide

C HAPTER 8
Managing Customers
In This Chapter
Introduction to Managing Customers .............................................................................................. 73
Customer Node ............................................................................................................................ 74
Sales Order Node ......................................................................................................................... 76
Line Item Node ............................................................................................................................. 78
Shipment Node............................................................................................................................. 80
Customer Filter Window ................................................................................................................ 82

Introduction to Managing Customers

The Customers window is used to organize customer information, and to record order and shipment
information. The window is split into two panes. The tree pane, on the left, contains a tree diagram of all
defined customers, sales orders, items, and shipment rec ords. The customer detail pane, on the right,
displays the detailed information for the node selected in the customer tree.

Version 6.0 73
MES Supervisor User Guide Managing Customers

Customer Node
A customer may be an individual or a business wishing to purchas e your company’s products. Each
customer may have his name, phone number, and address stored in his record, as well as that data for
individual contact persons for a business customer. Each customer’s sales orders will be organized
below his node in the tree, so that the shipment status of each sales order can be easily accessed.

Right -clicking a customer node opens a context menu that contains the following options:
Insert Customer
Creates a new customer record.
Delete
Delet es the selected customer record. You will not be prompted to confirm the delete.
Insert Sales Order
Creates a new sales order for the selected customer.
Filter
Allows you to choose what information appears in the customer tree. This feature is described in
detail in Customer Detail Pane on page 75.
Refre sh
Rolls up the customer tree to the top level, and then updates the entire tree to reflect any changes
made in this window or elsewhere.
Expand All
Displays all nodes below the selected node (all of its children, grandc hildren, etc.)
Rollup
Hides all nodes below the selected node.

74 Version 6.0
Managing Customers MES Supervisor User Guide

Customer Detail Pane

The customer detail pane contains the basic information about a customer. The field names shown in
bold represent the minimal requirements for a customer record.

Customer ID
Identifies the customer in all MES data records, so must be unique and is not editable after the
customer rec ord is first saved.
Customer Name
Descriptive name for this customer.
Addre ss 1
First line of this customer’s mailing address.
Addre ss 2
Second line of this customer’s mailing address.
City/State/Zip/ Country
Final line of this customer’s mailing address.
Phone
Telephone number for this customer.
Fax
Fax number for this customer.
Email
E-mail address for this customer.
Cust spare 1-4
Optional, user-definable fields for this customer.

Version 6.0 75
MES Supervisor User Guide Managing Customers

Contact Information pane

Multiple contact individuals may be defined for this business customer.
o Contact Name: Name of the contact individual for this customer.
o Department: Department of this contact.
o Phone: Phone number of this contact.
o Fax: Fax number of this contact.
o Email: E-mail address of this contact.
o Cust_Contact spare 1-4: Optional, user-definable fields for this contact.
To modify a customer record, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.
Right -clicking in the customer detail pane opens a context menu that can contain the following options:
Insert
Adds a new contact to this customer’s contact list.
Delete
Delet es the selected contact. You will not be prompted to confirm the delete.

Sales Order Node

A sales order records a purchase request from a customer. Sales orders will be organized in the
customer tree under the customer placing the order, and will, in turn, organize the shipment records
related to each order.

Right -clicking a sales order node opens a context menu that contains the following options:
Insert Customer
Creates a new customer record.
Delete
Delet es the selected sales order. You will not be prompted to confirm the delete.
Insert Line Item
Creates a new order line in the sales order, for ordering an item.
Filter
Allows you to choose what information appears in the customer tree. This feature is described in
detail in Customer Detail Pane on page 75.
Refre sh
Rolls up the customer tree to the top level, and then updates the entire t ree to reflect any changes
made in this window or elsewhere.
Expand All
Displays all nodes below the selected node (all of its children, grandc hildren, etc.)

76 Version 6.0
Managing Customers MES Supervisor User Guide

Rollup
Hides all nodes below the selected node.

Sales Order Detail Pane

The sales order det ail pane c ontains the basic information about a sales order. The field names shown in
bold represent the minimal requirements for a sales order definition.

Sales Order ID
Identifies the sales order in all MES data records, so must be unique, for the current customer, and is
not editable after the sales order definition is first saved.
Purcha ser list
Indicates which customer contact placed this sales order.
Date Received
Defines when the sales order was received from the customer. Click the Browse (...) button to open
the Select Date & Time window to simplify the date/time entry.
Note s
Optional, user-definable field for information about this sales order.
SO spare 1-4
Optional, user-definable fields for this sales order.
Line Items grid
Summarizes the order information for each item in this sales order.
o No: Identifies the line number within the sales order, so must be unique within the sales order,
and is not editable after the line item definition is first saved.
o Item: The item to be shipped to satisfy this line of the sales order. Click the Browse (...) button to
open the item tree window to simplify item selection.
o Quantity: The quantity of this item to be shipped.
o Price: The price of one of this item.

Version 6.0 77
MES Supervisor User Guide Managing Customers

o Required By: Defines when this item is needed for shipment with this sales order. Click the
Browse (...) button to open the Select Date & Time window to simplify the date/time entry.
o SO_Line spare 1-4: Optional, user-definable fields for this order line.

To modify a sales order definition, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.
Right -clicking on the Line Items grid opens a context menu that contains the following options:
Insert
Creates a new order line in this sales order, for ordering an item.
Delete
Delet es the selected order line. You will not be prompted to confirm the delete.

Line Item Node

A line item specifies the item and quantity information for one line of a sales order. Line items will be
organized under the appropriate sales order, and will, in turn, organiz e the shipment records related to
this line item.

Right -clicking a line item node opens a context menu that contains the following options:
Insert Customer
Creates a new customer record.
Delete
Delet es the selected order line from the sales order. You will not be prompted to confirm the delete.
Insert Shipment
Adds a new shipment record to the selected line item.
Filter
Allows you to choose what information appears in the customer tree. This feature is described in
detail in Customer Detail Pane on page 75.
Refre sh
Rolls up the customer tree to the top level, and then updates the entire tree to reflect any changes
made in this window or elsewhere.
Expand All
Displays all nodes below the selected node (all of its children, grandc hildren, etc.).
Rollup
Hides all nodes below the selected node.

78 Version 6.0
Managing Customers MES Supervisor User Guide

Line Item Detail Pane

The line item detail pane contains the order information from one line of a sales order. The field names
shown in bold repres ent the minimal requirements for a line item definition.

Line Number
Identifies the line number within the sales order, so must be unique within the sales order, and is not
editable after the line item definition is first saved.
Item list
The item to be shipped to satisfy this line of this sales order. Click the Browse (...) button to open the
item tree window to simplify item selection.
Quantity
The quantity of this item to be shipped.
Price
The price of one of this item.
Required By
Defines when this item is needed for shipment with this sales order. Click the Browse (...) button to
open the Select Date & Time window to simplify the date/time entry.
SO_Line spare 1-4
Optional, user-definable fields for this order line.
Shipments pane
Summarizes the shipment records for this order line.
o Ship Date: Defines when a shipment was made for this line item for this sales order. Is not
editable after the shipment record is first saved.
o Ship Via: The method of shipment used for this shipment of this line item.
o Shipment spare 1-4: Optional, user-definable fields for this shipment record.
To modify a line item definition, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.
Right -clicking on the Shipments pane opens a context menu that contains the following options:

Version 6.0 79
MES Supervisor User Guide Managing Customers

Insert
Adds a new shipment record to this line item. You must still select that shipment node to enter the lot
number and quantity information.
Delete
Delet es the selected shipment record.
Deleting a shipment lot record will not automatically re-enter the quantity of that item into inventory.
This must be done manually.

Shipment Node
A shipment record represents the shipment of some quantity of a line item from a sales order. A single
line item may have more than one shipment record associated with it.

Right -clicking a shipment node opens a context menu that contains the following options:
Insert Customer
Creates a new customer record.
Delete
Delet es the selected shipment record.
Deleting a shipment record will not automatically re-enter the quantity of that item into inventory. This
must be done manually.
Filter
Allows you to choose what information appears in the customer tree. This feature is described in
detail in Customer Filter Window.
Refre sh
Rolls up the customer tree to the top level, and then updates the entire tree to reflect any changes
made in this window or elsewhere.

80 Version 6.0
Managing Customers MES Supervisor User Guide

Shipment Detail Pane

The shipment detail pane contains the shipment information for some quantity of a line item in a sales
order. The field names shown in bold are the minimal requirements for a shipment record.

Item
The item that will be shipped.
Ship Date
Defines when this quantity of the line item was shipped for this sales order; is not editable after the
shipment record is first saved.
Ship Via
The method of shipment used for this line item.
Total to Ship
The total quantity ordered of this line item.
Total Shipped
The quantity of this line item already shipped, totaled from all shipment records associated with this
order line of this sales order.
Remaining to Ship
The quantity of this line item which still needs to be shipped.
Shipment spare 1-4
Optional, user-definable fields for this shipment.
Shipment Lots pane
Records the specific item lot number and quantity information for this shipment.
o Lot Number list: The lot number in invent ory from which this quantity of the line item was
withdrawn; is not editable after the shipment lot record is first saved.

Version 6.0 81
MES Supervisor User Guide Managing Customers

o Quantity Shipped: The quantity of the line item, from this lot number, which is included in this
shipment. Click the Browse (...) button to open a window showing all entities at which this lot
number of this item is stored, and the quantities available at each stora ge entity. Set the To Ship
values as desired and click OK to set the Quantity Shipped value or Cancel to select another
lot number.
If insufficient quantities of this item exist in inventory, you must create the work order manually.
Each item is defined wit h a minimum shippable grade and minimum shippable state. The possible
grades and states are defined and rank ed in MES Client. If an item lot does not meet the minimum
shipping requirements, you will not be allowed to ship it, unless your user group was gi ven the privileges
May override the minimum shippable grade and/or May override the minimum shippable state. In
addition, lot attributes, which have an item reason for a value, may override t he apparent grade and state
of an item. These secondary grade and state assignments may prevent the shipment of an item until the
attribute is removed or its value is changed in the Inventory window (Lot Attributes option).
To modify a shipment record, select the desired field and change its value. Click Save to keep your
changes or Cancel to discard them.
Right -clicking in the Shipments pane opens a context menu that contains the following options:
Insert
Adds a new shipment lot record to this shipment record. Withdraws the selected quantity from
inventory and updat es the Total Shipped field in all shipment records for this line item.
Delete
Delet es the selected shipment lot record.
Deleting a shipment lot record or editing the Quantity Shipped field of a shipment lot record will not
automatically re-enter the quantity of that item into invent ory. This must be done manually.

Customer Filter Window

The Customer Filter window allows you to control and limit the contents of the customer tree, below the
customer node level. To access this feature, select the Filter option from the right-click context menu of
any node in the customer tree. The Customer Filter window will appear. Changes to the customer filter
will be saved for the current user, so that each user c an easily access that information necessary for his
purposes.

Complete sales orders

When selected, includes in the customer tree thos e sales orders, their line items, and shipment
records for which the complete quantity of all line items has been shipped.
Partial sales orders
When selected, includes in the customer tree thos e sales orders, their line items, and shipment
records for which some quantity of a line item has been shipped, while other quantities of the same or
other items remain to be shipped.
Open sales orders
When selected, includes in the customer tree thos e sales orders, their line items, and shipment
records for which no quantity of any line item has been shipped.

82 Version 6.0
Managing Customers MES Supervisor User Guide

When one or more check boxes are checked, sales orders qualifying under any of the checked
guidelines are displayed in the customer tree. If no check boxes are checked, all sales order records will
be displayed, just as if all three boxes were checked.
Click Apply to apply this filter to the contents of the customer tree. The tree will be refreshed so that only
the selected sales records and their children nodes remain.
Click Clear to clear the filter window of previous filtering values.
Click Cancel to close the filter window without changing the contents of the customer tree.

Version 6.0 83
 MES Supervisor User Guide

C HAPTER 9
MES Supervisor Menu Selections
In This Chapter
File Menu ..................................................................................................................................... 85
Edit Menu..................................................................................................................................... 85
View Menu ................................................................................................................................... 85
Tools Menu .................................................................................................................................. 85
Window Menu .............................................................................................................................. 85
Help Menu ................................................................................................................................... 86

File Menu
The File menu contains the following options:
Close
Closes the active window within MES Supervisor.
Set Transport
Opens the Select Transport to Middleware window, to allow you to change the middleware access
method for your computer.
Exit
Closes MES Supervisor. Depending on your system configuration, a user with one or more
processes checked out might be prompted to check those processes back in before the module
closes.

Edit Menu
The Edit menu contains the options available when right-clicking in the active MES Supervisor window.

View Menu
The View menu contains an option for each main MES Supervisor window, and displays the shortcut
keystroke combination for each.

Tools Menu
The Tool s menu contains the following option:
Change Password
Allows the current user to change his password, effective at the next login to any MES application.

Window Menu
The Window menu contains the following options:
Tile Horizontally
Arranges the open windows so that each is displayed in a horizontal portion of the screen.
Tile Vertically
Arranges the open windows so that each is displayed in a vertical portion of the screen.

Version 6.0 85
MES Supervisor User Guide MES Supervisor Menu Selections

Cascade
Arranges the open windows cascade-fashion, one on top of another, so that the top left corner of
each window below the topmost window is visible.
The Window menu also allows the user to make any open MES Supervisor window the active window.

Help Menu
The Help menu contains the following options:
Help Topics
Opens the MES online help, providing doc umentation for MES Supervisor and several of the ot her
MES applications.
About
Opens the About MES Supervi sor window, providing license and version information which may be
necessary for technical support inquiries.

86 Version 6.0
 MES Supervisor User Guide

A PPENDIX A
Available Inventory Columns
Items may be stored in multiple lots, in multiple locations, and in various grades and states for each.
Depending on your system configuration, storage entities may store multiple items and/or multiple lots of
one it em. Each inventory record reflects the storage of some quantity of a unique combination of item, lot
number, storage entity, item grade, and item state.
A brief description of the columns available for display in the Inventory window follows:
Date In
The most recent date/time that a quantity of this item/lot/grade/state was received by this entity.
Date Out
The most recent date/time that the last quantity of this item/lot/grade/state was removed from
storage in this entity.
Enti ty
The description of the entity in which this inventory quantity is stored.
Enti ty ID
The databas e ID of the entity in which this inventory quantity is stored.
Enti ty Name
The name of the entity in which this inventory quantity is stored.
Expiry Date
The expiration date for this inventory quantity.
Item Class De scr
The description of the item class for this inventory quantity. Defined on the General tab of an item
node in the Item s window.
Item Class ID
The item class ID for this inventory quantity. Defined on t he General tab of an item node in the Items
window.
Item Description
The description of the item for this inventory quantity. Defined on the General tab of an item node in
the Items window.
Item Grade
The databas e ID of the item grade assigned to this invent ory quantity.
Item Grade Desc
The description of the item grade assigned to this inventory quantity.
Item ID
The ID of the item for this inventory quantity. Defined on t he General tab of an it em node in the Items
window.
Item Status
The databas e ID of the item status assigned to this inventory quantity.
Item Status De scription
The description of the item status assigned to this invent ory quantity.
Item_Inv Spare 1-6
The optional, user-defined fields for this inventory quantity.

Version 6.0 87
MES Supervisor User Guide Available Inventory Columns

Location Status
The storage status of the entity used for this inventory quantity. Set automatically by MES or by users
in the Physical Entities module in MES Client, the Storage Entity Status window of MES
Supervisor, or the Storage tab of MES Operator.
o Used: The entity is currently being us ed for storage, of some quantity great er than 0 of an item.
o Available: The entity is available for storage; it is completely empty. Each entity’s definition in
MES Client determines whether or not inventory records for 0 quantities are displayed in the
Inventory window.
o Dirty: If an entity’s definition in MES Client allows for Dirty status, the entity’s status is
automatically changed to Dirty when the last item is removed from it. A Dirty entity is empty bu t
may not be used for storage; a user must change the status to Available on the Storage Entity
Status window or on the Storage tab of MES Operator.

Lot
The lot number (a user-defined string) assigned to this inventory quantity.
Operation ID
The ID of the operation during which this inventory quantity was produced. Supplied by MES
Operator.
Quantity Left
The quantity of this item/lot/grade/state combination currently stored at this entity.
Quantity Left ERP
The inventory quantity of this item/lot/grade/state combination that has been reported to ERP.
Sequence No
The position number of the job in which this inventory quantity was produced (value may be great er
than 0 when multiple jobs are defined within a single operation).
Units
The unit of measured used by the product of this job. Defined on the General tab of an item node in
the Items window.
Work Order ID
The ID of the work order for which this inventory quantity was produced. Supplied by MES Operato r.
Attributes that have been associated with items and/or lots and defined in MES Client as available to the
Inventory window will also appear as available column headings. When selected, the columns will
appear for every inventory record, but values will appear only as defined elsewhere.

88 Version 6.0
 MES Supervisor User Guide

A PPENDIX B
Supply Chain Connector Imports and
Exports via a COM Object
In This Appendix
Introduction to SCC Imports and Exports via a COM Object............................................................. 89
Invoking a Method of a COM-Visible Object from an SCC Schedule ................................................. 89
C# COM-Visible Example .............................................................................................................. 90

Introduction to SCC Imports and Exports via a COM Object

For specialized data trans fers in Supply Chain Connector (S CC) that require more complex functionality
than a straight importing of table records, or the ex porting of a query res ult to a file, you can write a
method that is invoked via COM for greater flexibility.

Invoking a Method of a COM-Visible Object from an SCC

Schedule
Triggering an import schedule with the Import Dat a Type Import from COM object or an export
schedule with the Transport Type Call COM object causes MES Service (or MES Supervisor, in the
case when the Te st button is clicked on the Summary tab) to:
 Create an instance of the object specified in the COM Object field using late binding.
 Call the met hod specified in the Method to Call on COM Object field.
The contents of the COM Object field must be a fully qualified name with the format
Namespace. Class.Version.
For an import, the method needs to conform to the following signature:
 For Visual Basic: Public Method xxxxxx (ByVal session_id as long, ByVal sched_id as string,
Optional ByVal context as string) as long
 For C#: public long xxxxxx (long session_id, string sched_id, string context)
For an export, the method needs to conform to the following signature:
 For Visual Basic: Public Method xxxxxx (ByVal session_id as long, ByVal sched_id as string, ByVal
rs as ADODB.recordset, Optional ByVal context as string) as long
 For C#: public long xxxxxx (long session_id, string sched_id, ADODB.Records et rs, string context)
The method utilizes the parameters passed to it to know what it is to do in each particular case:
 The session_id parameter is the session ID of the MES Service (or MES Supervisor) that triggered
the import, and is used as a parameter in most stateless API methods.

Version 6.0 89
MES Supervisor User Guide Supply Chain Connector Imports and Exports via a COM Object

 The sched_id parameter identifies the SCC schedule that triggered the import, and allows the COM
object to extract additional configuration information from the dx_sched table (and other) if required,
or to use the sched_id if creating additional entries in the SCC log table (dx_log), wh ere it is a
required field.
 In the case of a method called from an export schedule, the rs parameter is the recordset ret urned by
the query associated wit h the export schedule.
 The optional context parameter allows passing of context information to the COM object. For
example, context information can be passed to allow multiple schedules to call the same COM object
yet have it respond differently by passing different context values it can use to conditionalize different
behaviors. It is always a string even though it is passed as a variant in Visual B asic. It is only included
in the method call if it is not null and not an empty string.
The method should return a (long) 0 if the import was handled successfully or a (long) -1 if an error
occurred. While S CC will create entries in its log if it is unable to invoke the met hod or the met hod c aused
an unhandled exception, it otherwise does not know if the intended processing succeeded. Therefore, it
is up to the method to make entries in the log (the dx_log table) if its internal processing was not
successful, to provide users a record of what failed and, to the extent possible, why. Note that there are
currently no stateless API methods to access the dx_* tables, so this must be done via a direct
connection to the MES middleware.
It is up to the method called by an input schedule to actually insert records into the MES database,
preferably by using the stateless API. A method called by an export schedule can either us e the A DODB
recordset passed to it, or it could do its own query. However, if all the required information to be exported
is in the records et, a separate query is not required.

C# COM-Visible Example
The following C# code is an example of a COM object that contains an import method and an export
method:
using System;
using System.Data;
using System.Data.OleDb;
using System.Runtime.InteropServices;

namespace SCCCOMObjNamespace
{
[GuidAttribute("B25215A6-CDB0-47A6-A3FD-DBDE69749198")]
public interface ISCCCOMObjClass
{
long ImportMethod(long session_id, string sched_id, string context);
long ExportMethod(long session_id, string sched_id, ADODB.Recordset rs,
string context);
void Close();
}

[ComDefaultInterface(typeof(ISCCCOMObjClass))]
[ClassInterface(ClassInterfaceType.None)]
[ComVisible(true)]
[GuidAttribute("22C7350C-15CF-43E0-97C2-DE1A3150D4EE")]
[ProgId("SCCCOMObjNamespace.SCCCOMObjClass.1")]
public class SCCCOMObjClass : ISCCCOMObjClass, IDisposable
{
public long ImportMethod(long session_id, string sched_id, string
context)
{
// Add processing code here

90 Version 6.0
Supply Chain Connector Imports and Exports via a COM Object MES Supervisor User Guide

return 0;
}

public long ExportMethod(long sessionId, string sched_id, ADODB.Recordset

rs, string context)
{
// Following 3 lines show an easy way to create a dataset ds wi th the
contents of the ADODB recordset rs
OleDbDataAdapter da = new OleDbDataAdapter();
DataSet ds = new DataSet();
da.Fill(ds, rs, "ATableName");
// Add processing code here
return 0;
}

public void Close()

{
Dispose();
}

public void Dispose()

{
GC.SupclickFinalize(this);
}

}
}
The two GUIDs in the GuidAttributes decorating the interface and class are created using the Create
GUID choice in Visual Studio’s Tool s menu and will not be the same as those shown in this example.
The DLL that will result from this code needs to be registered in the GA C using REGASM (found in the
latest version folder beneath the Microsoft.NET\Framework folder in the Windows folder; for example,
c:\Windows\ Microsoft.NET\Framework\v4.0.3019) using the /codebase option.
In this case the entries in the Data tab for the import schedule would be:
 Import Data Type: Import from COM object
 COM object: SCCCOMObjNames pace.SCCCOMObjClass.1
 Method to Call on COM Object: ImportMet hod
 Method Context Parameter: <as needed>
and the entries on the Transport tab for the export schedule would be:
 Trans port Type: Call COM object
 COM object: SCCCOMObjNames pace.SCCCOMObjClass.1
 Method to Call on COM Object: ExportMethod
 Method Context Parameter: <as needed>

Version 6.0 91