s Table of Contents

Preface
Preparation 1
Defining the Time Model 2
Configuring Reason Trees 3
Configuring State Translation
4
Tables
Displaying Downtime Data 5
Defining Counters and Design
6
SIMATIC IT OEE 2.1 SP2 Speeds
Displaying Counter and Design
Getting Started 7
Speed Data
Configuring Algorithms 8
Configuring Targets and Limits 9
Advanced Runtime Operations 10
Reporting OEE Data 11

SIEMENS AG
Edition 04/2012
Guidelines

This manual contains notices intended to protect the products and connected equipment against
damage. These notices are graded according to severity by the following texts:

CAUTION
Indicates that if the proper precautions are not taken, this can result into property damage.

Important
Highlights key information on handling the product, the product itself or to a particular part of the
documentation.

Note
Draws your attention to additional information.

Trademarks

All names identified by ® are registered trademarks of Siemens AG.

The remaining trademarks in this publication may be trademarks whose use by third parties for their
own purposes could violate the rights of the owner.

Disclaimer of Liability

We have reviewed the contents of this publication to ensure consistency with the hardware and
software described. Since variance cannot be precluded entirely, we cannot guarantee full
consistency. However, the information in this publication is reviewed regularly and any necessary
corrections are included in subsequent editions.

Siemens AG 04/2012 Copyright © Siemens AG 2012

Industry Sector Technical data subject to change
Postfach 48 48
90026 NÜRNBERG
GERMANY
 Table of Contents
Preface ...................................................................................................................................... 5

1 Preparation ......................................................................................................................... 10

1.1 Restoring the OEE plant ............................................................................................................. 11

1.2 Creating a PPA project and configuration................................................................................... 11
1.3 Creating the Equipment Model ................................................................................................... 13

2 Defining the Time Model .................................................................................................... 14

2.1 Defining the Time Model ............................................................................................................. 14

3 Configuring Reason Trees ................................................................................................ 16

3.1 Creating Equipment Types ......................................................................................................... 16

3.2 Defining Reason Tree levels....................................................................................................... 17
3.3 Configuring Machine States........................................................................................................ 17
3.4 Creating a simple Reason Tree .................................................................................................. 19
3.5 Creating a Sub Tree.................................................................................................................... 20
3.6 Creating a complex Reason Tree ............................................................................................... 21
3.7 Copying a Reason Tree .............................................................................................................. 22

4 Configuring State Translation Tables .............................................................................. 24

4.1 Creating State Translation Tables .............................................................................................. 24

4.2 Configuring Equipment to acquire downtime data ......................................................................26

5 Displaying Downtime Data ................................................................................................ 28

5.1 Approving and running the Project Version ................................................................................ 28

5.2 Configuring the OEE Web Client ................................................................................................ 29
5.3 Viewing downtime records .......................................................................................................... 29
5.4 Modifying downtime records ....................................................................................................... 30

6 Defining Counters and Design Speeds ............................................................................ 32

6.1 Creating a new OEE version....................................................................................................... 32

6.2 Defining Counters ....................................................................................................................... 32
6.3 Defining Design Speeds ............................................................................................................. 33
6.4 Configuring Equipment to acquire Counters ............................................................................... 34
6.5 Configuring Equipment to acquire Design Speeds .....................................................................35

7 Displaying Counter and Design Speed Data ................................................................... 37

7.1 Viewing counter records ............................................................................................................. 37

SIMATIC IT OEE 2.1 SP2 - Getting Started iii

Table of Contents

7.2 Viewing design speed records .................................................................................................... 38

8 Configuring Algorithms ..................................................................................................... 40

8.1 Configuring State Families.......................................................................................................... 40

8.2 Configuring Algorithms based on State Families ........................................................................41
8.3 Configuring OEE-related Algorithms........................................................................................... 42
8.4 Configuring contexts ................................................................................................................... 43

9 Configuring Targets and Limits ........................................................................................ 45

9.1 Configuring Limits ....................................................................................................................... 45

9.2 Configuring Targets .................................................................................................................... 46
9.3 Viewing Targets and Limits......................................................................................................... 47

10 Advanced Runtime Operations ....................................................................................... 49

10.1 Viewing Algorithm results.......................................................................................................... 49

10.2 Updating contexts at runtime .................................................................................................... 50
10.3 Configuring planned downtimes................................................................................................ 50
10.4 Viewing high-level production statistics .................................................................................... 51
10.5 Using the Operator Pages. ....................................................................................................... 53

11 Reporting OEE Data ......................................................................................................... 54

11.1 Creating a project...................................................................................................................... 54

11.2 Installing Standard Reports....................................................................................................... 55
11.3 Running the Downtime detail report.......................................................................................... 56
11.4 Running the OEE-DTM (on-the-fly calculation) report ..............................................................57
11.5 Running the OEE-DTM Line Efficiency report .......................................................................... 58

iv SIMATIC IT OEE 2.1 SP2 - Getting Started

 Preface

Guidelines

This manual contains notes of varying importance that should be read with care; i.e.:

Important

Contains essential information regarding handling the product, the product itself or a
specific part of the documentation.

Note

Provides supplementary information regarding handling the product, the product itself or
a specific part of the documentation.

Trademarks

All names identified by ® are registered trademarks of the Siemens AG.

The remaining trademarks in this publication may be trademarks whose use by third parties
for their own purposes could violate the rights of the owner.

Disclaimer of Liability

We have reviewed the contents of this publication to ensure consistency with the hardware
and software described. Since variance cannot be precluded entirely, we cannot guarantee
full consistency. However, the information in this publication is reviewed regularly and any
necessary corrections are included in subsequent editions.

Where is this manual valid?

This manual is valid for release 2.1 SP2 of SIMATIC IT OEE.

Basic knowledge required

This guide is intended for SIMATIC IT users who are responsible for system configuration,
such as application managers and system integrators (consultants). To be able to
understand the concepts and examples discussed in this guide, the reader should at least
have taken the SIMATIC IT Production Suite Basic Training.
In order to understand this manual, general knowledge of SIMATIC IT is required.

SIMATIC IT OEE 2.1 SP2 - Getting Started v

Preface

Purpose

This Manual explains How to configure and run a complete OEE project from creating a
PPA Project to viewing algorithms with targets and limits..

Important

This guide does not intend to describe details of OEE installation, migration scenarios,
prerequisites and license requirements. For more information about related concepts,
please see the Related Documentation section.

Related documentation

The following documentation illustrates concepts related to / the understanding of which is a

prerequisite to using OEE:

Document Content

OEE Engineering Client Online Detailed to guide to the engineering of OEE.

Help

OEE Web Client Online Help Contains information on the using the OEE Web
Client.

These documents are all available online from the SIMATIC IT Documentation Library,
which can be accessed by selecting Start > All Programs > Siemens Automation >
SIMATIC > SIMATIC IT Documentation > English (or German, if available).

Conventions

The table below describes the specific typographic conventions that are used throughout
this manual:

Symbol/
Indicates...
Convention

Text in bold The names of menus, commands, dialog boxes and toolbar buttons and,
in general, all strings (e.g. File menu; Save command).

KEY1+KEY2 Shortcut keys, which permit rapid access to commands (e.g. CTRL+C).

UPPERCASE The names of keyboard keys (e.g. RETURN key).

Italics Noun with special importance or significance for which emphasis is

needed. The names of parameters that must be replaced with a specific
name or value.

> A succession of commands in which the command preceding the symbol

must be selected before the command following it.

vi SIMATIC IT OEE 2.1 SP2 - Getting Started

 Preface

Symbol/
Indicates...
Convention

Code Code example.

example

SIMATIC IT Documentation Library

The SIMATIC IT Documentation Library provides you with a comprehensive and user-
friendly interface to access the overall product documentation where manuals and online
helps can be browsed by functionality or by component.
To access the SIMATIC IT Documentation Library, simply select Start > All Programs >
Siemens Automation > SIMATIC > SIMATIC IT Documentation > English (or German, if
available).

Readme

The installation includes a readme file, which contains information on upgrade procedures
and compatibility with previous releases. This file is supplied both in standard text
(ReadMe.wri) and in Acrobat PDF (ReadMe.pdf) format.
This file is available in folder \ReleaseNotes of the setup DVD. It is also provided in the
SIMATIC IT Documentation Library, which can be accessed by selecting Start > All
Programs > Siemens Automation > SIMATIC > SIMATIC IT Documentation > English
(or German, if available).

SIMATIC IT Training Center

