GE CIMPLICITY - OSIsoftcdn.osisoft.com/interfaces/1014/PI_GECimpi_1.2.8.doc · Web viewCIMPLICITY...

GE CIMPLICITYInterface to the PI System

Version 1.2.x2.8 and greater

PI-IN-CIMPI OSI Software, Inc.

How to Contact UsPhone (510) 297-5800 (main number)

(510) 297-5828 (technical support)

Fax (510) 357-8136

Internet [email protected]

World Wide Web http://www.osisoft.com

Bulletin Board (510) 895-9423Telebit WorldBlazer modem (Hayes, MNP, or PEP compatible)8 data bits, 1 stop bit, no parity, up to 14400 BPS downloadprotocols: Xmodem, Ymodem, Zmodem, Kermit

Mail OSI Software, Inc.P.O. Box 727San Leandro, CA 94577-0427USA

OSI Software GmbH Hauptstrae 30 D-63674 Altenstadt 1Deutschland

OSI Software, LtdP. O. Box 8256Level One, 6-8 Nugent StreetAuckland 3, New Zealand

Unpublished—rights reserved under the copyright laws of the United States.RESTRICTED RIGHTS LEGEND

Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph ©(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013

Trademark statement—PI is a registered trademark of OSI Software, Inc. Microsoft Windows, Microsoft Windows for Workgroups, and Microsoft NT are registered trademarks of Microsoft Corporation. Solaris is a registered trademark of Sun Microsystems.

HP-UX is a registered trademark of Hewlett Packard Corp. IBM AIX RS/6000 is a registered trademark of the IBM Corporation. DUX, DEC VAX and DEC Alpha are registered trademarks of the Digital Equipment Corporation.

document.doc

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

mailto:[email protected]

http://www.osisoft.com/

Table of ContentsOverview....................................................................................................2

PI Point Definition.......................................................................................5

General PI Tag Configuration Information...............................................5Additional PI2 Configuration....................................................................8

Conversion of configuration data................................................................9

Hardware and Software............................................................................10

Interface Software Requirements..........................................................10Interface Hardware Requirements.........................................................10

Principle of Operation...............................................................................11

Startup Command File.............................................................................13

CIMPI Interface Installation......................................................................18

NT-Intel Installation Disk File List..........................................................18Installation Procedure............................................................................18

CIMPI Interface System Administration...............20

Running the Interface as a Service.......................................................20Running the Interface Interactively........................................................21CIMPLICITY Security Configuration......................................................22Status, Warning, and Error Messages...................................................24

OSI Software, Inc. 1

GE CIMPLICITY Version 1.2.x Interface to the PI System

OverviewThe CIMPLICITY HMI Interface (PI-CIMPI) provides the transfer of data between “GE Fanuc CIMPLICITY” version 4.01 and higher and the Plant Information (PI) System. A different version of the interface is required for Cimplicity HMI version 5.5 than for the earlier versions. The interface runs on a Windows NT Workstation or Server.The interface reads data from one or multiple CIMPLICITY servers and sends them to the PI server. It may be located on the PI server or one of the CIMPLICITY servers or – most typically – a node of its own. The node the interface runs on is called the interface node in this document. If the interface is running on a node apart from the PI server, this node is also called a pure interface node.The interface can be configured to either use a change driven mechanism to get the new values from the CIMPLICITY system, or it can scan the values at regular intervals. Outputs are written when the PI source point changes value.

Note: The interface can be run in multiple copies. A convenient and highly recommended configuration is running one copy of the interface for each CIMPLICITY project used. This is recommended because sometimes, when one CIMPLICITY project is stopped while others continue running, the interface exits.

Supported Features

Platforms NT-Intel

PI Point Types Float16 / Float32 / Float64 / Int16 / Int32 / Digital / String

Subsecond Timestamps Yes

Subsecond Scan Classes No

Automatically Incorporates PI Point Attribute Changes Yes

Exception Reporting Done by Interface

Outputs from PI Yes

History Recovery No

*Failover No (see notes)

Inputs to PI: Scan-based / Unsolicited / Event Tags Scan-based or Unsolicited

Uniint-based Yes

Maximum Point Count Unlimited

SDK No

*Vendor Software Required on PI API node Yes

Vendor Software Required on DCS System No

Vendor Hardware Required No

*Additional PI Software Included with Interface Yes

Scaling Yes. That is, values of EU-converted Points in Cimplicity will be sent to PI also as converted values*.

2 OSI Software, Inc.

* Note: Further explanation below.

FailoverThe CIMPLICITY system supports a failover mechanism, and the interface is able to continue operation after a CIMPLICITY failover, but the interface does not have a separate failover mechanism.

Vendor Software Required on PI-API NodeThe interface requires that the CIMPLICITY Point Management API be installed on the PI-API node. This provides the functions required by the interface to access the CIMPLICITY database. To install the CIMPLICITY Point Management API, a minimal installation of the CIMPLICITY HMI is required.

Additional PI Software Included with InterfaceThe OSI Interface Control Program is included, but is not required by the interface. Please refer to the “OSI Interface Control Program” manual for more information.

Source of TimestampsThe source of timestamps is configurable for the interface. The source can be the CIMPLICITY system, the PI server or the CIMPLICITY “adjusted” to approximate the PI server time.

The following diagram illustrates the architecture of the interface. The interface communicates to CIMPLICITY via CIMPLICITY Point Management API calls. It makes internal use of the PI-API-NT in order to keep a standard way of interfacing from a client node to the PI Server Node.




PI Point DefinitionThe purpose of PI point definition is to map the PI tag to a field within the CIMPLICITY system and to instruct both the interface and the PI system on how to handle a particular tag.

General PI Tag Configuration InformationOne PI point (PI tag) must be configured for each CIMPLICITY point that the user wants to read from or write to. The points must be configured in the PI database. The following describes the PI point configuration field names that have specific meaning for use with the PI-CIMPI interface. For more information on PI Point configuration see the PI Data Archive Manual for Windows NT and UNIX. The CIMPLICITY HMI supports complex data types such as arrays and structures. The PI system does not support this type of data, however; so the interface maps a single element in a complex CIMPLICITY point to a single PI point. Therefore, several PI points may be configured to read the elements of a single CIMPLICITY point. Note: Writing to complex CIMPLICITY data types is not supported by the interface. Outputs can only be written to simple data types (Real, Integer, Boolean and String).The field names in the table below are those of the Data Archive Manual for PI3.

PointSourceThe PointSource is a single, unique character that is used to identify the PI point as a point that belongs to a particular interface. All points to be used by the PI-CIMPI interface must share a common point source (for example, ‘I’). Note that the character ‘C’ is reserved for Performance Equations Subsystem. You should therefore avoid using ‘C’ as the point source for this interface. If you do, you must change the default point source character for the Performance Equations Subsystem.

InstrumentTagThis field contains the exact CIMPLICITY point id. Do not use fully qualified point ids (like \\project\pointid) here. The interface generates fully qualified point IDs using location 2 and the instrument tag.

PointTypeThe interface supports Float16, Float32, Int16, Int32, Digital and String point types. It performs the following CIMPLICITY to PI data type conversions:

CIMPLICITY Data Type

PI Point Type REAL INT(a) BOOL BITS(b) STRING Others

Int16 Yes(c) Yes - - - -

Int32 Yes(c) Yes - - - -

Float16 Yes Yes(d) - - - -

Float32 Yes Yes(d) - - - -

Digital - Yes Yes Yes(e) Yes(f) -

String - - - - Yes -

(a) USINT, UINT, UDINT, SINT, INT, DINT(b) BYTE, WORD, DWORD(c) Rounded



(d) If a conversion to real is defined for a point (engineering unit conversion), the interface makes use of it. Such a point (EU conversion point) must be defined as a float point in PI, or else the raw value will be sent to PI.

(e) The extended descriptor is used to specify the bit number (see below).(f) Certain restrictions apply. See below.

For CIMPLICITY strings that are converted to PI digital tags, certain restrictions apply. For PI2 systems, all such tags must refer to the same digital start code and range. For PI3 systems, they must utilize the same digital state set. The interface looks at the first 12 characters in the string. If these characters match one of the digital states defined for the tag, the value of the tag will be this state. If, however, the string does not match a digital state, the value of the tag will be the state corresponding to the digital start code. The first state could therefore be called “unknown state.” If you change the digital state set or table after starting the interface, you must stop and restart the interface.For CIMPLICITY string tags that are defined as PI string tags also, the first 80 characters are sent to PI.

If the CIMPLICITY point referenced is a complex type (array, structure or bitstring), the component of the CIMPLICITY point to which the PI tag refers is selected in the extended descriptor (see the description of the extended descriptor below). Only one level of selection is supported.

Location1This parameter is used to specify the interface number, which corresponds to the /id=# flag in the CIMPI.bat file. Valid interface numbers are integer values 1 to 99, inclusive.

Location2This parameter specifies the CIMPLICITY project to which the point belongs. It is a number that refers to one of the /project=<project_name> flags in the CIMPI.bat file. It specifies the particular command-line parameter by the order in which it appears in the command line. For example, if the following is a part of the CIMPI.bat command-line,/project=CIMPIP1 /project=CIMPIP2 /project=CIMPIP3all tags in the project CIMPIP1 should have Location2 set to 1; all tags in CIMPIP2 should have Location 2 set to 2; and all tags in CIMPIP3 should have Location2 set to 3.

Location3This parameter specifies whether the point is input or output.= 0 input= 1 outputIf the point is an output point, the scan class (defined below) is ignored. Note that points written to the CIMPLICITY system must be “simple” data types. Outputs to arrays and compound point types are not permitted.

Location4Location4 defines the scan class for the PI point. The scan class determines the frequency at which input points are scanned for new values. In particular, this parameter specifies which of the scan classes defined in the startup script of the CIMPI.bat file will be used. Like the Location2 parameter, the value of Location4 is a number corresponding to a particular /f parameter on the command line. If there are 4 /f parameters, setting Location4=3 selects the third one. Note that the first scan class is not used for periodic scanning but for values to be received ‘on change’. The scan rate in this case determines the frequency at which the interface will


check the queue for new values received for the ‘on change’ points and then process these new values. The first scan rate has to be set like the others but should normally be 1 second.The scan class is ignored for output points. A value is sent to the CIMPLICITY system when a new value is received by the PI server.

Location5This parameter is used to specify whether the PI point should receive a scaled value or the raw value. If Location5 is set to 0, the point will receive the raw value. If it is set to 1, the point will receive a scaled value. Note that in order for the point to receive a scaled value its conversion expression and reverse conversion expression (if the conversion is nonlinear) must be configured in the EU_CONV.dat file under the ProjectName\DATA directory.

Exception ParametersIn addition to the standard usage in PI, the excmax attribute is used for a special purpose in this interface. This interface uses this parameter as a specification of time for automatic refresh for tags that change infrequently. Whenever a tag has not been updated for excmax time, a new value is scanned from CIMPLICITY and timestamped with the current PI Server time. An excmax value of 0 is interpreted as the default value 28800.Note that this is a means to recover from a CIMPLICITY problem: When a CIMPLICITY project is stopped (or more generally when there is a disconnection to a CIMPLICITY server or project), CIMPLICITY sends a ‘point unreachable’ value to the interface. This is turned into an ‘I/O Timeout’ for the tag by the interface. CIMPLICITY does not, however, send a new value with a new timestamp after the project is restarted or reconnected. The only way for the interface to detect the resumption of the project is with the automatic refresh feature. Users are therefore encouraged to make use of this feature by selecting appropriate settings for the excmax parameter. The other exception parameters are used normally by the interface as described in the PI Data Archive manual.

ExDescThe Extended Descriptor is used for 2 purposes..Firstly, the extended descriptor can be used to specify a "trigger” tag (for input tags only). When defining a trigger tag for a point, the syntax is as follows.

EVENT=<triggertag>

By specifying a trigger tag, the associated input tag is scanned after an "event" instead of being scanned at the frequency specified in Location4.The second purpose is to specify – in the case of a complex CIMPLICITY point – the unit to make up the value for the PI point. The specifications are done using the following syntax:

BIT=<bit number>ELEMENT=<element number>COMPONENT=<component name>

Complex CIMPLICITY points are bitstrings, arrays or structures. Bitstrings correspond to the data types BYTE, WORD and DWORD. Bit and element numbers counting starts by 0. No spaces are allowed before or after the = sign.



ScanThe Scan field is used by the interface to determine whether or not the tag is to be scanned. This allows the user to turn a tag on or off while the interface is on-line. A Digital state of “Scan off” is written to tags with scan off.

SourceTagIf the point is an output point, the SourceTag parameter defines the name of the PI point that is the source of the value that will be sent to the CIMPLICITY system. The value will only be sent when an event is generated. The outputs are not periodic.

Additional PI2 Configuration

Point SourceOn PI 2 systems, the point source range is specified by selecting the PointSrc option on the PI Menu, choosing a blank field from the point source list, and entering the following location parameter limits. After the limits have been defined, you will be prompted to define the point source for the point source list.

Location 1 Location 2 Location 3 Location 4 Location 5

1 1 0 0 -20000000

99 99 1 99 20000000


Conversion of configuration dataCIMPLICITY HMI includes a utility to import and export point configuration information to and from .csv or text files. Therefore it is possible to export the point configuration to a .csv file and use this file as the basis for the PI Tag Configurator in Excel. The following CIMPLICITY point attributes are needed for PI point configuration: Point ID data type engineering units zero and span (from the high and low limits) optionally array element, bit number or structure component.For PI 2 systems it may be difficult to change CIMPLICITY point IDs to the normally much shorter PI tag names. The full point ID must also be used for the instrument tag name.Another task often found difficult is to define digital states for PI and digital start code (PI 2) or digital set (PI 3) for tags from texts used in CIMPLICITY. It is very useful to have all these texts available in lists.The following is a list of steps typically needed for conversion: group CIMPLICITY points by server: interface number = location 1 group by project: project number = location 2 group by scan frequency or on change: scan class = location 4

group by common event point: ExDesc EVENT=<event point> default data type conversion INT to R, REAL to R, BOOL to D, BYTE to D etc. for all bit strings: ExDesc BIT=<bit number>

for all arrays: ExDesc ELEMENT=<element number>for all structures: ExDesc COMPONENT=<component name>

take over engineering units, point id (to tag name and instrument tag) take over zero, take over or calculate span set for groups of points: exception specs, compression specs



Hardware and SoftwareInterface Software Requirements

The interface requires that the CIMPLICITY Point Management API is installed on the interface node. This provides the mechanisms required by the interface to access the CIMPLICITY database. While it is possible for the interface to be installed directly on CIMPLICITY host, for reasons of redundancy or performance, this may not be the best solution. For larger systems, it is recommended that the interface node be run as an independent host (a pure interface node).

Interface Hardware RequirementsNo special hardware is required for the interface. Use the standard sizing guidelines for the CIMPLICITY and PI systems.


Principle of OperationStartupAt startup, the interface checks all command line parameters. If one of them is out of range, the interface generates an error-message and stops. If the parameters are all right, the interface runs the initialization part. The first step is to open a connection to the PI Server in order to be able to retrieve necessary tag information.After successful connection to the PI Server, the interface runs the initialization to the CIMPLICITY point management API. If CIMPLICITY is not running or not ready, the interface will stop with an error message.

Point ConfigurationAfter successful startup the configuration phase is started. The interface retrieves the all the points belonging to the specified point source from the PI server. If the point’s interface number (location1) matches the interface number specified at startup, the point is added to the interface. For each tag it does the following and likewise later on during normal operation if a new tag is created:The interface sets up CIMPLICITY shopping lists for different groups of points. There are shopping lists for “on-change” points, output points and one list for each scan class. According to the definition of the tag, it is added to the appropriate shopping. If a tag is deleted, the interface cancels its shopping list request and removes it. If it is the last one on its shopping list, the list is removed.The interface adds the CIMPLICITY point id to the local database, and extracts the definition of the point.After the configuration phase the interface sets all shopping lists enabled.

Data acquisition - InputNow the interface controls whenever one of the scan periods is due. This includes the on-change ‘scan rate’ which should normally be 1 second. It also controls whenever one of the event tags updates. On such events the input processing of the corresponding shopping list is triggered. The on-change list is treated differently from the scan and event lists. The on-change list will have the new values for any points that changed when it is checked. The scan and event lists must request the latest values and then process the new values when they arrive.For each run for a scan or event list the interface sends the shopping list request and waits for the collection of all results (snapshots). Then it fetches the results (get shopping list) and sends them to PI.

Data acquisition – Input RefreshAt the end of each periodic or on-change scan the interface investigates for a number of points if they have got a value in their last excmax time. If not a snapshot is required for those. A snapshot list is created and all points of the number needing an update added to this. Then the list is sent and CIMPLICITY returns the current value. These values are sent to the PI server with the current time.



Data OutputOn startup, a CIMPLICITY shopping list is created for the output points. All the output points have a setpoint request added to the output list, but all the requests are disabled. When new values need to be sent to the CIMPLICITY system, the setpoint request is modified to contain the new value, and the setpoint request is enabled. All the enabled requests are then sent to the CIMPLICITY system, and the responses are checked for errors.

StopIf the interface is stopped, it terminates orderly to CIMPLICITY (cancel all requests, remove all points, remove all shopping lists, terminate) and exits. It can write a shutdown state to all tags.

FailoverFailover is partly possible and depends of the network architecture. In most case the interface may run on a node by itself. This is a client node to a CIMPLICITY server then and a satellite node to the (PI2 or PI3) PI server. The interface may run on a CIMPLICITY server node and be a satellite node to the PI server. If the PI server is a PI3 running on NT, the interface may also run on the PI server. The PI server and the CIMPLICITY server however at least are expected to be different machines.Failover for the CIMPLICITY servers is part of the CIMPLICITY redundancy concept and is handled by CIMPLICITY transparent to the interface. If the interface loses communications with the CIMPLICITY servers, it will close the link and automatically retry until the projects can be accessed. Points will be retried every 60 seconds.

Failover for the PI server is normally not supported. It requires special means apart from the PI system and interface.Also the interface does not support Failover for the interface node. This functionality is not part of the standard OSI interface design but can be ordered separately. Please contact OSI Software if required.


Startup Command FileThe PI-CIMPI interface requires several command-line arguments for successful execution. For convenience, the arguments are defined in a startup command file called CIMPI.bat. A sample CIMPI.bat file is included on the installation disks. The command line in the CIMPI.bat file must be on a single line and cannot exceed the 255-character limit.

Startup Command File Parameters and Syntax

/ps=x Defines the point source x, where x can be any single character. A corresponding point source must be defined on the PI2 or PI3 home node. This argument is required.

/id=# Defines a unique identifier (#) between 1 and 99 for each version of the interface that is running. The identifier corresponds to location1 of the PI tag definition.

Home node on PI3: /host=x:5450Home node on PI2: /host=x:545Defaults: see right

Defines the node name, x, of the PI home node.Defaults:If the interface is installed on a PI3 home node: /host=localhost:5450If the interface is installed on a client PC and the PI home node is a PI3 system: /host=servername:5450where "servername" should be replaced with the name of the PI3 server.If the interface is installed on a client PC and the PI home node is a PI2 system: /host=servername:545where "servername" should be replaced with the name of the PI2 server.5450 and 545 refer port numbers

/project=x (One required, more optional SHOULD SAY MAX=10, no default) CIMPLICITY project name.

Projects are selected by Location 2 of a Tag. If for example a tag has Location 2=3, then it refers to the 3rd occurring /project=... in the start line of the interface. Location 2 specifies the order number of the /project parameters (starting by 1).

/f=hh:mm:ss Defines the time period in between scans in terms of hours (hh), minutes (mm), and seconds (ss). Several time periods can be defined on a single command line (however, one must be careful not to exceed the 255-character limit of the command line). Location4 determines which time period is used.

/time=FOREIGN

(optional)

(FOREIGN, SERVER, ADJUSTED) This parameter decides what time stamp is used for values received from CIMPLICITY: the time stamp sent from CIMPLICITY (FOREIGN), the time on the PI server when the interface receives the value (SERVER) or the CIMPLICITY time adjusted ‘as good as the interface can find out’ to the PI server time (ADJUSTED). Note that CIMPLICITY returned timestamp is the last time the value changed, not the time the value was scanned by CIMPLICITY. If a tag does not change value for a long time and exception maximum time passes, the corresponding PI tag will start getting PI timestamps regardless of the time option specified by this switch. User needs to be aware that if the tag finally changes value and new timestamp comes in and user specified /time=FOREIGN this new timestamp has to be later than the previously recorded PI timestamp ( at every excmax intervals),




otherwise it will be considered out of order and discarded. If CIMPLICITY server node and the API node are synchronized within the scan frequency of the tag the new value will get through and sent to PI, however.

/subsec[=no]

(optional)

If set to yes, this switch enables subsecond scanning

/stopstat[=Shutdown]

(optional)

Write status on shutdown. Not specifying this parameter at all means writing no status at all. Specifying /stopstat but no value means writing “I/O Timeout”.

/ec=x

(optional)

The /ec flag is used to specify an IORate tag from the iorates.dat file. Example entries from an iorates.dat file are given below:

Tagname1, 1 Tagname2, 2

Where tagname1 and tagname2 can be any legal tag name. The number after the tag name can be between 1 and 33 or between 51 and 200, inclusive. Numbers 34 to 50 are reserved for future use. If /ec=2 is used on the command line for the above iorates.dat file, then the rate (events per minute) at which data is sent to the snapshot will be stored in Tagname2. The rate that is sent to Tagname2 is a 10-minute average (i.e. the total number of events collected by the interface divided by 10 minutes). Therefore the IORate will appear to be zero for the first 10 minutes of interface operation. IORates for individual tags cannot be measured at this time.

The iorates.dat file must be created by hand. The file should be placed in the dat\ directory. The dat\ directory is located in the directory designated by the PIHOME entry in the pipc.ini file. Normally the PIHOME entry points to the c:\PIPC\ directory so that the iorates.dat file will reside in the c:\PIPC\dat\ directory.

Once the iorates.dat file is created, the interface must be stopped and restarted before the interface begins measuring the IORate.

Although the interface will allow multiple instances of the /ec flag to be specified on the command line, the rate will only be nonzero for the first rate tag that is referenced.

/q

(optional)

When this flag is specified, data is queued on the NT system before it is transmitted to the PI home node. Data is sent less frequently but in larger packets. This flag is recommended.

/cimwait=0

(optional)

(0..600000) The wait time in ms for CIMPLICITY to be initialized. If the interface is started manually, CIMPLICITY is expected to be started before. In the case of a reboot and both being started automatically there may be some time needed for CIMPLICITY to be initialized. If the wait time is over and CIMPLICITY is not initialized, the interface exits on error.

/exoncerr=YES

(optional)

(YES or NO) ‘Exit on connection error’. This flag tells the interface if it should exit on an initial connection error to a project. An initial connection error normally means that a project that the interface wants to access for a tag is stopped on interface start. The interface is not able to detect a project start after its own start (it can however come over a project stop and restart after its own start). In order for an interface to catch up the project it must be restarted by operator interaction after the project start.



If exoncerr is true and a project cannot be connected, the interface waits for 1 minute to exit (in order to keep automatic restart tries low). It can be shut down during this time by the user. If exoncerr is false and a project cannot be connected, an operator must look after the start of the project and then restart the interface.

/retrytim=60

(optional)

(0..3600) The time in seconds between retries to connect to a point in the CIMPLICITY database, should the point have failed initialize. (normally caused by a bad connection to the CIMPLICITY project. The default is 60 seconds between retries.

/maxchtim=10000

(optional)

(1..20000) Max time to look for on change results in one try – in ms.

/sctrtim=0

(optional)

(100..10000) Scan try time in ms. This time is used for scans and automatic refresh scans. If this time is 0, the interface requests a scan to CIMPLICITY, waits for a grant and reads all data supplied by CIMPLICITY for this scan. If this value is not 0, the interface requests a scan, does not wait for a grant and tries in /maxsctr loops to get data for all tags in the scan. It waits /sctrtim ms before each try. It exits the loop prematurely when all tags have been covered. According to GE Fanuc the wait for a grant may block the interface in some unusual situations (which has never taken place during tests). On the other hand according to GE Fanuc the ‘several tries solution’ may not to be completely reliable in all situations (but was always during tests).

/maxsctr=1

(optional)

(1..1200) Max scan tries. See the /sctrtim parameter below.

/hibtim=500

(optional)

(100..2000) Hibernation time in ms. This is the time the interface releases the CPU after every ‘internal cycle’ during normal operation (that means after the startup phase).

/maxchlst=1

(optional)

(0..9) Max on change lists. For test purposes only.

/deb=0

(optional)

(0..5) Debug level for interface. The higher the level the more detailed debug information is output.

/datadeb=n

(optional)

(0..9, default=/deb) Debug level for interface at the start of the ‘data phase’, that is after the configuration phase. Used to start with a low level to avoid configuration logs and change to a high level as soon as data acquisition begins.

/output= CIMPI.LOG

(optional)

(no default) Output file name, all messages will be written to that file. If this parameter is not used at all, no output is written. If it is used without a value (just /output) the common log file PIPC.LOG is used. If interface specific log files are used there must be separate ones for different copies.

/lineleng=200

(optional)

(20..200) This is the maximum line length for the log file. Lines are wrapped if they exceed that length.

/logtimfm=1

(optional)

(1,2 or 3) This is the format for the time stamp used in interface specific log files. 1 is abolute timestamp and recommended for product interfaces. 2 is seconds since interface start and can be a




debugging help. 3 is no time stamp.

/interact= NO

(optional)

(YES or NO) ‘Debug output to screen’. For test purposes only.

/select=filename

(optional)

(no default) Select certain tags for debug purposes. You can list up to 10 tags each in a line PITAG=tagname. The first line however selects a mode: With SELECT=DEBUG all tags for this interface are used but for the ones listed in <filename> more information is logged. With SELECT=USE only the ones listed in <filename> are used at all by the interface. The others will be rejected and get no data.

Sample contents of the start-up batch filesThe following is an example startup batch file. This file will start the interface with a point source of ‘I’ and an interface number of 1. It defines one project called CIMPDEMO. The “on-change” points checked for changes every 1 second (first /f=00:00:01), and two period scan classes are defined at 5 seconds (no offset) and 10 seconds (2 second offset). The data will be timestamped using the PI server as the time source. The PI server is the localhost. When the interface is stopped, then state “SHUTDOWN” will be written to points. The debug level is 3, and output is sent to the screen and to a log file called “cimpi.log”.

echo offREM ___________________________________________________REM | |REM | C I M P I 1 . B A T |REM | |REM | Example of a procedure to start CIMPLICITY inter- |REM | face copy 1. Overview of startup parameters. See |REM | the interface manual for a description. |REM | |REM | ps Point source |REM | id Interface number |REM | project CIMPLICITY project name |REM | f Scan class frequency |REM | time (FOREIGN,SERVER,ADJUSTED) Stamp source |REM | host PI Server name and port number |REM | stopstat Status on shutdown |REM | ec Event counter number |REM | cimwait (0..600000) CIMPLICITY init. wait time |REM | exoncerr (YES,NO) 'Exit on connect error' flag |REM | maxchtim (1..20000) Max time on change results |REM | maxsctr (1..1200) Max scan tries |REM | sctrtim (100..10000) Scan try time |REM | hibtim (100..2000) Hibernation time |REM | deb (0..5) Debug level |REM | datadeb (0..5) Debug level after configuration |REM | output Log file name |REM | lineleng (20..200) Max line length for log file |REM | logtimfm (1,2,3) Log file time stamp format |


REM | interact (YES,NO) 'Debug output to screen' flag |REM | select Selection of tags for debug or use |REM | |REM | Edit the call to one line. |REM |___________________________________________________|REM..\interfaces\cimpi1\cimpi1.exe ^

/ps=I /id=1 ^/project=CIMPDEMO ^/f=00:00:01 /f=00:00:05 /f=00:00:10,00:00:02 ^/time=SERVER ^/host=localhost:5450 ^/stopstat=SHUTDOWN ^/DEB=3 /interact=yes /output=cimpi.log

REM ___________________________________________________REM | |REM | E N D O F F I L E |REM |___________________________________________________|REM



CIMPI Interface Installation NT-Intel Installation Disk File List

Disk File List

File Name Description

CIMPI.EXE GE CIMPLICITY interface executable file

CIMPI.BAT Example startup command file

GECIMPI.DOC Interface Manual

ReleaseNotes.txt Release Notes

CPPI_kit.exe OSI Interface Control Program (optional)

Installation notes:The installation can be done on either a PI home node (the node where the PI Data Archive resides) or on a PI API node (a node which communicates to the PI home node across a network). The installation procedure assumes the following:1. You are installing the interface on the C drive. If you are installing the interface on a

different drive than your C: drive, substitute the appropriate drive name in the procedure below.

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

3. You have met the appropriate hardware and software requirements described in section entitled "Hardware and Software" above.

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

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

Installation Procedure1. Create the following directory:

c:\PI\interfaces\CIMPI#\ if running on a PI3 home node or

c:\pipc\interfaces\CIMPI#\ if running on a PI API node

# should be replaced by a number between 1 and 99, inclusive. # should correspond to the interface number that is specified using the /id flag in the CIMPI#.bat file. The user should create one directory for each version of the interface that he or she wishes to implement.

2. Insert the installation disk, and execute the following commands from an MS-DOS prompt:


copy b:\CIMPI.exe c:\PI\interfaces\CIMPI#\CIMPI#.execopy b:\CIMPI.bat c:\PI\interfaces\CIMPI#\CIMPI#.batAs mentioned above, # should correspond to the interface number that is specified using the /id flag in the CIMPI#.bat file.

3. Modify the command-line arguments in your CIMPI#.bat file to customize your interface. For example, ..\interfaces\CIMPI1\CIMPI1.exe /ps=I /id=1 /f=00:00:01 /f=00:00:05 /project=CIMPDEMO /qThe command line must be on a single line and cannot exceed 1024 characters (1 kilobyte). This is a limitation set by the interface, not by the NT Operating system. The command-line arguments are discussed earlier in this manual. Running the interface either manually or as a service is discussed below. Manual startup is recommended the first time the interface is started because manual startup is easier to troubleshoot.



CIMPI Interface System Administration

Running the Interface as a ServiceThe procedure for installing the CIMPLICITY interface as a service depends upon whether or not Bufserv is being used. Once the interface has been installed as a service, the procedure for starting, stopping, and removing the interface as a service is the same whether or not Bufserv is used. The purpose of the Bufserv utility is to continue to collect data from an interface in the event that the PI Data Archive is shut down for some reason. For example, if the CIMPLICITY interface is installed on the PI home node and the PI Data Archive is shut down for an upgrade, the Bufserv utility on the PI home node will buffer the data in a file until the PI Data Archive is brought back online. Another possibility is that the CIMPLICITY interface is installed on an API node. If there are problems with the PI home node, then the Bufserv utility on the API node will buffer the data in a file until the PI home node is brought back online.The procedure for installing the interface in conjunction with the Bufserv Utility assumes that the user has Bufserv 1.04 or higher because the procedure implicitly assumes that Bufserv will be installed as a service. The actual installation of the Bufserv Utility itself is not discussed. For these instructions, the user is referred to the PI-API Bufserv 1.x Release Notes. Also, the installation procedure below does not discuss the details related to shutdown events that the user should be aware of when the Bufserv Utility is used. For more information, refer to the PI-API Bufserv 1.x Release Notes .

To run as a service, complete the following steps:1. One can get help for installing the interface a service at any time by typing the

following:CIMPI# -helpNote that the –query flag that is described when help is invoked is not implemented at this time.The CIMPI# service can be installed either as a manual or an automatic service. Automatic services are started automatically when the NT operating system is rebooted. This feature is useful in the event of a power failure. To install the interface as a manual service, execute the following command from the CIMPI#\ directory.Without Bufserv:CIMPI# -install -depend tcpipWith Bufserv:CIMPI# -install -depend "tcpip bufserv"To install the interface as an automatic service, execute the following command from the CIMPI#\ directory.Without Bufserv:CIMPI# -install –auto -depend tcpipWith Bufserv:CIMPI# -install –auto -depend "tcpip bufserv"Check the Microsoft Windows NT services control panel to verify that the service has been successfully added. One can use the services control panel at any time to change the CIMPI# service from an automatic service to a manual service or vice versa. Once the CIMPI# service has been installed, the rest of the procedure is the same whether or not Bufserv has been implemented. The CIMPI# service can be started from


the services control panel or by executing the following command from the CIMPI#\ directory:CIMPI# -startA message will be echoed to the screen informing the user whether or not the interface has been successfully started as a service. If the service is successfully started, the interface will attempt to read the command-line arguments from the CIMPI#.bat file. For this to succeed, the root name (the part of the file name before the .exe and .bat extensions) of the batch file must be the same as the root name of the executable. Also, the batch file and the executable file must be in the same directory. If the interface is unable to read the command-line arguments or if the command-line arguments that the interface reads are invalid, the service will terminate with no error messages echoed to the screen.For this reason, the user MUST check the pipc.log file to verify that the interface is running correctly. In the pipc.log file, messages pertaining to the CIMPLICITY interface will be prepended by CIMPI #>. The location of the pipc.log file is determined by the PIHOME entry in the pipc.ini file. The pipc.ini file is located in the WinNT directory. Usually, the pipc.log file will reside in the c:\pipc\dat\ directory. If the service was successfully started, the user can verify that the service is still running from the services control panel. If the service has been terminated, the reason for its termination will be given in the pipc.log file. If the service is still running, the user can use c:\PI\bin\apisnap.exe or ProcessBook to verify that data is being successfully transferred to the PI Data Archive.The CIMPI# service can be stopped at any time by issuing the following command:CIMPI# -stopThe CIMPI# service can be removed byCIMPI# -remove

2. If the CIMPI# service is installed as a manual service on the PI home node, the user may wish to edit the c:\PI\adm\pisrvsitestart.bat and the c:\PI\adm\pisrvsitestop.bat command files. These command files are invoked only when the PI data archive is started and stopped as a manual service with the c:\PI\adm\pisrvstart.bat and the c:\PI\adm\pisitestop.bat command files. In the c:\PI\adm\pisrvsitestart.bat file, make sure that the second to last line ends in& wait 5000 If not, append "& wait 5000" to the end of the line. In the same file, add the following command just above ":theend"C:\PI\interfaces\CIMPI#\CIMPI# -start & wait 5000Add the following command to the c:\PI\adm\pisrvsitestop.bat file just above ":theend"C:\PI\interfaces\CIMPI#\CIMPI# -stopNote that the full path name to the CIMPI# executable must be given in both the c:\PI\adm\pisrvsitestart.bat and the c:\PI\adm\pisrvsitestop.bat command files.

Running the Interface Interactively To run in interactive mode, complete the following steps1. Execute the following command from an MS-DOS prompt:

cd c:\PI\interfacesstart "CIMPI#" CIMPI#\CIMPI#.bat A new MS-DOS window will appear, and the user will see several messages echoed to the screen. Then the messages will simply stop. The user will not regain a command prompt on the mdse. window until the interface has been stopped.



To stop the interface type “CONTROL-C” while the MS-DOS window is selected. The user can use c:\PI\bin\apisnap.exe or ProcessBook to verify that data is being successfully transferred to the PI Data Archive.Check whether there are any error messages to verify successful execution of the interface. Messages that are sent to the screen are also sent to the pipc.log file. Check the pipc.log file. Some messages are written to this file that are not echoed to the screen when the interface is started up. Messages in the pipc.log file that pertain to the CIMPLICITY interface will be prepended by CIMPI #>. The location of the pipc.log file is determined by the PIHOME entry in the pipc.ini file. The pipc.ini file is located in the WinNT directory. Usually, the pipc.log file will be placed in the c:\pipc\dat\ directory.

2. If you plan on starting both the PI Data Archive and the CIMPLICITY interface manually, you may wish to start the CIMPLICITY interface along with the PI data archive. To do this you must edit the c:\PI\adm\pisitestart.bat command file (there is no such thing as a c:\PI\adm\pisitestop.bat command file). Make sure that the last line of the c:\PI\adm\pisitestart.bat file ends in:& wait 5000 If not, append "& wait 5000" to the end of the line. In the same file, add the following two commands:echo Starting CIMPI# Interfacestart "CIMPI#" /min ..\interfaces\CIMPI#\CIMPI#.bat & wait 5000

The CIMPI# interface should now be started in interactive mode. The /min flag minimizes the MS-DOS window that is created

CIMPLICITY Security ConfigurationThe CIMPLICITY HMI system includes a security mechanism to enable or disable certain functions. For the interface to run, it must “logon” to the CIMPLICITY system with the privilages to read and write to the point database.Therefore, running the cimpi interface successfully as a service requires that user configures CIMPLICITY project’s security settings correctly. If this is not done properly, no data will be collected, and the interface may hang.


If the “cimpi” service is configured with the following Log On As account (SYSTEM account) then in CIMPLICITY project’s Workbench, under Security/Users, cimpi’s LogOnAs account must be in User ID column. The user account must be enabled, and no password assigned.



Status, Warning, and Error MessagesMessages from the interface can be sent to three places. If the interface is being run interactively then the messages will appear in the MS-DOS window. The messages will also be sent to the pipc.log file and optionally to a specific interface log file (/ouput parameter), depending on the configuration of the startup batch file (see “Startup Command File” on page 13). Two debug levels can be specified. The /deb parameter defines the main debug level and it is used during startup. If the /debdata parameter is defined, then when the data collection starts the debug level will change to that level, otherwise the will remain at the initial level.

Debug levels:0 Start time, interface version, exit time, exit reason.1 User configuration errors.2 Unexpected errors that allow the interface to continue working but may be an

indication of wrong usage or serious problems.3 Main steps, periodic status, periodic statistics.4 Every point configured with tag, every scan with class or event and result, every

hibernation, every remove tag with tag.5 Every point configured with details, every event with details.The interface can normally be run with level 3 for a long time (months). The log file would grow but should not take too much space and should still be of a ‘readable’ size. Look for messages that you get with level 1 or 2. These should be meaningful for you to confirm if the PI and CIMPLICITY point configurations are correct. When the system is stable for a long time and no changes are made you may just run the interface with level 0. In cases of problem analysis it may be necessary to use level 4 or 5. Watch however that you can get tens of thousands of lines within few seconds if you have thousands of points and there are problems or lots of values. Set the level back to at most 3 soon.


ReferencesGE Fanuc Automation, CIMPLICITY HMI for Windows NT and Windows 95,

Base System, User’s Manual, GFK-1180F, October 97GE Fanuc Automation, CIMPLICITY HMI for Windows NT and Windows 95,

Point Management API, Application Developer Guide, GFK-1201C,April 1997

OSI Software Inc., PI2 Data Archive, several versionsOSI Software Inc., PI3 Data Archive, several versionsOSI Software Inc., PI-API, several versionsOSI Software Inc., Uniint End User Interface Documentation, Uniint version 3.2.OSI Software Inc., OSI bufserv, July 1997OSI Software Inc., OSI Interface Control Program, V 2.0, March 1999



Revision HistoryDate Author Comments

7/12/99 KL Added detailed instructions on how to install and run the interface as a service.

1/19/00 KL Added instructions for CIMPLICITY security setting configuration to allow cimpi service to communicate with CIMPLICITY. Cimpi version 1.1.0

3/9/00 KM Added outputs. Re-write documentation

8/7/00 KL Location5 is not used to indicate whether a point is to receive scaled value or not.

4/18/02 DM Info on different versions for HMI 5.5, <=5.0


Date post:	26-Apr-2018
Category:	Documents
Upload:	lamminh
View:	222 times
Download:	0 times

GE CIMPLICITY - OSIsoftcdn.osisoft.com/interfaces/1014/PI_GECimpi_1.2.8.doc · Web viewCIMPLICITY...

Documents