PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70 Series

Version 2.4.0.x
Rev C
OSIsoft, LLC
777 Davis St., Suite 250
San Leandro, CA 94577 USA
Tel: (01) 510-297-5800
Fax: (01) 510-357-8136
Web: http://www.osisoft.com

OSIsoft Australia Perth, Australia

OSIsoft Europe GmbH Frankfurt, Germany
OSIsoft Asia Pte Ltd. Singapore
OSIsoft Canada ULC Montreal & Calgary, Canada

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
OSIsoft, LLC Representative Office Shanghai, Peoples Republic of China
OSIsoft Japan KK Tokyo, Japan
OSIsoft Mexico S. De R.L. De C.V. Mexico City, Mexico
OSIsoft do Brasil Sistemas Ltda. Sao Paulo, Brazil

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
PI Interface for Foxboro I/A 51 Series and PI Interface for Foxboro I/A 70 Series
Copyright: 1997-2013 OSIsoft, 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.

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
Published: 02/2013

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
Table of Contents
Chapter 1. Introduction.................................................................................................1

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 Reference Manuals 2
Supported Features 3
Diagram of Hardware Connection 7

Chapter 2. Principles of Operation...............................................................................9

FoxAPI and AIM*API 9
Overview 9
Buffered Access 9
Unbuffered Access 10
Object Status 10

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 Outputs 10

Chapter 3. Installation Checklist.................................................................................13

Data Collection Steps 13
Interface Diagnostics 16
Advanced Interface Features 16

Chapter 4. Interface Installation on Windows............................................................17

Naming Conventions and Requirements 17
Interface Directories 17

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 PIHOME Directory Tree 17
Interface Installation Directory 18
Interface Installation Procedure 18
FoxAPI / AIM*API Installation 18
Interface Installation Procedure 19
Installing Interface as a Windows Service 21
Installing Interface Service with PI Interface Configuration Utility 21
Service Configuration 21
Clearing and Resetting the FoxAPI / AIM*API Lists 24
Changing from FoxAPI to AIM*API24
Installing Interface Service Manually 26

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 Installing the Interface on Secure I/A Systems 27

Chapter 5. Interface Installation on UNIX...................................................................28

Naming Conventions and Requirements 28
Interface Directories 29
PIHOME Directory 29
Interface Installation Directory 29
FoxAPI Installation 29
PI API Installation Procedure 30
Interface Installation Procedure 33

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 Installing Multiple Instances of the Interface 35
Multiple Instances in a Single Directory 35
Multiple Instances in a Separate Directories 36

Chapter 1. FoxAPI Test Program................................................................................39

Chapter 6. Digital States..............................................................................................43

Chapter 7. PointSource...............................................................................................45

Chapter 8. PI Point Configuration...............................................................................47

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 Point Attributes 47
Tag47
PointSource 48
PointType 48
Location1 48
Location2 49
Location3 50
Location4 50
Location5 51
InstrumentTag 51
ExcDev / ExcDevPercent 51
ExDesc 52

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 UserInt1 56
Scan 57
Shutdown 57
Output Points 57
Trigger Method 1 (Recommended) 58
Trigger Method 2 58
Point Configuration Examples 58
Profile Points 59

Chapter 9. Startup Command File..............................................................................61

Configuring the Interface with PI ICU 61

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 fxbais Interface page 64
Command-line Parameters 69
Sample fxbais.bat File 75
Sample fxbais.sh file 75
fxbais.ini Configuration File 78

Chapter 10. Interface Node Clock.............................................................................81

Chapter 11. Security..................................................................................................83

Windows and UNIX 83

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
Chapter 12. Starting / Stopping the Interface on Windows....................................85
Starting Interface as a Service 85
Stopping Interface Running as a Service 85

Chapter 13. Starting / Stopping the Interface on UNIX...........................................87

Interface Startup Script 87
Interface Stop Script 88
Automatic startup and shutdown 88
Automatic startup on a reboot 88
Terminating Background Processes 89

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 Anomalous Background Job Termination 89

Chapter 14. Buffering................................................................................................91

Which Buffering Application to Use 91
How Buffering Works 92
Buffering and PI Server Security 92
Enabling Buffering on an Interface Node with the ICU 93
Choose Buffer Type93
Buffering Settings 94
Buffered Servers 96
Installing Buffering as a Service 99

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 Configuring PI API Buffer Server (BufServ) Manually 102
Buffering Settings 102
BufServ and n-way buffering 103
Kernel Resource Configuration on Solaris 105

