AVEVA Manufacturing Execution System 2023 (Version 7.0) Readme

Last revision: Thursday, January 12, 2023

In This Document

About This Readme

About This Release

System Requirements

Product Compatibility

Licensing

Upgrading from a Previous Version to MES 2023

Resolved Issues

Known Issues

MES Documentation

About This Readme

This document contains important information about AVEVA™ Manufacturing Execution System (MES) 2023 (version 7.0). This Readme documents the system requirements, known issues, resolved issues, and changes, if any, to the MES user documentation.

Readme files from previous releases of MES are posted to the Product Hub page of the Knowledge and Support Center. Once on the Product Hub page, you can use the filter to list the MES documents, which include the Readme files.

About This Release

The MES 2023 release includes multiple significant changes as listed below. Highlighting a couple of the significant changes:

MES 2023 has been enhanced to include a new shift pattern configuration that contains the shift schedules and links to entities. Prior releases had shift schedules assigned to entities. The database migration process will create new shift patterns with appropriate links. However, these should be reviewed and modified by the end user after migration as necessary.
MES 2023 includes modifications to the database tables related to shift definition and item inventory. It also includes corresponding stored procedure and API changes that might require changes to existing applications that are upgraded to MES 2023.

Upon release, MES 2023 is compatible only with System Platform 2023, Work Tasks 2023, Recipe Manager 2023, and other current releases. See the compatibility information on the Technology Matrix page for further updates.

MES Stateless API

Added classes in the Commerce namespace: Shipment, ShipmentLot, Receipt, ReceiptLot, and CustContact.
Added EnProd.DataLog class and redirected existing DataLog16 and DataLog48 calls to DataLog
Added EnProd.JobStepData class.
Added overloads to EnProd.ItemInv and EnProd.StorageExec methods to include UTC and local dates for expiry date.
Note: Get calls that pass a filter parameter with expiry_date (e.g., $$expiry_date=$$) will need to change this to expiry_date_utc or expiry_date_local.
Added validation to item inventory and item production calls to ensure that input parameters and resulting data updates meet defined business rules.
Note: Item inventory and production calls that previously worked might now fail due to validation errors.
Added new shift pattern and shift schedule classes in the Core namespace: ShiftPattern, ShiftPatternEntLink, and ShiftSchedule.
Added Core.ShiftHistory.UpdateSpecific to record the user comments and spare fields that were added to the shift_history table.
The new Core.ShiftSchedule class replaces the ShiftSched class. Most but not all ShiftSched methods have been mapped to corresponding ShiftSchedule methods. However, there is a change in functionality that makes some of the calls non-functional now. For details, see the MES Stateless API Reference help.
In the Core namespace, Ent.DoAutoShiftChanges, Ent.DoPastShiftChanges, Ent.GetRefreshedShiftSched, Ent.StartShift, and ShiftSched.DeleteAll are no longer functional calls and do not need to be used.
Added new folder and file-related classes in the Prod namespace: Folder, FolderFile, and FolderItemOperEntLink.
Added overloads for Prod.WO.CreateWOforALine and Prod.WO.ReassignWOToALine to include additional parameters.
Item Inventory and Storage Exec APIs for moving, transferring, splitting, and updating inventory have been updated to include additional data validation checks.
Added overloads for Commerce.Cust.GetByFilter and SOLine.GetByFilter to not include user context.
Added EnProd.StorageExec.Scrap method.
Updated Sample.GetChars to return additional columns.
Removed various overloads that have been marked as obsolete in the MES 2014 (v5.0) release, including the following methods:
- Ent.Add
- Ent.GetAll
- Ent.Update
- Ent.UpdateSpecific
- JobExec.GetQueue
- OEEExec.Update
- OEEExec.UpdateSpecific
- Sample.UpdateSpecific
- UserName.Add
- UserName.AddorUpdate
- UserName.Update
- UserName.UpdateSpecific
- UtilReas.Add
- UtilReas.GetAll
- UtilReas.Update
- UtilReas.UpdateSpecific
- UtilState.Add
- UtilState.GetAll
- UtilState.Update
- UtilState.UpdateSpecific

MES Web API V3

The MES installation software includes a PowerShell script to register a client ID and client secret with AVEVA Identity Manager (AIM) to allow for service-to-service Web API calls. For more information, see the MES Installation Guide or help and the MES Web API V3 Reference help.
Added WO methods: Put, Post, Delete, GetAll, GetByKey, GetByFilter, Release, Cancel, ChangeWOQuantities, CreateForLine, ReassignWOToLine, and CreateFromProcess.
Added Production/SetLotData and Consumption/SetLotData Put methods.
Added POLine methods: Put, Post, Delete, Get, GetByKey.
Add Item methods: Put, Post, Delete, Get, GetByKey, GetByFilter.
Added ItemInventory/Scrap as a Put method to replace the Delete.
Added a Jobs/ChangeJobStates Put method.
Added UtilHistory methods: Put, Post, AddEvent
Added QM chart-related Sample methods: GetChartDataByFilter, GetChartDataNameFilter, GetChartFilters, GetChartTypeByFilter, GetChartTypeNameFilter, GetControlRules, and GetChars.
Updated the MiddlewareAccess endpoint to support generic commands for calling Put, Post, Delete, and Get calls.
The input parameters max_rows and trans_id are now included in the Web API call header.
Updated the Web API OpenAPI (Swagger) JSON file.

MES Stateful API

The ClientSession class has new properties for IsHostedByOMI and IsOMIUserLoggedIn
Added an overload for Jobs.AddProdPostExec to include sublot

MES Client

