Siemens Teleperm XP via XU Interface

Version 2.5.6.x

OSIsoft, LLC
777 Davis St., Suite 250
San Leandro, CA 94577 USA
Tel: (01) 510-297-5800
Fax: (01) 510-357-8136
Web:
OSIsoft Australia • Perth, Australia
OSIsoft Europe GmbH • Frankfurt, Germany
OSIsoft Asia Pte Ltd. • Singapore
OSIsoft Canada ULC • Montreal & Calgary, Canada
OSIsoft, LLC Representative Office • Shanghai, People’s Republic of China
OSIsoft Japan KK • Tokyo, Japan
OSIsoft Mexico S. De R.L. De C.V. • Mexico City, Mexico
OSIsoft do BrasilSistemas Ltda. • Sao Paulo, Brazil
Siemens Teleperm XP via XU Interface
Copyright: © 1999-2012OSIsoft, LLC. All rights reserved.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, mechanical, photocopying, recording, or otherwise, without the prior written permission of OSIsoft, LLC.
OSIsoft, the OSIsoft logo and logotype, PI Analytics, PI ProcessBook, PI DataLink, ProcessPoint,PI Asset Framework(PI-AF), IT Monitor, MCN Health Monitor, PI System, PI ActiveView, PI ACE, PI AlarmView, PI BatchView, PI Data Services, PI Manual Logger, PI ProfileView, PI WebParts, ProTRAQ, RLINK, RtAnalytics, RtBaseline, RtPortal, RtPM, RtReports and RtWebParts are all trademarks of OSIsoft, LLC. All other trademarks or trade names used herein are the property of their respective owners.
U.S. GOVERNMENT RIGHTS
Use, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the OSIsoft, LLC license agreement and as provided in DFARS 227.7202, DFARS 252.227-7013, FAR 12.212, FAR 52.227, as applicable. OSIsoft, LLC.
Published: 05/2012

Table of Contents

Chapter 1.Introduction

Reference Manuals

Supported Operating Systems

Supported Features

Diagram of Hardware Connection

Chapter 2.Principles of Operation

Chapter 3.Installation Checklist

Data Collection Steps

Interface Diagnostics

Advanced Interface Features

Chapter 4.Interface Installation

Naming Conventions and Requirements

Interface Directories

PIHOME Directory Tree

Interface Installation Directory

Interface Installation Procedure

Installing Interface as a Windows Service

Installing Interface Service with PIInterfaceConfigurationUtility

Service Configuration

Installing Interface Service Manually

Chapter 5.Digital States

Chapter 6.PointSource

Chapter 7.PI Point Configuration

Point Attributes

Tag

PointSource

PointType

Location1

Location2

Location3

Location4

Location5

InstrumentTag

ExDesc

Scan

Shutdown

Exception Processing

Chapter 8.Startup Command File

Configuring the Interface with PI ICU

SITeleXPXU Interface page

Command-line Parameters

Sample PITxp.bat File

Chapter 9.UniInt Failover Configuration

Introduction

Quick Overview

Synchronization through a Shared File (Phase 2)

Configuring Synchronization through a Shared File (Phase 2)

Configuring UniInt Failover through a Shared File (Phase 2)

Start-Up Parameters

Failover Control Points

PI Tags

Detailed Explanation of Synchronization through a Shared File (Phase2)

Steady State Operation

Failover Configuration Using PI ICU

Create the Interface Instance with PI ICU

Configuring the UniInt Failover Startup Parameters with PIICU

Creating the Failover State Digital State Set

Using the PI ICU Utility to create Digital State Set

Using the PI SMT 3 Utility to create Digital State Set

Creating the UniInt Failover Control and Failover State Tags (Phase 2)

Chapter 10.Interface Node Clock

Chapter 11.Security

Windows

Chapter 12.Starting / Stopping the Interface

Starting Interface as a Service

Stopping Interface Running as a Service

Chapter 13.Buffering

Which Buffering Application to Use

How Buffering Works

Buffering and PI Server Security

Enabling Buffering on an Interface Node with the ICU

Choose Buffer Type

Buffering Settings

Buffered Servers

Installing Buffering as a Service

Chapter 14.Interface Diagnostics Configuration

Scan Class Performance Points

Performance Counters Points

Performance Counters

Performance Counters for both (_Total) and (Scan Class x)

Performance Counters for (_Total) only

Performance Counters for (Scan Class x) only

Interface Health Monitoring Points

I/O Rate Point

Interface Status Point

