CitectHistorian 2016

Size: px

Start display at page:

Download "CitectHistorian 2016"

Ashley Harper
6 years ago
Views:

1 CitectHistorian 2016 Readme (Updated 14 June 2016) See the Release Notes for information about fixes in this release and the Installation and Configuration Guide for information on the installation of the product and the upgrade process for existing projects. What's in this Document? 1 What s New? 2 Restrictions and Limitations 3 Requirements 4 Operational Notes 5 Known Issues with this Release 6 Disclaimers 1 What s New? 1.1 Technology Updates Dream Report Support CitectHistorian 2016 incorporates Dream Report which allows users to create and generate adhoc analysis reports for process data and alarms Support on Windows 8.1 and Windows Server 2012 R2 CitectHistorian 2016 support Windows 8.1 and Windows Server 2012 R2 along with Windows 7 and Windows Server 2008 R2 operating systems. 2 Restrictions and Limitations 2.1 SQL Server 2005 NOTE: CitectHistorian 2016 does not support SQL Server Web Client NOTE: CitectHistorian 2016 does not support web client on Windows 8.1 and Windows Server Auto Configure Auto configure may take several minutes on large systems (50,000+ tags). If you make a change to the equipment hierarchy in your source SCADA system that impacts more than 50,000 variables, you may get the following timeout error message when attempting to run an automated configuration: Timeout period expired. Please refer to the even log for more information. 2.4 Microsoft Windows and Java Updates After installation, ensure that your computer has the latest Windows Security patches applied through the Microsoft Update agent. After installation, ensure that a Java Auto update and any updates applicable to your computer are executed. Refer to the Java Auto update page at for further information. We recommend that you must implement a risk based ongoing Windows and Java Runtime Environment (JRE) update management mechanism to ensure that the updates are adequately applied based on the risk to your system.

