Simca-Batch On-Line Interfacecdn.osisoft.com/interfaces/2380/PI_SimBatchOL_2.1.3.19.doc · Web viewThe PI point is the basic building block for controlling data flow to and from the

Simca-Batch On-Line Interface

Version 2.1.2.x to 2.1.3.xRevision A

OSIsoft, LLC 777 Davis St., Suite 250San Leandro, CA 94577 USATel: (01) 510-297-5800Fax: (01) 510-357-8136Web: http://www.osisoft.com

OSIsoft Australia • Perth, AustraliaOSIsoft Europe GmbH • Altenstadt, GermanyOSIsoft Asia Pte Ltd. • Singapore OSIsoft Canada ULC • Montreal & Calgary, CanadaOSIsoft, LLC Representative Office • Shanghai, People’s Republic of ChinaOSIsoft Japan KK • Tokyo, JapanOSIsoft Mexico S. De R.L. De C.V. • Mexico City, MexicoOSIsoft do Brasil Sistemas Ltda. • Sao Paulo, Brazil

Copyright: © 2001-2023 OSIsoft, LLC. All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, mechanical, photocopying, recording, or otherwise, without the prior written permission of OSIsoft, LLC.

OSIsoft, the OSIsoft logo and logotype, PI Analytics, PI ProcessBook, PI DataLink, ProcessPoint, Sigmafine, Analysis Framework, IT Monitor, MCN Health Monitor, PI System, PI ActiveView, PI ACE, PI AlarmView, PI BatchView, PI Data Services, PI Manual Logger, PI ProfileView, PI WebParts, ProTRAQ, RLINK, RtAnalytics, RtBaseline, RtPortal, RtPM, RtReports and RtWebParts are all trademarks of OSIsoft, LLC. All other trademarks or trade names used herein are the property of their respective owners.

U.S. GOVERNMENT RIGHTSUse, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the OSIsoft, LLC license agreement and as provided in DFARS 227.7202, DFARS 252.227-7013, FAR 12.212, FAR 52.227, as applicable. OSIsoft, LLC.

Published: 06/2011

http://www.osisoft.com/

Table of ContentsTerminology......................................................................................................................v

Interface Specific Terms.....................................................................................vGeneral Terms...................................................................................................v

Chapter 1. Introduction...................................................................................................1A Terminology Note...........................................................................................1Reference Manuals............................................................................................2Supported Features...........................................................................................2

Chapter 2. Principles of Operation................................................................................5Modified Point Names........................................................................................5

Chapter 3. Installation Checklist....................................................................................7

Chapter 4. Interface Installation.....................................................................................9Interface Directories...........................................................................................9

PIHOME Directory Tree...........................................................................9PIHOME64 Directory Tree.......................................................................9Interface Installation Directory...............................................................10

Interface Installation Procedure.......................................................................10

Chapter 5. Startup Parameters.....................................................................................11PISimBOL.ini Parameters................................................................................11PISimBatchOL_FilterFile.ini Parameters..........................................................12Sample PISimBOL.ini File................................................................................13Sample Filter.ini File.........................................................................................13

Chapter 6. Interface Node Clock..................................................................................15

Chapter 7. Security........................................................................................................17Windows..........................................................................................................17

Chapter 8. Buffering......................................................................................................19

Chapter 9. Interface Diagnostics Configuration.........................................................21Scan Class Performance Points......................................................................21Performance Counters Points..........................................................................21Interface Health Monitoring Points...................................................................21I/O Rate Point..................................................................................................21Interface Status Point.......................................................................................21

Appendix A. Error and Informational Messages......................................................23Message Logs..................................................................................................23Messages.........................................................................................................23System Errors and PI Errors............................................................................24

Simca-Batch On-Line Interface iii

Appendix B. Technical Support and Resources......................................................25Before You Call or Write for Help...........................................................25Help Desk and Telephone Support........................................................25Search Support......................................................................................26Email-based Technical Support.............................................................26Online Technical Support.......................................................................26Remote Access......................................................................................27On-site Service......................................................................................27Knowledge Center.................................................................................27Upgrades...............................................................................................27OSIsoft Virtual Campus (vCampus).......................................................27

Appendix C. Revision History......................................................................................29

Simca-Batch On-Line Interface iv

TerminologyTo understand this interface manual, you should be familiar with the terminology used in this document.

Interface Specific Terms

NodeIn Umetrics terminology a Node is a PI Unit. In the Simca system a node will return batches that are related to the node or PIUnit. A virtual or filter node is a node that will return batches that relate to a query.

