CMS X-Tools Analyzing Bundle 1 User Manual - V XX - xx.EN

CMS X-Tools Analyzing Bundle 1 – User Manual CMS
Preface 1
Scope of Delivery 2
Installation 3
CMS X-Tools Analyzing Bundle 1

User Manual - 01 - Introduction Product Characteristics 4
List of Abbreviations 5
English
Release 2017-09 Contact Information 6
English
Release 2017-09 1 / 60
Safety Guidelines
This document contains notices which you should observe to ensure your own personal safety as well as to avoid property damage. The
notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring to property damage only
have no safety alert symbol
Danger
Indicates an imminently hazardous situation which, if not avoided, will result in death or serious injury.
Warning
Indicates a potentially hazardous situation which, if not avoided, could result in death or serious injury.
Caution
Used with the safety alert symbol indicates a potentially hazardous situation which, if not avoided, may result in minor or
moderate injury.
Notice
Used without the safety alert symbol indicates a potential situation which, if not avoided, may result in an undesirable result or
state.
When several danger levels apply, the notices of the highest level (lower number) are always displayed. If a notice refers to personal
damages with the safety alert symbol, then another notice may be added warning of property damage.
Qualified Personnel
The device/system may only be set up and operated in conjunction with this documentation. Only qualified personnel should be allowed to
install and work on the equipment. Qualified persons are defined as persons who are authorized to commission, to earth, and to tag cir-
cuits, equipment and systems in accordance with established safety practices and standards.
Intended Use
Please note the following:
Warning
This device and its components may only be used for the applications described in the catalog or technical description, and
only in connection with devices or components from other manufacturers approved or recommended by Siemens. This prod-
uct can only function correctly and safely if it is transported, stored, set up and installed correctly, and operated and main-
tained as recommended.
Trademarks
All designations marked with ® are registered trademarks of Siemens AG. Other designations in this documentation might be trademarks
which, if used by third parties for their purposes, might infringe upon the rights of the proprietors.
Copyright Siemens AG 2016. All rights reserved.
Reproduction, transmission or use of this document or its contents is not permitted without express written authority. Offenders will be
liable for damages. All rights, including rights created by patent grant or registration of a utility model or design, are reserved.
Disclaimer of Liability
We have checked the contents of this document for agreement with the hardware and software described. Since deviations cannot be
precluded entirely, we cannot guarantee full agreement. However, the data in the manual are reviewed regularly, and any necessary cor-
rections will be included in subsequent editions. Suggestions for improvement are welcomed.
Siemens AG
DF PL DS PAS R&D
91056 Erlangen Siemens AG 2016
Germany Technical data subject to change
English
Release 2017-09 2 / 60
Table of Contents
1 Preface .......................................................................................................................................... 6
1.1 Purpose of this Document ......................................................................................................... 6
1.2 Validity of this Document ........................................................................................................... 6
1.3 Audience ...................................................................................................................................6
1.4 Notations................................................................................................................................... 7
2 Scope of Delivery ........................................................................................................................... 8
2.1 Scope of Delivery ...................................................................................................................... 8
2.2 Unpacking and Checking........................................................................................................... 8
3 Installation...................................................................................................................................... 9
3.1 Licenses.................................................................................................................................... 9
3.2 Analyzing Bundle 1 ................................................................................................................. 10
4 Product Characteristics ................................................................................................................ 12
4.1 Introduction ............................................................................................................................. 12
4.1.1 What is CMS X-Tools? ....................................................................................................... 12
4.1.2 What is Analyzing Bundle 1? .............................................................................................. 12
4.2 General ................................................................................................................................... 13
4.2.1 Example Parameters .......................................................................................................... 13
4.3 Analyzing Functions ................................................................................................................ 14
4.3.1 AB1License ........................................................................................................................ 14
4.3.2 AddLogEntry ...................................................................................................................... 15
4.3.3 AlarmHandle ...................................................................................................................... 18
4.3.4 AlrmNotify .......................................................................................................................... 21
4.3.5 ConvToCSVCV .................................................................................................................. 23
4.3.6 ConvToUFF ....................................................................................................................... 26
4.3.7 ConvToUFFSV ................................................................................................................... 30
4.3.8 FilesCount .......................................................................................................................... 35
4.3.9 InLubCosH2O .................................................................................................................... 37
4.3.10 InOPCom2 ......................................................................................................................... 39
4.3.11 InOPComFerroS ................................................................................................................ 41
4.3.12 PhsClc ............................................................................................................................... 43
4.3.13 SendReport ........................................................................................................................ 45
4.3.14 SymCom ............................................................................................................................ 51
4.3.15 TraceBuffer ........................................................................................................................ 54
5 List of Abbreviations ..................................................................................................................... 58
6 Contact Information ...................................................................................................................... 60
English
Release 2017-09 3 / 60
Table of Figures
Figure 1: Licenses – X-Tools licenses within the Automation License Manager................................................. 9