2 2.5 Launching Historian Components Launch all Historian components with administrator privilege. To do this, right click on the shortcut of the required component and click Run as administrator. 3 Requirements 3.1 Licensing You need to upgrade your current CitectHistorian key version to run version To check if your Software Protection Key is capable of running version 2016 go to Historian Status Indicator > General > Key Utility and verify if the CitectHistorian Version is If you need to update your version, and you are in Support, you can get a new Authcode to update your license key to V2016. If you are not in support and are not licensed for version 2016, please contact your local sales representative. Historian Client Access Licenses (CALs) You can view the data from the Historian using Historian CALs. This release introduces a simplification of the previous CAL license approach which was divided into Historian Only, Portal Only, and Historian and Portal variations for both user/device and CPU CALs. The 2 options for CALs are: User/Device is based on either individual user or device connections. Processor unlimited number of users or devices. The choice between these 2 CAL options are based on the number of client users of the Historian data, as CPU licenses offer unlimited client access per processor installed on the server machine. 3.2 Software Version 2016 has primarily been tested to run on the following operating systems: Sl No OS Latest Service Pack 1 Windows 7 (32bit or 2 Windows 8.1 (32bit or 3 Windows Server 2008 R2 ( 4 Windows Server 2012 R2 ( The client tools of version 2016 have primarily been tested to run on the following operating systems: Sl No OS Latest Service Pack 1 Windows 7 (32bit or 2 Windows 8 (32bit or 3 Windows 8.1 (32bit or 4 Windows Server 2008 ( 5 Windows Server 2012 R2 ( NOTE: Confirm that any current Windows updates have been applied prior to installing.

3 Internet Explorer Version 8 or later is the minimum requirement if you are using the Process Analyst. However, in line with advice from Microsoft, we recommend you to use a latest version of Internet Explorer. 3.3 SCADA CitectHistorian 2016 is compatible with following versions of Vijeo Citect/CitectSCADA: Version 7.20 Service Pack 3 (or later) Version 7.30 Service Pack 1 (or later) Version 7.40 Version 7.50 Service Pack Hardware Minimum System Requirements Processor Type Processor Speed Memory (RAM) Disk space Disk Speed Operating System DualCore Intel Xeon processor 2.4 GHz 4 GB DDR2 Minimum required for install: 211 MB without SQL Server For a full installation with all features selected (including SQL Server): 5 GB SATA 1.5 GBit/s that is 7200 RPM drive X64 OS for faster RAM transfers Recommended System Requirements Processor Type Processor Speed Memory (RAM) Disk space Disk Speed Operating System Quad Core processor 3.6 GHz 8 GB DDR2 Minimum required for install: 211 MB without SQL Server For a full installation with all features selected (including SQL Server): 5 GB SATA 1.5 GBit/s that is 7200 RPM drive X64 OS for faster RAM transfers 4 Operational Notes 4.1 Upgrading from V4.50 To upgrade the Configuration database it is recommended that Configuration Backup and Restore Utility are used. To do this: 1. You need to first back up and save the project in a previous version of Historian. 2. You need to restore it using Historian 2016 (Restore tab of the Configuration Backup and Restore Utility). For more detailed instructions refer to the help topic Backing Up and Restoring a project. To upgrade the Historian Database, use the Historian Data Manager tool. In the General tab, select SQL Server 2012 database. In the Database tab, click Update. This confirms that the database version is now version For more detailed information, refer to the help topic Historian Data Manager.

4 4.2 Migrating Exported Sample Reports If you have exported sample reports in an earlier version using the Report Deployment Manager s Save and Edit Reports feature, you need to upgrade the reports in order to continue using them with SQL Server 2008 R2. The reporting solution should be opened in SQL Server s Business Intelligence Development Studio, which prompts you to upgrade the solution. You should also check the solution properties to verify that the TargetServerVersion property is set to SQL Server 2008 R2, and that the TargetServerURL property correctly points to the SQL Server 2008 R2 Reporting Services URL, which can be found using the Reporting Services Configuration Manager. If you want an existing exported report to include the updated graphics provided with Historian Reports Deployment Manager 2016, you need to export the new version of the report using Save and Edit and reapply the customizations made to the earlier version. 4.3 Unicode Characters Not Supported Unicode characters are not supported by some components of CitectHistorian. This means that some localized versions of CitectHistorian may display random, westernlanguage characters where doublebyte characters are entered. For example, the Name field of the Historian Folder Properties dialog box does not display the expected characters if a doublebyte language is used. It is recommended that English characters are used when configuring a localized version of CitectHistorian that is installed on a Russian, Korean, Japanese, or Simplified Chinese operating system. 4.4 Connecting to a Vijeo Citect/CitectSCADA Data Source Vijeo Citect/CitectSCADA Version 7.20 (or later) included some enhancements that required changes to the default settings for some ini parameters. As a result, the API that Historian uses to communicate with version 7.20 is disabled by default. Make the following adjustments to the citect.ini file on the Vijeo Citect/CitectSCADA computer the Historian Server is connected to. [CTAPI] AllowLegacyConnections=0 AllowLegacyServices=1 Remote=1 4.5 ReImport of Alarm Custom Filters Properties from Vijeo Citect/CitectSCADA Data Source Make the following adjustments to the citect.ini file on the Vijeo Citect/CitectSCADA connected to the Historian Server before reimporting alarm custom filters. [Alarm] UseConfigLimits=1 4.6 Restricting Memory Usage of the SQL Server It is recommended that the amount of memory that the SQL server can access is restricted so that there is enough free memory for other system applications and processes. To do this: 1) Select Start > All Programs > Microsoft SQL Server 2008 R2/ Microsoft SQL Server 2012> SQL Server Management Studio. 2) In the Object Explorer pane, rightclick the SQL Server and select Properties. 3) In the Server Properties dialog box, select the Memory page. 4) If the setting for Maximum server memory (in MB) represents all the available memory on the computer, reduce the value by 500 MB to ensure resources are always available to other CitectSCADA Reports components. NOTE: The recommended setting is dependent on: the amount of physical RAM the number of other applications and processes that are executing on the system The recommended setting is determined by subtracting the memory required for the OS, any other instances of SQL Server, and other system uses from the total physical memory.

5 The default value of maximum server memory is MB. Note that this value is in megabytes and not in bytes or bits. For a system with 4 GB of RAM, the recommended setting is 2000 MB depending on the other system applications and processes. For more information on determining an appropriate value for a specific system see Manual Adjustment of the ANSIToOEM Parameter When writing to a data file, a Vijeo Citect/CitectSCADA data source will process ANSI characters as OEM characters if the parameter [CTEDIT]ANSIToOEM is set to the nondefault value 1. When a SCADA system is connected to Historian as a data source, Historian presumes [CTEDIT]ANSIToOEM is set to the default value 0 (zero). If this is not the case, the connection to the SCADA system will be unsuccessful. To rectify this situation, you need to synchronize this setting within Historian by making a manual adjustment to the ANSIToOEM parameter in a local Citect.ini file created specifically for this purpose. To do this: 1) Confirm in the source SCADA system that the parameter [CTEDIT]ANSIToOEM is set to the nondefault value 1. (See the SCADA system documentation for information on how to do this.) 2) Locate the file named Citect.ini in the following directory on the Historian Server to which the SCADA data source is connected: \Program Files\CommonFiles\OLEDB\ 3) Open the file using a text editor, such as Notepad. 4) Add the following line to the Citect.ini file: [CTEDIT]ANSIToOEM=1 5) Save your changes to the file. The Historian Server should now be able to process the data received from the connected SCADA data source, allowing a successful connection to occur. 4.8 Disabling a Demo Mode PopUp in Vijeo Citect/CitectSCADA If Historian is connected to a Vijeo Citect/CitectSCADA system that undergoes a restart, the connection may become deadlocked by a popup that appears if a valid SCADA license key is not detected. This dialog simply asks if it is OK to run the SCADA system in demo mode, however it stops a connection to Historian until confirmation is received. This can be avoided by confirming that the citect.ini parameter [Debug]SysErrDsp is set to the default 0 on the machine that is the SCADA CTAPI server. This means Vijeo Citect/CitectSCADA will automatically operate in demo mode if a license key is not detected, with notification of this being sent as a hardware alarm. 4.9 Operating the Web Client with Internet Explorer 9 If you run the Historian Web Client in Internet Explorer 9, the browser may stop operating after a modal dialog box has appeared. This was addressed by Microsoft with the release of a Cumulative Security Update for Internet Explorer ( ) on June 14, To resolve this, install this update on the computer where you are attempting to run the Historian Web Client Operating the Web Client and Process Analyst with Internet Explorer 10 If you run the Historian Web Client or Process Analyst in Internet Explorer 10, the browser may show that the user name and password entered is not valid. To address this, go to Menu Bar Tools Compatibility View Settings and make sure that Display internet sites in Compatibility View is checked Historian Web Client and Process Analyst Settings If you run the Historian Web Client or Process Analyst in Internet Explorer 10, perform the following settings: 1. Go to Menu Bar Tools Internet Options Local Intranet. 2. In Security level for this zone pane, click Custom level.