General Terms

BufferingBuffering refers to an Interface Node’s ability to store temporarily the data that interfaces collect and to forward these data to the appropriate PI Servers.

N-Way BufferingIf you have PI Servers that are part of a PI Collective, PIBufss supports n-way buffering. N-way buffering refers to the ability of a buffering application to send the same data to each of the PI Servers in a PI Collective. (Bufserv also supports n-way buffering to multiple PI Server however it does not guarantee identical archive records since point compressions specs could be different between PI Servers. With this in mind, OSIsoft recommends that you run PIBufss instead.)

ICUICU refers to the PI Interface Configuration Utility. The ICU is the primary application that you use to configure PI interface programs. You must install the ICU on the same computer on which an interface runs. A single copy of the ICU manages all of the interfaces on a particular computer.

You can configure an interface by editing a startup command file. However, OSIsoft discourages this approach. Instead, OSIsoft strongly recommends that you use the ICU for interface management tasks.

ICU ControlAn ICU Control is a plug-in to the ICU. Whereas the ICU handles functionality common to all interfaces, an ICU Control implements interface-specific behavior. Most PI interfaces have an associated ICU Control.

Interface NodeAn Interface Node is a computer on which

the PI API and/or PI SDK are installed, and

PI Server programs are not installed.

Simca-Batch On-Line Interface v

Terminology

PI APIThe PI API is a library of functions that allow applications to communicate and exchange data with the PI Server. All PI interfaces use the PI API.

PI CollectiveA PI Collective is two or more replicated PI Servers that collect data concurrently. Collectives are part of the High Availability environment. When the primary PI Server in a collective becomes unavailable, a secondary collective member node seamlessly continues to collect and provide data access to your PI clients.

PIHOMEPIHOME refers to the directory that is the common location for PI 32-bit client applications.

On a 32-bit Operating system

A typical PIHOME is C:\Program Files\PIPC.

On a 64-Bit Operating system

A typical PIHOME is C:\Program Files (x86)\PIPC.

PI interfaces reside in a subdirectory of the Interfaces directory under PIHOME.

For example, files for the Modbus Ethernet Interface are in C:\Program Files\PIPC\Interfaces\ModbusE.

This document uses [PIHOME] as an abbreviation for the complete PIHOME or PIHOME64 directory. For example, ICU files in [PIHOME]\ICU.

PIHOME64PIHOME64 will be found only on a 64-bit Operating System and refers to the directory that is the common location for PI 64-bit client applications.

A typical PIHOME64 is C:\Program File\PIPC.

PI interfaces reside in a subdirectory of the Interfaces directory under PIHOME64.

For example, files for a 64-bit Modbus Ethernet Interface would be found in C:\Program Files\PIPC\Interfaces\ModbusE.

This document uses [PIHOME] as an abbreviation for the complete PIHOME or PIHOME64 directory. For example, ICU files in [PIHOME64]\ICU.

PI Message LogThe PI message Log is the file to which OSIsoft interfaces based on UniInt 4.5.0.x and later writes informational, debug and error message. When a PI interface runs, it writes to the local PI message log. This message file can only be viewed using the PIGetMsg utility. See the UniInt Interface Message Logging.docx file for more information on how to access these messages.

PI SDKThe PI SDK is a library of functions that allow applications to communicate and exchange data with the PI Server. Some PI interfaces, in addition to using the PI API, require the use of the PI SDK.

vi

PI Server NodeA PI Server Node is a computer on which PI Server programs are installed. The PI Server runs on the PI Server Node.

PI SMTPI SMT refers to PI System Management Tools. PI SMT is the program that you use for configuring PI Servers. A single copy of PI SMT manages multiple PI Servers. PI SMT runs on either a PI Server Node or a PI Interface Node.

Pipc.logThe pipc.log file is the file to which OSIsoft applications write informational and error messages. When a PI interface runs, it writes to the pipc.log file. The ICU allows easy access to the pipc.log.

PointThe PI point is the basic building block for controlling data flow to and from the PI Server. For a given timestamp, a PI point holds a single value.

A PI point does not necessarily correspond to a “point” on the foreign device. For example, a single “point” on the foreign device can consist of a set point, a process value, an alarm limit, and a discrete value. These four pieces of information require four separate PI points.

ServiceA Service is a Windows program that runs without user interaction. A Service continues to run after you have logged off from Windows. It has the ability to start up when the computer itself starts up.

The ICU allows you to configure a PI interface to run as a Service.