Appendix A.Error and Informational Messages

Message Logs

Messages

System Errors and PI Errors

UniInt Failover Specific Error Messages

Informational

Errors (Phase 1 & 2)

Errors (Phase 2)

Appendix B.PI SDK Options

Appendix C.Message Logging

Appendix D.Troubleshooting

Appendix E.Microsoft Winsock Errors

Appendix F.Detailed Time Considerations

Appendix G.KKS configuration

Appendix H.Terminology

Appendix I.Technical Support and Resources

Before You Call or Write for Help

Help Desk and Telephone Support

Search Support

Email-based Technical Support

Online Technical Support

Remote Access

On-site Service

Knowledge Center

Upgrades

OSIsoft Virtual Campus (vCampus)

Revision History

Siemens Teleperm XP via XU Interface1

Chapter 1.Introduction

This is a description of the Siemens Teleperm XP via XU Interface to the PI System (following referred to as SITeleXPXUInterface). The interface can be run on Windows 2003,XPand later. There TCP/IP services must be enabled.

A single interface can collect data from one XP system at a time, via an XU. The interface may also be configured to use a backup XU in the event that the primary fails. The interface will accept data from whichever XU is leading.

The XU is available for connection to two types of OM (“Operating and Monitoring System”):

  • TXP OM650
  • TXP OM690, previously called TXP-IN (“In Nuclear power plants”)

This has an influence on the way the XU operates internally.

The interface supports both OM650 and OM690.

The XU itself is a computer running SCO Unix; however, the PI-TXP-XU interface runs on Windows 2003 and later and just establishes a TCP/IP socket connection to the XU via the network.

This version of the interface uses the /EXT switch to transfer the sub-second portion of the time stamps into PI. Without this parameter the sub-second portion of the time stamps is still truncated as in version 1.

When the interface first submits a subscription list to the XU, it requests an “initial image” of the subscribed values. When the interface receives this image, it considers the data values to be “current” and changes the timestamps to the current time.

  • Due to the fact that PI will be receiving foreign timestamps, the two systems should be synchronized to the same clock time. OSI recommends the YAT32 program available from

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is being installed on a 32-bit operating system (C:\ProgramFiles\PIPC) or a 64bit operating system (C:\ProgramFiles(x86)\PIPC).

The value of [PIHOME64] variable for a 64-bit interface will be C:\ProgramFiles\PIPC on the 64-bit Operating system.

In this documentation [PIHOME] will be used to represent the value for either [PIHOME] or [PIHOME64]. The value of [PIHOME] is the directory which is the common location for PI client applications.

Note:Throughout this manual there are references to where messages are written by the interface which is the PIPC.log. This interface has been built against a of UniInt version (4.5.0.59 and later) which now writes all its messages to the local PI Message log.

Please note that any place in this manual where it references PIPC.log should now refer to the local PI message log. Please see the document UniInt Interface Message Logging.docx in the %PIHOME%\Interfaces\UniInt directory for more details on how to access these messages.

Reference Manuals

OSIsoft
  • PI Server manuals
  • PI API Installation manual
  • UniInt Interface User Manual
Siemens
  • Application Software Documentation
    Product: External Unit
    Foreign System Connection to TXP-OM
    Handling of the XU
    ZXX206-E.01-8700-185.980224
    V2.0
    1998-12-14
  • Application Software Documentation
    Product: External Unit
    Foreign system connection to TXP-OM
    interface description
    ZXX206-E.01-8700-185.96115
    V5.0
    1998-11-16
  • Anwender-Software-Dokumentation
    Produkt: External Unit
    Fremdsystemanschluß an TXP-OM650 / TXP-OM690
    Funktionsschnittstelle
    ZXX206-E.01-8700-185.000518
    V1.0
    2000-05-18
  • Anwender-Software-Dokumentation
    Produkt: External Unit
    Fremdsystemanschluß an TXP-OM650 / TXP-OM690
    Schnittstellenbeschreibung
    ZXX206-E.01-8700-185.961115
    V5.2
    2001-01-12
  • TELEPERM XP
    OM Prozessführungs- und Informationssystem
    External Unit (XU)
    Technische Beschreibung V1.00
    2000-07-26

Supported Operating Systems