Figure 2: Licenses – Server log entries ............................................................................................................. 9
Figure 3: Analyzing Bundle 1 – Install (part 1) ..................................................................................................10
Figure 4: Analyzing Bundle 1 – Install (part 2) ..................................................................................................10
Figure 5: Analyzing Bundle 1 – Analyzing Functions ........................................................................................11
Figure 6: AB1 License – Analyzing Function ....................................................................................................14
Figure 7: AddLogEntry – Analyzing Function ....................................................................................................15
Figure 8: AddLogEntry – Analyzing Model ........................................................................................................15
Figure 9: AddLogEntry – error log entry............................................................................................................15
Figure 10: AddLogEntry – folders within XTS directory .....................................................................................16
Figure 11: AddLogEntry – status file.................................................................................................................16
Figure 12: AlarmHandle – Analyzing Function ..................................................................................................18
Figure 13: AlarmHandle – Analyzing Model ......................................................................................................19
Figure 14: AlarmHandle – Monitoring View.......................................................................................................20
Figure 15: AlrmNotify – Analyzing Function ......................................................................................................21
Figure 16: AlrmNotify – Analyzing Model ..........................................................................................................21
Figure 17: ConvToCSVCV – Analyzing Function ..............................................................................................23
Figure 18: ConvToCSVCV – Analyzing Model ..................................................................................................24
Figure 19: ConvToCSVCV – Analyzing Model File ...........................................................................................25
Figure 20: ConvToCSVCV – CSV file storage location .....................................................................................25
Figure 21: ConvToCSVCV – created CSV file ..................................................................................................25
Figure 22: ConvToCSVCV – CSV file ...............................................................................................................25
Figure 23: ConvToUFF – Analyzing Function ...................................................................................................26
Figure 24: ConvToUFF – Analyzing Model .......................................................................................................27
Figure 25: ConvToUFF – created UFF file (Append) ........................................................................................28
Figure 26: ConvToUFF – UFF file (Append) .....................................................................................................28
Figure 27: ConvToUFFSV – Analyzing Function ..............................................................................................30
Figure 28: ConvToUFFSV – Analyzing Model ..................................................................................................31
Figure 29: ConvToUFFSV – created UFF file (Close) .......................................................................................32
Figure 30: ConvToUFFSV – UFF file (Close) ...................................................................................................32
Figure 31: FilesCount – Analyzing Function .....................................................................................................35
Figure 32: FilesCount – Analyzing Script ..........................................................................................................35
Figure 33: FilesCount – Monitoring View ..........................................................................................................36
Figure 34: InLubCosH2O – Analyzing Function ................................................................................................37
Figure 35: InLubCosH2O – OPCom2 structure of the impulse signal ................................................................37
Figure 36: InLubCosH2O – Analyzing Model ....................................................................................................38
Figure 37: InOPCom2 – Analyzing Function .....................................................................................................39
Figure 38: InOPCom2 – OPCom2 structure of the impulse signal .....................................................................39
Figure 39: InOPCom2 – Analyzing Model .........................................................................................................40
Figure 40: InOPComFerroS – Analyzing Function ............................................................................................41
English
Release 2017-09 4 / 60
Figure 41: InOPComFerroS – OPComFerroS structure of the impulse signal ...................................................41

Figure 42: InOPComFerroS – Analyzing Model ................................................................................................42
Figure 43: PhsClc – Analyzing Function ...........................................................................................................43
Figure 44: PhsClc – Analyzing Model ...............................................................................................................43
Figure 45: PhsClc – Monitoring View ................................................................................................................44
Figure 46: SendReport – Analyzing Function ...................................................................................................45
Figure 47: SendReport – Analyzing Model .......................................................................................................45
Figure 48: SendReport – folders within XTS directory.......................................................................................46
Figure 49: SendReport – TCP IP Test Server (startup) .....................................................................................47
Figure 50: SendReport – TCP IP Test Server (socket) .....................................................................................47
Figure 51: SendReport – TCP IP Test Server (configure) .................................................................................48
Figure 52: SendReport – TCP IP Test Server (listen) .......................................................................................48
Figure 53: SendReport – TCP IP Test Server (report) ......................................................................................48
Figure 54: SendReport – text file ......................................................................................................................49
Figure 55: SendReport – matching entry ..........................................................................................................49
Figure 56: SendReport – log file .......................................................................................................................49
Figure 57: SymCom – Analyzing Function ........................................................................................................51
Figure 58: SymCom – Analyzing Model ............................................................................................................52
Figure 59: SymCom – Monitoring View ............................................................................................................53
Figure 60: TraceBuffer – Analyzing Function ....................................................................................................54
Figure 61: TraceBuffer – Analyzing Model ........................................................................................................55
Figure 62: TraceBuffer – Monitoring View.........................................................................................................56
English
Release 2017-09 5 / 60
1 Preface
1.1 Purpose of this Document
This document provides an introduction about the functionalities and usage of the following X-Tools Analyzing
Functions:
∂ Analyzing Bundle 1 V xx.xx
In addition to the introduction which is found within this document and which provides an overview about the
available functionality, the following documentation is available for detailed information:
∂ CMS X-Tools Library User Manual - V xx.xx.pdf
o provides detailed information about used User Functions, which are not X-Tools standard
1.2 Validity of this Document
This document is valid for the following software:

∂ CMS X-Tools V xx.xx
1.3 Audience
This document is intended for personnel involved in the commissioning and using of the software:
∂ CMS X-Tools
English
Release 2017-09 6 / 60
1.4 Notations
The following notations are used within this document:

∂ bold, italic text is being used for the main executables of X-Tools
∂ bold text is being used for the software modules of X-Tools
o examples: Main Management System, Device Profile Editor, IPE Socket T001
∂ green text is being used for controls like tables and trees
o examples: Main Profile Settings table, Device Profile Data table
∂ orange text is being used for simple controls like a menu button, a single row/column/cell of a table or a
branch of a tree
o examples: Open… menu button, IP Address column, Target Device Name cell, Interfaces Branch
∂ dark yellow text is being used for the entries of context menus
o examples: Advanced Append…, Edit
∂ Camel Notation is being used for major terms of X-Tools
o examples: Main Profile, Interface Profile, User Accounts File, Analyzing Function
∂ < and > brackets are being used for keyboard keys
o examples: <Ctrl>, <Alt>, <Shift>, <Del>
∂ [ and ] brackets are being used for mouse operations
o examples: [left mouse button down], [mouse move]
English
Release 2017-09 7 / 60
2 Scope of Delivery
2.1 Scope of Delivery
What is shipped?
∂ Analyzing Bundle 1 V xx.xx
2.2 Unpacking and Checking
After unpacking, please check