Tag (Input Tag and Output Tag)The tag attribute of a PI point is the name of the PI point. There is a one-to-one correspondence between the name of a point and the point itself. Because of this relationship, PI System documentation uses the terms “tag” and “point” interchangeably.

Interfaces read values from a device and write these values to an Input Tag. Interfaces use an Output Tag to write a value to the device.

Simca-Batch On-Line Interface vii

Chapter 1. Introduction

The PI SimBatchOL Interface provides connectivity between one or more PI servers and a single Simca-Batch On-line Data Server. The PI SimBatchOL Interface comes in two flavors a Windows 32-bit DLL or a Windows 64-bit DLL which satisfies the Simca-Batch On-Line External Database API requirements. The file PISimBatchOL.dll is for use with SBOL version 3.1.0.1 or greater.

Note: This interface is different from other PI interfaces in that it is the Simca-Batch On-Line which makes calls to the commands contained in the interface dll to exchange data with the PI system.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the interface is being installed on a 32-bit Operating System (C:\Program Files\PIPC) or a 64-bit Operating system (C:\Program Files (x86)\PIPC).

The value of [PIHOME64] variable for the 64-bit interface will be C:\Program Files\PIPC on the 64-bit Operating system.

In this documentation [PIHOME] will be used to represent the value for either [PIHOME] or [PIHOME64]. The value of [PIHOME] is the directory which is the common location for PI client applications.

This interface requires the following software be installed on the same machine as the interface:

PI SDK version 1.3.4 or greater

The interface is only compatible with PI3 servers.

Both inputs to and outputs from PI are supported. Although the direction of data flow is bi-directional in nature, the primary purpose of this interface is to provide PI data to the Simca-Batch On-Line Server instead of providing external process data to PI.

It will operate with the Module DB and Batch DB of the PI Server 3.3.0 and higher.

A Terminology Note

This document refers to Servers and Points, Umetrics applications refer to Nodes and Tags.

When the Umetrics application refers to Nodes; they refer to the Server and PIUnits.

When the Umetrics application refers to Tags; they are Points

Simca-Batch On-Line Interface 1

Introduction

Reference Manuals

OSIsoft PI Server manuals

PI SDK Installation Instructions

PI SDK 64 Installation Instructions

Umetrics Application Installation Instructions

Supported Features

Feature Support

Part Number PI-IN-SIM-BO-NTPI-IN-SIM-BO-X64

* Platforms 32-bit Interface 64-bit Interface

Windows XP

32-bit OS Yes No

64-bit OS Yes (Emulation Mode) Yes

Windows 2003 Server

32-bit OS Yes No


Windows Vista

32-bit OS Yes No


Windows 2008

32-bit OS Yes No


Windows 2008 R2


Windows 7

32-bit OS Yes No


APS Connector No

Point Builder Utility No

ICU Control No

PI Point Types Float16, Float32, Float64, Int16, Int32, and Digital

Sub-second Timestamps No

Sub-second Scan Classes No

Automatically Incorporates PI Point Attribute Changes

No

Exception Reporting Only uses snapshot

2

Feature Support

Outputs from PI Yes

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

Supports Questionable Bit No

Supports Multi-character PointSource No

Maximum Point Count No

* Uses PI SDK Yes

PINet String Support N/A

* Source of Timestamps See description below

History Recovery No

UniInt-based* Disconnected Startup* SetDeviceStatus

NoNoNo

Failover No

* Vendor Software Required on PI Interface Node / PINet Node

Yes

Vendor Software Required on Foreign Device

No

Vendor Hardware Required No

Additional PI Software Included with Interface

No

Device Point Types NONE

Serial-Based Interface No

* See available paragraphs below for further explanation.

PlatformsThe Interface is designed to run on the above mentioned Microsoft Windows operating systems and their associated service packs.

Uses PI SDKThe PI SDK and the PI API are bundled together and must be installed on each PI Interface node. This Interface specifically makes PI SDK calls to create PI Points, access PI Module Database, PI Batch Database, and / or Questionable Bits.

The 32-bit version of the PISIMBOL Interface installs 32-bit PI SDK.

The 64-bit version of the PISIMBOL Interface installs both the 32 and 64 bit versions of the PI SDK; this is done to utilize the 32-bit AboutPI-SDK.exe on the 64-bit Operating System installations.

Source of TimestampsThe client application provides timestamps for input data. PI provides timestamps for output data, but the client application may or may not use them.

Vendor Software RequiredThis interface is implemented as a DLL and thus loaded by the client application at run-time.


Chapter 2. Principles of Operation

