PI Web Services 2010 Release Notes

Transcription

1 PI Web Services 2010 Release Notes Version OSIsoft, LLC. All rights reserved

2

3 Table of Contents Overview... 1 Known Issues... 1 Setup... 2 Operating Systems... 2 System Prerequisites... 2 Server Platforms... 2 Distribution Kit Files... 2 Installation and Upgrade... 4 Uninstalling PI Web Services List of Files Installed During Setup... 7 Documentation Overview... 8 Technical Support and Resources... 9

4

5 Overview PI Web Services consists of a Web service that accesses PI System data (PI and AF) in response to web service queries. It enables the retrieval of time series data types supported by the PI System, which include PI Points and time series data referenced by AF Attributes. The web service is a Windows Communication Foundation (WCF) service that allows web services clients to access PI System data through Simple Object Access Protocol (SOAP). PI Web Services supports writing of data to the PI Server as well as retrieval of standard PI summary calculations. PI Web Services is designed for lightweight, firewall-friendly data access over LAN or WAN and facilitates 2 main scenarios: Development of customer thick or thin/web applications, in various programming languages and on various operating systems Integration of PI System data within other Enterprise Business Systems, such as ERPs and data orchestration engines Known Issues Silent installs are not supported. Specifying interpolated boundaries with string tags may result in incorrect boundary times. Specifying very large numbers of intervals (that is, >255) for GetPISummaryData calls will result in a TimeSeries status property of Unable to cast object of type 'System.ApplicationException' to type 'OSIsoft.RtBaseline.DataService.TagInfo'. Filter expressions are only applied when calling GetPIArchiveData with the RetrievalType property of PIArchiveManner set to compressed. This applies to PI tags and AF data references. When used with AF data references, however, any tag name in the filter expression must be the actual tag name and not the name of the AF attribute used in the data reference. The 64 bit setup package does not detect the absence of the ASP.NET IIS feature. If PI Web Services 2010 is installed in the absence of this feature, an HTTP code may be observed. Installing the feature and restarting IIS corrects this condition. PI Web Services 2010 may be installed on a server which also hosts PI Web Parts 3.0. However, OSIsoft recommends that a web site and application pool that are not under the control of Microsoft SharePoint, be created prior to installation. The web site should execute under the new application pool, and the web site should be selected as the host for PI Web Services 2010 during installation. It is possible that a file or folder be left in place after uninstalling PI Web Services; in this case, the web application as configured in IIS would not be removed. It is safe to manually delete the file/folder and remove the web application from IIS. PI Web Services 2010 Release Notes Page 1

6 Setup Operating Systems This release supports Windows Server 2008, Microsoft Windows Server 2008 with Service Pack 2, Windows Server 2008 R2, Windows Server 2003 with Service Pack 2, Windows Server 2003 R2, Windows Vista, and Windows 7. System Prerequisites Installation of an OSIsoft product on Windows relies on the presence of Microsoft operating system components such as the Microsoft.NET Framework and Microsoft run time libraries. OSIsoft Prerequisite Kits are available in three packages that verify and install the needed operating system prerequisites: Online (Recommended): For installation on a computer connected to the internet. This kit connects to Microsoft sites in order to download.net Framework 3.5 for the operating system on which it is run. This is a bootstrapper kit that is much smaller than the Standalone kit. Standalone (Recommended): For installation on a computer that cannot connect to Microsoft sites or for installations where such connection is not desirable. This is a full redistributable kit that is much larger than the online kit. Legacy: This kit should only be used for installation on older operating systems where the OSIsoft products do not require.net Framework 3.5. All three Prerequisite Kits contain both 32-bit and 64-bit installation redistributables. See the Prerequisites Product Pages on the OSIsoft Tech Support Web site to determine which MS Operating System prerequisites you need: Server Platforms PI Web Services 2010 is hosted on the supported operating systems in Microsoft Internet Information Services (IIS) version 6 or later. IIS must be installed with the features described in the setup instructions below. Distribution Kit Files The following files are included in the 32-bit setup kit for PI Web Services 2010: AFClient_2010.msi AFClient_2010.mst dotnet20setup.dll dotnet30setup.dll dotnet35setup.dll PI Web Services 2010 Release Notes 2

