Industry Templates Deployment#

This document describes the configuration and deployment steps applicable to all industry templates developed within the CM MES:

• Electronics
• Semiconductor
• Medical Devices
• Industrial Equipment

Overview#

This guide covers the sequence of actions needed to place the selected template in the target system and highlights the key points to consider so that the deployment is completed correctly.

Deployment Approaches#

Industry templates can be installed either as standalone environments or as part of an existing customization project, depending on the desired setup.

Standalone Installation#

A standalone installation refers to deploying an industry template independently, without attaching it to any existing customization project.

In this setup, the template is installed on its own within a CM MES instance, allowing it to serve as a self-contained reference environment.

Project Dependency Installation#

Project Dependency Installation refers to deploying one or more industry templates as dependencies of an existing customization project.

In this scenario, the templates are installed into the project’s CM MES instance to provide the required industry-specific structures or functionalities that the project will build upon. Once deployed, the project can reference the template content directly.

Installation Instructions#

To install an industry template, the project instance must match the CM MES version of the target template.

The same rule applies when upgrading CM MES: the project instance must have the same CM MES version as the template for successful installation.

Container Installation#

In the context of container installation, the industry template can be deployed through CM DevOps Center.

There are two ways to perform the deployment: users can install a template as a customization package, suitable for ongoing project development, or as a deployment package, used when a CM MES instance is already installed and available as the target environment.

Installation as Customization Package#

1. In the CM Customer Portal, open the target environment and navigate to Views then select Installation.

   

2. On the Target Package tab, select the deployment package that matches both the customization project’s CM MES version and the target industry template version.

   

3. Next, navigate to Configuration and then General Data. Copy all template package files to the environment’s Installation Data Path, then update the path in DevOps Center accordingly.

4. The Package to Install field must reflect the template you are installing. In this field, the tag <template-name> should be replaced with the name of the template being installed, and the tag <M-m-p> corresponds to the template version, representing major, minor, and patch values.

   

5. After defining these fields, perform a final check to ensure the template packages are correctly placed in the Installation Data Path and verify that the template version is specified correctly.

6. Proceed with the installation, and once it is completed, the message Deployment Succeeded should appear.

Standalone Installation#

1. In the CM Customer Portal, open the target environment and navigate to Views then select Installation.

   

2. On the Target Package tab, select the industry template deployment package that matches the customization project and ensure it also matches the target template version.

   

3. Proceed with the installation, and once it is completed, the message Deployment Succeeded should appear.

Virtual Machine Installation#

In the context of a virtual machine environment, installing or upgrading an industry template requires running the CM MES setup wizard included in the ISO file.

1. To begin, copy the template packages to the virtual machine in a temporary folder or an existing file share.

2. After opening the CM MES setup wizard, select the Switch to Offline button and proceed to Install or Upgrade.

   

3. Next, in the Package Sources tab, select Add and define the path where the installation files are located. Select the appropriate location type in the field below the path.

   

4. After configuring the Package Sources, select the Next button to proceed to the Package Selection step.

5. In this step, select the package you want to install. It should match the name of the template package and its corresponding version.

   

6. Once everything is ready, select the Next button and complete the required setup configurations. In the Summary step, verify that all necessary packages are listed and that the correct version is displayed.

   

7. Finally, select the Next button and monitor the installation process. The process should complete successfully when finished.