Platforms / 32-bit application / 64-bit application
Windows XP / 32-bit OS / Yes / No
64-bit OS / Yes (Emulation Mode) / No
Windows 2003 Server / 32-bit OS / Yes / No
64-bit OS / Yes (Emulation Mode) / No
Windows Vista / 32-bit OS / Yes / No
64-bit OS / Yes (Emulation Mode) / No
Windows 2008 / 32-bit OS / Yes / No
Windows 2008 R2 / 64-bit OS / Yes (Emulation Mode) / No
Windows 7 / 32-bit OS / Yes / No
64-bit OS / Yes (Emulation Mode) / No

Supported Features

Feature / Support
Interface Part Number / PI-IN-SI-TLXP-NTI
Auto Creates PI Points / No
Point Builder Utility / No
ICU Control / Yes
PI Point Types / PI3: Float16, Float32, Float64, Int16, Int32, Digital
PI2: R, I, D
Sub-second Timestamps / Yes
Sub-second Scan Classes / No
Automatically Incorporates PIPoint Attribute Changes / Yes
Exception Reporting / Yes
Outputs from PI / No
Inputs to PI: / Scan-based
Supports Questionable Bit / No
Supports Multi-character PointSource / Yes
Maximum Point Count / Unlimited
* Uses PI SDK / No
PINet String Support / No
* Source of Timestamps
History Recovery / Yes
* UniInt-based
* Disconnected Startup
* SetDeviceStatus / Yes
No
Yes
* Failover / UniInt Failover (Phase 2 - COLD);
Server-level failover
* Vendor Software Required on Interface Node / PINet Node / No
Vendor Software Required on Foreign Device / No
Vendor Hardware Required / No
Additional PI Software Included with interface / No
Device Point Types / analog, digital, and counter
Serial-Based interface / No

* See paragraphs below for further explanation.

Sub-Second Scan Classes

Although sub-second scan-classes can be specified on the command line, they do not really make sense because the interface just subscribes for DCS events in the XU, then scans the memory containing the received values according to the scan cycle defined.

Sub-second timestamps, though, may be obtained from the XU by using the /ext parameter.

Inputs to PI

The interface subscribes for DCS events in the XU. During each scan period the interface processes the values received since the last scan.

Uses PI SDK

The PI SDK and the PI API are bundled together and must be installed on each PI Interface node. This Interface does not specifically make PI SDK calls.

Source of Timestamps
Values sent to the PI data archive retain the time-stamp received from the XP system except for values belonging to the “Initial Image”. See Data Timestampfor more information
History Recovery

The interface is able to access the history stored in the XU. See History Recoveryfor more details.

SetDeviceStatus

The SITeleXPXU Interface is built with UniInt4.5.5.22. New functionality has been added to support health tags. The Health tag with the point attribute ExDesc=[UI_DEVSTAT] represents the status of the source device. The following events can be written into this tag:

  • “1 | Starting” - the interface is starting.
  • “Good” - the interface is properly communicating and reading data from the server.
  • The following event represents a failure to communicate with the server:
  • "3 | 1 device(s) in error | Network communication error to XU"
  • "3 | 1 device(s) in error | Received NAK from XU"
  • "3 | 1 device(s) in error | The XU is shutting down"
  • "3 | 1 device(s) in error | The XU is in an unrecognized state"
  • "3 | 1 device(s) in error | Time out waiting for response from XU"
  • “4 | Intf Shutdown” - the interface is stopped.

Refer to the UniInt Interface User Manual for more information on how to configure health points.

Failover
  • Server-Level Failover

The interface supports server-level failover that allows collecting data from either primary or backup XU. This feature is built into the interface and does not require any additional hardware or software.

  • UniInt Failover Support

UniInt Phase 2 Failover provides support for cold, warm, or hot failover configurations. The Phase 2 hot failover results in a no data loss solution for bi-directional data transfer between the PI Server and the Data Source given a single point of failure in the system architecture similar to Phase 1. However, in warm and cold failover configurations, you can expect a small period of data loss during a single point of failure transition. This failover solution requires that two copies of the interface be installed on different interface nodes collecting data simultaneously from a single data source.Phase 2 Failover requires each interface have access to a shared data file. Failover operation is automatic and operates with no user interaction. Each interface participating in failover has the ability to monitor and determine liveliness and failover status. To assist in administering system operations, the ability to manually trigger failover to a desired interface is also supported by the failover scheme.

The failover scheme is described in detail in the UniInt Interface User Manual, which is a supplement to this manual. Details for configuring this Interface to use failover are described in the UniInt Failover Configuration section of this manual.

Device Point Types

The Teleperm XP interface provides support for analog, digital, and counter (integer) values from the XP system. The data type of the data in the XP system must be known ahead of time and so analog values may only be retrieved into real (float) tags, digital values into discrete tags, and counter values into integer tags (in PI).