∂ the packet for completeness and
∂ all parts for transport damage.
Notice
Do not use any parts that show evidence of damage!
English
Release 2017-09 8 / 60
3 Installation
3.1 Licenses
Before the Analyzing Functions of the Analyzing Bundle 1 can be used, the following valid licenses have to be
present within the Automation License Manager.
Figure 1: Licenses – X-Tools licenses within the Automation License Manager

A license check is performed during each X-Tools Server startup. Valid licenses generate the following Server
log entries.
Figure 2: Licenses – Server log entries
English
Release 2017-09 9 / 60
3.2 Analyzing Bundle 1
The CM Library requires the Analyzing Functions of the Analyzing Bundle 1. In order to install these Analyzing
Functions the correct zip file has to be chosen which matches to the present operating system platform (x32 or
x64). After extraction of the zip file, the Install.exe can be executed. It is not necessary to shut down the X-
Tools Server and the Client before the installation.
Figure 3: Analyzing Bundle 1 – Install (part 1)

When executing the Install.exe it is recommended to use Full Installation. The next steps have to be followed
whereby the installer automatically recognizes the correct X-Tools Server directory, if a suitable version of the
Analyzing Bundle 1 has been chosen.
Figure 4: Analyzing Bundle 1 – Install (part 2)

After the dll files have been installed they appear within the Analyzing System Explorer below section -> Li-
braries -> Analyzing Functions -> Analyzing Bundle 1.
English
Release 2017-09 10 / 60
Figure 5: Analyzing Bundle 1 – Analyzing Functions

A detailed description of each Analyzing Function provided by the Analyzing Bundle 1 is found in the X-Tools
Server directory “C:\Program Files\Siemens\CMS X-Tools Pro\Documents\CMS X-Tools (All Editions) Analyzing
Bundle 1.EN.pdf”.
English
Release 2017-09 11 / 60
4 Product Characteristics
4.1 Introduction
4.1.1 What is CMS X-Tools?
CMS X-Tools is a cost-effective, modular, PC-based measurement system, which has been specially optimized
to perform reactionless measurement of analog, binary and numerical signals in industrial plants. It consists out
of a PC-based software (CMS X-Tools) and various types of measurement devices (IONs, IFNs and CTNs)
With a sampling rate of up to 192 kHz, even highly dynamic processes and occurrences can be recorded with
high resolution. The system is used as a portable and/or installed unit in the fields of research & development,
testing, error tracking and production.
Input and output signals are handled by individual devices. To accommodate a higher number of signals, basi-
cally up to 62 devices can be networked over the IEEE1394 bus system and can be connected to any PC, lap-
top or server with an IEEE1394 interface.
Despite the considerable features of the system, an experienced technician, with no prior knowledge about
CMS X-Tools, can carry out measurements within a very short period of time. Simple measurement tasks, such
as paperless recording of plant signals or fault recording, are quickly and effectively carried out.
For higher sophisticated measurements, such as remote service & maintenance or condition monitoring, a high
level of graphical configuration and parameterization is possible within CMS X-Tools. In addition, the powerful
trigger machine and the analyzing engine enable the user to perform more extensive measurement tasks.
The following topics provide a short overview about the functionalities of the main parts of the CMS X-Tools
software.
For detailed information about CMS X-Tools please refer to the documentation delivered with CMS X-Tools
4.1.2 What is Analyzing Bundle 1?
The Analyzing Bundle 1 provides application specific Analyzing Functions which are not content of the stand-
ard Analyzing Function library.
English
Release 2017-09 12 / 60
4.2 General
4.2.1 Example Parameters
The Analyzing Model Parameters as well as the Offline Time Configurations (if necessary) which are used for
the illustrations in this document have been chosen according to the given input values in order to produce valid
results. These parameters and settings shall not be taken as default for other Configuration Files.
Furthermore the Analyzing Model Files as well as the corresponding Monitoring View Files are content of the
CM Training Location. For training purposes these Analyzing Models Parameters can be modified as well as the
input values for a subsequently re-execution of the Analyzing Model Files.
English
Release 2017-09 13 / 60
4.3 Analyzing Functions
4.3.1 AB1License
Purpose of the Analyzing Function AB1License is to prohibit the application of the User Functions which are
content of the CM Library whenever a valid X-Tools Analysis Library license is not present within the Automa-
tion License Manager. AB1License is contained in each User Function and is not compiled by the X-Tools
Server without a valid license what results in not-executable User Functions.
Figure 6: AB1 License – Analyzing Function

In the following table all input-/ output arguments of the Analyzing Function are found.
Full Name Short Name Description
Input(s) Enable EN enables or disables the internal calculation
Output(s) Output0 Out0 indicates whether the license check was successful
English
Release 2017-09 14 / 60
4.3.2 AddLogEntry
Purpose of the Analyzing Function AddLogEntry is to generate a specific log entry according to the given inte-
ger alarm and warning values received by the Analyzing Function AlarmHandle. This log entry is written with
priority class error to the system. Among others this log entry consists out of these received integer values for
alarm- and warning which can be extracted and decrypted afterwards by the Analyzing Function SendReport.
Figure 7: AddLogEntry – Analyzing Function

