Honeywell CM50S - OSIsoft



Honeywell PHD

Interface to the PI System

Version 1.5.x and greater

How to Contact Us

|Phone |(510) 297-5800 (main number) |

| |(510) 297-5828 (technical support) |

|Fax |(510) 357-8136 |

|Internet |techsupport@ |

|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 |OSI Software, Ltd |

| |Hauptstra(e 30 |P. O. Box 8256 |

| |D-63674 Altenstadt 1 |Level One, 6-8 Nugent Street |

| |Deutschland |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. 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.

HWPHD.doc

( 1997 OSI Software, Inc. All rights reserved

777 Davis Street, Suite 250, San Leandro, CA 94577

Table of Contents

Overview 1

PI Point Definition 3

PIPHDPtBld 3

PointSource 4

PointType 4

InstrumentTag 6

ExtendedDescriptor 6

SourceTag 6

Scan 6

Location1 6

Location2 7

Location3 7

Location4 7

Location5 8

History Recovery 9

Time Stamps 10

Hardware and Software 11

Hardware Requirements for PI-PHD 11

Software Requirements for PI-PHD 11

Optional Manuals for PHD 11

Startup Command File 12

PI-PHD Interface Installation 14

NT-Intel Installation Disk File List 14

Installation Notes 14

Installation Procedure 15

PI-PHD Interface System Administration 19

Starting the PI-PHD interface 19

Automatic Service Startup 19

Manual Service Startup 19

Interactive Startup 19

Stopping the PI-PHD Interface 19

Registering the PI-PHD Interface as a Windows NT Service 20

Manual Services 20

Automatic Services 20

Removing the PI-PHD Interface as a Windows NT Service 20

Status, Warning, And Error Messages 20

IORates 21

Overview

The Honeywell PHD Interface, from here on known as the PI-PHD interface, provides two-way communication with a Honeywell PHD System. The interface program reads the PI point database to determine which points to read from and write to the Honeywell PHD System. This interface runs on a TPS Node, which contains the PHD API from Honeywell. The customer must be running a Honeywell PHD System.

The PHD System must be at version 100 or higher, and the LCN must be at version 520 or higher. More information can be found in the Totalplant Process History Database Electronic Documentation 100 rev 1 12 AUG 1997.

This version of the interface includes:

1. Reads data from and writes data to a Honeywell PHD system.

2. Point database utility to build csv files from the PHD system to use with piconfig to create and edit the PI point data base.

3. History recovery.

|Supported Features |

|Sign up for updates |Yes |

|Exception reporting |Yes |

|PIAPI Node |Yes |

|Outputs |Yes |

|Vendor software required |Yes |

|Failover |No |

|History Recovery |Yes |

|Uniint based |Yes |

|Maximum points |Unlimited |

[pic]

PI Point Definition

A PI point or tag is a single parameter of a PHD point. For example, a process variable and a setpoint are part of the same point in the Honeywell system. However in both the PI and PHD systems these parameters are stored as two separate tags.

PIPHDPtBld

A utility called PIPHDPtBld.exe can be used to build a file called PIPHDPtBld.csv which contains all points from the Honeywell PHD point database. The PIPHDPtBld.csv contains the PHD tagname, descriptor, engineering unit, zero, span, and pointtype for each point. If the PI and PHD tag names will be the same then the interface does not require anything to be entered into the PI instrument tag field. If the PI and PHD tag names will be different then the PHD tag name must be entered in the PI instrument tag field.

The file below, PIPHDPtBld.txt, is a piconfig file that will read the PIPHDPtbld.csv file. In the example below the PI and PHD tag names are the same so nothing is needed to be entered into the instrument tag field.

*create tags from piphdptbld.csv

@table pipoint

@ptclass classic

@mode create,t

*modify following for site specific settings

@modify pointsource=H,location1=1,location2=1,location4=1

@istru tag,descriptor,engunits,zero,span,pointtype

@input piphdptbld.csv

If the PI and PHD tag names are to be different, the user should import the PIPHDPtbld.csv into Excel and create a separate column containing the PI tag name. The tags can then be created using the PI SMT tools or the file can be exported back to ASCII and piconfig run.

An example PIPHDPtBld.txt for this situation is shown below.

*create tags from modified piphdptbld.csv

@table pipoint

@ptclass classic

@mode create,t

*modify following for site specific settings

@modify pointsource=H,location1=1,location2=1,location4=1

@istru tag,instrumenttag,descriptor,engunits,zero,span,pointtype

@input piphdptbld.csv

The following PI point attributes determine how values are interpreted as they are moved to or from the Honeywell system.

PointSource

All points defined in the PI database to be used by the PHD interface must share a common point source. The point source is a one character variable, for example H. Edit the startup file PI-PHD.bat to specify the point source to be used.

PointType

The PI point type should usually match the PHD parameter type. Use Float16 or Float32 for real points, Int16 or Int32 for integer Points and Digital for enumeration. You can use a PI point type that does not match the PHD point type.

The interpretation of a PHD 24-character string or a 40-character string depends on the PI point type. For digital PI tags, the first 12 characters of the string are treated like a digital state string. For real and integer PI tags, the string variable is treated as an ASCII representation of the value. An exception is for time stamp outputs as described under Location5 below. The strings can also be put into a PI String tag for PI3 systems. String tags are not supported for PI2 systems.

The following tables show the interpretation of the PHD parameter types and PI point types for Inputs and Outputs.

Table 1. PHD parameter types to PI Points type: Interpretation for Inputs

|PHD Parameter Type |PI Point Type |Input Interpretation |

|Real |Real |Real |

|Real |Integer |Integer |

|Real |Digital |Digital State Code from Real Number Rounded to Integer |

|Real |String |Real value string |

|Integer |Real |Real |

|Integer |Integer |Integer |

|Integer |Digital |Digital State Code |

|Integer |String |Integer value as string |

|Enumerated/Ordinal |Real |Ordinal Value as Real |

|Enumerated/Ordinal |Integer |Ordinal Value as Integer |

|Enumerated/Ordinal |Digital |Ordinal Value as Digital State |

|Enumerated/Ordinal |String (PI3 only) |Ordinal value string |

|24 or 40 char ASCII |Real |ASCII Representation of Real |

|24 or 40 char ASCII |Integer |ASCII Representation of Integer |

|24 or 40 char ASCII |Digital |First 12 Characters as Digital State String |

|24 or 40 char ASCII |String (PI3 only) |String (PI3 only) |

Table 2. PI Point Type of Source Point to PHD ParameterType: Interpretation for Outputs

|PI Point |PHD 3000 | |

|Type of Source |Parameter Type |OutPut Interpretation |

|Real |Real |Real |

|Real |Integer |Real Number rounded to Integer |

|Real |Enumerated/Ordinal |Real Number rounded to Integer |

|Real |24 or 40 Char ASCII |ASCII Representation of Real to 2 decimal places |

|Integer |Real |Real |

|Integer |Integer |Integer |

|Integer |Enumerated/Ordinal |Ordinal Value |

|Integer |24 or Char ASCII |ASCII Representation of Integer |

|Digital |Real |Digital State Value (0*1*2*..state) as Real Number |

|Digital |Integer |Digital State Value (0*1*2*..state) |

|Digital |Enumerated/Ordinal |Digital State Value (0*1*2*..state) as Ordinal Value |

|Digital |24 or 40 Char ASCII |Digital State String |

|String(PI3) |Real |String converted to Real number |

|String(PI3) |Integer |String converted to Integer number |

|String(PI3) |Enumerated/Ordinal |String converted Ordinal Value |

|String(PI3) |24 or 40 Char ASCII |String |

If the input values read from the PHD have a bad status, the “Bad Input” digital state is sent to the PI point.

If the PI point for Outputting to the PHD is in a “not normal state” NO value is sent for the PHD parameter types except for real types.

Not a Number (NaN) representation is sent for real parameter types if the real value is a bad status.

The values of PI points are in a “not normal state” if:

For real points the status value is other than 0 referring to the Digital State Table (for example, SHUTDOWN,I/O TIMEOUT, BAD INPUT, Under Range, OverRange).

For integer points, the value is a Digital State string.

For Digital points when the value is not within its digital state set.

InstrumentTag

This filed must contain the PHD parameter name if that name does not match the PI tag name. The format is:

point.param(index)

where:

point is the PHD point name, param is the PHD parameter name, and index is the array index. The index is used only with array variables.

ExtendedDescriptor

The Extended Descriptor can be used in conjunction with the Location2 parameter. When outputting both a value and a timestamp (Location2 = 4), you must specify the PHD point parameter in the Extended Descriptor field. The parameter must be a time type or string type. The syntax for defining a point that contains a time stamp for output to PHD is as follows:

TIM=point.parameter

The extended descriptor is also used to specify event based scanning for an input. The syntax for defining an event-based point is to add the following in the Extended Descriptor of the input point:

EVENT=PI tag name, where the PI tag name is the name of the event trigger tag.

Every time the interface receives a new event for the event tag, the interface will read the PHD for all the event inputs associated with this event tag. A new event is defined as a snapshot event with time stamp greater than the existing snapshot time.

SourceTag

The source tag field contains the PI point for outputs. The format is:

tagname

where:

tagname is the name of a PI tag that provides the value for the output point. Use this feature to send values from Performance Equations or other interfaces to the PHD. If the OUTPUT PI point is its own source, then do not use the Source Tag field

For Outputs to the PHD, the Source tag and the Output tag should be the same point type and have the same zero and span. Warning messages are written if the SOURCE tag and the Output tag do not match. If the source for the output is different from the output tag, the output value sent is put in the output tag.

Scan

This is usually ON for all points for this interface. Edit the Point Attribute to OFF to make the interface Delete it from its lists of points. Change the SCAN back to ON when you want the point added back to the Interface. The digital state SCAN OFF is written to a point when its scan flag is turned OFF.

Location1

This is the node number. This node number must match that specified in PIPHD.bat. NodeNumber associates PI points with a particular interface.

Location2

|Direction of Data Transfer | |

|Input |1 |

|OutPut |2 |

|Output Time Stamp of Source Point to PHD |3 |

|Output Time Stamp of Source Point to PHD and a Normal Output. TimeTag Attribute must be set to a |4 |

|point.parameter specifying a PHD time parameter. TIM=point.parameter must be in the extended | |

|descriptor specifying a PHD time parameter | |

This is the direction of data transfer. Use 1 for inputs from the PHD and 2 for outputs to the PHD.

Use 3 to send the timestamp of the most recent PI value of the source tag to a string or time parameter. The time format is:

DD-MM-YY hh:mm:ss

Use 4 if you want to do a normal output and also send the time stamp to another PHD point at the same time. The TIM=Point.param for the time PHD point must be specified in the Extended Descriptor field.

NOTE: For interface to have the authority to send data to the PHD, the interface has to be started by a user in the PHD_PUTDATA group.

Location3

Location3 is used to indicate whether History Recovery should be done for the point.

4. 0 = no history recovery

5. 1 = perform history recovery

Location4

This is the Scan list number that corresponds to the scan frequency specified in the interface startup file. The interface sends and receives values for a list of PHD parameters in each message. You can control the grouping of parameters into lists by assigning Location4, which is the scan class, to a number from 1 to 256.

Scan classes are defined in the interface startup file. Each scan class defines an update period. This location code defines which scan class period is used to update the point lists. For example, if the following scan classes are specified in the interface startup command files as follows:

/f=00:00:05 /f=00:00:15 /f=00:01:00 /f=00:01:00,00:00:05

then,

ScanClass = 1 for frequency of 00:00:05 (5 seconds), ScanClass = 2 for a frequency of 00:00:15 (15 seconds) and ScanClass=3 for a frequency of 00:01:00 (1 minute) which will trigger on the minute, and ScanClass=4 for a frequency of 00:01:00 (1 minute) which will trigger 5 seconds after the minute.

Location 4 is ignored if using event based reads as described in the extended descriptor section.

Location5

Location5 is not used at this time.

In addition to the attributes listed above, the following point attributes (specified by PICONFIG keyword names) apply to the PHD points:

6. Tag

7. Descriptor

8. EngUnits

9. Zero

10. Span

11. Digital State Set

12. ExcMin

13. ExcMax

14. Archiving

15. Compressing

16. CompDev

17. CompMin

18. CompMax

History Recovery

The PI-PHD Interface retrieves data from PHD for points flagged for history recovery during the time when the interface has been down and no data was collected. Set location 3 to 1 for points that you want history recovery done. The history parameter, /hi=MAX, must also be passed in pi-phd.bat where MAX is the maximum time period that the interface will go back in time to retrieve history for. The time period must specify whether the period is in minutes, hours, or days as well as specify the number of those periods to go back. Some example time ranges are: 2d (two days), 24h (24 hours), 60m (sixty minutes). If no maximum time period is specified or the time period entered is invalid then the default of two days will be used.

History recovery will be started at interface startup or after a communication failure has occurred and is then resumed between PI and PHD. Data will be retrieved from the PHD starting from the last good value in the PI archive up to the current time, or the MAX recovery time specified in PI-PHD.bat. If good data is not found before the MAX recovery time, an I/O Timeout will be written to the point at the MAX time.

If the /hi parameter is not passed then no history recovery is done.

Time Stamps

The timestamps for the data comes from the PHD. The interface calculates the time difference between the PHD and the PI server every 1 minute. This offset is applied to the PHD time stamps prior to sending the data to PI.

With version 1.5 of the interface, the timestamp usage is configurable by adding a startup parameter in the pi-phd.bat file.

/ts=x

0 - default. Use PHD Timestamps and apply difference of PHD server time and PI Server time.

1 - Use PHD Timestamps without applying time difference. This is only done if PHD server time is behind PI server time. If PI server time is behind PHD server time, the timestamps will be adjusted to PI server time.

2 - Do not use PHD Timestamps. Send last value in each scan and use the PI server time.

Hardware and Software

Hardware Requirements for PI-PHD

The PI-PHD Interface is connected to a PHD system that must be at version 100 or higher. The PI-PHD Interface runs on the same NT as the PHD system. If an LCN is connected to the PHD system, the version of the LCN must be 520 or higher.

Software Requirements for PI-PHD

PHD Server and ‘C’ API from Honeywell.

Optional Manuals for PHD

A set of manuals in electronic format is available from Honeywell which may be of interest. These manuals are:

Totalplant Process History Database Electronic Documentation 100 rev 1 12 AUG 1997

The phd API is discussed in the PHD System Manual Document number PIM 030.1

Startup Command File

The PI-PHD interface requires several command-line arguments for successful execution. For convenience, the arguments are defined in a startup command file called pi-phd.bat. A sample pi-phd.bat file is included on the installation disks. The command line in the pi-phd.bat file must be on a single line and cannot exceed 1024 characters.

|Startup Command File Parameters and Syntax |

|/id=# |Defines a unique identifier (#) between 1 and 99 for each version of the interface|

| |that is running. The identifier corresponds to location1 of the PI tag |

| |definition. |

|/ps=x |Defines the point source x, where x can be any single character. A corresponding |

| |point source must be defined on the PI2 or PI3 home node. |

|/f=hh:mm:ss |Defines the time period in between scans in terms of hours (hh), minutes (mm), and|

| |seconds (ss). Several time periods can be defined on a single command line |

| |(however, one must be careful not to exceed the 255-character limit of the command|

| |line). Location4 determines which time period is used. |

|Home node on PI3: |Defines the node name, x, of the PI home node. |

|/host=x:5450 |Defaults: |

|Home node on PI2: |If the interface is installed on a PI3 home node: |

|/host=x:545 |/host=localhost:5450 |

|Defaults: |If the interface is installed on a client PC and the PI home node is a PI3 system:|

|see right |/host=servername:5450 |

| |where “servername” should be replaced with the name of the PI3 server. |

| |If the interface is installed on a client PC and the PI home node is a PI2 system:|

| |/host=servername:545 |

| |where “servername” should be replaced with the name of the PI2 server. |

| |5450 and 545 refer port numbers. If the pinetmgr process is configured to listen |

| |on a different port, change to the appropriate port number. |

|/ts=x |Optional - settings for what timestamp to use. |

| |0 - default. Use PHD Timestamps and apply difference of PHD server time and PI |

| |Server time. |

| |1 - Use PHD Timestamps without applying time difference. |

| |This is only done if PHD server time is behind PI server time. If PI server time |

| |is behind PHD server time, the timestamps will be adjusted to PI server time. |

| |2 - Do not use PHD Timestamps. Send last value in each scan and use the PI server|

| |time. |

|/hi=x |Flags the interface to do history recovery on startup. Pass the maximum time to |

| |go back. Ex: 2d for two days. |

|/q |When this flag is specified, data is queued on the NT system before it is |

| |transmitted to the PI home node. Data is sent less frequently but in larger |

| |packets. This flag is recommended. |

|/ec=x |The /ec flag is used to specify an IORate tag from the iorates.dat file. Example |

|default: none |entries from an iorates.dat file are given below: |

| |Tagname1, 1 |

| |Tagname2, 2 |

| |where tagname1 and tagname2 can be any legal tag name. The number after the tag |

| |name can be between 1 and 34 or between 51 and 200, inclusive. Numbers 35 to 50 |

| |are reserved for future use. If /ec=2 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 Tagname2. The rate that is sent to Tagname2 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. IORates for individual tags cannot be measured|

| |at this time. |

| |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. |

| |Although the interface will allow multiple instances of the /ec flag to be |

| |specified on the command line, the rate will only be nonzero for the first rate |

| |tag that is referenced. |

PI-PHD Interface Installation

NT-Intel Installation Disk File List

Dynamic-linked libraries need to be copied to the system32 directory only if they are not already present in the system32 directory or if the DLL’s in the user’s system32 directory are older than the DLL’s provided on the installation disk.

|PI-PHD.EXE |PI PI-PHD interface executable file |

|PI-PHD.BAT |Startup command file |

|MSVCIRT.DLL |Dynamic linked library. |

|MSVCRT.DLL |Dynamic linked library. |

|README.TXT |Instructions for installing the interface |

Installation Notes

The installation must be done on the same NT as the PHD system. This can either be a PI home node (the node where the PI Data Archive resides) or on a PI API node (a node which communicates to the PI home node across a network). The installation procedure assumes the following:

1. You are installing the interface on the C drive. If you are installing the interface on a different drive than your C: drive, substitute the appropriate drive name in the procedure below.

1. Your floppy drive is the B drive. If your floppy drive is not your B: drive, substitute the appropriate drive name in the procedure below.

1. You have met the appropriate hardware and software requirements described in the section entitled “Hardware and Software” above.

1. For a PI3 home node: The PI Firewall Database and the PI Proxy Database are configured so that the interface is allowed to write data to the PI Data Archive. See “Modifying the Firewall Database” and “Modifying the Proxy Database” in the Pi Data Archive Manual. If the interface cannot write data to the PI Data Archive owing to permission problems, an error –10401 will occur. Note that /host=localhost:5450 in the pi-phd.bat file corresponds to the loopback node 127.0.0.1, which is present by default in the Firewall and Proxy Databases.

1. For a PI2 home node: The client must be allowed write access to the PI2 Data Archive. Read and write access is controlled in PI2 with the pisysdat:piserver.dat file.

Bufserv Utility

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 PI-PHD 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 PI-PHD 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.

Installation Procedure

1. Create the following directory:

c:\PI\interfaces\pi-phd\

The user should create one directory for each version of the interface that he or she wishes to implement.

Note: The interface does not enforce the pi-phd naming convention for the executable file, the startup command file (batch file), or the directory. These can be given any legal name for the operating system. However, if the user wishes to run the interface manually and the user does not use the naming convention suggested in this manual, he or she will need to change the path to the executable on the command line in the batch file. Error messages in the pipc.log file will be prepended by piphd#>, independent of the name of the executable file, batch file, and directory.

2. Insert the installation disk, and execute the following commands from an MSDOS prompt:

copy b:\pi-phd.exe c:\PI\interfaces\pi-phd\pi-phd.exe

copy b:\pi-phd.bat c:\PI\interfaces\pi-phd\pi-phd.bat

3. If the dynamic linked libraries (.dll files) provided on the installation disk are not in your c:\winnt\system32 directory or if the dynamic linked libraries in your system directory are older than the libraries on the installation disk, copy the libraries from the installation disk to your system directory. Your system directory may be on a drive other than your C drive.

Remove the installation disk.

4. Modify the command-line arguments in your pi-phd.bat file to customize your interface. For example,

..\interfaces\pi-phd\pi-phd.exe /id=1 /q /ps=h

The command line must be on a single line and cannot exceed 1024 characters (1 kilobyte). This is a limitation set by the interface, not by the NT Operating system. The command-line arguments are discussed earlier in this manual. Next, complete steps 5 and 6 to start the interface as a service or complete steps 7 and 8 to start the interface manually (interactive mode). Manual startup is recommended the first time that the interface is started because manual startup is easier to troubleshoot.

To run as a service, complete steps 5 and 6:

NOTE: For the interface to have the authority to send data to the PHD, the interface has to be started by a user in the PHD_PUTDATA group.

The procedure for installing the PI-PHD interface as a service depends upon whether or not Bufserv is being used. Once the interface has been installed as a service, the procedure for starting, stopping, and removing the interface as a service is the same whether or not Bufserv is used.

5. One can get help for installing the interface a service at any time by typing the following:

pi-phd -help

Note that the –query flag that is described when help is invoked is not implemented at this time.

The pi-phd 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 pi-phd\ directory.

Without Bufserv:

pi-phd -install -depend tcpip

With Bufserv:

pi-phd -install -depend “tcpip bufserv”

To install the interface as an automatic service, execute the following command from the pi-phd\ directory.

Without Bufserv:

pi-phd -install –auto -depend tcpip

With Bufserv:

pi-phd -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 pi-phd service from an automatic service to a manual service or vice versa.

Once the pi-phd service has been installed, the rest of the procedure is the same whether or not Bufserv has been implemented. The pi-phd service can be started from the services control panel or by executing the following command from the pi-phd\ directory:

pi-phd -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 interface will attempt to read the command-line arguments from the pi-phd.bat file. For this to succeed, the root name (the part of the file name before the .exe and .bat extensions) of the batch file must be the same as the root name of the executable. Also, the batch file and the executable file must be in the same directory. If the interface is unable to read the command-line arguments or if the command-line arguments that the interface reads are invalid, the service will terminate with no error messages echoed to the screen.

For this reason, the user MUST check the pipc.log file to verify that the interface is running correctly. In the pipc.log file, messages pertaining to the PI-PHD interface will be prepended by Piphd#>. The location of the pipc.log file is determined by the PIHOME entry in the pipc.ini file. The pipc.ini file is located in the WINNT directory. Usually, the pipc.log file will reside in the c:\pipc\dat\ directory.

If the service was successfully started, the user can verify that the service is still running from the services control panel. If the service has been terminated, the reason for its termination will be given in the pipc.log file. If the service is still running, the user can use c:\PI\bin\apisnap.exe or ProcessBook to verify that data is being successfully transferred to the PI Data Archive.

The pi-phd service can be stopped at any time by issuing the following command:

pi-phd -stop

The pi-phd service can be removed by

pi-phd -remove

6. If the pi-phd service is installed as a manual service on the PI home node, the user may wish to edit the c:\PI\adm\pisrvsitestart.bat and the c:\PI\adm\pisrvsitestop.bat command files. These command files are invoked only when the PI data archive is started and stopped as a manual service with the c:\PI\adm\pisrvstart.bat and the c:\PI\adm\pisitestop.bat command files.

In the c:\PI\adm\pisrvsitestart.bat file, make sure that the second to last line ends in

& wait 5000

If not, append “& wait 5000” to the end of the line. In the same file, add the following command just above “:theend”

C:\PI\interfaces\pi-phd\pi-phd -start & wait 5000

Add the following command to the c:\PI\adm\pisrvsitestop.bat file just above “:theend”

C:\PI\interfaces\pi-phd\pi-phd -stop

Note that the full path name to the pi-phd executable must be given in both the c:\PI\adm\pisrvsitestart.bat and the c:\PI\adm\pisrvsitestop.bat command files.

To run in interactive mode, complete steps 7 and 8:

NOTE: For the interface to have the authority to send data to the PHD, the interface has to be started by a user in the PHD_PUTDATA group.

7. Execute the following command from an MSDOS prompt:

cd c:\PI\interfaces

start "pi-phd" pi-phd\pi-phd.bat

A new MSDOS window will appear, and the user will see several messages echoed to the screen. Then the messages will simply stop. The user will not regain a command prompt on the MSDOS window until the interface has been stopped. Typing CONTROL-C while the MSDOS window is selected stops the interface. The user can use c:\PI\bin\apisnap.exe or ProcessBook to verify that data is being successfully transferred to the PI Data Archive.

Check whether there are any error messages to verify successful execution of the interface. Messages that are sent to the screen are also sent to the pipc.log file. Check the pipc.log file. Some messages are written to this file that are not echoed to the screen when the interface is started up. Messages in the pipc.log file that pertain to the PI-PHD interface will be prepended by Piphd#>. The location of the pipc.log file is determined by the PIHOME entry in the pipc.ini file. The pipc.ini file is located in the WINNT directory. Usually, the pipc.log file will be placed in the c:\pipc\dat\ directory.

8. If you plan on starting both the PI Data Archive and the PI-PHD interface manually, you may wish to start the PI-PHD interface along with the PI Data Archive. To do this you must edit the c:\PI\adm\pisitestart.bat command file (there is no such thing as a c:\PI\adm\pisitestop.bat command file). Make sure that the last line of the c:\PI\adm\pisitestart.bat file ends in:

& wait 5000

If not, append “& wait 5000” to the end of the line. In the same file, add the following two commands:

echo Starting pi-phd Interface

start "pi-phd" /min ..\interfaces\pi-phd\pi-phd.bat & wait 5000

The pi-phd interface should now be started in interactive mode. The /min flag minimizes the MSDOS window that is created when the PI-PHD interface is executed.

PI-PHD Interface System Administration

Starting the PI-PHD interface

Automatic Service Startup

If the PI-PHD interface was configured as an automatic service in step 6 of the installation procedure, then the PI-PHD interface will automatically start after the NT system reboots. This configuration is useful in the event of a power failure.

Manual Service Startup

If the PI-PHD interface was configured as a manual service and the PI system was also configured as a manual service, then the PI-PHD interface can be started along with the PI System when the following command file is executed from the adm\ directory (assuming that step 6 of the installation procedure was completed):

pisrvstart.bat

If you wish to start a manual Piphdservice separately from the PI Data Archive, execute the following command from the pi-phd\ directory:

pi-phd -start

Interactive Startup

If both PI and the PI-PHD interface are started interactively, one can start both of them with the

pistart.bat

command file, assuming that step 8 of the installation procedure was completed.

Alternatively, one can start the interface independently of the PI Data Archive by typing the following command from the interfaces\ directory:

start "pi-phd" pi-phd\pi-phd.bat

Or one can issue the following command from the interfaces\ directory:

pi-phd\pi-phd.bat

When start “pi-phd”… command is used, a new MSDOS window is created.

Stopping the PI-PHD Interface

If the PI-PHD interface was configured as an automatic or a manual service in steps 5 and 6 of the installation procedure and if the PI system was also configured as an automatic or manual service, then the pi-phd service is stopped along with the PI system by executing the following command file from the adm\ directory:

pisrvstop.bat

This assumes that both steps 6 and/or 7 of the installation procedure have been completed.

Alternatively, one can stop the pi-phd service independently from stopping the PI system by executing the following command from the pi-phd\ directory:

pi-phd -stop

or one can stop the pi-phd service from the services control panel.

If the PI-PHD interface was started in interactive mode, one can stop the PI-PHD interface by 1) selecting the MSDOS window that corresponds to the pi-phd interface, and 2) holding down the control key while typing the letter c (note that there is no pisitestop.bat file to correspond to the pisitestart.bat file).

