Introduction#
This document is a guide for planning, installing and configuring the Critical Manufacturing application.
- Preparation - Instructions and recommendations about how to prepare an infrastructure for installing Critical Manufacturing MES. It's not intended to be an exhaustive document about infrastructure but instead a quick guide on proven solutions for successfully deploying the solution.
- Installation - A visual walk-through of the installation wizard and the settings that must be entered before initiating a deployment.
- Post Installation - Best practices that are required to double check the health status of the solution and advanced configuration options that can be made after installation.
- Upgrade - The steps necessary to upgrade an existing installation.
- Removal - How to remove Critical Manufacturing MES from your system.
Should you require further assistance, please open a support ticket in the Critical Manufacturing Customer Portal at https://portal.criticalmanufacturing.com ↗
Target Audience#
This Installation Guide is intended for application administrators and should be used to support the Critical Manufacturing installation process.
Definitions#
The next table identifies some common terms used throughout the document:
| Acronym | Definition |
|---|---|
| ACL | Access Control List |
| AD | Active Directory |
| CMF | Critical Manufacturing |
| COM | Component Object Mode |
| DACL | Discretionary Access Control List |
| DB | DataBase |
| DWH | Data Warehouse |
| EFC | Electronic Failure Catalogue |
| HPC | High Performance Cluster |
| HTTP | HyperText Transfer Protocol |
| HTTPS | HyperText Transfer Protocol Secure |
| IIS | Microsoft Internet Information Services |
| IP | Internet Protocol |
| MS-DTC | Microsoft Distributed Transaction Coordinator |
| MSMQ | Microsoft Message Queue |
| NLB | Network Load Balancing |
| ODS | Operational Data Store |
| OLAP | Online Analytical Processing |
| OS | Operating System |
| SAN | Storage Area Network |
| SDDL | Security Descriptor Definition Language |
| SID | Security Identifier |
| SMTP | Simple Mail Transfer Protocol |
| URL | Uniform Resource Locator |
Table: Definitions
Naming Conventions#
The following conventions are applied throughout the document:
Info
Helpful hints to assist in particular situations.
Note
A note with important information.
Warning
A warning or a word of caution.
These callouts carry important information can be very useful. However, in some situations, other smaller icons are visible and should be regarded as a visual identifier that a larger information callout of the same type can be found below. These icons include:
| Convention | Callout |
|---|---|
 | Info |
 | Warning |
| Note |
Table: Snippet visual conventions
Other visual indicators are used in the documentation to indicate information on specific actions or operations found in the MES GUI:
| Convention | Description |
|---|---|
 | Described functionality is associated with the stated security feature |
| Icon that symbolizes an edit action | |
| Icon that symbolizes an add action | |
| Icon that symbolizes a remove action | |
| Icon that symbolizes a move up action | |
| Icon that symbolizes a move down action | |
| Icon that symbolizes the use of a camera or scanner | |
| Icon that symbolizes the use of a keypad | |
| Icon that symbolizes a browser modal window view action | |
| Icon that symbolizes a download action | |
| Icon that symbolizes a copy action | |
| Icon symbolizing PDF availability |
Table: Visual conventions
Documentation Set#
The complete Critical Manufacturing MES documentation set is available online at https://help.criticalmanufacturing.com ↗. The local MES stack does not include a copy of the Documentation Portal. It provides only instance-specific Reference documentation, which is available from Critical Manufacturing MES through the /reference route.
The online documentation set includes the following guides:
| Document | Target Audience | Description |
|---|---|---|
| User Guide | End users, application administrators, MES configurators, key users, and domain specialists | Describes the Critical Manufacturing MES graphical user interface and its functionality. |
| System Requirements | System administrators, infrastructure architects, cloud and platform engineers, IT procurement specialists, and pre-sales or solution engineers | Defines the prerequisites and supported configurations for installing and operating Critical Manufacturing MES. |
| Installation Guide | System administrators, DevOps and platform engineers, implementation consultants, partner deployment engineers, and database and infrastructure specialists | Explains how to plan, install, configure, upgrade, and remove Critical Manufacturing MES. |
| Operation Guide | System administrators, application administrators, SRE and operations engineers, database administrators, security administrators, and support engineers | Explains how to administer, maintain, secure, troubleshoot, deploy, and migrate Critical Manufacturing MES. |
| Tutorials | Key users, process and manufacturing engineers, training coordinators, functional analysts, and application configurators | Provides task-based guidance for configuring and operating Critical Manufacturing MES. |
Table: Guides available online
Note
The Developer Portal is also available online at https://developer.criticalmanufacturing.com ↗. It provides system integrators and developers with information about extending and customizing Critical Manufacturing MES, including the Design System, Data Dictionary, and API reference.
The documentation set also provides the following PDF documents:
| Document | File Name | Description |
|---|---|---|
| Installation Guide | InstallationGuide.pdf | A PDF export of the web-based Installation Guide. |
| Release Notes | ReleaseNotes.pdf | A description of the new features and changes in the release. |
| System Requirements | SystemRequirements.pdf | A PDF export of the web-based System Requirements. |
Table: Included PDF documents
Note
This PDF is an exported version of the web-based Installation Guide.
Document History#
This document was developed prior to the product release to manufacturing and as such, it cannot be guaranteed that all details included herein will be exactly as what is found in the shipping product. Critical Manufacturing cannot guarantee the accuracy of any information presented after the date of publication.
The date of the document changes whenever a new edition is released. However, it must be noticed that some product updates do not necessarily require document changes, and as such, versions of the product may be released without accompanying documentation and vice versa.
Licensing#
The Critical Manufacturing base license includes the Core module. All other modules are licensed separately.
