MES Model-Driven Application Content (Version 4.0) Readme

Last revision: 7/16/2021

About This Release

The model-driven application content is designed to allow you to use the forms and workflows as is for inventory, job, quality, and work order management, or to customize them to meet the requirements of your specific production environment.

This version of the Manufacturing Execution System (MES) model-driven application content is being delivered as the following Work Tasks packages:

• The Inventory Management version 4.0 package (MES_PKG_Inventory_Management) includes forms and workflows that allow supervisors and operators to receive and manage inventory among lots and storage locations.
• The Job Management version 4.0 package (MES_PKG_Job_Management), along with the Split Control version 4.0 package (MES_PKG_CustomControl_Split), include forms and workflows that allow operators to manage jobs in a job queue, add job production, add BOM consumption, and manage utilization events for entities.

  In this release, the following features have been added:

  • A redesigned job summary area that presents item, job, and production status in a dashboard format.
  • The Utilization tab now allows you to toggle between a grid and a new timeline chart of utilization events. Event details and edit, split, and merge functions can be accessed by selecting an event in the chart.
  • A new Performance tab that provides at-a-glance charts to quickly assess utilization event counts and durations, overall OEE and KPI status, and production counts.
• The Quality Management version 4.0 package (MES_PKG_Quality_Management) has been added. It includes forms and workflows that allow operators to view current, past, and future quality samples and record their characteristic result values.
• The Work Order (WO) Management version 4.0 package (MES_PKG_Wo_Po_Management) includes forms and workflows that allow supervisors to manage work orders, a work order's job bill of materials (BOM) records, and a work order's job specifications.

  In this release, a Work Order Dashboard form has been added. It provides summary information about current work orders in a card layout.

The package forms now support the automatic expansion of grids when the Details pane is closed.

This version includes localization for all packages for the following languages: Chinese (Simplified), French, German, Japanese, Russian, and Spanish. It also includes a Language Installation wizard to simplify the set up of localized files.

System Requirements

AVEVA Software Requirements

The following AVEVA software is required for using MES model-driven application content:

• ArchestrA Identity Manager (AIM) is required to provide users with access tokens for MES. AIM can be installed as part of MES, Work Tasks, and System Platform installations.
• Work Tasks 2020 U1
  • To work properly using Chrome version 91 and later releases, Work Tasks 2020 U1 requires the following hot fix: AWT2020-U1-HTFX-7.1.2035.1. This hot fix is provided with the MES model-driven application content installation files.
• MES 2020 (version 6.2)
  • To work properly with the Quality Management package, MES requires the following hot fix: HF_1055331. This hot fix is provided with the MES model-driven application content installation files.

  Note: MES model-driven application content supports OS Group and OS User MES users, but not native MES users.

• Work Tasks 2020 U1 Connector and Extension for MES 2020 (version 6.7)

  Note: Previous versions of Work Tasks Connector and Extension for MES cannot be upgraded to version 6.7. You must uninstall the previous version, then install version 6.7.

• Intelligence 2017 U1 (a non-licensed limited version is included with the MES 2020 installation software; the full version is optional)

  Note: BI Gateway 2021 (the next version of Intelligence) is also supported. It must be downloaded and installed separately.

In addition, for solutions using automated data and event capture:

• System Platform 2020 R2 P01 (Application Server, InTouch, Historian).
• Work Tasks Connector and Extension for the latest available update of System Platform 2020. This connector is included with the Work Tasks 2020 U1 installation software.

Operating System, SQL Server, and Browser Requirements

For a particular node when implementing MES model-driven application content, the Windows operating system version, SQL Server version, and web browser must be compatible with all of the AVEVA products that are being installed on the node.

For the current compatibility information, see the Technology Matrix, which is available in the Knowledge and Support Center.

The recommended configuration is:

• For servers, Windows Server 2019. For clients, Windows 10.
• SQL Server 2019.
• Chrome for the web browser.

Hardware Requirements

The Windows operating system and SQL Server versions that are being used in the Model-Driven MES solution impose hardware requirements for the nodes in the solution. Refer to the Microsoft MSDN web site for the hardware requirements for the versions of Windows and SQL Server that are being used.

In addition, it is strongly recommended that the Work Tasks server node and all client nodes have at least 16 GB of RAM to optimize performance.

Installing MES Model-Driven Application Content

For complete system requirements and instructions about how to install a system to support MES model-driven application content and how to install or update the application content Work Tasks workflow packages, see the MES Model-Driven Application Content Installation Guide.

Extracted Installation Files Folder Structure

The folder structure of the MES model-driven application content installation files, after being extracted from the installation Zip file, is described below.

Top Level Folder