Diagram of Hardware Connection

Siemens Teleperm XP via XU Interface1

Chapter 2.Principles of Operation

The SITeleXPXU interface is a TCP/IP client that allows read data from Siemens Teleperm XP system (TCP/IP server). This interface is designed to provide connection to only one XP system and run multiple instances of the interface simultaneously.

At startup, the SITeleXPXU Interface establishes the initial connection to PI and reconnects to PI in the event that the connection is lost for some reason. If the Interface is started while the PI Server is down, the Interface will periodically try to establish a connection until the PI Server is up.

When the Interface starts, the interface searches the PI Point Database for points that belong to the Interface and a point list is created for the interface.

Once startup is complete, the Interface enters the processing loop, which includes:

  • Servicing scheduled input points. Each Scan Class is processed in turn.
  • The PI Point Database is checked every 2 minutes for points that are added, edited, and deleted. If point updates are detected, the points are loaded (or reloaded) by the Interface as appropriate. The 2-minute update interval can be adjusted with the /updateinterval command-line parameter discussed in the UniInt Interface User Manual. The Interface will only process 25 point updates at a time. If more than 25 points are added, edited, or deleted at one time, the Interface will process the first 25 points, wait 30seconds (or by the time specified by the /updateintervalparameter, whichever is lower), process the next 25 points, and so on. Once all points have been processed, the Interface will resume checking for updates every 2 minutes (or by the time specified by the /updateinterval parameter). The Interface will write the digital state SCAN OFF to any points that are removed from the Interface while it is running. If the Scan field of any point on the point list is set to off, the point is removed from the point list. The point is added once again after the Scan field is turned back on.
  • The interface subscribes for events in the Teleperm XP system. The XU permanently sends exceptions to the subscribing application (the SITeleXPXU Interface) which in turn sends the values to PI. Although the interface is scan based, it just scans the memory that has been filled with values sent from the XU.
  • A system digital state is sent to the input tag if a communication error occurs.
  • If the interface determines that the KKS does not exist in the XP system, then the tag is ignored. If the interface still has not received a value for a particular KKS by the time the initial image is complete, then that KKS is considered to be non-existent.
Communication

The SITeleXPXU interface communicates with the XP system over a TCP/IP link. Due to the licensing requirements of the XU, each interface must be assigned a client ID number (entered in a file /usr/madamxenv/project/xu_clients.p on the XU) that is unique among all clients connected to the system.

As part of the communication process, the interface is always aware of the state of the XU (i.e. leading, stand-by, etc). Signal data may only be collected from an XU if it is leading. If both a primary and a backup XU are specified on the command-line, then the interface will query the one that is leading for data. The interface maintains a connection to both primary and backup to prevent a loss of data.

Signals are requested by subscribing to “events” in the XP system. The interface passively receives these events until the list of requested events (determined by the PI input tags) changes. The interface checks the subscription list for changes every minute.

When the subscription list has changed, the interface cancels its current subscription and issues a new one. PI tags should always be configured before the interface is started in order to prevent any loss of data that may occur during the cancellation and re-subscription. The interface waits for a period of time after the last change to the subscription list before re-issuing the subscription.

All signal values are received into a data cache. PI input tags retrieve cached values at their designated scan rates. Version 2 gathers all events and sends them to PI at the configured scan rates.

Failover

This interface supports Server-Level Failover and Interface-Level Failover using UniInt. Refer to the UniInt Failover Configuration section of this document for configuring the interface for failover.

History Recovery

The interface now supports History Recovery. Whenever the interface shuts down a Time Stamp is written to a file named “PITxpAR.Tim#” (where # is the interface id). After a restart the interface automatically starts with the Time Stamp found in this file.

Enabling of History Recovery is done by using the /AR switch. You can also use this feature for transferring old data to PI when starting up the interface for the first time. Simply specify the Time Stamp you want the interface to start with in /AR parameter (/AR=startime). If it is required History recovery for specific time period, then run the interface with the /AR parameter (/AR=startime,endtime). For the correct notation of the Time Stamp see the description of the /AR switch in this manual inthe chapter Startup Command File.

Note: The time expected in and written to “PITxpAR.Tim#” is local time.

Data Timestamp

A time stamp associated with a process value is generated in the AS (Automation System) using local wintertime. This time stamp is being converted to UTC time on the Teleperm XP system (PU - Processing Unit), based on the Time Zone settings on the PU.