This Interface performs as an adapter between the requirements of the Umetrics Simca-Batch On-Line External Database API and the PI SDK.

It permits a Umetrics client application to:

Query for information about the connected server and the available analog and digital points on the server.

Read and write point snapshot data for multiple analog and digital points to and from one PI3 server.

Read archive data for multiple analog and digital points from one PI3 server.

Read batch data from the PI Batch DB.

Modified Point Names

Another restriction of Umetrics applications is that the colon character “:” is reserved and cannot be used in server or point names. Umetrics Simca-Batch On-Line automatically replaces colon characters “:” with the period character “.”. For instance, the point name “BA:Active.1” would display in the Umetrics Simca-Batch On-Line as “BA.ACTIVE.1”.

Thus, any point name will appear within the Umetrics application with colons replaced by periods.

It is unlikely, but possible, that these conversions result in two or more points having identical names and it will be necessary to make point names unique for correct operation.


Chapter 3. Installation Checklist

For those users who are familiar with running PI data collection interface programs, this checklist helps you get the PI SimBatchOL Interface running. If you are not familiar with PI interfaces, you should return to this section after reading the rest of the manual in detail.

1. Verify that the PI SDK has been installed. If this is an installation of the 64-bit interface verify that the 64-bit PI SDK has been installed. A PI Server is also required if the interface is running on the PI Home Node.

2. Install the interface.

3. Configure the PISBOL.ini file. A sample ini file called PISBOL.ini_sam is distributed with the interface.

4. Ensure that the PI servers specified in the PISBOL.ini file are in the Known Servers Table for PI SDK. Otherwise, the PI servers cannot be connected from Umetrics applications. The PI servers can be added to the Known Servers Table via the AboutPI SDK program delivered with the 32-bit PI SDK. Refer to the PI SDK Manual for details. Furthermore, if a password is required for the PI user while connecting to a PI Server with AboutPI SDK, a trust entry for the node running the interface and the PI user should be added to the PITrust table on the PI Server. Refer to the PI Server manual for details about the PITrust table


Chapter 4. Interface Installation

OSIsoft recommends that interfaces be installed on a PI Interface Nodes instead of directly on the PI Server node. A PI Interface Node is any node other than the PI Server node where the PI Application Programming Interface (PI API) has been installed (see the PI API manual). With this approach, the PI Server need not compete with interfaces for the machine’s resources. The primary function of the PI Server is to archive data and to service clients that request data.

Interface Directories

PIHOME Directory Tree

32-bit InterfacesThe [PIHOME] directory tree is defined by the PIHOME entry in the pipc.ini configuration file. This pipc.ini file is an ASCII text file, which is located in the %windir% directory.

For 32-bit Operating System a typical pipc.ini file contains the following lines:[PIPC]PIHOME=C:\Program Files\PIPC

For 64-bit Operating System a typical pipc.ini file contains the following lines:[PIPC]PIHOME=C:\Program Files (X86)\PIPC

The above lines define the \Program Files\PIPC directory as the root of the PIHOME directory tree on the C: drive. OSIsoft recommends using \Program Files\pipc as the root directory name. The PIHOME directory does not need to be on the C: drive.

PIHOME64 Directory Tree

64-bit InterfacesThe [PIHOME64] directory tree is defined by a System Environmental Variable called PIHOME64.

A typical value for this environmental variable is C:\Program Files\PIPC\.

The above lines define the \Program Files\PIPC directory as the root of the PIHOME64 directory tree on the C: drive. OSIsoft recommends using \Program Files\PIPC as the root directory name. The PIHOME64 directory does not need to be on the C: drive.


Interface Installation Directory

The interface install kit will automatically install the interface to:[PIHOME]\Interfaces\SimBatchOL\

Interface Installation Procedure

The PISimBatchOL Interface setup program uses the services of the Microsoft Windows Installer. Windows Installer is a standard part of Windows 2000 and greater operating systems. To install, run the appropriate installation kit.

32-bit InterfaceSimBatchOL_#.#.#.#_.exe

64-bit InterfaceSimBatchOL_x64_#.#.#.#_.exe


Chapter 5. Startup Parameters

PISimBOL.ini Parameters

The ini file contains multiple lines of the format key=value. There are no spaces permitted on either side of the “=” character. Key = value is incorrect.

Key Value

Debug=x Only the first character of the value is read and this must be a ‘t’, ‘T’ or ‘1’ to turn debugging on. Any other character will result in no debugging information.Debugging should generally be set to off.

Server=name The value is the name of one PI server from which to obtain point data.If server parameter does not exist the default server will be used.