The following table shows the Analyzing Model Parameters and the Offline Time Configuration which have been
used for this example.
Analyzing Model Parameters
Calculation Mode Equidistant
Cycle Time [Hz] 1

Output Data Class Offline
Offline Time Configuration

Time Input Mode Minimum Time and Time Interval
Minimum Time Format None (use Start Time of the Analyzing Model)
Time Interval Format s
Time Interval Value 1
Figure 8: AddLogEntry – Analyzing Model

AddLogEntry creates the log entry accordingly as it is shown in the following figure.
Figure 9: AddLogEntry – error log entry
English
Release 2017-09 15 / 60
After the Analyzing Model has been started for the first time, the folder SendReport is created within the X-
Tools Server directory and contains the conditions of all processed AddLogEntry Analyzing Functions. This
folder is also used by SendReport.
Figure 10: AddLogEntry – folders within XTS directory

The conditions of one AddLogEntry are stored in a file as the following figure shows. A new entry is only creat-
ed in case of changing conditions or the number of same status has been reached (NoSts).
Figure 11: AddLogEntry – status file
English
Release 2017-09 16 / 60
In the following table all input-/ output arguments of the User Function are found.
System Sys name of the system

Subsystem SubSys name of the subsystem
Component Comp name of the component
ID ID ID number
AlarmCode ACode input for integer alarm value
Input(s)
WarningCode WCode input for integer warning value
NumberOfStatus NoSts receives the number of same status cycles which have to be reached to
initiate a new log entry
Value Value receives the value which shall be sent

CodeType CodeType name of the sensor type (txt file with error description)
Output(s) OutputReady OutRdy indicates whether a log entry has been created
English
Release 2017-09 17 / 60
4.3.3 AlarmHandle
Purpose of the Analyzing Function AlarmHandle is to convert up to 16 given control values. Resulting quanti-
ties are two integer values for alarm and warning which are intended to be received by the Analyzing Function
AddLogEntry.
Figure 12: AlarmHandle – Analyzing Function
English
Release 2017-09 18 / 60

Cycle Time [Hz] 1

Minimum Time Format 2016-01-01 00:00:00:000.000.000

Figure 13: AlarmHandle – Analyzing Model
English
Release 2017-09 19 / 60
Depending on which control values are currently present at the inputs, the corresponding integer alarm- and
warning values are generated.
The alarm integer value is the sum of all inputs with value “2”.
6 10 14
-> 2 + 2 + 2 = “17472” (alarm integer).
The warning integer value is the sum of all inputs with value “1”.
-> 20 + 23 + 28 + 29 211 = “2825” (warning integer).
Figure 14: AlarmHandle – Monitoring View

Input0 In0 input integer control value which shall be used for conversion
Input(s) Input8 In8 input integer control value which shall be used for conversion
Enable EN enables or disables the internal calculation
OutAlarm OutA receives the conversion result of the control values for alarm
Output(s)
OutWarning OutW receives the conversion result of the control values for warning
English
Release 2017-09 20 / 60
4.3.4 AlrmNotify
Purpose of the Analyzing Function AlrmNotify is the interaction with CMS X-Tools Alarm Configurator. Infor-
mation about occurring status changes are stored within a Ini-File. The creation and change of these Ini-Files
are recognized by CMS X-Tools Alarm Configurator and are afterwards listed up within an Alarm List. Alrm-
Notify checks the presence of its created Ini-File. If it does not exist, the status changes has been acknowl-
edged by CMS X-Tools Alarm Configurator and AlrmNotify is then able to again indicate new status chang-
es. At the output “Status” value “true” is put for one cycle in case a new status change has been created. This
way it is possible to trigger mail notification in addition.
Figure 15: AlrmNotify – Analyzing Function

The following table shows the Analyzing Model Parameters which have been used for this example.
Cycle Time [Hz] 1

Output Data Class Online
Figure 16: AlrmNotify – Analyzing Model
English
Release 2017-09 21 / 60
DataName DataName specifies the ID for the alarm notification

Type Type specifies the type for the alarm notification
PGNumber PGNo specifies the used parameter group number
OSGNumber OSGNo specifies the active operating state group number

Input(s) OSNumber OSNo specifies the active operating state number
Control Cntrl specifies the actual control value

Warning Warn receives the actual warning level
Alarm Alrm receives the actual alarm level

Output(s) Status Status receives the result if the alarm is acknowledged
English
Release 2017-09 22 / 60
4.3.5 ConvToCSVCV
Purpose of the Analyzing Function ConvToCSVCV is to convert the given input values into a CSV file. Typically
characteristic values such as RMS, peak-peak etc. are used to be stored.
Figure 17: ConvToCSVCV – Analyzing Function
English
Release 2017-09 23 / 60

Cycle Time [kHz] 1

Figure 18: ConvToCSVCV – Analyzing Model

The CSV file creation is initiated every time the input “InReady” receives a rising edge. At the time this input
receives a rising edge the values of the inputs “In0” – “In19” are stored into a CSV file. The output path of the
files is created according to the folder structure of the Analyzing System Explorer where the Analyzing Model
has been executed plus the static folders “MTE” and “Reports” of the corresponding location. The name of the
resulting CSV file is equal to the name of the Analyzing Model.
English
Release 2017-09 24 / 60
Following figures are intended to show how the file creation is done.
Figure 19: ConvToCSVCV – Analyzing Model File

This Analyzing Model is located in the Analyzing System Explorer as it is shown and started which results in the
creation of additional folders within …/MTE/Reports/.
Figure 20: ConvToCSVCV – CSV file storage location

Name of the CSV file is identical to the name of the parent Analyzing Model.
Figure 21: ConvToCSVCV – created CSV file

