PI IntFix 2.0.1+

Intellution Fix DMACS (FIX32) / Dynamics (iFIX) Interface to the PI System
ersion 2!"!# or $reater
OSI Software, Inc.
How to Contact Us
Phone Fax Internet World Wide Web Bulletin Board (510) 297-5800 (510) 297-5828 (510) 357-8136 techsupport@osisoft.com http !!""".osisoft.com (510) 895-9#23 $elebit %orl&'la(er mo&em ()a*es+ ,-.+ or ./. compatible) 8 &ata bits+ 1 stop bit+ no parit*+ up to 1##00 bps &o"nloa& protocols 0mo&em+ 1mo&em+ 2mo&em+ 3ermit 456 5oft"are+ 6nc. ..4. 'o7 727 5an 8ean&ro+ 9: 9#577-0#27 ;5: 456 5oft"are <mb) )auptstrae 30 =-6367# :ltensta&t 1 =eutschlan& 456 5oft"are+ 8t& .. 4. 'o7 8256 8e>el 4ne+ 6-8 -u?ent 5treet :uc@lan& 3+ -e" 2ealan& (main number) (technical support)
Mail
;npublishe& -- ri?hts reser>e& un&er the cop*ri?ht la"s of the ;nite& 5tates. A/5$A69$/= A6<)$5 8/</-= ;se+ &uplication+ or &isclosure b* the <o>ernment is subBect to restrictions as set forth in subpara?raph (c)(1)(ii) of the Ai?hts in $echnical =ata an& 9omputer 5oft"are clause at =C:A5 252.227-7013 $ra&emar@ statementD.6 is a re?istere& tra&emar@ of 456 5oft"are+ 6nc. ,icrosoft %in&o"s+ ,icrosoft %in&o"s for %or@?roups+ an& ,icrosoft -$ are re?istere& tra&emar@s of ,icrosoft 9orporation. 5olaris is a re?istere& tra&emar@ of 5un ,icros*stems. ).-;0 is a re?istere& tra&emar@ of )e"lett .ac@ar& 9orp.. 6', :60 A5!6000 is a re?istere& tra&emar@ of the 6', 9orporation. =;0+ =/9 E:0 an& =/9 :lpha are re?istere& tra&emar@s of the =i?ital /Fuipment 9orporation. 20#107752.&oc
1997 456 5oft"are+ 6nc. :ll ri?hts reser>e& 777 =a>is 5treet+ 5uite 250+ 5an 8ean&ro+ 9: 9#577
10!15!200# 03 10 00 .,
ii
able of Contents
)o" to 9ontact ;s..................................................................................................................ii $able of 9ontents................................................................................................................... 3 4>er>ie"................................................................................................................................ 6 5upporte& =ata $*pes........................................................................................................ 7 .6 .oint =efinition................................................................................................................... 8 C60 $a? :&&ress Cormat.....................................................................................................8 <eneral .6 $a? 9onfi?uration 6nformation...........................................................................8 .oint5ource..................................................................................................................... 8 .oint$*pe......................................................................................................................... 8 8ocation1......................................................................................................................... 8 8ocation2......................................................................................................................... 8 8ocation#......................................................................................................................... 9 6nstrument$a?................................................................................................................ 10 5can.............................................................................................................................. 12 5ource$a?..................................................................................................................... 12 /7=esc.......................................................................................................................... 12 6nput $a? 9onfi?uration.....................................................................................................13 .erformance an& /=: ;sa?e.......................................................................................13 4utput $a? 9onfi?uration..................................................................................................1# :&&itional .62 9onfi?uration..............................................................................................1# .oint 5ource..................................................................................................................1# =i?ital 5tate 9o&e..........................................................................................................15 )ar&"are an& 5oft"are .......................................................................................................16 6nterface 5oft"are AeFuirements......................................................................................16 6nterface )ar&"are AeFuirements.....................................................................................16 5tartup 9omman& Cile.......................................................................................................... 17 C60 =,:95 6nterface 6nstallation ........................................................................................22 -$-6ntel 6nstallation =is@ Cile 8ist......................................................................................22 =is@ Cile 8ist.................................................................................................................. 22 6nstallation .roce&ure........................................................................................................22 $o run as a ser>ice........................................................................................................23
10!15!200# 03 10 00 .,
6ntellution Ci7 =,:95 6nterface =ocumentation $o run in interacti>e mo&e.............................................................................................25 $o 6nstall =ebu? 5*mbols..............................................................................................25 C60 =,:95 6nterface 5*stem :&ministration.......................................................................27 5tartin? the C60 =,:95 6nterface.....................................................................................27 :utomatic 5er>ice 5tartup.............................................................................................27 ,anual 5er>ice 5tartup.................................................................................................27 6nteracti>e 5tartup..........................................................................................................27 5toppin? the C60 =,:95 6nterface...................................................................................27 5tatus+ %arnin?+ an& /rror ,essa?es..............................................................................28 64Aates................................................................................................................................. 29 C60 Ae&un&anc* an& .i-e&a.................................................................................................30 C6032 Eie" -o&e.............................................................................................................. 30 C6032 .rimar* 59:=: -o&e.............................................................................................32 C6032 'ac@up 59:=: -o&e.............................................................................................33 C6032 Eie" -o&eGs -et"or@ 5tatus =ispla*......................................................................3# C6032 -o&e H"inntHs*stem32H&ri>ersHetc )ost Cile............................................................3# .6 $a? 9onfi?uration for C6032 $a?..................................................................................3# iC60 Eie" -o&e.................................................................................................................. 3# iC60 .rimar* 59:=: -o&e................................................................................................35 iC60 'ac@up 59:=: -o&e................................................................................................37 iC60 -et"or@ 5tatus Ae&un&anc* =ispla*.........................................................................37 iC60 -o&e H"inntHs*stem32H&ri>ersHetc )ost Cile...............................................................38 .6 $a? 9onfi?uration for iC60 $a?......................................................................................38 :ppen&i7 : 9ommunication /rror Aeco>er*.........................................................................39 :ppen&i7 ' $roubleshootin?.................................................................................................#0 CreFuentl* :s@e& Iuestions.............................................................................................#0 ,ore ,essa?es 8o??e& to pipc.lo? Cile an& /7planations...............................................#5 J9omplete& re-processin? ta?sJ........................................................................................#5 K/=: error LMN occurre& &urin? function 0000 on C60 -$C L0+ 1+ 2NO...........................#5 J$est fiel& for ta? $ is 2. 6nterface abortin?J......................................................................#5 J8ocal host 000 restore& at &a*-month-*ear hour min secon& J......................................#6 J-o C60 fiel& t*pe specifie& for .6 ta? 0J...........................................................................#6 J-o C60 ta? name specifie& for .6 ta? 0J..........................................................................#6 J-o con>ersion is supplie& for floatJ..................................................................................#6 J/=: =i?ital t*pe ta?s are confi?ure& in .6 as .6 &i?ital t*pesJ.........................................#6
456 5oft"are+ 6nc.
J/=: ,ultistate =i?ital t*pe ta?s are confi?ure& in .6 as .6 &i?ital t*pesJ........................#6 J/=: (:)lphanumeric fiel& is &efine&+ but the .6 fiel& is not Pstrin?PJ.................................#7 JCiel& t*pe L2N not supporte&J..........................................................................................#7 J-o ta? confi?uration specifie& for L$NJ............................................................................#7 J9oul& not retrie>e local host name. 6nterface aborte&J....................................................#7 J6nterface runnin? on local C60 no&e ----J.....................................................................#7 J9oul& not create /=: ?roup for scanclass MQJ.................................................................#7 J9oul& not create /=: ?roup for e>ent-ta? $ tri??ere& ta?sQJ..........................................#7 J9reate& ?roup for scanclass MJ........................................................................................#7 J9reate& ?roup for e>ent-ta? $ tri??ere& ta?sJ.................................................................#8 J/&ite& ta? $ coul& not be a&&e&J.....................................................................................#8 J9omplete -4=/ $:< C6/8= information una>ailable for .6 ta? $J................................#8 JCatal /rror on tree manipulationJ.....................................................................................#8 J/=: Caile& to a&& ta? R-+ $+ CS to the ?roupJ..................................................................#8 JAemo>e& ta? R-+ $+ CSJ....................................................................................................#8 J;nreco?ni(e& state L7777N in (,ultistate) =i?ital ta? R-+ $+ CSJ.......................................#8 J;n@no"n &ata t*pe for ta? R-+ $+ CSJ................................................................................#9 J9onnection "ith no&e - reestablishe&J...........................................................................50 J;nsupporte& t*pe for C60 ta? R-+ $+ CSJ............................................................................50 J=ri>er shut&o"nJ..............................................................................................................50 Cor C60 /=: /rrors+ consult 6ntellution /=: manual.....................................................50 :ppen&i7 9 ,essa?e 8o??in?..............................................................................................51 8o??in? 9onfi?uration.......................................................................................................51 :ppen&i7 = C60 to .6 9onfi?uration $ransfer ;tilit*.............................................................53 4>er>ie"........................................................................................................................... 53 ;ser 6nstructions................................................................................................................55
10!15!200# 03 10 00 .,
6ntellution Ci7 =,:95 6nterface =ocumentation
O!er!iew
This is a description of the Intellution FIX DMACS (FIX32) / Dyna ics (iFIX) interface to the !I Syste for "indo#s $T% In addition to ha&in' the pre&iously e(istin' functionalities this &ersion of the interface allo#s the user to collect the data placed on an alar /e&ent )ueue *y FIX #ith su*second ti esta ps% This enhanced &ersion can *e run on one of the follo#in'+ An $T !I3 Ser&er An $T !I A!I node #ith net#or, access to a !I2 or !I3 Ser&er The interface requires that the Intellution FIX MMI software version 6.x (or FIX32 version 7.0) or later or FIX !na"ics #MI$%&' ' version (.0 or later (or iFIX version 2.() )e *resent on the sa"e +& as the interface. %&' ' su**ort ,oes not nee, to )e ena)le, in or,er for this interface to run. That is- this interface can )e run on a FIX .iew no,e. /ote0 !re&iously se&eral custo ers ha&e *een una*le to run the interface on &ersion -%.2 of FIX% "ith &ersion .%/ and later the interface runs #ith FIX -%.2 as #ell% For i portant infor ation re'ardin' runnin' this interface #ith FIX Dyna ics0 see release notes% 1p to FIX Dyna ics .%2 and FIX DMACS -%.30 a FIX Dyna ics SCADA node and a FIX DMACS SCADA node do not tal, to each other% FIX32 &ersion /%2 node0 ho#e&er0 can *e seen *y iFIX &ersion 2%. node and &ice &ersa% FIX32 &ersion -%.3 and FIX Dyna es &ersion 2%2 introduced auto atic failo&er functionality% !i4eda runnin' on a 5ie# node (and 5ie# node only 6 see the section on 7edundancy in this anual) can ta,e ad&anta'e of this functionality to continuously collect data fro partner SCADA nodes if the acti&e one *eco es una&aila*le% See the section on FIX 7edundancy in this anual% /ote0 This interface requires +I '+I version at least (.3.2 (see release notes). For proper interface operation0 confi'ure input points (input ta's) and/or output points (output ta's) on a !I2 or !I3 ho e node (the #ords 8point8 and 8ta'8 are used interchan'ea*ly in this anual)% Input ta's are used to recei&e data fro FIX nodes0 either local or re ote% A sin'le interface can collect data fro one or ore FIX nodes at a ti e% Data are recei&ed either at a 'i&en fre)uency or after a &alue that is sent to a 'i&en 8tri''erta'8 passes e(ception% These ta's #ill *e referred to as the e&ent4tri''ered ta's in this anual% 9utput ta's are used to send co ands to FIX% A co and is sent to FIX after a &alue that is sent to a 8SourceTa'8 passes e(ception or after a &alue that is sent to the output ta' itself passes e(ception0 dependin' on the confi'uration of the output ta'% All &alues that are #ritten to the snapshot or archi&e use the syste ti e fro the !I ho e node% In addition0 this interface is a*le to fetch data fro the user )ueue #here FIX SAC places alar and e&ent essa'es% The points for #hich data are collected this #ay #ill *e referred to as the e&ent4 essa'e ta's in this interface anual% The event-message tags MUST be configured as alarm- and/or event message-enabled in FIX database % It is reco ended that separate instances of this interface *e run for strictly scan4*ased data collection and e&ent4 essa'e collection in order to ta,e full ad&anta'e of e&ent4 essa'in' feature of this interface% This #ill *e discussed further in :eneral !I Ta' Confi'uration
456 5oft"are+ 6nc.
section% ;ither "1S;7<.%e(e or "1S;7<2%e(e (please see FIX anual for details) ust *e runnin' in order for this feature to #or,% These e(ecuta*les #ill onitor alar s/e&ents fro alar areas and a,e the a&aila*le to our interface% /ote0 12%345( an, 12%3452 cannot "onitor alar" areas na"e, other than '6+. This interface was ,esi7ne, to use 12%345( or 12%3452- an, therefore will not wor8 if the alar" areas are na"e, other than '6+. This will )e fixe, in future release. At startup0 the interface scans the !I !oint Data*ase for all associated points and *uilds its o#n point list% Durin' runti e0 the interface continues to chec, the !I !oint Data*ase for point updates and odifies its point list accordin'ly% If the Scan field of any point on the point list is set to off0 the point is re o&ed fro the point list% The point is added once a'ain after the Scan field is turned *ac, on% If neither a fi(ed scanrate nor a &alid tri''erta' are found for a 'i&en point0 the point #ill *e re o&ed fro 0 or #ill not *e added to the point list% This applies to e&ent4 essa'e ta's also 4 specifically0 they ust *e in scan class .% See :eneral !I Ta' Confi'uration section%
Su""orted #ata $"es

The FIX DMACS interface pro&ides support for analo'0 di'ital0 and strin' &alues fro FIX% Di'ital &alues in FIX are stored as strin's% The interface con&erts the strin's to a nu erical state correspondin' to the position of the strin' #ithin the FIX setup% For di'ital points0 the &alues returned to !I #ill *e either . or 2% For ulti4state di'ital points0 the &alues returned to !I #ill *e fro 2 to /% Values for all FIX tags that are alarm and/or event-message enabled can be collected via this interface, provided that the belong to scan class ! and event message flag "/#M$ is set in the startup command file% Mappin' a FIX float to a !I di'ital is also supported in &ersions .%=%3 or 'reater% That is0 if a point is defined as a float in FIX (field is F>C5) *ut is confi'ured as a di'ital in !I0 &alues read as float is typecast to inte'er and this inte'er is sent as di'ital offset in !I% For e(a ple0 &alue 2 #ill *e apped to the first di'ital state in the di'ital set associated #ith the ta'0 and &alue . #ill *e apped to the second di'ital state0 and so on% Fi(topi utility #ill con&ert FIX float types to !I float32 *y default % It is the user&s responsibilit to modif the script file generated b fi'topi "fi'topi%scr$ to change the pointt pe to digital if mapping is desired % For ore infor ation on fi(topi utility see Appendi( D% /ote+ FIX analo' &alues can *e stored as !I inte'ers0 ho#e&er there is a ris8 of a si7nificant loss of precision due to the truncation of analo' data into an inte'er &alue%
10!15!200# 03 10 00 .,
PI Point #efinition
FI% a& 'ddress For(at
The FIX DMACS interface uses a 8node-tag-field 8 (NTF) identifier to reference a specific point in FIX% The node references the FIX node on #hich the ta' resides% Tag references the actual ta' #ithin the specified node0 and field deter ines #hich of the ta'?s attri*utes to reference%
)eneral PI a& Confi&uration Infor(ation

9ne !I point (!I ta') ust *e confi'ured for each FIX field the user #ants to read fro #rite to% The points can *e confi'ured on a !I2 or !I3 ho e node% or
The follo#in' descri*es the field na es associated #ith !I point confi'uration that ha&e specific eanin' for use #ith the FIX DMACS interface% 9ther fields ay also need to *e specified for proper confi'uration of the !I point% So e of these fields include point na e (ta' na e)0 typical &alue0 en'ineerin' units0 resolution code (!I2 only)0 filter code0 etc% The user ay #ish to create I/9 7ate Ta's for each interface% For ore infor ation on !I !oint confi'uration see the Data Archi&e (DA) section of the PI System Manual (for !I2 ho e nodes) or the PI Data Archive Manual for Windows NT and NI! (for !I3 ho e nodes)% The field na es in the ta*le *elo# are consistent #ith the field na es in the Data Archi&e Manual for !I3% !lease refer to the Appendi( re'ardin' use of the Fi"ToPI transfer utility to facilitate in the creation of !I points%
PointSource
All points to *e used *y the FIX DMACS interface ust share a co on point source (for e(a ple0 M)% For a !I2 ho e node0 one ust edit the point source ta*le to include this !ointSource (choose 8point source8 fro the !I2 Syste ain enu)% See 8Additional confi'uration for !I28 *elo#% For !I30 the only re)uire ent is to confi'ure the ta' #ith the sa e !ointSource that is defined in the PI-EDA#.bat startup co and file%
Point $"e
The interface supports all three !I point types for !I20 i%e%0 real 40 inte'er I0 and Discrete and Float(60 Float320 Int(60 Int32 and iscrete point types for !I3% The interface also supports the !I %trin7 point type%
*ocation+
This para eter is used to specify the interface nu *er0 #hich corresponds to the /id=# fla' in the PI-EDA#.bat file% 5alid interface nu *ers are inte'er &alues 2 to =@0 inclusi&e%
*ocation,
This para eter identifies the I/9 type for the ta'% If the ta' is an output ta'0 this para eter ust *e set to .% A 2 Input ta' A . 9utput ta'
456 5oft"are+ 6nc.
In&alid Bocation2 &alues #ill cause the ta' not to *e added to the scan list% Co#e&er0 the interface #ill add other &alid ta's to the list and continue to run%
*ocationThis field deter ines the fre)uency at #hich an input ta' is scanned% The field is i'nored for output ta's (I/9 type .)% The field is also i'nored for input ta's (I/9 type 2) if a 8tri''erta'8 is specified in the e(tended descriptor% Dy specifyin' a tri''erta'0 the associated input ta' is scanned after an 8e&ent8 instead of *ein' scanned at the fre)uency specified in BocationE% See the section entitled 8Input Ta' Confi'uration8 for essential details on input ta's and tri''erta's% To *e safe0 set BocationE to 2 for e&ent4*ased input ta's or for output ta's% The possi*le scannin' fre)uencies for a 'i&en interface are specified *y the user on the co and line in the PI-EDA#.bat file (see the section entitled 8Startup Co and File8)% For e(a ple0if part of the co and line is as follo#s+ /f=00:00:05 /f=00:00:15 /f=00:01:00,00:00:10 /f=00:00:0.05,0 Then0 the point can *e confi'ured to scan FI! e&ery 3 seconds0 e&ery .3 seconds0 or e&ery . inute% For the 34second and .3 second periods0 scannin' #ill *e'in on the hour or at a ultiple of 3 or .3 seconds after the hour% For the .4 inute period0 scannin' #ill *e'in .2 seconds after the hour or at a ultiple of . inute and .2 seconds after the hour% If BocationE is . for the a*o&e co and line0 then the point #ill *e scanned e&ery 3 seconds% If BocationE is 20 then the point #ill *e scanned e&ery .3 seconds0 and so on% The last scanclass sho#s the for at for su*second scan fre)uency% /ote0 The hi'hest scan resolution a&aila*le in FIX is 2%23 seconds as of FIX32 &erison /%2 and iFIX &ersion 2%.% !i4eda has a*out the sa e resolution #ith *ufferin' on% 1ser should #atch C!1 usa'e on the node pi4eda is installed on% Dependin' on ho# loaded the C!1 is0 this perfor ance can i pro&e or de'rade% The a*solute li it on resolution is 2%2. second%
I"*ortant notes for event6"essa7e ta7s+

For all event-message tags, (ocation) value MUST be ! % It does not atter #hat that fre)uency is as lon' as the e&ent4 essa'e ta's are confi'ured so that they all *elon' to scan fre)uency class . (BocationE A .)% This confi'uration in co *ination #ith /;M s#itch in the startup co and file is used to let the interface ,no# that these ta's are to recei&e &alues fro the alra /e&ent4 essa'e )ueue instead of FIX data*ase #hich the interface polls at pre4specified inter&als% If /#M s*itch is set and the tags that have (ocation) value e+ual to ! are not alarm/event-message enabled in FIX, the *ill receive ,- data through this interface% It is the user.s responsibilit to configure these tags correctl *ithin FIX database% It is strongl recommended to run separate instances of the interface for scan-based tags and event-message based tags% Althou'h this interface is capa*le of doin' *oth types of data collection0 if the interface has to spend ti e scannin' at fi(ed inter&als0 it cannot ta,e full ad&anta'e of the e&ent4 essa'in' feature% This interface is a 1niInt (9SI interface standard) *ased interface and fetches e&ent essa'es fro the )ueue #hile the interface is not scannin' (durin' so4called Fin*et#een scan ti esG)% Doth collection ethods? perfor ances #ill *e co pro ised if the list of each is lon'% /ue to the current UniInt limitation, scan-based tags cannot be scanned at subsecond intervals% 0o*ever, event-message tags receive sub-second timestamps upto the current FIX subsecond scanning resolution% The sub-second timestamp resolution for event-message tags in 1I is onl as good as that of FIX.s S23, rate% That is0 if FIX can only send alar s to the )ueue e&ery 2%23
10!15!200# 03 10 00 .,

seconds0 that is the hi'hest resolution that the !I ta's #ill 'et% For the latest infor ation on the hi'hest resolution a&aila*le0 please contact Intellution TechSupport%
Instru(ent a&
This field is used to specify the $TF address for FI!% $TF stands for $ode4Ta'4Field0 and is used to address a specific ta' #ithin FI!% ;ach entry in the $TF ust *e separated #ith a co a0 #ith no spaces *et#een the co as and te(t% F9&. (F for float) is the only Field that is specified for analo' FIX points (for other supported analo' Fields see the ne(t para'raph)% <ualifyin' FIX float4&alued *loc,s are con&erted to !I float ta's *y our utility FixTo+I and are assi'ned this Field% For *loc, types that are auto atically con&erted (#ithout re)uirin' anual inter&ention *y the user)0 see the section on Fi(To!I at the end of this anual% 9ther *loc, types that result in float &alue are also supported *y this interface0 *ut they need to *e anually confi'ured in !I% This attri*ute is also specified in the Instru entTa' field for the !I ta'% If FIX $TF A LocalNode,TagX, !"# the Instru entTa' field for a !I ta' #ould contain+ LocalNode,TagX, !"# /ote0 The Analo' Alar types in FIX are supported *y this interface *y confi'urin' the as one of the follo#in' three !I data types+ di'ital (t#o states only)0 ulti4state di'ital or strin's (if the ser&er is !I3)% For di'ital and ulti4state di'ital FIX points0 the Field specified in FIX is '9&. for *oth types of di'ital points (' for alphanu eric)% Co#e&er0 #hen confi'urin' !I ta's for FI! di'ital and ulti4state di'ital points0 the field na e ust *e odified fro the FI! for at% For di'ital ta's0 the field ust al#ays start #ith > and for ulti4state ta's0 the field na e ust start #ith M4. This is an interface4specific re)uire ent0 and no odification of the FI! data*ase is re)uired% The follo#in' e(a ple sho#s the contents of the Instru entTa' field for a di'ital ta' #hose FIX $TF A LocalNode,TagX,A!"# The Instru entTa' field for a !I ta' #ould contain+ LocalNode,TagX,D!"# The follo#in' e(a ple sho#s the contents of the Instru entTa' field for a ta' #hose FIX $TF A LocalNode,TagX,A!"# The Instru entTa' field for a !I ta' #ould contain+ LocalNode,TagX,$!"# ulti4state di'ital
10
456 5oft"are+ 6nc.
It should *e e phasiHed that the interface does support strin' &alues as strin' &alues% If re)uired *y the user0 the !I point in this case could *e confi'ured as a strin' ta' and the $TF could *e put in the Instru ent ta' as+ LocalNode,TagX,A!"# and the current &alue as an AS#II string #ill *e stored in !I% Si ilarly0 each field in the ;DA data*ase has an associated field na e% The nu eric fields ha&e *oth a 8A>8 and a 8F>8 type fieldna e associated #ith the 0 #hereas the fields #hich store alphanu eric data (such as Ta' $a e) has an 8A>8 type fieldna e associated #ith it% If desired0 a !I Ta' can *e confi'ured as a strin' ta'0 and the infor ation in this field could *e sent to !I &ia this interface% For e(a ple0 D;SC field can *e confi'ured as a !I strin' ta' *y settin' the field in instru ent ta' as A>D;SC% 9r0 if the field CICI (for CICI alar li it) is to *e o*tained as a !I ta'0 a !I ta' can *e confi'ured as a float32 point type #ith field &alue e)ual to F>CICI% Co#e&er0 ost infor ation in the data*ase other than the current &alue (8F>C5 and/or A>C5) is static0 i%e% it does not chan'e o&er a lon' period of ti e% Therefore0 )ueryin' the ;DA data*ase for &alues other than the current &alue #ould *e0 for ost users0 a #aste of ti e% If the Instru entTa' field is specified on a !I3 ho e node #ith the piconfi' utility0 then the Instru entTa' field should *e encased #ithin dou*le )uotes (8 8)% This is re)uired *ecause !IConfi'0 *y default0 uses a co a as a deli iter% In those rare cases where the 32 characters of the Instru"entTa7 will not suffice to contain the entire /TF- the /o,e na"e or the Fiel, na"e or )oth can )e *lace, in the +I 3xten,e, escri*tor fiel, (3x esc). If the full $TF is specified in the instru ent ta'0 then the interface does $9T chec, the ;(Desc field for additional infor ation 4 the interface already has all the infor ation re)uired% 1tiliHin' the ;(Desc for this purpose eans the Instru entTa' field #ill contain t#o or e&en one of the desi'nators 4 the others #ill *e in the ;(Desc% If the $TF entry in the Instru entTa' is not co plete0 the ;(Desc #ill *e chec,ed% 4e"e")er that the Ta7 na"e M2%T )e in the Instru"entTa7 fiel,. This can *e the Ta' na e *y itself0 or the node na e ay *e prepended #ith a co a *et#een the t#o0 or the Field na e ay *e appended #ith a co a separatin' the t#o% The ;(Desc #ill pro&ide the issin' field% /ote0 If the instru ent ta' contains t#o fields separated *y a co a and *oth the $ode na e and Field na e are pro&ided in the ;(Desc0 the interface uses *oth the Field $a e and the $ode $a e fro the ;(Desc% In this case0 it assu es that the first field in the Instru entTa' is the Ta' $a e% If this is not the case0 then an error #ill occur #hen the ta' is accessed%
'nother I"*ortant /ote0 If the ta' is of type float in FIX *ut is confi'ured as a di'ital ta' in !I0 the instru entta' attri*ute in !I should contain LocalNode,TagX, !"# rather than LocalNode,TagX,D!"#% In that case FIX float is apped to !I di'ital type *y sendin' the
10!15!200# 03 10 00 .,
11

float &alue typecast to inte'er as the offset to the di'ital set that the ta' is associated #ith in !I% That is0 if FIX 'enerates 20 .0 20 30 E that is read in the F>C5 field0 user can define this ta' in !I as a di'ital ta' #ith 3 di'ital states% 5alue 2 #ill *e apped to the first di'ital state in the correspondin' di'ital set and &alue . #ill *e apped to the second di'ital state0 and so on% Fi(topi utility #ill con&ert FIX float types to !I float32 *y default% It is the userIs responsi*ility to odify the script file 'enerated *y fi(topi (fi(topi%scr) to chan'e the pointtype to di'ital if appin' is desired% Summar of FIX tag to 1I tag conversion+ Delo#0 JJJJ represents the FI;BD na e in FIX for the &alue you are interested in% For #hate&er field &alue in FIX to *e con&erted to a !I type+ .) If it is represented as a te(t strin' (e(cept for di'ital state)0 it should ha&e A>JJJJ for FI;BD in !I Instru entTa' field and !I type defined as Strin'% 2) If it is represented as a di'ital state (24state) in FIX then FI;BDAD>JJJJ and !I type is defined as Di'ital% 3) If it is represented as a di'ital state ( ulti4state) in FIX then FI;BDAM>JJJJ and !I type is defined as Di'ital% E) If it is represented as an inte'er out of finite nu *er of &alues (that is0 it is a ta' #hose &alue is an inte'er in FIX *ut is to *e apped to a di'ital state in !I) in FIX then FI;BDAF>JJJJ and !I point type is di'ital% 3) If it is represented as a float in FIX then FI;BDAF>JJJJ and !I point type is float32% /ote0 For any FIX data type to *e con&erted to a di'ital state in !I0 a di'ital set containin' the di'ital state ust ha&e *een defined !7I97 to the ta' definition itself%
Scan
The Scan field is used *y the interface to deter ine #hether or not the ta' is to *e scanned% This allo#s the user to turn a ta' on or off #hile the interface is on4line%
Source a&
A SourceTa' can *e used in conKunction #ith an output ta'% An output ta' is a ta' for #hich the I/9 type has *een set to . Bocation3% See the section entitled 89utput Ta' Confi'uration8 for essential details on output ta's and SourceTa's%
.x#esc
The e(tended descriptor (;(Desc) can *e used to specify a 8tri''erta'8 (for input ta's only) and is specified *y the follo#in' synta( in the e(tended descriptor+ e%e&t=t'igge'tag Dy specifyin' a tri''erta'0 the associated input ta' is scanned after an 8e&ent8 instead of *ein' scanned at the fre)uency specified in BocationE% See the section entitled 8Input Ta' Confi'uration8 for essential details on input ta's and tri''erta's% The e(tended descriptor can also *e used to offload co ponents fro the $TF contained in the Instru entTa' ()%&%)% To add either a node na e or a field na e to the e(tended
12
456 5oft"are+ 6nc.
descriptor0 these fields are la*eled as in the tri''erta' a*o&e% To add the node na e to the e(tended descriptor0 the synta( is+ /: 3;no,ena"e To add the field na e to the e(tended descriptor0 the synta( is+ FI3< ;fiel,na"e !lease note0 that all three (e&entA0 nodeA0 and fieldA) can *e in the e(tended descriptor at the sa e ti e% A se icolon (L) is utiliHed as a separator *et#een the node na e and the field na e% If the user desires the ta' to *e tri''ered *y a chan'e in ta' XXXX0 and also #ishes to include a node na e of MMMM and a field na e of F>C50 the synta( is+ 3.3/T;XXXX-/: 3;====>FI3< ;F9&. 3.3/T;XXXX-/: 3;====-FI3< ;F9&. /: 3;====>3.3/T;XXXX-FI3< ;F9&. FI3< ;F9&.>/: 3;====-3.3/T;XXXX ;ither a se icolon (NL?) or a co a (N0?) can *e used as the deli iter to indicate the end of $9D; na e and FI;BD na e% Co#e&er0 a co a (N0?) "ust *e used to indicate the end of ;5;$T ta'% For an i portant essa'e re'ardin' the perfor ance of the interface for e&ent4tri''ered ta's see Performance and $DA sage *elo# under In%ut Tag #onfiguration % or or or
In"ut a& Confi&uration

Input ta's are used to recei&e data fro IX nodes% A ta' is an input ta' if a 2 is specified in Bocation2% 5alues are re)uested fro IX at a 'i&en fre)uency or after an 8e&ent08 dependin' on the confi'uration of the input ta'% &onfi7uration (+5alues are re)uested fro IX and sent to an input ta' at a 'i&en fre)uency% This fre)uency is specified in BocationE% Confi'uration . is ena*led if no 8tri''erta'8 is specified the input ta'?s e(tended descriptor% &onfi7uration 20 5alues are re)uested fro IX and sent to an input ta' after an e&ent is detected for a 8tri''erta'%8 The tri''erta' is specified in the input ta'?s e(tended descriptor% An e&ent occurs #hene&er a &alue reaches the snapshot of the tri''erta'% For *oth confi'uration . and confi'uration 20 ?' input ta' if a co unication error occurs% I/+2T (di'ital state 233) is sent to the
Perfor(ance and .#' Usa&e

The interface uses the standard FIX ;DA li*rary for co unication to local and re ote FIX nodes% The interfaces also use the concept of grou%s of points to lo'ically or'aniHe points%
10!15!200# 03 10 00 .,
13

The interface defines one ;DA 'roup for e&ery scan class defined #hen the interface is started% A separate 'roup for output ta's is also created% To a(i iHe perfor ance0 ta's on different nodes should not *e included in the sa e 'roup% This ay re)uire that se&eral scan classes #ith the sa e inter&al *e defined% Dy ,eepin' all ta's for indi&idual nodes #ithin the sa e 'roup0 ;DA does not ha&e to poll ultiple nodes in order to read &alues for a specific 'roup% Also0 note that e&ent4tri''ered ta's ta,e uch lon'er to process since a separate 'roup needs to *e defined for each e&ent ta'0 #hich is less efficient than scannin' ultiple ta's 'rouped to'ether% For e&ent4 essa'e ta's0 'roups are not created%
Out"ut a& Confi&uration

9utput ta's are used to send co ands to FIX% A ta' is an output ta' if a . is specified in Bocation2% Co ands are sent to FIX only upon an e&ent% An e&ent is tri''ered in one of t#o #ays0 dependin' upon the confi'uration of the output ta'% &onfi7uration (0(4eco""en,e,)0 In this confi'uration0 a co and is #ritten to FIX #hen an e&ent is detected for a SourceTa'% A SourceTa' is associated #ith an output ta' throu'h the output ta'?s SourceTa' field (see the section entitled 8!I !oint Definition8 a*o&e)% The &alue of the SourceTa' is #ritten to the output ta' if the co and is successful% The output ta' and the SourceTa' should *e 'i&en the sa e e(ception specifications (;(cDe&0 ;(cMin0 and ;(cMa()% 9ther#ise0 &alues that appear in the snapshot of the SourceTa' ay not appear in the snapshot of the output ta'% The !ointType of the output ta' and the SourceTa' do not need to *e the sa e0 *ut data loss could result fro differences in precision for different !ointTypes% &onfi7uration 20 In this confi'uration0 a co and is #ritten to FIX #hen an e&ent is detected for the output ta' itself% This confi'uration is ena*led if no SourceTa' is defined in the output ta'?s SourceTa' field% 1hen ,o @events@ occurA An e&ent occurrs #hene&er a &alue reaches the snapshot of the SourceTa' (confi'uration .) or the output ta' (confi'uration 2)% The actual &alue of the snapshot does not need to chan'e to tri''er an e&ent% For e(a ple0 say the current &alue in the snapshot of a SourceTa' ta' is 3.0 and say that e(ception testin' is turned on for the SourceTa'% ;&en if the &alue of the SourceTa' does not chan'e0 the e(ception a(i u ti e for the SourceTa' #ill e&entually *e e(ceeded% "hen this happens0 a &alue of 3. #ill *e sent to the snapshot of the SourceTa'0 tri''erin' an e&ent that #ill cause a co and to *e sent to FIX%
'dditional PI, Confi&uration

Point Source
9n !I 2 syste s0 the point source ran'e is specified *y selectin' the !ointSrc option on the !I Menu0 choosin' a *lan, field fro the point source list0 and enterin' the follo#in' location para eter li its% After the li its ha&e *een defined0 you #ill *e pro pted to define the point source for the point source list% Location 1 0 98 Location 2 0 1 Location 3 -20000000 2000000 Location 4 1 256 Location 5 -20000000 2000000
1#
456 5oft"are+ 6nc.
#i&ital State Code

For !I 2 syste s only0 chec, that the follo#in' codes are defined in the Di'ital States Ta*le (the states are already present in !I 3)+ Digital Code 237 238 239 246 251 252 255 299 State Digital String Bad Output Scan Off Scan On I/O Timeout Unde !an"e O#e !an"e Bad Input In#a$id %ata State
10!15!200# 03 10 00 .,
15
Hardware and Software

Interface Software /e0uire(ents
The !C ust *e runnin' the "indo#s $T4Intel operatin' syste % In order for the interface to run0 the !C ust *e confi'ured #ith the a*ility to connect to FIX on the local or re ote !C% That is0 FIX SCADA and/or 5I;" node support ust *e a&aila*le on the interface node% The eda.dll and fi(tool).dll ust also *e installed (this is nor ally done durin' the installation of FIX)%
Interface Hardware /e0uire(ents

$o hard#are is re)uired *eyond the !C and suita*le net#or, hard#are for access to re ote FIX nodes%
16
456 5oft"are+ 6nc.
Startu" Co((and File

The FIX DMACS interface re)uires se&eral co and4line ar'u ents for successful e(ecution% For con&enience0 the ar'u ents are defined in a startup co and file called PI-EDA#.bat% A sa ple PI-EDA#.bat file is included on the installation dis,s% The co and line in the PI-EDA#.bat file ust *e on a sin'le line and cannot e(ceed the 233 character li it% Startup Command File Parameters and Syntax /id=# %efine& a uni'ue identifie (#) *et+een 0 and 98 fo eac, #e &ion of t,e inte face t,at i& unnin"- T,e identifie co e&pond& to .ocation1 of t,e /I ta" definition%efine& t,e point &ou ce (0 +,e e ( can *e an1 &in"$e c,a acte - 2 co e&pondin" point &ou ce mu&t *e defined on t,e /I2 o /I3 ,ome node%efine& t,e time pe iod in *et+een &can& in te m& of ,ou & ( ++)0 minute& (,,)0 and &econd& ()))- Se#e a$ time pe iod& can *e defined on a &in"$e command $ine (,o+e#e 0 one mu&t *e ca efu$ not to e3ceed t,e 255-c,a acte $imit of t,e command $ine)- .ocation4 dete mine& +,ic, time pe iod i& u&ed%efine& t,e node name0 (0 of t,e /I ,ome node- %efau$t& a e5 If t,e inte face i& in&ta$$ed on a /I3 ,ome node5 /+o)t=local+o)t:5-50 If t,e inte face i& in&ta$$ed on a c$ient /6 and t,e /I ,ome node i& a /I3 &1&tem5 /+o)t=)e'%e'&a,e:5-50 +,e e 7&e #e name7 &,ou$d *e ep$aced +it, t,e name of t,e /I3 &e #e If t,e inte face i& in&ta$$ed on a c$ient /6 and t,e /I ,ome node i& a /I2 &1&tem5 /+o)t=)e'%e'&a,e:5-5 +,e e 7&e #e name7 &,ou$d *e ep$aced +it, t,e name of t,e /I2 &e #e 5450 and 545 efe po t num*e & 8,en t,i& f$a" i& &pecified0 data i& 'ueued on t,e 9T &1&tem *efo e it i& t an&mitted to t,e /I ,ome node- %ata i& &ent $e&& f e'uent$1 *ut in $a "e pac:et&- T,i& f$a" i& ecommended8,en t,i& f$a" i& &pecified0 $oca$ &1&tem time at,e t,an /I &e #e time i& u&ed fo /I time&tamp&- This option must be used with caution since the interface node clock should not be ahead of PI server node clock as PI ignores future data. 2$&o0 at t,e time of t,e inte face &,utdo+n0 /I Se #e time&tamp +i$$ *e a&&i"ned to a$$ ta"&- T,i& &+itc, &,ou$d on$1 *e u&ed if t,e e i& a compe$$in" ea&on to do &o-
/*)=(
/f=++:,,:))
4ome node on /I35 /+o)t=(:5-50 4ome node on /I25 /+o)t=(:5-5 %efau$t&5 &ee i",t
/.
/L/
10!15!200# 03 10 00 .,
17

Startup Command File Parameters and Syntax /ec=( defau$t5 none T,e /ec f$a" i& u&ed to &pecif1 an IO!ate ta" f om t,e io'ate).dat fi$e- ;3amp$e ent ie& f om an io'ate).dat fi$e a e "i#en *e$o+5 Ta"name101 Ta"name20 2 8,e e ta"name1 and ta"name2 can *e an1 $e"a$ ta" name- T,e num*e afte t,e ta" name can *e *et+een 1 and 33 o *et+een 51 and 2000 inc$u&i#e- 9um*e & 34 to 50 a e e&e #ed fo futu e u&e- If /ec=2 i& u&ed on t,e command $ine fo t,e a*o#e io'ate).dat fi$e0 t,en t,e ate (e#ent& pe minute) at +,ic, data i& &ent to t,e &nap&,ot +i$$ *e &to ed in Ta"name2- T,e ate t,at i& &ent to Ta"name2 i& a 10-minute a#e a"e (i-e- t,e tota$ num*e of e#ent& co$$ected *1 t,e inte face di#ided *1 10 minute&)- T,e efo e t,e IO!ate +i$$ appea to *e <e o fo t,e fi &t 10 minute& of inte face ope ation- IO!ate& fo indi#idua$ ta"& cannot *e mea&u ed at t,i& timeT,e io'ate).dat fi$e mu&t *e c eated *1 ,and- T,e fi$e &,ou$d *e p$aced in t,e dat0 di ecto 1- T,e dat0 di ecto 1 i& $ocated in t,e di ecto 1 de&i"nated *1 t,e /I4O=; ent 1 in t,e *i*c.i&i fi$e9o ma$$1 t,e /I4O=; ent 1 point& to t,e c:0PIP"0 di ecto 1 &o t,at t,e io'ate).dat fi$e +i$$ e&ide in t,e c:0PIP"0dat0 di ecto 1Once t,e io'ate).dat fi$e i& c eated0 t,e inte face mu&t *e &topped and e&ta ted *efo e t,e inte face *e"in& mea&u in" t,e IO!ate2$t,ou", t,e inte face +i$$ a$$o+ mu$tip$e in&tance& of t,e /ec f$a" to *e &pecified on t,e command $ine0 t,e ate +i$$ on$1 *e non<e o fo t,e fi &t ate ta" t,at i& efe enced/)to*)tat defau$t5 none One can &pecif1 /)to*)tat = dig)tate0 +,e e dig)tate i& a &1&tem di"ita$ &tate t,at +i$$ *e + itten to a$$ input ta"& upon &,utdo+n>o inte face& t,at a e un inte acti#e$10 t,e enti e a "ument mu&t *e enca&ed +it,in 'uote& +,en t,e e i& a &pace in t,e di"ita$ &tate- >o e3amp$e0 /)to*)tat=1ad I&*2t +i$$ +o : fo an inte face t,at i& un inte acti#e$1- T,i& ne+ featu e +a& ena*$ed due to t,e ne+ #e &ion of UniInt (OSI inte face &tanda d)Unfo tunate$10 /)to*)tat=1ad I&*2t +i$$ not +o : +,en t,e inte face i& un a& a &e #ice *ecau&e UniInt +i$$ inte p et t,e a "ument a& t+o &epa ate a "ument&0 t,e fi &t *ein" /)to*)tat=1ad and t,e &econd *ein" I&*2t- T,i& +i$$ *e co ected in t,e ne3t e$ea&ed #e &ion of UniInt (fo cu ent #e &ion &ee /I-;%2 e$ea&e note&)Specif1in" /)to*)tat on t,e command $ine *1 it&e$f +i$$ &ti$$ cau&e IO Timeout to *e + itten to a$$ input point& upon &,utdo+n/3=& Optiona$- %efau$t i& 120 (2 minute&)T,i& &pecifie& ,o+ man1 &econd& t,e inte face +ait& fo t,e >I? &oft+a e to come up comp$ete$1 &ince t,e initia$ &ta tup *efo e $oadin" ta"&-
18
456 5oft"are+ 6nc.
Startup Command File Parameters and Syntax /e, defau$t5 none T,i& &pecifie& co$$ectin" e#ent& f om t,e a$a m/e#ent 'ueue fo ta"& in &can c$a&& 1- >I? S26 p$ace& t,e a$a m& and/o e#ent me&&a"e& on t,e 'ueue0 if t,e a$a m condition& (&ee Inte$$ution >I? 2$a m and =e&&a"in" =anua$) a e met- T,e e&o$ution of t,e e#ent me&&a"in" i& t,e &ame a& t,e S629 time in >I?T,i& &pecifie& +,ic, 'ueue &,ou$d *e u&ed fo a$a m&/e#ent me&&a"e&- If /em i& &et0 defau$t of 1 i& u&ed- T,e num*e mu&t *e eit,e 1 o 20 and t,e co e&pondin" u&e 'ueue (ta&:& 8u&e '1-e3e o 8u&e '2-e3e) mu&t *e &ta ted in >I?8,en $aunc,in" 8u&e '1-e3e and/o 8u&e '2-e3e in i>I?0 one mu&t &pecif1 (#ia command $ine pa amete &) +,ic, a$a m a ea o a ea& t,e 'ueue i& to monito fo e#ent&- /$ea&e &ee Inte$$ution >i3 manua$- 9ote t,at if t,e a$a m a ea& a e named ot,e t,an 2-/0 t,e&e 'ueuemonito in" e3ecuta*$e&0 and t,e efo e pi-eda a$&o0 +i$$ not +o :- T,i& +i$$ *e fi3ed in futu e e$ea&e-
/.&=& defau$t51
10!15!200# 03 10 00 .,
19

Startup Command File Parameters and Syntax /c=&&&:** defau$t5 none T,i& pa amete &pecifie& t,e *e"innin" po&ition of t,e ta"@& #a$ue in it& a$a m me&&a"e fo mat- See fi"u e *e$o+- T,i& dia$o"ue *o3 +i$$ appea +,en =e&&a"e >o mat *utton i& c$ic:ed in S6U/2$a m menu- T,i& info mation i& nece&&a 1 +,en /e, &+itc, i& &et in o de to a$$o+ diffe ent data t1pe& to *e fetc,ed f om t,e 'ueue- To confi"u e t,e num*e & co ect$10 add t,e num*e & in t,e .en"t, *o3e& t,at a e not " a1ed out0 up to and not inc$udin" t,e Aa$ue co$umn- 2dd additiona$ 1 (fo &pace *et+een co$umn&0 +,ic, >I? add& automatica$$1) fo eac, co$umn *efo e Aa$ue co$umn- T,at i&0 if Aa$ue i& in t,e 5 t, co$umn a& *e$o+ (t,i& co e&pond& to t,e 6o$umn O de on t,e i",t)0 add 4 to t,e &um of co$umn $en"t,&- >o t,e fo mat &,o+n *e$o+0 t,e /c &,ou$d *e /c=45:15
T,i& pa amete mu&t *e &pecified if /e, &+itc, i& &et- Bot, inte"e & mu&t *e " eate t,an <e o and $e&& t,an t,e tota$ =e&&a"e .en"t,T,i& confi"u ation ma1 need to *e modified if not a$$ a$a m/e#ent me&&a"e fo mat& a e t,e &ame a& t,e defau$t &ettin"- T,e *e&t +a1 to confi m 1ou /c &+itc, i& &et co ect$1 i& to un 2$a m 4i&to 1 in >I? and ma:e &u e t,e a$a m& a e comin" in in t,e fo mat 1ou e3pect/*c defau$t B fa$&e >i3 point c,ec:- T,e inte face +i$$ c,ec: to &ee if t,i& point can *e ead f om >I? at t,e inte face &ta tup if t,i& &+itc, i& &et- To &et it to t ue0 &imp$1 add /*c in *i-eda#.bat fi$e- T,i& &+itc, i& u&efu$ +,en t ou*$e-&,ootin" +,1 a point i& not co$$ectin" data &ince t,e &ta tup- It +i$$ &,o+ if t,e point +a& not added and +,1- T,e di&ad#anta"e& of u&in" t,i& &+itc, a e5 1- T,e point-$oadin" p oce&& +i$$ ta:e muc, $on"e - 2- If t,e point i& off-&can at t,e inte face &ta tup0 and come& on-$ine $ate t,e inte face +i$$ not attempt to e$oad t,e point if t,e &+itc, i& not &et- If0 on t,e ot,e ,and0 t,e &+itc, i& not &et0 t,e te&t +i$$ *e pe fo med on t,i& ta" un$e&& it i& t,e fi &t ta" to *e added to a >I? node0 and t,e point +i$$ ,a#e *een added- On$1 u&e t,i& fo de*u""in"-
20
456 5oft"are+ 6nc.
Startup Command File Parameters and Syntax /L=fff defau$t5 &ee i",t T,i& pa amete &pecifie& t,e $o""in" confi"u ation fi$e- T,e inte face p o#ide& $o""in" faci$itie& *e1ond t,e &tanda d /I $o""in"- See t,e &ection on =e&&a"e .o""in" $ate in t,i& manua$ fo a fu$$ e3p$anation- It is ery important t!at t!e "ull pat! "or t!e logging con"iguration "ile is speci"ied# >o e3amp$e c:0*i0i&te'face)0*i-eda0edalogcfg.t(t in&tead of0 &a10 edalogcfg.t(t- T,e inte face +i$$ not &ta t if t,e fu$$ pat, i& not "i#en-
10!15!200# 03 10 00 .,
21
FI% #M'CS Interface Installation

1 2Intel Installation #is3 File *ist
#is3 File *ist
File $ame PI-EDA.EXE PI-EDA.1AT PI-EDA.D16 Installation notes0 The installation can *e done on either a !I ho e node (the node #here the !I Data Archi&e resides) or on a !I A!I node (a node #hich co unicates to the !I ho e node across a net#or,)% The installation procedure assu es the follo#in'+ .% Mou are installin' the interface on the C dri&e% If you are installin' the interface on a different dri&e than your C+ dri&e0 su*stitute the appropriate dri&e na e in the procedure *elo#% Mour floppy dri&e is the D dri&e% If your floppy dri&e is not your D+ dri&e0 su*stitute the appropriate dri&e na e in the procedure *elo#% Mou ha&e et the appropriate hard#are and soft#are re)uire ents descri*ed in the section entitled 8Card#are and Soft#are8 a*o&e% For a !I3 ho e node+ The !I Fire#all Data*ase and the !I !ro(y Data*ase are confi'ured so that the interface is allo#ed to #rite data to the !I Data Archi&e% See 8Modifyin' the Fire#all Data*ase8 and 8Modifyin' the !ro(y Data*ase8 in the PI Data Archive Manual % If the interface cannot #rite data to the !I Data Archi&e o#in' to per ission pro*le s0 an e''o' 710-01 #ill occur% $ote that /+o)t=local+o)t:5-50 in the PI-EDA#.bat file corresponds to the loop*ac, node .2/%2%2%.0 #hich is present *y default in the Fire#all and !ro(y Data*ases% For a !I2 ho e node+ The client ust *e allo#ed #rite access to the !I2 Data Archi&e% 7ead and #rite access is controlled in !I2 #ith the *i)8)dat:*i)e'%e'.dat file% Description >I? %=26S inte face e3ecuta*$e fi$e Sta tup command fi$e %e*u" &1m*o$ fi$e
2% 3% E%
3%
Installation Procedure
.% Create the follo#in' directory+ c:0PI0i&te'face)0*i-EDA0 if running on a PI3 home node or c:0*i*c0i&te'face)0*i-EDA0 if running on a PI API node 2% Insert the installation dis,0 and e(ecute the follo#in' co ands fro an MsDos pro pt+
22
456 5oft"are+ 6nc.
co*8 b:0PI-EDA.e(e c:0*i*c0i&te'face)0EDA0PI-EDA#.e(e co*8 b:0PI-EDA.bat c:0*i*c0i&te'face)0EDA0PI-EDA#.bat # should *e replaced *y a nu *er *et#een 2 and =@0 inclusi&e% # should correspond to the interface nu *er that is specified usin' the /id fla' in the PI-EDA#.bat file% 3% Modify the co and4line ar'u ents in your PI-EDA#.bat file to custo iHe your interface% For e(a ple0 ..0i&te'face)0EDA0PI-EDA1.e(e /id=1 /. /*)=$ /f=00:01:00 The command line must be on a single line and cannot e'ceed !56) characters (. ,ilo*yte)% This is a li itation set *y the interface0 not *y the $T 9peratin' syste % The co and4line ar'u ents are discussed earlier in this anual% 7unnin' the interface either anually or as a ser&ice is discussed *elo#% Manual startup is reco ended the first ti e the interface is started *ecause anual startup is easier to trou*leshoot%
o run as a ser!ice
The procedure for installin' the FIX DMACS interface as a ser&ice depends upon #hether or not Dufser& is *ein' used% 9nce the interface has *een installed as a ser&ice0 the procedure for startin'0 stoppin' and re o&in' the interface as a ser&ice is the sa e #hether or not Dufser& is used% The purpose of the Dufser& utility is to continue to collect data fro an interface in the e&ent that the !I Data Archi&e is shut do#n for so e reason% For e(a ple0 if the FIX DMACS interface is installed on the !I ho e node and the !I Data Archi&e is shut do#n for an up'rade0 the Dufser& utility on the !I ho e node #ill *uffer the data in a file until the !I Data Archi&e is *rou'ht *ac, online% Another possi*ility is that the FIX DMACS interface is installed on an A!I node% If there are pro*le s #ith the !I ho e node0 then the Dufser& utility on the A!I node #ill *uffer the data in a file until the !I ho e node is *rou'ht *ac, online% The procedure for installin' the interface in conKunction #ith the Dufser& 1tility assu es that the user has Dufser& .%2E or hi'her *ecause the procedure i plicitly assu es that Dufser& #ill *e installed as a ser&ice% The actual installation of the Dufser& 1tility itself is not discussed% For these instructions0 refer to the PI-API &ufserv '(" )elease Notes % Also0 the installation procedure *elo# does not discuss the details related to shutdo#n e&ents that the user should *e a#are of #hen the Dufser& 1tility is used% For ore infor ation0 refer to the PI-API &ufserv '(" )elease Notes % To run as a ser&ice0 co plete the follo#in' steps+ .% 9ne can 'et help for installin' the interface a ser&ice at any ti e *y typin' the follo#in'+ PI-EDA# -+el* $ote that the 7.2e'8 fla' that is descri*ed #hen help is in&o,ed is not i ple ented at this ti e% The $DA* ser&ice can *e installed either as a anual or an auto atic ser&ice% Auto atic ser&ices are started auto atically #hen the $T operatin' syste is re*ooted% This feature is useful in the e&ent of a po#er failure% To install the interface as a EDA#0 directory% anual ser&ice0 e(ecute the follo#in' co and fro the
"ithout Dufser&+ PI-EDA# -i&)tall -de*e&d tc*i* "ith Dufser&+
10!15!200# 03 10 00 .,
23

PI-EDA# -i&)tall -de*e&d 9tc*i* b2f)e'%9 To install the interface as an auto atic ser&ice0 e(ecute the follo#in' co EDA#0 directory% "ithout Dufser&+ PI-EDA# -i&)tall 7a2to -de*e&d tc*i* "ith Dufser&+ PI-EDA# -i&)tall 7a2to -de*e&d 9tc*i* b2f)e'%9 Chec, the Microsoft "indo#s $T ser&ices control panel to &erify that the ser&ice has *een successfully added% 9ne can use the ser&ices control panel at any ti e to chan'e the !I4;DAO ser&ice fro an auto atic ser&ice to a anual ser&ice or &ice &ersa% 9nce the !I4;DAO ser&ice has *een installed0 the rest of the procedure is the sa e #hether or not Dufser& has *een i ple ented% The !I4;DAO ser&ice can *e started fro the ser&ices control panel or *y e(ecutin' the follo#in' co and fro the PI!EDA#0 directory+ PI-EDA# -)ta't A essa'e #ill *e echoed to the screen infor in' the user #hether or not the interface has *een successfully started as a ser&ice% If the ser&ice is successfully started0 the interface #ill atte pt to read the co and4line ar'u ents fro the PI-EDA#.bat file% For this to succeed0 the root na e (the part of the file na e *efore the .e(e and .bat e(tensions) of the *atch file ust *e the sa e as the root na e of the e(ecuta*le% Also0 the *atch file and the e(ecuta*le file ust *e in the sa e directory% If the interface is una*le to read the co and4line ar'u ents0 or if the co and4line ar'u ents that the interface reads are in&alid0 the ser&ice #ill ter inate #ith no error essa'es echoed to the screen% For this reason0 the user M1ST chec, the *i*c.log file to &erify that the interface is runnin' correctly% In the *i*c.log file0 essa'es pertainin' to the FIX DMACS interface #ill *e prepended *y PI-EDA #:% The location of the *i*c.log file is deter ined *y the !IC9M; entry in the *i*c.i&i file% The *i*c.i&i file is located in the ;i&NT directory% 1sually0 the *i*c.log file #ill reside in the c:0*i*c0dat0 directory% If the ser&ice #as successfully started0 the user can &erify that the ser&ice is still runnin' fro the ser&ices control panel% If the ser&ice has *een ter inated0 the reason for its ter ination #ill *e 'i&en in the *i*c.log file% If the ser&ice is still runnin'0 the user can use c:0PI0bi&0a*i)&a*.e(e or !rocessDoo, to &erify that data is *ein' successfully transferred to the !I Data Archi&e% The !I4;DAO ser&ice can *e stopped at any ti e *y issuin' the follo#in' co and+ PI-EDA# -)to* The PI-EDAO ser&ice can *e re o&ed *y PI-EDA# -'e,o%e 2% If the !I4;DAO ser&ice is installed as a anual ser&ice on the !I ho e node0 the user ay #ish to edit the c:0PI0ad,0*i)'%)ite)ta't.bat and the c:0PI0ad,0*i)'%)ite)to*.bat co and files% These co and files are in&o,ed only #hen the !I data archi&e is started and stopped as a anual ser&ice #ith the c:0PI0ad,0*i)'%)ta't.bat and the c:0PI0ad,0*i)ite)to*.bat co and files% In the c:0PI0ad,0*i)'%)ite)ta't.bat file0 a,e sure that the second to last line ends in+ < 3ait 5000 and fro the
2#
456 5oft"are+ 6nc.
If not0 append < 3ait 5000 to the end of the line% In the sa e file0 add the follo#in' co and Kust a*o&e :t+ee&d + ":0PI0i&te'face)0EDA0PI-EDA# -)ta't < 3ait 5000 Add the follo#in' co and to the c:0PI0ad,0*i)'%)ite)to*.bat file Kust a*o&e :t+ee&d + ":0PI0i&te'face)0EDA0PI-EDA# -)to* $ote that the full path na e to the ;DAO e(ecuta*le ust *e 'i&en in *oth the c:0PI0ad,0*i)'%)ite)ta't.bat and the c:0PI0ad,0*i)'%)ite)to*.bat co and files%
o run in interacti!e (ode

To run in interacti&e .% ode0 co plete the follo#in' steps ;(ecute the follo#in' co and fro an Ms Dos pro pt+ cd c:0PI0i&te'face) )ta't 9EDA#9 EDA0PI-EDA#.bat A ne# Ms Dos #indo# #ill appear0 and the user #ill see se&eral essa'es echoed to the screen% Then the essa'es #ill si ply stop% The user #ill not re'ain a co and pro pt on the dse% #indo# until the interface has *een stopped% !ressin' PC$T7B4CQ ,ey co *ination #hile the Ms Dos #indo# is selected stops the interface% The user can use c:0PI0bi&0a*i)&a*.e(e or !rocessDoo, to &erify that data is *ein' successfully transferred to the !I Data Archi&e% Chec, #hether or not there is any error essa'es to &erify successful e(ecution of the interface% Messa'es that are sent to the screen are also sent to the *i*c.log file% Chec, the *i*c.log file% So e essa'es are #ritten to this file that are not echoed to the screen #hen the interface is started up% Messa'es in the *i*c.log file that pertain to the FIX DMACS interface #ill *e pre4pended *y PI-EDA #:% The location of the *i*c.log file is deter ined *y the !IC9M; entry in the *i*c.i&i file% The *i*c.i&i file is located in the ;i&NT directory% 1sually0 the *i*c.log file #ill *e placed in the c:0*i*c0dat0 directory% 2% If you plan on startin' *oth the !I Data Archi&e and the FIX DMACS interface anually0 you ay #ish to start the FIX DMACS interface alon' #ith the !I data archi&e% To do this you ust edit the c:0PI0ad,0*i)ite)ta't.bat co and file (there is no such thin' as a c:0PI0ad,0*i)ite)to*.bat co and file)% Ma,e sure that the last line of the c:0PI0ad,0*i)ite)ta't.bat file ends in+ < 3ait 5000 If not0 append < 3ait 5000 to the end of the line% In the sa e file0 add the follo#in' t#o co ands+ ec+o /ta'ti&g EDA# I&te'face )ta't 9EDA#9 /,i& ..0i&te'face)0EDA0PI-EDA#.bat < 3ait 5000 The ;DAO interface should no# *e started in interacti&e ode% The /,i& fla' ini iHes the Ms Dos #indo# that is created #hen the FIX DMACS interface is e(ecuted%
o Install #ebu& S$(bols

To install the de*u' sy *ols0 copy the file *i-eda.dbg to directory =/8)te,>oot=0/8,bol)0e(e
10!15!200# 03 10 00 .,
25

Ser&ice Control Mana'er can use the sy *ols contained in this file to atch Dr% "atson du ps #ith the e(tracted sy *ol infor ation% This directory is usually created *y !I 3%2 installation pro'ra % If it does not e(ist0 ho#e&er0 the user should create it% Dr% "atson is installed as the default de*u''er *y typin' d'3t)&5? 7i at DOS prompt%
26
456 5oft"are+ 6nc.
FI% #M'CS Interface S$ste( 'd(inistration

Startin& the FI% #M'CS Interface
'uto(atic Ser!ice Startu"
If the FIX DMACS interface #as confi'ured as an auto atic ser&ice0 the FIX DMACS interface #ill auto atically start after the $T syste re*oots% This confi'uration is useful in the e&ent of a po#er failure%
Manual Ser!ice Startu"

If the FIX DMACS interface0 as #ell as the !I syste 0 is confi'ured as a anual ser&ice0 the FIX DMACS interface can *e started alon' #ith the !I syste #hen the follo#in' co and file is e(ecuted fro the ad,0 directory (assu in' installation procedure discussed a*o&e #as co pleted)+ *i)'%)ta't.bat If you #ish to start a anual !I4;DA ser&ice separately fro the follo#in' co and fro the PI-EDA#0 directory+ +I63 '# -)ta't the !I Data Archi&e0 e(ecute
Interacti!e Startu"
If *oth !I and the FIX DMACS interface are started interacti&ely0 one can start *oth of the #ith+ *i)ta't.bat Alternati&ely0 one can start the interface independently of the !I Data Archi&e *y typin' the follo#in' co and fro the i&te'face)0 directory+ )ta't 9PI-EDA#9 PI-EDA#0PI-EDA#.bat 9r one can issue the follo#in' co PI-EDA#0PI-EDA#.bat "hen )ta't @PI-EDA#AB co and fro the i&te'face)0 directory+
and is used0 a ne# MsDos #indo# is created%
Sto""in& the FI% #M'CS Interface

If the FIX DMACS interface #as confi'ured as an auto atic or a anual ser&ice0 and if the !I syste #as also confi'ured as an auto atic or anual ser&ice0 then the !I4;DAO ser&ice is stopped alon' #ith the !I syste *y e(ecutin' the follo#in' co and file fro the ad,0 directory+ *i)'%)to*.bat Alternati&ely0 one can stop the !I4;DAO ser&ice independently fro stoppin' the !I syste *y e(ecutin' the follo#in' co and fro the PI-EDA#0 directory+
10!15!200# 03 10 00 .,
27

PI-EDA# -)to* 9ne can also stop the ;DAO ser&ice fro the ser&ices control panel% If the interface #as started in interacti&e ode0 it can *e stopped *y either selectin' the Ms Dos #indo# that corresponds to the !I4;DAO interface or holdin' do#n the control ,ey #hile typin' the letter c% /ote0 There is no *i)ite)to*.bat file to correspond to the *i)ite)ta't.bat file%
Status, Warnin&, and .rror Messa&es

Such essa'es #ill *e #ritten to the *i*c.log file% This file should *e chec,ed to &erify successful e(ecution of the interface *ecause not all error essa'es are echoed to the screen% The location of this file is deter ined *y the !IC9M; entry in the *i*c.i&i file0 #hich is located in the ;i&NT directory% For e(a ple0 if the !IC9M; entry is c:0PIP"0 then the *i*c.log file #ill *e located in the c:0PIP"0dat directory% The interface #ill report all FIX errors #ith a conte(t4sensiti&e description%
28
456 5oft"are+ 6nc.
IO/ates
The total rate (e&ents per inute) that the FIX DMACS interface sends data to the snapshot can *e easured% The interface calculates a .24 inute a&era'e (i%e% it counts the total nu *er of snapshot e&ents o&er a .24 inute period and then di&ides *y .2 inutes)% I97ates for indi&idual ta's cannot *e easured at this ti e% For instructions re'ardin' i ple entation of I97ates0 see the description of the /ec fla' of the startup co and file under the section entitled 8Startup Co and File%8
10!15!200# 03 10 00 .,
29
FI% /edundanc$ and Pi2eda

Doth FIX32 and iFIX support failo&er . (startin' fro FIX32 &ersion -%.3 and FIX Dyna ics &ersion 2%2)% !i4eda can ta,e ad&anta'e of this functionality *y runnin' on a 5ie# node% A 5ie# node can loo, at a pair of SCADA nodes that ha&e the identical data*ases (and connected to the sa e !BC) and o*tain data fro the currently acti&e node% More infor ation on Failo&er can *e found in Intellution?s docu entation for FIX32 or iFIX% Althou'h FIX allo#s a *ac,up SCADA confi'uration that in&ol&es t#o SCADA ser&ers and no 5ie# node0 pi4eda0 as of &ersion 2%2%20 does not support this confi'uration% /ote+ iFIX does not synchroniHe the process data*ases on the SCADA ser&ers% Mou ust ensure that *oth data*ases are identical% It is also i portant that the failo&er paired SCADA nodes? cloc,s are synchroniHed in order to ensure that the ta's 'et the sa e data re'ardless of #hich SCADA the &alues are pulled fro % This section descri*es the setup on 5I;" node and the failo&er4pair SCADA nodes and !I ta' confi'urations so that pi4eda can sea lessly collect data re'ardless of #hich SCADA node is acti&e% Confi'urations are sli'htly different dependin' on #hether the syste is FIX32 or iFIX%
FI%4, 5iew 1ode

In #onfigure+Networ, dialo'0 enter re ote node na es #ith #hich the 5I;" node co unicates% /ote0 9nly the pri ary node of the pair SCADA nodes needs to *e entered here%
Clic, on #onfigure - *utton and 'et the follo#in' screen%

.
FIX32 &ersion /%2 and iFIX 2%. ha&e *een tested at 9SI for failo&er support and pi4eda co pati*ility #ith FIX redundancy% The redundancy syste tested consisted of pure FIX32 or pure iFIX co *inations0 i%e%0 2 FIX32 SCADA nodes and . FIX32 5I;" node0 or 2 iFIX SCADA nodes and . iFIX 5I;" node% The a&era'e ti e it (5I;" node) too, to fail o&er fro one SCADA node to the other #as a*out 22432 seconds% This is reflected in the data 'ap in !I archi&e%
30
456 5oft"are+ 6nc.
;nter the *ac,up node na e for this re ote SCADA node%
10!15!200# 03 10 00 .,
31
FI%4, Pri(ar$ SC'#' 1ode

In SC10
In #onfigure+S#ADA screen0 fill in the data*ase na e% This data*ase ust reside *oth on the pri ary SCADA node and the *ac,up SCADA node #ith the identical ta' definitions% Define !artner SCADA in 7edundancy *o(%
32
456 5oft"are+ 6nc.
Then in #onfigure+Networ, dialo'ue0
;nter the 5ie# node na e and the SCADA partner node na e in 7e ote $odes *o(% Then hi'hli'ht the SCADA partner node (i%e%0 this node?s *ac,up node) and clic, on #onfigureThen enter its *ac,up node?s na e in redundancy *o( (since this is *ac,up nodes?s *ac,up0 it #ould *e pri ary node?s na e)%
FI%4, Bac3u" SC'#' 1ode

Do the sa e thin' as on the pri ary node0 e(cept that the local node na e is the *ac,up node na e0 !artner SCADA is the pri ary node0 and the re ote node?s *ac,up node is the *ac,up node%
10!15!200# 03 10 00 .,
33
FI%4, 5iew 1ode6s 1etwor3 Status #is"la$

In FIX 5ie#0 #hen you open &)d'ed2&.odf you #ill see #hich SCADA node is acti&e currently% This is the SCADA node fro #hich pi4eda #ill *e 'ettin' ta' &alues% For details on ho# to set this up0 see FIX docu entation%
FI%4, 1ode 7winnt7s$ste(4,7dri!ers7etc Host File

5ie# node and *oth SCADA nodes ust all ha&e host files #ith the 5ie# node na e0 pri ary and *ac,up SCADA node na es and I! addresses% For e(a ple0 (((%(((%(((%. (((%(((%(((%2 (((%(((%(((%3 FIX5I;" FIX!7M7M FIXDAR1!
PI a& Confi&uration for FI%4, a&

All confi'uration settin's are the sa e as #hen no redundancy is re)uired e(cept that the $9D; field in Instru entTa' attri*ute ust *e the primar node na e%
iFI% 5iew 1ode

In S# +#onfigure+Networ, screen0 enter the lo'ical na e that the 5ie# node is to co unicate #ith in the 7e ote $ode $a e field% Clic, the Add *utton% The lo'ical node na e appears in the Confi'ured 7e ote $odes list%
3#
456 5oft"are+ 6nc.
Then clic, on #onfigure *utton and chec, ;na*le Bo'ical $a es *o(% ;nter the local node na e of the pri ary node in the !ri ary $ode field% ;nter the local node na e of the *ac,up node in the Dac,up $ode field%
iFI% Pri(ar$ SC'#' 1ode

In S# +#onfigure+.ocalStartu% screen0 enter the lo'ical na e for the pri ary node and the *ac,up SCADA pair%
10!15!200# 03 10 00 .,
35
Then in SC1/Confi'ure/SCADA screen0 enter the *ac,up SCADA na e%
Then 'o to S# +#onfigure+Networ, screen and enter the lo'ical na e for this SCADA and its *ac,up SCADA nodes in the 7e ote $ode $a e *o(% Clic, Add%
Then clic, on #onfigure *utton and chec, $na/le .ogical Names *o(% ;nter the local node na e of the pri ary node in the !ri ary $ode field% ;nter the local node na e of the *ac,up node in the Dac,up $ode field%
36
456 5oft"are+ 6nc.
:o *ac, to S# +#onfigure+Networ, screen and add the 5ie# node na e in )emote Node Name *o(%
iFI% Bac3u" SC'#' 1ode

Do the sa e thin' as on the pri ary node0 e(cept that the local node na e is the *ac,up node na e0 and the !artner SCADA na e in #onfigure+S#ADA is the pri ary node na e% The #onfigure+Networ, settin' is identical to that of the pri ary SCADA node%
iFI% 1etwor3 Status /edundanc$ #is"la$

Net3o'B/tat2)>ed2&da&c8Di)*la8.g'f file can *et setup to sho# #hich SCADA node is currently acti&e% !i4eda 'ets its data fro this acti&e node%
10!15!200# 03 10 00 .,
37
iFI% 1ode 7winnt7s$ste(4,7dri!ers7etc Host File

5ie# node and *oth SCADA nodes ust all ha&e host files #ith the 5ie# node na e and pri ary and *ac,up SCADA node na es and I! addresses% For e(a ple0 (((%(((%(((%. (((%(((%(((%2 (((%(((%(((%3 FIX5I;" FIX!7M7M FIXDAR1!
PI a& Confi&uration for iFI% a&

All confi'uration settin's are the sa e as #hen no redundancy is re)uired0 e(cept that the $9D; field in Instru entTa' attri*ute ust *e the logical SCADA node na e for the failo&er (a,a redundancy) SCADA pair%
38
456 5oft"are+ 6nc.
'""endix ' Co((unication .rror /eco!er$

If a re ote FIX node 8'oes do#n8 (*eco es inopera*le)0 the ta's associated #ith that node #ill return an error code to !I (1AD INPCT)0 and #ill not report any future &alues to !I until the re ote node *eco es opera*le a'ain% 9nce the re ote node is opera*le0 the interface auto atically starts sendin' data to !I% If the local FIX node 'oes do#n0 access to all re ote FIX nodes is also inhi*ited% In this case0 e&ery ta'?s status #ill *e set to 1AD INPCT% "hen the local node is re4started0 all ta's #ill *e redefined in ;DA0 and pollin' #ill continue as *efore the node #ent do#n%
10!15!200# 03 10 00 .,
39
'""endix B roubleshootin&
If the interface is *eha&in' in an une(pected anner0 chec, the *i*c.log file and the user4 specified lo' file (see 8Appendi( C8)% ;&en #hen the interface runs in interacti&e ode0 not all error essa'es are #ritten to the screen% In 'eneral0 the user4specified lo'file #ill contain 'reater detail then the *i*c.log file%
Fre0uentl$ 's3ed 8uestions

5. 's soon as I start the interface- an a**lication error "essa7e )ox co"es u*. The interface crashes. 1hat coul, cause thisA A% Chec, ta' confi'uration% Co on causes ay *e+ Missin' Instru entTa' &alue% Fi(To!I does not auto atically con&ert all *loc, types to !I type% See the !I !ointDefinition section in this anual% See release notes for ost current info on ,no#n pro*le s% This is i portant if you are runnin' FIX Dyna ics instead of FIX DMACS% A re)uired interface DBB is issin' (see 8FIX DMACS Interface Installation8)% Chec, Control!anel applet0 Syste /;n&irone nt/!ath &aria*le% This should contain the FIX *ase directory% If not set it and restart the syste % If this does not #or,0 you are pro*a*ly issin' the file% Mou ay need to copy that file fro FIX installation CD%
5. 1h! ,oes it ta8e several "inutes to see new values after I a,, a new ta7 while the interface is runnin7A A% The interface chec,s for chan'es in the !I point data*ase e&ery t#o &alues #on?t *e sent to !I until the first scan after the ta' #as added% inutes% Any ne#
5. 1hen I sto* an, restart FIX !na"ics while +I63 ' is still runnin7 I 7et the followin7 "essa7e. 1h!A
A% FIX ay ha&e *een confi'ured to run only interacti&ely% Ma,e sure that FIX is installed as a ser&ice (this re)uires chec,in' the FContinue runnin' after Bo'off F option in SC1SBocalStartup in FIX as #ell as the hard#are ,ey fro Intellution in the *ac, of the co puter)% "hether FIX started as a ser&ice or not can *e &erified *y chec,in' if FIX ser&ice
#0
456 5oft"are+ 6nc.
in Control!anelSSer&ices sho#s FstartedG% 9r0 FIX #asn?t co pletely dead fro pre&ious operation% Chec, Tas, Mana'er for possi*le re nant co ponents of FIX since the last ti e it #as shutdo#n% 5. 1h! ,o I constantl! 7et a ti"e,6out status for ta7s on a re"ote no,eA A% Most li,ely0 the re ote FIX node is not runnin'% If the node is runnin'0 chec, the ta' confi'uration to a,e sure that the proper node0 ta'0 and field ha&e *een specified% 5. ' re"ote %&' ' no,e see"s invisi)le to the local %&' ' no,e althou7h networ8 connection is 7oo, an, the re"ote %&' ' no,e is u* an, runnin7. 1h!A A% If that re ote SCADA node na e is not the sa e as its SCADA na e and I! address need to *e added to 03i&&t0)8)te,5?0d'i%e')0etc0+o)t) file% achine na e on the net#or,0 the
5. 1hat ,o the followin7 error "essa7es (C E#$ Li)t lo)t--3ill atte,*t to 'e-e)tabli)+0G FE''o' e)tabli)+i&g tag D*b001:010-T E1?F0GH0A etc) in *i*c.log "eanA
2E4$o&4=@ 22+..+3@ !I4;DA .Q Bocal FIX soft#are #ent do#n at 2E4$o&4=@ 22+..+3@% "aitin' for FIX to restart%%% 234$o&4=@ 2@+33+33 !I4;DA .Q Bocal host T!D22. restored at 234$o&4=@ 2@+33+33 234$o&4=@ 2@+33+33 !I4;DA .Q "aitin' 32 seconds for FIX to start co pletely *efore loadin' pts%%% 234$o&4=@ 2@+3E+3/ !I4;DA .Q Co pleted re4processin' ta's 234$o&4=@ 2@+3E+E2 !I4;DA .Q !I 'et e(ception syste 234$o&4=@ 2@+3E+E2 !I4;DA .Q ;5M Bist lost44#ill atte pt to re4esta*lish 234$o&4=@ 2@+3E+E2 !I4;DA .Q ;rror esta*lishin' ta' Kp*22.+2.24T (.2/2=) 234$o&4=@ 2@+3E+E2 !I4;DA .Q ;rror esta*lishin' ta' Kp*22.+2.24T (.2/.2) U error 4/3
10!15!200# 03 10 00 .,
#1
U 234$o&4=@ 2@+3E+E2 !I4;DA .Q Scan !erfor ance su 234$o&4=@ 2@+3E+E2 !I4;DA .Q Class .0(. sec)+ Scans on ti e+ .%3V0 Scans s,ipped+ =@%/V 234$o&4=@ 2@+3E+E. !I4;DA .Q ;5M 'et e(ception no lon'er in error ary
A% Ta's that correspond to these errors are e&ent ta's% All e&ent ta's 'et si'ned up for e(ception reports% This si'nin' up is called Festa*lishin'%G These ta's 'et disesta*lished if their e(ception &alues0 or Fe&ents0G are not re)uested fro the snapshot su*syste for 32 inutes% Since the !I4;DA interface does not re)uest the e&ents #hile the local FIX node is do#n0 if it is do#n for lon'er than 32 inutes0 error essa'es PI get e(ce*tio& )8)te, e''o' 7F5 and E#$ Li)t lo)t--3ill atte,*t to 'e-e)tabli)+ #ill *e printed in *i*c.log file% The essa'e E''o' e)tabli)+i&g tag ... is a 1niInt (9SI interface standard upon #hich !I4;DA is *uilt) &ersion 2%2= *u' and can *e i'nored% This Kust indicates the ta' is *ein' si'ned up for e(ception reports a'ain% The e&ent ta's should start 'ettin' &alues after the E#$ get e(ce*tio& &o lo&ge' i& e''o' essa'e% 5. 1h! ,o so"e ta7s 7et 3 ' e''o' I1F0F: at startu*A
2E4$o&4=@ .3+E/+E3 !I4;DA .Q Startin' interface0 !oint source+ . 2E4$o&4=@ .3+E/+E3 !I4;DA .Q 1niint &ersionQW(O)uniint%c(( 2E4$o&4=@ .3+E/+E3 !I4;DA .Q A!I &ersionQ .%2%3%E 2E4$o&4=@ .3+E/+E3 !I4;DA .Q successfully connect to piser&er localhost+3E32 2E4$o&4=@ .3+E/+E3 !I4;DA .Q I97AT;+ ta' Kp*.rate confi'ured% 2%2= 224Apr4=@
#2
456 5oft"are+ 6nc.
2E4$o&4=@ .3+E/+E3 !I4;DA .Q 5ersion .%@%3X of !I4;DA Interface started 2E4$o&4=@ .3+E/+E3 !I4;DA .Q Interface runnin' on local FIX node T!D22. 2E4$o&4=@ .3+E/+E3 !I4;DA .Q "aitin' .2 seconds for FIX to start co pletely *efore loadin' pts%%% 2E4$o&4=@ .3+E/+33 !I4;DA .Q . Scan classes ha&e *een defined 2E4$o&4=@ .3+E/+33 !I4;DA .Q Scan class .0 update period A . seconds0 phase offset A 2 2E4$o&4=@ .3+33+3. !I4;DA .Q ;DA error P./2/Q occurred durin' function eda>set>float() on FIX $TF PT!D22.02.24TIM;4D9220F>C5Q 2E4$o&4=@ .3+33+3. !I4;DA .Q 5alue out of ran'e 2E4$o&4=@ .3+3@+23 !I4;DA .Q ;DA error P./2/Q occurred durin' function eda>set>float() on FIX $TF PT!D22.02=.4TIM;4T!D22.4DAM0F>C5Q 2E4$o&4=@ .3+3@+23 !I4;DA .Q 5alue out of ran'e U U 2E4$o&4=@ .3+3@+3@ !I4;DA .Q 232E points found for point source . 2E4$o&4=@ .3+3@+3@ !I4;DA .Q 2 uni)ue e&ent classes ha&e *een esta*lished 2E4$o&4=@ .3+3@+3@ !I4;DA .Q @ output points ha&e *een esta*lished
A% "hen this ;DA e''o' I1F0F: appears in *i*c.log0 chec, the current &alue and the Hero and span of the ta'% These errors occur #hen the current &alue of the ta' is outside the ran'e specified *y the Hero and span attri*utes of the ta'% 9ne co on instance of this error occurrin' is #hen an output ta' has itself as a sourceta'0 #hich #as not initialiHed correctly% The interface initialiHes the current &alue of this ta' as 2% If the &alue Hero falls outside of the Hero to HeroXspan ran'e0 the ta' #ill 'et ;DA e''o' I1F0F:% The point con&ersion utility fi(topi included #ith this interface auto atically sets
10!15!200# 03 10 00 .,
#3

the source ta's of all con&erted FIX output ta's as the sel&es% 1nless the user anually odifies the output script of this utility0 these ta's #ill recei&e I1F0F: e''o' if 2 is not in their defined Hero and HeroXspan ran'e% 5. 1hat causes the 3 ' e''o' I1?1?:J A% This error eans that the field &alue (e%'% F>C50 A>C50 etc) is not a&aila*le% For re'ister ta's (analo' and di'ital) this error is returned as a result of an atte pt to read the re'ister that #ent to sleep% If your i/o dri&er supports Disa*le Access Ti e (for ore details consult your i/o dri&er anual) then you can pre&ent the re'ister fro 'oin' to sleep% 1sually0 this error is returned at the first atte pt to read the asleep re'ister% At the ne(t atte pt0 the field &alue #ill *e returned correctly% Chec, your data retrie&al tool #hen a ta' 'ets this error to see if the &alues did co e in after the first essa'e of this ,ind% 5. 1hat causes the 3 ' e''o' I1F50:A The error "essa7e in *i*c.log loo8s li8e0 EDA e''o' I1F50: occ2''ed d2'i&g f2&ctio& I&itialiKe/tate)EH o& IX NT INode-Tag&a,e,A!"#: A% ;DA e''o' 1F50 ta' really e(ists in FIX% eans Ta' na e not defined% Chec, if the data*ase is loaded or the
5. C3vent ta7 XXXXXX- *oint DDDDD- re"ove,E is foun, in *i*c.log file althou7h this ta7 was not ,elete, in +I. 1h!A A% This ta' #as pro*a*ly the e&ent ta' for so e e&ent4tri''ered ta' that #as deleted or edited% 5. 'll ta7s su,,enl! are 7ettin7 1AD-INPCT values an, are not chan7in7. A% Chec, *i*c.log file% Most li,ely the local FIX node #ent do#n% 50 Ta7s that *reviousl! receive, ,ata well- no lon7er 7et an! ,ata after FIX *oint ,ata)ase has )een "o,ifie,. A+ 1pdates in FIX point data*ase are not auto atically transferred to !I point data*ase% Fi(To!i utility transfers FIX point infor ation to !i only #hen it is run% If there are si'nificant chan'es to the FIX point confi'uration0 !I point data*ase should *e chec,ed and/or odified to a,e sure that the FIX and !I point attri*utes are co pati*le% 50 1hen the interface starts- it *rints "essa7e @No )e'%ice lib'a'ie) a'e loaded@ althou7h all 3 ' ,llFs are in FIX ,irector!. A+ Chec, !ATC &aria*le in Control!anel/Syste /;n&iron ent% Ma,e sure there is a path to FIX directory% FIX can run #ithout this0 *ut ;DA client needs to ,no# #here to find the dll?s% 50 The interface starts u* an, then re*orts that local no,e ,oes not a**ear to )e runnin7 when it is runnin7 an, one can see ,ata chan7in7 in ata)ase ?uil,er. A+ Chec, to see if *oth FIX DMACS and FIX Dyna ics are (or ha&e *een) installed on the A!I node% If this is the case0 it is li,ely that ;DA #ill reco'niHe only one of the % Try runnin' the other FIX soft#are (other than the one a'ainst #hich pi4eda is runnin' and
##
456 5oft"are+ 6nc.
'ettin' this essa'e)% If that succeeds0 contact Intellution and 'et instructions as to ho# to install *oth safely or re o&e one of the co pletely the correct #ay%
More Messa&es *o&&ed to pipc.log File and .x"lanations

C1aitin7 DDD secon,s for FIX to start co"*letel! )efore loa,in7 *ts...E DDD is specified *y the user &ia /# s#itch in co and line% !I4;DA #aits DDD seconds *efore startin' to collect infor ation on ta's and scan the data% This is to allo# FIX itself to finish loadin' all its su*syste s and data*ase% @&o"*lete, re6*rocessin7 ta7s@ "hen FIX local node 'oes do#n #hile the interface is runnin'0 the interface #aits in a loop0 periodically chec,in' to see if FIX has co e *ac, up% "hen FIX restarts0 the interface reinitialiHes FIX4!I related infor ation% This essa'e indicates !I4;DA has finished loadin' such infor ation to e ory so that it can start scannin'% C3 ' error <#> occurre, ,urin7 function XXXX on FIX /TF GX- =- HIE An error occurred #hile a,in' an ;DA call% The ;DA error nu *er0 D0 is e(plained at the end of this section under the su*section FFIX ;DA ;rrorsG% XXXX is the ;DA function called% X is the FIX node na e0 = is the FIX ta' na e0 and H is the field na e% Co on errors are+
I1F0F: !I ta' &alue is out of ran'e of its correspondin' FIX ta'% This occurs if an atte pt is ade to #rite a &alue to the FIX ta'0 and the &alue is out of ran'e defined in FIX% I1?1?: Field &alue is not a&aila*le% 1sually0 this eans FIX ta' is off4scan% Ma,e sure FIX data*ase is loaded and the ta' is confi'ured to scan% @Test fiel, for ta7 T is H. Interface a)ortin7@ !I4;DA #as chec,in' to see if data for the ta' T is no# a&aila*le at FIX startup0 and found that data type specified in NFIX field? for this ta' is not set to either A (for analo') or F (for float)% Interface a*orts if this happens% C3 ' Faile, to a,, ta7 JK+?'<M-0(L6%:MM6'<03-'9&.M to the 7rou*. xxxxxxxxxxxE !oint loadin' failed due to reasons xxxxxxxxxxx. For e(a ple0 Ta' na e is not defined% Chec, FIX data*ase if the point is confi'ured correctly and is on4scan% This point #ill not *e added to the scan list unless it is edited in !I or the interface is restarted0 and e&en then0 only #hen the FIX ta' is confi'ured correctly and is a&aila*le on4scan% If /pc s#itch is not set0 only the first ta' on the node #ill *e chec,ed and recei&e this essa'e if there is an error%
10!15!200# 03 10 00 .,
#5

@<ocal FIX software went ,own at ,a!6"onth6!ear hour0"in0secon,. 1aitin7 for FIX to restart...@ FIX local node do#n condition is detected% !I4;DA #ill #ait in a loop0 periodically chec,in' to see if FIX restarted% @<ocal host XXX restore, at ,a!6"onth6!ear hour0"in0secon, @ The FIX local node restart condition is detected *y !I4;DA0 #hich had *een #aitin' in a loop #hile it #as do#n% @/o FIX fiel, t!*e s*ecifie, for +I ta7 X@ The re)uired FIX field type infor ation is issin' for this ta'% This essa'e is follo#ed *y the follo#in' !I Instru entTa' and ;(Desc (e(tended descriptor) infor ation+ !I Instru entTa' A 8XXXX8 !I ;(Desc A 8MMMM8 @/o FIX ta7 na"e s*ecifie, for +I ta7 X@ The re)uired FIX ta' na e infor ation is issin' for this ta'% This essa'e is follo#ed *y the follo#in' !I Instru entTa' and ;(Desc (e(tended descriptor) infor ation+ 8!I Instru entTa' A 8XXXX8 8!I ;(Desc A FMMMM8 @/o conversion is su**lie, for float@ This ta' is defined as FIX float *ut is not confi'ured as either float or inte'er in !I0 the only allo#ed con&ersion fro FIX float to !I% This essa'e is follo#ed *y+ @Float ta7 GXI cannot )e use, for 3 ' JT- /- FM@ T is the ta' na e0 / is the FIX node na e0 and F is the FIX field type% @3 ' i7ital t!*e ta7s are confi7ure, in +I as +I ,i7ital t!*es@ This !I ta'?s correspondin' FIX ta' is di'ital0 *ut it #as not confi'ured as di'ital in !I% This essa'e is follo#ed *y+ @Ta7 GxxxI cannot )e use, for 3 ' JT- /- FM as it is not a ,i7ital t!*eE T is the ta' na e0 / is the FIX node na e0 and F is the FIX field type% @3 ' Multistate i7ital t!*e ta7s are confi7ure, in +I as +I ,i7ital t!*es@
This !I ta'?s correspondin' FIX ta' is of type N ultiple4state di'ital?0 and has to *e confi'ured as type di'ital in !I% This essa'e is follo#ed *y+ @Ta7 GXI cannot )e use, for 3 ' JT- /- FM as it is not a ,i7ital ta7@ T is the ta' na e0 / is the FIX node na e0 and F is the FIX field type%
#6
456 5oft"are+ 6nc.
@3 ' (')l*hanu"eric fiel, is ,efine,- )ut the +I fiel, is not Nstrin7N@ The correspondin' FIX ta' is of type alphanu eric0 and has to *e confi'ured as type strin' in !I% This essa'e is follo#ed *y+ Ta7 GXI cannot )e use, for 3 ' JT- /- FM as it is not a strin7 ta7@ T is the ta' na e0 / is the FIX node na e0 and F is the FIX field type% @Fiel, t!*e GHI not su**orte,@ FIX type specified as Field &alue H in this !I ta'?s Instru entTa' or ;(Desc is not one of the follo#in'+ F for float0 ' for alphanu eric (strin')0 for di'ital0 M for ultistate di'italL #hich are le'al types in FIX% @/o ta7 confi7uration s*ecifie, for GTI@ Instru entTa' does not contain the correspondin' FIX ta' infor ation (at least the correspondin' FIX ta' na eL node na e and Field &alue ay *e specified in e(tended descriptor) re)uired to correctly associate this !I ta' #ith a FIX ta'% @<ocal host FIX software ,oes not a**ear to )e runnin7. 1aitin7...@ Bocal FIX node is not runnin' at the ti e of interface startup% It #aits in a loop until FIX starts% @&oul, not retrieve local host na"e. Interface a)orte,@ The ;DA function Neda>'et> yna e(BocalCost$a e)? returned an error% For so e reason local host na e #as not o*tained% Since !I4;DA needs FIX SCADA to *e runnin' on the sa e achine0 it #ill a*ort% @Interface runnin7 on local FIX no,e ////@ The interface detected the local FIX node na e to *e ////% @3 ' Faile, to a,, ta7- T- to the 7rou*. <ocation2 out of ran7e.@ Ta' T?s location2 &alue is not either 2 or .% @&oul, not create 3 ' 7rou* for scanclass DO@ An atte pt to 'roup ta's #ith the sa e scan fre)uency D (specified in co ade and failed #hen the ;DA function Neda>define>'roup? #as called% @&oul, not create 3 ' 7rou* for event6ta7 T tri77ere, ta7sO@ An atte pt to create a FIX scan 'roup0 the scannin' of #hich #ill *e tri''ered *y an e&ent in !I ta' T0 #as ade and failed% @&reate, 7rou* for scanclass D@ A FIX scan 'roup #as created for ta's that *elon' to the sa e scan fre)uency class% and line) #as
10!15!200# 03 10 00 .,
#7
@&reate, 7rou* for event6ta7 T tri77ere, ta7s@ A FIX scan 'roup #as created for ta's that ha&e the sa e e&ent ta' (see of e&ent ta')% @3,ite, ta7 T coul, not )e a,,e,@ Ta' T #as edited in !I and its para eters% 7elated FIX infor ation such as ta' na e0 node na e and field type0 could not *e set correctly% Chec, Instru entTa' and e(tended descriptor attri*utes for this ta' and/or its correspondin' FIX ta'?s confi'uration% @&o"*lete /: 30T'P0FI3< infor"ation unavaila)le for +I ta70 T@ !I ta' attri*utes Instru entTa' and ;(Desc did not contain all of &alid FIX ta' na e0 FIX node na e0 and FIX *loc, type% Settin' those para eters failed and this point #ill not *e scanned% This essa'e is follo#ed *y+ 8!I Instru entTa' A XXXX8 8!I ;(Desc A 8MMMM8 #hich sho# the current contents of Instru entTa' and ;(Desc% @Fatal 3rror on tree "ani*ulation@ FIX node as specified either in Instru entTa' or ;(Desc is not found% Interface #ill a*ort% Chec, if $9D; #as specified correctly and if this FIX node really e(ists% @3 ' Faile, to a,, ta7 J/- T- FM to the 7rou*@ "hile settin' the necessary para eters so that FIX data*ase and !I can e(chan'e infor ation on this ta' T0 on node $0 of data type F0 an error occurred% The type of error is indicated in the essa'es prior to this one% If the error is not due to net#or, pro*le s0 the point #ill not *e added to the scan 'roup and #ill not *e scanned *y the interface% @4e"ove, ta70 J/- T- FM@ Ta' T *elon'in' to node $0 and of type F0 has *een re o&ed fro scan% @2nreco7niQe, state GxxxxI in (Multistate) i7ital ta7 J/- T- FM@ !I4;DA list of ta's to anual for definition
Ta' T on $ode $ contains a &alue not defined in the !I di'ital set for this ta'% /Anode na e0 TAta' na e0 FAdata type @*isn9*utsna*shotx() returne, result D after rea,in7 xxxx fro" 3 ' nft J/-T-FM@ An atte pt to put the strin' &alue in FIX to !I snapshot failed durin' scan routine% D A !I4 A!I error code% xxxx A the current strin' &alue for ta' T% / A node na e% T A ta' na e0 F A data type% !I4A!I function pisn>putsnapshot(() adds an array of ne# e&ents to the !I syste snapshot% ;rror codes are+ -GG1 $ot i ple ented
#8
456 5oft"are+ 6nc.
-50000 -50?00
Success0 *ut so e points had errors $o data pro&ided
This error indicates that read operation for the ta' failed0 due to reasons other than net#or, failure% @*isn97etsna*shotx() returne, result D after atte"*t to 7et strin7 value fro" ta7 T@ An atte pt to 'et the strin' &alue to #rite to FIX fro routine% ;rror codes are+ -GG1 -GGL -15010 $ot i ple ented Me ory allocation error 5alue truncated ta' T8 !I snapshot failed durin' output
See 8pisn>'etarc&alues(() returned result O after atte pt to 'et strin' &alue fro
@*isn97etarcvaluesx() returne, result D after atte"*t to 7et strin7 value fro" ta7 T@ An atte pt to 'et the strin' &alue to #rite to FIX fro routine% ;rror codes are+ 100 :0 -1 -GL? -GL5 -GG1 -GG? -GG5 -GGL -110-G -15010 (other than .22) Syste !oint not found In&alid function code In&alid archi&e $ot i ple ented In&alid *siHe In&alid count Me ory allocation error In&alid ti esta p 5alue truncated ode (co pressed data or e&enly4spaced data) !I archi&e failed durin' output ore &alues)
All &alues ha&e *een returned (no error
The !I4;DA interface 'ets e(ception reports fro !I for input ta's tri''ered *y e&ent ta's and for output ta's% "hen the interface is notified of an e&ent in the snapshot0 it also recei&es a ti esta p for that e&ent in the snapshot% Co#e&er0 the A!I function pisn>e& e(ceptions0 #hich is used to 'et the e(ceptions0 cannot handle !I3 e(tended data types% This interface handles strin's% Thus0 the strin' &alue is retrie&ed &ia e(tended A!I calls% First0 pisn>'etsnapshot(() is called to 'et the current snapshot &alue and ti esta p% The &alue in the snapshot ay or ay not *e the actual &alue #ritten0 i%e% if the (!I output) ta' #as #ritten #ith a ti esta p earlier than the ti esta p in the snapshot (this #ould happen if the source ta' had an e&ent (e(ception) and ti e lapsed since then and #hen pisn>'etsnapshot(() is called)0 then that &alue is not in the snapshot0 *ut in the archi&e% So0 the &alue has to *e retrie&ed fro the archi&e for this ti esta p% @2n8nown ,ata t!*e for ta7 J/- T- FM@ The data type for this ta'0 specified *y F0 is not a ,no#n FIX data type%
10!15!200# 03 10 00 .,
#9

@&onnection with no,e / reesta)lishe,@ FIX #as restarted on node $% @.alue of +I ta7 for FIX ta7 J/- T- FM out of ran7e. I7nore,.@ The di'ital state of !I output ta' is out of ran'e for the correspondin' FIX ta' T% This &alue is thro#n out and the ta' recei&es FAIB;D status% @2nsu**orte, t!*e for FIX ta7 J/- T- FM@ Sa e as 81n,no#n data type for ta' Y$0 T0 FZ8 e(cept that this essa'e is printed *y a #rite routine0 #here as 81n,no#n data type for ta' Y$0 T0 FZ8 is printed *y a read routine% @ river shut,own@ Interface cleanup routine called *efore the interface e(its% For FIX 3 ' 3rrors- consult Intellution 3 ' "anual.
50
456 5oft"are+ 6nc.
'""endix C Messa&e *o&&in&

The FIX DMACS interface pro&ides e(tensi&e run4ti e operation lo''in' facilities% The lo''in' facility pro&ides the follo#in' capa*ilities+ Multiple detail le&els+ lo#0 ediu 0 hi'h0 none0 allL
A forced #rites option that0 #hen ena*led0 co its all data to the dri&e after each #rite (slo#s the process si'nificantly)% That is0 this option forces the lo' file to *e closed after each #rite% A screen lo''in' option that #ill echo the lo' entries to the consoleL A*ility to append or o&er#rite e(istin' lo'L Circular lo' file for at #ith selecta*le siHe (only if 6$0 see *elo#0 is true)L and A co on lo' file &ie#er for "indo#s=3 and "indo#s $T%
The circular lo' file al'orith allo#s (#hen the lo' file is opened #ith 6$true option) the user to put a a(i u li it to the lo' file siHe% "hen the a(i u li it for lo' file siHe is reached the oldest essa'es #ill *e o&er#ritten in the lo' file as ne# essa'es co e in%
*o&&in& Confi&uration
These options can set or selected usin' a lo''in' confi'uration file% The confi'uration file is a te(t file #ith a 8loose8 for at0 that is0 only lines *e'innin' #ith a inus si'n (4) are treated as para eters0 and all para eters are case4insensiti&e% Any para eters not included in the file #ill *e set to the default &alues% The follo#in' para eters are supported+ 4F 4D 4B 4M 4$ A forced #rites0 either T71; or FABS;0 defaultAFABS; A detail le&el0 2 to = (see ta*le later in this appendi() defaultAB9:>M;DI1M A lo'file na e0 re)uired A a( lo'file siHe0 in *ytes0 defaultA322222% This is also the ini u lo' file siHe% If the specified file siHe is s aller than 322222 *ytes0 it #ill *e i'nored% A start ne# file0 either T71; or FABS;0 defaultAT71;% "hen this is set to FABS; essa'es #ill *e appended to the lo' file lea&in' the older essa'es intact% If this is set to False0 4M s#itch #ill ha&e no effect% A ena*le screen lo''in'0 either T71; or FABS;0 defaultAFABS;% This option has no effect if the interface is run in ser&ice ode%
4S
There are no li its on the siHe or filena e of the confi'uration file% A sa ple confi'uration file is sho#n *elo#% $ote that for 6B option0 the full path ust *e 'i&en% MM /et log le%el to LN6!$EDIC$ -D? MM /et log file&a,e
10!15!200# 03 10 00 .,
51

-Lc:0te,*0te)t.log MM E&able )c'ee& loggi&g -/t'2e MM /et ,a( logfile )iKe to 10O -$10?-0
52
456 5oft"are+ 6nc.
'""endix # FI% to PI Confi&uration ransfer Utilit$

O!er!iew
A utility is pro&ided to transfer confi'uration infor ation contained in the FIX ;DA data*ase to ta's in the !I Data archi&e% This utility ust *e considered as an aid rather than a total solution for confi'urin' the !I Data Archi&e to #or, #ith the FIX ;DA data*ase% The utility is a co and line pro'ra called 8FIXTo!I%e(e8% The utility transfers the confi'uration infor ation of the acti&e ra# data points in the FIX data*ase0 and for ats the in a te(t file of appropriate co ands for entry into the piconfi' pro'ra % The te(t file is na ed 8FIXTo!I%scr80 and it ay *e utiliHed in either of t#o #ays% The first ethod is to run the piconfi' utility #ith input redirected fro this file% The second ethod is to use the WI$!1T co and of the piconfi' utility% The confi'uration transfer utility is desi'ned to transfer infor ation contained in Analo' Input0 Analo' 9utput0 Analo' 7e'ister0 Di'ital Input0 Di'ital 9utput0 Di'ital 7e'ister0 and Multiple Di'ital Input *loc,s% If you #ish to archi&e infor ation contained in other than those *loc,s0 this ust *e done anually% In addition0 the 87e'ister8 type *loc,s are confi'ured as !I input points and thus #ill *e read *y the interface instead of *ein' a*le to #rite to the 7e'isters% If the client #ishes to confi'ure 87e'ister8 type *loc,s as !I output ta's0 the ta' ust *e edited anually in piconfi'% The utility ust *e run on a FIX SCADA node0 as it uses FIX functions that #ill not #or, on a si ple 5I;" node% The pro'ra is desi'ned to *e fle(i*le0 allo#in' the transfer of all the infor ation contained for the a*o&e type *loc,s as a default0 and allo#in' the user to restrict that transfer in a anner of the userIs choosin'% The user can choose to allo# the pro'ra to transfer confi'uration infor ation fro the SCADA node that the utility is runnin' on and all the attached SCADA nodes0 or he can choose to restrict it to any su*set of those nodes% Ce can choose to allo# it to transfer all ta's of the types descri*ed a*o&e0 or he can restrict that to any su*set of those types% Ce can choose to allo# transfer of all ta's on the specified nodes0 or he can e(clude certain ta'na es *ased on a si ple pattern4 atchin' sche e% Ce can also choose to only include ta'na es that atch a particular pattern% The pattern4 atchin' sche e is si ple 4 it is the one used in MS4D9S to atch filena esL the I[I character atches any character0 the IJI
10!15!200# 03 10 00 .,
53

character atches all characters fro that point on0 and any other character is an e(act that the pattern atchin' is case sensiti&e0 so 89$;8 is not the sa e pattern as 8one8% atch% !lease note
The utility creates a uni)ue di'ital set for each uni)ue di'ital set in FIX #hen *uildin' the file to create the !I ta's% The di'ital set na es assi'ned to the di'ital sets all start #ith the prefi( d FIXds% The suffi( XXXX is app e n d e d #her e XXXX is a &alue fro 222 2 to ====% The first di'ital set #ill *e na e d d FIXds22 2 2 0 the seco n d di'it al set #ill *e na e d d FIXds2 2 2 . 0 etc% The user should edit the di'it al stat e set na e s in the file #her e appro p ri a t e % All di'ital output ta's are assi'ned a source ta' #ith the sa e na e as the ta' ta e% This should *e edited and the appropriate source ta' na e used%
5#
456 5oft"are+ 6nc.
User Instructions
The for at of the co and line for usin' the utility is+
FIXTo!I /pAPpointsourceQ Y/nAPnodeQ Y/nAPnodeQUZZ Y/tAPtypeQ Y/tAPtypeQ UZZ Y/IAPinclude patternQ Y/IAPinclude patternQ UZZ Y/eAPe(clude patternQ Y/eAPe(clude patternQ UZZ The para eters are+ /p The !I point source that you #ould li,e these points to ha&e% This is a re)uired para eter0 and if not included0 the pro'ra done /n (optional) a na e of a node% This para eter type is specified0 the pro'ra on #hich the pro'ra /t is runnin' ay *e repeated for each ay *e repeated for each node that the user #ishes to include in the list of nodes% If no para eter of this achine defaults to all nodes accessi*le *y the #ill e(it #ith nothin'
(optional) a na e of a *loc, type% This para eter
*loc, type that the user #ishes to include in the list of *loc, types% These can *e any of 8AI808A9808A7808DI808D9808D7808MDI0 8AA80 8DA8% If no para eter of this type is specified0 the default is to include all the a*o&e in the list of types /e (optional) a pattern to atch to the FIX *loc, na e to e(clude fro ay *e repeated for each pattern the confi'uration transfer% The para eter utility atte pts to
the user #ishes to e(clude% If any of these type of para eters appears0 the atch each *loc, na e as encountered0 and if the pattern atches A$M of the atch succeeds0 the confi'uration infor ation is $9T transferred% If ultiple patterns are included0 if the *loc, na e /I confi'uration (optional) a pattern to infor ation% This para eter patterns0 the confi'uration infor ation is $9T transferred atch to the FIX *loc, na e to transfer ay *e repeated for each pattern that the user
#ishes to include% If no para eter of this type is specified0 the default is to include all the ta's #ith the e(ception of the a*o&e e(clude list% If one or ore of these para eters are included0 the confi'uration atches any of the Infor ation is transferred for any *loc, #hose na e !atterns in the list%
10!15!200# 03 10 00 .,
55

/ote0 ;(clude processin' is done *efore include processin'0 and therefore0 if a *loc, na e atches the pattern of so ethin' on the e(clude list0 it #ill not *e su*Kected to include list processin'% ;(a ples+ FIXTo!I /pA; /nASCADA. Transfer all ta's on node SCADA. FIXTo!I /pA: /tAA9 /tAAI /tAA7 Transfer all the analo' points for all connected SCADA nodes FIXTo!I /pA( /IAIJ /IATJ /nAB9CAB /tADI Transfer the Di'ital Input *loc, infor ation on node 8B9CAB8 #hose na es *e'in #ith the letters III or ITI FIXTo!I /pA, /eA.[[CCRJ Transfers all confi'uration infor ation of all *loc,s on all connected nodes e(cept for the *loc,s #ith na es containin' a I.I as the first character0 anythin' in the ne(t t#o characters0 8CCR8 as the ne(t three characters and anythin' after that% 9nce the 1tility has *een run0 the user should first edit the file FIXTo!I%scr prior to creatin' the !I ta's and di'ital sets% The follo#in' e(a ple output sho#s the file that #ill *e created in order to create a !I ta' for each FIX point type% FIX Ta' $a e AI. A9. A7\ DI. D9. D7. MDI. AA. DA. FIX !oint Type AI A9 A7 DI D9 D7 MD AA (supported *ut not sho#n) DA (supported *ut not sho#n)
56
456 5oft"are+ 6nc.
The output fro
the utilities is+
Ptable *id) P,ode c'eate, t Pi)t'2ct2'e )et,)tate,... d, IXd)0000,NPEN,"LN/E d, IXd)0001,NPENCP,"LN/ECP d, IXd)000?,)tate0,)tate1,)tate?,)tate5,)tate-,)tate5,)tate4,)tateF Pe&d)ectio& Ptable *i*oi&t P*tcla)) cla))ic P,ode c'eate, t Pi)t'2ct2'e tag,*oi&t)o2'ce,de)c'i*to',*oi&tt8*e,digital)et,*tacce)),dataacce)),a'c+ i%i&g,)ca&,i&)t'2,e&ttag,locatio&1,locatio&?,locatio&DA#ID:DI1,E,Digital I&*2t 1,Digital,d, IXd)0000,o:'3 g:'3 3:'3,o:'3 g:'3 3:'3,1,1,9DA#ID,DI1,D!"#9,1,0,1 DA#ID:DN1,E,Digital N2t*2t 1,Digital,d, IXd)0001,o:'3 g:'3 3:'3,o:'3 g:'3 3:'3,1,1,9DA#ID,DN1,D!"#9,1,1,1 DA#ID:D>1,E,Digital >egi)te' 1,Digital,d, IXd)0000,o:'3 g:'3 3:'3,o:'3 g:'3 3:'3,1,1,9DA#ID,D>1,D!"#9,1,0,1 DA#ID:$DI1,E,,Digital,d, IXd)000?,o:'3 g:'3 3:'3,o:'3 g:'3 3:'3,1,1,9DA#ID,$DI1,$!"#9,1,0,1 Pe&d)ectio& Pi)t'2ct2'e tag,)o2'cetag DA#ID:DN1,DA#ID:DN1 Pe&d)ectio& Ptable *i*oi&t P*tcla)) cla))ic P,ode c'eate, t Pi)t'2ct2'e tag,*oi&t)o2'ce,de)c'i*to',*oi&tt8*e,Ke'o,)*a&,t8*ical%al2e,e&g2&it),e(c de%,e(c,i&,e(c,a(,co,*de%,co,*,i&,co,*,a(,*tacce)),dataacce)),a'c+i%i&g, co,*'e))i&g,)ca&,i&)t'2,e&ttag,locatio&1,locatio&?,locatio&DA#ID:AI1,E,A&alog I&*2t 1, loat5?,0.000000,100.000000,50.000000,,1.000000, 0, 400, ?.000000, 0, ?LL00,o:'3 g:'3 3:'3,o:'3 g:'3 3:'3,1,1,1,9DA#ID,AI1, !"#9,1,0,1 DA#ID:AN1,E,A&alog N2t*2t 1, loat5?,0.000000,100.000000,50.000000,ao1,1.000000, 0, 400, ?.000000, 0, ?LL00,o:'3 g:'3 3:'3,o:'3 g:'3 3:'3,1,1,1,9DA#ID,AN1, !"#9,1,1,1 DA#ID:A>1,E,A&alog >egi)te' 1, loat5?,0.000000,100.000000,50.000000,,1.000000, 0, 400, ?.000000, 0, ?LL00,o:'3 g:'3 3:'3,o:'3 g:'3 3:'3,1,1,1,9DA#ID,A>1, !"#9,1,0,1 Pe&d)ectio& Pi)t'2ct2'e tag,)o2'cetag DA#ID:AN1,DA#ID:AN1 Pe&d)ectio&
10!15!200# 03 10 00 .,
57

Pb8e
9nce the editin' has *een done0 the last step is to utiliHe the te(t file 'enerated *y this utility to 'enerate ta's in the !I Data Archi&e itself% There are t#o ethods of doin' this% The first in&ol&es standard input redirection0 #hich eans that you run the piconfi' utility *ut instead of acceptin' input fro the ,ey*oard0 you redirect that input so that it co es fro the file% !iconfi' P FIXTo!I%scr The second #ay of utiliHin' this file is to use the WI$!1T co co and set% To do this0 start the piconfi' utility+ !iconfi' Then0 at the co and pro pt0 enter the co and WI$!1T follo#ed *y the file na e+ and of the piconfi'
(Bs 4 ) !Iconfi'QWI$!1T FIXTo!I%scr In *oth cases0 ensure that you prepend the correct path infor ation if this file is not in the current su*directory% /ote0 FixTo+I utilit! is not a ta7 auto6s!nchroniQation *ro7ra". :nce it is run an, chan7es are "a,e later in FIX *oint ,ata)ase- it is the userFs res*onsi)ilit! to chec8 that the chan7es are still co"*ati)le with +I *oint attri)utes an, if necessar! +I *oint ,ata)ase is a**ro*riatel! "o,ifie,.
58
456 5oft"are+ 6nc.
/e!ision Histor$
Date 10/21/97 10/22/97 11/11/97 11/12/97 01/23/98 04/09/98 04/15/98 05/13/1998 06/16/98 07/17/98 08/08/98 08/08/98 %ut!or =4 =4 %= %= %= %= C>D %= 42O E. E. E. Comments >i &t d aft >i &t #e &ion e#ie+ed %ata t1pe e#i&ion& .oca$ fai$u e detection 2dded confi"u ation t an&fe uti$itie& Off$oaded 9T> component& to ;3%e&c fie$d in /I !e-added uti$it1 info f om #e &ion 1-3 manua$2dditiona$ info mation on &t in" ta"& >i3ed ta*$e of content&0 pa"e num& +e e a$$ $i&ted a& 0 9oted c,an"e& &ince #e &ion 1-46o ected de&c iption& in /. &+itc, and $o""in" ta" &ection&%e$eted .o""in" Ta" &ecion- =odified /. de&c iption to ef$ect t,e c,an"e in code +,ic, cau&e& t,e inte face to a*o t in&tead of ,an"in" (#1-8)6o ected t,e e o in manua$& up to #e &ion 1-8-2 e"a din" t,e de$imito afte e#entB3333 ent 1 in t,e /I e3tended de&c ipto - 9o+ *ot, F0@ and FG@ a e a$$o+ed to end 9O%; name and >I;.% name- 4o+e#e 0 a comma mu&t &ti$$ *e u&ed to end e#ent ta" name2dded a mo e detai$ed me&&a"e $i&t unde T ou*$e&,ootin" &ection- 2dded comment& on added featu e& (optiona$ $oca$ &e #e time &+itc,)2dded de&c iption& of en,ancement featu e&=odified e3p$anation fo eda e o 1212- Inc$uded de*u" &1m*o$ in&ta$$ation in&t uction&- 2dded de&c iption& of mo e de*u" &+itc,e& in command $ine2dded e3p$anation fo ne+ data t1pe &uppo t (>I? f$oat to /I di"ita$ mappin") 2dded >I? edundanc1 info mation6o ected .ocation1 an"e f om 1 to 99 to 0 to 982dded mo e comment& a*out u&e 'ueue in /'n &ection
09/10/98
E.
12/3/98
E.
03/29/99 04/15/99
E. E.
08/03/99 01/25/00 07/03/00 07/28/00
E. E. E. E.
10!15!200# 03 10 00 .,
59
60
456 5oft"are+ 6nc.

PI IntFix 2.0.1+

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

PI IntFix 2.0.1+

Uploaded by

Copyright:

Available Formats

Intellution Fix DMACS (FIX32) / Dynamics (iFIX) Interface to the PI System

ersion 2!"!# or $reater

OSI Software, Inc.

456 5oft"are+ 6nc.

6ntellution Ci7 =,:95 6nterface =ocumentation

456 5oft"are+ 6nc.

Su""orted #ata $"es

6ntellution Ci7 =,:95 6nterface =ocumentation

)eneral PI a& Confi&uration Infor(ation

456 5oft"are+ 6nc.

I"*ortant notes for event6"essa7e ta7s+

6ntellution Ci7 =,:95 6nterface =ocumentation

456 5oft"are+ 6nc.

6ntellution Ci7 =,:95 6nterface =ocumentation

456 5oft"are+ 6nc.

In"ut a& Confi&uration

Perfor(ance and .#' Usa&e

6ntellution Ci7 =,:95 6nterface =ocumentation

Out"ut a& Confi&uration

'dditional PI, Confi&uration

456 5oft"are+ 6nc.

#i&ital State Code

6ntellution Ci7 =,:95 6nterface =ocumentation

Hardware and Software

Interface Hardware /e0uire(ents

456 5oft"are+ 6nc.

Startu" Co((and File

6ntellution Ci7 =,:95 6nterface =ocumentation

456 5oft"are+ 6nc.

6ntellution Ci7 =,:95 6nterface =ocumentation

456 5oft"are+ 6nc.

6ntellution Ci7 =,:95 6nterface =ocumentation

FI% #M'CS Interface Installation

456 5oft"are+ 6nc.

"ithout Dufser&+ PI-EDA# -i&)tall -de*e&d tc*i* "ith Dufser&+

6ntellution Ci7 =,:95 6nterface =ocumentation

456 5oft"are+ 6nc.

o run in interacti!e (ode

o Install #ebu& S$(bols

6ntellution Ci7 =,:95 6nterface =ocumentation

456 5oft"are+ 6nc.

FI% #M'CS Interface S$ste( 'd(inistration

Manual Ser!ice Startu"

and is used0 a ne# MsDos #indo# is created%

Sto""in& the FI% #M'CS Interface

6ntellution Ci7 =,:95 6nterface =ocumentation

Status, Warnin&, and .rror Messa&es

456 5oft"are+ 6nc.

6ntellution Ci7 =,:95 6nterface =ocumentation

FI% /edundanc$ and Pi2eda

FI%4, 5iew 1ode

Clic, on #onfigure - *utton and 'et the follo#in' screen%

456 5oft"are+ 6nc.

;nter the *ac,up node na e for this re ote SCADA node%

6ntellution Ci7 =,:95 6nterface =ocumentation

FI%4, Pri(ar$ SC'#' 1ode

456 5oft"are+ 6nc.

Then in #onfigure+Networ, dialo'ue0

FI%4, Bac3u" SC'#' 1ode

6ntellution Ci7 =,:95 6nterface =ocumentation

FI%4, 5iew 1ode6s 1etwor3 Status #is"la$

FI%4, 1ode 7winnt7s$ste(4,7dri!ers7etc Host File

PI a& Confi&uration for FI%4, a&

"ithout Dufser&+ PI-EDA# -i&)tall -dee&d tci* "ith Dufser&+