Moved Customer configuration from MES Supervisor to MES Client except for the generation of sales orders.
Moved Data Log configuration from MES Supervisor to MES Client, including a new property pane setting in entity configuration for linking data log groups.
Added an option to create a database view from a data log group.
Modified Shift Schedules to include shift patterns and moved shift exceptions from MES Supervisor to MES Client. Please see the MES Client User Guide or help for details about the new functionality provided.
New installations include an updated color palette for job, utilization, sample, sample result states, and other system colors. An upgraded database will retain the existing color settings.
Added an option to hide or show entities marked as unlisted.
Added a calendar sample frequency option to delay the generation of the initial sample.
Added Category on the QM Specification property pane for custom use.
MES Client icons and theme have been updated. All menu items remain in the same locations and order.

MES Middleware and Middleware Proxy

MES Service has been merged into the MES middleware.
One MES middleware will perform the background maintenance tasks that had been performed by the MES Service. In a multi-node environment with more than one Middleware Server, the maintenance tasks can be moved to another middleware if the current middleware that is handling them stops running. Related to this hand-off, the preferred middleware for handling the maintenance tasks can be set during post-install configuration.
An option was added to set the default region/time zone for transactions that are not associated to a site.
Shift generation will now use a site's region to generate shift transitions at local time for the entity.
Log flags were added for the FactMES.Server.MaintenanceService to log shift and sample generation maintenance activity.
All time conversion between UTC and Local use SQL Server functions and no longer rely on the tz_offset table, which has been removed.
In the Middleware Configuration editor, the default DB Connection retry count was changed from 100 to 10. For an upgrade, this setting will need to be manually modified after installation.
In a multi-node environment with more than one Middleware Server, optional additional MES middlewares can now be defined for the Middleware Proxy to use if it cannot connect to the initial MES middleware.
The communication between the MES Proxy and the MES Middleware is encrypted by default. New settings have been added to the Middleware Configuration Editor to change this behavior.

MES Web Portal

A new version of the Kendo library is being used in this release, including Kendo's version of globalization. MES Web Portal no longer is using the Globalize library. Any existing customer using this library will need to modify their custom pages to call the Kendo library instead.
MES Web Portal icons and theme have been updated.

MES Supervisor

Only Inventory, Storage Entity Status, and Supply Chain Connector configuration remains in MES Supervisor.
Customer, Data Log, and Shift Exception editors have been moved to MES Client.
Removed Item Folders configuration from MES Supervisor. Stateless APIs have been added to cover this functionality, but no configuration screens.
MES Supervisor is no longer included in any standard installation roles. Supervisor can be installed through a custom install.

MES Security

Improved MES native security password encryption technology is now being used.
MES native security no longer supports unique password as an option.
MES native security now uses new defaults of a 12-character password length and 5 login failures.
The MES .NET Control option for auto-login now works in InTouch OMI as well as InTouch.
MES OS Group based security addresses first-time user login issues. Now when a new user logs into MES for the first time from some method other than MES Client, the necessary user records will be generated in the MES database.

Note the following:

AVEVA Identity Manager (AIM) supports validation with Azure AD as a provider. If the Azure AD provider is synchronized with the same domain used for MES users, the MES Web Portal and applications calling the MES Web API will function. However, there is no option within MES Client to add Azure AD users or groups to MES security.
Platform Common Services (PCS) now has an option for a redundant single sign-on server. However, MES 2023 does not support PCS redundancy.

Upgrade Information

Data Log: Migration of a prior MES database version will move all data_log_16 and data_log_48 table data to the data_log table. If you previously ran the optional scripts from MES 2020 to copy the data to this new table, then you should delete the duplicate data from the data_log_16 and data_log_48 tables prior to upgrading so that there isn't duplicate data in the data_log table after migration. To continue support of reports that use the data_log_16 and data_log_48 tables, these are now views.
Shift Schedules Converted to Shift Patterns: During migration, existing shift schedules will be validated for conversion to shift patterns. If any inconsistencies are found, a list will be stored in the error_log table. If the existing shift schedules can be converted, then the migration creates shift patterns with names in the format MES DB 7.0 upgrade pattern - n. It is recommended to change these names to something meaningful. For more information, see the topic "Migrated Shift Schedules" in the MES Installation Guide or help.
Migration will not include any shift exception definitions from prior releases as the approach for defining these has changed.

Migration of shift schedules should be reviewed in close detail. You should determine whether or not a better approach exists with the new functionality added for shift patterns with effectivity dates and entity-specific shift exceptions.
Item Inventory Expiry Dates: Item Inventory records are updated to reflect expiry date local and UTC time, with the original value in the table retained in the expiry date local column.
New Licensing Version Required: This release requires a new version of licensing. Prior licenses for MES 2017, MES 2017 R2, and MES 2020 will not work with this release. The license feature lines remain the same.
Middleware:
- An upgrade will require reconfiguration to enforce MES middleware security and synchronization with System Management Server, which is now a required component.
- The MES Middleware service will be configured with Delayed Startup by default. If the database is on a separate node from the middleware, this can be changed to normal startup.

MES Data Editor and Supervisor to Be Deprecated

Future releases of AVEVA MES will no longer include the Data Editor or Supervisor components.

Transactions currently being performed in Data Editor should be transitioned into using the corresponding Stateless API methods or the Stateless API DirectAccess methods. If there is no Stateless API method to perform the desired action, use the Stateful API ClientSession.SendXMLCommand method.
With the future removal of Supervisor, the configuration of Supply Chain Connector integration will be removed. MES databases that are migrated as part of an MES upgrade will continue to function. All new customers should use Enterprise Integration instead of Supply Chain Connector.

BI Gateway

A limited version of BI Gateway Server is included with the MES installation software for use with MES BI Gateway reports and third-party reporting or BI Gateway tools. This version can be used solely with AVEVA Manufacturing Execution Software.

Note: An Azure SQL‑based BI Gateway datastore database is not supported with MES.

Note: Install BI Gateway either from the MES installation software or from BI Gateway installation software but not both. Installing from both might cause issues.

Updated Documentation

Significant content updates to the MES user documentation are summarized below.