Based on the given inputs this CSV file contains the following characteristic values.
Figure 22: ConvToCSVCV – CSV file

InputReady InReady initiates the creation of a new CSV file
Input(s) Input0 – Input19 In0 – In19 Input(s) for characteristic value(s)

Output(s) OutputReady OutReady indicates whether the CSV file has been created
English
Release 2017-09 25 / 60
4.3.6 ConvToUFF
Purpose of the Analyzing Function ConvToUFF is to convert the given spectra or a single spectrum into an UFF
file. Additional information such as motor speed and motor current can be converted as well.
Figure 23: ConvToUFF – Analyzing Function
English
Release 2017-09 26 / 60

Cycle Time [kHz] 1

Time Interval Value 2.048
Figure 24: ConvToUFF – Analyzing Model

This Analyzing Function is typically implemented directly within the Analyzing Model which calculates the spec-
tra. If several spectra from different Analyzing Models shall be stored in one and the same UFF file, the input
“ID” can be used to number each row of the UFF file accordingly. For instance the first spectrum obtains the “ID”
“1” using “FileOption” “create”. Following spectra during subsequent calculations obtain an incremented “ID”
using “FileOption” “append”. For the last spectrum “FileOption” “close” has to be used in order to add the last
spectrum and to close the UFF file except the Analyzing Function ConvToUFFSV is used afterwards.
Before closing the UFF file, “MotorSpeed” and “MotorCurrent” are added in separate rows as well as the
timestamp.
English
Release 2017-09 27 / 60
Based on the given input values, the next figures show the correspondingly created UFF file.
Figure 25: ConvToUFF – created UFF file (Append)
Index 1
Figure 26: ConvToUFF – UFF file (Append)
English
Release 2017-09 28 / 60
In the following table the index 1 – 15 of the UFF file is described.

Index Type Unit
1 Acceleration m/s²
Input0 In0 input for the spectrum
MotorCurrent MotorCurrent input for motor current in A stored in record 4

MotorSpeed MotorSpeed input for motor speed in rpm stored in record 5
ID ID input for the spectrum ID

Input(s) FileOption FileOption option to choose between creating a new file, appending to an existing file
or closing the file
Path Path output path of the stored file (e.g.: c:/storage/UFF)

FileName FileName output name of the stored UFF file
Output(s) OutputReady OutReady indicates whether a new UFF file has been created
English
Release 2017-09 29 / 60
4.3.7 ConvToUFFSV
Purpose of the Analyzing Function ConvToUFFSV is to add the given values to an existing UFF file. Con-
vToUFFSV depends to the Analyzing Function ConvToUFF and therefore both Analyzing Functions are intend-
ed to be implemented as a bundle.
Figure 27: ConvToUFFSV – Analyzing Function
English
Release 2017-09 30 / 60

Cycle Time [Hz] 1

Figure 28: ConvToUFFSV – Analyzing Model

This Analyzing Function is executed after an UFF file has been created using “FileOption” “Create” or “Append”.
The given input values are added to the UFF file and afterwards the UFF file is closed.
English
Release 2017-09 31 / 60
Based on the given input values, the next figures show the correspondingly created UFF file.
Figure 29: ConvToUFFSV – created UFF file (Close)

Index 16
Index 17
Index 18
Index 19
Figure 30: ConvToUFFSV – UFF file (Close)
English
Release 2017-09 32 / 60
In the following table the index 16 – 37 of the UFF file is described.

Index Type Unit
16 Time s
17 Speed rpm
18 Current A
19 Voltage V
20 Power kW
21 Temperature °C
22 Temperature °C
23 Temperature °C
24 Temperature °C
25 Temperature °C
26 Temperature °C
27 Temperature °C
28 Temperature °C
29 Temperature °C
30 Temperature °C
31 Temperature °C
32 Temperature °C
33 Temperature °C
34 Temperature °C
35 Temperature °C
36 Temperature °C
37 Temperature °C
English
Release 2017-09 33 / 60
MotorCurrent MotorCurrent input for motor current in A stored in record 4

MotorSpeed MotorSpeed input for motor speed in rpm stored in record 5
Input0 In0 input for single value with index 19



Input(s) Input8 In8 input for single value with index 27





Output(s) OutputReady OutReady indicates whether a new UFF file has been created
English
Release 2017-09 34 / 60
4.3.8 FilesCount
Purpose of the Analyzing Function FilesCount is to count the files within a specific folder recursively.
Figure 31: FilesCount – Analyzing Function

The following table shows the Analyzing Script Parameters which have been used for this example.
Analyzing Script Parameters
Operating Mode Sequential
Calculation Mode N/A
Figure 32: FilesCount – Analyzing Script
English
Release 2017-09 35 / 60
Bases on the given input values, the next figure shows the correspondingly counted files within the specified
folder.
Figure 33: FilesCount – Monitoring View

Path Path specifies the path for the file counting
TimeInterval TmIntvl specifies the time interval for the file counting in hours
Input(s)
EnableTimeInterval ENTmIntvl enables or disables the time interval for the file counting
Output(s) NumberOfFiles NoF receives the result of the file counting
English
Release 2017-09 36 / 60
4.3.9 InLubCosH2O
Purpose of the Analyzing Function InLubCosH2O is to read and convert an impulse signal received from an
OPCom2 sensor in order to obtain the corresponding measurement information. Resulting quantities are tem-
perature, humidity, permittivity, conductivity, permittivity- and conductivity at 40°C, aging process and the filling
level if correct sensor available.
Figure 34: InLubCosH2O – Analyzing Function