Trim=x Only the first character of the value is read and this must be a ‘t’, ‘T’ or ‘1’ to turn trim on. Any other character will result in no trimming.Trim on will trim white space from all string event values. This is used to resolve an issue with white space in batch id events.

Batchtimeoffset=x simapi2_nodeGetBatchTimes call sometime misses a currently executing PIUnitBatch, even though it exist in PI. When a batch end time is before the timeHint simapi2_nodeGetBatchTimes will not find that batch. Configure value so timeHint = timeHint – x to resolve issue. X is the number of seconds to subtract from the time hint for the batch search time. By default 1 second is subtracted.

Singleapartment=x A value of t ( or T or 1 ) will call the PISDK call in a single apartment thread ( STA). The calling routines must be single threaded that is only one single thread will be allowed to call any routines in the interface DLL. A value of f ( or F or 0 ) will call the PISDK in Multiple threaded apartments. The calling routines may be multithreaded. The default value is f ( or F or 0) for multithreaded.

Filterfilename=filter.ini The value of the filterfilename will be the initialization file that the Umetrics system will use to extract the virtual nodes information. These virtual nodes are used to filter the batch searches.


PISimBatchOL_FilterFile.ini Parameters

The filter nodes allow the batch searches to be tailored to an individual’s needs. For example if you would like to find PIUnitBatches that have been generated from a group of units when the units are make a particular product.

For example if you have:

Units:

Unit_3401, Unit_3402, Unit_3403, Unit_3501, Unit_3502

That are making product:

Product_abc, Product_def

You would like to find the PIUnitBatches on the Unit_34’s making product Product_abc, you would create a filter node that would have;

A filter Type PIUnitBatchFilterA Node Name Product_abc_NodeA Unit Mask Unit_340?A BatchID Mask *A ProductID Mask Product_abcA Procedure Mask *A SubBatch Mask *

The Node line would look like:PIUnitBatchFilter=Product_abc_Node Unit_340? * Product_abc * *

There are two types of filters nodes PIBatchFilters and PIUnitBatchFilters. The PIBatchFilter provides parameters for a PIBatchSearch and PIUnitBatchFilters provides parameters for a PIUnitBatch search. The parameters for each search are as follows:

PIUnitBatchFilter Virtual / Filter Node Parameters

Parameter DescriptionNode Name Your choice of name

Unit Mask A name with Asterisk <*> for multiple character wildcard match or Question mark <?> for a single character wildcard match.

UnitBatchID Mask A name with Asterisk <*> for multiple character wildcard match or Question mark <?> for a single character wildcard match.

ProductID Mask A name with Asterisk <*> for multiple character wildcard match or Question mark <?> for a single character wildcard match.

Procedure Mask A name with Asterisk <*> for multiple character wildcard match or Question mark <?> for a single character wildcard match.

SubBatch Mask A name with Asterisk <*> for multiple character wildcard match or Question mark <?> for a single character wildcard match.


PIBatchFilter Virtual / Filter Node Parameters

Parameter DescriptionNode Name Your choice of name

BatchID Mask A name with Asterisk <*> for multiple character wildcard match or Question mark <?> for a single character wildcard match.

ProductID Mask A name with Asterisk <*> for multiple character wildcard match or Question mark <?> for a single character wildcard match.

Recipe Mask A name with Asterisk <*> for multiple character wildcard match or Question mark <?> for a single character wildcard match.

The filter lines in the filter.ini file will be in the form:PIBatchFilter=NodeName BatchIDMask ProductMask RecipeMask

OrPIUnitBatchFilter= NodeName UnitMask UnitBatchIDMask ProductMask ProcedureMask SubBatchMask

Node Names must be unique. No two nodes can have the same name.

Sample PISimBOL.ini File

The following is an example file:Debug=0Server=XXXXXXtrim=0batchtimeoffset=60

Sample Filter.ini File

The following is an example file:PIBatchFilter=AbatchNode MyBatchMask MyProductMask MyRecipeMaskPIBatchFilter=BatchNode2 MyBatch* M?ProductMask *PIBatchFilter= BatchNode2 MyBatchMask M?ProductMask *RecipeMaskPIUnitBatchFilter=AnodeName aUnitMask aBatchIdMask aProductMask aProcedureMask aSubBatchMaskPIUnitBatchFilter=MyOtherNode aUnit* aBatch??Mask * *ProcedureMask aSubBatchMask


Chapter 6. Interface Node Clock