MES Deployment Guide

Updated content to incorporate Work Tasks deployment with MES model-driven application content, database and recovery backup guidelines, and updated performance data.

MES Client User Guide and Help

Updated content to cover the new and updated modules for the changes in this release.

MES Installation Guide and Help

Updated content to cover changes to the installation, upgrading, and configuration.

MES Middleware User Guide

A new document that replaces the MES Middleware Extensibility Hooks Reference and the MES Service User Guide, which have been removed from the library.

MES Stateless API Reference Help

Updated content to cover API changes described above in "MES Stateless API."

MES Stateful API Reference Help

Updated content to cover API changes described above in "MES Stateful API."

MES Supervisor User Guide

Now contains only Inventory, Storage Entity Status, and Supply Chain Connector content.

MES Web API V3 Reference

Updated content to cover API changes described above in "MES Web API V3."

MES Operator User Guide and Help

Added content to cover serialization of produced items.

MES Web Portal User Guide and Help

Updated content to cover changes described above in "MES Web Portal Updates."

System Requirements

This section describes the hardware, software, and operating system requirements to install the MES 2023 software.

For the most current compatibility information, see the Technology Matrix page.

Hardware Requirements

The following are the recommended hardware requirements for nodes on which MES 2023 components will be installed.

The hardware requirements that are described in the following topics are based on the minimal requirements for running MES components. Additional minimum hardware might be required based on the version of Windows being used on a node (see Minimum Hardware Requirements for Supported Windows Versions).

Middleware or Database Server

Computer with dual core processor with 2 GHz or faster clock speed, or single core processor with 3 GHz or faster clock speed. Multi-core processor recommended for optimal performance.
8 GB or more of RAM recommended, 4 GB of RAM minimum.
300-GB Disk with RAID support for data. The amount of disk space necessary depends on the frequency of data collected (number of work orders, operations, production quantities, etc.) and the amount of data kept online in the production database.
Depending on complexity and size of the database server, 30 GB or more of available disk space is recommended. The database hard disk space should be enough to support the storage and performance requirements for your particular deployment.

MES Web Application Server

Computer with 2 GHz or faster processor clock speed.
8 GB or more of RAM recommended, 4 GB of RAM minimum.

All Systems (Client Applications)

30 GB (minimum) hard drive
Super VGA (1024 x 768) or higher resolution video adapter and monitor
CD-ROM or DVD drive, or access to a network share or portable media device that contains the installation files
Keyboard
Mouse or compatible pointing device

Minimum Hardware Requirements for Supported Windows Versions

All supported Windows operating system versions require 64-bit CPUs.

See your specific Microsoft operating system hardware requirements for additional details.

Software Requirements

This section lists the AVEVA and other third-party software requirements to install MES 2023:

Microsoft .NET Framework 4.8 is required for all components. If the required version of .NET Framework is not installed, it will be installed during the MES installation. Note that Windows 10 versions prior to version 1607 will fail to install .NET Framework 4.8.
If installing MES Web Portal, the following are required:
- Microsoft Internet Information Services 7.5.
- Microsoft Web Deploy tool.
- MES Web Portal is compatible with version 13.0.1 of newtonsoft.json.dll.
If installing MES application objects, the following are required:
- The Entity Model Builder feature requires System Platform Integrated Development Environment (System Platform IDE).
- The Utilization Capability Object (UCO) and Operations Capability Object (OCO) require Microsoft Message Queue for their asynchronous calls.

Web Browsers Supported for MES Web Portal Client

The MES Web Portal client has been validated with the following web browsers, using the web browser versions that were available at the time of the MES 2023 release:

Chrome
Edge Chromium
Firefox

It is expected that the MES Web Portal client will operate properly with subsequent releases of Chrome, Edge, and Firefox browsers. However, if any MES Web Portal features do not function due to changes in a new release of Chrome, Edge, or Firefox, customers will be notified by a Technical Alert when we are made aware of the issue.

Note: Internet Explorer and Microsoft Edge releases prior to Edge Chromium version have a memory leak and are not recommended. Update your browser to Edge Chromium.

Note: Demo videos in the MES Web Portal help will not run in standard Firefox. To run demo videos in Firefox, you must have an MP4-capable video player such as Windows Media Player installed on both the server and client machines or have a third-party MP4 plug-in installed in Firefox.

Database Requirements

Supported Microsoft SQL Server Versions


Microsoft SQL Server Version		Type	Service Pack Level
2016	64-bit	Express, Standard, or Enterprise Edition	SP3
2017	64-bit	Express, Standard, or Enterprise Edition	N/A
2019	64-bit	Express, Standard, or Enterprise Edition	N/A

Requirements

The MES 2023 release requires SQL Server 2016 SP3 or later as it makes use of SQL functionality added in that release.
SQL Server should be configured for TCP/IP for local connections. SQL Server should also be configured for TCP/IP for remote connections if servers that require access to the MES database, such as the MES middleware server or the Reports server, are on remote machines. SQL Server must be installed using a case-insensitive collation.
Microsoft Distributed Transaction Coordinator and IIS 6.0 or later.
MES Database using multiple languages requires AL32UTF8 Unicode character set installed on your server.

Recommendations

For proper database maintenance, use a SQL Enterprise version due to the availability of online indexing capability.

Operating System Requirements

The following table lists the operating systems that are supported and can be installed on computers that run MES 2023.


Operating Systems		Type	Version	MES Features
Operating Systems		Type	Version	Client Components	Database	Middleware	MES Web Portal Service	Reports Components
Windows Server 2016	64-bit	Standard or Datacenter	none	Yes	Yes	Yes	Yes	Yes
Windows Server 2019	64-bit	Standard or Datacenter	none	Yes	Yes	Yes	Yes	Yes
Windows Server 2022	64-bit	Standard or Datacenter	none	Yes	Yes	Yes	Yes	Yes
Windows Server	64-bit	Core	1803/1903	No	No	No	No	No
Windows 10	64-bit	Professional or Enterprise	1607 (Anniversary Update) or later for .NET 4.8	Yes	Yes ¹	Yes ¹	No	Yes
Windows 11	64-bit	Professional or Enterprise	none	Yes	Yes ¹	Yes ¹	No	Yes