The following figure is intended to explain the structure of the impulse signal which is read in and converted by
InLubCosH2O.
Figure 35: InLubCosH2O – OPCom2 structure of the impulse signal

The measurement information are obtained sequentially according to the structure of the received impulse sig-
nal. For detailed information regarding this sensor refer to the corresponding documentation.
English
Release 2017-09 37 / 60

Cycle Time [Hz] 10
Figure 36: InLubCosH2O – Analyzing Model

Input0 In0 impulse signal of the OPCom2 sensor

Offset Offst specifies the offset of the impulse signal
Input(s)
EnableLevel ENLvl enables or disables the reading of the level
OutputTemperature OutT receives the result of the LubCosH2O temperature measurement
OutputHumidity OutH receives the result of the LubCosH2O humidity measurement

OutputPermittivity OutP receives the result of the LubCosH2O permittivity measurement
OutputConductivity OutC receives the result of the LubCosH2O conductivity measurement

Output(s)
OutputPermittivity40 OutP40 receives the result of the LubCosH2O permittivity measurement at 40°C
OutputConductivity40 OutC40 receives the result of the LubCosH2O conductivity measurement at 40°C
OutputAgingProcess OutAP receives the result of the LubCosH2O aging process measurement
OutputLevel OutL receives the result of the LubCosH2O level measurement
English
Release 2017-09 38 / 60
4.3.10 InOPCom2
Purpose of the Analyzing Function InOPCom2 is to read and convert an impulse signal received from an OP-
Com2 sensor in order to obtain the corresponding measurement information. Resulting quantities are an order
number for each of the defined particle sizes.
Figure 37: InOPCom2 – Analyzing Function

InLubCosH2O.
Figure 38: InOPCom2 – OPCom2 structure of the impulse signal

English
Release 2017-09 39 / 60

Cycle Time [Hz] 10
Figure 39: InOPCom2 – Analyzing Model

Input0 In0 impulse signal of the OPCom2 sensor

Input(s) Offset Offst specifies the offset of the impulse signal
OutputParticle4µm OutP4µm receives the result of the OPCom2 order analysis for 4um particles
Output(s)
English
Release 2017-09 40 / 60
4.3.11 InOPComFerroS
Purpose of the Analyzing Function InOPComFerroS is to read and convert an impulse signal received from an
OPCom2 sensor in order to obtain the corresponding measurement information. Resulting quantities are tem-
perature, occupancy rate sum, occupancy rate fine, occupancy rate chunk, clean counter, chunk counter and
cleanup.
Figure 40: InOPComFerroS – Analyzing Function

InOPComFerroS.
Figure 41: InOPComFerroS – OPComFerroS structure of the impulse signal

English
Release 2017-09 41 / 60

Cycle Time [Hz] 10
Figure 42: InOPComFerroS – Analyzing Model

Input0 In0 impulse signal of the OPComFerroS sensor

Input(s) Offset Offst specifies the offset of the impulse signal

OutputTemperature OutT receives the result of the OPComFerroS temperature measurement
OutputOccupancyRateSum OutORS receives the result of the OPComFerroS occupancy rate sum measure-
ment
OutputOccupancyRateFine OutORF receives the result of the OPComFerroS occupancy rate fine measure-
ment
Output(s)
OutputOccupancyRateChunk OutORC receives the result of the OPComFerroS occupancy rate chunk meas-
urement
OutputCleanCounter OutClnCnt receives the result of the OPComFerroS clean counter measurement
OutputChunkCounter OutChunkCnt receives the result of the OPComFerroS chunk counter measurement
OutputCleanUp OutClnUp receives the result of the OPComFerroS cleanup measurement
English
Release 2017-09 42 / 60
4.3.12 PhsClc
Purpose of the Analyzing Function PhsClc is to calculate the actual phase of the given periodically oscillation.
Figure 43: PhsClc – Analyzing Function

Cycle Time [kHz] 1



Figure 44: PhsClc – Analyzing Model

PhsClc receives either a pre-filtered- or directly a sine or cosine signal and its correspondingly calculated period
duration. According to these inputs the actual phasing in rad is calculated.
English
Release 2017-09 43 / 60
Bases on the given input values, the next figure shows the correspondingly calculated phase.
Figure 45: PhsClc – Monitoring View

Input0 In0 actual value of the periodically oscillation
Input(s) Period Prd actual value of the period duration in seconds

Amplitude Ampl receives the actual value of the amplitude

Output(s)
Phase Phs receives the actual value of the phase
English
Release 2017-09 44 / 60
4.3.13 SendReport
Purpose of the Analyzing Function SendReport is to build and send specific reports based on the received error
log entries which are created by AddLogEntry. SendReport depends to the Analyzing Function MonLog which
supervises all submodules (DME, MTE, ANE and STE) in order to transmit each error log entry whenever the
phrase CMR is found. SendReport decrypts the alarm- and warning integer values of this error log entry and
picks up the right text messages from the error text file for building and sending the report via TCP/IP.
Figure 46: SendReport – Analyzing Function

Cycle Time [Hz] 1
Figure 47: SendReport – Analyzing Model

SendReport receives the string which contains the error log entry.
English
Release 2017-09 45 / 60
After the Analyzing Model has been started for the first time, SendReport creates two additional folders within
the X-Tools Server directory. In case the folder SendReport does not exist, the folder is also created.
Figure 48: SendReport – folders within XTS directory

The AC.txt file has to be copied from “…\CM Training V 04.04.00\_errorDescr\” to “...\CMS X-Tools Profession-
al\Server\User\SendReport\errorDescr\”. Furthermore the TCP IP Test Server has to be started for receiving the
reports. This has to be done via the Analyzing Script “00 Start TCP IP Test Server”.
English
Release 2017-09 46 / 60
This Analyzing Script starts the TCP IP Test Server and the following window comes up.
Figure 49: SendReport – TCP IP Test Server (startup)