Siemens IA AS MES offers a number of training courses to familiarize you with the
SIMATIC IT product suite. To successfully achieve this goal, training consists of lessons in
both theory and practice.
Courses are held year-round, according to a program that is published well in advance of
the first scheduled session.
The material on the basis of which our courses are conducted reflects the result of years of
experience in process, LIMS, quality control and production management.
All courses are held by expert personnel that are aware of the developments and
innovations in the Siemens IA AS MES product suite.
Courses are held in English at the Siemens IA AS MES Training Centers.
Upon request, training courses can also be organized on the customer's premises.
For more information on the training course calendar, please visit our technical web site
(http://www.automation.siemens.com/mcms/mes/en/serviceandsupport/
valueaddedservices/Pages/Default.aspx).

SIMATIC IT Service & Support

A comprehensive Software Maintenance program is available with SIMATIC IT products.

Software Maintenance includes the following services:

SIMATIC IT OEE 2.1 SP2 - Getting Started vii

Preface

• Software Update Service (SUS): automatic distribution of upgrades and service packs
• Technical Support Service (TSS): support on technical problems with SIMATIC IT
software (standard support and other optional services)
• Online Support: a technical web site, providing information such as Frequently Asked
Questions and technical documentation on SIMATIC IT products

Software Update Service (SUS)

This service provides automatic shipment of new versions and service packs when
released. When a new version / service pack is available for shipping, it is typically shipped
within one month.
One copy of the installation DVD is shipped for each Server covered by Software
Maintenance.
Hot fixes (officially tested and released) are not shipped and must be downloaded from the
Technical Support Service Web site.

Technical Support Service (TSS)

Siemens provides a dedicated technical support team for SIMATIC IT products.

The following options are available:
• Bronze support: 9 hours/day, 5 days/week
• Silver support: 24 hours/day, 5 days/week
• Gold support: 24 hours/day, 7 days/week

The principal language of the SIMATIC IT hotline is English.

SIMATIC IT partners and customers covered by the Software Maintenance program are
entitled to direct access to the TSS.

Access to the TSS

To be able to access the TSS, the customer needs to register as a user on the Technical
Support Web site. Connect to http://www.automation.siemens.com/MCMS/MES/EN/Pages/
Default.aspx and in the Restricted areas follow the SIMATIC IT TSS link.
The registration form must be completed with:
• Personal data
• The required company and plant information
• The Contract Number provided by Siemens Back Office when the contract is agreed.

Online Support

