Beruflich Dokumente
Kultur Dokumente
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 statementPI 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. HP-UX
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
Introduction.................................................................................................................... 1
Supported Features......................................................................................................2
Connection Options......................................................................................................3
PI Point Configuration....................................................................................................5
Point Parameters Definition..........................................................................................5
Point Examples.......................................................................................................... 10
Profile Status Handling...............................................................................................11
HMX DaVinci Issues...................................................................................................12
Interface Operation......................................................................................................37
Data Rate Monitoring..................................................................................................37
Error and Information Logging -- VMS........................................................................37
Error and Information Logging -- Windows.................................................................37
Error Messages.......................................................................................................... 38
Error Modes................................................................................................................ 38
Appendix A: Glossary..................................................................................................43
Revision History............................................................................................................. 45
Supported Features
Feature Support
Part Number PI-IN-MX-MXO-AXP
PI-IN-MX-MXO-NTI
PI-IN-MX-MXO-VAX
Platforms VMS / Alpha VMS / NTI (4, 2000, XP)
PI Point Types PI 3: Float16 / Float 32 / Int16 / Int32 /
Digital / String
PI 2: Float / Integer / Digital
Sub-Second Timestamps No
Sub-Second Scan Classes No
Automatically Incorporates PI Point Yes
Attribute Changes
Exception Reporting Yes
Outputs from PI Yes
Inputs to PI: Scan-Based / Unsolicited / Scan-based
Event Tags
Maximum Point Count Limited by capacity of HMX Node
Uses PI-SDK No
PINet to PI 3 String Support No
History Recovery No
Failover No
* UniInt-Based Yes
Vendor Software Required on PI-API / No
PINet Node
Vendor Software Required on Foreign No
Device
Vendor Hardware Required No
Additional PI Software Included with No
Interface
* See below for more information.
UniInt-Based
UniInt stands for Universal Interface. UniInt is not a separate product or file; it is an
OSIsoft-developed template used by our developers, and is integrated into many
interfaces, such as the PI-MXO interface. The purpose of UniInt is to keep a consistent
feature set and behavior across as many of our interfaces as possible. It also allows for
the very rapid development of new interfaces. In any UniInt-based interface, the
interface uses some of the UniInt-supplied configuration parameters and some
interface-specific parameters. UniInt is constantly being upgraded with new options and
features.
Connection Options
Connection Usage
HMX For use with AM, this interface requires HMX ODX
software version 1.4 or higher. For use with the MX Server,
it requires Server software version 1.2 or higher.
TCP/IP TCP/IP support is required on the computer executing the
interface. VMS certified with TGV Multinet on and
DEC UCX. NT Certified on MS TCP/IP stack for WinNT
3.51 and 4.0
Figure 1
Connection Topologies for
PI to Measurex Interface
PEER to PEER
Application
PI Host
Manager
Tag Process
PI Tag ODX Protocol for PM1
Database For
One MX
Node
PEER to MANY
Sample Measurex Network
PI Host MX
Process Server
PI Tag Tag MX Server
Database For DataFreeway
Protocol
Many MX Protocol
Nodes through ODX
Single Server Protocol Data Freeway
Node
for Node 3
Application Application
Manager Manager
for Node 1 for Node 2
Note: Beginning with version 3.0 of this interface: The box representing PI Host
Process may also refer to a PI API node running the interface.
Note: It is preferable to use the Unsolicited-time-driven INPUT type of tag over the
Solicited-time-driven INPUT type of tag. The former requires less network traffic and
CPU overhead at both ends of the link.
Point Source
The point source is any one-character value that is usually the same for all points of
MXO interface. If a different point source is used, edit the file PISysExe:MXOn.COM
(or \pipc\interfaces\MXO\MXOn.BAT) to change the character specified and run Point
Src from the PI menu to define the character and establish the limits.
If the PI Server is running PI2 then the Point Source Table needs to be edited as shown
below.
Location 1 Location 2 Location 3 Location 4 Location 5
1001 110000 0 0 0
99999 521024 99999 99 199999
Point Type
The interface supports the following PI2 point types. This is usually R (real) for data
values, and I or D for counters, flags, etc. However, any PI point type can be used for
any PI point.
The interface supports the following PI3 point types: Float16 and Float32, Int16,
Digital, and string tags. String tags can only be used when the interface is running on
NT-Intel and sending data to a PI3 Server.
Notes: (1) If D or I is used for a real value and the value is less than 0 or greater
than 32767, the point is given a status of either UNDERRANGE or OVERRANGE,
respectively.
(2) HMX status flags (in HMX parlance, Ordinals) may be stored in either D or
I type variables.
Location1
The first location contains the Process Number (PP) and the HMX System Number
(SSS) packed as:
(PP * 1,000) + SSS
i.e. PPSSS
Where:
1. Process Number refers to the ASCII name (See description of /PROC in startup
file item below.) of the group of process equipment associated with this PI tag. For
PI HMX ODX interfaces, PP=1 (there is only one Process Name per interface)
since the connection is Peer to Peer with AM nodes.
2. HMX System Number matches the startup parameter in MXOn.COM (or
MXOn.BAT).
3. The specific usage of these items depends upon the nature of the connection with
HMX and upon the startup file. See description of /MXO parameter in Software
Configuration below.
Location2
The second location is used to specify the Variable Type (V), the Data Type (D) and the
Array Element Number (AAAA) packed as:
(V * 100,000) + (D* 10,000) + AAAA
i.e. VDAAAA
where:
1. Variable Type (V) specifies the type of variable referred to by the HMX symbol
name (reference the Instrument Tag below):
Variable types 3 through 6 are supported only for Peer to Peer Connections to HMX
AM Nodes via ODX. Variable types 3 - 5 provide are provided for the special
information embedded in scanner based profiles (i.e., Scanner status, sensor status, and
edge positions). In order to provide this additional information, the interface makes
assumptions that the AM follows a HMX symbol naming standard. (See Section on
Profile Status Handling below).
Variable type 6 allows the interface to receive ASCII-converted number data from
HMX and store it as a number in the PI database. The interface does not support other
types of ASCII data.
2. Data Type (D) specifies the kind of data. Two data types are supported:
1 Numeric Value
2 Digital value (In HMX terminology, an Ordinal value)
3. Array Element Number (AAAA) specifies the correspondence of this PI point with
an element within a HMX array (Variable Type 2 to 5). The maximum Array Element
Number for Variable Types 2 to 4 is now 256. For Variable Type 5, the maximum is
1024.
Location3
The third location is used to set up an UNSOLICITED TIME where HMX provides
the time trigger:
MX Trigger Time Rate (RRRRR) in seconds:
RRRRR
where:
MX Trigger Time Rate (optional) specifies how often HMX should send the data for
this PI tag to PI. This field must be zero if PI Scan Group, PI Event or HMX Event
triggers are defined. This parameter is required for UNSOLICITED TIME INPUT
tags.
Location4
The fourth location is used to set up a SOLICITED TIME where PI provides the time
trigger:
Scan Group
Scan Group number (optional) specifies the Scan Group to which this point belongs.
This parameter is required for SOLICITED TIME INPUT tags.
The user defines a scan list by specifying the time between executions for each scan list
in the interfaces startup parameters (See MXOn.COM for VMS or MXOn.BAT for
WinNT). The scan lists defined thereby, are referenced in the Location 4 parameter by
their sequential position (i.e., 1,2, 3, etc.) in the startup parameters. For example: if
there are three Scan Groups each executing at a different rate, then there will be three
Scan Groups specified in the startup parameters.
If the value for this PI tag should be requested at the rate specified by the third Scan
Group time, then Location 4 contains a Scan Group value of 3.
This parameter will be ignored if other parameters defined in the PI tag specify time or
event triggering.
Location5
Specifies the Input/Output Flag (F), the HMX Processor Number (M) and the BTI
Number (BBBB) packed as:
(F * 100,000) + (M * 10,000) + BBBB
i.e. FMBBBB
Where:
1. Input /Output Flag: If flag is set to 1, tag makes outputs to the HMX system upon
changes in its value or other PI-defined trigger.
2. MX Processor Number (optional) defines the ASCII name of the HMX processor
(LPN) associated with this point. It is used in conjunction with interface startup
parameter /LPN=ProcessorName1 /LPN=ProcessorName2 etc. Processor Number
references the nth item in the list of /LPN= startup parameters to provide the ASCII
for the Processor name.
3. BTI Number (optional) defines the ASCII name of the HMX memory bank
associated with this point. It is used in conjunction with interface startup parameter
/BTI=BTIName1 /BTI=BTIName2 etc. BTI Number references the nth item in the
list of /BTI= startup parameters to provide the ASCII for the BTI name.
Notes: (1) The LPN and BTI numbers are usually not required unless the HMX
symbol name is not unique within a HMX LPN. In practice, the symbols of interest to
PI are not likely to be so defined.
(2) If either LPN or BTI number is provided, then both must be provided.
The interface log file will report an error if HMX can not uniquely resolve the symbol
name; i.e., HMX system has more than one symbol with the same name.
Note: The MX Server sometimes has problems when attempts are made to access
undefined symbols on Data Freeway nodes. As a result, it is suggested that the user
verify the accuracy of the symbols for Data Freeway nodes by trying them at the MX
Server.
If HMX symbols are not unique within a node and require LPNx\BTIDx type
specifications, do not specify the full HMX variable in the instrument tag as
LPNx\BTIx\Variable_Name. If the LPN and BTI are specified in Location 5, the
interface will automatically prepend the LPN and BTI specification to the symbol name
specified in the Instrument Tag.
Valid characters in symbol names are _,$,0-9, a-Z, and . . No embedded
blanks are allowed.
SourceTag
PI tag (not case sensitive) used as the source of the data to be output to the HMX
Symbol specified by the Instrument Tag.
Notes: (1) To use this field requires site running PI V2.06 or higher.
(2) An alternative method for specifying a source tag is to include source =
any valid PI Tagname in the extended descriptor.
(3) A source tag name is required for OUTPUT type of tags.
Extended Descriptor
This is limited to 80 characters. The following possible delimiters and symbol names
must fit within the 80 characters.
/Tx = any defined HMX Ordinal Symbol Name (optional). It specifies a HMX
event trigger that is used to trigger its transmission of unsolicited data to PI. It has
maximum of 31 characters. This parameter is required for UNSOLICITED
EVENT INPUT tags. The HMX Symbol must refer to a HMX Ordinal (i.e., digital
flag).
Where: /Tx= may have the following values:
/T0 = Trigger on 0 to 1 transition of HMX variable
/T1 = Trigger on 1 to 0 transition of HMX variable
/T2 = Trigger on any transition of HMX variable
Point Examples
The following PI point examples explain the point parameter definition specified above.
In addition, the MXO interface will make a special request for scanner status
information if no profile data is received within the time period specified by the /POLL
parameter in the MXOn.COM(or MXOn.BAT) startup file.
This can be valuable if the scanner is offsheet due to a paper break, etc. In this
situation, the PI tags for the profile will show a status of Emergency OFFSheet or
OFFSheet.
Note: If the Application Manager does not follow this convention for profile data, the
user may want to ask HMX to make the required changes.
Time Stamps
The interface uses PIs time for the all data received from HMX.
The simplest way to handle this is to define the event names of interest as symbols
in the DaVinci data symbol list. This will allow the interface to validate the events
as symbols.
Hardware
The interface requires Ethernet hardware and properly connected and terminated
cabling.
Software
The interface requires TCP/IP support.
SYRNI01,1
If /ec=1 is used on the command line for the above iorates.dat file, then the rate (events
per minute) at which data is sent to the snapshot will be stored in SYRNI01. The rate
that is sent to iorate counters is a 10 minute average (i.e. the total number of events
collected by the interface divided by 10 minutes). Therefore the IORate will appear to
be zero for the first 10 minutes of interface operation.
On VMS, the interface rate tag should then be added to the I/O Rate List,
PISysDat:IORates.dat. The counter chosen may be any unused counter in the ranges of
1 -35 or 51 - 200. The IORates process must then be stopped and restarted for the
counter to be included. The IORates process can be stopped by:
@PISysExe:stop iorates
the IORates process can then be restarted by:
@PISysExe:iorates
For additional information see Data Rate Monitoring in the Interface Standard chapter
of the PI Interface Manual (IN).
On NT, the iorates.dat file must be The iorates.dat file must be created by hand. The
file should be placed in the dat\ directory. The dat\ directory is located in the directory
designated by the PIHOME entry in the pipc.ini file. Normally the PIHOME entry
points to the c:\PIPC\ directory so that the iorates.dat file will reside in the c:\PIPC\dat\
directory. Once the iorates.dat file is created, the interface must be stopped and
restarted before the interface begins measuring the IORate.
IOStatus Codes
The interface requires that the following digital states are defined in the Digital State
Table for a PI2 server and the System Digital State Set for a PI3 server. The default
starting code is 550 if the /IOSTAT parameter is not passed in the startup command
file.
The IOStatus Codes are shown in numerically increasing order. Thus, if IOStatus
WaitScnr is entered in the Digital State Table at number 550, then IOStatus
UndfSymMX would be positioned at number 603. Reserved items may be left blank.
Scanner/Profile Statuses
Code State Description
550 WaitScnr Scanner waiting to move
551 BkgrdScnr Scanner in background mode
552 RefScnr Scanner in reference mode
553 SmplScnr Scanner in sample mode
554 StdzScnr Scanner in standardize mode
555 ScanScnr Scanner in scan mode
556 SnglPtScnr Scanner in single point mode
557 OffShtScnr Scanner in offsheet mode
558 EmrgOffScnr Scanner in emergency offsheet mode (probably because of
sheet break)
559 2StrtScnr Scanner getting ready to start
560 LimboScnr Scanner in limbo scan mode (usually locating sheet edges)
561 SmplGrdScnr Scanner in grade sample mode
562 OfflineScnr Scanner in offline mode
563 ProfCorScnr Scanner in profile correction mode
564 ReptScnr Scanner in repeat mode
565 GrdLdScnr Scanner in load grade data mode
Startup File
The set of interface parameters (defined in MXOn.COM or MXOn.BAT) used for all
connection topologies are listed below. Some of the parameters have different usage
depending upon the type of network connection intended. The command line parameters
for the MXO interface need to be edited with site specific startup parameters. The site
specific interface parameters required for MXO interface startup are the same for both
the NT and VMS platforms. However, the script files (MXOn.COM and MXOn.BAT)
differ.
REM MXO.BAT
REM
REM Generic command file to start the MXO interface
REM For combined ODX/MX Server implementation
REM Version 3.00, 1993-1997
@echo off
cls
echo on
REM
REM revised:Last Modification
REM 20-may-97 VEF
REM
REM if multiple copies of the interface are to be run, copy MXO.BAT to
REM MXOn.BAT
REM where n is the same number passed by /id=n in the command string.
REM
REM command line arguments:
REM
REM Universal Interface parameters (in any order)
REM /PS = point source.
REM Use whatever letter you want and also setup matching
REM output. This file rolls over daily (at definite time) into a
new file
REM /MSGFL = Full Path and file name of message files used
REM to to send messages to program.
REM /INTFTG = Name of PI tag that has value 1 if communications to MX Node is
up
REM and 0 if the communications are down
REM /MXSYM= Max Number of single valued HMX symbols to include in a data
REM request (Default is 20; max is 100)
REM /SYMDLY= Number of seconds to delay between each symbol verification:
REM (Default is 1.0 seconds)
REM NOSERVICE system runs PItoMXO interface as a console application
REM instead as WinNT service.
REM Edit the following to select the switches of interest
REM Run string needs a space between arguments, no spaces within argument.
pause
MXO.exe /mxdate /ps=M /id=1 /ec=7 /sn /out=c:\mxo\mxo.out /host=pltal1:545
/intfhost=namebywhichmxlistsus /mxo=1 /mxinet=167.148.253.140 /ka=20 /rspt=30
/poll=120 /proc=gppm6 /iostat=-700 /f=00:00:12 /f=00:00:05 /f=00:00:31
/stopstat=shutdown
/KA = Keep Alive Rate at which MXO interface queries network connection to HMX to
message rate [sec]. 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 HMX configuration file
IDSERVER.CFG file located in the HMX 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 time [sec] to wait for status response from HMX. The
default of 30 seconds is adequate for most situations.
/F = Scan period.
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 HMX will be
recorded in the interface log file.
/SN (optional) snapshot, MXO interface 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 (optional) name and location of an auxiliary log file into which the
Name interface will place its trouble-shooting and normal message output.
This file rolls over daily (at 12:10 A.M.) into a new file.
VMS -- (When this file is used, the interface process will also utilize
an error file MXOn.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
MXOn.OUT.
WinNT -- The interface will send system error messages to the console
(if noservice option is selected) or to the PI Message Log system.
Trouble-shooting, normal and debug message output will be sent to a
file MXO_DateTime.OUT that rolls over daily to a new file. Warning:
this file can get very large.
If this parameter is not defined, the interface will send all trouble-
shooting and normal message output to the console (if noservice
option is selected) or to the PI Message Log system.
/SYMDLY=Sym Delay Time [sec] to delay between each symbol verification. Depends upon
capacity of MX AM to handle the cpu intensive symbol lookups. Default
is 1.0 second.
/INTFTG=Intf Tag Tag with value 1 or 0 if the communications to HMX node is up or down,
Status Name respectively.
/MXSYM=Max Maximum number of HMX symbols to include in single data request.
Symbols in single Default is 20; maximum is 100. This limit does not apply to array type
request symbols.
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.
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.
point source for the MXO Interface Points. Define it using the Point Src Display
from the PI Menu for PI2 servers.
5. Create an I/O Rate Tag for each MXO interface and add them to the file PISysDat:
IORates.Dat. Define these tags in the PI System. Edit PISysExe: MXO.COM with
the correct rate counter. Stop and restart the IORates program:
$ @PISysExe:Stop IORates
$ @PISysExe:IORates
6. Put correct parameters in PISysExe: MXO.COM. If you have more than one HMX
interface running, copy PISysExe: MXO.COM as PISysExe: MXOn.COM for
each interface to be run, where n refers to the link number of this HMX link.
7. Modify PISysExe: ShutdownEvents.Com to shutdown all HMX PI tags in the
event of a shutdown. Additionally, the interface is programmed to mark all HMX
PI tags as I/O timeout if the interface is stopped or exits abnormally.
8. Add stop command to SiteStop.Com.
$ @PISysExe:Stop MXO_In (n refers to the HMX link number )
9. Add the Interface IOStatus Codes to either the Digital State Table for a PI2 server
or the System Digital State Set for a PI3 server.
10. Configure the data points for the MXO interface.
11. Start the MXO interface(s) manually with:
$ @PISysExe:MXOnDetach.com
Or by (re) starting the PI or PINet System.
Note: When starting multiple copies of this interface, a short delay may be required
between calls to the detach command because of operating system contention on PI
installed images.
Installation Tasks
Create the directory to put the MXO interface into. The convention is to put the MXO
subdirectory under the pipc\interfaces directory; i.e. pipc\interfaces\mxo.
When installing TCP/IP software and PI3 system, the MXO interface batch
MXOn.BAT and executable files MXO.EXE files, as well as the utility files for point
creation should be located in this directory.
The files required for the MXO interface should be copied from the distribution
diskette directly to the \pipc\interfaces\mxo directory.
Once the above has been completed the following steps should be taken:
1. Configure the HMX systems according to the HMX MX Server Manual if the MX
Server is used
2. Establish the physical link between MX and NT. Test the connection by using the
TCP/IP PING utility program. It is suggested to test the link from both endpoints.
3. Choose a point source for the MXO Interface Points.
4. Add interface start and stop commands to the PI Site start/stop batch files.
5. Configure the IO Status codes for the interface.
6. Configure points for each copy of the MXO interface.
7. Determine an interface number for each interface to be run. This will be dependent
upon how many MXOs the host computer will read data from and write data to.
8. Edit the MXOn.BAT file(s) so that the proper parameters are passed.
9. Create a copy of the MXOn.EXE executable for each copy of the interface to be
run.
10. Install the interface as a service as discussed in Setting up the Interface as a
Service (section below).
11. Add the startup and shutdown commands to the startup and shutdown file as
discussed under Interface Startup and Shutdown Files discussed below.
procedure for starting, stopping, and removing the interface as a service is the same
whether or not Bufserv is used. The purpose of the Bufserv utility is to continue to
collect data from an interface in the event that the PI Data Archive is shut down for
some reason. For example, if the MXO interface is installed on the PI home node and
the PI Data Archive is shut down for an upgrade, the Bufserv utility on the PI home
node will buffer the data in a file until the PI Data Archive is brought back online.
Another possibility is that the MXO interface is installed on an API node. If there are
problems with the PI home node, then the Bufserv utility on the API node will buffer
the data in a file until the PI home node is brought back online.
The procedure for installing the interface in conjunction with the Bufserv Utility
assumes that the user has Bufserv 1.04 or higher because the procedure implicitly
assumes that Bufserv will be installed as a service. The actual installation of the
Bufserv Utility itself is not discussed. For these instructions, the user is referred to the
PI-API Bufserv 1.x Release Notes. Also, the installation procedure below does not
discuss the details related to shutdown events that the user should be aware of when the
Bufserv Utility is used. Once again, refer to the PI-API Bufserv 1.x Release Notes for
more information.
One can get help for installing the interface a service at any time by typing the
following:
mxo# -help
The mxo# service can be installed either as a manual or an automatic service.
Automatic services are started automatically when the NT operating system is
rebooted. This feature is useful in the event of a power failure. To install the interface
as a manual service, execute the following command from the \pipc\interfaces\mxo
directory.
Without Bufserv:
mxo# -install -depend tcpip
With Bufserv:
mxo# -install -depend tcpip bufserv
To install the interface as an automatic service, execute the following command from
the \pipc\interfaces\mxo directory
Without Bufserv:
mxo# -install auto -depend tcpip
With Bufserv:
mxo# -install auto -depend tcpip bufserv
Check the Microsoft Windows NT services control panel to verify that the service has
been successfully added. One can use the services control panel at any time to change
the mxo# service from an automatic service to a manual service or vice versa.
Once the mxoi# service has been installed, the rest of the procedure is the same whether
or not Bufserv has been implemented. The mxo# service can be started from the
services control panel or by executing the following command from the
\pipc\interfaces\mxo directory:
mxo# -start
A message will be echoed to the screen informing the user whether or not the interface
has been successfully started as a service. If the service is successfully started, the
Startup
Each interface should be set up to automatically start if the computer is rebooted. This
is done by setting the startup parameter in the Services Control Panel to Automatic.
The interface can also be manually started from the Services Control Panel by
highlighting the interface and clicking on Start. If the interface is running on a PIAPI
node, the interface can also be manually started by executing the following files which
should be created.
rem
rem pistart.bat 24-apr-98 jfz> OSI
rem
c:\pipc\bin\bufserv -start
rem
rem start interfaces
rem
call sitestart
rem
rem sitestart.bat 24-apr-98 jfz> osi
rem
rem start interfaces
rem
c:\pipc\interfaces\mxo\mxo1 -start & wait 5000
c:\pipc\interfaces\mxo\mxo2 -start
:theend
The file pistart.bat starts the buffering service first and then calls the file sitestart (a
.bat file) which starts mxo1 and mxo2 as services.
If the interface is running on the a PI3 Server, the interface can also be manually
started by adding line below to the pisrvsitestart.bat file found in the \PI\adm directory.
This entry should not be the last entry in the file.
C:\pipc\interfaces\mxo\mxo# -start
Shutdown
Each interface can be manually stopped from the Control Panel Services dialog box.
If the interface is running on a PIAPI node, the interface can also be manually stopped
by executing the following files which should be created.
rem
rem pistop.bat
rem
rem stop the interfaces
rem
call sitestop
rem
rem stop bufserv service
rem
c:\pipc\bin\bufserv -stop
The file pistop.bat stops the interface (running as services) first by calling sitestop.bat
and then stops buffering service.
rem
If the interface is running on a PI3 Server, the interface can also be manually stopped
by adding the following line to the pisrvsitestop.bat file found in the \PI\adm directory.
C:\pipc\interfaces\mxo\mxo1 -stop
When the interface is shutdown, the points coming into the system should receive
shutdown events. The switch /stopstat=shutdown be added so that if the interface is
shutdown independently of any PI processes, shutdown will get written to all points
belong to the interface. If the interface is running on a PIAPI node and is sending data
to a PI server, make sure that the interface points are not included in the list of points to
receive shutdown when the server goes down. If the interface is running on a PI3
server, the points belonging to the interface should also be specified to receive
shutdown when the PI server is shutdown. This is done by including the points in the
PI\dat\shutdown.dat file.
Error Messages
The major kinds of messages that could appear in the log file MXO.OUT (or daily
LogFile Name if specified) include Error Modes, Fatal Error Messages, Link Status
Messages, and Tag Configuration Messages.
The messages have the following format:
<Interface Name> <Subroutine Name> Message.
Error Modes
Undefined Symbols
When the interface is talking to a HMX AM node, it can detect if a PI tag references an
undefined HMX symbol. If the symbol name is accurate, define it on the HMX system.
To force PI to be respond to this change, edit the PI tag on the PI system using the
Point Edit display (without making an actual change) or restart the interface.
A simple way to locate them in the log file is to use the SEARCH command on the log
file for the string undefined. Search can operate on a file while the interface process
locks it.
Connections
The interface checks the integrity of the communications connection with the HMX
MX Server or ODX every Keep Alive rate seconds (/KA). If the interface does not
receive a response to its message, it executes the routine DoMLIShutdown which marks
all interface tags as I/O Timeout.
The interface then attempts to re-establish the connection with HMX. The interface
prints a message to the MXO.OUT log file whenever there is a status change to the
connection.
Incomplete Messages
Occasionally, the HMX sends an incomplete message to the PI interface. This may
occur with extremely long messages (usually over 8000 bytes) when the HMX system
breaks the message into blocks of 4096 bytes. HMX may send the first and second
blocks but not the third, etc.
This may happen if the HMX system doesnt acknowledge rapidly enough (usually
within 2 seconds) from the TCP/IP System software layer. The causes of these timing
glitches can be either:
an extremely busy network
a network with some hardware problems, or
a very busy Host.
The symptoms of this type of problem appear in the archive and/or in interface log file
as follows:
I/O Timeout status occurs every now and then in the archive for the interface
tags.