Make sure that the time and time zone settings on the computer are correct. To confirm, run the Date/Time applet located in the Windows Control Panel. If the locale where the interface node resides observes Daylight Saving Time, check the “Automatically adjust clock for daylight saving changes” box. For example,

In addition, make sure that the TZ environment variable is not defined. All of the currently defined environment variables can be viewed by opening a Command Prompt window and typing set. That is,C:> set

Confirm that TZ is not in the resulting list. If it is, run the System applet of the Control Panel, click the “Environment Variables” button under the Advanced Tab, and remove TZ from the list of environment variables.


Chapter 7. Security

Windows

The PI Firewall Database and the PI Proxy Database must be configured so that the interface is allowed to write data to the PI Server. See “Modifying the Firewall Database” and “Modifying the Proxy Database” in the PI Server manuals.

Note that the Trust Database, which is maintained by the Base Subsystem, replaces the Proxy Database used prior to PI version 3.3. The Trust Database maintains all the functionality of the proxy mechanism while being more secure.

See “Trust Login Security” in the chapter “Managing Security” of the PI Server System Management Guide.

If the interface cannot write data to the PI Server because it has insufficient privileges, a -10401 error will be reported in the pipc.log file. If the interface cannot send data to a PI2 Serve, it writes a -999 error. See the section Appendix A: Error and Informational Messages for additional information on error messaging.

PI Server v3.3 and Higher

Security configuration using piconfigFor PI Server v3.3 and higher, the following example demonstrates how to edit the PI Trust table:

C:\PI\adm> piconfig@table pitrust@mode create@istr Trust,IPAddr,NetMask,PIUsera_trust_name,192.168.100.11,255.255.255.255,piadmin@quit

For the above,

Trust: An arbitrary name for the trust table entry; in the above example,a_trust_name

IPAddr: the IP Address of the computer running the Interface; in the above example,192.168.100.11

NetMask: the network mask; 255.255.255.255 specifies an exact match with IPAddr

PIUser: the PI user the Interface to be entrusted as; piadmin is usually an appropriate user


Security Configuring using Trust EditorThe Trust Editor plug-in for PI System Management Tools 3.x may also be used to edit the PI Trust table.

See the PI System Management chapter in the PI Server manual for more details on security configuration.

PI Server v3.2For PI Server v3.2, the following example demonstrates how to edit the PI Proxy table:

C:\PI\adm> piconfig@table pi_gen,piproxy@mode create@istr host,proxyaccountpiapimachine,piadmin@quit

In place of piapimachine, put the name of the PI Interface node as it is seen by PI Server.


Chapter 8. Buffering

This Interface is not compatible with OSIsoft’s standard buffering mechanisms, PI API Buffer Server (Bufserv) or the PI Buffer Subsystem (PIBufss).


Chapter 9. Interface Diagnostics Configuration

The Interface Point Configuration chapter provides information on building PI points for collecting data from the device. This chapter describes the configuration of points related to interface diagnostics.

Scan Class Performance Points

Scan class performance points are not supported by this interface.

Performance Counters Points

Performance counter points are not supported by this interface.

Interface Health Monitoring Points

Interface health monitoring points are not supported by this interface.

I/O Rate Point

I/O rate points are not supported by this interface.

Interface Status Point

This interface does not support the Interface Status Utility.


Appendix A.Error and Informational Messages

Message Logs

The location of the message log depends upon the platform on which the interface is running. See the UniInt Interface User Manual for more information.

Messages are written to [PIHOME]\dat\pipc.log at the following times.

When the interface starts many informational messages are written to the log. These include the version of the interface, the version of UniInt, the command-line parameters used, and the number of points.

As the interface retrieves points, messages are sent to the log if there are any problems with the configuration of the points.

Messages