• Additional Files folder The additional files that support MES model-driven application content forms and workflows. The required additional files are installed automatically using MSI files when a package is installed. They are provided separately here as well, if needed.
• Hot fix folders
  • Work Tasks 2020 U1 hot fix AWT2020-U1-HTFX-7.1.2035.1 is required to use Chrome version 91 or later.
  • MES 2020 hot fix HF_1055331 is required to use the Quality Management package.
• Package files The MES model-driven application content package files.
• User documentation files The Readme, Installation Guide, and Developer Guide.

Additional Files Folders

• CSS The CSS files for all packages.
• DLL The DLL file for the Job Management Split control.
• Help The folders that contain the help files, by package.
• JS The javascript files for all packages.
• JSON The MES Web API JSON file.
• Locales The localized text files for all packages, organized by the locales of the supported languages.
• MDMSPLIT Image files for the Split control.
• MDMTHEME Image files that are used by forms and controls for all packages.
• MSI The additional package MSI files and the Language Installation MSI file.

Resolved Issues

The following important issue was resolved in this release, listed by its Change Request number.

In addition, the following issues were resolved:

• Attempting to edit an activity in the job management Cancel Job workflow (MDMCancelJobWorkFlow) caused an error to occur.
• When updating a package, the additional files might not be installed.
• Some messages in the job management utilization Split control had not been translated to the supported languages.
• If using Work Order Management while running Workflow Management 2019, using certain non‑English characters for work order and operation IDs could cause some work order and job actions, such as changing their status or deleting work orders, to fail.

Known Issues

Display Issues on Non-Windows Devices

MES model-driven application content has been optimized for web browsers on Windows devices. While Work Tasks does not support browsers on non-Windows devices, MES model-driven application content has been tested on a limited number of these devices (that is, Android and iPad tablets). Best results were found with Chrome in landscape mode (if the tablet device is used in portrait mode, you might experience limitations in the display of the forms). Future versions of MES model-driven application content will further address mobile device needs and support for the Work Tasks Pro application.

Using MES Model-Driven Application Content with InTouch OMI

If using MES model-driven application content with InTouch OMI, Active Directory user authentication must be used and token authentication must be configured for OMI.

Even if these requirements are met, there are some limitations that can make MES model-driven application content not usable with OMI. Workarounds are currently being investigated.

Russian Characters Being Passed Using the MES Web API

When Work Tasks uses the MES Web API for a Quality Management operation and the data that is being passed is in Russian characters, the operation fails. Further investigation and resolution of this issue is planned for the next release.

Quality Management Issues

• When saving sample results, the Verified Write feature is not currently supported.
• The superseding of quality results is not occurring.
• A finalized sample will appear in the Summary area until the form is refreshed.
• The following labels are not translated for languages other than English:
  • On the Sample tab Create panel, “current" and “custom"
  • On the Results tab Result Values panel, "min/default/max"

  If needed, you can install the required localization files and manually translate these labels. For more information about localization, see the MES Model-Driven Application Content Installation Guide.

Additional Known Issues

Following are additional known issues:

• During an upgrade to Work Tasks 2020 U1, MES 2020 (version 6.2), and Work Tasks 2020 U1 Connector and Extension for MES 2020 (version 6.7), errors might appear in the SMC Logger until you complete the Work Tasks 2020 U1 Connector and Extension for MES 2020 installation and configuration.
• When updating packages, a warning message might appear in the install window. Also, two errors and a warning message are logged in SMC. The error relates to the folders created in Forms to separate each package. The error does not affect proper functionality of package features.
• On a tablet only, when using the Gantt chart in the Utilization form, the Merge and Split pop‑up forms are not being called. The workaround is to use the buttons in the tool bar. A fix is expected to be available in the next release of Work Tasks.
• When a form lookup is called and no records are returned, a warning message is logged in SMC because the MES Web API returns a null instead of an empty JArray. This issue does not adversely affect the use of the form.

MES Model-Driven Application Content Documentation

The MES model-driven application content documentation set includes the following:

MES Model-Driven Application Content Installation Guide

Provides information about installing Work Tasks, MES, Work Tasks Extension and Connector for MES, Work Tasks Extension and Connector for System Platform, and Intelligence to support using the MES model-driven application content. Also provides information about installing or updating the MES model-driven application content packages.

Work Order Management Help

Provides information about using the Work Order Management form.

Job Management Help

Provides information about using the Job Management form.

Inventory Management Help

Provides information about using the Inventory Management form.

Quality Management Help

Provides information about using the Quality Management form.

MES Model-Driven Application Content Developer Guide

Provides information about how to use MES model-driven application custom controls in Work Tasks forms.