Measurex MXOPEN Interface to the PI System

Measurex MXOPEN
Interface to the PI System

How to Contact Us

Phone / (510) 297-5800 (main number)
(510) 297-5828 (technical support)
Fax / (510) 357-8136
Internet /
World Wide Web /
Bulletin Board / (510) 895-9423
Telebit WorldBlazer modem (Hayes, MNP, or PEP compatible)
8 data bits, 1 stop bit, no parity, up to 14400 bps download
protocols: Xmodem, Ymodem, Zmodem, Kermit
Mail / OSI Software, Inc.
P.O. Box 727
San Leandro, CA 94577-0427
USA
OSI Software GmbH
Hauptstrae 30
D-63674 Altenstadt 1
Deutschland /
OSI Software, Ltd
P. O. Box 8256
Level One, 6-8 Nugent Street
Auckland 3, New Zealand

Unpublished -- rights reserved under the copyright laws of the United States.
RESTRICTED RIGHTS LEGEND
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

Trademark statement—PI is a registered trademark of OSI Software, Inc. Microsoft Windows, Microsoft Windows for Workgroups, and Microsoft NT are registered trademarks of Microsoft Corporation. Solaris is a registered trademark of Sun Microsystems. HPUX is a registered trademark of Hewlett Packard Corp.. IBM AIX RS/6000 is a registered trademark of the IBM Corporation. DUX, DEC VAX and DEC Alpha are registered trademarks of the Digital Equipment Corporation.
PI_Mxopen.doc

 1997 OSI Software, Inc. All rights reserved
777 Davis Street, Suite 250, San Leandro, CA 94577

10/15/2004 8:39:00 AM1

Table of Contents

Introduction...... 1

Interface Configuration...... 4

Hardware...... 4

Software...... 4

Startup File...... 4

Parameters Common to All Types of Connections...... 4

Parameters For Peer to Peer Connections to Measurex AM Nodes...... 6

Parameters For Peer to Peer Connections through Measurex Server...... 6

Parameters For Peer to Many Connections through Measurex Server...... 7

PI Point Definition...... 10

Point Parameters Definition...... 10

Point Source...... 10

Point Type...... 11

Location 1...... 11

Location 2...... 11

Time Driven Setup...... 13

Location 3...... 13

Location 4...... 13

Scan Group...... 13

Location 5...... 13

Instrument Tag...... 14

Source Tag...... 14

Extended Descriptor...... 14

Point Examples...... 16

Profiles—Unsolicited Event Input...... 16

Single Variable—Unsolicited Time Input...... 16

Single Variable—Solicited Time Input...... 16

Profile Status Handling...... 17

Interface Operation...... 17

Data Rate Monitoring...... 17

Error and Information Logging...... 17

Error Messages...... 18

Error Modes...... 18

Fatal Error Messages...... 19

Link Status Messages...... 19

Tag Configuration Messages...... 20

Installation Checklist...... 23

List of Files...... 23

Installation Tasks...... 23

PI Upgrades...... 27

Test Procedure...... 28

Glossary...... 36

January 9, 19971

Introduction

The PI Measurex Open interface connects OSI Software's Plant Information (PI) system to Measurex LAN Devices that support Measurex’s ODX Protocol or to Measurex’s MX Server Hardware. The interface allows PI system to access most data in nodes on Measurex LANs. It also supports PI outputs which can be used to send data to the Measurex nodes.

This interface consists of a program running on the PI Host making calls to/from the PI archive and communicating with the Measurex via TCP/IP socket calls.

The supported Measurex system configurations are as follows:

PI to Measurex Application Manager (AM) via Measurex ODX network protocol (AM release 1.0 and 2.0 or higher, also referenced as MXOpen release 94). This is a Peer to Peer connection in which the PI system communicates with only one Measurex AM node per PI Host interface process.
PI to MX Server to AM where the PI to MX Server connection utilizes the MX Server Protocol.
PI to MX Server to Data Freeway nodes (Vision, etc.). In this latter case, the MX Server communicates to its Data Freeway nodes via Measurex proprietary Data Freeway hardware and software.

