Skip to content

Getting Started#

The complete Critical Manufacturing MES documentation set is available in the online Critical Manufacturing Documentation Portal ↗. The local MES stack does not include a copy of the portal. It provides only instance-specific Reference documentation, which is available from Critical Manufacturing MES through the /reference route.

The Documentation Portal is organized into the following guides:

  • System Requirements - defines the prerequisites and supported configurations for installing and operating Critical Manufacturing MES.
  • Installation Guide - explains how to plan, install, configure, upgrade, and remove Critical Manufacturing MES.
  • User Guide - describes the Critical Manufacturing MES graphical user interface and its functionality.
  • Operation Guide - explains how to administer, maintain, secure, troubleshoot, deploy, and migrate Critical Manufacturing MES.
  • Tutorials - provides task-based guidance for configuring and operating Critical Manufacturing MES.

Note

The Developer Portal ↗ is also available online. It provides system integrators and developers with information about extending and customizing Critical Manufacturing MES, including the Design System, Data Dictionary, and API reference.

User Guide#

If you're new to our MES, we recommend starting with the General Concepts section on the User Guide. Take the time to explore this section thoroughly as it will help you understand how to take full advantage of our comprehensive User Guide. This guide mirrors the MES graphical user interface, as shown in the images below. For every Entity (e.g., Calendar, Flow, Material,...), you'll find a dedicated section in the User Guide.

MES GUI

User Guide

For every Entity (e.g., Transfer Order), you'll have a landing page providing an overview, connections, and dependencies with other MES Entities.

Screenshot showing a user interface with tabs labeled "User Guide", "Materia Logistics", and others, on a transfer order landing page.

For each Entity, a list of the available pages and operations is provided, divided into three main parts:

  • Main Page, offering a detailed explanation of everything you can do from that page, including other accessible views (e.g., Transfer Order Page).

transfer_order_page

  • Generic Operations, which are common to all entities (with particular differences for each entity);
  • Specific Operations, which are uniquely available for that entity.

Screenshot showing the available pages for a specific operation, including "Transfer Order" and "Get Started".

Make the Search Field your Best Friend#

Our Search Field is your ultimate tool for finding what you need quickly. Here are some tips to help you get the best results:

  • Use as a wildcard anywhere in the search term (e.g., autom)
  • Use + before a term to mark it as mandatory (e.g., material +defects)
  • Use - before a term to exclude the word from results (e.g., maintenance activity -order)
  • Enclose multiple terms with " " to search for exact phrases (e.g., "combine material")

Explore related topics by utilizing Tags found above each page. Simply click on a tag to navigate to a page with related content options.

Search with Tags

These Tags will guide you to additional pages where you can access content related to your area of interest.

Tags page