For receiving the reports which are sent by the Analyzing Function SendReport, a socket connection has to be
configured. This is done via the menu bar -> Socket -> Listen.
Figure 50: SendReport – TCP IP Test Server (socket)
English
Release 2017-09 47 / 60
The Server IP and Port Number have to be typed in according to the parameters of the Analyzing Model
SendReport and are confirmed by clicking onto the OK button.
Figure 51: SendReport – TCP IP Test Server (configure)

If the Analyzing Model SendReport has been started before the TCP IP Test Server it may take a couple of
minutes till the connection is established. This can be prevented by restarting the Analyzing Model SendReport
after the TCP IP Test Server has been started.
Figure 52: SendReport – TCP IP Test Server (listen)

A new report is sent after the Analyzing Model AddLogEntry has been executed several times according to the
parameter NumberOfStatus (NoSts). Once a new error log entry has been created, SendReport builds up the
specific report and sends it to the TCP IP Test Server.
Figure 53: SendReport – TCP IP Test Server (report)

The report is displayed by the table column Message.
English
Release 2017-09 48 / 60
The folder errorDescr contains the text files (can be created user defined) which contains the clear text mes-
sages for specific types of signals, e.g. for acceleration AC.txt. This text file can be filled as follows.
Figure 54: SendReport – text file

According to the created log entry by the Analyzing Function AddLogEntry and the given text file, the report is
built as follows.
YYYY-MM-DD hh:mm:ss:mmm:uuu:nnn: Error List, System, Sub System, Component, ID – Alarm: …, …., … -
Warning: …, …, …;Value
Figure 55: SendReport – matching entry

The folder Log contains a text file SendReport.log which contains all sent reports.
Figure 56: SendReport – log file
English
Release 2017-09 49 / 60
Input(s) Message Msg string of the log entry

IPAddress IP receives the IP address for sending the data or values
Port Port receives the port for sending the data or values

Output(s) OutputReady OutRdy indicates whether a log entry has been sent
English
Release 2017-09 50 / 60
4.3.14 SymCom
Purpose of the Analyzing Function SymCom is to calculate the symmetric components of the given three phase
current system according to the Fortescue Transformation. Resulting quantities are the positive-, negative- and
the zero sequence as well as the corresponding real- and imaginary parts.
Positive sequence
The positive sequence illustrates the three phase current system. The space vector rotates to the rota-
tional direction with a magnitude proportional to the current demand of the three phase current system.
Negative sequence
The negative sequence illustrates the entire stator asymmetries. The space vector rotates against the
rotational direction of the positive sequence with a motor specific basic magnitude. Each motor pos-
sesses a certain magnitude of the negative sequence even though the motor comes straight from the
factory. Due to the fact that the negative sequence is a function of speed and torque, the magnitude can
in- or decreases according to the operation point. Equally the magnitude depends on the strength of
faults in the machine, e.g. increasing number of stator winding shorts results in an increasing or de-
creasing magnitude of the negative sequence. If the magnitude increases, the magnitude of the positive
system will increase proportional to compensate the negative sequence magnitude, which results in
thermal stress for the motor, caused by the higher demand of current.
Zero sequence
The zero sequence illustrates the sum zero term. While the motor is running correct isolated, the magni-
tude of the zero sequence is next to zero.
Figure 57: SymCom – Analyzing Function
English
Release 2017-09 51 / 60

Cycle Time [Hz] 4


Figure 58: SymCom – Analyzing Model

SymCom receives the real and imaginary parts of a three phase current system as well as the three phase
current signals.
English
Release 2017-09 52 / 60
Bases on the given input values, the next figure shows the correspondingly calculated symmetric components.
Figure 59: SymCom – Monitoring View

i1Real i1Re input for the real part of the phase current i1
i1Imaginary i1Im input for the imaginary part of the phase current i1
Input(s)
i1 i1 input for the phase current i1


PositiveSequenceReal PSRe receives the real part of the positive sequence

PositiveSequenceImaginary PSIm receives the imaginary part of the positive sequence
PositiveSequence PS receives the absolute value of the positive sequence
NegativeSequenceReal NSRe receives the real part of the negative sequence

Output(s) NegativeSequenceImaginary NSIm receives the imaginary part of the negative sequence
NegativeSequence NS receives the absolute value of the negative sequence

ZeroSequenceReal ZSRe receives the real part of the zero sequence
ZeroSequenceImaginary ZSIm receives the imaginary part of the zero sequence
ZeroSequence ZS receives the absolute value of the zero sequence
English
Release 2017-09 53 / 60
4.3.15 TraceBuffer
Purpose of the Analyzing Function TraceBuffer is to rebuild signals received from a SINAMICS control unit.
The control unit writes four signal points for each signal into a separate buffer with a maximum cycle time of
250µs. Therefore the buffer is filled within 1ms and can be transmitted afterwards via TCP/IP to the X-Tools
Server.
Figure 60: TraceBuffer – Analyzing Function
English
Release 2017-09 54 / 60

Cycle Time [Hz] 4


Figure 61: TraceBuffer – Analyzing Model

TraceBuffer receives and shifts the values according to the cycle time. Subsequently these values are append-
ed and provided to the output. The inputs In0 – In31 are reserved for 8 signals which results in four inputs for
one output.
English
Release 2017-09 55 / 60
Bases on the given input values, the next figure shows the correspondingly rebuilt signal.
Figure 62: TraceBuffer – Monitoring View
English
Release 2017-09 56 / 60
Input0 In0 Iinput1 for signal 1