Message COM Error [####] : "Description"

Meaning Error: A COM error has occurred communicating with the PI SDK. Error number and description provided.

Message PI SimBatchOL Version #.#.#.# Connected to [XXXXX]

Meaning Informational: Interface version and connection information

Message PI SimBatchOL x64 Version #.#.#.# Connected to [XXXXX]

Meaning Informational: Interface version and connection information

Message Interface failed to identify itself to the PI Server.

Meaning Error: Interface failed call to Application ID in the PI SDK

Message Icould not find the PIServer \XXXX\ in the list of known servers.

Meaning Error: Bad or Unknown server in PISimBOL.ini file.

Message Successfully opened a connection to the Server \XXX\

Meaning Informational: Connection to PI Server opened successfully.


Message The Interface failed to identify itself to the PI Server, "Description"

Meaning Error: Application had problems with the Application ID, description provided.

Message Could not get the PI-SDK Version information. Cannot continue without verifying PISDK version number

Meaning Error: Problem getting PI SDK version.

Message This is an Old PI-SDK Version, Please upgrade to X.X.X : Build XXX or higher

Meaning Error: Not using the Minimum version of PI SDK.

Message Failed to open PISIMBOL.ini file:

Meaning Error: Failed to open PISIMBOL.ini file

Message Failed to open Filter.ini file:

Meaning Error: Failed to open filter.ini file

System Errors and PI Errors

System errors are associated with positive error numbers. Errors related to PI are associated with negative error numbers.

Error Descriptions on WindowsOn Windows, descriptions of system and PI errors can be obtained with the pidiag utility:

Windows: \PI\adm\pidiag – e error_number


Appendix B.Technical Support and Resources

You can read complete information about technical support options, and access all of the following resources at the OSIsoft Technical Support Web site:

http://techsupport.osisoft.com (http://techsupport.osisoft.com)

Before You Call or Write for Help

When you contact OSIsoft Technical Support, please provide:

Product name, version, and/or build numbers

Computer platform (CPU type, operating system, and version number)

The time that the difficulty started

The log file(s) at that time

Help Desk and Telephone Support

You can contact OSIsoft Technical Support 24 hours a day. Use the numbers in the table below to find the most appropriate number for your area. Dialing any of these numbers will route your call into our global support queue to be answered by engineers stationed around the world.

Office Location Access Number Local Language OptionsSan Leandro, CA, USA 1 510 297 5828 English

Philadelphia, PA, USA 1 215 606 0705 English

Johnson City, TN, USA 1 423 610 3800 English

Montreal, QC, Canada 1 514 493 0663 English, French

Sao Paulo, Brazil 55 11 3053 5040 English, Portuguese

Frankfurt, Germany 49 6047 989 333 English, German

Manama, Bahrain 973 1758 4429 English, Arabic

Singapore 65 6391 181186 021 2327 8686

English, MandarinMandarin

Perth, WA, Australia 61 8 9282 9220 English


http://techsupport.osisoft.com/

Support may be provided in languages other than English in certain centers (listed above) based on availability of attendants. If you select a local language option, we will make best efforts to connect you with an available Technical Support Engineer (TSE) with that language skill. If no local language TSE is available to assist you, you will be routed to the first available attendant.

If all available TSEs are busy assisting other customers when you call, you will be prompted to remain on the line to wait for the next available TSE or else leave a voicemail message. If you choose to leave a message, you will not lose your place in the queue. Your voicemail will be treated as a regular phone call and will be directed to the first TSE who becomes available.

If you are calling about an ongoing case, be sure to reference your case number when you call so we can connect you to the engineer currently assigned to your case. If that engineer is not available, another engineer will attempt to assist you.

Search Support

From the OSIsoft Technical Support Web site, click Search Support.

Quickly and easily search the OSIsoft Technical Support Web site’s Support Solutions, Documentation, and Support Bulletins using the advanced MS SharePoint search engine.

Email-based Technical Support

[email protected]

When contacting OSIsoft Technical Support by email, it is helpful to send the following information:

Description of issue: Short description of issue, symptoms, informational or error messages, history of issue

Log files: See the product documentation for information on obtaining logs pertinent to the situation.

Online Technical Support

From the OSIsoft Technical Support Web site, click Contact us > My Support > My Calls.

Using OSIsoft’s Online Technical Support, you can:

Enter a new call directly into OSIsoft’s database (monitored 24 hours a day)

View or edit existing OSIsoft calls that you entered

View any of the calls entered by your organization or site, if enabled

See your licensed software and dates of your Service Reliance Program agreements


mailto:[email protected]

Remote Access

From the OSIsoft Technical Support Web site, click Contact Us > Remote Support Options.

OSIsoft Support Engineers may remotely access your server in order to provide hands-on troubleshooting and assistance. See the Remote Access page for details on the various methods you can use.

On-site Service

From the OSIsoft Technical Support Web site, click Contact Us > On-site Field Service Visit.

OSIsoft provides on-site service for a fee. Visit our On-site Field Service Visit page for more information.

Knowledge Center

From the OSIsoft Technical Support Web site, click Knowledge Center.

The Knowledge Center provides a searchable library of documentation and technical data, as well as a special collection of resources for system managers. For these options, click Knowledge Center on the Technical Support Web site.

The Search feature allows you to search Support Solutions, Bulletins, Support Pages, Known Issues, Enhancements, and Documentation (including user manuals, release notes, and white papers).

System Manager Resources include tools and instructions that help you manage: Archive sizing, backup scripts, daily health checks, daylight savings time configuration, PI Server security, PI System sizing and configuration, PI trusts for Interface Nodes, and more.

Upgrades

From the OSIsoft Technical Support Web site, click Contact Us > Obtaining Upgrades.

You are eligible to download or order any available version of a product for which you have an active Service Reliance Program (SRP), formerly known as Tech Support Agreement (TSA). To verify or change your SRP status, contact your Sales Representative or Technical Support (http://techsupport.osisoft.com / ) for assistance.

OSIsoft Virtual Campus (vCampus)

The OSIsoft Virtual Campus (vCampus) Web site offers a community-oriented program that focuses on PI System development and integration. The Web site's annual online subscriptions provide customers with software downloads, resources that include a personal development PI System, online library, technical webinars, online training, and community-oriented features such as blogs and discussion forums.

OSIsoft vCampus is intended to facilitate and encourage communication around PI programming and integration between OSIsoft partners, customers and employees. See the


http://techsupport.osisoft.com/

Technical Support and Resources

OSIsoft vCampus Web site, http://vCampus.osisoft.com (http://vCampus.osisoft.com) or contact the OSIsoft vCampus team at [email protected] for more information.

28

http://vCampus.osisoft.com/

Appendix C.Revision History

Date Author Comments

08-Oct-2001 NC Document for V1.1.0, uses skeleton document v1.09

10-Jan-2003 Dchen Use skeleton v1.11. Change the interface name to PI-SBOL v1.0.0

11-April-2003 Dchen Change the version from 1.0.0 to 1.0.0.0 and change the name from SBOL to SimBatchOL

21-May-2003 Dchen Update “Security” section to include PI Trust Database. Add the server connection via PI SDK into the installation check list.

01-Jul-2003 Dchen Add string points for Batch ID and clarify the aliased points for batch id.

28-Aug-2003 Dchen Update the manual using skeleton document v1.12

04-Sep-2003 Cgoodell Some reformatting; clarified Supported Features table

08-Sep-2003 Hbeeson Added setup info (1.0.0.0,doc rev A).

11-Apr-2006 Dchen Change the document version from 1.0.0.0 to 1.0.0.1

25-Apr-2006 Mkelly Version 1.0.0.1 Rev A: Updated to current interface skeleton manual v2.4, fixed headers and footers, updated How to Contact Us page, copyright date, supported features.

18-Mar-2008 Oacevedo Document for V2.1.0.0, uses skeleton document v2.5.6

24-Mar-2008 Mkelly Version 1.0.0.1 and 2.1.0.0 Rev A; fixed headers and footer, page setup, made minor formatting changes and wording. Saved as Final.

30-Jun-2008 Oacevedo Version 1.0.0.1 and 2.1.0.3 Rev A; Added ini parameter batchtimeoffset=x

13-Nov-2008 Epaolino Version 2.1.1.3 Server Parameter update. SingleApartmentThread parameter.

10-Dec-2008 Janelle Version 2.1.1.3, Revision A: added buffering and interface diagnostics sections, fixed headers and page numbering. Updated TOC; made final.

08-May-2009 Epaolino Version 2.1.2.0 Added filtering for batch search. Also, used 3.0.9 skeleton.

01-Jun-2009 Mkelly Version 2.1.2.0, Revision A; Updated copyright date, fixed header, footers, page numbers and section breaks. Rebuilt the TOC.

27-Jan-2010 Epaolino Version 2.1.2.1 Updated to current interface skeleton manual v3.0.22, Changes for 64bit software

06-Apr-2010 Mkelly Version 2.1.2.1 Updated/Clarified 32-bit and 64-bit descriptions. Fixed headers, footers and page breaks. Updated to current interface skeleton manual v3.0.25.

23-Feb-2011 Nwisehart Version 2.1.2.x Revision A – Updated to current interface skeleton manual 3.0.32 styles


Date Author Comments

06-May-2011 Mkelly Version 2.1.2.x Revision B – Corrected install kit filenames.

09-May-2011 Epaolino Version 2.1.2.x – 2.1.3.x

02-Jun-2011 MKelly Version 2.1.2.x – 2.1.3.x, Revision A; Fixed headers and title page to use Document Property for title not StyleRef field.


Documents

Simca-Batch On-Line Interfacecdn.osisoft.com/interfaces/2380/PI_SimBatchOL_2.1.3.19.doc · Web viewThe PI point is the basic building block for controlling data flow to and from the