¹ Indicates that it is supported for sales and demo purposes only, not for production systems.

Support for Virtual Environments and High Availability

The MES 2023 software can be run in virtual environments to support High Availability for Live Migration and Failover. Implementing High Availability can be performed using VMware technology or Microsoft Hyper-V technology.

For information about implementing MES in a virtual environment, see the System Platform in a Virtualized Environment Implementation Guide and the MES Virtual Implementation Guide.

For specific information on VMware product compatibility, see the VMWare Compatibility Guide at http://www.vmware.com/resources/compatibility/search.php.

Support for Non-English Versions of Operating Systems

The MES 2023 software runs on the following non-English operating systems:

French
German
Japanese
Simplified Chinese
Russian
Spanish

The corresponding language versions of Microsoft SQL server are used, where applicable.

MES Firewall Exceptions List and Firewall Ports

The firewall ports and exception white list entries specific to MES applications are created during the MES DB/MW Communication component configuration. The default HTTPS, HTTP, and SQL Server firewall ports that are required by MES applications are opened by default on Windows or by installing SQL Server.

The default port numbers that MES uses are listed in the following table.


Component	Port		Changeable?
Component	HTTP	HTTPS	HTTP	HTTPS
MES Middleware Proxy	80	443	Y	N
MES Middleware Web API			Y	N
MES Web Portal			N	Y
System Management Server	N/A		N	Y

For a list of the firewall ports used by other AVEVA products with which MES works, refer to their documentation:

License Server and Manager: Enterprise Licensing Guide
System Platform: System Platform Readme and Application Server User Guide
Work Tasks: Work Tasks Administrator Guide
BI Gateway: BI Gateway Installation Guide and BI Gateway Web Configuration Guide

For SQL Server and similar third-party products, refer to the appropriate product documentation.

Product Compatibility

MES 2023 is compatible and can co-exist with the following products. Compatibility means that the products can communicate with each other over the network. Co-existence means that the products can be installed on the same computer.

For the most current compatibility information, see the Technology Matrix page.

Component	Version	Compatibility	Co-existence
Application Server	2017 U3, 2020, 2020 R2	N	N
System Platform	2023	Y	Y
Platform Common Services (PCS)	7.0	Y	Y
Operations Management Interface (OMI)	2023	Y	Y
InTouch^®	2023	Y	Y
Historian Server	2023	N/A	Y
Historian Client	2023	N/A	Y
Batch Management	2020	N/A	N
Batch Management	2023	N/A	Y
BI Gateway	2021 SP 1¹	Y	Y
Enterprise Integration	2023	Y	Y
Recipe Management	2020, 2020 R2	N/A	N
Recipe Management	2023	N/A	Y
Work Tasks	2020, 2020 U1, 2020 U2	N	N
Work Tasks	2023	Y	Y
Work Tasks Connector/Extension for MES	7.0²	Y	Y

¹The version of BI Gateway included with MES has different OS and SQL Server version support. Check the Technology Matrix page for the latest updates to BI Gateway OS and SQL Server support^..

²This version of Work Tasks Connector/Extension for MES works with MES 2023 and Work Tasks 2023.

Licensing

The 2007 Microsoft Office Fluent User Interface is subject to protection under U.S. and international intellectual property laws and is used by MES under license from Microsoft.

Quinn-Curtis SPC Chart Control:

The use of the QCSPCChart and QCChart2D WPF, .NET, and JavaScript controls require the purchase of an Advanced Dev Studio or MES Quality license.

Upgrading from a Previous Version to MES 2023

Upgrading from the following MES versions is supported:

4.0 (all service packs and patches)
4.5 (including P1)
5.0 (including SP1 and R2)
5.3
6.0 (including R2)
6.2

To upgrade from an earlier version, you must first uninstall the previous version and then install the new version.

Database Migration

The MES Database Setup component in the post-install Configurator application supports migration of databases from version 3.1 and later. To migrate from versions earlier than 3.1, you must first update the database to version 3.1. Custom modifications to any version of the MES database might not be supported by the utility and might prevent migration.
The MES database upgrade from versions prior to 6.0 will take significantly longer than previous upgrades as the utilization data must be migrated to the new schema. Databases with multiple millions of records in the Util_Log, Job_Util_Log_Link, and Item_Prod tables will take on the order of hours to migrate. Prior to migration, the post-install Configurator application will provide a rough estimate of the time required.
The current database structure has views that include the same columns as the tables prior to MES version 6.0 so that legacy queries will not break. However, the data will be slightly different as there are no longer extra records during shift changes.
Starting with MES 2020 (version 6.2), an additional link table is included and the views are updated to use this new table. The migration populates this new link table, so migrations from 6.0 and 6.1 to version 7.0 also take significant time.
Migration of a prior MES database version will move all Data_Log_16 and Data_log_48 table data to the Data_Log table. If you previously ran the optional scripts from MES 2020 to copy the data to this new table, then you should delete the duplicate data from the Data_log_16 and Data_log_48 tables prior to upgrading so that there isn't duplicate data in the Data_Log table after migration.
Migration will not include any shift exception definitions from prior releases as the approach for defining these has changed. Migration of shift schedules should be reviewed in close detail. You should determine whether or not a better approach exists with the new functionality added for shift patterns with effectivity dates and entity-specific shift exceptions.

Note: If an existing database has custom indexes or keys that reference MES core tables, the database migration will fail. Prior to upgrading, drop any custom indexes and keys. They can be added back after the database migration is complete.

