How to Contact Us

Download 0.51 Mb.
Size0.51 Mb.
  1   2   3   4   5   6

PI Batch File Interface


Revision D

How to Contact Us

OSIsoft, Inc.

777 Davis St., Suite 250

San Leandro, CA 94577 USA


(01) 510-297-5800 (main phone)

(01) 510-357-8136 (fax)

(01) 510-297-5828 (support phone)

Houston, TX

Johnson City, TN

Mayfield Heights, OH

Phoenix, AZ

Savannah, GA

Seattle, WA

Yardley, PA

Worldwide Offices

OSIsoft Australia

Perth, Australia

Auckland, New Zealand

OSIsoft Software GmbH

Altenstadt, Germany

OSIsoft Software Asia Pte Ltd.


OSIsoft Canada ULC

Montreal, Canada 

OSIsoft, Inc. 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 

Sales Outlets and Distributors

  • Brazil

  • Middle East/North Africa

  • Republic of South Africa

  • Russia/Central Asia

  • South America/Caribbean

  • Southeast Asia

  • South Korea

  • Taiwan


OSIsoft, Inc. is the owner of the following trademarks and registered trademarks: PI System, PI ProcessBook, Sequencia, Sigmafine, gRecipe, sRecipe, and RLINK. All terms mentioned in this book that are known to be trademarks or service marks have been appropriately capitalized. Any trademark that appears in this book that is not owned by OSIsoft, Inc. is the property of its owner and use herein in no way indicates an endorsement, recommendation, or warranty of such party’s products or any affiliation with such party of any kind.

Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013

Unpublished – rights reserved under the copyright laws of the United States.

© 1996-2006 OSIsoft, Inc. PI_BatchFL.doc

Table of Contents

Introduction 1

Reference Manuals 1

Supported Features 1

Diagram of Hardware Connection 3

Principles of Operation 5

Installation Checklist 6

Interface Installation on Windows 9

Naming Conventions and Requirements 9

Interface Directories 9

The PIHOME Directory Tree 9

Interface Installation Directory 10

Interface Installation Procedure 10

Installing the Interface as a Windows Service 10

Installing the Interface Service with PI ICU 10

Installing the Interface Service Manually 13

Digital States 15

PointSource 17

PI Point Configuration 19

Point Attributes 19

Tag 19

PointSource 19

PointType 19

Location1 20

Location2 20

Location3 20

Location4 20

Location5 20

InstrumentTag 20

ExDesc 21

Scan 21

UserReal1 21

Shutdown 21

Performance Point Configuration 23

I/O Rate Tag Configuration 25

Monitoring I/O Rates on the Interface Node 25

Configuring I/O Rate Tags with PI ICU (Windows) 25

Configuring IORates Tags Manually 26

Configuring the PI Point on the PI Server 27

Configuration on the Interface Node 27

Data File Format 29

Data Files 29

Startup Command File 31

Configuring the Interface with PI ICU 31

batchfl Interface Tab 33

Command-line Parameters 37

Informational Parameters 41

Sample batchfl.bat File 41

Interface Node Clock 43

Security 45

Windows 45

Starting / Stopping the Interface on Windows 47

Starting Interface as a Service 47

Stopping Interface Running as a Service 47

Buffering 49

Appendix A: Error and Informational Messages 51

Message Logs 51

System Errors and PI Errors 51

Revision History 53


The Batch File Interface reads data from comma-delimited ASCII files and sends the data to a Plant Information (PI) System. Basically, the files include the PI tagname, timestamp, and data value. Other formats are described later in this manual. The interface requires the PI API so it may run on a PI API node or a PI Home node.

This document applies to Windows platforms.

Reference Manuals


  • PI Data Archive Manual

  • PI API Installation Instructions

  • PI ICU UserManual

  • UniInt End User Document

Supported Features



Part Number



NTI (4, 2000, XP, 2003)

APS Connector


Point Builder Utility


ICU Control


PI Point Types

Float16 / Float32 / Float64 / Int16 / Int32 / Digital / String

Sub-second Timestamps


Sub-second Scan Classes


Automatically Incorporates PI Point Attribute Changes

Yes –only when /as is passed

Exception Reporting

Yes –only when /ex is passed

Outputs from PI


Inputs to PI: Scan-based / Unsolicited / Event Tags


Supports Questionable Bit


Supports Multi-character PointSource


Maximum Point Count


*Uses PI SDK

Yes-only when /pt is passed

PINet String Support


* Source of Timestamps


History Recovery






Vendor Software Required on PI Interface Node


Vendor Software Required on DCS System


Vendor Hardware Required


Additional PI Software Included with Interface


*See paragraphs below for further explanation.

The Interface is designed to run on the above mentioned Microsoft Windows operating systems and greater. No service packs are required.

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 unless /pt is passed in for point creation.
Source of Timestamps

Each line of the input file includes the timestamp for the given data value.

Diagram of Hardware Connection

Download 0.51 Mb.

Share with your friends:
  1   2   3   4   5   6

The database is protected by copyright © 2024
send message

    Main page