PI Web API 2014 R2 Update 1 Release Notes

Transcription

1 PI Web API 2014 R2 Update 1 Release Notes Application Version OSIsoft, LLC. All rights reserved

2

3 Table of Contents Overview... 1 Fixes and Enhancements... 1 Fixes... 1 Enhancements... 1 Setup... 2 Operating Systems... 2 System Prerequisites... 2 Server Platforms... 2 Distribution Kit Files... 2 Installation and Upgrade... 2 Uninstalling... 3 List of Files Installed During Setup... 4 Known Problems and Limitations... 6 Documentation Overview... 7 Technical Support and Resources... 7

4

5 Overview The PI Web API is a RESTful PI System Access layer, designed to provide cross-platform web and mobile programmatic interfaces to the PI System. The PI Web API presently contains basic functionality needed to retrieve and manipulate time series data from the PI Data Archive, and Asset and Event Frame data from the PI Asset Server, and to index and search on objects within the PI System. A future release that includes OData resources is planned. The PI Web API belongs to the OSIsoft PI System Access family of products, which is designed to support the implementation of custom applications on top of the PI System, as well as the integration of PI System data with other applications and business systems such as Microsoft Office or SQL Server, Enterprise Resource Planning systems (ERPs), reporting and analytics platforms, web portals, geospatial and maintenance systems, just to name a few. The PI System Access suite covers a wide range of use cases in various environments, programming languages, operating systems and infrastructures. For more information on other PI System Access products and details on the licensing specific to these products (for example, development vs. runtime), please contact your account manager. Fixes and Enhancements Fixes This section lists items that were resolved or added in this release of PI Web API. Work Item Description Incremental crawl fails to crawl all changed items when unsupported item types are encountered lsass process memory usage spikes during basic authentication Incremental crawls fail for asset databases in a collective. Enhancements The PI Web API service now runs as a 64-bit process. Release Notes Page 1

6 Setup Operating Systems The preferred, supported deployment platforms are Windows Server 2012 R2 or Windows Server Windows Server 2008 R2 (Full Desktop Installation only) may also be used; however, use of Windows Server 2008 R2 is discouraged, as planned enhancements to PI Web API will require functionality that is only available in later versions of Windows. Microsoft s client operating systems, Windows 8 and later (64-bit only) may be used in a limited capacity for development and testing purposes only. Earlier versions of Windows and non-x64 versions of Windows are not supported. System Prerequisites Installation of this product requires the presence of.net Framework 4.5 (.NET Framework is strongly recommended). The PI AF Client 2014 R2, included in the distribution kit, is also required. The setup will not proceed if either of these components is not present. Server Platforms PI Data Archive or later (PI Data Archive 2012 or later recommended) PI Asset Framework (AF) 2.1 or later (PI Asset Framework (AF) 2012 or later recommended) Distribution Kit Files The installer is released as a self-extracting distribution kit that contains: Installation files for PI AF Client 2014 R2, which includes the AF client installer, and installers for its prerequisites: OSIsoft MS Runtime Redistributables Microsoft Visual C++ Runtimes 2008, 2010, and 2012 (x86 and x64) PI SDK 2014 (x86 and x64) PI Buffer Subsystem 4.3 PI AF Client 2014 R2 The PI Web API Windows Installer Database (MSI) file that is signed by OSIsoft. Installation and Upgrade Before You Install Verify that the system you plan to use is running a supported operating system. Release Notes Page 2

7 Verify that the system you plan to use has.net Framework 4.5 installed (.NET Framework strongly recommended) Verify that you can run the installer as an Administrator. Installation and Upgrades Uninstalling The PI Web API installer has a graphical user interface, which allows you to perform an installation or upgrade of PI Web API. You will likely be satisfied with a Typical installation, which installs all components and selects the most common installation options for those components. Advanced users may choose a Custom installation. Detailed information and a walk-through of installation options is available in the PI Web API User Guide. Remove the product using Uninstall a program in the Windows Control Panel, or alternatively, re-run the Installation Kit and follow the prompts to remove the product. Uninstalling the product will not remove: Any SSL certificates that were created during the installation process The binding of the selected SSL certificate to the port used by PI Web API in the Windows HTTP service s configuration The URL reservation for PI Web API in the Windows Kernel routing table. The locally stored indexes for Indexed Search functionality. These items may be removed manually if desired. Release Notes Page 3

8 List of Files Installed During Setup By default, the product is installed to [Program Files]\PIPC\WebAPI. A different directory may be selected in the installer. The following table lists the files installed into this directory by the setup program. File Version AutoMapper.dll AutoMapper.Net4.dll Lucene.Net.Contrib.Analyzers.dll Lucene.Net.Contrib.Core.dll Lucene.Net.Contrib.FastVectorHighlighter.dll Lucene.Net.Contrib.Highlighter.dll Lucene.Net.Contrib.Memory.dll Lucene.Net.Contrib.Queries.dll Lucene.Net.Contrib.Regex.dll Lucene.Net.Contrib.SimpleFacetedSearch.dll Lucene.Net.Contrib.Snowball.dll Lucene.Net.Contrib.SpellChecker.dll Lucene.Net.dll Microsoft.Data.Edm.dll Microsoft.Data.OData.dll Microsoft.Diagnostics.Tracing.EventSource.dll Microsoft.IdentityModel.dll Microsoft.Owin.dll Microsoft.Owin.Host.HttpListener.dll Microsoft.Owin.Hosting.dll Microsoft.Owin.Security.dll NDesk.Options.dll Newtonsoft.Json.dll OSIsoft.REST.Database.exe OSIsoft.REST.dll OSIsoft.REST.External.dll OSIsoft.REST.Help.dll OSIsoft.REST.Host.exe OSIsoft.REST.Host.exe.config OSIsoft.REST.Instrumentation.dll Release Notes Page 4