Note: You can only perform a database Restore from an archive that was created with the version of MES that you are currently running. Restores using an archive from a previous version of MES are not supported and might fail.

For more information on upgrading, see the MES Installation Guide and online help.

Resolved Issues

This section describes important resolved issues in MES 2023, listed by their Change Request number.

IMS 539797	Create WO from Process fails if the first operation includes a specification and the next operation has multiple entities. Cannot insert duplicate key in object 'dbo.job_spec'.
IMS 560891	Shifts not changing on some entities tracking labor.
IMS 561009	Editing a final reason for a utilization event does not change the Category; it is leaving the original one.
IMS 564097	Ending multiple jobs at one time takes a long time.
IMS 564325	Stateless API StorageExec.ReduceInv() method's Dateout parameter is not saved in the MES database.
IMS 565784	MES service is timing out when executing stored procedure sp_U_Sample_UpdateStatus.
IMS 577706	Undeploy/deploy of OCO causes rolling counters to improperly increment when using input source.
IMS 620413	The latest start time and required finish time for jobs on a multi-operation process are incorrect when percent to start is configured.
IMS 626235	Can't end a job with multiple long running jobs in the database.
IMS 644716	Entity Allowable Reason Group settings are getting cleared when viewing them and then adding a new allowable reason group to a different entity.
IMS 690874	Linking an item to a process times out when thousands of entities are associated to operations in the process
IMS 739856	The Stateless API Prod.ItemReasGrpEntLink.GetReasons method is ignoring item_id.
IMS 740518	Item and item class specification are not saved when removing another one.
IMS 805244	Create Work Order from Process times out.
IMS 826084	Control rule check is skipped when multiple entities have same characteristic, there are different request times, and the later request time sample results are recorded before the earlier sample.
IMS 826093	Middleware configuration does not accept the user in the username@domain format.
IMS 828969	Support single sign-on when MES .NET control is used in AVEVA OMI and the auto login user property is enabled.
IMS 831519	HF L00159969 for MES 6.0: On a Terminal Server node, MES middleware periodically denies connections and fails to record or read data.
IMS 834929	HF L00159969 for MES 6.2: On a Terminal Server node, MES middleware periodically denies connections and fails to record or read data.
IMS 840286	Using Australian regional settings (dd/mm/yyyy), MES Client can create a work order but cannot update a work order.
IMS 860392	Related to HF L00153970: With 64-bit applications, the error "Client Proxy configuration settings are missing" is logged.
IMS 861467	Stored procedure sp_i_Item_Cons_AddConsPostExec allows for NULL shift start time, which makes queries of the item_cons table to be slow.
IMS 888530	IMS 860392 for 6.2: Related to HF L00153970: With 64-bit applications, the error "Client Proxy configuration settings are missing" is logged.
IMS 1052245	MES service deadlock occurs when executing stored procedure sp_U_Sample_UpdateStatus while inserting a new result at the same time.
IMS 1055331	MES Web API SampleCharLink method does not provide the UOM and number of decimals properties.
IMS 1092380	Importing an attribute item with a space character using SCC is creating a record when it shouldn't.
IMS 1148093	Continuation of IMS 826084 for Xbar-Sigma chart: Control rule check is skipped when multiple entities have the same characteristic, there are different request times, and the later request time sample results are recorded before the earlier sample.
IMS 1209336	HF 826084 and 1148093 for MES 6.2: Control rule check is skipped when multiple entities have same characteristic, there are different request times, and the later request time sample results are recorded before the earlier sample.
IMS 1330272	Data Editor is showing the wrong wo_id on the Utilization tab.
IMS 1398371	The migration script for migrating from MES 5.3 to 6.0 generates the error "Cannot insert duplicate key in object 'dbo.job_history'." (multiple job positions starting at the same time).
IMS 1427402	The user has an apostrophe in their name and cannot log into MES.
IMS 1434375	An OS User was moved to a group other than local Administrator and can no longer log in to MES.
IMS 1437263	The stored procedure sp_U_Job_Hour_History_RefreshQtysAndTimes takes more than a minute to complete.
IMS 1440740	ItemProd.UpdateSpecific method cannot update created_at date.
IMS 1441052	An arithmetic overflow error occurs when converting IDENTITY to data type int in the job_hour_history table (row_id now is Big_Int).
IMS 1503396	The migration script for migrating from MES 5.3 to 6.0 generates the error "Cannot insert duplicate key in object 'dbo.job_history'." (duplicate job_event records in the original database).
IMS 1516792	Related to L00153800: Ending a paused job sets the job end utilization state when another job is still running.
IMS 1555706	Inserting messages into the rejected message table fails in Russian time zones.
IMS 1560981	Creating a new shift schedule interferes with existing calendar frequencies on other entities.
IMS 1562267	Utilization Control does not update Category fields when changing downtime reason.
IMS 1569379	Quality Web API Result (Post) to update an existing record does not flag the result as superseded.
IMS 1577968	Web API for splitting the current utilization event (Split Next) generates 3 events instead of 2 events.
IMS 1585235	IMS 1555706 for 5.3: Inserting messages into the rejected message table fails in Russian time zones.
IMS 1589005	After creating a new bom_ver for a parent item that contains a sub-item, the BOM item operation links for the sub-item are removed.
IMS 1592357	Setting OEE basis calculation to 1 (KPI per job) in the oee_exec table still calculates OEE KPIs by shift.
IMS 1595508	Job_event.quantity is an integer when it should be a real.
IMS 1605342	Reducing production of production counts recorded by the OCO fails in Operator or MDM Job Management Form because a different user is registered with the production vs reduction transaction.
IMS 1613590	HF 577706 for MES 6.1: Undeploy/deploy of OCO causes rolling counters to improperly increment when using input source.
IMS 1615207	Create Work Order from Process creates only one job for a process with a single operation and multiple entities.
IMS 1626643	In a complex process with a multilevel BOM, setting a subitem as the produced item at an operation times out.
IMS 1645833	OCO with push production on reset is recording the rollover value instead of just the incremental amount on reset command when the counter has an input source from I/O that also is changing to 0.
IMS 1655505	Related to HF IMS 805244: Create Work Order from Process fails to create job BOM records.
IMS 1677808	MES Web API Swagger JSON file for MDM updated to pass body parameters in the DirectAccess API (POST) within Work Tasks web API activity.
IMS 1679737	Shift change process timing out - slow sp_U_TPM_Stat_RefreshTimes.
IMS 1691063	Canceling a work order with jobs running on multiple job positions only cancels the job on job position 0.
IMS 1698736	Cannot set the produced item for an operation in a process with complex BOMs.
IMS 1729228	OEE KPI Control generates an error when the OEE value equals 0.
IMS 1735473	Occasionally sample status stays "Ready" even when results have been recorded. Similar to HF L00145710.
IMS 1747702	MES Web API to retrieve utilization records missing spare and category fields.
IMS 1758256	HF 560891 for MES 6.2: Shifts are not changing on some entities tracking labor.
IMS 1758257	HF 564097 for MES 6.2: Ending multiple jobs at one time takes a long time.
IMS 1758342	HF 539797 for MES 6.2: Create WO from Process fails if the first operation includes a specification and the next operation has multiple entities. Cannot insert duplicate key in object 'dbo.job_spec'.
IMS 1776370	Migration from MES 5.0 to 6.2 generates unique key constraint errors on job_history table.
IMS 1781018	Continuation of HF 1747702: MES Web API to retrieve utilization records missing spare and category fields.
IMS 1786715	In MES Client, the Add Frequency Link dialog stops populating when editing Sample Plans after opening and closing it multiple times.
IMS 1791526	HF 1679737 for MES 6.2: Shift change process timing out - slow sp_U_TPM_Stat_RefreshTimes.
IMS 1808716	Related to HF 1691063: MES Web API does not pause jobs running on multiple job positions; it can only pause the job at job position 0. Fix also includes changes from HF 1691063.
IMS 1839546	After migration to MES 6.2, the job_hour_history table might not include production counts from AddProdPostExec if the timestamp doesn't match the job record.
IMS 1847823	With large amounts of data within an hour, Purge process times with query size set to 1 hour.
IMS 1853100	Related to HF 1691063: MES Web API does not end jobs running on multiple job positions; it can only end the job at job position 0.
IMS 1860171	Cannot set the produced item for an operation in a process when the operation name is greater than 10 characters.
IMS 1869589	HF 1735473 for MES 6.2: Occasionally sample status stays "Ready" even when results have been recorded. Similar to HF L00145710.
IMS 1875623	Item Inventory Add incorrectly defaults status_cd to grade_cd in the stored procedure.
IMS 1877180	MES Client crashes when opening item specifications if the user’s access level is NULL.
IMS 1882057	vw_prod_events is much slower to execute compared with MES 2014.
IMS 1885754	Item consumption from a storage entity with ‘Multiple lots/items stored here become indistinguishable' does not set the segment_requirement_id and segment_response_id fields in the item_cons table.
IMS 1886463	Cannot register an application with AIM to call the MES Web API through a service-to-service token.
IMS 1891768	Cannot edit entity attributes in the MES Web Portal.
IMS 1903067	A new OS user cannot use MES Web API functions in Enterprise Console if they don't log in to the MES provider or MES Client application first.
IMS 1905658	An arithmetic overflow error occurs in the stored procedure that calculates statistics when characteristics have very large sample sizes.
IMS 1905962	Cloning a job does not transfer the serial_no_source field to the cloned job.
IMS 1953213	When there are multiple OCOs with storage enabled on an engine, restarting the engine might leave some OCOs in Connecting status.
IMS 1985700	On a French OS with comma as the decimal separator, MES QualityCharacteristicDetail Report generates the error "Subreport could not be shown" even with the correct security setting.
IMS 2007701	Control rule violations are triggered with first result instead of waiting for the minimum sample size before evaluating control rules.
IMS 2011639	Utilization group spare fields are not loaded in the MES Client editor.
IMS 2030255	Modifying the start time of the shift schedule for the active shift to an earlier time is updating the current shift's start time, causing an overlap with a previous shift.
IMS 2060346	The JobExec.AddConsDirect method logs created_at_local in the server time zone instead of the entity's site time zone.
IMS 2070351	job_bom Spare fields are truncated when creating WO from process, splitting, or cloning a job
IMS 2072146	The JobExec.AddProd method does not populate rmLotNo and rmSublotNo.
IMS 2076937	A pulled sample transitions from In Progress to Ready when the expiration time elapses instead of transitioning to Late.
IMS 2086178	Duplicate key error when setting the produced item for a process with complex routing.
IMS 2089008	The SRO attributes RecentSampleX.SampleStatus and .ControlRuleViolation have a 10-second delay.
IMS 2141338	HF 1330272 for MES 6.2: Data Editor is showing the wrong wo_id under the Utilization tab.
IMS 2160659	Calling Pause Job with no job information (only job position) fails to pause the job.
IMS 2160919	Required finish time for jobs created from a process with two initial operations do not match.
IMS 2198972	Shift breaks are missing in the shift_to_go table for shifts that span across midnight.
L00143038	Upgrades will fail if a table with a same name but different schema exists in MES database.
L00149773	expiry_date column is recorded in local time only.
L00149839	Milliseconds are not stripped off from the created_at_local and created_at_utc fields in the item_prod table.
L00151587	Sample generation offset automatically shifts after midnight - Added new Start Delay option for Calendar Frequency.
L00152300	When MES Service is changing shifts for a site not in the same timezone as where it is running, the records in shift_history are being created either before or after they should be.
L00152573	Creating an instance of Sample Recording Object (SRO) logs unhandled errors when there is a default Area defined. The work around is to not have a default area or to ignore the messages.
L00152703	Slowness in calling the API Prod.ItemProcessLink.Add method after many items and BOMs are linked.
L00153893	The ItemInv.Add method does not accept NULL for grade and state - Method marked as obsolete and documentation improved.
L00155839	Memory leak in Internet Explorer11/MS Edge when staying on a collection page such as line collection or work order collection. This is a Microsoft known issue and is addressed in the Chromium version of Edge.
L00157474	Incorrect timestamp values are recorded to the job_event table when recording backflush consumption.
L00157709	Setting 'Log storage entity changes' is not logging changes to spare_intx in the storage_ent_transfer table.
L00158123	The following properties of the imported OMI apps cannot be saved in the OMI configuration (fixed in OMI 2020 R2): CDKPIFilter and ReasonGroupColors in the Counts and Duration control OEEKPIFilter in the OEE KPI control UtilizationFilter in the Utilization control
L00158991	The Prod.Sublot.Rename method does not work when there is inventory.
L00159022	Using PEM attributes in the OCO objects to report production/consumption for the same jobs on different entities at the same time results in not being able to stop the second job.
L00159062	Jobs running for over a month take a long time to end and can time out.
L00159144	Users are unable to log in to MES Client when one of the OS Groups to which the user belongs is deleted.
L00159262	HF L00159062 for MES 6.1: Jobs running for over a month take a long time to end and can time out.
L00159359	Pausing/suspending a job in the MES Client Job Queue does not update certain fields in the job and job_history tables.
L00159432	Deploying OCO with a PEM instance that references 'MyContainer' causes warnings in the logger.
L00159500	OCO Job attributes are stuck in the initializing state after a reboot.
L00159604	MES Client APR will crash if an archive job is created and then the system parameter for the Archive Root Directory is changed.
L00159669	When selecting an entity class in MES Client, the attributes are not updated.
L00159775	Related to CR L00159262: Changing the utilization event for an entity that has been in the same state for over a month takes 1 minute.
L00159891	When production is recorded during the first seconds of a new shift (shift change in progress), the shift information logged is for the previous shift, not the new one.
L00159969	On a Terminal Server node, the MES middleware periodically denies connections and fails to record or read data.