Registering the PI-PHD Interface as a Windows NT Service

Manual Services

From the pi-phd\ directory, execute the command.

Without Bufserv:

pi-phd -install -depend tcpip

With Bufserv:

pi-phd -install -depend “tcpip bufserv”

Check the services control panel to verify that the pi-phd service has been added. See the PI-API Bufserv 1.x Release Notes for the installation instructions for Bufserv.

Automatic Services

From the pi-phd\ directory, execute the command:

Without Bufserv:

pi-phd -install –auto -depend tcpip

With Bufserv:

pi-phd -install –auto -depend “tcpip bufserv”

Check the services control panel to verify that the pi-phd service has been added. See the PI-API Bufserv 1.x Release Notes for the installation instructions for Bufserv. The Piphd interface will now start automatically when the computer is rebooted.

Removing the PI-PHD Interface as a Windows NT Service

From the pi-phd\ directory, execute the command:

pi-phd -remove

Check the services control panel to verify that the pi-phd service has been removed.

Status, Warning, And Error Messages

Such messages will be written to the pipc.log file. This file should be checked to verify successful execution of the interface because not all error messages are echoed to the screen. The location of this file is determined by the PIHOME entry in the pipc.ini file, which is located in the WINNT directory (for more information, see the description of the subroutine pilg_putlog in the PI Application Programming Interface manual). For example, if the PIHOME entry is c:\PIPC, then the pipc.log file will be located in the c:\PIPC\dat directory.