A customer who is a registered TSS user, can access the Technical Support Web site
(https://mes-simaticit.siemens.com/tss/RestrictedSupportServices.html), which contains
technical information such as:
• Service conditions (Phone numbers, Working hours, Reaction times,…)

viii SIMATIC IT OEE 2.1 SP2 - Getting Started

 Preface

• SIMATIC IT knowledge base: a technical support database that includes practical service
solutions from the Technical Support or the SIMATIC IT community
• SIMATIC IT software (e.g. hot fixes, software examples) and release notes that can be
downloaded
• SIMATIC IT cross-industry libraries that can be downloaded (limited access to SIMATIC
IT certified partners)
• SIMATIC IT product documentation that can be downloaded
• Frequently Asked Questions and useful tips.

SIMATIC IT OEE 2.1 SP2 - Getting Started ix

 1 Preparation

Introduction

This Getting Started teaches you how to configure and use SIMATIC® IT OEE product
option to collect and analyze downtime data and key performance indicators to monitor the
efficiency of your plant.
More specifically, you will learn how to:
• create an OEE configuration using the OEE Engineering Client
• use the OEE Web Client to display collected and aggregated data, execute algorithm
calculations and perform other runtime operations.

Prerequisites

This document assumes that you are already familiar with SIMATIC IT Historian, and that
you already installed SIMATIC IT OEE on your computer. Furthermore, it is recommended
that you read at least the OEE Concept Guide before beginning this Getting Started, as it
contains useful information concerning OEE key concepts, and engineering and runtime
workflow.

Scenario

The Getting Started project is based upon an imaginary bottling plant, in which two sections
of the bottling line, deliberately simplified, fill bottles with liquid and cap them.
The restored OEE Plant provides a set of tags and associated tasks in SIMATIC IT RTDS,
which are used to generate simulated online process data. This generated data is used to
represent monitored process data from the bottling plant. Using the simulated data, it is
possible to perform all the monitoring functions required to analyze the availability,
performance and quality in the imaginary plant and, hence, calculate its OEE.
Before setting up your OEE project, you must perform some preliminary steps to set up
information about your plant:
• restore the OEE plant
• create a PPA project the storage, clustering and manipulation of the monitored process
data received from the plant
• create the Equipment Model for the plant, within the PPA project

After these steps, it will be possible to create the OEE configuration.

10 SIMATIC IT OEE 2.1 SP2 - Getting Started

 1 Preparation
1.1 Restoring the OEE plant

1.1 Restoring the OEE plant

Introduction

A pre-configured SIMATIC IT example plant is provided for this Getting Started and is found
as a compressed .arq file in the %ICUBEPATH%\Documentation\GettingStarted_Files
directory: it can be opened using SIMATIC IT Backup Manager tool.

Procedure

1. In the Plant Management environment, select Tools > Backup Manager.

2. In the Backup Manager dialog box, select File > Restore.
3. Select the OEE.ARQ file and click Open.
4. In the Restore dialog box, type OEE in the Plant Name edit box and click OK.
5. Log on to the OEE plant, by double-clicking the OEE icon: the SIMATIC IT
Management Console is displayed.
6. Right-click the RTDS_OEE Unit and select Modify.
7. In the Attribute dialog box, select your computer in the Device Name area and click
Finish.
8. Select Unit > Real Time Data Engine > Start Real Time Data Engine to start the unit
to be used for PLC simulation.

Result

You have restored the OEE.PLT plant, containing a number of field tags configured in the
Data Dictionary and various simulation tasks created with RTDE. These tasks will be used
to generate dynamic values for the field tags, thereby simulating field data to demonstrate
the OEE capabilities.

1.2 Creating a PPA project and configuration

Introduction

The configuration on the SIMATIC IT Services level that is required for the Getting Started
project is provided once you have restored OEE.ARQ. However, a Plant Performance
Analyzer project must be configured to collect, store and process the data received from the
plant.
The following procedures explain how to:
• Create a new PPA project
• Create a new PPA configuration
• Create a new OEE configuration

SIMATIC IT OEE 2.1 SP2 - Getting Started 11

1 Preparation
1.2 Creating a PPA project and configuration

Procedure

To create a new PPA project:

1. From the SIMATIC IT Management Console, select Component > Plant
Performance Analyzer > Plant Performance Analyzer Configuration.
2. Select Project > Add to start the Add Project Wizard.
3. Select the SQL Server instance that will manage the PPA database set.
4. Click Add a new database set.
5. Type the name of the PPA configuration database (for example, PPADBOEE).
6. Browse to the directory where the configuration database will be stored.
7. Type 2 as the number of databases in the online database set.
8. Browse to the location of the online database set and the transaction log.
9. Accept the default values provided for the online database set parameters.
10. Select the PPA Server name.
11. Click Next to accept the default values provided for the remaining wizard steps. After
the last step of the wizard, some time must elapse before the new PPA project is
actually created.

Procedure

To create a new PPA configuration:

1. From PPA Administration Tool, right-click the new project and select Open Project.
2. When the Configuration Editor starts, a dialog box opens. Click New to create a new
configuration.
3. Type a name for the new PPA configuration (for example, PPA_OEE) and click OK.

Procedure

To create a new OEE configuration linked to the PPA configuration:

1. In PPA Configuration Editor, click the Time Model tab.
2. When the Open Overall Engineering Effectiveness Configuration dialog is
displayed, select the BASE configuration and click OK.

Result

You have created a new Plant Performance Analyzer Project, as well as new configurations
for PPA and OEE.

12 SIMATIC IT OEE 2.1 SP2 - Getting Started

 1 Preparation
1.3 Creating the Equipment Model

1.3 Creating the Equipment Model

Introduction

The following plant model, representing a small bottling line, must be configured in PPA
Configuration Editor:

Procedure

1. In the PPA Configuration Editor environment, click the Equipment tab

2. Right-click EquipmentModel* in the tree list, and select New Equipment Unit.
3. Type BottlingLine1 in the Name edit box of the dialog box displayed and click OK.
4. Right-click BottlingLine1 and select New Equipment Unit.
5. Type Filler in the Name edit box of the dialog box displayed and click OK.
6. Right-click Filler and select New Equipment Unit.
7. Type Fan in the Name edit box of the dialog box displayed and click OK. Fan is added
to Filler.
8. Repeat steps 4 to 7 to add a Capper and Fan to the model.

Result

You have created a small plant model that will be used for OEE analysis.

SIMATIC IT OEE 2.1 SP2 - Getting Started 13

 2 Creating the Time Model

Overview

This section explains how to create a simple Time Model for your plant.
Once the Time Model is defined, you will be able to use the following time categories
representing the main reasons of downtime for the plant:
• Planned Shutdown
• Downtime Loss
• Speed Loss
• Quality Loss

2.1 Defining the Time Model

Introduction

The first stage in setting up an OEE configuration is to define the time categories into which
the total processing time of BottlingLine1 is divided. These include all the downtime
categories and the remaining Fully Productive Time, which together form the Time Model.
For this example, the Time Model has been kept simple, for clarity. In reality, you can define
whatever categories you like to make the complex process easier to understand and
analyze.

Procedure

1. In the Configuration Editor, delete the default Time Model by right-clicking on Total
Time and selecting Reset Time Model. Everything except the Total Time row is
removed from the Time Model.
2. Right-click inside the main workspace and select Add Row.
3. Type Planned Production Time as Left Item and browse for a color of your choice.
4. Type Planned Shutdown as Right Item and browse for a color of your choice.
5. Repeat the process in steps 2 to 4 to add more rows until you have created the Time
Model shown in the Result section.

Result

You have created the following Time Model:

14 SIMATIC IT OEE 2.1 SP2 - Getting Started

 2 Creating the Time Model
2.1 Defining the Time Model

SIMATIC IT OEE 2.1 SP2 - Getting Started 15

 3 Configuring Reason Trees

Overview

This section explains how to create and configure Reason Tree.

A Reason Tree defines, more in detail, the exact reason of a downtime for a specific type of
equipment. You can create Reason Tree up to 4 levels in depth, specifying exactly what
caused the downtime in terms, for example, of a particular component malfunctioning.
Before creating your first Reason Tree, you must configure the following engineering
objects first:
• Equipment Types: classifications for your plant's equipment units.
• Reason Tree levels: the name of each of the four levels of the Reason Trees.
• Machine States: every possible state any equipment unit in your plant can assume,
constituting the leaves of the Reason Trees.
• Sub Trees: small branches of Reason Trees which can be used in more than one tree.

3.1 Creating Equipment Types

Introduction

Equipment Types help you organize your product structure by equipment type.

Procedure

1. In the Configuration Editor, click the General Registry tab.

2. Click on Equipment Types in the tree list.
3. Right-click inside the main workspace and select New Equipment Type.
4. Type Generic Fan as the Equipment Type Name.
5. Following the steps above, create an Equipment Type named Generic Machine.

Result

You have created two Equipment Types: Generic Fan and Generic Machine.

16 SIMATIC IT OEE 2.1 SP2 - Getting Started

 3 Configuring Reason Trees
3.2 Defining Reason Tree levels

3.2 Defining Reason Tree levels

Introduction

Before you can create Reason Trees, you must first specify how many Reason Tree levels
you want to have available for each time category. For our example, you will need to define
all four available levels.

Procedure

• In Configuration Editor, click the General Registry tab.

• In the tree list, select Levels. The default Reason Tree levels are displayed in the main
workspace.
• Click Set.
• In the Set Levels dialog box, make sure that the check boxes for all Reason levels are
checked and configure the level names as follows:

Level 1 State

Level 2 Cause

Level 3 Reason

Level 4 Detailed Reason

Result

You have defined the names for all four Reason Tree levels.

3.3 Configuring Machine States

Introduction

Machine States are used to populate reason trees with all the possible states that can be
assumed by any piece of equipment.

Tip

Creating all the Machine States manually can be a lengthy and tedious task in the case
of complex plants. In alternative, you can create Machine States (and any other
Engineering Object) using Microsoft Excel, as described in the OEE Bulk Operations
manual.

SIMATIC IT OEE 2.1 SP2 - Getting Started 17

3 Configuring Reason Trees
3.3 Configuring Machine States

Procedure

1. In the Configuration Editor, click the General Registry tab.

2. Select Machine State List in the tree list.
3. Right-click inside the main workspace and select New Machine State.
4. Type Adjustment as the Item Name of the machine state and click OK.
5. Following the steps above, create the Machine States listed below :

Item Name Color Is a Stop State

Adjustment Red Checked

Bottle Red Checked

Cap Red Checked

Changeover Red Checked

Component Red Checked

Electrician Red Checked

Emergency Red Checked

Engineer Red Checked

Equipment Red Checked

Failure Red Checked

Fan Red Checked

Human Resource Red Checked

Liquid Red Checked

Machine Red Checked

Materials Red Checked

Routine Stop Red Checked

Setup Red Checked

Stopped Red Checked

Team Leader Red Checked

Technician Red Checked

Waiting Red Checked

Unknown Failure Red Checked

18 SIMATIC IT OEE 2.1 SP2 - Getting Started

 3 Configuring Reason Trees
3.4 Creating a simple Reason Tree

Unknown Stoppage Red Checked

Fuse Red Checked

Running Green Unchecked

Maintenance Light Blue Unchecked

No Production Light Blue Unchecked

Break Light Blue Unchecked

Holiday Light Blue Unchecked

Scheduled Unavailability Light Blue Unchecked

Result

You have created all the Machine States for the entire plant.

3.4 Creating a simple Reason Tree

Introduction

You can create a Reason Tree associated to a particular Equipment Type. A Reason Tree
contains all Machine States that apply to the specified Equipment Type and are organized
hierarchically.

Procedure

1. In the Configuration Editor*, click the Reason Tree tab.

2. Right-click Reason Tree List* and select New Reason Tree.
3. Type Fan RT as Name and select Generic Fan as Equipment Type.
4. Select Fan RT from the tree list. The time categories defined in the Time Model are
displayed.
5. Right-click Fully Productive Time and select Add State.
6. Select Running from the Machine State List and click OK.
7. Continue adding Machine States until you obtain a Reason Tree like the one shown in
the Result section.

Result

You have created the following Reason Tree for your fan equipment:

SIMATIC IT OEE 2.1 SP2 - Getting Started 19

3 Configuring Reason Trees
3.5 Creating a Sub Tree

3.5 Creating a Sub Tree

Introduction

When creating complex Reason Trees, some branches may be repeated in different parts
of the tree. In such cases, it is faster to create reusable Sub Trees.

Procedure

1. In the Configuration Editor, click the Reason Tree tab.

2. Right-click Sub Tree List and select New Sub Tree.
3. Type Filler Components as the Sub Tree Name and click OK.
4. Right-click Filler Components in the tree list and select Add State.
5. Select Component from the Machine State List and click OK.
6. Right-click Component and select Add State.
7. While holding down the CTRL key, select both Liquid and Bottle from the Machine
State List and click OK.
8. Expand Filler Components in the main workspace. The final Sub Tree should look like
the one shown in the Result section.

Result

You have created the following Filler Components Sub Tree, which can now be used in
both the Filler and Capper Reason Trees:

20 SIMATIC IT OEE 2.1 SP2 - Getting Started

 3 Configuring Reason Trees
3.6 Creating a complex Reason Tree

3.6 Creating a complex Reason Tree

Introduction

Complex equipment, such as fillers and cappers, require more complex Reason Trees,
which often contain one or more Sub Trees.
Result Your Filler RT Reason Tree should look like this:

Procedure

1. In the Configuration Editor, click the Reason Tree tab.

2. Right-click Reason Tree List and select New Reason Tree.
3. Type Filler RT as Name and select Generic Fan as Equipment Type.
4. Configure the Reason Tree as shown in the Result section, leaving out the Component
branches.
5. Right-click Waiting.
6. Click the Sub Tree List tab.
7. Select the Filler Components Sub Tree and click OK.
8. Right-click Failure and repeat steps 6 and 7.

Result

Your Filler RT Reason Tree should look like this:

SIMATIC IT OEE 2.1 SP2 - Getting Started 21

3 Configuring Reason Trees
3.7 Copying a Reason Tree

3.7 Copying a Reason Tree

Introduction

The Reason Trees of the filler and capper machines are going to be very similar. In this
case, the fastest way to create the capper Reason Tree is to copy the filler Reason Tree,
and then make some changes.

Procedure

1. In the Configuration Editor, click the Reason Tree tab.

2. Right-click Reason Tree List and select Copy Reason Tree.
3. Type Capper RT as the name of the new Reason Tree.
4. Right-click the Component branches and select Remove to delete them.

22 SIMATIC IT OEE 2.1 SP2 - Getting Started

 3 Configuring Reason Trees
3.7 Copying a Reason Tree

5. Create a new Sub Tree called Capper Components, which contains the same states
as the Filler Components Sub Tree, but with Cap instead of Liquid.
6. Add the Capper Components Sub-Tree to the Waiting and Failure states of the
Capper RT Reason Tree.

Result

Your Capper RT Reason Tree should look like this:

SIMATIC IT OEE 2.1 SP2 - Getting Started 23

 4 Configuring State Translation Tables

Overview

This section explains how to create State Translation Tables for existing Reason Trees.
Reason Trees are useful to visualize and classify all the possible reason of downtime for an
equipment unit. They do not, however, provide any mapping between machine status
values collected from the field and machine states. Such mapping is provided by State
Translation Tables, which can be generated automatically from Reason Trees and then
modified manually to specify a value for each Machine State used in by the Reason Tree.

4.1 Creating State Translation Tables

Introduction

After creating Reason Trees, you must create the corresponding State Translation Tables
(STTs), which bind specific Reason Tree state combinations to values received from the
field.

Procedure

1. In the Configuration Editor, click the Reason Tree tab.

2. Right-click Filler RT and select New State Translation Table.
3. Type Filler STT as name and click OK.
4. When prompted to auto-create a State Translation Table, click Yes: the STT will be
populated automatically.

Note

The rows of the STT can also be defined manually.

5. In the tree list, select Filler RT > Filler STT to display the new STT.
6. Edit the STT so that it looks like the one shown in the Result section.
• To delete a row, right-click it and select Remove.

Tip

You can hold down the SHIFT and CTRL keys to perform multiple row selection.

24 SIMATIC IT OEE 2.1 SP2 - Getting Started

 4 Configuring State Translation Tables
4.1 Creating State Translation Tables

• To update the Raw Value of a row, double-click a row and enter the new value in the
Modify State Translation Table Item dialog.

7. Repeat this procedure to create the Simple Fan STT (generated from Fan RT), Self
Diagnosing Fan STT (generated from Fan RT) and Capper STT (generated from Capper
RT). In alternative, you can create the STTs using Excel, as explained in the OEE Bulk
Operations Manual.

Result

Your Filler STT should look like this:

Your Simple Fan STT should look like this:

Your Self Diagnosing Fan STT should look like this:

Your Capper STT should look like this:

SIMATIC IT OEE 2.1 SP2 - Getting Started 25

4 Configuring State Translation Tables
4.2 Configuring Equipment to acquire downtime data

4.2 Configuring Equipment to acquire downtime data

Introduction

You can now define how each equipment unit retrieves status information from the field, by
configuring equipment attributes.

Procedure

To configure the Filler equipment attributes:

1. In the Configuration Editor, click the Equipment Attributes tab.
2. Right-click Filler and select Attributes Management.
3. In the General tab, configure the following attributes:

Attribute Value

Equipment Type Generic Machine

Reason Tree Name Filler RT

State Translation Table Filler STT

Microstop Threshold 45

4. In the Downtime Acquisition tab, click the Acquired by Plant Performance Analyzer
radio button.
5. Click the … button next to Status Value.
6. Define a new source point as follows:

Attribute Value

Unit Name RTDS_OEE

Symbolic Name L1_Filler_State

Source Point Name RTDS_RTDS_OEE_L1_Filler_State

7. Click OK to close all open dialogs.

Procedure

Following the steps given in the previous procedure, configure the Capper attributes as
follows:
• General attributes:

Attribute Value

Equipment Type Generic Machine

26 SIMATIC IT OEE 2.1 SP2 - Getting Started

 4 Configuring State Translation Tables
4.2 Configuring Equipment to acquire downtime data

Reason Tree Name Capper RT

State Translation Table Capper STT

Microstop Threshold 45
• Status value:

Attribute Value

Unit Name RTDS_OEE

Symbolic Name L1_Capper_State

Source Point Name RTDS_RTDS_OEE_L1_Capper_State

Result

You have configured the Equipment Type, Reason Tree Name and State Translation Table
for the Capper and Filler equipment units, and their status values are now bound to source
points.

SIMATIC IT OEE 2.1 SP2 - Getting Started 27

 5 Displaying Downtime Data

Overview

This section explains how to display and modify downtime data at run time, using the OEE
Web Client.
Before being able to do so, you must:
1. Approve the current engineering configuration version.
2. Run the engineering configuration.
3. Configure the OEE Web Client to display data.

5.1 Approving and running the Project Version

Introduction

Before downtime data can be displayed, you must approve both the relevant OEE and PPA
versions, to ensure that they are consistent.

Procedure

1. Click the Approve button in the PPA toolbar.

2. In the Approving dialog, select the PPA version and click OK.
3. Click the Approve button in the OEE toolbar.
4. Close the Configuration Editor.
5. From SIMATIC IT Management Console, select Unit > Real Time Data Engine > Start
Real Time Data Engine.
6. From SIMATIC IT Management Console, select Component > Plant Performance
Analyzer (PPA) > Overall Equipment Effectiveness Acquisition Server.
7. From PPA Administrative Tool, select Server > Acquisition > Run.

Result

Both the PPA and OEE Acquisition Servers are now running and acquiring data.

28 SIMATIC IT OEE 2.1 SP2 - Getting Started

 5 Displaying Downtime Data
5.2 Configuring the OEE Web Client

5.2 Configuring the OEE Web Client

Introduction

The OEE Web Client is a CAB application containing web pages you can use to view and
modify OEE runtime data.

Prerequisites

You must install the OEE Web Client CAB package as described in OEE Installation
Manual.

Procedure

1. Open Microsoft Internet Explorer and navigate to the following URL: http://localhost/
SITApps/SITPortal/default.aspx.
2. Click the Login tab.
3. Type manager as User Name and click Log In.
4. After logging in, click the Overall Equipment Effectiveness tab.
5. Click User OEE Configuration in the main workspace.
6. In the Equipment section, select BottlingLine\Capper and BottlingLine\Filler.
7. In the Visibility - Refresh section, enable all values and set the refresh to 1 minute.
8. In the Columns Filter section, enable all columns.
9. Click Save Configuration to save the changes.

Result

You configured OEE Web Client to display run time data.

5.3 Viewing downtime records

Introduction

You can view downtime records via the OEE Web Client in two ways:
• in a Gantt chart
• in tabular form

Procedure

To view downtime records in tabular form:

SIMATIC IT OEE 2.1 SP2 - Getting Started 29

5 Displaying Downtime Data
5.4 Modifying downtime records

1. Start the OEE Web Client and log in.

2. Click the Overall Equipment Effectiveness tab and click DTM Viewer in the main
workspace.
3. Once the DTM Viewer page is loaded, click the Time Span tab.
4. Specify a 15 minutes time span.
5. In the Tree View, select either Capper or Filler, then click Load. The downtime records
relative to the last 15 minutes are shown.
6. To filter data by Reason Tree state, click the Reason Tree tab, select one or more
Reason Tree states (for example, Downtime Loss > Stopped) and click Load.

Procedure

To view downtime records in a Gantt Chart:

1. Start the OEE Web Client and log in.
2. Click the Overall Equipment Effectiveness tab and click Gantt Viewer in the main
workspace.
3. Once the Gantt Viewer page is loaded, click the Time Span tab.
4. Specify a 15 minutes time span.
5. In the Tree View, select either Capper or Filler, then click Load. The downtime records
relative to the last 15 minutes are shown.
6. To filter data by Reason Tree state, click the Reason Tree tab, select one or more
Reason Tree states, (for example Downtime Loss > Stopped) and click Load.

Result

You are now able to view downtime records. You can also perform other operations on the
DTM Viewer and the Gantt Viewer page, such as exporting data, modifying the display
settings, etc.

5.4 Modifying downtime records

Introduction

You can use the DTM Viewer page to modify downtime records manually . This is useful,
for example, when you must enter machine states that cannot be detected automatically.

Procedure

1. In the OEE Web Client, navigate to the DTM Viewer page.

2. Configure the page to display some downtime records, as explained previously.
3. Select a table row and click Modify.
4. In the Edit Row dialog, change the Reason Tree state associated to the downtime
record to Downtime Loss > Stopped > Waiting > Human Resource > Electrician, or
any other state under the Waiting branch.

30 SIMATIC IT OEE 2.1 SP2 - Getting Started

 5 Displaying Downtime Data
5.4 Modifying downtime records

5. Click OK to close the dialog and then click OK again to confirm the operation.

Result

You have manually changed the state associated to a downtime record.

SIMATIC IT OEE 2.1 SP2 - Getting Started 31

 6 Defining Counters and Design Speeds

Overview

This section explains how to create counters and design speeds. These two engineering
objects are used, at run time, to collect data related to production measures (for example
number of pieces produced) and speed of equipment units.

6.1 Creating a new OEE version

Introduction

Before you can create new engineering objects, you must first create a new OEE version of
your engineering configuration.

Procedure

1. Open the Configuration Editor.

2. In the PPA Configuration dialog box, select the current PPA configuration and click
OK.
3. Click the General Registry tab.
4. In the OEE Configuration dialog box, click *New.
5. Enter a name for the new OEE Configuration and click OK.
6. In the OEE Configuration, select the new version and click OK.

Result

You have created a new OEE version.

6.2 Defining Counters

Introduction

You can create Counters to archive the number of items produced or processed by
equipment units. This makes it possible to calculate specific quality-related algorithms.

32 SIMATIC IT OEE 2.1 SP2 - Getting Started

 6 Defining Counters and Design Speeds
6.3 Defining Design Speeds

Procedure

1. In the Configuration Editor, select the General Registry tab.

2. Select Counters from the tree list.
3. Right-click inside the main workspace and select New Counter.
4. Type TotalPieces as Counter Name and click OK.
5. Repeat the last two steps to create another counter called GoodPieces.

Result

You have defined two Counters that will be used to archive the number of good pieces and
total pieces processed by specific equipment units.

6.3 Defining Design Speeds

Introduction

Like counters, Design Speeds can be defined in the General Registry. They are used to
archive the speed of equipment units, which is necessary for certain performance-related
algorithms.

Procedure

1. In the Configuration Editor, select the General Registry tab.

2. Select Design Speeds from the tree list.
3. Right-click TargetSpeed (this is a predefined design speed) and select Modify.
4. De-select Set as default and click OK.
5. When prompted to remove the selected design speed from all equipment units, click Yes.
6. Right-click inside the main workspace and select New Design Speed.
7. Configure the Design Speed as follows:

Name Effective Speed

Description Effective Speed

Unit of Measure Pieces/Minutes

Set as default selected

8. Click OK to create the Design Speed.

SIMATIC IT OEE 2.1 SP2 - Getting Started 33

6 Defining Counters and Design Speeds
6.4 Configuring Equipment to acquire Counters

Result

You have defined a Design Speed that will be used to archive the effective speed of
specific equipment units.

6.4 Configuring Equipment to acquire Counters

Introduction

After defining Counters in the General Registry, you can associate them to equipment units
and configure how data are acquired at runtime.

Procedure

1. In the Configuration Editor, select Equipment Attributes.

2. Right-click Capper and select Attributes Management.
3. Click the Counter Acquisition tab and then click Add.
4. Select Acquired by Plant Performance Analyzer and configure the Counter Attributes
as follows:

Attribute Value

Counter Name GoodPieces

Counter Type Limited, Threshold: 32768

Cyclically Every 1 Minute

Compression Factor 3

Counter Value (Source Point Definition)

Unit Name RTDS_OEE

Symbolic Name L1_Capper_Counter_Good

Source Point Name RTDS_RTDS_OEE_L1_Capper_Counter_Good

5. Click OK to close all the dialogs.

6. Repeat this procedure to configure the following counters (those attributes that are not
listed are configured with the same values as the previous counter):

Attribute Value [Capper] Value [Filler] Value [Filler]

Counter TotalPieces GoodPieces TotalPieces

Name

Counter Value (Source Point Definition)

34 SIMATIC IT OEE 2.1 SP2 - Getting Started

 6 Defining Counters and Design Speeds
6.5 Configuring Equipment to acquire Design Speeds

Symbolic L1_Capper_Counter_Total L1_Filler_Counter_Good L1_Filler_Counter_Total

Name

Source RTDS_RTDS_OEE_L1_ RTDS_RTDS_OEE_L1_ RTDS_RTDS_OEE_L1_

Point Capper_Counter_Total Filler_Counter_Good Filler_Counter_Total
Name

Result

You have configured the acquisition of the TotalPieces and GoodPieces counters for both
the Capper and the Filler equipment units.

6.5 Configuring Equipment to acquire Design Speeds

Introduction

After defining a Design Speed in the General Registry, you can associate it to equipment
units and configure how data are acquired at runtime.

Procedure

1. In the Configuration Editor, select Equipment Attributes.

2. Right-click Capper and select Attributes Management.
3. Select TargetSpeed and click Modify.
4. Select Acquired by Plant Performance Analyzer and configure the Design Speed
Value as follows:

Attribute Value

Unit Name RTDS_OEE

Symbolic Name L1_Capper_Speed

Source Point Name RTDS_RTDS_OEE_L1_Capper_Speed

5. Click OK to close all the dialogs.

6. Repeat this procedure to configure EffectiveSpeed for the Filler equipment unit. In this
case, you must configure the Design Speed Value as follows:

Attribute Value

Unit Name RTDS_OEE

Symbolic Name L1_Filler_Speed

Source Point Name RTDS_RTDS_OEE_L1_Filler_Speed

SIMATIC IT OEE 2.1 SP2 - Getting Started 35

6 Defining Counters and Design Speeds
6.5 Configuring Equipment to acquire Design Speeds

Result

You have configured the acquisition of the Design Speeds for both the Capper and the
Filler equipment units.

36 SIMATIC IT OEE 2.1 SP2 - Getting Started

 7 Displaying Counter and Design Speed Data

Overview

This section explains how to display counter values and design speed values at run time.
Like downtime records, counter and design speed records can also be modified and
exported.

7.1 Viewing counter records

Introduction

You can view counter records using the OEE Web Client in four ways:
• in tabular form
• in relation to equipment units and contexts
• in trend graphs
• in bar graphs

Prerequisites

• The OEE version must already have been approved.

• PPA Acquisition Server and Writing Service must be stopped and then restarted.

Procedure

To view counter records in tabular form:

1. Start the OEE Web Client and log in.
2. Click the Overall Equipment Effectiveness tab and click DTM Viewer in the main
workspace.
3. Once the DTM Viewer page is loaded, click the Time Span tab.
4. Specify a 15 minutes time span.
5. In the Tree View, select either Capper or Filler, then click Load. The downtime records
relative to the last 15 minutes are shown.

Procedure

To view counter values in relation to equipment units and contexts:

1. Open the Counters Grouped page.

SIMATIC IT OEE 2.1 SP2 - Getting Started 37

7 Displaying Counter and Design Speed Data
7.2 Viewing design speed records

2. In the Tree View, select both Capper and Filler.

3. In the Contexts tab, select Counters and click Apply.
4. Click Select all filters. Both GoodPieces and TotalPieces are selected.
5. In the Group By tab, select Equipment.
6. Specify a Time Span of 15 minutes and click Load. All counter values in relation to
each equipment unit are shown.

Procedure

To view counter values in trend graphs:

1. Open the Counters Graphic page.
2. In the Tree View, select either Capper or Filler.
3. In the Contexts tab, select Counters and click Apply.
4. Click Select all filters. Both GoodPieces and TotalPieces are selected.
5. In the Group By tab, set the grouping to 5 minutes.
6. Specify a Time Span of 15 minutes and click Load. All counter values are shown in
trend graphs.

Procedure

To view counter values in bar graphs:

1. Open the KPI Viewer page.
2. In the Tree View, select both Capper and Filler.
3. In the Counters List, select and add both the GoodPieces and the CounterPieces
counters.
4. Select ctByEquipmentIDs and ctByMinutes as cluster and sub cluster, respectively.
5. Specify a Time Span of 1 hour and click Load. All counter values are shown in bar
graphs.
6. (Optional) Click Settings to change the graph's visual setting, including graph type.

Result

You can now view counter records. You can also perform other operations with these
pages, like modifying and exporting data, changing the display settings, etc.

7.2 Viewing design speed records

Introduction

You can view design speed records using the OEE Web Client in two ways:
• in tabular form
• in trend graphs

38 SIMATIC IT OEE 2.1 SP2 - Getting Started

 7 Displaying Counter and Design Speed Data
7.2 Viewing design speed records

Procedure

To view design speed records in tabular form:

1. Start the OEE Web Client and log in.
2. Click the Overall Equipment Effectiveness tab and click Design Speed Viewer in the
main workspace.
3. Once the Design Speed Viewer page is loaded, click the Time Span tab.
4. Specify a 15 minutes time span.
5. In the Tree View, select either Capper or Filler, then click Load. The downtime records
relative to the last 15 minutes are shown.

Procedure

To view design speed values in trend graphs:

1. Open the Counters Graphic page.
2. In the Tree View, select either Capper or Filler.
3. In the Contexts tab, select Counters and click Apply.
4. Click Select all filters. Both GoodPieces and TotalPieces are selected.
5. In the Group By tab, set the grouping to 5 minutes.
6. In the Design Speed tab, select Show design speed series.
7. Specify a Time Span of 15 minutes and click Load. All counter values and design
speed values for the selected equipment are shown in trend graphs.

Result

You can now view design speed records. You can also perform other operations using the
Design Speed Viewer, such as modifying and exporting data, changing the display settings,
etc.

SIMATIC IT OEE 2.1 SP2 - Getting Started 39

 8 Configuring Algorithms

Overview

This section explains how to create and configure algorithms which will be used, at run
time, to calculate and display key performance indicators for the plant.
In particular, you will create instances of the following algorithms:
• Mean Time Between Failures
• Mean Time Between Assists
• Availability
• Performance Rate
• Quality Rate
• OEE

8.1 Configuring State Families

Introduction

State Families offer another way to categorize machine states. Unlike Reason Tree levels,
a Machine State can be associated to one or more State Families, and a State Family can
be associated to one or more Machine States.

Prerequisites

You must create a new OEE version to create and update engineering objects.

Procedure

To define a State Family:

1. In the Configuration Editor, click the General Registry tab.
2. Select State Families and click Set in the main workspace.
3. Type Failures as the name for Family 1.
4. (Optional) Specify a name for other State Families.
5. Click OK.

Procedure

To associate a State Family to a Machine State:

1. Create a new OEE version.

40 SIMATIC IT OEE 2.1 SP2 - Getting Started

 8 Configuring Algorithms
8.2 Configuring Algorithms based on State Families

2. In the Configuration Editor, click the General Registry tab.

3. Select Machine State List.
4. In the main workspace, right-click Failure and select Modify.
5. Select the Failures State Family and click OK.
6. (Optional) Repeat steps 4-5 to associate more Machine States to the Failures State
Family.

Result

You have configured the Failures State Family.

8.2 Configuring Algorithms based on State Families

Introduction

You can use State Families when configuring the factors of certain algorithms like MTBF
(Mean Time Between Failures) and MTBA (Mean Time Between Assists). These two
algorithms are very similar, depending on the concepts of "failure" and "assist". In this case,
they are defined as follows:
• Failure: an unplanned malfunction lasting more than 30 seconds.
• Assist: an unplanned malfunction lasting 30 seconds or less.

Given these definitions, the Failures State Family can be used for both algorithms and a
distinction can be made between them only as to how Microstops are handled.

Procedure

To create a new MTBF algorithm:

1. In the Configuration Editor, click the Algorithm tab.
2. Right-click MTBF in the tree list and select New Algorithm. The Add Algorithm wizard
is displayed.
3. Enter MTBF1 as both Algorithm Name and Display Name, and select No Microstop
Threshold.
4. In the Numerator Definition step, click Add, select Operating Time, and click OK.
5. In the Denominator Definition step, click Add, select Failures from the State Families
tab, and click OK.
6. Finish the wizard.

Procedure

To create a new MTBA algorithm:

1. In the Configuration Editor, click the Algorithm tab.

SIMATIC IT OEE 2.1 SP2 - Getting Started 41

8 Configuring Algorithms
8.3 Configuring OEE-related Algorithms

2. Right-click MTBA in the tree list and select New Algorithm. The Add Algorithm wizard
is displayed.
3. Enter MTBA1 as both Algorithm Name and Display Name, and select Microstop
Threshold.
4. In the Numerator Definition step, click Add, select Operating Time, and click OK.
5. In the Denominator Definition step, click Add, select Failures from the State Families
tab, and click OK.
6. Finish the wizard.

Result

You have configured a MTBF algorithm and a MTBA algorithm.

8.3 Configuring OEE-related Algorithms

Introduction

In addition to State Families, algorithms can be calculated by combining Time Categories,

Counters, Design Speeds and other Algorithms. For example, the OEE (Overall Equipment
Effectiveness) algorithm is calculated by combining the Availability, Performance Rate and
Quality Rate algorithms.

Procedure

To create a new Availability algorithm:

1. In the Configuration Editor, click the Algorithm tab.
2. Right-click Availability in the tree list and select New Algorithm. The Add Algorithm
wizard is displayed.
3. Enter Availability1 as both Algorithm Name and Display Name.
4. In the Numerator Definition step, click Add, select Operating Time, and click OK.
5. In the Denominator Definition step, click Add, select Planned Production Time, and
click OK.
6. Finish the wizard.

Procedure

To create a new Performance Rate algorithm:

1. In the Configuration Editor, click the Algorithm tab.
2. Right-click Performance Rate in the tree list and select New Algorithm. The Add
Algorithm wizard is displayed.
3. Enter PerformanceRate1 as both Algorithm Name and Display Name.
4. In the Numerator Definition step, click Add, select TotalPieces, and click OK.
5. In the Denominator Definition step, click Add, select Operating Time, and click OK.

42 SIMATIC IT OEE 2.1 SP2 - Getting Started

 8 Configuring Algorithms
8.4 Configuring contexts

6. Finish the wizard.

Procedure

To create a new Quality Rate algorithm:

1. In the Configuration Editor, click the Algorithm tab.
2. Right-click Quality Rate in the tree list and select *New Algorithm. The Add
Algorithm wizard is displayed.
3. Enter QualityRate1 as both Algorithm Name and Display Name.
4. In the Numerator Definition step, click Add, select GoodPieces, and click OK.
5. In the Denominator Definition step, click Add, select TotalPieces, and click OK.
6. Finish the wizard.

Procedure

To create a new OEE algorithm:

1. In the Configuration Editor, click the Algorithm tab.
2. Right-click OEE in the tree list and select New Algorithm. The Add Algorithm wizard
is displayed.
3. Enter OEE1 as both Algorithm Name and Display Name.
4. In the Formula Definition step, click Add.
5. Hold the CTRL key, select the Availability1, PerformanceRate1 and QualityRate1
algorithms, and click OK.
6. Finish the wizard.

Result

You have configured an OEE algorithm.

8.4 Configuring contexts

Introduction

You can configure contextual information to be collected together with runtime data, such
as downtime records or counter values. Such contexts are defined through custom fields
created using the Engineering Client. At runtime, you can then filter and group data
according to context values.

Procedure

To configure a custom field:

SIMATIC IT OEE 2.1 SP2 - Getting Started 43

8 Configuring Algorithms
8.4 Configuring contexts

1. In the Engineering Client, click the General Registry tab.

2. Select Custom Fields in the tree list, right-click inside the main workspace and select
New Custom Field.
3. Create a new Custom Field of type Long, called CustomID and click OK.

Procedure

To configure the acquisition of a custom field for an equipment unit:

1. In the Engineering Client, click the Equipment Attributes tab.
2. Right-click Capper and select Attributes Management.
3. Click the Downtime Acquisition tab.
4. In the Context List, select CustomID and configure the RTDS source point as follows:

Attribute Value

Unit Name RTDS_OEE

Symbolic Name L1_CustomID

Source Point Name RTDS_RTDS_OEE_L1_CustomID

5. (Optional) Following the steps above, configure custom field acquisition for any counter
or design speed.
6. Repeat this procedure to configure the acquisition of the CustomID custom field for
Filler.

Result

You have created the CustomID custom field and configured how it is acquired both by the
Capper and the Filler equipment units.

44 SIMATIC IT OEE 2.1 SP2 - Getting Started

 9 Configuring Targets and Limits

Overview

This section explains how to configure limits and targets.

Targets are used to configure thresholds for algorithm results. Target are defined for
specific equipment in relation to a particular algorithm instance, within a certain time span.
Some OEE web pages are able to display algorithm results in different colors depending on
whether they are higher or lower than targets, thereby providing plant supervisors and
operators with a quick way to evaluate KPIs at-a-glance.

9.1 Configuring Limits

Introduction

Limits are used to configure value ranges for algorithm results. Limits are defined for
specific equipment, in relation to a particular algorithm instance, within a certain time span.
For instance, it is possible to define a limit between 50% and 70% for the Availability of a
piece of equipment, from April 1st to April 15th.
Some OEE web pages are able to display algorithm results in different colors depending on
whether they fall within the range of a limit, thereby providing plant supervisors and
operators with a quick way to evaluate KPIs at-a-glance.
Note that:
• It is not mandatory to specify the end time of a target.
• If two limits are configured on the same piece of equipment and for the same algorithm
instance, they must be defined with the same start and end time but the range of the
limits defined by their minimum and maximum values must not overlap.

Procedure

1. On the side menu bar select the OEE KPI Analysis tab then, the Target and Limit Value
Management page.
2. Select the OEE1 algorithm from the dropdown list.
3. Select limits from the target and limit dropdown list.
4. Insert MyLimit as Name, insert a description of what you want your limit to do as
Description.
5. In the Algorithm Description field insert a description of the algorithm to which you
want to assign the limit.
6. Insert the name of the Product in the product field.
7. In the Start box fill in the day and time fields insert the required timeframe and (optional)
insert the end time and date in the End box.

SIMATIC IT OEE 2.1 SP2 - Getting Started 45

9 Configuring Targets and Limits
9.2 Configuring Targets

8. Select Percentage from the Percentage and Absolute dropdown list and insert the
required values.
9. Click Insert and then Click Save.

Note

After step 8 you can configure Triggers which trigger an event whenever the algorithm
value goes above or below them limit, this requires an appropriate Algorithm Event. For
more information see OEE Engineering Client Online Help

Procedure

To verify the target has been assigned to the algorithm:

1. Select the OEE1 algorithm from the dropdown list and MyLimits from the dropdown list.
2. Click Load. The system displays the details of the target.

Result

You have configured the Limits which can be used to add information to algorithm results.

9.2 Configuring Targets

Introduction

Targets are used to configure thresholds for algorithm results. Target are defined for
specific equipment in relation to a particular algorithm instance, within certain time span.
For instance, it is possible to define a target value of 75% for the Performance Rate of a
piece of equipment from March 21st to March 27th.
Some OEE web pages are able to display algorithm results in different colors depending on
whether they are higher or lower than targets, thereby providing plant supervisors and
operators with a quick way to evaluate KPIs at-a-glance.
Note that:
• It is not mandatory to specify the end time of a target.
• It is not possible to configure two targets for the same algorithm, on the same piece of
equipment, with overlapping time spans.
• All targets configured for the same piece of equipment and algorithm instance must have
the same name.

46 SIMATIC IT OEE 2.1 SP2 - Getting Started

 9 Configuring Targets and Limits
9.3 Viewing Targets and Limits

Procedure

1. On the side menu bar select the OEE KPI Analysis tab then, the Target and Limit Value
Management page.
2. Select the OEE1 algorithm from the dropdown list.
3. Select target from the target and limit dropdown list.
4. Insert the MyTarget as Name, insert a description of what you want your target to do as
Description.
5. In the Algorithm Description field insert a description of the algorithm to which you
want to assign the target.
6. Insert the name of the Product in the product field.
7. In the Start box fill in the day and time fields and (optional) insert the end time and date
in the End box.
8. Select Percentage from the Percentage and Absolutedropdown list, and the required
value in the field below.
9. Click Insert and then Click Save.

Note

After step 8 you can assign an alarm to a target. for more information see__OEE
Engineering Client Online Help__.

Procedure

To verify the target has been assigned to the algorithm:

1. Select the OEE1 algorithm from the dropdown list and MyTarget from the dropdown list.
2. Click Load. The system displays the details of the target.

Result

You have configured the Targets which can be used to add information to algorithm results.

9.3 Viewing Targets and Limits

Introduction

You can view Targets and Limits in the same way as you can view counters: using the KPI
Viewer page.

Procedure

To view Targets and Limits:

SIMATIC IT OEE 2.1 SP2 - Getting Started 47

9 Configuring Targets and Limits
9.3 Viewing Targets and Limits

1. Start the OEE Web Client and log in.

2. Click the Overall Equipment Effectiveness tab and click KPI Viewer in the main
workspace.
3. In the Tree View, select both Capper and Filler.
4. In the Algorithm Name dropdown menu, select and add OEE1.
5. Select CustomID as cluster.
6. Specify a Time Span within the timeframe specified in the Target/Limit and click Load.
7. (Optional) Click Settings to change the graph's visual settings, including graph type.

Result

You can now view algorithm results with their corresponding targets and limits.

48 SIMATIC IT OEE 2.1 SP2 - Getting Started

 10 Advanced Runtime Operations

Overview

This section explains how to perform some more advanced runtime operations, such as:
• Viewing algorithm results
• Forcing values for contexts
• Configuring and viewing planned downtimes
• Viewing high-level production statistics.

10.1 Viewing Algorithm results

Introduction

You can view algorithm results in the same way you can view counters: using the KPI
Viewer page.

Prerequisites

The OEE version must already have been approved. PPA Acquisition Server and Writing
Service must be stopped and then restarted.

Procedure

To view design speed records in tabular form:

1. Start the OEE Web Client and log in.
2. Click the Overall Equipment Effectiveness tab and click KPI Viewer in the main
workspace.
3. In the Tree View, select both Capper and Filler.
4. In the Algorithm Name dropdown menu, select and add the MTBF1 and the MTBA1.
5. Select CustomID as cluster.
6. Specify a Time Span of 1 hour and click Load. All counter values are shown in bar
graphs.
7. (Optional) Click Settings to change the graph's visual setting, including graph type.

Result

You can now view algorithm results grouped according to a custom field.

SIMATIC IT OEE 2.1 SP2 - Getting Started 49

10 Advanced Runtime Operations
10.2 Updating contexts at runtime

10.2 Updating contexts at runtime

Introduction

You can use the Context Management page to update context values at runtime.

Procedure

Before you can update context values, you must first modify the OEE Web Client
configuration as follows:
1. In the OEE Web Client, click the Overall Equipment Effectiveness tab and then User
OEE Configuration in the main workspace.
2. In the Context Filter section, select the CustomID context.
3. Click Save Configuration.

Procedure

To use the Context Management page:

1. In the OEE Web Client, click the Overall Equipment Effectiveness tab and then click
Context Management.
2. Select Capper. The CustomID context is shown.
3. Click Load to retrieve the current value of the CustomID context.
4. Type 6000 as the forced value and click Modify.
5. Repeat the last three steps to force the same context value for the Filler equipment
unit.
6. Verify that the context value has been changed by viewing data on another page, such
as DTM Viewer.
7. Return to the Context Management page, deselect the Forced Value checkbox and
click Modify to resume normal context acquisition.

Result

You can now force context values at runtime.

10.3 Configuring planned downtimes

Introduction

Certain downtime periods, such as scheduled maintenance or plant shutdown, are often
planned ahead of time. In this case, downtime records can be created manually using the
Planned Downtime page.

50 SIMATIC IT OEE 2.1 SP2 - Getting Started

 10 Advanced Runtime Operations
10.4 Viewing high-level production statistics

Procedure

To use the Planned Downtime page:

1. In the OEE Web Client, click the Overall Equipment Effectiveness tab and then click
Planned Downtime.
2. In the Tree View tab, select Capper.
3. Click the Reason Tree tab, and select Planned Shutdown > Scheduled Unavailability
> Maintenance.
4. Select the Add tab.
5. Select Multiple and configure the parameters as follows:

Start the current time

Duration 1 minute

Recur every 5 minutes

End after 3 occurrences

6. Click Add.

Procedure

To view the planned downtime:

1. In the OEE Web Client, click the Overall Equipment Effectiveness tab and then click
Gantt Viewer.
2. In the Tree View tab, select Capper.
3. Set the start and end times in the Data Selection control to contain the periods of
planned downtime, and click Load. The planned downtimes are shown in a different
color on the Gantt chart.

Result

You have configured and displayed the planned downtimes.

10.4 Viewing high-level production statistics

Introduction

The following web pages can be used to monitor high-level production statistics in real time:
• Runtime Operator Panel
• Equipment Comparison

SIMATIC IT OEE 2.1 SP2 - Getting Started 51

10 Advanced Runtime Operations
10.4 Viewing high-level production statistics

Procedure

Before you can view high-level production statistics, you must first modify the OEE Web
Client configuration as follows:
1. In the OEE Web Client, click the Overall Equipment Effectiveness tab then click User
OEE Configuration in the main workspace.
2. In the Algorithms section, configure the following settings:

Setting Value

Counter GoodPieces

Availability Algorithms Availability1

Performance Algorithms PerformanceRate1

QualityRate1 !
3. Click Save Configuration.

Procedure

To use the Runtime Operator Panel page:

1. In the OEE Web Client, click the Overall Equipment Effectiveness tab.
2. Click Runtime Operator Panel.
3. In the main workspace, select Capper and click Start Refresh. The current value of the
GoodPieces counter for the Capper equipment unit is shown in the Production Chart:
this value is automatically updated every minute.
4. Click the OEE Chart tab to view a trend chart of the Availability, Performance Rare,
Quality Rate and OEE of the Capper equipment unit.
5. In the Current Context Value section, select CustomID. The current value for the
CustomID context is displayed.
6. Repeat the last three steps to view the same data for the Filler equipment unit.

Procedure

To use the Equipment Comparison page:

1. In the OEE Web Client, click the Overall Equipment Effectiveness tab.
2. Click Equipment Comparison. The following data are displayed for each equipment
unit:
• OEE Calculations (OEE, Performance Rate, Quality, Availability)
• Counter Data (GoodPieces value)

3. (Optional) Click Manual Refresh to refresh the page (otherwise, the page will be
refreshed every minute).

52 SIMATIC IT OEE 2.1 SP2 - Getting Started

 10 Advanced Runtime Operations
10.5 Using the Operator Pages.

Result

You can now view high-level runtime data using the Runtime Operator Panel and the
Equipment Comparison pages.

10.5 Using the Operator Pages.

Introduction

Besides using the standard OEE Web Client pages, SIMATIC IT OEE includes a set of
Operator Pages optimized for touch panel usage.
By using these pages, it is possible to:
• Monitor the current status of one or more production lines and their respective machines.
• Display a production overview for a specific line.
• Update the current and past machine statuses, by justifying, adding or updating stops.

For information on:

• Configuration of the operator pages see SIMATIC IT OEE Operator Pages Configuration
Online Help.
• Runtime usage of the operator pages see SIMATIC IT OEE Use Case Catalog.

SIMATIC IT OEE 2.1 SP2 - Getting Started 53

 11 Reporting OEE Data

Overview

This section explains how to retrieve specific sets of data from the OEE database using
dedicated OEE standard reports (.rep and .webi reports) provided by SIMATIC IT Report
Manager.
To retrieve data with Report Manager, you must:
1. Create an OEE project and add connections to the OEE database within the Report
Manager Console environment.
2. Install Standard Reports.
3. Run the reports of interest.
4. If necessary, perform additional operations, such as changing the layout of reports,
performing calculations, inserting charts and/or saving the report with different
document formats.

11.1 Creating a project

Prerequisite

Check that all Report Manager and Business Objects Services are started (Start > All
Programs > BusinessObjects XI Release 2 > BusinessObjects Enterprise > Central
Configuration Manager).

Procedure

1. Launch Report Manager Console (Start > All Programs > SIMATIC > SIMATIC IT >
Components > Report Manager > Report Manager Console).
2. Select File > New > Project.
3. In the Project Parameters dialog box, type "MyOEEProject" as the name of the project
and click Next.
4. In the Connection Parameters dialog box, configure the following and click OK.

Parameter Description

Database SQL Server.

Component Historian.

User A valid SQL Server login.

Password A valid SQL Server login.

54 SIMATIC IT OEE 2.1 SP2 - Getting Started

 11 Reporting OEE Data
11.2 Installing Standard Reports

Server Name of the SQL server hosting the CMS database.

Database Name of the database containing OEE data.

5. In the Runtime User Information dialog box, enter the user name and password for a
runtime user (which is usually configured with 'read' rights).
6. If an upgrade is required, a confirmation dialog box is displayed: click Yes.

11.2 Installing Standard Reports

Introduction

Standard Reports can have the following extensions:

• .rep
• .webi

.rep reports are installed by Report Manager in the Administration Tool environment
(Report Manager Console), whereas .webi reports are delivered as BIAR files and must
be installed manually.
WebI reports are located inside the RMAdminToolDataV6.4.zip file under
%ICUBESYS%\SIT\RM\DATA.
In this Getting Started online help, examples are given with both types of standard reports.
Therefore, both procedures below must be followed after creating a project and before
running the reports.

Procedure

To install standard reports (.rep):

1. In Report Manager Console, right-click the MyOEEProject project and select Install
Standard Reports.

Procedure

To install standard reports (.webi):

1. Start BO Import Wizard (Start > All Programs > BusinessObjects XI Release 2 >
BusinessObjects Enterprise).
2. In the Source Environment step, select the *BIAR option from the Source list box.
3. In the BIAR file box, type the file name with the file path and click Next.
4. In the Destination Environment step, select the RM Server with the project you
require, enter your BO credentials and click Next.
5. In the Select Objects to import step, select all objects and click Next.
6. In the Incremental Import step, leave the default settings and click Next.
7. In the A note on importing server groups step, click Next.
8. In the Users and groups step, leave the default settings and click Next.

SIMATIC IT OEE 2.1 SP2 - Getting Started 55

11 Reporting OEE Data
11.3 Running the Downtime detail report

9. In the Categories step, leave the default settings and click Next.
10. In the Folders and objects step, select the BIAR files you require and click Next.
11. In the Select application folders and objects step, leave the default settings and click
Next.

Result

Standard Reports are imported into the RM repository, under specific folders (for example,
EBR and EBR KPI can be found under the Public Folder > Batch folder; the OEE-DTM
reports can be found under Production > OEE-DTM).
To be used, they must be linked to the correct universe.

11.3 Running the Downtime detail report

Introduction

The Downtime Detail report retrieves data concerning details on a specific selected
downtime from the database.
For a specific downtime record, pertaining to a specific equipment, this report displays the
start and end times, as well as the status duration expressed in terms of time category and
reason tree levels.
This report must be run from the RM InfoView environment.

Procedure

1. Log on to InfoView (Start > All Programs > BusinessObjects XI Release 2 >
BusinessObjects Enterprise).
2. Select the checkbox next to Downtime Detail report and click Modify.
3. Click Edit Query.
4. Click the Properties tab and then click the Browse button next to the Universe box.
5. Select the renamed standard universe created for your project (it should be Univ.
SIMATIC IT Historian PPA for MyOEEProject) and click OK.
6. In the Change Source dialog box, leave the default mappings and click OK.
7. Click Run Queries in the toolbar.
8. In the Prompts dialog box, select or type the required prompt values and click Run
Query.
9. Click Save in the toolbar to apply the settings.

Note

If you do not perform steps 8-9, the changes regarding the universe cannot be saved.

56 SIMATIC IT OEE 2.1 SP2 - Getting Started

 11 Reporting OEE Data
11.4 Running the OEE-DTM (on-the-fly calculation) report

11.4 Running the OEE-DTM (on-the-fly calculation) report

Introduction

This report executes a user-specified algorithm on-the-fly and displays the result in a bar
graph.

Prerequisites

Check that:
• The sql_oee.msi installer has been executed.
• OEE Web Service URL has been set.

Tip

For more information, see OEE Installation Manual.

Procedure

1. Approve the OEE configuration.

2. Approve and run the PPA configuration.
3. Start Report Manager Reporter (Start > All Programs > SIMATIC > SIMATIC IT >
Components > Report Manager > Reporter).
4. Open the OEE-DTM On The- Fly calculation.rep report (File > Import from
Repository> OEE-DTM).
5. Refresh data.
6. In the Enter or Select Values dialog box, set the following parameters:

Parameter Description

Start Time Type the start time with the format YYYY/MM/DD HH:mm:ss.

End Time Type the end time with the format YYYY/MM/DD HH:mm:ss.

Equipment Select the equipment name from the list of values, or manually type the
list equipment names you require (separated by a comma).

Algorithm Select an algorithm or a counter from the list of values.

Cluster Select a cluster from the list of values.

Cluster Type the cluster interval.

interval

SIMATIC IT OEE 2.1 SP2 - Getting Started 57

11 Reporting OEE Data
11.5 Running the OEE-DTM Line Efficiency report

Sub Select a sub cluster from the list of values. The value “none” is acceptable
Cluster if you want to leave the filter empty.

Note

If “none” is selected, the Sub Cluster Interval must be “0”.

Sub Type the sub cluster interval.

Cluster
Interval

7. Click OK.

11.5 Running the OEE-DTM Line Efficiency report

Introduction

This report shows the results of any previously-executed algorithms. Choose a Calculation
ID from the list of values.

Procedure

1. Start Report Manager Reporter (Start > All Programs > SIMATIC > SIMATIC IT >
Components > Report Manager > Reporter).
2. Open the OEE-DTM Line Efficiency.rep report (File > Import from Repository> OEE-
DTM).
3. Refresh data.
4. In the Enter or Select Values dialog box, type a value or click Values to select a KPI
calculation value from a list of available values.
5. Click OK.

58 SIMATIC IT OEE 2.1 SP2 - Getting Started