Known Issues

This section describes important known issues in MES 2023, and in System Platform that affect MES.

System Platform 2020 R2 SP1 and MES 2020 Patch 2 Upgrade Issues

If there are issues when upgrading from System Platform 2020 R2 SP1 and MES 2020 Patch 2 , first ensure that you follow the correct sequence to upgrade your system:

Upgrade System Platform to 2023; do not connect to the System Platform IDE.
Upgrade MES to 2023.
Start the System Platform IDE to migrate the galaxy.
Follow MES steps in the MES Installation Guide or help to import updated MES .NET Controls, application objects, and scripts.
Following completion of the upgrade, perform a reboot.

If there is still have an issue with deploying the objects or View app with errors related to the ArchestrA.Visualization components, try restarting the AVEVA Service Manager service.

Regarding IMS 2075532 (Unable to deploy the remote Windows platform once System Platform 2020 R2 SP1 is upgraded to System Platform 2023): If, during deployment, an error stating that the remote node's user ID or password doesn't match the GR node, try re-registering the transport component on the remote node as described below:

In a command prompt, go to C:\Program Files (x86)\ArchestrA\Framework\Bin.
Run aaDCOMTransport.exe /REGSERVER.

Work Tasks 2023 Connector for System Platform

If the Work Tasks Connector for System Platform is installed in a Galaxy with any objects created from the Application Object Toolkit (AOT), then these objects will not show the Workflows tab in the System Platform IDE and will log an error in the OCMC Logger. All three of the MES application objects are created with the AOT and will not show the Workflows tab in the IDE.