Chapter 15. Interface Diagnostics Configuration..................................................109

Scan Class Performance Points 109
Configuring Performance Points on UNIX 112
Performance Counters Points On Windows 112
Performance Counters 114
Performance Counters for both (_Total) and (Scan Class x) 114

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 Performance Counters for (_Total) only 115
Performance Counters for (Scan Class x) only 118
Interface Health Monitoring Points 119
Configuring Interface Health Points Manually 120
Interface Health Point Keywords 120
I/O Rate Point 124
Configuring I/O Rate Tags On UNIX 127
Configuring PI Point on the PI Server 127
Configuration on the Interface Node 127
Interface Status Point 128

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
Appendix A. Error and Informational Messages...................................................131
Message Logs 131
Messages 132
Extra Debugging Messages 132
List Event Counters and Location5134
Common Problems 134
Operational Hints 139
Solaris/Unix 139
Updates and HotFixes for the FoxAPI 140
Reading an Entire MCIN/MCOUT Block 140

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 Reading I/A Series Messages 141
FoxAPI Configuration Settings (foxapi.cfg) 141
Time Difference Reported by the Interface 143
System Errors and PI Errors 143

Appendix B. PI SDK Options..................................................................................145

Appendix C. Failover Support.................................................................................147

Parameters for Operation 149
Design Details 152
Operational Scenarios 155

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 Failover Installation Checklist 157
Miscellaneous Information on Failover 158

Appendix D. Notes on Upgrading from Previous Versions..................................161

Required -host= argument161
ExDesc keywords no longer supported 161
PIHOME and LD_LIBRARY variables defined in /.cshrc 161
Install Procedure 162

Appendix E. FoxAPI Configuration........................................................................165

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
Appendix F. FoxAPI Status Definition....................................................................167
Status Definition for I/A Series Version 4.1 and Earlier 167
Status Definition for I/A Series Version 4.2 and Later 168
Storing Status Values in PI 169

Appendix G. Terminology.......................................................................................171

Appendix H. Technical Support and Resources....................................................175

Before You Call or Write for Help 175
Help Desk and Telephone Support 175

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 Search Support 176
Email-based Technical Support 176
Online Technical Support 176
Remote Access 177
On-site Service 177
Knowledge Center 177
Upgrades 177
OSIsoft Virtual Campus (vCampus) 177

Appendix I. Revision History..................................................................................179

1 PI Interface for Foxboro I/A 51 Series

and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is
 1 PI Interface for Foxboro I/A 51 Series
and PI Interface for Foxboro I/A 70
Series Introduction

The PI Interface for Foxboro I/A 51 Series and the PI Interface for Foxboro I/A 70 Series
(fxbais) provide for the bi-directional transfer of data between OSIsofts PI Server and
Foxboros I/A Series system. Foxboros I/A Series systems run on either Solaris (51 Series
I/A 6.x or later) or Windows (70 Series I/A 8.2 or later) computers.
On Windows, the interface uses either the FoxAPI or the AIM*API to communicate with the
I/A system. The interface must run directly on a Foxboro I/A AP or AW machine, where
either the FoxAPI or the AIM*API software installed. It is compatible with Secure I/A
systems as well as standard I/A.
As of I/A 8.8, the FoxAPI is no longer available and is replaced by the AIM*API. These APIs
have the same functionality and are source code compatible, but require different executables.
The interface setup kit for Windows includes executables for both FoxAPI and AIM*API,
and the required executables are selected during the installation. The configuration of the
interface and the PI points are the same for both the FoxAPI and AIM*API.
On Solaris, the interface uses the FoxAPI. Normally, the interface runs directly on a AP or
AW machine, using the local FoxAPI.
There is also an option to allow the interface to be run on a generic Solaris machine which is
not a part of the I/A system, using Foxboro netFoxAPI software. The netFoxAPI must be
purchased and installed on this generic Solaris machine. In addition, netFoxAPI software
must also be licensed at the netFoxAPI server machine. The standard FoxAPI manuals
describe this operation. The fxbaisnet interface (included in the fxbais Solaris install kit) can
then be run on the generic machine and access the I/A system. This option is only available
on Solaris. The Windows version of the fxbais interface does not support networked access to
the FoxAPI or AIM*API.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is