Input(s) Input16 In16 Iinput1 for signal 5







Output0 Out0 receives the rebuilt signal 1


Output(s)

English
Release 2017-09 57 / 60
5 List of Abbreviations
Abbreviation Description
AME Analyzing Model Editor

AMF Analyzing Model File
ANF Analyzing Function

ANS Analyzing System
ANX Analyzing System Explorer
ASE Analyzing Script Editor

ASF Analyzing Script File
CMM Communication Module

CTN Control Node
DMS Device Management System
DMX Device Management System Explorer

DPE Device Profile Editor
DPF Device Profile File

GOE Global Options Editor
IFM Interface Module

IFN Interface Node
IOM I/O-Module, Input/Output-Module
ION I/O-Node, Input/Output-Node

IPE Interface Profile Editor
IPF Interface Profile File

LPE Loading Profile Editor
LPF Loading Profile File
MDS Master Data System

MDX Master Data System Explorer
MMS Main Management System

MMX Main Management System Explorer
MPE Main Profile Editor
MPF Main Profile File

MTC Monitoring Chart
MTS Monitoring System

MTX Monitoring System Explorer
MVE Monitoring View Editor

MVF Monitoring View File
ODL Offline Data Loader
UAE User Accounts Editor

SLV System Log Viewer
SPE Storage Profile Editor

SPF Storage Profile File
STS Storage System
STX Storage System Explorer

UFE User Function Editor
UFF User Function File

USF User Function
English
Release 2017-09 58 / 60
UPS Uninterruptible Power Supply
XTC X-Tools Client

XTS X-Tools Server
XTT X-Tools Tray

XTV X-Tools Service
English
Release 2017-09 59 / 60
6 Contact Information
Should you have any questions concerning the software application, please refer to the Digital Factory Tech-
nical Support.
Department
Siemens AG
Digital Factory
Phone
+49 (0) 911 895 7222 (Monday to Friday, 08:00 am to 04:00 pm CET/CEST)
Fax
+49 (0) 911 895 7223
Internet
www.siemens.de/automation/service&support
Thank you for using one of the above mentioned contacts to ensure your inquiry is registered and can be pro-
cessed.
English
Release 2017-09 60 / 60

CMS X-Tools Analyzing Bundle 1 User Manual - V XX - xx.EN

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

CMS X-Tools Analyzing Bundle 1 User Manual - V XX - xx.EN

Uploaded by

Copyright:

Available Formats

CMS X-Tools Analyzing Bundle 1 – User Manual CMS

CMS X-Tools Analyzing Bundle 1

Figure 1: Licenses – X-Tools licenses within the Automation License Manager................................................. 9

Figure 41: InOPComFerroS – OPComFerroS structure of the impulse signal ...................................................41

1.1 Purpose of this Document

1.2 Validity of this Document

This document is valid for the following software:

The following notations are used within this document:

2.1 Scope of Delivery

2.2 Unpacking and Checking

After unpacking, please check

Figure 1: Licenses – X-Tools licenses within the Automation License Manager

Figure 2: Licenses – Server log entries

3.2 Analyzing Bundle 1

Figure 3: Analyzing Bundle 1 – Install (part 1)

Figure 4: Analyzing Bundle 1 – Install (part 2)

Figure 5: Analyzing Bundle 1 – Analyzing Functions

4.1.1 What is CMS X-Tools?

4.1.2 What is Analyzing Bundle 1?

4.2.1 Example Parameters

4.3 Analyzing Functions

Figure 6: AB1 License – Analyzing Function

Figure 7: AddLogEntry – Analyzing Function

Cycle Time [Hz] 1

Offline Time Configuration

Figure 8: AddLogEntry – Analyzing Model

Figure 9: AddLogEntry – error log entry

Figure 10: AddLogEntry – folders within XTS directory

Figure 11: AddLogEntry – status file

System Sys name of the system

Value Value receives the value which shall be sent

Figure 12: AlarmHandle – Analyzing Function

Calculation Mode Equidistant

Offline Time Configuration

Minimum Time Format 2016-01-01 00:00:00:000.000.000

Figure 13: AlarmHandle – Analyzing Model

Figure 14: AlarmHandle – Monitoring View

Figure 15: AlrmNotify – Analyzing Function

Cycle Time [Hz] 1

Figure 16: AlrmNotify – Analyzing Model

DataName DataName specifies the ID for the alarm notification

OSGNumber OSGNo specifies the active operating state group number

Control Cntrl specifies the actual control value

Alarm Alrm receives the actual alarm level

Figure 17: ConvToCSVCV – Analyzing Function

Calculation Mode Equidistant

Offline Time Configuration

Figure 18: ConvToCSVCV – Analyzing Model

Figure 19: ConvToCSVCV – Analyzing Model File

Figure 20: ConvToCSVCV – CSV file storage location

Figure 21: ConvToCSVCV – created CSV file

Figure 22: ConvToCSVCV – CSV file

Input(s) Input0 – Input19 In0 – In19 Input(s) for characteristic value(s)

Figure 23: ConvToUFF – Analyzing Function

Calculation Mode Equidistant

Offline Time Configuration

Figure 24: ConvToUFF – Analyzing Model

Figure 25: ConvToUFF – created UFF file (Append)

Figure 26: ConvToUFF – UFF file (Append)

In the following table the index 1 – 15 of the UFF file is described.

MotorCurrent MotorCurrent input for motor current in A stored in record 4

ID ID input for the spectrum ID

Path Path output path of the stored file (e.g.: c:/storage/UFF)