The workaround is to use a standard user-defined object for configuring the Workflows tab.

The error message is:

UIThreadExceptionHandler: Object reference not set to an instance of an object

Additional errors might be logged related to ArchestrA.Workflow.IDEExtension.Extensibility.xxx.

This issue will be addressed in either an updated release of the Work Tasks Connector for System Platform or the next release of MES.

MES BI Gateway Reports: Detection of Utilization Event Deletion or Modification

The MES BI Gateway Reports model cannot detect utilization event deletion or duration modification. The BI Gateway service is dependent upon a detection method for notification of changes to records. The MES model uses the last_edit_at field in the MES database for its detection method. When a utilization event is deleted by modifying an existing event's duration or inserting a new event to cover an existing event, there is no option to notify the BI Gateway Service. Similarly, if an event's duration is changed but not its start time, the last_edit_at column is not modified since the duration is not stored in the new Util_History table, resulting in no notification to the BI Gateway Service. There is no workaround for this issue.

Known Issues for MES

The following table lists the known open change requests for MES, listed by their change request number.

IMS 1809089	Related to HF 152505: sp_BOM_Item_Oper_Link_Chk improvements when there are many BOM versions and items linked to a process.
IMS 2147744	MES Web API for Utilization Grid does not populate some fields such as raw_reas_cd, failure, spares, and categories.
IMS 2150752	Connection errors continue to be logged every few seconds when the MES Middleware is down and MES objects are undeployed. These will end when MES Middleware is restarted or the engine is undeployed.
IMS 2156935	Reducing item consumption to zero should not remove the record until the ERP quantity is also reduced to zero.
IMS 2173510	When MES is installed in a system with System Platform, running the MES Repair operation will cause you to be prompted to specify the location of the installation media. Use the Browse button to navigate to and select the MES setup.exe file in the MES installation software.
IMS 2175840	Continuation of IMS 2147744: Changing raw_reas_cd does not get recorded in the database.
L00131983	Trying to start a job on more than one machine causes an error inserting into the Prod_Rate_History table on very specific scenarios.
L00132902	If multiple items to be produced in a process have a common sub-item to be produced in BOM #1 and BOM #2, then every time that common sub-item is marked as "Set as Produced Item" on BOM #1 for an operation, the same sub-item will be marked as produced on that operation for BOM #2.
L00135404	With the OS language set to Russian, the Entity OEE targets set in MES Client will generate a validation error but still save correctly.
L00137118	During migration of the MES database from MES version 4.5 SP1 to 5.0 SP1, there is an error associated to conflict with check constraint CK_Sample_Size. MES 2014 (version 5.0) and above prohibit this invalid configuration. The user must correct the bad data in the database and then run the migration again.
L00143414	Launching of the Operator following a fresh install fails with an error dialog that states Unable to load DLL 'PEGRP32C.DLL'. This is an intermittent issue that can be resolved by rebooting the machine after installation.