6 3. Scroll down and enable the following: 4. Click OK. Download signed ActiveX controls Download unsigned ActiveX controls Initialize and script ActiveX controls not marked as safe for scripting 4.12 Running Configuration Manager as an MMC SnapIn Tool on a 64 Bit System The Historian Configuration Manager is a snapin tool that is designed to operate in a legacy 32bit version of Microsoft Management Console (MMC). When the Configuration Manager runs on a 64bit operating system, the Windows 64bit registry redirector substitutes %SystemRoot%\system32 with %SystemRoot%\sysWOW64. This has side effects on the operation of other snapin tools. The Historian installer is updated to include the system environment variable HISTORIAN_SYSTEM32. The value of this variable is set to system32 and is used to address the compatibility of Historian s legacy MMC tool with 64 bit operating systems. The environment variable is used in the following registry locations: HKEY_CLASSES_ROOT\mscfile\shell\Author\command HKEY_CLASSES_ROOT\mscfile\shell\open\command HKEY_CLASSES_ROOT\mscfile\shell\RunAs\command 4.13 New Sample Time Persistence Feature The Data Sources tab of the Historian Properties dialog includes a new check box labelled Persistthe last read sample times for tags. When selected, this feature updates the timestamp for a tag every sample period, even if the value has not changed. By default, Historian only stores the sample time of the last value change. This capability is included to support status tag calculations in Historian OPC HDA Server v4.31 and v4.40 or later Editing Reports with a Dual Install of SQL Server If you attempt to edit a report from the Reports Deployment Manager using the Save and Edit feature, the report typically opens in Visual Studio 2008 for editing. However, if you have both SQL Server 2008 and 2012 installed, the report always opens in Visual Studio If you then edit the report and try to build it, the build will be unsuccessful. If you want to edit a report on a computer that has this dual installation scenario, manually open Microsoft Visual Studio 2012 to edit and build your reports. 5 Known Issues with this Release The following are known issues with this release, which will be fixed in a later release: Bug Bug Bug Bug If a valid license dongle or softkey with CAL enabled is removed from historian server, the demo period for Historain Enquire and Process analyst will be started immediately and will be expired in 8 hours. To make it work again, please apply the valid license dongle or softkey back to historian server. Microsoft security updates KB blocks Historian Web client connected to server. To fix this issue, please refer to KB article Url: Download SCADA Tag Data Task is not working correctly. To fix this issue, add a new registry key DownloadTagTaskUserOption in HKEY_LOCAL_MACHINE\SOFTWARE\Citect\Historian\Task Manager and set the value to 1. Users, who wants a fix for this bug set this key value to 1. The data types from Non Vijeo Citect/CitectScada data sources may not be

7 6 Disclaimers mapped properly to Type field of the Historian Enquire when you are performing aggregate operations. This does not affect the actual aggregation of data. Disclaimer of All Warranties and Liabilities As detailed in paragraphs 9 to 10 of the End User Licence Agreement, SCHNEIDER ELECTRIC excludes all warranties and liabilities to the fullest extent permitted by law. CITECTHISTORIAN and all documentation are provided "AS IS" and your company understands that it assumes all risks pertaining to your use of CITECTHISTORIAN.

KYOCERA Net Admin Installation Guide

KYOCERA Net Admin Installation Guide KYOCERA Net Admin Guide Legal Notes Unauthorized reproduction of all or part of this guide is prohibited. The information in this guide is subject to change without notice. We cannot be held liable for