In configurations 2 and 3, the connection is Peer to Peer with respect to the Measurex Server. Depending upon the configuration of the interface startup file (MXOn.COM), the connection may be either Peer to Peer or Peer to Many with respect to individual Measurex nodes.

Thus, one PI interface can get data from and send data to multiple MX nodes through the MX Server. Or one individual interface process can be dedicated to obtain/send data from/to a single Measurex node that is connected to the MX Server.

Connection Options [1]
Measurex / For use with AM, this interface requires Measurex ODX software version 1.4 or higher. For use with the MX Server, it requires Server software version 1.2 or higher.
VAX / This interface works best with PI 2.06 or higher.
TCP/IP / TCP/IP support is required on the computer executing the interface. This interface has been tested with TGV Multinet on DEC VAX and Digital Equipment’s TCP/IP Services on DEC VAX and ALPHA.
Version 2.13+ / This document applies to version 2.13 and higher of the PI-MX Interface. The interface version number can be found at the beginning of the MXOx.OUT file or the first dailylogfile file (if one is defined -- See below).
Supported Features
Sign Up for Updates / Yes
Exception Reporting / Yes
PINet Support / Yes
Outputs / Yes
Vendor Software Required / No
Failover / No
Maximum Number of Points / limited by capacity of Measurex Node

Figure 1. Connection Topologies for P1 to Measurex Interface

Interface Configuration

The interface uses the startup file (MXOn.COM) and PI point database to map PI tags to the corresponding Measurex symbol names and MX nodes. As shown in Figure 1, there are a number of connection topologies which can be utilized. In all cases, however, the Measurex symbol name must be defined in the Measurex system before it can be accessed by this interface. For Data Freeway nodes, the symbol names are defined in the MX Server; for Measurex Application Manager nodes, the symbol names are defined intrinsically by the Application Manager.

Hardware

The interface requires Ethernet hardware and properly connected and terminated cabling.

Software

The interface requires TCP/IP support. Also, it utilizes features of PI V2.06 and higher.

Startup File

The set of interface parameters (defined in MXOn.COM) used for all connection topologies are listed below. Some of the parameters have different usages depending upon the type of network connection intended.

Parameters Common to All Types of Connections

There should be one copy of MXOn.COM for each instance of the interface as follows:

Common Parameters
/PS=X / The letter to designate Point Source for PI Point database. Must also be setup in the PI Point Src Display
/ID=LinkName# / This is the name for this instance of the interface to be used in messages. If there are multiple instances of this interface, there should be different name for each.
/EC=n / (optional) I/O Rate Counter number to be used with this interface. Used to keep track of I/O throughput for this interface to the PI database
/MXINET=Internet ID / IP address Measurex node to which this interface is connecting (in dot format like 159.124.80.145). If there is an MX Server, this is the IP address of the Server, otherwise, it is the IP address of the AM node.
/IOSTAT=starting # of IO status / Starting number of PI IO Status codes defined for this Interface (i.e., the most negative value). Default number is -550.
/KA=Keep Alive message rate [sec]. / Rate at which interface queries network connection to Measurex to verify the status of that connection. For MX Server operation, it can be set to 40 seconds. For operation with ODX, the value should be set to 5 seconds less than the value defined in the Measurex configuration file IDSERVER.CFG file located in the Measurex system C:\VISION directory.
If this file is missing, set the Keep Alive rate to 25 seconds. This file should only be changed by certified MX personnel and requires a MX reboot to take effect.
/RSPT=Maximum wait time [sec] / Maximum time to wait for status response from Measurex. The default of 30 seconds is adequate for most situations.
/F=hh:mm:ss / Multiple Scan Groups can be defined in the startup file by adding additional /F=hh:mm:ss items (separated by white space).
A specific Scan Group is referenced by its enumerated position in the startup file. Thus, if the startup file contains three Scan Groups as follows (/F=00:01:00 /F=00:00:30/F=1:00:00), then the 1 minute group is referenced as Scan Group 1 because it is the first in the list; the 30 second group is Scan Group 2; and the 1 hour group is Scan Group 3, etc.
Individual PI tags are defined as belonging to a specific Scan Group by using Location 4 parameter.
/DB / (optional) Turns on additional interface messaging. It is useful for trouble-shooting the interface and network communications. When it is set, all network messages between the interface and Measurex will be recorded in the interface log file.
/SN / (optional) Overrides exception reporting with snapshot reporting. This means that exception specifications are bypassed and data is put in the archive when the compression specifications are exceeded. If compression is also turned off, data is put in the archive as it is received.
/OUT=Daily Logfile Name / (optional) Name and location of an auxiliary log file into which the interface will place its trouble-shooting and normal message output. This file rolls over daily (at 12:10 A.M.) into a new file. (When this file is used, the interface process will also utilize an error file MXOx.OUT which the operating system attaches to the interface process. This file does not roll over; it contains all Operating System specific messages.)
If this parameter is not defined, the interface will send all its trouble-shooting and normal message output to the process output file MXOx.OUT.
/MSGFL=MSG File Name / (optional) Name and location of a file containing real-time switch settings to be sent to the interface. The interface will check every 2 minutes for the existence of this file. If it exists, it will parse the file for the new switch settings contained in this file and then delete this file.
Currently, this file can be used to turn trouble-shooting on or off without having to restart the interface. To turn on debugging, create a file with the specified MSG File Name and put “/DB” in line one column one. To turn off debugging, put “/NODB” in line one column one.
/MON=“PI Tag Name” / (optional) Name of a PI Tag for which trouble-shooting information will be printed to the interface log file. When a tag is specified, the interface will print all I/O communication and messages to PI that refer to this tag.
Multiple tags can be monitored by adding a /MON=“tagname” for each tag that is monitored. The specified tag name should include blank trailing characters if the tag name is less than 12 characters.
This can be used as an alternative to the full trouble-shooting switch /DB.

Parameters For Peer to Peer Connections to Measurex AM Nodes

The following parameters are to be used in addition to those above.

Measurex AM Nodes Parameters For Peer to Peer Connections
/HOST=PIHostNode / Computer Name which Measurex AM uses to identify the connection
/POLL=Polling rate [sec] / Rate at which to request Profile status updates from Measurex for variable types 3, 4, and 5.
/MXO=Measurex System number / 3 digit number used to relate PI tags to this particular instance of the interface. Can be any value as long as it matches the last 3 digits of the location 1 tag parameter. If there are multiple instances of this interface, this number should be unique for each interface.
/PROC=Process Names / Defines the process name of the AM System and relates to the PP digits of location 1 of the PI tag. There should only be one instance of the parameter in the MXOn.COM file. Thus, PP in location 1 should be 01.
/ODX=UserName:Password / Tells the interface to utilize the ODX communications protocol. Also, provides the UserName and Password required to log on to the Measurex AM. This name and password must be known to the Measurex system. These are defined in the Measurex file IDSERVER.CFG. In addition, this file defines access privileges for each UserName as FULL or PARTIAL. The FULL privilege allows reading or writing data from/to the Measurex system. The PARTIAL allows only reading data from the Measurex system.
/ODX=IDS :RESULTS is Measurex’s default UserName and Password. It has read and write privileges. Therefore, the PI user can set up this parameter as /ODX=IDS :RESULTS.

The interface uses the MX System number in Location parameter 1 to map a particular tag to a specific instance of the interface and thereby to a particular Measurex AM node.

Parameters For Peer to Peer Connections through Measurex Server

The following parameters are to be used in addition to those above. Under this setup, the interface is commuicating to one MX Node through the MX Server.