Known Issues for System Platform and Common Components That Affect MES

The following table lists the known open change requests for System Platform that affect MES, listed by their change request number.

IMS 2178106	System Platform IDE 2023 becomes sluggish and unresponsive when creating many instances of the MES Operations Capability Object (OCO) with PEM enabled and when running Entity Model Builder. Will be fixed in SP 2023 R2.
L00117794	Tooltip text on the MES Button Bar .NET control buttons is not shown when running the control in InTouch. This is an InTouch issue; fixed in OMI 2020.
L00138837	AppEngine can crash due to the calls made to the FactMES API dlls even when using try/catch. Specific to Nullable data types. Will not be fixed in System Platform, so recommendation is to continue using the wrapped MES API DLLs in System Platform scripting.
L00140001	On an OS using a comma separator instead of a period separator for numbers, when the System Platform IDE is first opened, the MES objects will display the period separator instead of the comma separator. If you open another editor, the MES objects will display correctly. This is a System Platform IDE issue.
L00144202	After failover, selecting an OCO object with PEM enabled in the Object Viewer logs many error messages from the BaseRuntimeComponentServer component when reading a PEM extended attribute's data type property. This can be corrected by restarting the hosting engine of the object.
L00153087	SampleViewer .NET control does not honor RequireEntityLogOn property when used in an InTouch Frame window. Request InTouch Hotfix L00153571 for InTouch 2017 Update 2 to be released for your version of InTouch.
L00154309	Modifying a deployed OCO or SRO that adds or removes an object-generated attribute causes errors to be logged every scan (object reference not set) even though the object still functions correctly. Request AOT HF L00154664 for System Platform 2023.
L00158082	Importing of the MES folder for OMI can generate a warning during the import and log a message that it was unable to find referenced file system.windows.forms. Instead of importing the folder, MES 2023 includes an MESOMIControls.aapkg file that does not generate any warnings.

MES Documentation

The MES 2023 documentation set includes the following:

MES Deployment Guide

Provides guidance on deploying a MES solution.

MES Virtual Environment Implementation Guide

Provides information to assist with implementing MES in a virtualized environment.

ReadMe

Provides information about software and hardware requirements, known issues, licensing, and documentation.

MES Installation Guide and online help

Provides information about installing MES applications.

MES Client User Guide and online help

Provides information about customizing and maintaining the plant floor information.

MES Dynamic Routing User Guide

Provides information required to set up dynamic routing of operations through a process defined in MES.

MES .NET Controls Developer Guide

Provides information about the properties and methods of the MES .NET controls for use in custom applications and System Platform graphics.

MES Application Object (OCO, UCO, SRO) Help

Provides information about run-time behavior, configuration, and run-time attributes of UCO, OCO, and SRO application objects. This help is accessed from the Object Editor Help menu in the System Platform IDE.

Operation Capability Object (OCO) User Guide

Provides information about installing, configuring, and using the Operations Capability Object to track production transactions against equipment.

Sample Recording Object (SRO) User Guide

Provides information about installing, configuring, and using the Sample Recording Object to collect and store values for samples.

Utilization Capability Object (UCO) User Guide

Provides information about installing, configuring, and using the Utilization Capability Object to collect equipment performance data.

MES Entity Model Builder User Guide

Provides information about creating entities from the System Platform equipment model.

MES Stateless API Reference online help

Provides information about using the Stateless API within the System Platform IDE to develop and customize System Platform scripts.

MES Stateful API Reference online help

Provides information about using the Stateful API within the System Platform IDE to develop and customize System Platform scripts.

MES Web API V1 Reference online help

Provides information about using the MES Web API V1 to develop custom applications.

MES Web API V3 Reference online help

Provides information about using the MES Web API V3 to develop custom applications.

MES Operator User Guide

Provides information about executing production processes at the plant floor using the Operator application.

MES Web Portal User Guide and online help

Provides information about using the web browser-based MES Web Portal to customize and maintain the MES system and execute jobs at the plant floor.

MES Middleware User Guide

Provides information about how to configure the MES middleware and what regularly scheduled tasks it performs in the MES system. Also provides information about how to use middleware extensibility hooks to perform custom actions before or after a specific middleware event is executed.

MES Supervisor User Guide

Provides information about managing inventory and Supply Chain Connector imports and exports.

MES BI Gateway Reports User Guide

Provides information about running and viewing MES BI Gateway Reports.

MES Help

Provides online information about MES Operator, Supervisor, and Data Editor.

MES Data Editor User Guide

Provides information about inserting and modifying data in the MES database.

The MES 2023 product library includes a set of Portable Document Files (PDFs) located in the Docs folder in the MES installation folder. You need Adobe Reader installed on your computer to view the MES documentation. You can download the latest version of Adobe Reader from the Adobe Corporation web site.

After installing Adobe Reader, double-click a PDF file to view the book with Adobe Reader. You can also open a book with the Adobe Reader Open command from the File menu.

The MES installation instructions are located in the root folder of the MES installation folder as a PDF file and an online help file. You can view these instructions by clicking Help as you start the MES installation procedure.