IORates

The total rate (events per minute) that the PI-PHD interface sends data to the Snapshot can be measured. The interface calculates a 10 minutes average (i.e. it counts the total number of snapshot events over a 10-minute period and then divides by 10 minutes). IORates for individual tags cannot be measured at this time.

For instructions regarding implementation of IORates, see the description of the /ec flag of the startup command file under the section entitled “Startup Command File.”

Revision History

|Date |Author |Comments |

|28-Apr-97 |MMG |preliminary document |

|21-May-97 |MMG |updated preliminary document |

|5-Jun-97 |MMG |updated preliminary document |

|11-Jun-97 |MMG |updated preliminary document |

|17-oct-97 |MMG |update preliminary document |

|7-nov-97 |MMG |added install and startup requirements |

|23-Jan-98 |MMG |Change name to pi-phd |

|27-Jan-98 |MMG |Added note for sending data to PHD |

|17-Jul-98 |MMG |Change to reflect what is in version 1.1 of interface |

|23-Oct-98 |MMG |Change to reflect what is in version 1.3 of interface. History |

| | |recovery, and timestamps. |

|9-Apr-99 |MMG |Add software requirements |

|3-Aug-99 |MMG |Correct Hardware requirements. LCN not required. |

|1-Nov-99 |MMG |1.5.x version of interface. Added new startup parameter. /ts= |

|27-Jan-00 |MMG |Fix typo from PHD_PTDATA to PHD_PUTDATA |

................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download