7 MSRuntimes.msi osilogow.jpg PI Data Services_x86.msi PIDataServices_x86.mst PIOLEDBProvider.msi pisdk.msi Setup.exe Setup.ini Setup_silent.ini SetupUtils.dll PIWebServicesSetup.msi

8 The following files are included in the 64-bit version of the setup kit for PI Web Services 2010 : AFClient_2010.msi AFClient_2010.mst dotnet20setup.dll dotnet30setup.dll dotnet35setup.dll MSRuntimes.msi MSRuntimes_x64.msi osilogow.jpg PI Data Services_x64.msi PIDataServices_X64.mst PIOLEDBProvider64.msi pisdk.msi pisdk.mst pisdk_x64.msi Setup.exe Setup.ini Setup_silent.ini SetupUtils.dll PIWebServicesSetup.msi Installation and Upgrade Install and Configure Microsoft IIS PI Web Services is hosted by the Microsoft Internet Information Server (IIS). Before you can install PI Web Services 2010, IIS must be configured properly. The configuration of IIS varies slightly, based on the version of the Windows operating system. Use the instructions provided here to configure IIS for use with PI Web Services. Windows 2003 Server 1. Go to Start > Control Panel > Add or Remove Programs. 2. Click Add/Remove Windows Components. 3. Select Application Server and click Details. 4. Select Internet Information Services and click Details. 5. Verify that Internet Information Services Manager and World Wide Web Service are selected. PI Web Services 2010 Release Notes 4

9 6. Under World Wide Web Services, the following items should be selected:.net Extensibility ASP.NET ISAPI Extensions ISAPI Filters 7. Under IIS 6 Management Compatibility, verify that IIS Metabase and IIS configuration compatibility is selected. Windows 2008 Server 1. Go to Start > All Programs > Administrative Tools > Server Manager then click Turn Windows features on or off. 2. In the Server Manager dialog, click Add Roles. 3. Click Server Roles and select Web Server (IIS) in the Select Server Roles dialog. 4. Select Web Server (IIS) on the Select Server Roles dialog. 5. If necessary, click Add Required Features in the Add Roles Wizard. You can open dialog links for further information. 6. Click Role Services and select ASP.NET under Application Development. 7. Add any required role services. 8. Verify that these items are selected in the list of role services: ASP.NET.NET Extensibility ISAPI Extensions ISAPI Filters 9. Scroll to Management Tools. Under IIS 6 Management Compatibility, select IIS Metabase and IIS configuration compatibility and IIS Management Console. 10. Click Confirmation to review the settings, then click Install. 11. Review the Installation Results and click Close. Windows 7 1. Go to Control Panel > Programs > Turn Windows features on or off. In the Windows Features dialog, select Web Management Tools. Click to expand Web Management Tools and verify that IIS Metabase and IIS 6 configuration compatibility and IIS Management Console are selected. 2. Click to select and expand World Wide Web Services. Verify that these Application Development Features and Common Http Features are selected.net Extensibility ASP.NET ISAPI Extensions