Connections though Measurex Server Parameters
/HOST=Unique PI Interface Name / Computer Name which Measurex Server uses to identify the connection. This name must be included in the MX Server configuration files in order for the server to reference it. If multiple instances of the interface are used, this name should be unique for each instance of the interface.
/POLL=Polling rate [sec] / Rate at which to request Profile status updates from Measurex for variable types 3, 4, and 5.
/MXO=Measurex System number / 3 digit number used to relate PI tags to this particular instance of the interface. Can be any value as long as it matches the last 3 digits of the location 1 tag parameter. If there are multiple instances of this interface, each getting data from a different MX node, this number should be unique for each interface.
/PROC=Process Names / Defines the process names of the Measurex nodes connected to the MX Server and relates to the PP digits of location 1 of the PI tag. There will be a separate /PROC=ProcName parameter for each Measurex Process Name. These process names should match those defined in the MX Server configuration files and should be the same for all instances of the interface communicating with this MX Server.
A specific Process Name is referenced in the PP digits of Location 1 by its enumerated position in the startup file. Thus, if the startup file contains three Process Names as follows (/PROC=PM1 /PROC=COATER1 /PROC=PM2), then PM1 is Process 1 because it is the first in the list; the Coater 1 is Process 2; and the PM2 is Process 3, etc.
/DFY / Required if this instance of the interface is talking through the server to Measurex Data Freeway nodes.
NOTE If the MX Server is talking to both Measurex Data Freeway and Application manager nodes, you must utilize separate interface processes and dedicate one process to communicate through the MX Server to the Data Freeway nodes and one each to the Application Manager Nodes.
/DATE / Required if the MX Server was configured with -date option. When the MX Server uses the -date option in its startup file, the MX Server will include both date and time stamps in its messages; otherwise it includes only the time.

The interface uses the MX System number in Location parameter 1 to map a particular tag to a specific instance of the interface and thereby to a particular MX Server. The Process Number in Location parameter 1 maps a particular tag to a specific MX Node attached to the MX Server.

Parameters For Peer to Many Connections through Measurex Server

The following parameters are to be used in addition to those above. Under this setup, the interface is commuicating to many MX Node through the MX Server.

Peer to Many Connections though Measurex Server Parameters
/HOST=Unique PI Interface Name / Computer Name which Measurex Server uses to identify the connection. This name must be included in the MX Server configuration files in order for the server to reference it. If multiple instances of the interface are used, this name should be unique for each instance of the interface.
/POLL=Polling rate [sec] / Rate at which to request Profile status updates from Measurex for variable types 3, 4, and 5.
/MXO=Measurex System number / 3 digit number used to relate PI tags to a specific MX Server. Can be any value as long as it matches the last 3 digits of the location 1 tag parameter. This number should be unique for each MX Server.
/PROC=Process Names / Defines the process names of the Measurex nodes connected to the MX Server and relates to the PP digits of location 1 of the PI tag. There will be a separate /PROC=ProcName parameter for each Measurex Process Name. These process names should match those defined in the MX Server configuration files and should be the same for all instances of the interface communicating with this MX Server.
A specific Process Name is referenced in the PP digits of Location 1 by its enumerated position in the startup file. Thus, if the startup file contains three Process Names as follows (/PROC=PM1 /PROC=COATER1 /PROC=PM2), then PM1 is Process 1 because it is the first in the list; the Coater 1 is Process 2; and the PM2 is Process 3, etc.
/DFY / Required if this instance of the interface is talking through the server to Measurex Data Freeway nodes.
NOTE If the MX Server is talking to both Measurex Data Freeway and Application manager nodes, you must utilize separate interface processes and dedicate one process to communicate through the MX Server to the Data Freeway nodes and one each to the Application Manager Nodes.
/DATE / Required if the MX Server was configured with -date option. When the MX Server uses the -date option in its startup file, the MX Server will include both date and time stamps in its messages; otherwise it includes only the time.
/LPN=Measurex Processor Names / (Optional -- Only required in the case of non-unique Measurex symbol names.) Measurex Process Number -- For example: LPN1
Can be multiple /LPN parameters in startup file; they are referenced by their enumerated position (similarly to /PROC above)
/BTI=Measurex memory bank names / (Optional -- Only required in the case of non-unique Measurex symbol names.) Measurex Memory Bank Number -- For example: BTID2..
Can be multiple /LPN parameters in startup file; they are referenced by their enumerated position (similarly to /PROC above)