Installation#
Installing Critical Manufacturing MES is a streamlined process carried out directly through the Critical Manufacturing DevOps Center, available from the Critical Manufacturing Customer Portal ⧉. This environment provides a centralized, guided experience designed to help you deploy, configure, and maintain your MES landscape with confidence.
In the section below, you'll find a step-by-step overview of how to perform a full installation of the core MES platform. Additional details on optional modules and complementary components are also provided, allowing you to tailor your installation to the needs of your operation.
Info
If you're looking for broader information on prerequisites, architecture, or infrastructure-related topics, be sure to explore the comprehensive DevOps Center documentation ⧉, which offers deeper insights into setup, best practices, and system administration.
In this guide you are going to create an MES Customer Environment in an existing Customer Infrastructure with an Infrastructure Agent already deployed and connected to the DevOps Center. Let's consider the Infrastructure Agent with version 11.1.0. This example is configured for an OpenShift v4.18 cluster.
-
Load the Environments section in the main page of the Customer Infrastructure and select Create. This opens a transaction wizard.
-
Set a Name, a Type and a Site. Select Create.
-
The Customer Environment is now created in the system and ready to be used. The current page should now be its installation view where it is possible to start configuring. The first step group is named Target and is related with the configurations' base package and version, opt-in features and the deployment target.
-
In the first step, named Package, you can define the base package and version along with other metadata. Set the following values and select Next:
- Deployment Package - base package to be used. If you are installing a Critical Manufacturing MES 11.1.0, set the value to
MES 11.1.0.
Upgrade Warning
If you are choosing version 11.1.5, we strongly recommend choosing the latest available patch, as this version contains a known issue that may lead to data loss in the ClickHouse ODS database, impacting both CDM and DWH database tables.
- Configuration Level - different levels which will have an impact in how many configurations will be asked and are possible to configure. Set to
Advancedso that you are able to configure everything that is currently possible. - License - license for the Critical Manufacturing MES installation. Select an available license.
- Deployment Package - base package to be used. If you are installing a Critical Manufacturing MES 11.1.0, set the value to
-
Now configure the base package with opt-in features. These can vary based on the license modules and on the base package and version. The available ones for a Critical Manufacturing MES 11.1.0 are the following:
-
External dependencies mode - different modes for ClickHouse, Kafka, RabbitMQ, and S3. These may be:
- None - ClickHouse, Kafka, RabbitMQ, and S3 are not installed within the MES stack. These components must be available externally to the MES stack.
- Broker and Storage - ClickHouse and Kafka are not installed within the MES stack, but RabbitMQ and S3 are installed within MES stack (not recommended for Staging or Production environments).
- All - ClickHouse, Kafka, RabbitMQ, and S3 are installed within the MES stack (not supported in Staging or Production environments).
-
Database Mode - different modes for the database installation. These may be:
- None - base mode where only the Online database is installed in an external MSSQL Server.
- MES Analytics - enhanced version of the previous mode where more features are available but an external MSSQL Server is still required. These features are: Operational Data Store (ODS), Data WareHouse (DWH), Reporting and Analysis Services.
- MSSQL Server - similar to the None mode but instead of relying on an external MSSQL Server, a container is deployed along with the rest of the stack, which runs a containerized version of MSSQL Server.
-
Connect to a central Traefik - configures the stack's Traefik reverse proxy to not be exposed and instead connect to the Traefik that is included in the Infrastructure Agent. This is very useful as many Customer Environments can be deployed and their only entrypoint is the Infrastructure Agent's Traefik reverse proxy, which means less open inbound ports and less networking configurations. When creating a Customer Environment in a Customer Infrastructure with an Infrastructure Agent, this option will be selected by default.
To exemplify the feature, keep the Database mode set to
MES Analytics, the External dependencies mode set toNoneand the opt-in feature Connect to a central Traefik set totruesince you have an Infrastructure Agent configured and running.Set the values as shown in the example above and select Next.
-
-
Set the Target to
OpenShift Remoteas you are using OpenShift as your remote Deployment Target. Select Next. -
Read and Understand all the licenses that are displayed and select Next, which advances to the next step group, Configuration.
-
-
By now, the base application and its features are set. Before starting the deployment process, you need to configure the base application and features with the required data. The following steps address the available configurations for each different part of the system. Bear in mind that the Configuration Level and License have an impact on how many steps and parameters are shown along with the available Critical Manufacturing MES features.
Note
For configuration purposes, the character double quotes ( " ) is not allowed to be inserted on input fields.
-
General Data - general information regarding the system.
- Details
- System Name - name of the system. Also used to set the database(s) name(s).
- Tenant Name - tenant name of the system. Must not contain blank spaces.
- Access Information
- Application Public HTTP Address - public HTTP address to access the environment. Remember that when using Domain Name System (DNS) providers or Transport Layer Security (TLS) via certificates, such as in the case of an Infrastructure Agent, this field must comply to their specifications, for example, if configuring a wildcard certificate for
*.mydomain.comor using a Cloudflare for that same domain, this field must be set to<mysubdomain>.mydomain.com. Do not specify the HTTP Port, since the Agent's Traefik already has the ports 80 and 433 configured and these are the ones that are going to be used. For OpenShift, we should use its native routing mechanism which generally follows the cluster's certificate and domain as well instead of relying on DNS and TLS validation at the Infrastructure Agent or another level. - Application Public HTTP TLS Enabled - set to
trueif this environment has TLS enabled. This is just for internal usage, the actual TLS configuration must be set via DNS providers or certificates.
- Application Public HTTP Address - public HTTP address to access the environment. Remember that when using Domain Name System (DNS) providers or Transport Layer Security (TLS) via certificates, such as in the case of an Infrastructure Agent, this field must comply to their specifications, for example, if configuring a wildcard certificate for
- Install Information
- Package to Install - root package to be installed by the Environment Manager. If empty, it will use the default base package for the version. This can be set to override and install a different package, for example, a customization package.
- Installation Data Path - the path that the MSSQL Server can use to access the Installation Data volume. When using an external MSSQL Server, this volume must be a shared location between it and the containers.
- Deployment Mode - The deployment mode can be Transactional (if the installation fails, the database is guaranteed to be in a stable state and the installation can be retried) or it can be Non-Transactional (if the installation fails, the database is left in an intermediate state and it needs to be restored before retrying, requiring downtime. It is much faster than the Transactional mode).
- Details
-
Database - information regarding database(s) connection(s).
- Online - online database information.
- Address - database address. Applies to Database Modes: None and MES Analytics.
- Port - database TCP port. Applies to Database Modes: None and MES Analytics. Only set this if the database listens on a fixed non-default port. For named instances, this must be left empty as they use dynamic ports.
- Username - database SA user. Applies to Database Modes: None and MES Analytics.
- Password - database SA user password. Generated when in database mode MSSQL Server. Applies to Database Modes: None, MES Analytics and MSSQL Server.
- File Location - location where the database files will be persisted. Applies to Database Modes: None and MES Analytics.
- Database Always On Enabled - whether to enabled Always On mode. Applies to Database Modes: None and MES Analytics. Feature not available with MSSQL Server database mode.
- External Port - port to expose the database for remote access. Applies to Database Modes: MSSQLServer.
- Online Data Store (ODS) - ODS database information. Applies to Database Modes: MES Analytics.
- Address - database address. If left blank, it will default to the Online database value.
- Port - database TCP port. If both this and the Address are left blank, it will default to the Online database value. Only set this if the database listens on a fixed non-default port. For named instances, this must be left empty as they use dynamic ports.
- Username - database SA user. If left blank, it will default to the Online database value.
- Password - database SA user password. If left blank, it will default to the Online database value.
- File Location - location where database files will be persisted. If left blank, it will default to the Online database value.
- Data WareHouse (DWH) - DWH database information. Applies to Database Modes: MES Analytics.
- Address - database address. If left blank, it will default to the Online database value.
- Port - database TCP port. If both this and the Address are left blank, it will default to the Online database value. Only set this if the database listens on a fixed non-default port. For named instances, this must be left empty as they use dynamic ports.
- Username - database SA user. If left blank, it will default to the Online database value.
- Password - database SA user password. If left blank, it will default to the Online database value.
- File Location - location where database files will be persisted. If left blank, it will default to the Online database value.
- Analysis Services (AS) - AS database information. Applies to Database Modes: MES Analytics.
- Address - database address.
- Port - database TCP port. Only set this if the database listens on a fixed non-default port. For named instances, this must be left empty as they use dynamic ports.
- Username - Windows authentication user.
- Password - Windows authentication user password.
Example:
- Online - online database information.
-
Dependencies - information regarding external MES dependencies.
- ClickHouse - ClickHouse information. Applies to External dependencies mode: None/Broker and Storage
- Address - The hostname or IP address of the ClickHouse server.
- HTTP Port - The HTTP port used by ClickHouse.
- TCP Port - The TCP port used by ClickHouse.
- Username - The username for ClickHouse authentication.
- Password - The password for ClickHouse authentication.
- Validate certificates - Toggle to enable or disable server certificate validation.
- Kafka - Kafka information. Applies to External dependencies mode: None/Broker and Storage
- Bootstrap Servers - The Kafka bootstrap servers.
- Authentication Method - The authentication method used by Kafka (None, mTLS, SASL_SSL Plain)
- Ssl Certificate Authority - The certificate authority (CA) file for validating the Kafka server's certificate. Applies to Authentication Method: mTLS and SASL_SSL Plain.
- Ssl Certificate - The public key certificate used for client authentication against Kafka. Applies to Authentication Method: mTLS.
- Ssl Key - The private key certificate used for client authentication against Kafka. Applies to Authentication Method: mTLS.
- Validate certificates - Toggle to enable or disable server certificate validation. Applies to Authentication Method: mTLS.
- Kafka Username - The username for Kafka authentication. Applies to Authentication Method: SASL_SSL Plain.
- Kafka Password - The password for Kafka authentication. Applies to Authentication Method: SASL_SSL Plain.
- RabbitMQ - RabbitMQ information. Applies to External dependencies mode: None
- Host - The hostname or IP address of the RabbitMQ server.
- Port - The port used by RabbitMQ.
- Virtual Host - The RabbitMQ virtual host name.
- Username - The username for RabbitMQ authentication.
- Password - The password for RabbitMQ authentication.
- Use TLS - Toggle to enable or disable TLS for RabbitMQ communication.
- Ssl Certificate - The public key used for client authentication against RabbitMQ. Applies to Use TLS: true.
- Ssl Key - The private key used for client authentication against RabbitMQ. Applies to Use TLS: true.
- Ssl Certificate Authority - The certificate authority (CA) file for validating the RabbitMQ server's certificate. Applies to Use TLS: true.
- Validate Certificate(s) - Toggle to enable or disable server certificate validation. Applies to Use TLS: true.
- External Storage (S3-compatible) - S3 information. Applies to External dependencies mode: None
- Address - The hostname or IP address of the S3-compatible storage service.
- Bucket Name - The name of the S3 bucket to be used.
- AccessKey Id - The access key ID for authenticating with the S3-compatible storage.
- Secret Access Key - The secret access key for authenticating with the S3-compatible storage.
- Use Path Style - Toggle to enable or disable path-style access for S3-compatible storage.
Example:
- ClickHouse - ClickHouse information. Applies to External dependencies mode: None/Broker and Storage
-
Security - information regarding the Security Portal.
- Domain
- Client Id - System's Auth Client Id. Defaults to MES and cannot be changed.
- Active Directory
- Enable - whether to enable the Active Directory authentication strategy.
- Domain - default domain where user information is stored.
- Address - AD address to connect.
- Base DN Address - base search query.
- Username - user to use for searching.
- Password - user password to use for searching.
- Use SSL - whether to use SSL.
- Port - AD port to connect.
Example:
- WebAuthn
- Enable - whether to enable the WebAuthn authentication strategy.
- Open ID Connect
- Enable - whether to enable the OpenID Connect authentication strategy.
- Display Name - The display name of the strategy in the Security Portal. Defaults to OpenID.
- Client ID - ID of an existing OpenID provider's auth client.
- Metadata URL - URL of the OpenID provider metadata.
- Session Options
- Session Duration - the duration while a session is still valid for authentication.
- Show Remain Signed In - whether the option to remain signed in via a session strategy is shown to the user after a login.
- CORS (Cross-Origin Resources Sharing)
- Allowed Origins - When set, will configure some client containers, such as the UI, Help and Security Portal, with the domains specified here, effectively blocking cross-domain requests by the browser.
- Domain
-
Reporting Services - Reporting Services access information. Applies to Database Modes: None and MES Analytics.
- Reporting Services
- Web Portal URL - URL of the MSSQL Reporting Services Web Portal.
- Web Service URL - URL of the MSSQL Reporting Services Web Service.
- Username - user with read and write access for the MSSQL Reporting Services.
- Password - user password.
- Reporting Services
-
Cloudflare Configs - Cloudflare configuration to be used to create a subdomain for the current Customer Environment. Since we're not using Cloudflare to configure DNS, skip this step.
-
Printing - access information of the printing component service or to use a CUPS server. Currently, the service only works in Windows and it is not deployed in a containerized stack. It must be installed using the Deployment Framework in a Windows machine.
- Access Information
- Use CUPS - Set to true if using a CUPS server.
- Printing Service URL - URL to a printing service running in a Windows server. Available if Use CUPS is set to false.
- CUPS URL - URL of a CUPS server. Available if Use CUPS is set to true.
- Access Information
-
ECAD - access information of the ECAD component service. Currently, this service only works in Windows and it is not deployed in a containerized stack. It must be installed using the Deployment Framework in a Windows machine.
- Access Information
- HTTP Address - HTTP address to connect to the ECAD service.
- HTTP Port - HTTP port to connect to the ECAD service.
- Access Information
-
IoT Data Platform - configurations for the IoT Data Platform:
- Event Strategy
- Event Handler Strategy - either Kafka itself or an SQL Queue.
- Event Strategy
-
Email - email server information for the system used by several features.
- Email Server
- From - email address to be used to send emails.
- Address - email server address.
- Port - email server port.
- TLS Enabled - whether the email server is configured with TLS or not.
- Username - email server user.
- Password - password of the email server user.
- Support Email Address - email address of the local support team to send emails to.
- Email Server
-
SAP - ERP SAP connection information:
- Access Information
- Enabled - whether the connection to a SAP system is enabled.
- Address - address of the SAP host.
- System Number - SAP system number.
- Service Name - name of the gateway in SAP.
- Program ID - SAP Program ID.
- Username - user to connect to the SAP system.
- Password - user password to connect to the SAP system.
- Client Number - SAP Client Number.
- Connect License - theobald ERP connect license.
Example:
- Access Information
-
Service Resources - Definition of resources used by stack. You can define the memory (GB/GBi) and CPU (number of virtual cores) needed to deploy the specific container and maximum available to it. Also, you can specify the number of replicas to be deployed. Note that, in the upper right corner, there is a button to restore these configurations to their default values, as defined in the deployment package manifest, depicted in the image below.
-
Services - generic stack-wide configurations that vary depending on the base deployment package and deployment target.
- Environment Manager
- Stop Installation on External Components Validation Failure - Stops installation if validation against external components fails.
- DNS - allows to set custom DNS domains to use for resolving host names. It's recommended to use Fully Qualified Domain Names (FQDN) everywhere instead of short names and configuring this setting since it will impact the performance of hostname resolving and may even lead to unexpected issues.
- Container Image Registry Override - this setting can be used to override the image registry used to pull container images from. Useful in the case that a private registry is preferred.
- Custom Certificates - allows adding new certificates to the running containers. It is possible to add more than one certificate, and all of them will be injected into the containers that accept this feature. Before starting the deployment, a secret for each certificate must be created with the content of the certificate (same logic as external secrets). It is necessary to insert the name of the created secrets in this field. If there are proxies performing SSL Inspection on the network traffic, the respective certificate should also be added through this feature.
- Environment Manager
-
Volumes - configuration for each required volumes. The entries here depend on the deployment package, database mode and opt-in features.
- Cube - repository for cube models. Applies to Database Modes: MES Analytics
- Dagster - repository for Dagster Data files. Applies to Database Modes: MES Analytics
- ML Platform Agent - repository to store the Ml models binaries that are deployed and in use.
- ML Platform Training - repository to store the ML models' configurations and other associated data such as CSV datasets, transformed data and binaries.
- Redis Data Folder - repository for the Redis Data files. Recommended to be a local high-performance disk.
- MSSQL Server Data - volume to persist the database files to. Currently, MSSQL Server does not support restoring a database when persisting the data to a Windows directory. Ensure that the environment is running on Linux. Applies to Database Modes: MSSQL Server. Recommended to be a local high-performance disk.
- Grafana Folder - repository to persist the Grafana's data.
- Installation Data - shared location between the MSSQL Server and the Environment Manager. When using an external database, the shared path must point to the same location as the Installation Data Path setting.
- Connect IoT Repository Share - repository for Connect IoT compressed files.
- Rabbit Data Folder - repository for RabbitMQ Data files. Applies to External dependencies mode: All/Broker and Storage
- Rabbit Log Folder - repository for RabbitMQ Log files. Applies to External dependencies mode: All/Broker and Storage
- Storage Data Folder - repository for Storage Data files. Applies to External dependencies mode: All/Broker and Storage
- Kafka Data Folder - repository for Kafka Data files. Applies to External dependencies mode: All. Recommended to be a local high-performance disk.
- ClickHouse Data Folder - repository for ClickHouse Data files. Applies to External dependencies mode: All.
- ClickHouse Log Folder - repository for ClickHouse Data files. Applies to External dependencies mode: All.
- Documents Folder - location where the Critical Manufacturing MES documents and attachments are persisted to. Advised to be a shared location, so that when having more replicas of the Critical Manufacturing MES host, the containers maintain data consistency.
- Logs Folder - location to persist logs as files. This is an optional volume, you can set this volume to the type None in order to not use it.
Each volume can be configured with a different volume type. These types are Deployment Package specific. For more information on each type and their configurations, see Kubernetes Volumes Configuration documentation. Also, check the requirements for each volume System Requirements ⧉.
For local volumes, it's recommended to use dynamic provisioning so that all local paths are handled by the cluster and not by you. For more information, see Local Volumes with dynamic provisioning ⧉.
-
-
Selecting Next will trigger the deployment process. It is automatic and you are provided with feedback to follow during the installation.
If everything is correct, the last screen should present you with the deployment Summary, which includes information such as the outcome, admin credentials to use to access the environment, and the URL.
Accessing this URL should present the Critical Manufacturing MES to be used. In this case, you must log in and because this is the first login, the credentials in the Summary must be used to access the system and the password must be reset after logging in:
After resetting the password, you'll be redirected to the Home Page which will show there are no Apps installed:
Info
At this stage, only Administrator users have access to the MES. To allow other users to access it, you need to assign them the MES OAuth Role in the security page:
Optional Component Installation#
The Critical Manufacturing MES installation procedure is supported by an installation wizard that is described step-by-step in this section. Depending on whether the installation is performed with or without Internet access, and on the chosen installation package, the setup's interface may present changes. Therefore, you may notice slight differences between the screenshots included in this guide and the version being installed.
Note
Random errors may occur during the Critical Manufacturing MES installation process if it is initialized using a blocked ISO file. This occurs when Windows Attachment Manager marks ISO files as blocked (more information here ⧉).
Before mounting and starting the installation, execute the following procedure to unblock your ISO file:
- Open the folder containing the ISO file on Windows Explorer.
- Right-click on the file and select the Properties option.
- Select the Unblock option, if available.
- Select the Apply button and then the OK button.
The image below shows the first screen of the setup wizard:
All screens of the setup wizard are divided in three areas:
- The top area displays all the steps of the installation, and the current step is highlighted. It also displays the name of the user who is logged in to the Customer Portal or Offline. If the setup process is launched in Online mode without previous valid user authentication for the current user in the Customer Portal, a separate browser tab window is automatically opened for proper user authentication.
- The middle area shows the information setup step and the text boxes to be filled out with the required setup information.
- The bottom area is the navigation area. In this navigation area, you can go to the next screen or return to the previous one. It is also possible to cancel the installation, thus aborting the setup. The Install button is only enabled when all the configurations are filled out, and the setup is then ready to start.
Completing the text boxes may be mandatory (flagged by ). Throughout the steps, the existing groups may have an associated Validate button which if selected, will check if the entered value is within the expected ranges.
See the example below:
Main Installation Process#
If you need to backup existing databases, visit Database Backup and Restore for a specific guide for this process.
The first step of the installation process is the License Agreement. Select Install or Upgrade to get started.
License Agreement#
In this step, you need to read and agree to the Critical Manufacturing License Agreement.
It is necessary to accept the License Agreement to continue with the installation, otherwise the wizard will display an error message:
To accept the License Agreement select I agree to the License Agreement. Then, select Next to continue.
Package Sources#
In the Package Sources step, you can add a location to search for installation packages. You can also add multiple package sources, and dependencies are resolved using the provided source order. If the setup is running in Online mode, the default process will add the local packages folder, and the server, to the list.
The package source can either be a Server or a FileSystem. The Server should be an NPM compatible endpoint. The FileSystem should be a folder accessible by the user running the setup, when the installation is started from the installation media, or the user running the master agent windows service is using a master only or master/slave configuration.
Select Next to continue.
Package Selection#
In the Package Selection screen, you must select the product and the version to be installed. The available packages are:
- Cmf.ConnectIoT.Packages: Connect IoT packages to upload to a supported Package Repository.
- Cmf.DataPlatform.Consumers: Consumers to use with Critical Manufacturing IoT Data Platform. - remove
- Cmf.ECADService.Server: Critical Manufacturing MES ECAD (Electronic Computer-Aided Design) server to run as a service.
- Cmf.PrintingService.Server: Critical Manufacturing MES Printing Service.
For Critical Manufacturing Connect IoT packages there is only one available option. The product names, versions, and installation options can vary according to the installation packages available on the installation media.
Choose the package you wish to install and select Next to continue.
ECAD Service#
Before installing the ECAD Service, ensure that the Visual C++ Redistributable Packages for Visual Studio 2013 are installed. Afterwards, the ECAD Service can be installed using several different configurations, as shown in the image.
Info
The Import Installation File step allows you to load a file with the configuration of the installation. It will automatically fill out the information existing in the selected file.
Configure the Online Database and Services User Account settings:
Configure the settings for the ECAD Service. The PCBI Floating Service Address should use the default IPv4 address and the PCBI Floating Service Port can use any available port.
The current way to get the PCBI Floating Service License is by requesting a license file using the Server ID.
If you do not have the PCBI Floating Service License you can keep this field empty and follow the manual steps below (after the setup finishes).
Contact the System Administrator by sending the Server ID to generate the license.
When you get your license, place the file inside a folder and make sure that the configuration properties of ECAD are duly set. These configurations can be found inside the ECAD folder named config.xml and Cmf.Navigo.ECADServiceAPI.exe.config.
Restart the PCBI Floating Server and Critical Manufacturing ECAD services.
Note
If you have multiple environments in the same machine, all environments should point to the same PCBI Floating Service and only one PCBI Floating Service can be started.
Confirm the settings and select Next, where you will be shown the summary of the component you are about ot install. You have the option to force a reinstallation if you have previously installed a version of this component in your system.
Select Next to complete the installation process configuration.
In the Complete Installation screen, you can export all the current installation configuration data (including licenses) to a file. To export the current configuration data, select Export and then choose a location and a file name.
Select Install to start the installation process.
Printing Service#
The Critical Manufacturing MES Printing Service is a standalone service that enables containerized environments to perform printing jobs using printers configured in a Windows machine.
To achieve this, the Printing Service must be installed in the Windows machine that has access to the printers (which may need permissions to be used by the user running the service). Additionally, when deploying the environment using DevOps Center, the user must select the option to use the external printing service and configure the URL to the Windows machine running the service.
Info
This service is standalone and not coupled to a specific MES installation, which means that multiple MES installations can share the same Printing Service.
The Printing Service is installed using the same setup process as the traditional installation and selecting the Cmf.PrintingService.Server option in the Package Selection screen.
Info
The Import Installation File step allows you to load a file with the configuration of the installation. It will automatically fill out the information existing in the selected file.
After selecting the Printing Service package, the user must fill (or import from a parameters file) the following information:
- Root Installation Directory - The Directory where the Printing Service will be installed.
- Services User Account - The user account that will be used to run the service.
- Port - The port where the service will be exposed.
Confirm the settings and select Next, where you will be shown the summary of the component you are about ot install. You have the option to force a reinstallation if you have previously installed a version of this component in your system.
In the Complete Installation screen, you can export all the current installation configuration data (including licenses) to a file. To export the current configuration data, select Export and then choose a location and a file name.
Select Install to start the installation process.
Update Product License#
The Product License can be updated using the Critical Manufacturing setup program in three ways:
- Setup - Online
- Setup - Offline
- Command Console
For the Setup - Online, follow the steps below:
- Mount the Critical Manufacturing MES ISO.
-
Run the Setup.exe:
-
Select Update License:
-
You will be redirected to the Critical Manufacturing Customer Portal and will need to log in with a User that has access to Critical Manufacturing Licenses:
-
Import the
.jsonparameters file used with the original installation: -
Select Next to continue.
-
The Environment Data screen will contain the System Name and the connection to the Online DataBase:
Note
You can also set the parameters manually if you know the settings.
-
Select Next to continue.
-
Select the license you want to use:
-
Proceed with the Update:
For the Setup - Offline, follow the steps below:
-
Before selecting Update License, select the Switch to offline option:
-
After importing the
.jsonparameters file used with the original installation or manually setting the Environment Data, an activation code is provided: -
Copy the activation code.
- With a different device, log in to the Critical Manufacturing Customer Portal with a User that has access to the required license.
-
Open the Licenses menu and select My Licenses:
-
From here you can:
- Select the Activate License in the top ribbon:
- Paste the Activation Code from the Setup - Offline update license operation:
- Then select the required Environment License and Activate it:
-
A license code will be provided and you should Download or Copy it:
-
Use the license code with the Setup - Offline installer, accordingly, and then select Update:
For the Command Console, follow the steps below:
Note
This method requires that you know the License Id or the License Name. You also need to have a valid json file with the Environment data (original installation json file), and online access to the Critical Manufacturing Customer Portal.
- Mount the Critical Manufacturing MES ISO.
-
Open a console at the mounted ISO root:
-
Run the CmfDeploy.exe and provide the
licenseIdand theparameters:- Command for reference:
.\tools\CmfDeploy.exe installlicense --licenseId="LicenseName" --parameters="OriginalInstallationJsonFilePath" - Example for reference:
.\tools\CmfDeploy.exe installlicense --licenseId="CMF - CMFLAB_Development_v7.0.0_ED20230901" --parameters="C:\Users\Administrator\Downloads\installation 7.0.2.json"
- Command for reference:
-
You will be redirected to the Customer Portal and will need to log in with a User that has access to the provided License. What follows is a successful output example for this operation:



























