10 ISAPI Filters 3. Click OK. Install PI Web Services 2010 Note: If you want to install the PI Web Services 2010 on Microsoft Windows Vista, Windows 7, or Server 2008, you must be logged in as administrator and initiate the setup kit with elevated privileges. To install PI Web Services 2010: 1. Verify that the server on which you plan to install PI Web Services 2010 has Microsoft IIS installed and properly configured. For details, see Install and Configure Microsoft IIS. 2. Verify that the server has the OSIsoft Prerequisites installed. If necessary, install the appropriate OSIsoft prerequisites kit, available at the OSIsoft Technical Support Web site ( 3. Run the PI Web Services setup kit. During the SDK installation, when you are prompted for a default username and name of a default PI Server, enter the appropriate information. During the PI AF Client setup, enter the name of the AF Server to which you want PI Web Services to connect. You may be asked to provide the name of a PI Server for storage of Module Database configuration data. You must have write access to the %OSI module in the Module Database of that PI Server. You can test this using PI SMT. During the installation of PI Web Services, use the Select Installation Address dialog to select: Site: A Web site location to host the Web site content and Web service files used by Microsoft Internet Information Server (IIS). By default, this file tree is stored in C:\inetpub\wwwroot\PIWebServices. Virtual directory: A name for the IIS virtual directory. The default value is PIWebServices. Application Pool: The Application Pool within the Internet Information Server where PI Web Services runs. 4. Verify your installation by entering the URL in Internet Explorer. PI Web Services 2010 Release Notes 6

11 5. You should see this screen: Uninstalling PI Web Services 2010 From Programs and Features, select PI Web Services 2010 and click Uninstall. The setup kit will remove the installed files and delete the Web application and virtual directory created to host the Web service. List of Files Installed During Setup The following table lists the files installed by the PI Web Services 2010 setup program. In the table below, [WEBROOT] refers to the physical location of the root of the Web site you select during installation. PIWebServices is the default virtual directory, but you may rename this. Directory File Version [WEBROOT]\PIWebServices [WEBROOT]\PIWebServices Setup Setup Setup bin bin PITimeSeries.svc Web.config CustomInstallerActions.dll OSIsoft.ico Top.bmp PIWebServices.dll PIWebServicesInstrumentation.dll Multiple HTML help files

12 Directory File Version Help Help\Samples Help\Samples Help\Samples Help\Samples Web_all_bindings_basic.config Web_config_basic_no_security.config Web_config_netTcp.config Web_config_wsHttp.config Documentation Overview PI Web Services 2010: A guide to installing, using, and programming for PI Web Services 2010 is installed as HTML help and is also available as a PDF file for download. The installed files may be accessed by browsing to on an installation that was installed with the default settings. System prerequisites, installation and removal, and an overview of the programming interface are included. Code samples are provided for each method in the interface and demonstrate common programming tasks. PI Web Services 2010 Release Notes 8

13 Technical Support and Resources OSIsoft provides dedicated technical support internationally, 24 hours a day, 7 days a week to customers with a current SRP contract. To locate local access numbers and current contact options, please visit our Contact Methods page on the Technical Support web site at The main contact information is also listed below: Telephone: Web Portal: [email protected] My Calls When you open a case using any of the above methods, you will receive a response from a Technical Support Engineer within four hours. Be sure to provide: Product name, version, and/or build numbers Computer platform (CPU type, operating system, and version number) The time that the difficulty started The message log(s) at that time You can also take advantage of the Self-service Search page on our Technical Support Web Site to look for answers to your technical questions and issues. The search tool searches our online library of documentation, knowledge base articles, technical announcements and bulletins, known product issues, and documented product enhancement requests, as well as a collection of resources for system managers.

14 OSIsoft, LLC 777 Davis St., Suite 250 San Leandro, CA USA Tel: (01) Fax: (01) Web: OSIsoft Australia Perth, Australia OSIsoft Europe GmbH Frankfurt, Germany OSIsoft Asia Pte Ltd. Singapore OSIsoft Canada ULC Montreal & Calgary, Canada OSIsoft, LLC Representative Office Shanghai, People s Republic of China OSIsoft Japan KK Tokyo, Japan OSIsoft Mexico S. De R.L. De C.V. Mexico City, Mexico OSIsoft do Brasil Sistemas Ltda. Sao Paulo, Brazil Copyright: 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, 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 RIGHTS Use, 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 , DFARS , FAR , FAR , as applicable. OSIsoft, LLC. Published: 25-May-10 PI Web Services 2010 Release Notes 10