9 OSIsoft.REST.Instrumentation.PIWebAPI.etwManifest.dll OSIsoft.REST.Instrumentation.PIWebAPI.etwManifest.man OSIsoft.REST.PI.dll OSIsoft.REST.PI.xml OSIsoft.REST.xml OSIsoft.Search.Common.dll OSIsoft.Search.Diagnostics.dll OSIsoft.Search.SvcLib.dll OSIsoft.Search.SvcLib.xml OSIsoft.Tau.Authentication.dll OSIsoft.Tau.LogService.Contracts.dll OSIsoft.Tau.LogService.LogServiceClient.dll OSIsoft.Tau.RetryHandler.dll OSIsoft.WebID.dll OSIsoft.WebID.PI.dll Owin.dll 1.0 RazorEngine.dll System.Net.Http.Formatting.dll System.Spatial.dll System.Web.Cors.dll System.Web.Http.Cors.dll System.Web.Http.dll System.Web.Http.OData.dll System.Web.Http.Owin.dll System.Web.Http.WebHost.dll System.Web.Razor.dll The installer also creates A registry key at HKLM\System\Software\PISystem\WebAPI, and adds values to this key for its internal use. A directory at [AppData]\OSIsoft\WebAPI, which contains the index and repository for Indexed Search. Release Notes Page 5

10 Known Problems and Limitations This product contains the following problems and limitations which are known to OSIsoft. Limitation Listener port not configurable. Logout required for administrative interface. PI Asset Server administrative permissions required for installation. Installation on nondomain joined PCs may require manual intervention. Crawler install, PI Web API URL cannot be set via silent install. Crawler service must be run in a domain. PI Asset Server and Database security is not factored into element level security. PI Asset Server admin privilege is not giving a user rights to see every element. Queries may time out during the final step of indexing in some Asset Databases. Incremental crawl fails with An item with the same key has already been added. Crawler lock timeout error. Deleted PI Points are not updated in a crawl. Description At this time, the product supports listening on TCP port 443 only. We plan to make this configurable in the PI Web API 2015 release. On initial install, the local group PI Web API Admins is created, and the installing user is added. However, the installing user must log out and log back in before attempting to resources that are limited to PI Web API administrators. At this time, the product must be installed by an Administrator of the PI Asset Server (AF Server) on which PI Web API s configuration will be maintained. We expect to remove this limitation in a future release. Consult the PI Web API Troubleshooting Guide for details on how to install PI Web API in a non-domain environment. The Indexed Search Crawler Service install kit allows the user to specify a PI Web API URL. That is ndot currently accessible via silent install commands. The Indexed Search Crawler Service will not run if it s installed on a machine in a workgroup. When security is calculated, only element security is considered. This is only a problem if a user is given explicit DENY-READ on a PI asset server (AF Server) or database but has ALLOW-READ on an AF element. If a user has Admin privileges on a PI Asset Server, for example if the user is an administrator on that computer, all AF elements are available in search results. This is true even if the user has no explicit Read privilege on an element. If a PI Asset Database (AF database) has a lot of elements with multiple parents, the finalize step of indexing can take lots of CPU. This could cause incoming query requests to fail due to timeout. Between crawls, if an element template is inserted and elements associated with this template have already been crawled, the crawler may attempt to re-crawl the same element, causing this error. Concurrent crawlers may cause timeouts when simultaneously attempting to access the indexes. Deletions of PI Points belonging to a member of a PI Collective may not be captured by an incremental crawl. A workaround is to perform a full crawl. Release Notes Page 6

11 Documentation Overview These release notes are a part of a documentation set that supports PI Web API that includes: PI Web API Reference: This reference is included in the product. It is an online API reference meant for developers who wish to program against the services provided in the product. It is accessible as HTML from the link where servername is the hostname of the server on which this product has been installed. PI Web API Users Guide: This reference provides information relevant to the configuration, settings, and administration of the product, and contains steps and helpful information for resolving problems with the product. vcampus Forums: The OSIsoft Virtual Campus (vcampus) website has subscription-based resources to help you with the programming and integration of OSIsoft products. Additional information about the PI Data Archive, PI Asset Server, and other topics of interest can be found in respective books available on the OSIsoft Technical Support and Resources Web site. Technical Support and Resources For technical assistance, contact OSIsoft Technical Support at or techsupport@osisoft.com. The OSIsoft Technical Support website offers additional contact options for customers outside of the United States. When you contact OSIsoft Technical Support, be prepared to provide this information: Product name, version, and build numbers Computer platform (CPU type, operating system, and version number) Time that the difficulty started Log files at that time Details of any environment changes prior to the start of the issue Summary of the issue, including any relevant log files during the time the issue occurred The OSIsoft Virtual Campus (vcampus) website has subscription-based resources to help you with the programming and integration of OSIsoft products. Release Notes Page 7

12 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 Web API, 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 PI Event Frames, PI Coresight and RtWebParts are all trademarks of OSIsoft, LLC. All other trademarks or trade names used herein are the property of their respective owners. This product relies on ASP.Net Web API and the Katana Project, which are copyright Microsoft Open Technologies, and Lucene.Net, which is copyright Apache Software Foundation. These open source components are licensed under the Apache License 2.0, whic h is available at This product relies on Automapper, which is copyright 2010 Jimmy Bogard, and JSON.Net, which is copyright 2007 James Newton-King. These open source components are licensed under the MIT License, which applies to these components only: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: the above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 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: December 12, 2014 Release Notes Page 8