Demo Context
This performance-insight-clean-in-place-demo is part of the Getting Started with Production Optimization solution and is currently available for U.S. customers only.
- Evaluating Cleaning Processes in Production Introduction
- Prerequisites
- Configure Applications
- Configuring a CIP Analysis
- Overview of CIP Analysis
- Detail View of CIP Analysis
- Defining a Golden CIP
- Score Calculation
- Contribution
- Licence and Legal Information
Clean-in-place (CIP) analysis provides transparency into cleaning processes executed in production lines.
Performing CIP analysis can lead to:
- ⏱️ Time Savings – Higher equipment availability due to reduced cleaning duration.
- 🌱 Resource Efficiency & Sustainability – Significant reduction in water, energy, and chemical consumption.
- 🧪 Food Safety & Quality – Continuous monitoring and validation of CIP performance and hygiene.
CIP process parameters are collected from various systems through communication protocols such as OPC UA, SIMATIC S7, and Ethernet IP.
The configuration of the CIP analysis automatically generates a dashboard, accessible via the home module or through a specific selected asset.
Results are presented as:
- An overview dashboard
- Detailed process views
This enables users to obtain a complete overview of all executed processes or drill down into single process data.
By defining a Golden CIP, process comparisons can be made to identify bottlenecks or optimization opportunities.
In this demo, we will use Flow Creator to simulate the source data for the CIP.
- Setting up a working Industrial Edge Hub / Industrial Edge Management / Industrial Edge (Virtual) Device environment (out of scope for this tutorial)
- Installing all required apps on the Industrial Edge (Virtual) Device (out of scope for this tutorial)
- Flow Creator - v1.18 or newer
- Databus - v3.0.2 or newer
- IIH Essentials - v2.0.0 or newer
- Performance Insight v1.18.1 or newer
- flow-creator-flows.json - Contains the Node-RED code to be deployed in Flow Creator. It simulates a CIP process and sends emulated production data to the Databus.
- iih-essentials-backup-config.json - IIH Essentials configuration file that contains the configuration data for setting up the data points in IIH Essentials.
We now have to configure the applications so that they can work together. We need to achieve the following:
- Databus is configured to provide a topic
ie/#with username and password for read/write access. - Flow Creator needs to be configured by loading script files.
- IIH Essentials needs to be loaded with the configuration for the CIP demo (data points). The project comes with a configuration file to use for this.
We have to configure the Databus to handle a topic group ie/#. Note that the # is a placeholder symbol. We configure the Databus for any topic that starts with ie/. This is done from the IEMC via the Data Connections tab.
Step 1: Click the Data Connections tab
Step 2: Click the Databus icon
Step 3: Select the Edge Device and click the Launch button
Step 4: Click the Users (+) button
On the next page, add a new user with edge as username and password (both the same). Then create a topic ie/# with Publish and Subscribe permissions for the user "edge".
Username: edge
Password: edge
Topic name: ie/#
Permission: Publish and Subscribe
Step 4: Save username, password, and topic
In this step we import the Flow Creator script that simulates the data of CIP process. It is basically a Node-RED workflow. For this, navigate to the "Data Connections" tab in IE(V)D and select the Flow Creator app.
Step 1: Click the Flow Creator icon
From the right corner 3 lines button select Import button.
Step 2: Click the 3 lines button
Select the flow-creator-flows.json file to upload and click Import button.
Step 2: Click the Import button
Then, the flows are shown in the web UI, click the mqtt component to figure the node properties.
Step 2: Click the mqtt component
After that, click the pencil icon next to the Server text box.
Step 3: Click the pencil icon
Then, click the Security tab and enter the username and password.
The username and password are the ones previously configured in IEMC, and both are set to edge.
Step 4: Enter the username and password
Click the Start sending data component, check inject once after 0.1 seconds. Then, set repeat interval every 1 seconds.
Step 5: Configure the injection interval.
Click top right corner Deploy button，then, click the blue injection button in sequence.
Step 6: Deploy the flows
Step 7: Click the blue inejction buttons
After having deployed the flow, we have to make sure that the Databus connection is set up correctly. This is done by injecting a simulation datapoint and a timestamp by clicking on the corresponding buttons in the flow. The connected MQTT output nodes should show a green "connected" flag.
If the green light does not show up double click on the MQTT output nodes and make sure that they
are configured correctly with the username and password of the databus user edge which we
configured in the previous section 3.1.
Note
Note that the core logic for creating the data is implemented within the function "Simulation". Feel free to open the function and review the JavaScript code.
The IIH Essentials app must be configured to read the datapoints from the MQTT topics which we configured in the Databus (see Section 3.1.).
Step 1: Open IIH Essentials app from your Edge Device
Click on Settings and open the Databus setting, enter the username and password configured in the Databus (see Section 3.1.).
Step 1: Configure the databus
Click on Settings and open the group Backup and restore:
Step 2: IIH Essentials Backup and Restore
Select the iih-essentials-backup-config.json file and click the Upload button.
This will configure the IIH Essentials to handle the incoming MQTT data and providing it to the CIP demo.
Then, in the Manange Data, CIP Data, you can find all the simulated tags.
Step 3: Explore CIP Data
Each asset can have a CIP analysis dashboard automatically generated based on user-defined settings.
Once configured, the asset is marked as in use and reflected in billing.
- Select an asset in My Plant
- Click Add Dashboard
- Select CIP Dashboard
- The CIP Configuration view appears
- Choose a default time period (from predefined configuration)
- Select a calculation cycle to influence parameter scoring
- Define context parameters:
- CIP ID → Unique process identifier (mandatory)
- Process ID → Type of cleaning process (optional)
- Step ID → Cleaning phase identifier (optional)
- Select core process parameters:
- Temperature
- Concentration
- Flow Rate
- Pressure
- (Optional) Add extra parameters (e.g., energy cost, raw material usage)
- Click Save → A dashboard is created and continuously updated with live data
The CIP Analysis Dashboard is accessible out-of-the-box from the asset view.
- CIP Process Type Selection: “All” or specific process types
- View Toggle: Switch between Overview and Details
- Faulty Processes Count
- Score Statistics for selected time ranges
- Golden CIP Information
- Period Selector for analysis range
- Process Timeline Overview
- Process Table (ID, score, start/end time, duration)
- ⭐ Set Golden CIP by clicking the star icon
- ➡️ View Process Details by clicking the arrow icon
The Detail View is accessible by selecting “Details” or clicking a specific process in the table.
- Filter by process type
- Toggle between Overview / Details
- Adjust time period
- View process list (with scoring & metadata)
- Examine selected process parameters and scoring
- Modify calculation cycle to match process duration
- Compare actual vs. Golden CIP parameters, with confidence intervals and step boundaries shown
A Golden CIP acts as the benchmark reference for scoring.
All processes are compared to this golden process to evaluate deviation and quality.
Defining a Golden CIP is optional, but enhances precision and process insight.
- Open the CIP Dashboard for a given asset
- Choose “All” or a specific process
- Click the ⭐ icon to set as the Golden CIP
🔁 When a Golden CIP is redefined, all scoring calculations are automatically recalculated (this may take time).
A score quantifies how closely an actual process matches the Golden CIP reference.
| Score | Meaning |
|---|---|
| 100 | Perfect match with Golden CIP |
| 0 | Deviates beyond 1 target threshold |
Average of the Time Score and Part Scores.
Comparison of total CIP duration versus Golden CIP duration.
Trend-based comparison (based on Sinner’s Circle) of:
- Temperature
- Concentration
- Flow Rate
- Pressure
Trends are analyzed at 1-minute resolution.
Computed per optional parameter (e.g., cost or energy use).
-
Sequence Scoring:
A single score for the entire process duration. -
Step Scoring:
The process is divided into steps, each scored individually.
This approach enhances accuracy by aligning each step with the corresponding phase in the Golden CIP.
Thank you for your interest in contributing. Anybody is free to report bugs, unclear documentation, and other problems regarding this repository in the Issues section. Additionally everybody is free to propose any changes to this repository using Pull Requests.
If you haven't previously signed the Siemens Contributor License Agreement (CLA), the system will automatically prompt you to do so when you submit your Pull Request. This can be conveniently done through the CLA Assistant's online platform. Once the CLA is signed, your Pull Request will automatically be cleared and made ready for merging if all other test stages succeed.
Please read the Legal information.
End of Document