Uniformance System Monitor Real-Time Data Interface: Installation Guide R300
Uniformance System Monitor Real-Time Data Interface: Installation Guide R300
Uniformance System Monitor Real-Time Data Interface: Installation Guide R300
Release Information
Uniformance 300 Document Revision 1 Document Revision Date: January, 2010 Document ID: rdi4201.pdf
Honeywell Process Solutions 860 W. Rose Garden Ln Phoenix, Arizona 85027-2708 USA
WWW.HONEYWELL.COM/PS
Contact:
Mail:
Honeywell Solution Support Center Phone: 1-800 822-7673. Calls are answered by dispatcher between 6:00 A.M. and 4:00 P.M. Mountain Standard Time. Emergency calls outside normal working hours are received by an answering service and returned within one hour. Honeywell HPS TAC, MS L17 1860 W Rose Garden Ln Phoenix, Arizona 85027-2708 Honeywell TAC-EMEA +32-2-728-2732 +32-2-728-2696 TAC-BE02 Hermes Plaza Hermeslaan, 1H B-1831 Diegem, Belgium
Europe
Pacific
Contact: Phone:
Honeywell Global TAC Pacific 1300-300-4822 (toll free within Australia) +61-8-9362-9559 (outside Australia) Facsimile: +61-8-9362-9564 Mail: Honeywell Limited Australia 5 Kitchener Way Burswood 6100, Western Australia Email: [email protected]
India
Email:
Honeywell Global TAC India +91-20- 66039400 +91-20- 66039800 Honeywell Automation India Ltd. 56 and 57, Hadapsar Industrial Estate Hadapsar, Pune 411 013, India [email protected]
Korea
Contact: Phone:
Honeywell Global TAC Korea +82-2-799-6317 +82-11-9227-6324 Facsimile: +82-2-792-9015 Mail: Honeywell Co., Ltd 4F, Sangam IT Tower B4-4 Block 1590, DMC Sangam-dong, Mapo-gu, Seoul, 121-836, Korea Email: [email protected]
Peoples Republic of China
Email:
Singapore
Honeywell Global TAC China +86- 21-52574568 Honeywell (China) Co., Ltd 33/F, Tower A, City Center, 100 Zunyi Rd. Shanghai 200051, Peoples Republic of China [email protected]
Contact: Global TAC South East Asia Phone: +65-6580-3500 Facsimile: +65-6580-3501 +65-6445-3033 Mail: Honeywell Private Limited Honeywell Building 17, Changi Business Park Central 1 Singapore 486073 Email: [email protected]
Taiwan
Email:
Japan
Global TAC Taiwan +886- 7- 536 2567 +886-7-536 2039 Honeywell Taiwan Ltd. 17F-1, No. 260, Jhongshan 2nd Road. Cianjhen District Kaohsiung, Taiwan, ROC [email protected] Global TAC Japan +81-3-6730-7160 +81-3-6730-7228 Honeywell Japan Inc. New Pier Takeshiba, South Tower Building, 20th Floor, 1-16-1 Kaigan, Minato-ku, Tokyo 105-0022, Japan [email protected]
Email:
Elsewhere
Contents
1. INTRODUCTIONTOTHEUNIFORMANCESYSTEMMONITORRDI........................................................................ 9 1.1. 1.2. 1.3. 1.4. 1.5. 1.6. 2. RDIDESCRIPTION ....................................................................................................................................................9 TAGCAPACITYLIMITATIONS .......................................................................................................................................9 CONCURRENTINTERFACELIMITATIONS ......................................................................................................................... 9 DATATHROUGHPUTANDCONSTRAINTS ....................................................................................................................... 9 REQUIREDSUPPORTFILES ..........................................................................................................................................9 REQUIREDHARDWAREANDSOFTWARE ........................................................................................................................ 9
INSTALLATIONOFTHEUSMRDI ...................................................................................................................... 11 2.1. INSTALLATIONCHECKLIST .........................................................................................................................................11 2.2. TODEFINESOURCESYSTEMTAGATTRIBUTESANDDATATYPES ......................................................................................12 2.3. TOCOMPLETETHERDIPARAMETERCONFIGURATIONFORM .........................................................................................13 2.4. TOCOMPLETETHEINTERFACES(RDIS&LINKS)FORM .................................................................................................14 2.5. SECUREUSERCREDENTIALS ......................................................................................................................................15 2.6. RDISPARTICIPATINGINANRDCSCHEME....................................................................................................................17 2.7. TOINCREASEMAXIMUMTAGS(PHDPARAMS.DAT)......................................................................................................18 2.8. TORUNRDISETUP.................................................................................................................................................19 2.9. INTERFACES_CUSTOMCONFIG.DAT ...........................................................................................................................21 2.10. TODEFINEANDSTARTRDISONARUNNINGPHDSYSTEM ............................................................................................22 2.11. MODIFYINGREGISTRYSETTINGS ...............................................................................................................................23 ToSetthePolledModeStampingOption ..................................................................................................................23 ToSettheRDIStartupOption ....................................................................................................................................23 ToPreventDuplicateBadTagMessages ...................................................................................................................26
3.
CONFIGURATIONOFPHDTAGS....................................................................................................................... 27 3.1. 3.2. 3.3. OVERVIEW ............................................................................................................................................................27 TAGFIELDUSAGE ..................................................................................................................................................27 TAGCONFIGURATIONPROCEDURE ............................................................................................................................27
4.
Contents
1.1.
RDI Description
The Uniformance System Monitor (USM) RDI reads Monitor Item values and Condition Item states from Uniformance System Monitor agent and stores the values in PHD. It executes in the exception mode resulting in only changed values being stored. Since USM does not hold history this RDI does not have any history recovery mechanism.
1.2.
1.3.
1.4.
1.5.
1.6.
1 Introduction to the Uniformance System Monitor RDI 1.6 Required Hardware and Software
2.1.
Installation Checklist
Task Go to 9 Notes
1. Enter Configuration Data In the PHD Configuration Tool, modify the Tag Source Configuration form, if necessary. In the PHD Configuration Tool, complete the RDI Parameter Configuration form, if necessary In the PHD Configuration Tool, complete the Interfaces (RDIs & Links) form. (Optional) In the PHD Configuration Tool, configure additional copies of the Interfaces (RDIs & Links) form if the RDI is to participate in a Robust Data Collection scheme. (Optional) In the PHD Configuration Tool, complete the RDC Configuration form if the RDI is to participate in a Robust Data Collection scheme. This guide section To Define Source System Tag Attributes and Data Types If parameters to be historized by PHD are not specified in the standard list (such as userdefined parameters), then you must add them to this form. No modifications to this form are required.
This guide section To Complete the RDI Parameter Configuration Form This guide section To Complete the Interfaces (RDIs & Links) Form Robust Data Collection User Guide (pim350)
To support RDC, two or three copies of each RDI must be configured, depending on the RDC mode of the RDI.
Port numbers must be assigned to each RDI that is to participate in an RDC scheme.
2. Verify PHD System Configuration Modify the PhdParams.Dat file, if necessary, to ensure that tags to be built against the new RDI will not exceed the specified maximum. This guide section To Increase Maximum Tags (PhdParams.Dat) MAX_TAGS and MAX_TAGNO
3. Create RDI Run RDISetup to save the configuration. This guide section To Run RDISetup Start>Programs> Uniformance> PHD Server> PHD RDI Configuration
2 Installation of the USM RDI 2.2 To Define Source System Tag Attributes and Data Types
In a running PHD system, use PHDMAN to define and start the RDI. 4. Modify Registry Settings (Optional) If appropriate, add the NewPolledModeStamping parameter to the registry for the new RDI. (Optional) If appropriate, add the RDIDependency parameter to the registry for the new RDI. (Optional) If appropriate, add the PreventBadTagMessages parameter to the registry for the new RDI. 5. Configure PHD Tags In PHD Configuration Tool, configure PHD tags.
This guide section To Define and Start RDIs on a Running PHD System
Enable this option if you want the RDI to defer its next scan if it falls behind, instead of starting it immediately after the current scan. Enable this option if you want to startup RDIs in dependency order. Enable this option if you want only one record for a tag's bad value to be output to the PHD_EVENT.log.
This guide section To Set the RDI Startup Option This guide section To Prevent Duplicate Bad Tag Messages
2.2.
1 2 3 4
REFERENCE: For definitions of the PHD data types, refer to PHD System Manual (PIM-0301), section Understanding the Tag Source Definitions.
2 Installation of the USM RDI 2.3 To Complete the RDI Parameter Configuration Form
2.3.
1 2 3 4 5
2 Installation of the USM RDI 2.4 To Complete the Interfaces (RDIs & Links) Form
2.4.
1 2 3 4
*Description Enabled *RDI Type Name *Remote RDI Type Name Source System Parameter Name DEBUGLEVEL
Field NOINITTAG
Description /I disables the insertion of a 0 value with a -1 confidence when the RDI is started, shutdown, or every 24 hours when the RDI resynchronizes its time with the USM Agent. Default is disabled. Hostname or IP address of the machine running the USM Agent. Defaults to localhost. The USM Agent port number to connect to the remote PHD server. The default port number if not specified is 41000. The Windows username to use to connect to the USM Agent with. For security reasons this parameter should not be used and the user credentials should be entered via the Uniformance System Console. Refer to the section Secure user credentials
PASSWORD
The password for the Windows user account used to authenticate the connection from the USM RDI to the USM Agent.
2.5.
Then right click on the RDI in the right hand window which lists all the RDIs defined for this RDI Server. Select Properties from the context menu and then select the Interface User Account tab.
Click the Run As User Account to display the Specify User Account window.
Enter the user name, password, and confirm the password that should be used. Once entered the Validate button can now be clicked to verify the details entered are correct. This may not be possible if the USM Agent is in an untrusted domain or behind a firewall. Click Ok to save the details and return to the Interface User Account tab. Click the Store User Credentials Only check box to store the details instead of having the RDI be set to run as the specific user. Finally click the Apply or Ok buttons to save the details.
2.6.
2.7.
1 2
3 4
Save the file. If you modified the above parameters, then you need to Stop and Cold Start the PHD Server in order to resize its global memory sections. To restart the PHD Server, execute the following commands at a command prompt: PHDCTL STOP PHDCTL START COLD
2.8.
To Run RDISetup
Perform the following steps to run the RDISetup utility, which creates the files for a particular RDI. REFERENCE: For more information about how RDISetup works, refer to the Basic RDI Installation Guide (in0701). Attention: Perform the following steps on the PHD Server machine on which the RDI is to run. Attention: Do NOT delete "127.0.0.1 localhost" from the Hosts file. This entry (which is created when Windows is installed) is used by PHD functions. If it is deleted, PHD will not function properly. Prerequisite: Log on to the operating system as a user that is member of the Product Administrators group. Tip: If you change local rights, you must logon again to establish the change.
Step Action Make a backup copy of the following files located at <install directory> \PHDServer\NtSite\: Interfaces.Dat Start_Interfaces.Dat.
If new RDIs have been previously created in error, for each RDI execute the following at a Command prompt: PHDMAN SHUT INT <rdiname> TIP When you run RDISetup, the utility may attempt to copy new dlls for every interface (RDI or Link) configured for this node. If you choose to leave any existing interfaces running on this node, then when RDISetup attempts to copy the dll for a running interface, the copy fails and an error message is output.
On the PHD Server where the RDI is to run, open the RDISetup utility: Start>Programs>Uniformance>PHD Server>PHD RDI Configuration
In the left pane, select the RDI of interest. RESULT: The RDI parameters appear in the right pane, as shown in the following screen example.
5 6 7
Verify/modify the values of the items listed in Table 3, as needed. To run RDISetup, select File and choose Save RDI/Link Configuration. Verify that RDISetup accomplished the following for the new RDI:
Rewrote the Interfaces.Dat file to add commands that define the new RDI. Rewrote the Start_Interfaces.Dat file to add commands for starting the new
RDI.
It may have copied the DLL for the interface type as RDI<rdiname>.DLL to the
RDI directory. This will NOT occur for those RDIs distributed with the PHD Server.
Step
8 9
Verify that the Interfaces.Dat and the Start_Interfaces.Dat files contain the appropriate parameters. Verify that the registry reflects the correct RDI parameters entered through the Interfaces (RDIs & Links) form. Registry location: HKLM \ SYSTEM \ CurrentControlSet \ Services \ <RDIServer> \ Parameters \ RDIList \ <rdiname>
RDIServer Port
MIN_HISTRECMN
Both 1
For normal RDIs (D) This is the maximum recoverable history duration (minutes).
This parameter
Sets this For RDC RDIs Refer to the previous table for MIN_HISTRECMN.
XSCANSECS
(D) - Exception interface scan wait interval (scan interval in exception mode). The real-time system will be queried for values at this interval (seconds). (D) - Use remote real-time system clock for timestamps. (D) - Synchronize scan intervals/offset with remote clock. (D) - Offset in seconds for scan cycle. Typically, the user changes the OFFSET parameter if the purpose of the new RDI is to achieve better load leveling. Attention: To minimize overlap, offset the scan cycles relative to each other by setting the OFFSET parameters to different prime numbers. REFERENCE: For guidelines on using the OFFSET parameter, refer to the PHD System Manual (pim0301), section RDI Configuration Guidelines to Prevent Data Loss.
Note: The above parameters are dynamic (D) and therefore can be changed while the PHD Server is running; however, you may have to restart the RDI for the changes to affect the RDI. So, if you changed the parameters for an existing, running RDI, you may have to restart it to implement the change.
2.9.
Interfaces_CustomConfig.Dat
For some RDIs, it may be necessary to add set commands to the Interfaces_CustomConfig.Dat file to set the value of certain parameters that cannot be entered into the database or the RDISetup utility. The format of the command is as follows: SET <rdiname>:<parametername> <value> Prior to PHD 210, RDC commands were required to be in the Interfaces_CustomConfig.Dat file PHD 210 and greater do not have this requirement. For PHD 210 and greater, if the user configures the RDC Configuration form through the PHD Configuration Tool, then the RDISetup utility will place RDC commands in the Interfaces.Dat file. If present, Interfaces_CustomConfig.Dat is executed automatically upon system startup, after automatic execution of Interfaces.Dat. You may execute the file manually through PHDMAN. REFERENCE: For additional information on setting RDI parameters, refer to the section "Set Interface Parameters." in the PHDMAN User Guide (pim0221).
2 Installation of the USM RDI 2.10 To Define and Start RDIs on a Running PHD System
Note: Performing a system startup of a PHD System causes the above files to be executed automatically.
Step Action On the PHD Server, open a command prompt and change directories to the <install directory>PHDServer\NtSite, and then enter the following command: PHDMAN EXECUTE Interfaces.Dat Note: Alternatively, you can use the PHDMAN shortcut on the desktop, which defaults to the path of the NtSite directory.
Verify that the new RDI is now available: PHDMAN SHO INT
Enter the following command to set any RDI modifications you entered into the Interfaces_CustomConfig.Dat file, if any: PHDMAN EXECUTE Interfaces_CustomConfig.Dat
Enter one of the following commands to start the new RDI: To start all non-running RDIs - PHDMAN EXECUTE Start_Interfaces.Dat OR To start a single RDI - PHDMAN STA INT <RDI Name>
Disabled (0) - Default. If the RDI detects that the current scan has fallen behind, it still schedules the next scan immediately after the current scan is complete (PHD R150 behavior). Enabled (1) - If the RDI detects that the current scan has fallen behind, it defers polling until the next scheduled scan cycle. An overloaded source system may experience reduced loading with this setting, but will also experience skipped scans.
If needed, perform the following steps to add/enable the parameter in the registry:
Step Action At the Run command, open the registry editor: regedit Go to the following registry location: HKLM \ SYSTEM \ CurrentControlSet \ Services \ <RDIServer> \ Parameters \ RDIList \ <rdiname> Add a new DWORD parameter:
1 2 3
a)
Right-click>New>DWORD Value.
a)
Right-click NewPolledModeStamping>Modify.
To Set the RDI Startup Option A registry entry (RDIDependency) can be added to enable the option that starts RDIs in dependency order. When a request is made to start all RDIs (Start Int *), the startup of any RDI can be delayed until other RDIs, upon which it is dependent, are started. For each RDI, you can specify one or more RDIs on which it is dependent. Tag Routing is an example of an RDI function for which RDI startup dependency may be a concern.
If needed, perform the following steps to add/configure the parameter in the registry:
Step Action At the Run command, open the registry editor: regedt32 Go to the following registry location: HKLM \ SYSTEM \ CurrentControlSet \ Services \ <RDIServer> \ Parameters \ RDIList\<rdiname> Use one of the following procedures, depending on the operating system, to add a new multiple string value: Windows 2003:
1 2 3
a)
d) On separate lines, enter the name of each RDI upon which this RDI
e)
Click OK.
Windows 2000:
a)
Step
Action
d) Click OK. e)
On separate lines, enter the name of each RDI upon which this RDI is dependent.
f) 4
Click OK.
To Prevent Duplicate Bad Tag Messages On PHD 210 and greater, you can configure the registry parameter 'PreventBadTagMessages' for each RDI to prevent logging of duplicate bad value messages in the PHD_EVENT.log. The possible values are:
Disabled (0) - Default. Allows duplicate log records for a tag with bad values. Enabled (1) - Only the first occurrence of a bad value for each tag is logged. This is reset when a good value is received for the tag.
Multiple bad value errors may occur upon restart, following an outage where every tag value is bad. This option is useful to prevent the log from filling up with the same errors. If needed, perform the following steps to add/enable the parameter in the registry:
Step Action At the Run command, open the registry editor: regedit Go to the following registry location: HKLM \ SYSTEM \ CurrentControlSet \ Services \ <RDIServer> \ Parameters \ RDIList \ <rdiname> Add a new DWORD parameter:
1 2 3
a)
Right-click>New>DWORD Value.
a)
Right-click PreventBadTagMessages>Modify.
3.1.
Overview
Uniformance System Monitor RDI tags are defined in much the same way as normal collected tags. All USM items are handled as double values.
3.2.
For retrieving values from a USM Agent, the only tag field used for specifying data is the Source Tag Specification (src_tagname) field. This field contains either the Monitor Item name or the Condition Item Name. For Monitor Items prefix the name with M: and for Condition Items use the prefix C:. Note: if no prefix is specified then it is assumed that a Monitor Item is being specified. Example Source Tag Names M:CommittedBytes C:HighCPUUsage
Scan Frequency
Refers to a Monitor Item called CommittedBytes Refers to a Condition Item called HighCPUUsage
Since the RDI executes in exception mode the scan frequency is used simply to set the tags data queue size based on the expectation of the number times the values is expected to change. REFERENCE: For additional information on the Tag Configuration form, refer to the Process History Database User Guide (pim0201).
3.3.
Step
Action Click the Tags button on the tool bar. Refer to following sections for details.
Verify that the new RDI collects tag values by entering the following command at a command prompt or through the PHDMAN shortcut on the desktop. PHDMAN MON QUE <Tag name>
4. Troubleshoot RDI
4.1.
Common Problems
In most cases, the following problems may occur:
The interface startup parameters from PHD are incorrectly defined (Interfaces (RDIs & Links) form). The interface has not been defined to PHD or is incorrectly defined. Hosts file on PHD Server is not correct:
Attempting to start an RDI when the RDI Server is not running will result in the RDI being stuck in the Init/Inactive state. If this occurs, it is necessary to restart the RDI Server, and then Kill the RDI before issuing the Start command again.
4.2.
Problem Diagnosis
In many cases, looking at the RDI log file (<rdiname>.OUT ) can be very useful. The log file gives information about the following:
Initialization of tags, poll groups, and errors during these actions Outgoing and incoming data packages
For further problem diagnosis, refer to the PHD system log files mainly, the PHD event log (PHD_EVENT.LOG). REFERENCE: For a description of all PHD logs, see Process History Database Installation Guide (in6001).
Troubleshooting Steps Troubleshooting interface problems usually involves the following steps:
1. Verify interface activity via the PHDMAN MONITOR INTERFACE command.
If the interface has not started correctly, check RDI output file in the Log Files directory. If the interface has aborted, check the event log file PHD_EVENT.LOG. Also check the output file to which the RDI was directed in the registry settings.
2. Check for problem tags with the PHDMAN REPORT CONFIDENCE command. 3. Data queues for tags may be displayed via the PHDMAN MONITOR QUEUE
command. .
4. Check the PHD Event Log for any error logs indicating problems for the interface
or interface tags.
Glossary
History Recovery
The retrieval of data from a source system by the RDI for the period of time during which the RDI was unable to collect data directly from the source system. The recovered data will eliminate the data gaps that result from non-collection of data.
RDI
PHD Real-time Data Interface. One or more RDIs are used for each type of DCS, PLC, SCADA, and other real-time source of data that is included in PHD.
Source System
The source system is the system that provides the real-time data to the PHD systems. This can be another PHD system, or a DCS system.
Tag
A distinct value residing in the source system and collected by an RDI.
Glossary
Index
Command Line Prefix, 13 duplicate log records, 26 DWORD parameter, 26 encrypted format, 15 Interface platform, 9 Operating system, 9 PHD Configuration Tool, 21 PHD RDI Configuration, 11 Port numbers, 11 RDIs participating in an RDC scheme, 17 Secure user credentials, 15 single or dual buffer system, 17 Tag Source Configuration form, 11 Troubleshooting interface problems, 29 Uniformance System Monitor (USM), 9 user credentials, 15
Honeywell International Process Solutions 1860 W Rose Garden Ln Phoenix, AZ 85027-2708 USA