WWSystemPlatformCourse Part2 EntireManual

Training Manual
Revision B
December 2007
Part Number 11-GM-10001
W O N D E R W A R E T R A I N I N G
Wonderware System Platform
Course - Part 2
Wonderware Historian 9.0, ActiveFactory 9.2, Wonderware Information
Server 3.0
INFORMATION IN THIS DOCUMENT IS SUBJECT TO CHANGE WITHOUT NOTICE.
2007 by Invensys Systems, Inc. All rights reserved. No part of this document may be reproduced, stored in
or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical,
photocopying, recording or otherwise), or for any purpose, without the express written permission of Invensys
Systems, Inc. Except where noted, the companies, organizations, products, domain names, e-mail
addresses, logos, people, places and events depicted herein are fictitious and no association with any real
company, organization, product, domain name, e-mail address, logo, person, place or event is intended or
should be inferred.
Invensys and the author(s) assume no responsibility for errors or omissions and no liability is assumed for
damages resulting from the use of the information contained herein. Use of the Invensys software described
in this document is subject to the terms of the applicable Wonderware Corporation or Invensys Systems, Inc.,
license. These terms include provisions that limit your rights such as use restrictions, disclaimers of
warranties and limitations of Wonderware and Invensys liability. A copy of the applicable license will be
displayed upon initial installation of the software. If a copy of the license is not displayed or you require an
additional copy of the license, you may obtain one from Invensys' Wonderware business unit upon request by
calling 1.949.727.3200 or by sending an e-mail to support@wonderware.com.
Invensys; Wonderware; ActiveFactory; ArchestrA; DT Analyst; FactorySuite; FactorySuite A2; InBatch;
InControl; IndustrialSQL Server; InTouch; InTrack; QI Analyst; SCADAlarm; SPCPro; SuiteLink;
SuiteVoyager; WindowMaker; WindowViewer; Every system in your plant, working in concert; and the
Visualize, Analyze, Optimize logo are trademarks or service marks of Invensys plc, its subsidiaries and
affiliated companies. All other brands and product or service names may be the trademarks or service marks
of their respective owners.
Table of Contents 1
Wonderware System Platform Course - Part 2
Table of Contents
Module 1 Introduction .................................................................................1-1
Section 1 Course Introduction......................................................................... 1-3
Section 2 Introduction to the Wonderware Historian..................................... 1-19
Section 3 Introduction to ActiveFactory Software......................................... 1-25
Section 4 Introduction to Wonderware Information Server........................... 1-27
Module 2 Historian Configuration ..............................................................2-1
Section 1 Software, Hardware and Network Considerations.......................... 2-3
Section 2 System Licensing and Installation Notes ..................................... 2-13
Lab 1 Create a Galaxy ........................................................................... 2-17
Section 3 ArchestrA System Management Console Interface...................... 2-25
Section 4 System Configuration.................................................................... 2-31
Lab 2 Configuration................................................................................ 2-35
Module 3 History Data Storage and Retrieval ...........................................3-1
Section 1 Data Retrieval ................................................................................. 3-3
Section 2 Historian Time Domain Extensions................................................. 3-9
Lab 3 Query Examples........................................................................... 3-25
Module 4 ActiveFactory Trend ...................................................................4-1
Section 1 Introduction to ActiveFactory Software........................................... 4-3
Section 2 ActiveFactory Trend........................................................................ 4-7
Lab 4 Use ActiveFactory Trend Basic Functions.................................... 4-31
Lab 5 Configure Public Groups and Trend Sets..................................... 4-45
Lab 6 Configure Time Offsets and Target Regions................................ 4-57
Lab 7 Advanced Properties: Retrieval Styles......................................... 4-65
Module 5 ActiveFactory Workbook............................................................5-1
Section 1 Introduction..................................................................................... 5-3
Lab 8 Using ActiveFactory Workbook Basic Functions.......................... 5-21
Lab 9 Use Other ActiveFactory Workbook Functions............................. 5-31
Lab 10 Use the Tag Analysis Wizard..................................................... 5-37
Lab 11 Create an Hourly-Average Shift Report...................................... 5-41
Module 6 ActiveFactory Query ...................................................................6-1
Lab 12 Use ActiveFactory Query ............................................................. 6-9
Lab 13 Use ActiveFactory Query in Excel.............................................. 6-23
Module 7 ActiveFactory Report ..................................................................7-1
Lab 14 Using ActiveFactory Report.......................................................... 7-7
Lab 15 Wildcard Time Options and Report Editing................................ 7-15
Module 8 Manual Data.................................................................................8-1
Section 1 Manual Data Acquisition Service (MDAS) ...................................... 8-3
Lab 16 Importing Original Data ................................................................ 8-7
Lab 17 Importing Versioned Data........................................................... 8-11
Module 9 Historian Event System..............................................................9-1
2 Wonderware System Platform Course - Part 2
Wonderware Training
Section 2 Defining Event Tags........................................................................9-9
Lab 18 Create Events ............................................................................9-15
Section 3 ActiveEvent ...................................................................................9-33
Lab 19 Using ActiveEvent.......................................................................9-37
Module 10 Introduction to Information Server ......................................... 10-1
Section 1 Hardware and Software Requirements .........................................10-3
Section 2 Information Server License Management .....................................10-5
Lab 20 Licensing Management...............................................................10-9
Module 11 Process Graphics ..................................................................... 11-1
Section 1 Convert & View InTouch Windows Over the Web.........................11-3
Lab 21 Convert and View InTouch Windows Over the Web.................11-25
Section 2 Configuring Write-Back for Factory Data Sources ......................11-37
Lab 22 Configuring Write-Back Access ................................................11-39
Module 12 Information Server Data Sources............................................ 12-1
Section 1 Configuring Data Sources .............................................................12-3
Section 2 Alarm Database Logger Utility.......................................................12-7
Lab 23 Configuring Data Sources.........................................................12-11
Module 13 Factory Alarms ......................................................................... 13-1
Section 1 Visualizing Factory Alarms............................................................13-3
Lab 24 Visualizing Factory Alarms..........................................................13-7
Module 14 ActiveFactory Reporting.......................................................... 14-1
Section 1 Introduction....................................................................................14-3
Section 2 Reports..........................................................................................14-7
Lab 25 Publishing Trend Reports .........................................................14-17
Lab 26 Publishing Workbook Reports...................................................14-25
Lab 27 Publishing Tag and Time Bound Reports .................................14-31
Section 3 Custom Folders...........................................................................14-43
Lab 28 Creating Report Folders............................................................14-45
Module 15 Table Weaver ............................................................................ 15-1
Section 2 Defining Queries............................................................................15-9
Section 3 Defining Content Units ................................................................15-15
Lab 29 Define a Content Unit................................................................15-19
Section 4 Defining Displays.........................................................................15-27
Lab 30 Add Custom Displays to the Content Unit.................................15-33
Section 5 Defining Key Performance Indicators (KPIs)...............................15-45
Lab 31 Add KPIs to the Content Unit....................................................15-49
Section 6 Defining Links..............................................................................15-57
Lab 32 Add Links to the Content Unit...................................................15-61
Lab 33 Create a Filter Query................................................................15-73
Module 16 MultiViews ................................................................................. 16-1
Section 1 MultiViews .....................................................................................16-3
Lab 34 Configuring MultiViews .............................................................16-17
Section 2 Using Web Parts in MS SharePoint ............................................16-33
Module 17 ArchestrA Reports.................................................................... 17-1
Table of Contents 3
Module 18 Information Server Security and Customization....................18-1
Section 1 Managing Security........................................................................ 18-3
Lab 35 User Manager........................................................................... 18-15
Section 2 Panel Manager............................................................................ 18-29
Lab 36 Configuring Panel Manager...................................................... 18-37
Section 3 Portal Configuration.................................................................... 18-49
Lab 37 Portal Configuration.................................................................. 18-55
Section 4 Backup and Restore Utility.......................................................... 18-63
Appendix A Supported Animations & Scripts .............................................. A-1
Appendix B Using Web Parts in MS SharePoint .......................................... B-1
4 Wonderware System Platform Course - Part 2
Wonderware Training
Intentionally left blank
Module 1
Introduction
Section 1 Course Introduction 1-3
Section 2 Introduction to the Wonderware Historian 1-19
Section 3 Introduction to ActiveFactory Software 1-25
Section 4 Introduction to Wonderware Information Server 1-27
1-2 Module 1 Introduction
Wonderware Training
Module Objectives
Introduce and describe course and product elements
Introduce the Wonderware System Platform components
Explain software considerations
Section 1 Course Introduction
This section describes the Wonderware System Platform Course - Part 2, the objectives of the
course, intended audience, prerequisites, and the course agenda. It also includes a description of
Wonderware Products.
Course Overview
The Wonderware System Platform Course - Part 2 is a five-day instructor-led class designed to
provide you with a fundamental understanding of the Wonderware
software involved in
information management, delivery, analysis and remote visualization for the Wonderware System
Platform. This class is the second part of a 2-part series. Part 1 provided you with the knowledge
necessary to develop and support applications using Wonderware Application Server.
In Part 2, key concepts and terms associated with the Wonderware Historian 9.0, ActiveFactory
9.2 and the Wonderware Information Server 3.0 are discussed. You will learn how they integrate
with ArchestrA
technology to extend the capabilities of the System Platform.

You will also learn how to use the Historian, a high-performance real-time and historical database
for SCADA and factory data, as a historian and data provider for applications based on the
Application Server. You will learn how to visualize and analyze data stored in the Historian using
the trending, analysis and reporting capabilities of ActiveFactory software. Finally, you will learn
how to use Information Server web analysis software to implement remote visualization, reporting
and analysis.
Course Objectives
Upon completion of this course, you will be able to:
Utilize the Historian as a storage location for plant data from applications developed with
the Application Server, including live and historical production data, configuration data,
and business data
Retrieve and report factory data using the ActiveFactory suite of Historian clients
Utilize the Information Server for web visualization, reporting and analysis
Audience
Plant floor engineers and managers, system administrators, system integrators and other
individuals who need to use the System Platform software in their manufacturing processes.
Prerequisites
The prerequisites for this course are:
Completion of Getting Started with IndustrialSQL Server web tutorial
http://www.wonderware.com/training/online_training/tutorials.asp
Section Objectives
Welcome participants
Familiarize participants with the Course Objectives and agenda for the class
Review Wonderware Products fundamentals
Wonderware Training
Completion of Getting Started with ActiveFactory web tutorial
Completion of Getting Started with SuiteVoyager web tutorial
Microsoft Windows experience
Manufacturing industry experience
Agenda
Module 1 Introduction
Section 1 Course Introduction
This section describes the Wonderware System Platform Course - Part 2, the objectives of the
course, intended audience, prerequisites, and the course agenda. It also includes a
description of Wonderware Products.
Section 2 Introduction to the Wonderware Historian
This section describes Historian in detail. It introduces the key features, architectures, and
system requirements.
Section 3 Introduction to ActiveFactory Software
This section describes ActiveFactory in detail. It introduces the key features, architectures,
and system requirements.
Section 4 Introduction to Wonderware Information Server
This section describes Information Server in detail. It introduces the key features,
architectures, and system requirements.
Module 2 Historian Configuration
Section 1 Software, Hardware and Network Considerations
This section explains the software and hardware considerations and requirements for the
Historian, as well as network considerations.
Section 2 System Licensing and Installation Notes
This section explains Historian Licensing strategy, and explains installation strategies for the
Historian and for Microsoft SQL Server.
Lab 1 Create a Galaxy
Section 3 ArchestrA System Management Console Interface
This section introduces and explains the ArchestrA System Management Console (SMC)
Interface Elements.
Section 4 System Configuration
This section introduces and explains the Historian System Configuration. It also introduces
Dynamic Configuration of the Historian parameters.
Lab 2 Configuration
Module 3 History Data Storage and Retrieval
Section 1 Data Retrieval
This section explains the Data Retrieval Subsystem and features for the Historian.
Section 2 Historian Time Domain Extensions
This section explains the Data Retrieval Subsystem and Features for the Historian.
Lab 3 Query Examples
Module 4 ActiveFactory Trend
This section describes the ActiveFactory system requirements, installation considerations, and
licensing features.
Section 2 ActiveFactory Trend
This section introduces the ActiveFactory Software system requirements, installation
considerations, and licensing features.
Lab 4 Use ActiveFactory Trend Basic Functions
Lab 5 Configure Public Groups and Trend Sets
Lab 6 Configure Time Offsets and Target Regions
Lab 7 Advanced Properties: Retrieval Styles
Module 5 ActiveFactory Workbook
Section 1 Introduction
This section explains the ActiveFactory Workbook uses and operation.
Lab 8 Using ActiveFactory Workbook Basic Functions
Lab 9 Use Other ActiveFactory Workbook Functions
Lab 10 Use the Tag Analysis Wizard
Lab 11 Create an Hourly-Average Shift Report
Module 6 ActiveFactory Query
This section explains the ActiveFactory Query uses and operations.
Lab 12 Use ActiveFactory Query
Lab 13 Use ActiveFactory Query in Excel
Module 7 ActiveFactory Report
Lab 14 Using ActiveFactory Report
Lab 15 Wildcard Time Options and Report Editing
Module 8 Manual Data
Section 1 Manual Data Acquisition Service (MDAS)
This section explains the Manual Data Acquisition Service (MDAS) and how it acquires data.
Wonderware Training
Lab 16 Importing Original Data
Lab 17 Importing Versioned Data
Module 9 Historian Event System
This section introduces and explains the Historian Event System.
Section 2 Defining Event Tags
This section explains and defines Historian Event Tags and their characteristics.
Lab 18 Create Events
Section 3 ActiveEvent
Lab 19 Using ActiveEvent
Module 10 Introduction to Information Server
Section 1 Hardware and Software Requirements
This section introduces you to the hardware and software required to install and operate a
Information Server.
Section 2 Information Server License Management
This section introduces you to the details of Information Server licensing, including viewing,
querying and configuring active and historical license data.
Lab 20 Licensing Management
Module 11 Process Graphics
Section 1 Convert & View InTouch Windows Over the Web
This section introduces and walks you through the tools and steps necessary to publish your
InTouch windows onto a Information Server web portal for Internet viewing.
Lab 21 Convert and View InTouch Windows Over the Web
Section 2 Configuring Write-Back for Factory Data Sources
This section introduces you to the tools and steps necessary to enable write-back capabilities
for factory data sources using the Information Server portal.
Lab 22 Configuring Write-Back Access
Module 12 Information Server Data Sources
Section 1 Configuring Data Sources
This section walks you through the tools and steps necessary to add and configure a variety of
data sources.
Section 2 Alarm Database Logger Utility
This section describes the steps necessary to configure and start the Alarm Database Logger
utility in order to capture historical alarm data for viewing in Information Server.
Lab 23 Configuring Data Sources
Module 13 Factory Alarms
Section 1 Visualizing Factory Alarms
This section introduces you to the steps necessary to configure and view current and historical
factory alarms.
Lab 24 Visualizing Factory Alarms
Module 14 ActiveFactory Reporting
This section provides an overview of the ActiveFactory Reporting Website component of
Information Server.
Section 2 Reports
This section introduces the reporting features available in ActiveFactory Reporting.
Lab 25 Publishing Trend Reports
Lab 26 Publishing Workbook Reports
Lab 27 Publishing Tag and Time Bound Reports
Section 3 Custom Folders
This section explains how to add custom report folders, static report folders and subfolders,
and how to publish reports to custom folders.
Lab 28 Creating Report Folders
Module 15 Table Weaver
This section introduces the Information Server Table Weaver add-on application. Table
Weaver provides a table and chart display with customizable queries and drill-down
capabilities.
Section 2 Defining Queries
This section uses the Query function of the Table Weaver to define queries for a specific data
source type.
Section 3 Defining Content Units
Wonderware Training
This section uses the Content Unit area of the Table Weaver Manager to select the Data
Source, Query, Display, Link, and KPI definitions to define a Content Unit. You will define a
Content Unit.
Lab 29 Define a Content Unit
Section 4 Defining Displays
This section introduces the Display component of the Table Weaver and uses it to define a
table and a chart display. You will add a Display component to a Content Unit.
Lab 30 Add Custom Displays to the Content Unit
Section 5 Defining Key Performance Indicators (KPIs)
This section introduces the Key Performance Indicator (KPI) component of the Table Weaver.
You will define a KPI and its parameters and then add it to a content unit to enhance the value
of the Display.
Lab 31 Add KPIs to the Content Unit
Section 6 Defining Links
This section uses the Links component of the Table Weaver. You will define links and add
them to a Content Unit. These Links will create a drill-down capability for the Display created
earlier. You will create a Filter Query to create a search capability within a Content Unit.
Lab 32 Add Links to the Content Unit
Lab 33 Create a Filter Query
Module 16 MultiViews
Section 1 MultiViews
This section introduces Web Part technology and walks you through the steps necessary to
create and view multiple Web Parts simultaneously.
Lab 34 Configuring MultiViews
Section 2 Using Web Parts in MS SharePoint
Module 17 ArchestrA Reports
Module 18 Information Server Security and Customization
Section 1 Managing Security
This section introduces the security features of Information Server. It walks you through the
steps necessary to configure access, grant privileges using roles and enable write-back
privileges.
Lab 35 User Manager
Section 2 Panel Manager
This section introduces the Information Server Panel Manager and walks you through the
steps necessary to configure Access Panels.
Lab 36 Configuring Panel Manager
Section 3 Portal Configuration
This section walks you through the steps necessary to customize the Home Page of your
Information Server Web Portal.
Lab 37 Portal Configuration
Section 4 Backup and Restore Utility
This section walks you through the steps necessary to backup and restore your Information
Server portal configuration.
The following software is installed on your desktop for purposes of this training class:
InTouch HMI software
Wonderware Application Server
Information Server
ActiveFactory Software
Wonderware Historian
Microsoft SQL Server
Wonderware Training
Wonderware Software Solutions
WonderwareSoftware Solutions provide valuable tools for optimizing and standardizing your
industrial organization. They offer essential time- and cost-saving techniques that increase
efficiency and reduce application engineering effort and deployment.
The solutions deliver manufacturing and operational performance improvements that can reduce
the amount of project-specific work required to develop information and automation applications
that are integrated across entire operational enterprises. These solutions can also be implemented
in the context of existing systems, at your own pace and to the extent that you choose.
The Wonderware solutions leverage a powerful, layered software architecture that enables a
variety of features and capabilities.
Microsoft Technologies, such as Microsoft Windows, Microsoft SQL Server, and
.NET, are applied as a basis, enabling compatibility with commercial IT hardware and
software.
Wonderware System Platform and Wonderware Client Software provide a
comprehensive set of services and capabilities to enable an industrial infrastructure that
includes all the necessary functions needed by any industrial application solution.
Function-Specific Modules make it easier than ever before to optimize production and
performance management by providing common tools for a variety of functions, from
tracking production orders to analyzing performance data.
Wonderware QuickStarts provide examples of configuration best practices, pre-defined
graphics, and Web reports, using a fully functional and documented demo application.
All Wonderware Software Solutionswhether in the areas of Supervisory HMI, Production and
Performance Management, or Geo-SCADAleverage the comprehensive ArchestrAindustrial
automation and information software architecture.
The Wonderware System Platform provides a single platform for all the SCADA, Supervisory HMI,
and Production and Performance Management needs of industrial automation and information
personnel. The Wonderware System Platform, built on ArchestrA technologies, is a strategic
application infrastructure. Its modular approach allows new application components to be created
now, with the understanding that the requirements, and even the application itself, could
completely change tomorrow.
Functional Capabilities
The Wonderware System Platform contains an integral core set of capabilities and services to
support sustainable production and operations performance improvements via a comprehensive
set of six capability areas:
Industrial domain services for industrial computing functions that are not provided by
commercial operating systems or products
Software and device connectivity services for easy communication to any plant or
business information source
Information and data management services for management of real-time and historical
information
Information-delivery and visualization services for functions that provide information to
the right user at the right time, and in the form in which they expect it
Application development services that provide easy and intuitive development of
modular industrial software solutions that are easily changed to meet future needs
System management and extensibility services that provide easy management,
expansion, and modification of the application or host computing architecture
Software Applications -
Business Systems, MES
Databases
Existing HMIs,
Historian, Lab Systems,
CMMs
Field Devices - PLCs,
RTUs, DCS
Application
Development
Industrial Domain
Features
Information Delivery
and Visualization
System Mgmt and
Extensibility
Database and
Historian
Information and
Data Management
Software and Device Connectivity
ArchestrA
Applications Architecture
Wonderware Clients
3rd Party
Clients
Modular Industrial and Manufacturing Solutions
Wonderware Training
System Platform Components
The Wonderware System Platform consists of a variety of software components.
Wonderware Application Server (formerly known as Industrial Application Server)
framework for system-wide, real-time data acquisition, alarm and event management,
centralized security, data manipulation, remote deployment, and collaborative engineering
Wonderware Historian (formerly known as IndustrialSQL Server) plant data historian
Wonderware Information Server (formerly known as SuiteVoyager) industrial portal
software for Internet/intranet visualization and content management
Wonderware Device Integration Tools for field device connectivity
Wonderware Clients
Wonderware InTouch View human-machine interface (HMI) software as a visualization
client for the System Platform
ActiveFactory trending and analysis software
Reporting Client-Access Licenses for Information Server to enable information-sharing
and reporting over the Web
Wonderware Functional Modules
To complement the capabilities and benefits offered by the Wonderware System Platform,
Wonderware also offers a set of easily implemented add-on modules to assist you in the areas of
Performance Management, Production Management, Supervisory Control, and Geo-SCADA.
Historian
(InSQL)
S/W
Applications
DB, MES
3
rd
Party
Data Sources
HMI, LIMS
Field Devices
PLC, RTU
DCS
Application Server
(IAS)
Information Server
(SuiteVoyager)
Device Integration
Wonderware Clients
InTouch View ActiveFactory
Reporting Client
(Information Server CAL)
Functional
Modules
Historian
(InSQL)
S/W
Applications
DB, MES
3
rd
Party
Data Sources
HMI, LIMS
Field Devices
PLC, RTU
DCS
Application Server
(IAS)
Application Server
(IAS)
Information Server
(SuiteVoyager)
Information Server
(SuiteVoyager)
Device Integration Device Integration
Wonderware Clients
InTouch View ActiveFactory
Reporting Client
Wonderware Clients
InTouch View InTouch View ActiveFactory ActiveFactory
Reporting Client
Reporting Client
Functional
Modules
Functional
Modules
Production and Performance Management Software Solutions
Wonderware provides tools that empower you to take a proactive approach to production and
performance management. Appropriate for a wide range of manufacturing and production
operations, these integrated software applications are designed to drive operational improvements
and substantially decrease total cost of ownership.
These software solutions:
Integrate with your existing plant, IT and business systems, creating one effective system
for the entire organization
Leverage a single, open and scalable software architecture called the ArchestrA industrial
automation and information software architecture
Complete MES and flexible batching capabilities that can help you actively manage
production and collect data for analysis and reporting
Enable secure, wide-scale delivery of reports on KPIs, downtime, OEE, and SPC through
a powerful portal that delivers the information contextually
Improve data analysis and information sharing with advanced trending and reporting
capabilities
Wonderware Training
Product Offerings
The Wonderware Production and Performance Management Software Solutions consist of a
variety of products:
Wonderware System Platform providing a core set of service capabilities as a
foundation for application development, operations, and information delivery
InBatch flexible batch management software
Manufacturing Execution Module (formerly known as InTrack) resource and WIP
tracking software
Equipment Operations Module for formula management including product definitions
and equipment setups, and for capturing and storing information from production events
including product and production history and genealogy
Equipment Performance Module (formerly known as DT Analyst) equipment
downtime tracking and performance management software
QI Analyst for using real-time and historical data to monitor, analyze, and predict
potentially harmful process variations, allowing for online adjustments for improved
production quality and consistency
Supervisory HMI Software Solutions
The Wonderware market-leading Supervisory HMI Software Solutions can be applied in process,
discrete, and hybrid markets where there is demand for an information and automation
infrastructure for centralized monitoring and control. These software solutions enable plant
personnel to:
Easily design, build, deploy and maintain the most flexible and secure supervisory
solutions with the lowest total life-cycle costs
Scale from a single machine up to multiple networked supervisory stations
Integrate plant devices, databases, and control systems
Incorporate strong security at the data-element level and for every user in the system
Rapidly expand production and performance management solutions
Standardize on a common set of supervisory HMI tools at all levels of the plant with
rugged Wonderware Industrial Tablets and Touch Panel Computers, which are pre-
bundled with powerful visualization software
Product Offerings
The Wonderware Supervisory HMI Software Solutions consist of a variety of products:
InTouch human-machine interface (HMI) software for process visualization and control
InControl real-time control software
Geographically Distributed SCADA (Geo-SCADA) Software Solutions
Since the late 1980s, the Wonderware Geographically Distributed (Geo-SCADA) Software
Solutions have been present in almost every industry including water & wastewater, oil & gas,
facility management, power delivery, transportation, and telecommunications.
These solutions offer several unique features that can greatly benefit companies looking to
implement a new SCADA solution or upgrade an existing system.
The easiest and most efficient, open software solution for SCADA
Highly available, reliable, and scalable SCADA applications
Single-click software redundancy
Leverages ArchestrA architecture for easy configuration and management of operational
and system security that is compatible with existing IT security capabilities
Empowers users to design, build, deploy, and maintain standardized SCADA applications
Lowest total system lifecycle costs
Product Offerings
The Wonderware Geo-SCADA Software Solutions consist of a variety of products:
foundation for application development, operations, and information delivery.
SCADAlarm event notification software for real-time alarm notification, data acquisition,
and remote control from telecommunication devices to industrial automation software
systems
Wonderware Training
Wonderware Individual Software Products
All the latest Wonderware software offerings leverage the latest ArchestrA technology and are
essential to the Wonderware Production and Performance Management, GEO-SCADA, and
Supervisory HMI Software Solutions.
The following Wonderware products offer increased functionality and flexibility as well as
extensive connectivity:
Wonderware Application Server (formerly known as Industrial Application Server) for
system-wide, real-time data acquisition, alarm and event management, centralized
security, data manipulation, remote deployment, and collaborative engineering
ArchestrA Object Toolkit for creating application objects for use within the
Wonderware Application Server
Functional Modules for seamlessly integrating new functional capabilities into
Wonderware Application Server applications using a modular approach, including:
Equipment Operations Module for formula management and real-time production
events collection
Equipment Performance Module (formerly known as DT Analyst) for equipment
downtime tracking and performance management
Manufacturing Execution Module (formerly known as InTrack) for resource and
WIP tracking
Wonderware Historian (formerly known as IndustrialSQL Server) real-time historian for
SCADA and factory data
Wonderware Information Server (formerly known as SuiteVoyager) Web analysis
software for Internet/intranet visualization and content management
Device and Software Connectivity Tools offering a library of hundreds of DA Servers
and I/O Servers, the DA Server Toolkit, and Device Integration (DI) Objects
InTouch View human-machine interface (HMI) software as a visualization client for the
System Platform
ActiveFactory trending and analysis software for accelerating and improving decision-
making at all levels within an organization
QI Analyst statistical process and quality control software to predict process variations
and enable online adjustments for improved production
InControl real-time control software
InBatch flexible batch management software
SCADAlarm event notification software for real-time alarm notification, data acquisition,
and remote control from telecommunication devices to industrial automation software
systems
InTouch for Terminal Services software for remote hosting of InTouch applications
Wonderware software offers robust, best-of-breed software components that empower customers
to effectively develop and manage their automation and information applications in continuous,
discrete, process, hybrid, and batch manufacturing environments.
The Wonderware mission is to power intelligent plant decisions in real time.
ArchestrA Framework
ArchestrA provides an infrastructure for simplifying the development, deployment, lifecycle
maintenance, and administration of distributed automation applications.
The supervisory control and manufacturing information environment is served by a variety of
systems, including (HMI), Distributed Control Systems (DCS), Supervisory Control and Data
Acquisition systems (SCADA), Process Information Management systems (PIM), Manufacturing
Execution Systems (MES), batch and recipe management systems, and advanced control/
simulation systems.
ArchestrA leverages advanced software technologies to fill the gap between ERP systems and the
control systems. This architecture provides the following:
Framework which supports common services and a core set of system objects
Domain Objects which are industry-specific objects
Object Development Toolkit which allows third parties to create new domain objects
customized for specific needs
The ArchestrA infrastructure, or Framework, supports core services that are required by most of
the different types of supervisory control and manufacturing information systems mentioned
above. These core services include the following:
Integrated development environment
Version management
License management and centralized deployment
System diagnostics and system administration
Internationalization
Data visualization and monitoring
Event based processing, scripting, and calculation capabilities
Alarm and event management, historization, and security
Data acquisition and field device integration
Inter-object communications and name service
Reporting and ad-hoc query capability
Support for industry standards such as OPC and SQL
The ArchestrA Framework consists of the following:
Configuration and Deployment Related Components that are required for centralized
deployment of the runtime components. These components are installed just like any
other Windows
application and include the following:

Centralized object repository (called Galaxy Repository)
Integrated development environment (IDE)
Object deployment services (called Bootstrap)
Runtime Components that are centrally deployed and administered. These components
include the following:
PCs with core infrastructure (called Platforms)
Key software applications (Engines)
Objects (Framework Objects) that expose framework related functionality
Wonderware Training
Section 2 Introduction to the Wonderware Historian
Introduction
This section describes Historian in detail. It introduces the key features, architectures, and system
requirements.
The Historian system bridges the gap between the real-time high-volume plant monitoring and
control environment and the open and flexible business information environment.
The Historian, which contains an embedded Microsoft
SQL Server, acquires plant data via

high-speed Wonderware DAS Servers and I/O Servers, compresses and stores the data, and then
responds to SQL requests for the plant data. The Historian also contains event, summary,
configuration, security, backup, and system monitoring information.
Process Data and Relational Databases
Relational Databases
In Relational Database Management System (RDBMS), information is stored in multiple tables
that are related, or linked, together. Storing and accessing information in these multiple tables is
far faster than if all of the information were stored in a single large table. Microsoft SQL Server is a
RDBMS.
SQL, the language used to communicate with relational database, is an industry "super-standard
supported by hundreds of software vendors. It provides an openness unmatched in the plant
environment. Relational databases are mature and are the accepted IT workhorses in database
applications today. SQL offers far superior power and flexibility than proprietary interfaces that
have come out of the plant environment.
RDBMS Limitations
A typical relational database is not a viable solution for storing plant data because of the following
limitations:
Cannot handle the volume of data produced by plants
Cannot handle the rapid storage rate of plant data
SQL does not effectively handle time-series data
Industrial plants have many thousands of tags, all changing at different rates. Several months of
plant history result in hundreds of gigabytes of data in a normal relational database.
Also, a plant with 10,000 variables changing on the average of every two seconds is generating
5,000 values per second. 5,000 rows of data must therefore be inserted into the database each
second in order to store a complete history. This transaction rate is non-sustainable by normal
relational databases like Oracle or SQL Server.
Section Objectives
Introduce the Historian
Explain its main features
Wonderware Training
The Historian as a Real-time Relational Database
As a real-time relational database, the Historian is an extension to Microsoft SQL Server, providing
more than an order of magnitude increase in acquisition speeds, a corresponding reduction in
storage volume, and elegant extensions to structured query language (SQL) for querying time
series data.
High-Speed Data Capture
The comprehensive range of Wonderware I/O Servers is used to connect to over 500 control and
data acquisition devices.
Designed for optimal acquisition and storage of analog and discrete data, the Historian
outperforms all normal relational databases on similar hardware by a wide margin, making the
storage of high-speed data in a relational database possible. The Historian acquires and stores
process data 100 times faster than a RDBMS.
All newer Wonderware I/O Servers support the SuiteLink protocol. SuiteLink allows for time and
quality stamping at the I/O Server and further improves the rate of data acquisition.
Reduced Storage Space
The Historian stores the data in a fraction of the space that would be required by a normal
relational database. The actual disk space required to store plant data depends on the size and
nature of the plant and the length of the plant history required.
The compression algorithm is a loss-less algorithm, assuring high resolution and high quality data.
Time Domain Extensions to SQL
The SQL language does not have support for time series data. In particular, there is no way to
control the resolution of returned data in SQL. An example of resolution would be an evenly
spaced sampling of data over a period of time.
Microsoft SQL Server supports its own additions to the SQL language, called Transact-SQL. The
Historian extends Transact-SQL, allowing control of resolution and providing the basis for time-
related functions such as rate of change and integral process calculations on the server.
Integration with MS SQL Server
A large amount of plant-related data has the same characteristics as normal business data. For
example, configuration data is relatively static or does not change at a real-time rate. Over the life
of a plant, tags are added and deleted, descriptions are changed, and engineering ranges are
altered. A Microsoft SQL Server database, called the Runtime database, is used to store this type
of information.
The Runtime database is the SQL Server online database for the entire Historian system. The
Runtime database is shipped with all of the database entities, such as tables, views, and stored
procedures that are necessary to store the configuration data for a typical factory.
In order to understand how to retrieve Historian data, it is first necessary to understand how the
Historian interacts with Microsoft SQL Server and how data storage is expedited between them.
The following figure illustrates a high-level view of Historian data storage:
Microsoft SQL Server:
Stores Configuration and Event Data. This is data that is unlikely to change significantly
over time.
The data is sometimes referred to as Static data.
Historian:
Stores high-speed process data in files called History Blocks.
Data is accessed via the tables listed in the above figure.
This data is sometimes referred to as Dynamic data.
Wonderware Training
Object Linking and Embedding for Databases (OLE DB) is an application programming interface
(API) that allows COM-based client applications to access data that is not physically stored in the
Microsoft SQL Server to which they are connecting.
OLE DB providers enable much easier and more robust linking and retrieval of data stored in the
Microsoft SQL Server databases and the history blocks. Also, the Historian OLE DB provider has a
richer set of query capabilities than the Open Data Services (ODS) interface.
The name of the Historian OLE DB provider is INSQL. The INSQL OLE DB provider is installed
during Historian installation and then associated, or linked, with the Microsoft SQL Server.
The benefit of using OLE DB is that it provides access to different types of data in a broader
manner. By using OLE DB, you can simultaneously access data from a variety of sources, such as
from a Microsoft SQL Server database, an Oracle database, and a Microsoft Access database.
A query that accesses data from multiple, dissimilar data sources is called a heterogeneous
query, with "heterogeneous" meaning "dissimilar." A heterogeneous query can also be called a
"distributed query," since the data can be distributed across various data sources.
The ArchestrA System Management Console is used to easily add configuration data to the
Runtime database that reflects your factory environment.
Microsoft SQL Server Object Linking and Embedding for Databases (OLE DB) is used to access
the real-time plant data that Historian stores outside of the SQL Server database. You can query
the Microsoft SQL Server for both configuration information in the Runtime database and historical
data on disk, and the integration appears seamless.
Since Historian embeds a Microsoft SQL Server, it can leverage all of the features that Microsoft
SQL Server has to offer, such as database security, replication, and backups.
Support for SQL Clients
The Historian client/server architecture supports client applications on the desktop, while ensuring
the integrity and security of the data on the server. This client/server architecture provides
common access to plant and process data: real-time and historical data, associated configuration,
event, and business data.
The computing power of both the client and the server are exploited by optimizing processor
intensive operations on the server and minimizing data to be transmitted on the network to
improve system performance.
The gateway for accessing any type of information in the Historian is through the Microsoft SQL
Server. Thus, any client application that can connect to Microsoft SQL Server can connect to the
Historian.
Two categories of client applications can be used to access and retrieve information from the
Historian:
Clients developed specifically to access data from the Historian. Wonderware provides a
number of client tools to address specific data representation and analysis requirements.
Any third-party query tool that can access SQL or ODBC data sources. Numerous
commercial querying and reporting tools are available that provide rich, user-friendly
interfaces to SQL-based data.
All client tools with an interface to Microsoft SQL Server or ODBC are suitable for
Historian data access and reporting.
Historian Subsystems
Configuration
Setting up the required databases and included entities (such as tables, stored procedures, and
views) to support a typical factory environment would take countless hours. However, when you
install the Historian, all of these entities are defined for you, allowing you to quickly start using the
system.
Configuration data is stored in SQL Server tables in the Runtime database. Configuration data
includes tag definitions, I/O Server definitions, storage locations for historical data files, and so on.
If you are already using InTouch, you can easily import much of this information from existing
InTouch applications, thus preserving your engineering investment. You can also use the
ArchestrA System Management Console application to manually add definitions and configure the
system.
You can reconfigure the system at any time with no interruption in the acquisition, storage, and
retrieval of unaffected tags. Configuration data is stored with a complete revision history.
Data Acquisition
The Historian is designed for high-speed acquisition of data.
Custom client applications can be another source for real-time historical data. Clients that are
developed with the Historian manual data acquisition interface such as Application Server can
send historical tag values directly to the system.
Finally, you can batch import any historical data that adheres to a defined.csv format and insert or
update data via T-SQL queries, enabling migration of existing data from other historians.
Data Storage
Configuration data is stored in SQL Server tables in the Runtime database, as well as data for
event detections and actions. High-speed, large-volume analog, discrete, and string tag data,
however, is stored in files on the hard disk. This allows the Historian to store historical data in a
fraction of the space that would be required by a normal relational database. Compact storage
formats and loss-less compression algorithms reduce the storage space requirements to as little
as two percent of the space that would be required in a standard relational database. Upon
retrieval, historical data is presented via the Historian OLE DB provider as if it were stored in SQL
Server tables.
Wonderware Training
Data Retrieval
The Historian appears to client applications as a Microsoft SQL Server. the Historian receives SQL
queries and then locates, processes, and returns the data. Microsoft Transact-SQL is extended
with the Historian time domain extensions, providing support for time-series data.
Since the Historian is a relational database, queries can join data across multiple tables to retrieve
data efficiently. Some examples of database queries possible with the Historian are:
Average vibration of a motor each day over the last month when the load is greater than x.
Annotation for a discrete tag that was archived to a backup drive six months ago.
The limit of an analog tag in the context of a normal production mode. The limit of the
same analog tag in the context of an accelerated production mode.
The values for 50 specified analog tags at a point in time when the value of x was greater
than 10.
The path to the storage location for a specific tag.
20 evenly distributed data values from the total values stored for an analog tag between
8:00 and 8:30 a.m. on September 12, 2007.
All data values at 20-minute intervals from the total values stored for an analog tag
between 8:00 and 8:30 a.m. on September 12, 2007.
All values of an analog tag stored on J anuary 8, 2007, where the value of the analog tag
changed by 10 engineering units. The data for this analog tag was stored if the value
changed by 5 engineering units.
All values for tags associated with an event boiler trip on J anuary 8, 2007.
Event
The event system allows users to define events and associate actions with the detection of those
events. Plant events range from startups and shutdowns, through trips and shift changes, to batch
events and operator actions.
Detecting and recording these events puts continuous data into meaningful context. The Historian
detects events by executing event detectors against historical data. Actions can then be taken as a
result of the event detection.
For example, the detection of a boiler trip could result in the generation of a shift report, the
detection of a shift change could result in the updating of a production web page, the detection of a
plant failure could result in an e-mail to maintenance, and so on.
Introduction
This section describes ActiveFactory in detail. It introduces the key features, architectures, and
system requirements.
Whether you're an operator, process engineer, or manager, ActiveFactory client tools help you
organize, explore, analyze, present and disseminate your process data in a wide variety of
formats. All of this can be done from your desktop computer.
Wonderware ActiveFactory client tools integrate tightly with the most popular Microsoft Office
tools.
Wonderware ActiveFactory client tools are integrated with the Historian as a full-featured suite of
client applications that maximize the value of the data displayed in ActiveFactory software. With
ActiveFactory client tools you can:
Explore your data graphically to find important information
Analyze the data to produce relevant information
Develop and execute ad hoc queries against any Historian data
Visualize the current process state
Disseminate information on an Intranet
Produce clear, rich automated reports
Analyzing Process Data
Process data is any type of information that is relevant to the execution of a process. The following
types of information are considered part of process data:
Real-time data - What is the current value of this tag?
Historical data - What was the value of this tag every second of last Monday?
Summary data - What is the average of each of these five tags?
Business data - How much does this particular material cost?
Event data - When did that boiler trip? When it tripped, what was the internal pressure and
temperature?
To improve performance and quality, while reducing cost, we need to be able to analyze all of this
acquired information. Plant data is typically analyzed to determine:
Process analysis, diagnostics, and optimization
Materials management, such as raw materials usage
Predictive and preventive maintenance of equipment
Product and process quality (SPC/SQC)
Health and safety; environmental impact (FDA/EPA)
Production reporting
Failure analysis
Section Objective
Become familiar with ActiveFactory Software main features
Wonderware Training
Desktop Applications
ActiveFactory client tools include the following stand-alone applications:
Trend: Enables trending of historical and real time date over time. Powerful features allow
data to be compared with other data from different periods. Alarms and limit excursions
are readily visible. Its also possible to add and view annotations in your trends.
Query: This point-and-click application enables complex queries to be built to return any
InSQL data without any knowledge of the database structure or TSQL. Query can be
extended to view InTrack and InBatch data tables.
MS Office Add-Ins:
WorkBook: an add-in to MS Excel that enables almost any type of analysis and display of
data from InSQL using the Excel spreadsheet format
Report: an add-in to MS Word that allows sophisticated reporting from InSQL using the
Word document format
Other Controls
In addition to these applications, aaHistClientTrend and aaHistClientQuery are ActiveX controls
providing the essential functionality of Trend and Query for use in container applications such as
InTouch and Internet Explorer. Use of ActiveFactory client tools constituent controls (such as the
TagPicker, TimeBar etc.) in any application is possible with a server license.
Section 4 Introduction to Wonderware Information Server
This section describes Information Server in detail. It introduces the key features, architectures,
and system requirements.
Information Server provides real-time information to everyone who needs it in an organized, easy-
to-use format that can be accessed from a desktop browser or in conjunction with existing
business systems. This information can consist of consolidated data within a single line in one
plant, multiple lines in one plant or multiple lines spanning multiple plants. It is all presented in a
format designed to help plant personnel make intelligent business decisions. Moreover, the
Information Server software empowers plant personnel to not only visualize information in real
time, but to actually control manufacturing processes to increase profitability and efficiency.
Using Information Server, plant managers can access trends, real-time reports and information on
KPIs from multiple systems at a glance. In addition, plant personnel can optimize production by
modifying process parameters to accommodate for frequent product changeovers and just-in-time
production requirements. In essence, Information Server can facilitate proactive management of
manufacturing processes as well as enhance system flexibility for smooth production runs.
Key Features
Information Server enables access to vast amounts of information from virtually any data source
within data acquisition and control systems. As a result, plant personnel can:
Extend the capabilities of any existing Wonderware or third-party software system by
leveraging that information over a browser
Access real-time and historical information from supervisory systems via charts, trends,
data tables and graphical displays
Leverage information from the Wonderware Application Server, InTouch HMI software, I/O
Servers, DDE servers and more
Connect to any database or historian that supports ADO/ODBC connections such as the
Historian, InTouch alarm databases, Oracle databases and Microsoft SQL Server
Moreover, Information Server can integrate information from these diverse data sources with
information from other portal systems such as those featuring Microsoft's SharePoint and SAP's
mySAP products.
Solutions featuring Information Server Web analysis software excel at providing the critical
dynamic information required to maximize plant productivity. Web-based applications from most
industrial vendors can be embedded into the Information Server software to leverage the latest
navigation, panel management and security tools.
Open interfaces like XML, OPC, OLE, SQL, Web Services, HTTP and SOAP allow Wonderware
products to integrate with just about any third party system, application or database. In addition,
most ACAD drawings and HTML reports that have been designed to be displayed over a browser
can be embedded into the Information Server software to gain increased extensibility and Web-
part and schedule integration benefits.
Section Objectives
Introduce the Information Server product features
Wonderware Training
Use the Latest Visualization and Analysis Tools
Information Server Web analysis software offers several visualization and analysis tools in easy-to
understand formats. Examples of this kind of realtime and historical information include:
KPIs, trends and dynamic reports
Statistical reports and charts
Downtime and OEE analysis
Manufacturing execution system (MES) reports
Information on product and batch genealogy
Spreadsheets, charts and tables
Live graphics
Respond Quickly to Unforeseen Events
In order to remain profitable in today's demanding business environment, companies must be able
to respond quickly to unforeseen events. Appropriate decision-making during such unexpected
circumstances also requires knowledge of where each product is in its manufacturing life-cycle.
Wonderware solutions featuring Information Server software facilitate cost-effective tracking and
tracing of materials all the way through to the finished goods. Thus, the Information Server
software provides:
Real-time knowledge of production status
The ability to rapidly and economically respond to production events such as product
recalls
Features that can help plant employees effectively fulfill regulatory requirements for
documentation
Access to complete genealogy reports and batch trend comparisons
Tools for identifying material waste, which can lead to reduced production costs
Effectively Manage Downtime
When production stops, profits fall and costs rise. Whether for a few minutes each hour or an
unplanned outage that lasts for days, downtime is expensive in terms of time, costs and missed
opportunities. Conversely, effective downtime management can unlock the hidden capacity of
each production line, which leads to cost-effective opportunities to increase a plant's overall
profitability. Wonderware solutions featuring
Information Server Web analysis software can help plant personnel efficiently:
Conduct downtime analysis
Create accurate downtime reports
Access valuable historical data on hardware reliability
Schedule for maintenance and planned outages
Enjoy the Convenience of Centralized, Organized Information
Information Server software centralizes and organizes critical real-time information, making it
easier for plant personnel to identify opportunities for production efficiency improvements. Plant
information can be accessed anytime, anywhere via a Web browser or business systems such as
those featuring SAP's NetWeaver or Microsoft SharePoint products.
Visualize Information and Control Your System in Real Time
Wonderware solutions featuring Information Server software provide real-time visualization and
control of production processes, which can result in:
Greatly reduced life-cycle costs
Improved production efficiency
Significantly reduced waste
Less time spent creating, deploying, modifying and managing standardized applications
Increased plant profitability
Quickly and Easily Build a Plant Intelligence Portal
Wonderware's Information Server software enables plant personnel to quickly and easily build a
plant intelligence portal because it provides the entire portal framework, home page and
configuration tools out of the box. The Information Server software builds the entire portal
infrastructure upon installation. Straight from the home page, portal administrators can easily point
and click to configure the portal and instantly obtain realtime and historical plant information. In
fact, the Information Server portal was designed to be configured by users with no programming
knowledge. In addition, Information Server Web analysis software offers the following advanced
capabilities:
Portal personalization
Intelligent content linking
Dynamic formatting
Integrated security
Support for Web Services
Centralized software administration and management
Multi-View Windows
Easy portal customization
Extensive search capabilities
Multilingual support
Extensibility
Wonderware Training
Module 2
Historian Configuration
Section 1 Software, Hardware and Network Considerations 2-3
Section 2 System Licensing and Installation Notes 2-13
Lab 1 Create a Galaxy 2-17
Section 3 ArchestrA System Management Console Interface 2-25
Section 4 System Configuration 2-31
Lab 2 Configuration 2-35
2-2 Module 2 Historian Configuration
Wonderware Training
Module Objectives
Introduce and explain the ArchestrA System Management Console
Introduce and explain the ArchestrA System Management Console elements
Introduce and explain the concept of Dynamic Configuration of Historian parameters
Use the ArchestrA System Management Console to configure Server Headroom
Use the ArchestrA System Management Console to perform a Tag Import
Use the ArchestrA System Management Configuration Export/Import Utility
Section 1 Software, Hardware and Network Considerations
This section explains the software and hardware considerations and requirements for the
Historian, as well as network considerations.
Software and Hardware Requirements
It is highly recommended that you run the Historian on a dedicated computer in the production
environment. For example:
Do not use the Historian computer as a domain controller, mail server, and so on
Do not use the Historian computer as a workstation
Do not use the Historian computer for InTouch, InControl, and so on
Do not use the Historian computer as an Application Object Server
The following table describes the minimum disk space required to install the software (besides the
operating system) for a Historian system.
Server Recommendations
The following minimum hardware and software requirements for the Historian are based on the tag
count and anticipated data throughput rate, and are divided into four levels.
The recommended memory configuration guideline for SQL Server 2000 is to clamp its memory
consumption to 50% of the amount of physical memory installed on the server or 512 MB,
whichever is smaller.
The recommended Windows virtual memory setting is twice the amount of physical RAM installed
on the server. For tag counts less than 30,000, the data throughput rate is assumed to be equal to
the tag count.
For tag counts greater than or equal to 30,000, the data throughput rate is assumed to be 30,000
values per second (this is the guaranteed throughput that the system can handle, but substantially
higher throughput rates are possible, depending on hardware configuration).
Section Objective
Explain software and hardware considerations and requirements for the Historian
Discuss Network Considerations using the Historian
Software Required Disk Space
Microsoft SQL Server See your Microsoft documentation
Wonderware Common Component Files 20MB or less
Historian program files (including the
ArchestrA System Management Console tool
and printable documentation files).
18 MB
ArchestrA System Management Console only 10 MB
Remote IDAS only 4 MB
Wonderware Training
Level 1 Server
A Level 1 server can handle a load of about 5,000 tags. For example, 2,600 analogs, 2,000
discretes, 300 strings, and 100 non-I/O Server (manual) tags. The minimum requirements are:
P4 3.2 GHz CPU
1 GB RAM
1 GB network interface card (NIC)
Any of the following operating systems:
Windows 2000 Professional SP4
Windows XP Professional SP2
Windows 2000 Server SP4
Windows 2000 Advanced Server SP4
Windows Server 2003 Standard Edition
Microsoft SQL Server 2000 Standard Edition software, SP3a or later OR Microsoft SQL
Server 2000 Personal Edition SP3a, which is required for Windows 2000 Professional and
WIndows XP Professional
270 MB of free disk space to install the Historian.
Level 2 Server
A Level 2 server can handle a load of about 63,000 tags. For example, 40,000 analogs, 20,000
discretes, 2900 strings, and 100 non-I/O Server (manual) tags. The minimum requirements are:
P4 3.0 GHz Dual CPU
1 GB RAM
Windows Server 2003 Standard Edition
Microsoft SQL Server 2000 Standard Edition software, SP3a or later OR Microsoft SQL
Server 2000 Personal Edition SP3a, which is required for Windows 2000 Professional and
WIndows XP Professional
270 MB of free disk space to install the Historian
Level 3 Server
A Level 3 server can handle a load of up to 130,000 tags. For example, 70,000 analogs, 50,000
discretes, 9,000 strings, and 1000 non-I/O Server (manual) tags. The minimum requirements are:
P4 2.7 GHz Xeon Quad
8 GB RAM
Windows 2003 Standard Edition
Windows Server 2003 Enterprise Edition
Microsoft SQL Server 2000 Standard Edition software, SP3a or late
270 MB of free disk space to install the Historian
ArchestrA System Management Console Requirements
If you will be installing the Historian configuration tools (ArchestrA System Management Console)
on a remote computer, the following requirements apply:
Windows 2003 Standard Edition
Windows Server 2003 Enterprise Edition
Microsoft Management Console 2.0 or later
Internet Explorer 5.5 or later
20 MB of free disk space install the Historian
MDAC 2.7
Wonderware Training
General Hardware Recommendations for Data Storage
The following are general recommendations for the hardware used for storage:
SCSI drives configured using hardware RAID is optimum. The disk space required is a
function of data rate and the desired history duration.
The Historian was designed to run on a computer configured with NTFS, and NTFS is the
only officially supported file system for a production environment. Although the Historian
will run if you are using the FAT file system, data corruption may occur if the system
crashes while files are still open.
You should enable file compression for the historical data storage locations: Circular,
Alternate, Buffer, and Permanent. File compression for the default directories is
automatically set during the installation process.
File compression is only available for the NTFS file system.
Planning for Disk Space Requirements
There are four factors to consider when estimating the amount of disk space required to run the
Historian:
Disk space required to install the required software components and files needed to run
the Historian system.
Disk space required to store the Historian database files.
Disk space required to store the Historian historical data files.
If a remote IDAS is used, the disk space required on the local IDAS computer to store
cached data if the network connection to the Historian fails.
Disk Requirements for Database Files
The Historian installation program adds two databases to the Microsoft SQL Server: Runtime and
Holding.
Runtime Database: used to store all the Historian configuration data and event data.
The information in the Runtime database is stored to disk as a database file named
Run90dat.Mdf. Its associated log file is Run90log.Ldf.
The configuration data in the database file remains relatively static and usually never
causes the file size to go above 20 MB.
However, if you choose to set up events, records of event detections and the results of any
data summaries or snapshots will increase the size of the Runtime database file (because
the tables are filling). Also, entries will be created in the log file for event-related
transactions.
If the database files are set to auto-size, the Runtime database file will expand to
accommodate event-related data until the amount of hard disk space is exhausted.
Holding Database: used to temporarily store tag definitions being imported from
InTouch
. The information in the Holding database is stored to a database file named

Holding90Dat.Mdf. Its associated log file is Holding90Log.Ldf.
Note: Historical plant data is not stored in the database files. This type of data is stored in special
files called History Blocks.
The minimum disk space for the database files are configured as follows:
The Runtime and Holding databases are (by default) set to automatically expand at a 10% rate.
You cannot change these default settings during the installation. The databases can be resized
later using Microsoft SQL Server utilities. For more information on sizing databases, see your
Microsoft SQL Server documentation for guidelines.
Note: When upgrading Historian, you will need space to save a copy of the old Runtime database
while a new one is created. Therefore, in order to upgrade, the total need for database space is
twice the size of your old database, plus the database size for the new install.
Disk Requirements for Historical Data Files
The Historian stores historical plant data to the hard disk in special files called history blocks.
When you install the Historian, you will be required to specify a storage location (directory) in
which these files will be dynamically created and subsequently filled. You must have at least 200
MB of free disk space for these files in order to install the Historian.
Once you have your Historian system up and running, when the free space on the drive containing
the storage directory drops below a minimum threshold, the oldest data will start to be overwritten.
It is very important that you have allocated enough disk space for storing your plant data for the
desired length of time.
The amount of data that you will be able to store to disk before running out of space is dependent
upon the number of tag values that you are storing and how often they are stored. That is, the
more tags you have, the fewer values you can store per tag before you will need to archive the
oldest data. The higher the specified storage rate per tag, the faster you will run out of space.
Analog, Discrete, and Fixed-length String Requirements: Each value that is stored uses
Storage Size +3 bytes of disk space, plus approximately 15% overhead. Use the following formula
to estimate the disk usage:
Estimated disk usage per day =(1.15*(Storage Size +3)*number of tags) * (60/storage rate in
seconds) * 60 minutes * 24 hours / (NTFS compression ratio)
For example, the disk usage per day for 2000 4-byte analog tags (that is, Storage Size =4 bytes)
that are stored at 2-second intervals would be (1.15*(4+3)*2000)*(60/2)*60*24/2, which is
approximately 332 MB per day.
The disk usage per day for 10,000 discrete tags (that is, Storage Size =1 byte) that are changing,
on average, every 60 seconds would be (1.15*(1+3)*10000)*(60/60)*60*24/2, which is
The disk usage per day for 2000 100-byte string tags (that is, Storage Size =8 bytes) that are
changing, on average, every 60 seconds would be (1.15*(100+3)*200)*(60/60)*60*24/2, which is
File Required Disk Space
Runtime database file 30 MB
Runtime log file 10 MB
Holding database file 30 MB
Holding log file 10 MB
Total Space Used (Minimum) 80 MB
Wonderware Training
Variable-length String Storage Requirements
For strings of variable length that are 128 characters or more, the number of bytes required for
storage will be the actual number of characters being sent from the data source +5 bytes, plus
15% overhead. Therefore, the average disk usage per day for a variable-length string that is
receiving an average of 'N' characters per sample could be calculated using the following formula:
Estimated average disk usage per day =(1.15 *(N+5)*number of tags) * (60/average storage
rate in seconds) * 60 minutes * 24 hours / (NTFS compression ratio)
For example, the disk usage per day for 100 131-byte string tags that are changing, on average,
every 60 seconds and the average incoming value is 60 characters in length would be
(1.15*(60+5)*100)*(60/60)*60*24/2, which is approximately 513 MB per day.
Memory Requirements
For a complete Historian system, the following components put a demand on memory.
Internal Historian systems: Includes I/O Servers, data acquisition, and data storage.
The Operating System
Client access (data retrieval): Includes caching.
When determining the amount of memory to purchase, remember that it is likely the cheapest (and
easiest) thing that you can do to improve performance. The difference in performance is noticed by
the end-users running client applications who are ultimately your customer for the Historian data.
More memory will reduce the amount the server has to use virtual memory - lowering the load on
the disk subsystem.
Processes required by the server will become faster because they are memory-dependent.
Even if the Performance Monitor indicates that Pages/sec counter is NOT high (you have an
excess of memory), additional memory can be used as additional disk cache, speeding up disk
access and therefore file service.
The following figure provides a general outline of memory requirements used in different tag-load
scenarios.
The tag traces correspond to the server setup scenarios found under Server Requirements
starting on page 2-3 (5,000 Tags =Level 1 Server, etc.):
X Axis =MB of RAM.
Y Axis =#of History Blocks Online.
For example, a system with 25,000 tags (Level 3 Server) would use approximately 400MB of RAM
when 375 History Blocks (duration of 8 hours =93.75 Days) are on line.
For further detailed recommendations on memory consumption and disk sizing requirements, see
the Historian online help file section System Sizing Examples.
History Blocks Online
MB RAM
Wonderware Training
Network Performance Considerations
One of the major factors in how well the Historian will perform is how the network architecture is
set up. In general, the faster the hardware, software and network connections, the better the
performance.
Major architectural factors affecting the performance of the system are:
Domain issues, authentication issues. What is your network protocol?
What are you going to name your Historian nodes -- hard to change the name after the
install.
Operating System choice.
Processor configuration: single, Symmetric Multi-Processor (SMP) or Multi-Core
Processor.
Computer configuration: the number of computers in a distributed (multi-node) Historian
configuration.
Disk sub-system performance.
Network bandwidth.
The Historian is a highly configurable package that can be set up in many different ways,
depending on your needs.
The following materials provide an overview of the various architectures available with Historian
and the recommended configurations for each. Generally, it is recommended that you split the
process and IS networks to ensure that the process network does not become overloaded.
All tags to be stored in the Historian are on "advise" all of the time. This may cause heavy
load conditions on the process network. Prior to installing the Historian, you should
investigate the possible load impact of installing the Historian on your network.
Install two network adapter cards on a server-type computer running the Windows Server
2000 or Windows Server 2003 operating system. Configure them to segment the IS
network from the process network.
Install the Historian on the server computer.
The Historian must have access to a local Microsoft SQL Server. During the Historian installation,
you can either choose an existing local Microsoft SQL Server, or install it from the Historian
installation disk.
Wonderware Training
Section 2 System Licensing and Installation Notes
This section explains Historian Licensing strategy, and explains installation strategies for the
Historian and for Microsoft SQL Server.
Licensing Strategy: License Validation
The Historian includes License Validation and Tag Count Enforcement. The Historian validates
that a Wonderware license file is installed and that the allowed tag count has not been exceeded.
On startup, the system checks to see that a valid Wonderware license file is present on the
Historian computer. If the license file is not present, the Historian and the embedded Microsoft
SQL Server will run but will only store the system tags.
If no license is present, or the tag count is exceeded, the status console displays and logs a
"License Violation" message.
Licensing Strategy: Tag Count Enforcement
The total tag count for a Historian includes configured analog, discrete, and string tags. The
system tags are not included in the count. The tag count is checked when the following operations
are performed:
Start up the Historian
Use the ArchestrA System Management Console to manually add new tag definitions to
the database
Use the ArchestrA System Management Console Tag Import function to import tag
definitions from InTouch
Use Microsoft SQL Server Query Analyzer to manually add new tags using an INSERT
statement
Use Application Server to create new tags
The system adds all requested tags to the tag definition table.
If the tag count is exceeded, the Historian disables a sufficient number of tags to bring the count
back into compliance.
Tags are disabled in the reverse order in which they were added; that is, the most recent addition
is disabled first. In other words, the wwTagKey reference is used in the logic to determine which
tags are excluded.
Section Objectives
Explain Historian Licensing strategy
Explain installation strategies for the Historian and Microsoft SQL Server.
Wonderware Training
Installation Notes
A complete Historian system is composed of the following software components:
Historian program files
Historian database files
Historian history blocks
Historian management tools
One or more remote IDAS (optional)
Historian online documentation
It is highly recommended that you have a defined plan for implementing the Historian in your plant
environment before you start the installation process.
This plan should include the type of network architecture for the Historian system, considerations
for how much disk space is required for data storage, and the amount of space required for the
Historian database files and log files.
You must have administrative rights to install the Historian. The installation program detects any
previous versions of the Historian and notifies you of your migration options. You are required to
confirm the upgrade or re-install in order to proceed with the installation.
The Historian installation program allows you to install some of the system components separately.
The following table describes the various Historian components that can be installed:
Option Description
Complete Historian Installs, modified, or repairs the Historian, Runtime database, IDAS,
ActiveX Controls, Configuration tools, and Online documentation.
Configuration Tools Server Management tools include Historian Configuration Editor and
ArchestrA System Management Console. Both of these applications are
MMC snap-ins. These tools can be installed on the same computer as the
Historian, or on a different computer on the network. This option is included
if you have selected to install a complete Historian.
Historian Data Acquisition
Service (IDAS)
The IDAS to be deployed remotely. This option is included if you have
selected to install a complete Historian.
ActiveEvent ActiveX
Control
Used to detect external events and send them to the Historian event
detector engine. Does not display a runtime interface.
Historian Installation will fail unless the following Microsoft SQL Server installation options are
selected:
The Microsoft SQL Server Default instance option must be selected. Named instances of
SQL Server are not supported by the Historian.
Installation Operations
The installation program performs the following operations:
Installs the common components, such as SuiteLink
, NetDDE
extensions, and the

Wonderware Logger
Locates a running Microsoft SQL Server on the local computer. If you do not have the
required version of Microsoft SQL Server installed, you are required to install or upgrade it
prior to the Historian installation.
Logs on to the installed Microsoft SQL Server using a system administrator login. You
must be able to successfully log on to the Microsoft SQL Server to complete the setup.
Checks for required disk space based on the options that you have selected.
Creates and configures Historian databases files.
Creates the Historian directories on the hard disk and install program files.
Populates the Historian program or startup menu group with icons.
A successful installation of the Wonderware depends upon proper configuration of Microsoft SQL
Server:
The required version of Microsoft SQL Server (minimum Personal Edition, or Express
Edition for SQL Server 2005) must be installed and running prior to installing the Historian.
If the Historian installation program detects that a Microsoft SQL Server or a required
service pack is not installed, you are required to have them installed for you.
You can also use an existing Microsoft SQL Server, provided that you have configured
certain options (logon, service pack installed) correctly.
Remote Microsoft SQL Servers are not supported.
The Microsoft SQL Server used by the Historian MUST be the primary instance of SQL
Server.
Multiple instances of Microsoft SQL Server on the same machine as the Historian are not
supported.
After the Historian installation is complete, the installation program restarts the Microsoft
SQL Server so that the installation changes can take effect. Any users connected to the
Microsoft SQL Server at that time are automatically disconnected.
A restart is not required for a re-installation of the Historian.
If you are installing the Historian management tools on a remote computer, only the
Microsoft SQL Server Client Utilities are required. If these utilities are not already installed,
you are prompted to install them prior to installing the Historian.
Wonderware Training
The Microsoft SQL Server is deployed for this course with the following settings:
When installing Microsoft SQL Server, you must properly configure certain options prior to
installing the Historian:
Dictionary Sort Order: Use any of the case-insensitive sort orders supported by SQL
Server, such as the default.
Modifying the dictionary sort order after the installing the Historian will result in a loss of the
Historian databases.
Network Support: Use TCP/IP and any other support required at your site.
You can run the Microsoft SQL Server setup program to change these options.
Note: Microsoft SQL Server options should only be configured by a qualified Windows or SQL
Server administrator. For more information, see your Microsoft SQL Server documentation.
Option Default Value
SQL Server Services Set to use the Local System account.
Default Database Collation Dictionary order, case-insensitive, for use with 1252 char. set.
Security Mode Mixed.
Administrator Login Username is sa with a password of ww.
Lab 1 Create a Galaxy
Introduction
In this lab you will create a new Galaxy, import automation objects that represent a Mixer
application, configure the objects to run on the local computer, and deploy the Galaxy. Throughout
this class you will use this Mixer application. This lab will draw upon knowledge gained in the
prerequisite course.
Objectives
Upon completion of this lab you will be able to:
Create a Galaxy
Import Automation Objects
Configure imported Automation Objects to be used on a local computer
Deploy the Galaxy
Wonderware Training
Galaxy Configuration
This figure shows the components of the process used as a real data source for this class. The
galaxy you are about to create will model this process within Application Server. These objects
have pre-configured attributes connecting to the real-time source; during the rest of the class you
will reference the attributes shown in the figure below.
Your instructor will provide you with a unique student number. Please note it here.
Student number (XX): _____
Mixer_XX0: ______________
Mixer_XX1: ______________
Create a Galaxy
1. Start the ArchestrA Integrated Development Environment (IDE) (Start / All Programs /
Wonderware / ArchestrA IDE).
2. Click New Galaxy.
3. Enter the GR node name. This is the name of the local computer. Your instructor will provide
this information. In the following example, the local computer name is WWSYSPLATFORM2.
4. Enter a Galaxy Name of WWGalaxy.
5. Select Base_Application_Server.cab in the Galaxy type drop-down box.
6. Click Create.
7. Click Close in the Create Galaxy window when Galaxy creation is complete.
8. Click Connect in the Connect To Galaxy window.
9. In the ArchestrA IDE, choose the Galaxy menu, and select Import / Object(s).
10. Navigate to the Mixer Objects.aaPKG file located in the C:\Wonderware Training folder and
click Open.
Wonderware Training
11. Click OK to accept the defaults in the Import Preferences dialog box.
12. Click Close in the Import Automation Object(s) dialog box when the importing process is
complete.
13. In Deployment view, expand TWinPlatform as shown (press the * key on the number keypad).
14. Change the XX in the Mixer_XX0 and MixerXX1 object names to reflect your student number
(the number you noted on page 2-18).
15. You will receive a warning. Click Yes.
Configure and Deploy the Galaxy
16. In Deployment View, double-click the InControl object to open it for editing.
17. Modify the Server node: field as needed. Your instructor will provide the Server node name.
18. Click the Save and Close button.
19. Enter appropriate Check In comments and click OK.
20. Double-click the TAppEngine object to edit its settings.
21. Check the Enable storage to historian checkbox.
22. Verify the Enable tag hierarchy checkbox is checked.
Wonderware Training
23. Enter the node name of the Historian in the Historian field.
24. Click the Save and Close button and check in the TAppEngine object.
25. Double-click the TWinPlatform object.
26. Enter your node name in the Network address field.
27. Click the Save and Close button and check in the TWinPlatform object.
28. Right-click the TWinPlatform object and choose Deploy.
29. Verify Cascade Deploy is checked and click OK.
30. Click Close when the deploy is complete.
31. Right-click an object in the Line1 Area and select View in Object Viewer.
Wonderware Training
32. Add the following attributes to the Watch List to observe their values, and to ensure data is
being received.
InletValve_001.PV
LIT_001.PV
OutletValve_001.PV
TransferPump_001.PV
TT_001.PV
Section 3 ArchestrA System Management Console Interface
This section introduces and explains the ArchestrA System Management Console (SMC) Interface
Elements.
The Historian leverages the functionality of the ArchestrA System Management Console (SMC) by
making all areas within the Historian available to the administrator.
ArchestrA System Management Console does not perform administrative functions, but hosts
tools that do. The primary type of tool you can add to a console is called a snap-in. Other items
that you can add include ActiveX controls, links to Web pages, folders, taskpad views, and tasks.
There are two general ways to use SMC:
in user mode, working with existing MMC consoles to administer a system
in author mode, creating new consoles or modifying existing MMC consoles
Section Objective
Introduce and explain the ArchestrA System Management Console Interface Elements
Wonderware Training
The installation program of the Historian automatically creates a shortcut on the desktop:
a. Double-click the shortcut icon.
The ArchestrA System Management Console appears (see the following figure).
The ArchestrA System Management Console Tree View pane (left-side) is divided into two
main areas: The Management Console and the Configuration Editor. Other options that may
display are the Log viewer, Application Server managers, and so on.
The Management Console: This area is where the server housekeeping takes place.
From this area, you can monitor all communications, add and delete servers and groups,
access History Block information.
The Configuration Editor: This area is where tag import, I/O servers, IDAS, Storage
information, and the Public and Private Groups are administered.
The following figure shows the Status icon highlighted. The Historian has not yet been started.
Management Console
a. Within the console root, expand IndustrialSQL Server Historians, IndustrialSQL Server
Group and the Server icons.
b. Expand the Management Console icon.
c. Highlight the Status icon. Within the Item, Module and Time/Message panes, you should see
current information about your server status.
This pane includes all system information in real-time.
d. Highlight the License status line within the Item pane:
The status message should be Valid.
Note: If the License Status message is not Valid, the Historian will log only system tags. No
other tags will be logged.
Wonderware Training
Configuration Editor
e. Expand the Configuration Editor icon.
f. Expand any of the main icons in the Tree View pane.
This area contains a browser-like display of all system information.
g. Expand the System Configuration folder and click the Parameters icon.
Storage and Headroom settings are configured from within this pane, and are discussed in
detail later in this manual.
h. Expand the Storage folder.
Wonderware Training
Storage properties are stored within this folder.
Several different storage locations are available. Notice all four types have similar configurable
properties: Path, Deletion Threshold, Maximum size, and Age threshold.
Circular: Local storage location for historical data storage. When the free space on the disk
containing the circular storage location drops below a minimum threshold or the data is of a
specified age, the oldest data is deleted out of this storage location and replaced with new data.
Instead of data being deleted from the circular storage location, it can be moved into the alternate
storage location, if that location is defined.
Alternate: When circular data is scheduled for deletion, the storage subsystem will start moving
these history blocks to one or more alternate locations, if defined. Alternate storage locations are
numbered. A block of data moves sequentially through the alternate locations until it is finally
moved to the end of the last alternate location space, at which point the data is deleted from the
system.
Buffer: Used for temporary purposes, such as retrieval from a data archive. Data stored in the
buffer storage location can be accessed and viewed along with the data stored in the circular
storage location.
Permanent: Permanent storage locations are used to store critical data (for example, reactor
trips) that must not be overwritten. The storage subsystem will never attempt to delete data in this
location. Data in a permanent storage location can be accessed and viewed along with the data
stored in the circular storage location.
Section 4 System Configuration
This section introduces and explains the Historian System Configuration. It also introduces
Dynamic Configuration of the Historian parameters.
Overview
Configuration data is information about elements that make up the Historian system, such as tag
definitions, I/O Server definitions, storage locations for historical data files, and so on.
Configuration data is relatively static; that is, it is not constantly being changed as the result of
plant operation.
The configuration subsystem is responsible for handling and storing configuration data. When the
Historian is installed, all configuration information are defined automatically.
Configuration data is stored in Microsoft SQL Server tables within the Runtime database. If
InTouch is handling your I/O, you can easily import much of this information from existing InTouch
applications.
System Configuration for Manual Data is performed from within the ArchestrA System
Management Consoles Configuration Editor.
Bulk modifications and Historian system migrations can be performed using the Historian
Database Export/Import Utility.
The system can be configured at any time with no interruption in the acquisition, storage, and
retrieval of unaffected tags. Configuration data can be stored with a complete revision history.
Dynamic Configuration
The Historian supports dynamic configuration. In other words, tags and other objects in the
Historian database can be modified while the system is running.
The Historian detects and applies the modifications to its internal runtime state, when the
modifications are authorized by the user, without requiring the system to be restarted. In addition,
clients do not suffer interruptions due to configuration changes.
The dynamic configuration feature in the Historian caters for all possible database modifications
that affect the runtime operation of the system.
The dynamic configuration subsystem is designed to ensure that no loss of data occurs for tags
that are not affected by the modifications being applied. However, tags that require a change in
data acquisition configuration will obviously lose data during the reconfiguration.
For some types of configuration modifications, the system automatically creates a new history
block.
In all but one case, the system continues to run uninterrupted. The single exception that requires a
restart of the system is when you change the main historization path in the system, a parameter
that is rarely modified after installation.
Section Objectives
Introduce and explain the Historian System Configuration
Introduce Dynamic Configuration of the Historian parameters
Wonderware Training
Dynamic configuration is usually a two-step process:
First, you modify one or more objects in the database, using the ArchestrA System
Management Console, Transact-SQL statements, or the database modification tool of
your choice.
Then, after making all of the modifications, you must commit the changes, which triggers
the dynamic configuration process in the server.
System Change Scenarios
Different types of dynamic changes to the database affect the system in different ways. A
summary of typical changes and their effect on the system follows.
Modifying System Parameters
Modification to system parameters usually takes effect immediately (a new history block is not
created).
Exceptions:
Adding headroom for one or more tag types (requires a new history block).
Changes to the AutoStart parameter (takes effect after the next full shutdown of the
system).
Modifying Storage Locations
Modifying the circular storage location requires a shutdown and restart of the Historian. Changes
to the other storage locations take effect immediately.
System Change Effects
Modifications to the tag database that changes the database footprint on the disk may result in
creation of a new history block.
If only data acquisition or retrieval characteristics of a tag are modified, the changes take effect
without requiring the system to create a new history block. Any change to the data source for the
tag (for example, modifying the item name, topic name or I/O Server name of the tag) results in a
short gap in data for the tag. This is because the system disconnects from the old data source and
connects to the new data source.
Adding, Deleting, and Modifying Tags
Adding one or more tags to the system generally results in creation of a new history block, unless
sufficient headroom is available for that particular tag type. In this case a new block is not required.
If the headroom is exceeded, a new block is created and the headroom is replenished to the
amount specified in the SystemParameter table.
Deleting one or more tags takes effect immediately.
Certain modifications to tags result in a new history block. Those modifications include:
Changing the integer size.
Changing the raw type.
Changing strings tags from fixed length to variable length or vice-versa.
Changing storage type from Not stored to Stored.
Changing a string tag from ASCII to Unicode or vice-versa,
Changing tag acquisition type from IDAS to Manual or vice-versa.
Headroom capability enables the user to define "space" storage to be readily available to the
system. In other words, settings are changed in order to add a few tags fairly quickly and with
no wait or delay when creating a new history block.
For example, when importing tags, the system merely checks the number of new tags against
the amount of headroom available and on that basis decides whether a new history block will
be created after the commit operation.
At the start of each new history block, however, the system will replenish the amount of
headroom to the setting specified by the user. If the user specified headroom for 100 discrete
tags and imports an application with 40 discrete tags (nothing else), the import happens
without a new block being created, but the system consumes 40 of the discrete headroom
"slots."
For the remainder of the duration of that block, the headroom remains at 60. Assuming no new
discrete tags are added, at the next block changeover (whether it is a scheduled block
changeover, or a block forced by the user), the discrete headroom internally will reset to 100.
Headroom settings should not be used to keep space "just in case" 10,000 tags will be added.
Memory and hard disk space is impacted.
Tag count validation for licensing purposes does not apply to pre-allocated tag memory; the tag
count is verified only when the tag definitions are committed.
Committing Changes
Committing database changes is the action that makes the Historian aware of changes in the
Runtime database. When the user modifies the Runtime database (using the Configuration Editor,
Query Analyzer, etc.) while the Historian is running, Historian is unaware of the changes until the
user commits the changes.
When the commit operation occurs, the Historian reads the modified info from the database to
keep in memory, and reconfigures the runtime components like IDAS, storage etc.
Modifications made to the database are done in a transactional fashion.
You can commit changes to the configuration of the system as often as needed. You can also
commit changes in batches or individually. There is no limit on the number of changes that may be
committed to the database.
Committing configuration changes typically takes effect within 10 seconds under maximum data
throughput conditions.
Cases in Which Configuration Changes will NOT be Committed
If the system is not running, or storage has not been started, any commit will be ignored, and the
contents of the ConfigStatusPending table will be cleaned up.
When the system is running, a commit will be disallowed:
While a previous dynamic configuration is still in progress.
While a new history block creation is in progress (initiated as a scheduled block
changeover, a dynamic configuration, or a user request). A block is deemed in progress
for five minutes after it has been created, and also ten minutes prior to the next scheduled
block changeover.
For each case, a message is displayed indicating that the commit was disallowed.
Wonderware Training
Lab 2 Configuration
Introduction
Next you will begin the process of system configuration to optimize the system for use. The tasks
performed in this lab can be performed within any environment depending on the planned number
of tags, system and network requirements, and so on.
Objective
Upon completion of this lab, you will be able to:
Start the Historian
Review Historian Registration Properties
Enable Autostart of the Historian
Configure Modification Tracking
Wonderware Training
Start the Historian
1. Start the Historian (Start / All Programs / Wonderware / IndustrialSQL Server /
IndustrialSQL Server).
2. Expand the folders as shown below.
3. Right-click Status and choose Start InSQL.
4. Log in when prompted. Your instructor will give you the proper login information.
Each Module status changes to Started:
Review Historian Registration Properties
5. Select the Server icon.
6. Right-click and select Edit IndustrialSQL Server Registration Properties.
7. Check the Display InSQL Server state in console checkbox. This setting displays the status
of the server as a small icon on top of the Local Server icon.
8. Verify that the Always prompt for login information and the Use Windows authentication
checkboxes are checked. These settings define the security access to the Historian console.
9. Click OK.
In the following figure the server state is good/running:
Note: If the server is not started or any problems exist (incorrect service logins, etc.) the icon
displays a red square.
Wonderware Training
Enable Modifications Tracking
Next you will configure the Historian to log any modifications made to configuration information.
10. Navigate to the Configuration Editor under your server name and expand System
Configuration. The folders are located within the Tree View (left-hand) pane of the ArchestrA
System Management Console.
11. Select Parameters in the System Configuration folder.
12. Double-click ModLogTrackingStatus in the Parameters list.
13. Set the Value to 7. This will log the following types of modifications: Inserts, Updates, and
Deletions.
14. Click OK.
15. Click once on the Configuration Editor to select it.
16. Right-click on the Configuration Editor and select Commit Pending Changes.
17. Click Display to see the Pending Changes.
The Pending Changes are displayed, indicating the ModLogTrackingStatus was recently
modified.
18. Click OK.
19. Click Commit.
Once the changes have been committed, a confirmation box will display.
20. Click OK.
Wonderware Training
Track Modifications
21. Right-click Configuration Editor and select Track Modifications...
22. Click the Search button, accepting the default settings.
The Modification Tracker will display any modifications made after tracking was enabled.
23. Click Cancel when finished viewing, and Cancel again.
Configure System Parameters
Next you will configure the AutoStart parameter to true so that the Historian automatically starts.
24. Navigate to the Configuration Editor and expand System Configuration. The folders are
located within the Tree View (left-hand) pane of the ArchestrA System Management Console.
Wonderware Training
25. Select Parameters in the System Configuration folder.
Double-click the AutoStart parameter.
Set the Value field entry to 1, and click OK. This will automatically start the Historian server the
next time the computer is restarted.
26. Commit pending changes as you did previously.
27. Track Modifications as you did previously to see the AutoStart line has been added.
28. Click Cancel when finished viewing, and Cancel again.
Wonderware Training
Module 3
History Data Storage and Retrieval
Section 1 Data Retrieval 3-3
Section 2 Historian Time Domain Extensions 3-9
Lab 3 Query Examples 3-25
3-2 Module 3 History Data Storage and Retrieval
Wonderware Training
Module Objectives
Explain high-level data retrieval and changes to the Historian OLE-DB Provider
Explain Historian SQL Query structures
Use SQL examples to show query syntax and data retrieval options
Section 1 Data Retrieval
This section explains the Data Retrieval Subsystem and features for the Historian.
Data Retrieval Subsystem
The purpose of the retrieval subsystem is to receive SQL queries from clients, locate the
requested data, perform any necessary processing, and then return the results. For configuration
and event data, retrieval is made possible by normal SQL queries, because these types of data
are stored in normal SQL Server database tables. History data, however, must be retrieved from
the history blocks and presented to clients as if it were also stored in SQL Server tables. To
accomplish retrieval from both of these data repositories, the retrieval subsystem includes:
An implementation of a SQL Server data provider, which determines whether the
requested data resides in normal SQL Server tables or in the history blocks.
A low-level retrieval layer, which is responsible for extracting the requested data from the
history blocks and presenting to the InSQL OLE DB provider as "virtual" history tables.
A set of SQL Server extensions, which are implemented as columns in the history tables.
You can use these extensions to specify the nature of the rowset that will be returned,
such as the number of rows returned, the resolution of the data, or the retrieval mode.
For more information on data storage, see the Online Help topic: Data Storage Subsystem.
Data Retrieval Features
Some of the main features of the data retrieval subsystem are:
All tag types can be included in the same query, when retrieving from the History table.
You do not need to separate analog, discrete, and string tags into different queries. Any
combination of tags may be submitted in a query.
Live data from the active image will be returned independent of the tag types in the list,
unless an ORDER BY clause is applied to the query.
Both fixed length and variable length strings are supported.
All internal time computation and manipulation is done using the Win32 FILETIME type.
The resolution of FILETIME is 100 nano-seconds.
All times are handled internally as absolute time (UTC). Conversions to and from local
time are handled going in and out of retrieval so the external interface is local time.
Non-realtime data is supported (for example, store-and-forward data or data imported
from a .CSV file).
Retrieval of different versions is supported.
Section Objective
Explain the Data Retrieval Subsystem and Features for the Historian
Wonderware Training
History Blocks: A SQL Server Remote Data Source
Remote data sources are simply data repositories that exist outside of a Microsoft SQL Server
database file (.MDF). Microsoft sometimes refers to these types of data sources as "non-local data
stores." In the case of the Historian, a remote data source is the set of history block files. All tag
data is stored in the history blocks. For more information on history blocks, see the Online Help
topic: History Blocks.
OLE DB technology can be used to access data in any remote data store. This access is
accomplished though a software component called an OLE DB provider.
About the InSQL OLE DB Provider
Object Linking and Embedding for Databases (OLE DB) is an application programming interface
(API) that allows COM-based client applications to access data that is not physically stored in the
Microsoft SQL Server to which they are connecting.
The benefit of using OLE DB is that it provides access to different types of data in a broader
manner. By using OLE DB, you can simultaneously access data from a variety of sources, such as
from a Microsoft SQL Server database, an Oracle database, and a Microsoft Access database. A
query that accesses data from multiple, dissimilar data sources such as these is called a
"heterogeneous query," with "heterogeneous" meaning "dissimilar." A heterogeneous query can
also be called a "distributed query," because the data can be distributed across various data
sources.
Microsoft SQL Server uses OLE DB to process heterogeneous queries and makes linking data
between the data sources much easier. Through OLE DB, Microsoft SQL Server supports
Transact-SQL queries against data stored in one or more SQL Server and heterogeneous
databases without any need for specialized gateway server applications.
The interface required to access data in a non-local data store (such as the Historian history
blocks) is provided by a "virtual" server, called an OLE DB provider. OLE DB providers allow you to
use the power of the Microsoft SQL Server query processor to make linking data stored in the
Microsoft SQL Server databases and from the history blocks much easier and more robust. Also,
the Historian OLE DB provider has a rich set of query capabilities.
The name of the Historian OLE DB provider is "INSQL." The INSQL OLE DB provider is installed
during Historian installation and then associated, or linked, with the Microsoft SQL Server. For
information on the syntax for linking the INSQL OLE DB provider, see the Online Help topic:
Linking the INSQL OLE DB Provider to the Microsoft SQL Server.
To access historical data using OLE DB, any COM-based client application must connect directly
to the Microsoft SQL Server and then specify to use the Historian OLE DB provider in the syntax of
the query.
When you execute a query and specify the Historian OLE DB provider in the syntax, the Microsoft
SQL Server parser will pass the appropriate parts of the data request to the Historian Server OLE
DB provider. The Historian OLE DB provider will then interface with the low-level retrieval layer to
locate the data store, extract the requested information, and return the data to the Microsoft SQL
Server as a rowset. Microsoft SQL Server will perform any other processing required on the data
and return the data to the client application as a result set and a set of output parameters, if
applicable.
The Historian OLE DB provider must be present on the server running Microsoft SQL Server. The
set of Transact-SQL operations that can be used to retrieve data in the history blocks depends on
the capabilities of the Historian OLE DB provider. The Historian OLE DB provider is SQL-92
compliant. For more information on OLE DB, see your Microsoft documentation.
Extension (Remote) Tables for History Data
Some of the history tables are rowset representations that provide a means for handling acquired
plant data. These tables are not part of normal SQL Server functionality. A normal SQL Server
table stores data directly in the database's data device file (.mdf). An extension table, however,
presents data as if it were a real table, but it does not physically exist in the data device. An
extension table is a logical table that is populated from other types of data files; thus, the data is
stored "remotely" from SQL Server. In the case of the Historian, the data files are the history
blocks generated by the storage system.
Note Extension tables are also called remote tables.
Data access from the history blocks is made possible by SQL Server's OLE DB provider
technology. Client applications must connect directly to the Microsoft SQL Server and then specify
to use the Historian OLE DB provider in the syntax of the query.
The extension tables are:
History (InSQL.Runtime.dbo.History)
HistoryBlock (INSQL.Runtime.dbo.HistoryBlock)
Live (INSQL.Runtime.dbo.Live)
WideHistory (INSQL.Runtime.dbo.WideHistory)
The AnalogHistory, DiscreteHistory, StringHistory, AnalogLive, DiscreteLive, StringLive,
AnalogWideHistory, DiscreteWideHistory, and StringWideHistory tables are provided for backward
compatibility. For more information, see the Online Help topic: Backward Compatibility Entities.
The AnalogHistory, DiscreteHistory, StringHistory, and History tables are the only tables which are
updateable. The remaining tables are read-only.
For more information on the history extension tables, see the Online Help topic: History Tables.
Query Syntax for the Historian OLE DB Provider
The most common Historian query is a SELECT statement:
SELECT select_list
FROM table_source
WHERE search_condition
[ GROUP BY group_by_expression ]
[ HAVING search_condition ]
[ ORDER BY order_expression [ ASC | DESC ] ]
A WHERE clause is mandatory when issuing a SELECT query against any extension table except
HistoryBlock.
There are four variations for issuing a SELECT statement to the Historian OLE DB provider to
retrieve history data, which will be discussed next:
Four-Part Naming Convention
Historian OLE DB Provider View
OPENQUERY Function
OPENROWSET Function
Wonderware Training
Using the Four-Part Naming Convention
The linked server name is simply a name by which the Historian OLE DB provider is known to the
Microsoft SQL Server. In order for a query to be passed on to the Historian OLE DB provider, you
must specify the linked server name and the extension table name as part of a four-part naming
convention.
For example, this query specifies to retrieve data from the History extension table in the Historian
OLE DB provider:
SELECT * FROM INSQL.Runtime.dbo.History
WHERE TagName = 'SysTimeSec'
AND DateTime >= '2001-09-12 12:59:00'
AND DateTime <= '2001-09-12 13:00:00'
The four-part naming convention is described in the following table:
In the case of four-part queries, SQL Server produces the statement that is sent to the Historian
OLE DB provider from the statement that the user executes. Sometimes this produced statement
is incorrect, too complex, or lacks portions of the WHERE clause required for the Historian OLE
DB provider to return data.
A typical error message when executing unsupported syntax is:
Server: Msg 7320, Level 16, State 2, Line 1
Could not execute query against OLE DB provider 'INSQL'.
[OLE/DB provider returned message: Historian did not receive a WHERE clause from SQL Server.
If one was specified, refer to the Historian OLE DB documentation]
For four-part queries against non-English SQL Servers running on non-English operating systems,
the default date format might differ from the English versions. For example, for a French or
German SQL Server running on the corresponding operating system, the date/time in a four-part
query must be:
yyyy-dd-mm hh:mm:ss.fff
For example:
2003-28-09 09:00:00.000
Part Name Description
linked_server Linked server name. By default, INSQL.
catalog Catalog in the OLE DB data source that contains the object from which you
want to retrieve data. For Microsoft SQL Server type databases, this is the
name of the database. To use the Historian OLE DB provider, the catalog
name will always be "Runtime."
schema Schema in the catalog that contains the object. For Microsoft SQL Server
type databases, this is the name of the login ID for accessing the data. To
use the Historian OLE DB provider, the catalog name will always be "dbo."
object_name Data object that the OLE DB provider can expose as a rowset. For the
Historian OLE DB provider, the object name is the name of the remote table
that contains the data you want to retrieve. For example, the History table.
Using a Historian OLE DB Provider View
Microsoft SQL Server views have been provided that will access each of the extension tables,
eliminating the need to type the four-part server name in the query. These views are named the
same as the provider table name. Note Backward compatibility views are named according to the
v_ProviderTableName convention.
For example:
SELECT * FROM History
AND DateTime >= '2001-09-12 12:59:00'
AND DateTime <= '2001-09-12 13:00:00'
Using the OPENQUERY Function
You can use the linked server name in an OPENQUERY function to retrieve data from an
extension table. The OPENQUERY function is required to retrieve wide table data. For example:
SELECT * FROM OPENQUERY(INSQL, 'SELECT * FROM History
WHERE TagName = "SysTimeSec"
AND DateTime >= "2001-09-12 12:59:00"
AND DateTime <= "2001-09-12 13:00:00" ')
The following example retrieves data from a wide table:
SELECT * FROM OPENQUERY(INSQL, 'SELECT DateTime, SysTimeSec
FROM WideHistory
WHERE DateTime >= "2001-09-12 12:59:00"
AND DateTime <= "2001-09-12 13:00:00" ')
The OPENQUERY portion of the statement is treated as a table by SQL Server, and can also be
used in joins, views, and stored procedures. SQL Server sends the quoted statement, unchanged
and as a string, to the Historian OLE DB provider. Consequently, only the syntax that the Historian
OLE DB provider can parse is supported. Also, be sure that you do not exceed the 8000 character
limit for the statement. Consider the following example:
SELECT * FROM OpenQuery(INSQL, 'XYZ')
where "XYZ" is the statement to pass. You should be sure that the value of "XYZ" is not more than
8000 characters. This limit is most likely to cause a problem if you are querying many tags from a
wide table.
Also, you should supply the datetime in an OPENQUERY statement in the following format:
yyyy-mm-dd hh:mm:ss.fff
For example:
2001-01-01 09:00:00.000
You cannot use variables in an OPENQUERY statement. For more information, see the Online
Help topic: Using Variables with the Wide Table.
Using the OPENROWSET Function
The linked server name can be used as an input parameter to an OPENROWSET function. The
OPENROWSET function sends the OLE DB provider a command to execute. The returned rowset
can then be used as a table or view reference in a Transact-SQL statement. For example:
SELECT * FROM OPENROWSET('INSQL',' ', 'SELECT DateTime, Quality,
QualityDetail, Value
FROM History
WHERE TagName in ("SysTimeSec")
AND DateTime >= "2001-09-12 12:59:00"
AND DateTime <= "2001-09-12 13:00:00" ')
Wonderware Training
Section 2 Historian Time Domain Extensions
This section explains the Data Retrieval Subsystem and Features for the Historian.
Data Retrieval Methods
The SQL language is not always appropriate for handling time series data. The Historian adds
several extensions to the normal SQL language to make it possible to meaningfully query this type
of information. The methods of data retrieval can be grouped by function as follows:
Time interpolation
Wide Table Transformations
Storage Independent Retrieval Mode
Resolution Control
Edge Detection
Time Domain Extensions
Each of the above functions is described in the following pages. The various extensions can be
used together to achieve a wide range of effects. The extensions only apply to the live (real time)
and history tables.
Time Interpolation
This extension allows data to be retrieved at any point in time even if there is no row at that point in
time.
Why This is Needed
An unassisted database would return data from history for a specified point in time only if there
were an actual row with that time stamp. If there were no row data, complex SQL would be
required to determine the effective value.
How It Is Used
Nothing special is required to use Time Interpolation. This is inherent in the way the Historian
handles all queries to the extension data.
For example the queries:
SELECT Value
FROM InSQL.runtime.dbo.AnalogHistory
WHERE TagName = 'SysTimeHour'
AND DateTime = '20070218 17:45:55'
and
SELECT Value
FROM InSQL.runtime.dbo.AnalogHistory
WHERE TagName = 'SysTimeHour'
AND DateTime = '20070218 17:45:58'
both request data 3 seconds apart, and both return a value of 17, even though the tag
SysTimeHour is stored cyclically only once every 5 minutes.
Section Objective
Explain the Data Retrieval Subsystem and Features for the Historian
Wonderware Training
Wide Table Transformation
Wide Table Transformation is defined as the ability to provide the same historical data in two
different table formats: one in Narrow table format, and one in Wide table format, for each of the
basic data types.
For example, we can view the tables WideHistory and History. These two formats are
appropriate for very different uses.
Data for three tags from the wide table typically looks like this:
Dat eTi me SysTi meSec SysTi meMi n SysTi meHour
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2007- 02- 18 13: 56: 13. 153 13. 0 56. 0 13. 0
2007- 02- 18 13: 56: 49. 517 4 56. 0 13. 0
2007- 02- 18 13: 57: 25. 880 25. 0 57. 0 13. 0
2007- 02- 18 13: 58: 02. 243 2. 0 58. 0 13. 0
2007- 02- 18 13: 58: 38. 607 38. 0 58. 0 13. 0
2007- 02- 18 13: 59: 14. 970 14. 0 59. 0 13. 0
2007- 02- 18 13: 59: 51. 333 51. 0 59. 0 13. 0
The same data from the narrow table looks like this:
Dat eTi me TagName Val ue Qual i t y
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2007- 02- 18 13: 52: 04. 277 SysTi meSec 4. 0 0
2007- 02- 18 13: 52: 04. 277 SysTi meMi n 52. 0 0
2007- 02- 18 13: 52: 04. 277 SysTi meHour 13. 0 0
2007- 02- 18 13: 52: 40. 640 SysTi meSec 40. 0 0
2007- 02- 18 13: 52: 40. 640 SysTi meMi n 52. 0 0
2007- 02- 18 13: 52: 40. 640 SysTi meHour 13. 0 0
2007- 02- 18 13: 53: 17. 003 SysTi meSec 17. 0 0
2007- 02- 18 13: 53: 17. 003 SysTi meMi n 53. 0 0
2007- 02- 18 13: 53: 17. 003 SysTi meHour 13. 0 0
2007- 02- 18 13: 53: 53. 367 SysTi meSec 53. 0 0
2007- 02- 18 13: 53: 53. 367 SysTi meMi n 53. 0 0
2007- 02- 18 13: 53: 53. 367 SysTi meHour 13. 0 0
2007- 02- 18 13: 54: 29. 730 SysTi meSec 2. 0 0
2007- 02- 18 13: 54: 29. 730 SysTi meMi n 54. 0 0
2007- 02- 18 13: 54: 29. 730 SysTi meHour 13. 0 0
The data is physically stored only once.
Analysis
The narrow format is best for most relational query use.
The wide format is best for most Engineering uses.
The advantages and disadvantages to each type are as follows:
In a traditional database you would either have to select one of the above with the attendant
disadvantages, or store the data twice.
The Historian gives both formats while storing only once. The Historian provides the time domain
extensions on both formats.
Wide Table Format Narrow Table Format
Easy to visualize, especially for cyclically stored data
because one can see the values for each of the tags
in a single row for a point in time.
Hard to interpret visually.
Allows one to use the value of specified tags to
scope the retrieval of data for other tags. For
example Show me the level in the tank when the
pressure was greater than 50 and the temperature
was less than 32.
This type of query would require nested selects.
Well suited for import and export into non-relational
systems such as Excel or legacy historian systems.
This type of import/ export is not easily performed
with out some form of non-SQL processing.
Requires a column per tag. This limits the number of
Tags to the maximum allowed by the relational
database.
Supports an unlimited number of tags.
Very inefficient for the retrieval of delta stored data. Good for delta storage but not for cyclic.
Cannot query value qualifiers such as the fields
Quality and QualityDetail in the narrow table.
Easily supports any other columns.
Does not allow joins on TagName. Thus one cannot
select tags based on information in other tables.
Ideal relational format.
Table structure is determined by the tags making it
very cumbersome to add new tags.
Table structure does not change when tags are
added and deleted.
No joins to other tables are possible on Value so a
query for alarms conditions defined in another table
would be impossible.
Ideal relational format.
Wonderware Training
Here is a typical narrow table query:
SELECT DateTime,TagName,Value,Quality
FROM v_AnalogHistory
WHERE TagName IN ('SysTimeSec', 'SysTimeMin' , 'SysTimeHour')
This query returns the following rows:
Dat eTi me TagName Val ue Qual i t y
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2007- 02- 18 13: 52: 04. 277 SysTi meSec 4. 0 0
2007- 02- 18 13: 52: 04. 277 SysTi meMi n 52. 0 0
2007- 02- 18 13: 52: 04. 277 SysTi meHour 13. 0 0
2007- 02- 18 13: 52: 40. 640 SysTi meSec 40. 0 0
2007- 02- 18 13: 52: 40. 640 SysTi meMi n 52. 0 0
2007- 02- 18 13: 52: 40. 640 SysTi meHour 13. 0 0
2007- 02- 18 13: 53: 17. 003 SysTi meSec 17. 0 0
2007- 02- 18 13: 53: 17. 003 SysTi meMi n 53. 0 0
2007- 02- 18 13: 53: 17. 003 SysTi meHour 13. 0 0
2007- 02- 18 13: 53: 53. 367 SysTi meSec 53. 0 0
2007- 02- 18 13: 53: 53. 367 SysTi meMi n 53. 0 0
2007- 02- 18 13: 53: 53. 367 SysTi meHour 13. 0 0
2007- 02- 18 13: 54: 29. 730 SysTi meSec 53. 0 0
2007- 02- 18 13: 54: 29. 730 SysTi meMi n 54. 0 0
2007- 02- 18 13: 54: 29. 730 SysTi meHour 13. 0 0
Here is a typical Wide Table query:
SELECT*
FROM OpenQuery(INSQL,"
SELECT DateTime, SysTimeSec, SysTimeMin, SysTimeHour
FROM runtime.dbo.WideHistory
WHERE wwRetrievalMode = 'Cyclic' ")
The query returns the following rows:
Dat eTi me SysTi meSec SysTi meMi n SysTi meHour
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2007- 02- 18 13: 56: 13. 153 13. 0 56. 0 13. 0
2007- 02- 18 13: 56: 49. 517 4 56. 0 13. 0
2007- 02- 18 13: 57: 25. 880 25. 0 57. 0 13. 0
2007- 02- 18 13: 58: 02. 243 2. 0 58. 0 13. 0
2007- 02- 18 13: 58: 38. 607 38. 0 58. 0 13. 0
2007- 02- 18 13: 59: 14. 970 14. 0 59. 0 13. 0
2007- 02- 18 13: 59: 51. 333 51. 0 59. 0 13. 0
Storage Independent Retrieval Mode
This feature allows you to retrieve data using several different methods, regardless of how the
data was stored.
Normally the way that data is stored in a relational database determines exactly how it will be
retrieved. One must thus pre-determine what method will be used to store time series data.
The Historian enables you to specify how data is stored on a per-tag basis. The time domain
extensions in the Historian enable the choice of the retrieval mode at query time.
Storage type and retrieval type are independent choices.
At retrieval time one specifies the retrieval mode using a virtual column (see the following) called
wwRetrievalMode.
The Historian employs virtual columns to implement three of the time domain extensions it
provides. A virtual column is a column that is generated on the fly by the Historian. There is no
actual stored data for these columns. Specifying criteria with these columns in the WHERE clause
controls the behavior of the time domain extensions.
Each storage/retrieval method is described in detail in the following section:
wwRetrievalMode = Cyclic
wwRetrievalMode = Delta
Retrieval Type Normal Cyclic Retrieval
Usage Use as:
wwRetrievalMode =Cyclic
Use with:
wwCycleCount
wwTimeStampRule (Start,End)
wwResolution
Results Returns cyclic time stamps based on time boundaries. Cyclic mode sets the number of
rows per tag to be returned. The rows will be evenly spaced over the time period
specified by the start and end datetime.
QualityDetail Value N/A
Retrieval Type Normal Delta Retrieval
Usage Use as:
wwRetrievalMode ='Delta'
Use with:
wwCycleCount
Results Returns delta points. Values will be returned each time the value changes within the time
period specified by the start and end datetime.
Wonderware Training
wwRetrievalMode = Full
wwRetrievalMode = Interpolated
wwRetrievalMode = Integral
Retrieval Type Delta retrieval all points
Usage Use as:
wwRetrievalMode ='Full'
Use with:
wwCycleCount
Results A cyclic retrieval based on delta points where the actual points returned are Stairstep
(normal cyclic) or Interpolated values based on available delta points. The results can
contain positive and negatives values.
Retrieval Type Cyclic
Usage Use as:
wwRetrievalMode ='Interpolated'
wwInterpolationType ='Stairstep' or 'Linear' (default setting based on system or tag
parameter)
Use with:
wwCycleCount
wwResolution
wwTimeStampRule ('Start', 'End')
wwQualityRule ('Good','Extended')
Results A cyclic retrieval based on delta points where the actual points returned are Stairstep
(normal cyclic) or Interpolated values based on available delta points. The results can
contain positive and negatives values.
Retrieval Type Cyclic (uses Full retrieval points)
Usage Use as:
wwRetrievalMode ='Integral'
wwInterpolationType ='Stairstep' or 'Linear' [integral divisor].
Use with:
wwCycleCount
wwResolution
Results Returns cyclic slices equal to the integral or area of each slice. The area value is scaled
down based on the IntegralDivisor in the EngineeringUnit table ((average value * number
of seconds)/Integraldivisor).
wwRetrievalMode = Average
wwRetrievalMode = BestFit
Retrieval Type Cyclic (uses Full retrieval points)
Usage Use as:
wwRetrievalMode ='Average'
wwInterpolationType ='Stairstep' or 'Linear'
Use with:
wwCycleCount
wwResolution
Results Returns a value which is the Integral value divided by the number of seconds (Integral/
seconds). A time-weighted average algorithm is used to calculate the values to be
returned for each retrieval cycle.
QualityDetail Value If all the points found are good (192) then Qualitydetail value will be 192. Otherwise if the
quality of any point is not 192 or can not calculate (NULL points found) qualitydetail value
will be 64 (undetermined) and will be sent to OPCQuality. Percent column show percent
of usable points that are not NULL.
Retrieval Type Delta retrieval with cycles
Usage Use as:
wwRetrievalMode ='bestfit'
Use with:
wwCycleCount
wwResolution
Results Returns a max of 5 rows (delta point) per cycle where for each cycle contains distinct
values for the First time stamp, Last time stamp, Min value, Max value and First NULL
encountered. If for example First, Last, Min or Max are the same value will return only
one row for those values.
QualityDetail Value If the cycle was complete returns a 192, else 1216 or 4288 for an incomplete or partial
cycle, QD =1068 for incomplete cycle where a re-connect happened. Incomplete or
partial cycles are cycles that do not meet the resolution or contain NULLs.
Wonderware Training
wwRetrievalMode = Minimum
wwRetrievalMode = Maximum
wwRetrievalMode = Counter
Retrieval Type Delta retrieval with cycles (uses Full retrieval)
Usage Use as:
wwRetrievalMode ='minimum'
Use with:
wwCycleCount
wwResolution
Results Returns one row (delta point) for each cycle identifies the minimum value with in each
cycle, except for the phantom cycle (first row) will return the time stamp of the value
found (delta point).
QualityDetail Value If the cycle was complete returns the 192, else 1216 for incomplete. Incomplete or partial
cycles do not meet the resolution or contain NULLs.
Retrieval Type Delta retrieval with cycles (uses Full retrieval)
Usage Use as:
wwRetrievalMode ='maximum'
Use with:
wwCycleCount
wwResolution
Results Returns one row (delta point) for each cycle identifies the maximum value with in each
cycle, except for the phantom cycle (first row) will return the time stamp of the value
found (delta point).
QualityDetail Value If the cycle was complete returns the 192, else 1216 for incomplete. Incomplete or partial
cycles do not meet the resolution or contains NULL.
Usage Use as:
wwRetrievalMode ='counter'
Use with:
wwCycleCount
wwResolution
Results Returns a total or accumulated value of the delta points with in each cycle or the
difference between the end value and start value of the cycle. Requires the 'Rollover
value' for the tag be set to 1 more then the max value of the tag. Only works with discrete
and Analog unsigned integer tags.
QualityDetail Value If a cycle results in a roll-over the QualityDetail of that cycle will identified with a 212.
wwRetrievalMode = Slope
wwRetrievalMode = ValueState
Retrieval Type Delta (uses Full retrieval points)
Usage Use as:
wwRetrievalMode ='slope'
Use with:
wwCycleCount
Results Returns (delta point) the +/- rate of change, which represents the magnitude change per
second. Results shown as +/- if going positive or negative.
QualityDetail Value
Usage Use as:
wwRetrievalMode ='ValueState'
Use with:
wwCycleCount
wwResolution
wwStateCalc ('Minimum' (Min), 'Maximum' (Max), 'Average' (Avg), 'Total' (Sum), 'Percent'
Results Returns the amount of Time (in StateTime column) of each distinct value found in each
cycle as indicated by wwCycleCount or wwResolution.
Note: Can use the History or the wide StateWideHistory table to obtain the same
information. History table uses StateTime column to show the percent or time (in
milliseconds) based on the wwStateCalc requested.
QualityDetail Value
Wonderware Training
A summary of each storage/retrieval method is shown in the following table:
Cycle
Count (X
Values
over
Equal
Time
Intervals)
Resolution
(Values
Spaced
Every X
ms)
Time
Deadband
Value
Deadband
History
Version
Interpolation
Type
Timestamp
Rule
Quality
Rule
Row Limit
Cyclic
Retrieval
*
Delta
Retrieval

Full Retrieval
Interpolated
Retrieval

Best Fit
Retrieval

Average
Retrieval

Minimum
Retrieval

Maximum
Retrieval

Resolution Control
This set of extensions allows you to control the apparent resolution of the underlying data in the
analog and discrete history tables. Different control mechanisms are provided for the different
retrieval modes.
The data resolution requirement for a tag is often a function of the proposed usage of the data.
Examples:
A trend program does not require a higher resolution of data than can meaningfully be
displayed on the display device. In this case data reduction is typically required to prevent
millions of unneeded values being sent to the client.
When performing some aggregations data is required at a specific resolution for the
aggregation to have meaning. For example, a volume can be deduced from a flow (such
as Gallons per Minute) by summing the samples provided that the samples are at an
appropriate resolution (such as 1 second for this case).
Values of tags with widely differing time characteristics are being compared.
When the underlying data storage mode is delta but cyclic retrieval is being used.
At retrieval time one specifies time resolution using one or more of the virtual columns (see below)
called wwCycleCount, wwResolution, wwValueDeadband and wwTimeDeadband.
Historian uses virtual columns to implement four of the time domain extensions it provides.
wwCycleCount. In Cyclic mode this sets the number of rows per tag to be returned. The
rows will be evenly spaced over the time period specified by the start and end datetime of
the query. wwCycleCount and wwResolution are mutually exclusive.
wwResolution. This is an integer value in milliseconds. In Cyclic mode this sets the time
interval between samples to be returned over the time period specified by the start and
end datetime of the query. wwCycleCount and wwResolution are mutually exclusive.
wwValueDeadband. This a float value specifying a percentage of full scale. In Delta
mode it is used to control when a change in value is considered to occur. It can have any
value between 0 and 100. A change in value is only considered to have occurred when the
value changes by at least this percentage of the full scale of the tag.
wwTimeDeadband. This is an integer value in milliseconds. In Delta mode it is used to
control the number of rows returned. Values will not be returned more frequently than this
even if the underlying data changes many times within the interval.
Wonderware Training
Edge Detection
This extension enables detection of a value change using edge conditions. For example it can be
used to determine the point in time that a tag goes into (leading) or comes out of (trailing) alarm.
Normal SQL queries return all data that matches the applied criteria. With time series data one is
often only interested in the first or last point when criteria become valid or not. For example one
might want to find the time that an alarm limit is exceeded. The normal query:
SELECT Dat eTi me, Val ue FROM v_Anal ogHi st or y
WHERE TagName = ' SysTi meSec'
AND Val ue > 55
AND wwResol ut i on = 1000
Will return the following rows:
Dat eTi me Val ue
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2007- 02- 18 16: 37: 56. 730 56. 0 ?---- Limit Exceeded here
2007- 02- 18 16: 37: 57. 730 57. 0
2007- 02- 18 16: 37: 58. 730 58. 0
2007- 02- 18 16: 37: 59. 730 59. 0
2007- 02- 18 16: 38: 57. 730 57. 0
2007- 02- 18 16: 38: 58. 730 58. 0
2007- 02- 18 16: 38: 59. 730 59. 0
2007- 02- 18 16: 39: 57. 730 57. 0
2007- 02- 18 16: 39: 58. 730 58. 0
2007- 02- 18 16: 39: 59. 730 59. 0
2007- 02- 18 16: 40: 57. 730 57. 0
2007- 02- 18 16: 40: 58. 730 58. 0
2007- 02- 18 16: 40: 59. 730 59. 0
<- - - About 190 r ows omi t t ed f or cl ar i t y
2007- 02- 18 17: 36: 56. 730 56. 0
2007- 02- 18 17: 36: 57. 730 57. 0
2007- 02- 18 17: 36: 58. 730 58. 0
2007- 02- 18 17: 36: 59. 730 59. 0
( 240 r ow( s) af f ect ed)
The problem is that we are not, in this case, interested in any of the values between the points that
the limit is exceeded. At first glance it appears that one could find these point using the TOP
argument of a SELECT statement but this is not the case.
At retrieval time one specifies that edge detection should be applied to the query using the virtual
column (see below) called wwEdgeDetection.
The virtual column wwEdgeDetection is a character column whose values can be None,
Leading, Trailing or Both. This column determines how rows are returned when the WHERE
criteria in the query evaluate to true.
The effects are:
None: Returns all rows that successfully meet the criteria; no edge detection is
implemented at the specified resolution.
Leading: Returns only rows that are the first to successfully meet the criteria (return true)
after a row did not successfully meet the criteria (returned false).
Trailing: Returns only rows that are the first to fail the criteria (return false) after a row
successfully met the criteria (returned true).
Both: All rows satisfying both the leading and trailing conditions are returned.
So to avoid the effect shown by the preceding example we use the following query:
SELECT DateTime, Value FROM v_AnalogHistory
AND Value > 55
AND wwResolution = 1000
AND wwEdgeDetection = 'Leading'
It returns the following data:
Dat eTi me Val ue
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2007- 02- 18 17: 13: 56. 180 56. 0
2007- 02- 18 17: 14: 56. 180 56. 0
2007- 02- 18 17: 15: 56. 180 56. 0
2007- 02- 18 17: 16: 56. 180 56. 0
2007- 02- 18 17: 17: 56. 180 56. 0
<- - - About 50 r ows omi t t ed f or cl ar i t y
2007- 02- 18 18: 09: 56. 180 56. 0
2007- 02- 18 18: 10: 56. 180 56. 0
2007- 02- 18 18: 11: 56. 180 56. 0
2007- 02- 18 18: 12: 56. 180 56. 0
( 60 r ow( s) af f ect ed)
The results show the time at which the tag value exceeds 55
Wonderware Training
Time Domain Extensions
The following table provides information for the Historian Time Domain Extensions:
wwVersion
The wwVersion time domain extension allows you to specify which version of the stored data is to
be retrieved. The storage subsystem handles versioning by creating new tags to represent
updates and inserts. The tags containing the updates/inserts have a creation date, which is used
to version the data.
If a number of updates or inserts have been made, there will be a number of timestamped
versions. However, there will be two possible versioning types that you can use to access data:
ORIGINAL and LATEST.
Note: The values ORIGINAL and LATEST are not case-sensitive.
If you do not specify the version, the latest modified data value will be retrieved.
For example:
SELECT TagName, DateTime, Value, wwVersion
FROM INSQL.Runtime.dbo.History
WHERE TagName IN ('SysTimeHour', 'SysTimeMin')
AND DateTime >= '2007-12-20 0:00'
AND DateTime <= '2007-12-20 0:05'
AND wwRetrievalMode = 'delta'
AND wwVersion = 'original'
wwCycleCount Determines the number of rows to be retrieved.
wwEdgeDetection The moment at which a detection criterion is met. A string value of Leading,
Trailing, Both or None. Defaults to None.
wwInterpolationType Controls how retrieval will determine which analog value to return at a given cycle
boundary. Valid values are STAIRSTEP and LINEAR.
wwQualityRule Specify whether values with certain characteristics are explicitly excluded from
consideration by data retrieval. Valid values are GOOD or EXTENDED.
wwResolution Specify the time interval in milliseconds between samples to be returned.
wwRetrievalMode Determines the type of result set returned. A string value of Cyclic, Delta, Full,
Interpolated, Integral, Average, BestFit, Minimum, Maximum, Counter, Slope, or
ValueState may be used. Default depends on the table.
wwTimeStampRule Use to specify whether cyclic results are timestamped at the beginning of the
cycle or the end of the cycle. Valid values are START and END.
wwTimeDeadband The time deadband, in milliseconds, to apply to the result set. Only meaningful for
Delta queries. Ignored for Cyclic queries. Defaults to 0 (no deadband).
wwValueDeadband The value deadband, in percent of full scale, to apply to the result set. Only
meaningful for Delta queries. Ignored for Cyclic queries. Defaults to 0 (no
deadband). Not available for v_DiscreteHistory (only 0 & 1).
wwTimeZone Determines time zone format for returned data. Defaults to the time zone of the
Historian computer.
wwVersion Determines which version of data is returned. A string value of Original or
Latest. Defaults to Latest.
The results are:
wwTimeZone
For the Historian 8.0 and later, all history data is stored in Universal Time Coordinated (UTC). The
wwTimeZone extension allows you to specify the time zone to be used for the timestamps of the
returned data values. The retrieval subsystem will convert the timestamps to local time in the
specified time zone.
The wwTimeZone extension may be assigned any of the values stored in the TimeZone column of
the TimeZone table in the Runtime database. In addition to specifying the name of the timezone in
the wwTimeZone parameter, you can also specify the TimeZoneID (as a string). For example, on a
typical US English system, specifying " wwTimeZone ='Mountain Standard Time' " and
"wwTimeZone ='64' " yields the same result.
The TimeZone table is repopulated at every system startup from Microsoft operating system
registry entries, and will therefore reflect the time zones available via the server operating system,
including any new or custom time zones that might be added by operating system service packs or
installed software.
The retrieval subsystem will automatically correct for daylight savings time in the requested time
zone. When computing daylight savings and time zone parameters, the settings of the server
operating system are used. The retrieval sub-system does not provide any means for using client-
side settings.
If wwTimeZone is not specified, the time zone for retrieval defaults to the time zone of the Historian
computer.
For example:
SELECT TagName, Dat eTi me, Val ue, wwTi meZone
FROM I NSQL. Runt i me. dbo. Hi st or y
WHERE TagName I N ( ' SysTi meHour ' , ' SysTi meMi n' )
AND Dat eTi me >= ' 2007- 12- 20 0: 00'
AND Dat eTi me <= ' 2007- 12- 20 0: 05'
AND wwRet r i eval Mode = ' del t a'
AND wwTi meZone = ' W. Eur ope St andar d Ti me'
TagName DateTime Value wwVersion
SysTi meMi n 2007- 12- 20 00: 00: 00. 000 0. 0 ORI GI NAL
SysTi meHour 2007- 12- 20 00: 00: 00. 000 0. 0 ORI GI NAL
Wonderware Training
The results are:
TagName DateTime Value wwTimeZone
SysTi meMi n 2007- 12- 20 00: 00: 00. 000 0. 0 W. Eur ope St andar d Ti me
SysTi meHour 2007- 12- 20 00: 00: 00. 000 15. 0 W. Eur ope St andar d Ti me
Lab 3 Query Examples
Introduction
This lab employs Microsoft SQL Server Management Studio, which is installed as a client utility
with Microsoft SQL Server 2005.
Objective
Open SQL Server Management Studio and connect to the Historian
Execute SQL Queries against the Historian Runtime Database
Wonderware Training
Run a SQL Query
1. Double-click the QueryExamples.sql file located in the C:\Wonderware Training folder.
2. Configure the Connect to Database Engine window as follows, entering aaUser in the
Login: field and pwUser in the Password: field.
3. Click Connect to connect to Microsoft SQL Server.
4. Select the Runtime database in the drop-down menu.
5. Highlight the Example 1 query and click the Execute button.
The following queries are intended for use as a reference in order to build your own queries.
Each query includes an explanation of why it is used and how it works.
When using Microsoft SQL Server Management Studio, highlight only the query you plan to
run one at a time! If you click the Execute button with no queries highlighted, the system will
run all the queries in your current session. This could cause significant overload to your
system.
6. After highlighting the selected query, execute the query by using the Ctrl+E keys or click
Execute.
7. Change date/time in the query to retrieve current data where applicable.
Query Examples
- - Exampl e 1
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- -
- - Per f or mi ng A Si mpl e Quer y:
SELECT *
FROM Tag
- - Exampl e 2
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- -
- - Sel ect i ng Mul t i pl e Col umns:
SELECT Tagname, Description, DateCreated
FROM Tag
- - Exampl e 3
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- -
- - I nt r oduci ng The ' WHERE' Cl ause:
SELECT Tagname, Description
FROM Tag
WHERE Tagname = 'SysTimeSec'
- - Exampl e 4
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- -
- - Usi ng t he I N St at ement I n A WHERE Cl ause:
Wonderware Training
SELECT TagName, MinEU, MaxEU
FROM AnalogTag
WHERE TagName IN ('LIT_001.PV', 'TT_001.PV', 'InletValve_001.PV')
- - Exampl e 5
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- -
- - Compl ex WHERE Cl ause wi t h LI KE st at ement :
SELECT TagName, MinEU, MaxEU
FROM AnalogTag
WHERE TagName LIKE 'sys%'
AND MaxEU<50
- - Exampl e 6
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- -
- - J OI NS - Sel ect i ng Dat a Fr omMul t i pl e Tabl es:
SELECT TagName, MinEU, MaxEU, Unit
FROM AnalogTag, EngineeringUnit
WHERE EngineeringUnit.EUKey = AnalogTag.EUKey
- - I f a col umn i s sel ect ed t hat i s pr esent i n mor e
- - t han one t abl e, you must speci f y Tabl eName. Col umnName:
SELECT AnalogTag.TagName, Description, MinEU, MaxEU
FROM AnalogTag, Tag
WHERE Tag.TagName = AnalogTag.TagName
- - Exampl e 7
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- -
- - J OI NS wi t h Compl ex WHERE St at ement s:
SELECT TagName, MinEU, MaxEU, Unit
FROM AnalogTag, EngineeringUnit
WHERE EngineeringUnit.EUKey = AnalogTag.EUKey
AND Tagname LIKE 'sys%'
AND Unit = 'Day'
- - Exampl e 8
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- -
- - Accessi ng Dat a Fr omt he I nSQL Ext ensi on Tabl es
- - The " Li ve" t abl e pr ovi des l i ve val ues f or
- - al l t ag t ypes i n one t abl e:
SELECT Datetime, Tagname, Value
FROM Live
WHERE Tagname in ('LIT_001.PV', 'InletValve_001.PV.IsActive1',
'SysString')
- - NOTE: Not i ce t he " NULL" val ue gi ven f or t he st r i ng t ag
- - " SysSt r i ng". When accessi ng st r i ng t ags i n t he Li ve or Hi st or y
- - t abl es t he " vVal ue" col umn i s used. vVal ue col umn st or es t he
- - val ue as a sql _var i ant whi ch al l ows val ues wi t h mi xed dat at ypes
- - as a r esul t :
SELECT Datetime, Tagname, Value, vValue
FROM Live
WHERE Tagname in ('LIT_001.PV', 'InletValve_001.PV.IsActive1',
'SysString')
Wonderware Training
- - Exampl e 9
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Accessi ng Dat a f r omt he Hi st or y t abl e
SELECT Datetime, Tagname, vValue
FROM History
WHERE Tagname = 'TT_001.PV'
- - Not i ce t hat t hi s quer y r et ur ns hi st or y dat a f or t he l ast hour . Si nce
- - t he quer y doesn' t speci f y a t i me per i od expl i ci t l y, Hi st or i an
- - r et ur ns one hour wor t h of dat a. However , t her e ar e sever al ways t o
- - speci f y a t i me per i od.
- - Exampl e 10
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Accessi ng Hi st or y t abl es usi ng Dat e const ant s. Modi f y t he dat es i n t he
- - quer y as needed.
FROM History
AND Datetime > 'January 1, 1970 10:00'
AND Datetime <= 'January 1, 1970 10:30'
- - Exampl e 11
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Usi ng Get dat e( )
- - The Get dat e( ) f unct i on r et r i eves t he cur r ent dat et i mef r omt he comput er cl ock.
- - Modi f y t he dat es i n t he quer y as needed.
FROM History
AND Datetime > 'January 1, 1970 10:00'
AND Datetime <= Getdate()
- - Exampl e 12
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Usi ng Dat eadd wi t h Get dat e( ) :
- - Usi ng Dat eadd i n conj unct i on wi t h t he Get dat e( ) f unct i on
- - al l ows t he user t o speci f y an st andar d of f set f r omt he
- - cur r ent t i me. The f ol l owi ng quer y wi l l al ways r et ur n
- - t he l ast hour of dat a f or t he t ags ' TT_001. PV and LI T_001. PV' :
FROM History
WHERE Tagname IN ('TT_001.PV', 'LIT_001.PV')
AND Datetime > Dateadd(mi, -60, Getdate())
- - Exampl e 13
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Accessi ng Dat a Fr omWi deHi st or y
- - Wi de Tabl es:
- - I n t he pr ecedi ng exampl e t he dat a i s har d t o r ead. Thi s i s
- - because t he dat a f or a par t i cul ar t ag i s not gr ouped f or
- - easy vi ewi ng. A speci al set of t abl es ar e pr ovi ded whi ch
- - use t he t agname as a col umn name, t hus maki ng t he t abl e
- - easi er t o vi ew. To access t hese t abl es an OpenQuer y must
- - be used:
Wonderware Training
SELECT *
FROM OpenQuery (INSQL, '
SELECT Datetime, [LIT_001.PV], [InletValve_001.PV.IsPassive],
SysString
FROM WideHistory
WHERE Datetime > Dateadd(mi, -65, Getdate())
AND Datetime <= Getdate()')
- - Not i ce t he squar e br acket s ar ound LI T_001. PV and I nl et Val ve_001. PV. I sPassi ve
- - Thi s i s needed because t he dot i s a r eser ved char act er i n MS SQL Ser ver .
- - I n t he r esul t s of t he pr ecedi ng quer y, not i ce t hat a val ue i s gi ven f or
- - SysSt r i ng even t hough i t onl y changed at t he t op of t he hour , When usi ng
- - del t a quer i es on a wi de t abl e, a new r ow i s r et ur ned i f any of t he r equest ed
- - t ags change val ue.
- - Exampl e 14
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Usi ng ' wwRet r i eval Mode' , Cycl i c vs. Del t a Ret r i eval
- - Pr ocess dat a user s use dat a di f f er ent l y t han most ot her user s of dat abases
- - ( banks, sci ent i f i c communi t i es et c. ) . To al l ow our user s t o vi ew t he dat a i n
- - t he most advant agi ous way, a number of speci al f unct i ons wer e added t o t he
- - Tr ansact - SQL l anguage. We cal l t hese f unct i ons Real Ti me SQL. The f i r st we
- - wi l l expl or e i s t he wwRet r i eval Mode f unct i on. wwRet r i eval Mode al l ows t he user
- - t o over r i de t he def aul t r et r i eval mode f or t he hi st or y t abl es on a per quer y
- - basi s.
- - Fi r st i s t he concept of " Cycl i c" ver sus " Del t a" r et r i eval modes. The Hi st or y
- - t abl e r et ur ns dat a usi ng Del t a r et r i eval mode as def aul t . Thi s means t hat a
- - new r ow i s r et ur ned onl y i f t he val ue changes. Not i ce t hat t he i nt er val
- - bet ween each r ow i s di f f er ent f or t he f ol l owi ng quer i es:
FROM History
- - wwRet r i eval Mode al l ows you t o over r i de t he def aul t r et r i eval mode.
- - I n t he f ol l owi ng quer y t he r et r i eval mode i s f or ced t o cycl i c f or
- - t hi s one quer y onl y. Not i ce t he r et ur ned val ues ar e evenl y spaced ever y
- - mi nut e.
FROM History
AND wwRetrievalMode = 'cyclic'
- - Del t a r et r i eval mode can al so be expl i ci t l y i ndi cat ed:
FROM History
- - Cycl i c r et r i eval i s usef ul when l ooki ng f or pr of i l es and aver ages, whi l e
- - Del t a r et r i eval i s usef ul when l ooki ng f or al t er at i ons i n dat a, l i ke a
- - set poi nt change t hat occur ed once dur i ng a shi f t .
- - Exampl e 15
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Wonderware Training
- - Usi ng ' Ful l ' Ret r i eval Mode
- - For f ul l r et r i eval mode, al l st or ed val ues wi l l be r et ur ned, r egar dl ess
- - of whet her a val ue or qual i t y has changed si nce t he l ast val ue. I f used i n
- - conj unct i on wi t h st or age wi t hout f i l t er i ng ( no del t a or cycl i c st or age mode
- - appl i ed) , t he f ul l r et r i eval mode al l ows f or t he r et r i eval of al l val ues and
- - qual i t y t hat or i gi nat ed f r omt he pl ant f l oor dat a sour ce or f r omanot her
- - appl i cat i on.
FROM History
WHERE Tagname = 'LIT_001.PV'
AND wwRetrievalMode = 'full'
- - Ful l r et r i eval mode i s especi al l y i mpor t ant when used t o r et r i eve dat a
- - st or ed by Wonder war e Appl i cat i on Ser ver , si nce i t wi l l di spl ay ever y si ngl e
- - val ue comi ng f r omt he Gal axy.
- - Exampl e 16
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Usi ng ' wwResol ut i on'
- - Let ' s exami ne a si mpl e cycl i c quer y:
FROM History
- - Not i ce t hat Hi st or i an r et ur ns 100 r ows evenl y spaced over t he
- - t i me per i od speci f i ed. Thi s i s t he def aul t behavi our , but t her e ar e
- - mechani sms t o speci f y ' how much' dat a you want .
- - wwResol ut i on t el l s Hi st or i an t o r et ur n dat a separ at ed by a f i xed
- - t i me i nt er val ( set i n mi l l i seconds) . Thi s wor ks best wi t h quer i es i n CYCLI C
- - r et r i eval mode. The f ol l owi ng quer y r et ur ns dat a ever y second f or t he l ast
- - 10 mi nut es.
FROM History
- - By changi ng t he wwr esol ut i on t o 60000 we get a r ecor d ever y mi nut e:
FROM History
- - Exampl e 17
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - The f ol l owi ng exampl e uses cycl i c r et r i eval mode and wwResol ut i on
- - t o cr eat e a wi de f or mat r epor t f or t he l ast hour :
Wonderware Training
SELECT *
FROM OpenQuery(InSQL, 'SELECT Datetime, [LIT_001.PV], [TT_001.PV],
[InletValve_001.PV.IsActive1]
FROM WideHistory
WHERE Datetime > Dateadd(hh, -1, Getdate())
AND wwRetrievalMode = "Cyclic"
AND wwResolution = 60000')
- - Exampl e 18
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Usi ng ' wwCycl eCount '
- - Anot her way t o cont r ol t he amount of dat a r et ur ned f r oma quer y i s
- - t he wwCycl eCount f unct i on. Usi ng wwCycl eCount , t he number of r ows t hat wi l l
- - be r et ur ned i s speci f i ed. When wwCycl eCount i s used i n conj unct i on wi t h
- - CYCLI C r et r i eval quer i es t he r ows r et ur ned ar e evenl y spaced t houghout
- - t he t i me per i od speci f i ed. However , when used i n a del t a quer y, wwCycl eCount
- - r et ur ns t he a r ow each t i me t he val ue changes, up t o t he number of r ows
- - speci f i ed.
- - Fi r st i n CYCLI C mode:
FROM History
AND wwCycleCount = 25
- - Now l et ' s see what del t a does:
FROM History
- - Set t i ng wwCycl eCount t o ' zer o' causes ALL val ues wi t hi n t he t i me
- - per i od t o be r et ur ned:
FROM History
- - Thi s i s usef ul when t r yi ng t o r et r i eve dat a when t he sampl e r at e
- - i s unknown.
- - Exampl e 19
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Usi ng Ti me- Wei ght ed Aver age Ret r i eval Mode
- - To get an aver age cal cul at i on f r omhi st or y dat a, we need t o deci de how much
- - dat a goes i nt o t he quer y, al l owi ng us t o deci de how much wor k t he I nSQL
- - Ser ver comput er per f or ms. The f ol l owi ng i s a r ough est i mat e of an hour l y
- - aver age usi ng one sampl e ever y mi nut e:
SELECT AVG(Value)
FROM History
AND Datetime > Dateadd(hh, -1, Getdate())
Wonderware Training
- - The SQL Ser ver AVG aggr egat e i s a si mpl e st at i st i cal aver age. The r esul t wi l l
- - depend on t he r esol ut i on of sampl es. Usi ng t he t i me wei ght ed aver age ( TWA)
- - r et r i eval mode wi l l use act ual val ues i n t he t abl e t o cal cul at e t he aver age.
- - Even i f t he SQL Ser ver AVG aggr egat e r et ur ns a si mi l ar val ue, t he dat a i s
- - r et ur ned much f ast er . The f ol l owi ng exampl e wi l l r et ur n t he aver age f or t he
- - l ast hour :
FROM History
AND wwRetrievalMode = 'average'
- - Exampl e 20
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Ti me Wei ght ed Aver age ( TWA) r et r i eval mode i s a t r ue cycl i c mode, so you can
- - di vi de t he ent i r e per i od of t i me i nt o sever al per i ods. The hi st or i an wi l l
- - r et ur n one r ow f or each t ag i n t he quer y f or each cycl e. To speci f y how many
- - cycl es you want , you can use wwResol ut i on or wwCycl eCount .
- - The f ol l owi ng quer y wi l l r et ur n an hour l y t i me wei ght ed aver age f or t he l ast
- - shi f t :
SELECT Datetime, Tagname, vValue, PercentGood
FROM History
AND wwRetrievalMode = 'average'
- - Exampl e 21
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Ti me- i n- St at e Ret r i eval Mode
- - The t i me- i n- st at e r et r i eval mode r et ur ns t he amount of t i me t hat a t ag has
- - been i n a par t i cul ar st at e f or each r et r i eval cycl e. Thi s r et r i eval mode i s
- - usef ul f or det er mi ni ng how l ong a machi ne has been r unni ng or st opped, how
- - l ong a val ve has been opened or cl osed, and so on:
SELECT Datetime, Tagname, vValue, StateTime, wwStateCalc, qualitydetail
FROM History
WHERE Tagname = 'InletValve_001.PV.IsActive1'
AND wwRetrievalMode = 'ValueState'
- - The val ues can al so be r et r i eved as per cent age
SELECT Datetime, Tagname, vValue, StateTime, wwStateCalc
FROM History
AND wwStateCalc = 'Percent'
- - The wwSt at eCal c speci f i es t he t ype of st at e cal cul at i ons ( aggr egat i ons) t o be
- - per f or med on t he dat a. Val i d val ues ar e ' Tot al ' , ' Per cent ' , ' Mi ni mum' ,
- - ' Maxi mum' and ' Aver age' , ' Tot al ' bei ng t he cal cul at i on by def aul t .
- - The f ol l owi ng quer y wi l l r et ur n an hour l y r epor t of t he aver age t i me t he
- - St eamVal ve has r emai ned opened f or t he l ast shi f t :
Wonderware Training
SELECT Datetime, Tagname, vValue, StateTime, wwStateCalc
FROM History
AND vValue = 1
- - Exampl e 22
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Usi ng ' Best Fi t ' Ret r i eval Mode
- - For t he " best f i t " r et r i eval mode, t he t ot al t i me f or t he quer y i s di vi ded
- - i nt o even sub- per i ods, and t hen up t o f i ve val ues ar e r et ur ned f or each
- - sub- per i od: f i r st , l ast , mi ni mum, maxi mumand f i r st ' except i on' val ues. Thi s
- - mode al l ows f or a compr omi se bet ween del t a r et r i eval mode and cycl i c
- - r et r i eval mode:
FROM History
AND wwRetrievalMode = 'BestFit'
- - Obser ve t he amount of val ues r et ur ned f or t he above quer y, compar ed t o t he
- - val ues r et ur ned f or a del t a r et r i eval :
FROM History
AND wwRetrievalMode = 'Delta'
- - I f you t r y t o gr aph t he r esul t s f or t hese t wo quer i es, you wi l l NOT
- - not i ce a susbst ant i al di f f er ence bet ween bot h cur ves.
- - You can al so use wwCycl eCount t o speci f y t he amount of sub- per i ods
- - f or t he t i me per i od r equest ed:
FROM History
- - Exampl e 23
- - ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
- - Usi ng ' wwEdgeDet ect i on'
- - Thi s f unct i on al l ows a t r anst i on poi nt t o be
- - det ect ed. A common r equi r ement i s t o det ect ' WHEN'
- - somet hi ng st ar t ed t o happen and/ or st opped happeni ng.
- -
- - Fr omour ear l i er exampl es, we have seen t hat i t i s
- - qui t e st r ai ght f or war d t o use a WHERE cl ause i n or der t o
- - sel ect dat a when cer t ai n condi t i ons ar e t r ue. I n many
- - cases, you ar e onl y i nt er est ed i n WHEN t he condi t i on st ar t ed
- - t o happen - and WHEN i t st opped happeni ng.
- -
- - For exampl e, consi der when your pr ocess t emper at ur e goes
- - above a cer t ai n poi nt . You may onl y want t he r esul t set
- - f r omyour quer y t o r et ur n WHEN t hi s st ar t ed t o happen and
- - WHEN i t st opped - not r et ur n ever y val ue r ecor ded when
- - t he condi t i on was t r ue:
Wonderware Training
SELECT DateTime, Tagname, Value
FROM History
WHERE TagName = 'SYSTIMESEC'
AND wwEdgeDetection = 'Leading'
AND Value >= 30
AND DateTime > dateadd(Second, -60,GetDate())
AND DateTime <= GetDate()
- - +++++++++++++++++++++++++++++++++++++++++++
- - The f unct i on can be used i n a number of ways. I t can
- - det ect t he ' st ar t ' of a t r ansi t i on ( l eadi ng) , t he end of a
- - t r ansi t i on ( t r ai l i ng) , or bot h.
- - +++++++++++++++++++++++++++++++++++++++++++
- - Tr ai l i ng:
FROM History
AND wwEdgeDetection = 'Trailing'
AND Value >= 30
- - +++++++++++++++++++++++++++++++++++++++++++
- - Bot h:
FROM History
AND wwEdgeDetection = 'Both'
AND Value >= 30
Module 4
ActiveFactory Trend
Section 2 ActiveFactory Trend 4-7
Lab 4 Use ActiveFactory Trend Basic Functions 4-31
Lab 5 Configure Public Groups and Trend Sets 4-45
Lab 6 Configure Time Offsets and Target Regions 4-57
Lab 7 Advanced Properties: Retrieval Styles 4-65
4-2 Module 4 ActiveFactory Trend
Wonderware Training
Module Objectives
Introduce ActiveFactory Trend.
Use ActiveFactory Trend to display a variety of Historian data.
Configure ActiveFactory Trend Properties.
This section describes the ActiveFactory system requirements, installation considerations, and
licensing features.
System Requirements
Minimum Hardware (Client)
CPU: 400 MHz Pentium or better
Available hard disk space: 45 MB
RAM: 256 MB
Software
Operating system: Windows Server 2003 Enterprise Edition (R2 or SP1), Windows Server
2003 Standard Edition (R2 or SP1), Windows XP Professional SP2, Windows XP Tablet
PC Edition Version 2002 SP1
The add-ins to Microsoft Office require Office 2000, Office XP, Office 2003 or Office 2007
Microsoft Internet Explorer 5.5 or later
ActiveFactory works with Historian version 8.0 SP3 or 9.0, and with MS SQL Server 7.0
and later versions
Installation Notes
Note: Before installing ActiveFactory, disable any Virus Scan applications running on the
machine. Doing so ensures that all ActiveFactory components and services install correctly.
Uninstall any ActiveFactory 8.5 or earlier software prior to installing ActiveFactory 9.2.
If you intend to use Report or Workbook, it is best to install Microsoft Office prior to ActiveFactory.
If you install Microsoft Office after ActiveFactory, please refer to the ReadMe.html file located on
the installation CD.
Active Factory is installed by running Setup.exe from the root of the disc or by inserting the disc
and letting auto-run start the setup program. Follow the simple instructions to complete the
installation. If you are prompted to reboot, please log in as the same user after the reboot for the
install to complete.
If you are installing on Terminal Services remember to start the installation using the Add /
Remove Programs control panel applet. You are now ready to begin using your ActiveFactory
applications from the Start menu under Wonderware / ActiveFactory.
The default installation location should reflect the standard FactorySuite location: ..\Program
Files\Wonderware\ActiveFactory.
Running any one of the ActiveFactory Client applications for the first time will start the Server List
Configuration tool when you first connect to a server. This tool needs to run only once per server.
The Server Setup installs essential server-side components as well as a promotional (45 day)
license if there is no license already installed.
Section Objective
Become familiar with ActiveFactory Software system requirements, installation
Wonderware Training
When ActiveFactory is installed, it searches the system to determine whether the Historian has
been installed. Occasionally, you might be prompted by ActiveFactory to name the default server.
If so, enter InSQL9, or the appropriate version number.
Licensing
Active Factory 9.2 supports two kinds of licenses, unserved and served.
Unserved licenses, also known as local licenses, are installed on the same computer as the
applications using them. Unserved licenses do not run on a license server. Unserved license files
usually have the file names wwsuite.lic or ArchestrA.lic.
Served licenses are only installed on computers with an installed ArchestrA license server.
License servers can reside on local or remote computers. Served licenses files usually have the
file name ArchestrAserver.lic.
There are three types of served license:
Named device licenses, also known as host-based licenses, which are associated with
specific computers.
Named user licenses, also known as user-based licenses, which are associated with
specific users.
Concurrent licenses, which can be used with any devices or users.
Information about the license type appears in the license name and license components
when you view it in the ArchestrA License Manager.
When ActiveFactory 9.2 starts, it looks for an unserved license on the same computer in the
background. If no license is found locally, the application searches all license servers specified in
ArchestrA License Manager for the computer.
When a license file is found, the application checks that this version is licensed for use. If more
than one license is found, the order in which licenses are acquired by applications is:
Unserved licenses
Named device licenses
Named user licenses
Concurrent licenses
If ActiveFactory is not supported by the license or if the required license is not found, the software
component defaults to either a demonstration mode or an absent license mode.
License Files
The license server can be accessed by client applications for license information. When the
license server starts, it loads the served license files. Client computers running licensed
applications can access the served licenses on the license server using the license server search
paths entered in ArchestrA License Manager.
License servers have the advantage of establishing a single location for maintaining Wonderware
licenses rather than installing multiple local licenses across your network.
You can switch from one license type to another just by installing a different type of license without
having to install a different version of the application.
Using Named Device and Named User Licenses
Device and user information for both types of licenses is stored in the license server options file,
Wonderware.opt. For detailed information on this file, click Start and point to All Programs /
Wonderware / ArchestrA License Server / Macrovision FLEXnet Licensing End User Guide.
You can change the devices or users associated with a named device or named user license by
repeating the named user setup procedure and entering new user names.
When you specify host names in the options file, you can use the NETBIOS names of the
computers or the static IP addresses.
The ArchestrA licensing infrastructure overrides the NETBIOS name of the computer running the
licensed application with the NETBIOS name of the computer used as a terminal session client.
For example, if a user logs into computer Host1 and starts a remote desktop session to computer
Host2, a licensed application started in the remote session is shown being run by Host1 rather
than Host 2. However, if you use static IP addresses instead of NETBIOS names in the options
file, the IP address always identifies the actual computer where the licensed application is running.
Please view the free ArchestrA License Manager online seminar at http://wonderware.com/
training for more information.
Wonderware Training
Section 2 ActiveFactory Trend
This section introduces the ActiveFactory Software system requirements, installation
ActiveFactory Trend is an application that enables a graphical view of the historical data for
selected tags. ActiveFactory Trend also enables viewing of multiple Historians (and multiple
versions of the Historian) at the same time.
Once tags have been added to a trend graph, the tag data can be manipulated in a variety of
ways, including panning, zooming, and scaling. ActiveFactory Trend can be customized by
configuring display options and setting general options for use with all trends displayed on a
particular workstation (known as a Workspace).
The Trend graphs and their associated data information can be printed so that the data can be
analyzed away from the client machine.
Trend is typically the most frequently used Client Application.
Before this client application can be used to query tag information from the database, the server
must be running and you must have security access.
Section Objective
Become familiar with ActiveFactory Software system requirements, installation
Wonderware Training
Start ActiveFactory Trend
Note: Running any of the ActiveFactory applications for the first time will start the Server List
Configuration utility in order to connect to a server. The Wizard needs to run only once per
server.
a. From the Start button on the Windows Taskbar, select All Programs / Wonderware /
ActiveFactory / Trend.
The main Trend Application window appears:
Connect to the Server
a. Select Tools / Servers from the Trend menu:
The Server List Configuration dialog box appears:
The Server List Configuration dialog enables configuration of connection properties to
multiple Historians.
The following information is used to configure a connection to a Historian:
Server name
User Login ID
Password associated with the Login ID
An option to use the Integrated Security
Time-out parameters for connections and queries
An option to remember the password between instances of the application
An option to use HTTP as the Server Connection Protocol
Note: Application startup delays may occur if a connection to a stopped or disabled Historian is
configured and active.
Wonderware Training
b. Enter the Servers network node name in the Server field.
c. Enter the LoginID and Password.
d. Click Add.
The node name appears in the server list pane.
e. Click Close.
Trend is now connected to the designated Historian node.
Note: Highlighting the server name in the Server list pane enables the LogOn and Remove
buttons. If the highlighted server connection is active, the LogOn button changes to LogOff and
enables disconnecting from that server.
Change Login information by highlighting the target Server in the Server list, make the change(s),
click Update, then LogOn.
Click Remove to eliminate the server from the Server list.
Wonderware Training
Tag Picker Control
The Tag Picker control is common to all ActiveFactory applications.
The Tag Picker Control assists a user when searching for tagnames to be used in their application
(this may be Trend, Query, Workbook or Report).
The Tag Pickers functionality duplicates Windows Explorer by displaying a hierarchical tree-view
of the Historian group.
Depending upon the application and user preferences it may consist of a Server Pane, a Tags
Pane, and a Filter pane.
Servers Pane
The primary area within the Tag Picker Control is called Servers. This pane lists all of the
Historians that are currently connected. Each Servers folder contains the sub-folders associated
with the individual Historian Group.
Tag Folders
a. Right-click a tag folder to expose its sub-menu:
The sub-menu enables creation of new groups and showing/hiding elements of the TagPicker
control. New groups in the public groups area can only be created by wwadmin permissions
and above.
Wonderware Training
Tags Pane
The Tag Information Pane lists all of the tags from the selected folder in the Tree Pane along with
any filter conditions specified in the Filter Pane. Tagname, description, and IO address are
exposed using the scroll bar.
The pane contains tabs that filter tags in a Group by tag type. For example, in a Private Group
containing Analog, Discrete, String and Event Tags, selecting the Analog tab displays only the
Analog tags contained in that folder.
Trending tags is performed by dragging tags from this pane directly to the trend and tag list panes.
Tags may also be dragged to other tag group folders.
Tag Filter pane
Filter tags using the criteria listed in the pane.
Using the filter conditions in the Filter Pane, you can search the selected folder for tags that match
a particular search pattern for a tagname, description, or address.
There is an important interaction between these panes. When the Servers Pane and the Filter
Pane are both visible, the filter conditions apply to the selected part of the name space. In other
words the filters are additive. When the server is selected the filter applies to all tags.
Tag Name: Enter the tagname search parameters for the query. The percentage character
(%) is used as a wildcard character when Exact match is checked.
Description: Enter a string for the tag description search parameters for the query. The
percentage character (%) is used as a wildcard character when Exact match is checked.
I/O Address: Enter the address search parameters for the query. The percentage
character (%) is used as a wildcard character when Exact match is checked.
Exact Match: Click the Exact Match checkbox to limit tags returned to the exact
character positions searched for. For example, searching for Rea will return all tags that
contain the letters Rea, no matter where within the tagname the letters appear. A search
of Rea% with the Exact Match checkbox enabled will return only tags beginning with Rea.
Apply: Click the Apply button to execute the query. Tags matching the query parameters
are listed in the Tagname Pane.
Clear: Click the Clear button to clear the filter criteria chosen. The filter conditions are
removed.
Wildcard Character Examples (only apply when Exact match is enabled)
% Any string of zero or more characters
_ Any single character
[ ] Any single character within the specified range
InSQL searches for all strings that contain the letters InSQL (SysPerfInSQLIOSCPU)
InSQL%, Exact match searches for all strings that begin with the letters InSQL
(InSQL_ProdLevel).
%X, Exact match searches for all strings that end with the letter X (HenonX, VectorX).
_ _ _ _1, Exact match searches for all five-letter tags ending with the number 1 (I2311,
R2511).
[R-S]_ _ _ 1, Exact match searches for all names ending with the number 1 that begin
with any single letter from R to S (R2511, Step1).
Wonderware Training
Create a Trend
Create a Trend by dragging and dropping tags directly onto the Trend pane.
The Toolbars become active. The information on the following pages describes the available
configuration options.
Time Picker
The time picker allows you to select a time range by specifying a start time, end time, and/or
duration. An error appears next to the start or end time controls if you specify an invalid time
period. For example, an end time before a start time.
To specify a time period
a. On the Time toolbar, specify the start time, end time, and/or duration. To select a date from a
calendar, click the down arrow on the start time or end time list. To select a predefined
duration, click the down arrow on the duration list.
When you change one of the options, one of the other options is recalculated automatically.
While you change the option, a blue frame appears around the option that will be recalculated
as a result of the change.
The relation between changed and updated options is as follows:
If you change multiple options in a row, which option is updated depends on which two other
options you changed last. For example, if you change the start time and then the end time, the
duration is calculated accordingly. If you change the start time and then the duration, the end
time is calculated, and so on.
b. Press ENTER.
To specify a time period relative to the current time
a. Do one of the following:
On the Chart menu, click Update to Current Time so that a check mark appears.
Click the Update to Current Time toolbar button so that it is highlighted.
b. In the duration list of the Time toolbar, click a duration or enter one manually.
The start time is automatically calculated as the current time minus the duration you selected,
and the trend display is updated with the new time period.
The Time picker allows you to specify the time range of data that will be displayed on the
Trend. Select a duration from the drop-down menu (1 minute, 5 minutes, etc.) or enter the
Start Time. The End Time will automatically update based on the time selected in the duration
field. Updating the Duration field will update the Start Time field based on the duration field,
and updating the End Time field will automatically update the Start time field based on the
duration field.
You change... The time picker updates...
Start time End time (based on duration)
End time Start time (based on duration)
Duration Start time (based on end time
Tag List
a. Right-click the main tag details pane.
Properties configuration is enabled by the following sub-menu:
b. Highlight a tag and select Configure.
c. Individual Pen properties (including time offset) are set in the tag configuration dialog box.
Wonderware Training
Configure Trend Options for a Tag: Display Options
General tab
The Time Offset option in the tag Configure dialog box can be used to offset tag traces in a Trend
a specified length of time.
When a value is entered in the Time Offset field, the column takes a positive or negative offset in
the format: HH:MM:SS.
Any tags with time offsets are displayed using that offset, and the X-Axis cursors are adjusted
accordingly. The time span for the data retrieved to populate the trend graph is also adjusted
according to any offsets entered. So, for instance, if a 1 hour trend is displayed, and one of the
tags is given a 30 minute offset, then Trend retrieves 1:30 of data.
For example, 2 Historians are storing identical batch data, but are timesynched to a different time
master. The batch times should be identical, but since the two Historian Servers are synched to
different masters, the times always appear slightly different.
Trending the two batches and offsetting the time of one of the batch tags would be a way to directly
compare both sets of batch data.
Additionally, a single tag may be placed in the same Trend multiple times to allow for different
configuration of the displayed data.
Note: When offset values are changed, the trend graph is updated immediately, however no
query is made to Historian until the trend is refreshed either via the User Interface, or by calling the
Refresh method in the case of aaHistClientTrend.
Target Region tab
A target region can be defined to provide a visual indicator that tag values are outside of the
specified region. Two or more points must be defined to utilize this feature.
To add region items manually:
a. Click Add. A new item appears in the list. Add the time, and low and high tag values to define
each point for the target region. The points will be connected to define the Target Region.
To load region items from a CSV file:
a. Click Load file. A standard Open dialog box appears.
b. Select the desired file and click Open. The list is populated with the entries from the CSV file.
The CSV file must be formatted as follows:
Each row must contain a region item composed of three values: the time offset, the low value, and
the high value. The format of the time offset is the same as for time offsets in relative time mode.
For more information, see the Online Help topic: Time Offset Formats.
The Trend application tries to determine the CSV delimiter and the decimal and time separators
automatically. If one of the values contains a delimiter or separator character, that value must be
enclosed in double quotation marks.
Wonderware Training
Retrieval tab
To have the tag use the same retrieval settings as specified in the trend options, click Style
selected at option level in the Retrieval style list. This is the default setting when you add a tag to
a trend.
To use a predefined retrieval style, click its name in the Retrieval style list.
To use custom retrieval settings, click Custom style in the Retrieval style list, and specify any
additional settings required.
If you are using custom retrieval settings, select a retrieval mode and specify all the settings that
are relevant to it. For more information, see the Online Help topic: Understanding Retrieval Modes.
If you are using one of the predefined styles, you can edit all settings that are not covered by the
style definition. For information on which settings are covered by style definitions, see the Online
Help topic: Working with Retrieval Styles. Because a style definition can contain multiple sets of
retrieval settings with different retrieval modes, some of the settings available for editing here may
turn out to be irrelevant for the retrieval mode that actually gets used for a given query. However,
because there is no way to know in advance which retrieval mode will be used, the settings are still
available for editing.
Live Mode
a. Click the Enable or disable live or replay mode button to view the tags in live mode.
Live data is data that is being retrieved continuously in real time.
Add an Annotation
An annotation can be added to any tags trend display and is associated with the selected tags
value where the mouse button is clicked.
a. Right-click near a tag on the Trend.
b. From the sub-menu, select Add Annotation.
c. Enter an annotation in the Text: field of the Annotation dialog box and click OK.
An annotation can be Private (visible only to you) or Public (visible to all ActiveFactory users).
d. Click OK to add the annotation to the trend field.
The annotation appears on the trend graph as a blue dot.
e. Pass the cursor over the blue dot to view the annotation text:
f. Select View/Annotation List from the Trend menubar:
The annotations can be saved, deleted, and/or printed. The time, text, and visibility can
also be edited by clicking Annotations / Edit.
Annotations do not appear in the Annotation List unless they are included within the Trend
Graphs current time span.
Zooming
a. To zoom in or out or the trend graph, use the Zoom In or Zoom Out buttons in the
Scaling toolbar.
Wonderware Training
Scale the Tags
Scaling a tag up reduces the current scale range of the vertical axis (Y-axis) by half.
For example, a trend tag has a minimum Y-axis value of 0 and a maximum Y-axis value of 10, for a
total range of 10.
When the tag is scaled up, the range for the trend tag becomes 5, where 0 is the minimum Y-axis
value and 5 is the new maximum Y-axis value.
Scaling can be set for a single tag, or for all of the tags in a trend by using the appropriate Scaling
Toolbar button.
Scale a Single Tag
b. Select the tag to be scaled in the Tag List.
c. Select the Scale Type you wish to apply to the tag.
The Scale Tag buttons for individual tags are (in order):
Scale the current tag to its original scale
Auto scale the current tag
Scale the current tag up
Scale the current tag down
Scale All Tags
a. Select the Scale Type you wish to apply to the tag.
The Scale Tag buttons for all tags are (in order):
Scale all tags to their original scale
Auto scale all tags
Scale all tags up
Scale all tags down
Automatic Scaling When automatic scaling is applied on a selected tag or all tags in a trend
graph, the scale will be based on the tag having the smallest minimum Y-axis value and the tag
with the largest maximum Y-axis value. The Y-axis scale for a particular tag is always displayed
along the Y-axis. That is, when scrolling through tags, the Y-axis always displays the scale of the
selected tag.
a. Click the Auto scale all tags button.
Rubber Band Scaling
Rubber band scaling enables selection of an area of the trend graph using the mouse cursor and
automatically sets the scaling based on the area that you selected. Rubber band scaling can be
enabled for a single tag, or for all tags .
Cursor
Red and blue cursors display at either end of the trend. Moving either cursor will cause the value
for the tag where the cursor and the tag curve meet to display.
a. Ensure View / Time Axis Cursors is checked.
b. Click a tagname in the Tag List.
c. Move a cursor (red line on left or blue line on right) to see the tag value change.
Wonderware Training
Trend Options
Several options can be configured for a Trend by clicking on Tools / Options menu within Trend:
Retrieval tab: set the retrieval options for the Trend
Retrieval style: automatically switches retrieval modes for trend tags based on the trend
duration and/or tag type
Main options tab within the Retrieval tab:
Query row limit: set the number of rows to retrieve in the query results
Cyclic attributes: Set the Interpolation type to Stairstep, Linear, or to the default Tag
setting
Delta retrieval deadbands: Set the time and Value % for delta retrieval deadbands
Other tab within the Retrieval tab:
History Version: The Historian supports versioning on the data in its extension tables. It
supports 2 versions for each data point:
Latest: The Latest value is the most recent update made to that data point.
Original: The Original value is the first value entered for a given data point (typically
the value acquired from an I/O Server).
Rules: Set the Time stamp and Quality rules for retrieval
State retrieval: Set the state parameter for retrieval
Note: These settings do not apply when Trend is in Live Mode. In Live Mode, Trend always
uses Delta retrieval.
Wonderware Training
Colors tab:
Allows selection of default tag trace colors, and also allows you to enable or disable usage of
colors.
Time Zones tab:
Allows selection of the time zone on the computer running Trend, as well as the time zone of the
Historian Trend is connected to.
Miscellaneous tab:
Always on top: The Trend application is always displayed in front of other applications that
are active on the Trend node.
Display all tag timestamps in all data logs: Displays all tag timestamps in all data logs.
Display actual numeric values: Displays the values of discrete tags in the discrete data log
in numerical format (0 or 1).
Display associated messages: Displays the messages associated with the values of
discrete tags in the discrete data log. For example, ON or OFF.
Decimal Places: Indicate how many decimal places should be displayed.
Format: Format of the tag values (decimal/scientific).
Open documents on start up: By default when you start Trend it automatically reopens the
Trend files that were open when it was last closed. Clear the checkbox to disable this
behavior.
Wonderware Training
Other tab:
In the Source area, specify the Historian tables from which data will be retrieved.
Manual history tables: Normal SQL Server tables that are used to store data. These are the
ManualAnalogHistory and ManualDiscreteHistory tables.
Extension tables: Logical tables that are populated from the Historian data files. These tables
support the Historian time domain extensions for handling data.
Both: Select this option to retrieve data from both the manual and extension
Legacy retrieval
In the Legacy retrieval area, specify the retrieval mode for data that is retrieved from a Historian
with a version earlier than 9.0.
Use Delta retrieval for less than specified intervals: Enables retrieval of only data that has
changed (delta retrieval mode). By checking this box, Trend will retrieve Analog and Discrete Tags
in Delta retrieval mode for periods less than entered. For periods greater, Cyclic retrieval is used.
Interval for Analogs: The time period, in minutes, for which delta values are retrieved for analog
tags. For greater time periods, cyclic retrieval is used instead. Valid values are 0 to 10,000. The
default is 15.
Interval for Discretes: The time period, in minutes, for which delta values are retrieved for analog
tags. For greater time periods, cyclic retrieval is used instead. Valid values are 0 to 10,000. The
default is 15.
Maximum values to retrieve per tag: Limits the number of tags retrieved in Delta mode for a
given period. The maximum number of values to return per tag. Valid values are 0 to 30,000. The
default is 10,000.
Trend Properties
Several Trend properties are available to configure:
General: Live mode settings, and printing
Colors: Background color, plot area color, borders, grids, and highlighting
Axes: X and Y axes colors, number of values, width and style
Limits: tag limit configuration
Annotations: Set retrieval and display of annotations
XY Scatter Plot: Labeling and trace gradient configurations, full or delta retrieval
Target Regions: Colors for target region configuration
View Data From the Data Log
You can view data in a wide or narrow table by using the View / Data Log menu items.
Each view enables you to save or print the data file in its respective formats. Note that the
Rows Displayed value is different for each log format. The number of rows in the Narrow
versus Wide data log views will most likely be different
The Narrow log shows data in the following format: Time, TagName, Server, Value, Quality.
There is one row for each value returned by each tag
Each row shows the timestamp and value for one tag
The Wide log shows data in the following format: Time, TagName(1), TagName(2),
TagName(3)... and so on
There is one row for each timestamp in the combined result sets of all the tags
Each row shows the values for all the tags at that time
Wonderware Training
Configure Public Namespace Groups and Trend Sets
Private and Public Groups
Changes made to the Public Groups are visible to all ActiveFactory clients from any workstation.
Changes to the Private Groups are visible only to the user who made them.
Many installations do not modify the Historian default users and groups. In this case changes
made to Private Groups as wwUser will be visible to any other user who logs in as wwUser. For
example, if you configure a user named "Ted" and add him to the wwUsers group, his groups will
only be visible to him.
By default, any user can edit their Private Groups, but only users with specific privileges can edit
the Public Groups.
The TagPicker retains the servers that were last connected to for each application. They are
shown in the Tree Pane. To prevent a server from reappearing in the tree, it must be manually
disconnected.
Note that the System Status Tags folder is displayed automatically.
Trend Sets
Trend sets can be created to group similar reports for ease of printing and distribution.
Create the individual Trends, save them, then click File / New Trend Set to add the desired
trends and name the Trend Set.
Lab 4 Use ActiveFactory Trend Basic
Functions
Introduction
Trend is an ActiveFactory client application that enables tag querying, plotting, and graphic display
from multiple Historians. Once tags have been added to a trend, the data can be manipulated in a
variety of ways, including panning, zooming, and scaling.
Trend graphs and their associated data can be printed so that the data can be analyzed away from
the client machine. Trends can be customized by configuring display options and setting general
options for all trend displays.
This lab focuses on using the interface toolbar buttons.
Objective
Create a New Trend
Manipulate the Trend
Print the Trend
View Live Mode
Wonderware Training
1. Select All Programs / Wonderware / ActiveFactory / Trend from the Start button on the
taskbar.
If no connection to a Historian is present, the Server List Configuration window will display:
2. Configure a connection to the Historian as follows, substituting the Server name, Login ID,
and Password supplied by your instructor, and click Add.
3. Click Close.
Create a New Trend
4. Select the Analog tab at the bottom of the Tags pane. The analog tags appear within the Tags
Pane.
5. Holding down the Ctrl key on your keyboard, select the following tags:
LIT_001.PV
InletValve_001.PV
TransferPump_001.TempAvg

6. Drag the selected Tags and drop them on the Trend pane.
The selected tags appear as a new trend:
Congratulations, you have just created a basic trend!
Wonderware Training
7. Click the Auto scale all tags button in the Scaling toolbar to load the tag properties into
the trend and rescale the graph.
Note an important aspect of the ActiveFactory Trend functionality: The Minimum and
Maximum setpoints for each tag display on the left side of the trend.
Manipulate the Trend
Change the Time Range
Verify that the current time mode is enabled by clicking the button. This ensures that the time
span selected is relative to the current time.
8. Select a time span from the drop-down list.
The trend data pane changes to display the time span selected.
Notice a blue halo displays around the Start Time field, indicating the field is automatically updated
based on the time span selection.
Assign Exact Start and End Times
9. Click the drop-down button in the Start Date / Time field to display its Calendar drop-down
object.
10. Select a specific day to begin the trend range.
11. Change the time value if you wish.
12. Repeat the above steps to assign a specific End Date / Time.
13. Click the Refresh button to refresh the trend.
Notice a blue halo displays around the Duration field, indicating the field is automatically
updated based on the time span selection. Also notice that because you selected specific start
and end times, the current time mode is now disabled.
View Single Tags
14. Click the Enable or disable single tag mode button on the Main Toolbar.
15. To view the values for one of the other trended tags, click the tag name in the list pane.
16. Click the Enable or disable single tag mode button again to disable the single tag mode.
Wonderware Training
Stack the Traces
For clarity the previously configured Trend Properties are not displayed in the following examples.
17. Click the Stack the tag traces button in the Main Toolbar.
All traces appear as separate rows:
18. Restore the trend traces by clicking the Stack the tag traces button again.
Change the Pen Style
19. Right-click a tag in the Tag List pane.
20. Click Configure.
21. From the Type drop-down list, select Point, Line, or StepLine.
22. Click OK.
Notice the change in the Trend when a different line type is selected.
Wonderware Training
Change the Trace Color
23. Right-click a tag in the Tag List below the Trend pane.
24. Click Configure.
25. Click the Color box.
The Color window opens:
26. Select a color, or click Define Custom Colors to create a unique color.
27. Click OK.
View Data From the Data Log
28. From the Trend menubar, select View / Data Log / Narrow, or click the View the data log in
narrow format button .
29. Close the Data log window.
30. Select View / Data Log / Wide for the Wide format view of the data, or click the View the data
log in wide format button .
31. Close the Data log window.
View Trend Statistics
32. From the Main Toolbar, click the Statistics button.
The Trend Statistics are displayed. The statistics can be saved and/or printed.
33. Use the scroll bar at the bottom of the Statistics data pane to view all of the columns.
34. Close the window.
Wonderware Training
Add an Annotation
In the following figures, an annotation is added to the LIT_001.PV tag. The trend for this tag
displays a vertical spike approximately every 1.18 minutes.
35. Locate the level spike by using Trends Pan buttons .
36. From the tag list below the trend pane, highlight the LIT_001.PV tag.
37. Right-click at the peak of the level spike.
Ensure the LIT_001.PV tag is currently selected in the Tag List or the annotation will be
placed incorrectly on the Trend graph pane.
38. From the sub-menu, select Add Annotation.
39. Enter your annotation in the Text: field of the Annotation dialog box.
For this example, keep the annotation Private (default).
40. Click OK to add the annotation to the trend field.
The annotation appears on the trend graph as a blue dot.
41. Pass your cursor over the blue dot to view the annotation text:
42. Repeat the previous steps to add annotations to the InletValve_001.PV and
TransferPump_001.TempAvg tags.
43. Select View / Annotation List from the Trend menubar or click the View the annotation
list button .
The annotations you created will be used in a subsequent lab.
44. Close the Annotations window.
Wonderware Training
Rubber Band Scaling
The Rubber Band scaling buttons are (in left to right order):
Enable rubber band scaling
Apply rubber band to all tags
Rubber band scaling can be enabled for a single tag, or for all tags.
45. Click the Enable rubber band scaling button .
The cursor changes to a +.
46. While holding down the left mouse button, drag it across a trend field to create a rectangular
area.
In this figure, the LIT_001.PV tag is selected.
47. Release the mouse button.
The trend graph is refreshed using the new scaling values of the tag you selected:
Zooming in on data using the Rubber band scaling can be done as many times as is practical to
view granular data.
48. To return to the original scaling, click Undo button on the main Trend toolbar.
Click the Undo button as many times as necessary to return the original Trend chart view.
Note: Undo can be performed using the Ctrl+Z keys or from the main menu by selecting Edit
/ Undo.
View Live / Replay Mode
49. Click the Enable or disable live or replay mode button .
50. The chart will automatically update (refresh) at the specified interval.
Change the update interval
51. Click Chart / Properties from the main menu.
52. Change the Refresh interval to 5 seconds.
53. Click OK.
54. Click the Enable or Disable Live or Replay mode button again to return the Trend to History
mode.
55. Click File / Save As.
56. Save the Trend as Mixer1.aaTrend in the C:\Wonderware Training\Labs folder.
Wonderware Training
Create a XY Scatterplot
57. Click File / New.
58. In the Trend main menu, choose Chart / Chart Type / XY Scatter Plot.
59. Add the LIT_001.PV and TT_001.PV tags.
No data points display because the axes have not been configured.
60. Right-Click the TT_001.PV tag and choose Configure.
61. Select the LIT_001.PV tag in the X axis tag field.
62. Click OK.
63. Click the Auto scale all tags button .
64. Choose one minute for the duration.
The XY Scatterplot Trend should look similar to the following:
65. Click the live mode button.
You should see two data points moving to reflect the last minute of data.
66. Save the current trend as Lab4XYScatterplot.aatrend in the C:\Wonderware Training\Labs
folder.
67. Close all of the trends, leaving Trend open.
Lab 5 Configure Public Groups and Trend
Sets
Introduction
Tags can be organized into logical groups allowing users to quickly identify those areas relevant to
their job. This lab will show you how to create groups visible to all users, and groups visible only to
select individuals.
Objective
Create Public Tag Groups
Create a Trend Set
Wonderware Training
Create Public Tag Groups
Use ActiveFactory Trends TagPicker window to create new groups for members of the
Maintenance staff, the Quality Assurance staff, and an area within the Mixer facility.
Note: Public Groups can only be created by users with wwPower security privileges or higher.
Any user with any security level can create a Private name space; however, the folder will be
visible only to that user.
Note: You should be logged in as wwPower. If not, select Tools / Servers from the main Trend
menu and select the target server.
Change the login username and password to wwPower, click Update, click Close, and then
expand the target server icon.
1. Within the Tag Picker pane, expand your Historian server.
2. Right-click on the Public Groups folder.
3. From the Public Groups sub-menu, select New Group.
4. Name the new folder Mixer.
5. Press the Enter key to save the folder name.
6. Navigate to the TransferPump_001.PV tag: Public Groups / WWGalaxy / Plant /
Production / Line1 / Mixer_XX0 / TransferPump_001, where the XX in Mixer_XX0 is your
student number.
7. Drag the TransferPump_001.PV tag into the new Mixer group to add it to the group.
8. Click the All Analog Tags folder to select it.
9. Show the Filter pane (right-click in the Servers or Tags pane and click Filter pane).
10. Use the tagname filter to select the remaining two tags:
LIT_001.PV
TT_001.PV
Wonderware Training
11. Highlight the correct tag name(s) and drag them into the new Mixer group.
The selected tags are added to the new Group:
12. Select the Mixer folder and drag it on top of the graph, and release the mouse button to place
the tags in the graph.
13. If necessary, configure the Trend Duration (time span) for 5 Minutes.
14. Save the new Trend as Mixer.aaTrend in the C:\Wonderware Training\Labs folder.
Wonderware Training
15. From the main Trend menu, select File / New.
16. Create groups using the following table. Be sure to select the Historian in the Tag Picker to see
all tag data types.
17. Select File / New, and add each Group to a new trend.
18. Click the Auto scale all tags button after each group is added to its new trend.
19. Save each trend with its respective name in the C:\Wonderware Training\Labs folder.
Group Tagname Description
QA TransferPump_001.PV Pump
TT_001.PV Temperature Meter
InletValve_001.PV.IsActive1 Inlet Valve open
InletValve_001.PV.IsPassive Inlet Valve
SysTimeSec System Time: Seconds
Line1 LIT_001.PV Level Meter
TT_001.PV Temperature Meter
InletValve_001.PV Inlet Valve
SysTimeSec System Time: Seconds
IS SysString System Hourly String
SysPerfCPU0 % CPU load on processor
SysDataAcqOverallItemsPerSec Items per second received from SysDrv
SysStatusEvent Status Tag Snapshot Event
SysTimeMin System Time: Minutes
20. For the IS Trend, configure the duration to 2 hours and stack the traces to create a better view
of the event and string tags. Note the string and event tag symbols:
21. Select the All Filter tab to view the tags in the new Group folders.
The following figure shows all tags in the IS Group, including String and Event tags:
SysTimeMin (Analog)
SysDataAcqOverallIte
msPerSec (Analog)
SysStatusEvent (Event)
SysString (String)
SysPerfCPU0 (Analog)
Wonderware Training
Create a Trend Set
A trend set is a saved grouping of trend files. You can specify a common trend duration (for
example, the last 24 hours) to apply to all of the files in the set. This allows you to easily print
information for the same duration from multiple trend files at the same time. This is useful for
reports such as shift or daily reports.
22. From Trends main menu, select File / New Trend Set.
The Trend set configuration dialog box appears.
23. Select File / Add.
24. Browse to the .aaTrend files previously created for this lab.
25. Highlight each Trend you created by holding Ctrl and clicking each file.
26. Click Open.
The files appear in the Trend set configuration dialog box.
27. Select Last 5 minutes from the Duration drop-down list.
28. Select File / Save.
Wonderware Training
29. Name the new trend set and click Save, saving it in the C:\Wonderware Training\Labs
folder.
The trends are now configured to show the last 5 minutes of data when printed or distributed.
Note: Clicking on File / Print would send the trend set to the default printer. Each trend will be
sent as a separate print job.
30. Click File / Exit to exit the Trend set configuration window.
Modify the Trend display
It is easy to adjust the display and layout of multiple trends.
31. Open two of the previously created trend files.
32. Select Window / Tile Horizontally from the main menu. The trend windows will resize
automatically to fit within the main window.
33. Select View / Tagpicker.
The Tagpicker pane disappears on both trends.
34. Widen each trend to the width of the entire Trend program window.
35. Right-click on each trend and select Properties.
36. Select the Colors tab and configure a different background display color for each trend. Click
OK when finished.
Your Trend application should now look similar to the following figure (minor changes have been
made to each trend):
37. Close the open Trends, leaving ActiveFactory Trend open. Do not save your changes.
Wonderware Training
Lab 6 Configure Time Offsets and Target
Regions
Introduction
This lab demonstrates the use of the Time Offsets option and the Target Region option in the tag
Properties dialog box.
Objective
Start a New Trend
Configure a Time Offset
Trend one tag several times and configure Time Offset
Configure a Target Region for a tag
Wonderware Training
Configure Time Offset
Note: Use of this feature with large offset values will have a detrimental effect on performance
and query times.
1. Open a new Trend (File / New).
2. Click View / Tag Picker if the Tag Picker is not already displayed.
3. Add the SysTimeSec analog tags from two different Historians.
Your instructor will supply the node names. Use the Tools / Servers menu command to
configure a connection to a different Historian.
Both tags will display identical traces:
The tagname pane should appear similar to the following figure:
4. Right-click the remote instance of the SysTimeSec tags and select Configure.
5. Change the Time Offset field to 10 seconds:
6. Click OK.
The traces appear with the configured offset:
7. Use the time value cursors to verify the offset (View / Time Axis Cursors).
Remove the remote SysTimeSec tag
Remove the instance of the remote SysTimeSec tag from the Trend, leaving the local
SysTimeSec tag in the Trend.
Wonderware Training
Trend a tag multiple times
8. Add SysTimeSec from your local Historian three more times.
9. Offset the second, third, and fourth instance of SysTimeSec by 10 seconds more than the one
before it. For example, the second SysTimeSec will be offset 10 seconds, the third 20
seconds, and the fourth 30 seconds.
The Trend should now look similar to the following:
This trend allow you to compare the behavior of the same signal in different moments in time.
In this example, the behavior of the same tag is shown 10, 20, and 30 seconds ago.
10. Close the Trend, saving it if you wish.
Analyze signals using relative time
11. Open a new Trend.
12. Add the LIT_001.PV tag to the trend two times.
13. Verify the current time mode button is disabled.
14. Click View / Relative Time.
15. Right-click on the first LIT_001.PV tag and select Configure.
16. Change the Start time: field to a time in the recent past. For example, today at 1:00 pm.
17. Click OK.
18. Configure the second instance of the tag with a start time that is 10 minutes later than the first
tag. In this example, 1:10 pm.
19. Click OK.
This will analyze the behavior of the level meter 10 minutes apart.
20. Click the enable or disable live or replay mode button to enable it.
21. Click the drop-down menu to the right of the enable or disable live or replay mode button
and select 2x. Notice how the replay speed is affected.
22. Continue to alter the replay speed to see the effect on the Trend refresh rate.
Wonderware Training
Define a Target Region
24. Add the SysDataAcqOverallItemsPerSec tag to the Trend.
25. Change the time span to ten minutes.
26. Click the Auto scale all tags button.
27. Click View / Relative Time.
Notice that the Trend axes now show relative time rather than absolute time. The time
displayed is relative to the Start Time displayed in the Tag List under the Trend.
28. Right-click the tag and select Configure.
29. Select the Target Region tab.
30. Click Load File...
31. Navigate to the TargetRegion.csv file in the C:\Wonderware Training folder.
32. Click OK.
Notice the region is defined by a highlighted band.
33. Right-click the SysDataAcqOverallItemsPerSec tag and select Configure.
34. Click the Target Region tab.
35. You can adjust the Target region manually. Modify the last row of data to be:
Low: 68.5
High: 71.5
Wonderware Training
Lab 7 Advanced Properties: Retrieval Styles
Introduction
This lab demonstrates the use of the Retrieval Styles in Trend and how to properly apply different
Retrieval styles to achieve the desired results.
Objective
Apply the following retrieval styles:
Best Fit
Cyclic
Linear
Moving Average
Custom
Delta
Slope
Wonderware Training
Using Standard Retrieval Styles
2. Add the LIT_001.PV tag to the Trend.
3. Enable the current time mode button.
4. Click Tools / Options.
5. Select BestFit-5 in the Retrieval style field of the Retrieval tab. ActiveFactory Trend will
query the data using the Best Fit retrieval mode, with one cycle every five pixels.
6. Click OK.
The Trend updates:
7. Using the previous steps, change the Retrieval style to BestFit-10.
Notice the difference in the tag trace. Now that the interval for the Best it retrieval mode is 10 pixels
instead of 5, fewer data points are retrieved, and the line is less smooth.
8. Change the Retrieval style to BestFit-15.
The data is queried using the Best Fit retrieval mode, with one cycle every 15 pixels, resulting in a
choppier, even less smooth line.
Override the Retrieval Style at the tag level
9. In Tools / Options, change the Retrieval style to BestFit-10.
10. Add another instance of the LIT_001.PV tag to the current Trend.
11. Right-click the first instance of LIT_001.PV and select Configure.
12. Select the Retrieval tab.
13. Select Cyclic (ActiveFactory 9.1).
14. Click OK.
You can now compare how the tag data looks when retrieved with full resolution (Cyclic) versus
Best Fit. The signals now look very similar, however the amount of data retrieved is substantially
different. The data log will show this difference.
Wonderware Training
15. Uncheck the second instance of LIT_001.PV in the tag list.
16. Click View / Data Log / Narrow.
Data displayed in the Data Log represents the history data retrieved by ActiveFactory Trend
used to plot the trend. Notice how many rows are returned in the Data Log.
17. Close the Data log.
18. Uncheck the first instance of LIT_001.PV and check the second instance of LIT_001.PV.
19. Click View / Data Log / Narrow.
Notice there are fewer rows retrieved than for the first instance of the tag.
20. Check the first instance of LIT_001.PV so that both tag traces display in Trend.
Use Other Retrieval Styles
21. Select Tools / Options.
22. Change the Retrieval style to MovingAverage(12-5 sec). This will show the Moving Average
(using 12 values and a resolution of 5 seconds) for the second instance of LIT_001.PV. The
first instance still has a Retrieval style of Cyclic (ActiveFactory 9.1) configured at the tag level,
so its tag trace does not change.
24. Change the Retrieval style to MovingAverage(30-1 sec).
Now, Trend displays a Moving Average calculation using more values and a higher resolution.
Notice how the second tag trace is affected.
26. Change the Retrieval style to Custom style.
27. Change the Retrieval mode in the Retrieval tab to Cyclic.
28. Select Use Manual Cycles.
29. Enter 10 in the Values over equal time intervals field.
30. Click OK.
Trend is displaying data retrieved as 10 evenly spaced intervals across the selected time span.
Notice how the tag traces in the Trend are affected.
Wonderware Training
32. Leave the Retrieval style as Custom style.
33. Change the Retrieval mode in the Main options tab of the Retrieval tab to Delta.
34. In the Delta retrieval deadbands pane, enter 10 in the Value % field.
35. Click OK.
Trend is displaying data retrieved delta with a 10% value deadband. Notice how the tag traces in
the Trend are affected.
37. Leave the Retrieval style as Custom style.
38. Change the Retrieval mode in the Main options tab of the Retrieval tab to Slope.
39. Click OK.
40. Click the Auto scale all tags button.
41. Change the Retrieval style back to BestFit-5.
Module 5
ActiveFactory Workbook
Section 1 Introduction 5-3
Lab 8 Using ActiveFactory Workbook Basic Functions 5-21
Lab 9 Use Other ActiveFactory Workbook Functions 5-31
Lab 10 Use the Tag Analysis Wizard 5-37
Lab 11 Create an Hourly-Average Shift Report 5-41
5-2 Module 5 ActiveFactory Workbook
Wonderware Training
Module Objectives
Explain Workbook GUI elements and functionality
Successfully use the Workbook application to create a variety of reports using the Excel
spreadsheet format
This section explains the ActiveFactory Workbook uses and operation.
Introduction
ActiveFactory Workbook is an add-in to Microsoft Excel that displays Historian data in Excel
spreadsheet format in order to perform data analysis and to develop standard reports. The reports
that you create with ActiveFactory Workbook can be saved, allowing you to run a report again at
any time.
Workbook is used to embed your SQL statements directly into the Microsoft Excel worksheets to
facilitate the repeated retrieval of data from the Historian.
When the add-in is loaded, the ActiveFactory menu and toolbar appear. Use these menu
commands and toolbar buttons to create Workbook functions. When the functions are executed,
SQL queries are sent to the server, and the requested data is then returned to the worksheet.
Start ActiveFactory Workbook
a. Click Start / All Programs / Wonderware / ActiveFactory / Workbook.
The ActiveFactory toolbar displays automatically in Office 2003, and is also available from the
ActiveFactory menubar. To access the ActiveFactory toolbar in Office 2007 click the Add-Ins tab in
the Ribbon.
b. Click ActiveFactory / Connection Management to establish a connection to a Historian.
c. Use the toolbar buttons to create your report.
The toolbar buttons are described in detail next.
Section Objective
Understand ActiveFactory Workbook uses and operation.
Tag Search: Search for tag(s) to place on the Sheet.
Live Values: Show live (current) values for a tag.
History Values: Return historical values for a tag or tag range.
Aggregate Values: Retrieve historical values and calculate aggregation for selected tags.
Direct Query: Insert a query.
Convert Function: Convert formula array to values. The formula will no longer update.
Convert Sheet: Convert entire worksheet to values. The values will no longer update.
Edit Function: Edit the function in the current cell using the wizard.
Refresh Function: Execute the function associated with the selected cells.
Refresh Sheet: Refresh the entire worksheet.
Wonderware Training
Tag Search
Use the Tag Search button to search the Historian for the tags you want in your report, and place
them on the Sheet. Once you have located the tags you are looking for, this function can insert the
Tagnames into the highlighted cell in the spreadsheet. By using the Tag Search function, you
reduce the possibility of error comparing to entering the tagname manually.
a. Click the Tag Search button.
The Tag Selection window displays.
b. Use the Filter criteria to search for the tags you wish to display in your report.
c. Holding the Control key, select each tag you wish to display in your report.
d. Click the underscore button to the right of the Select cell range to insert tags field.
e. Select the first cell where you want the tag label(s) to show. The tag names will cascade down
the cells in the column.
Note: It is best to start the tag label list on or after row 2 because row 1 will be used for column
headers later.
f. Click the button to close the cell range selector.
g. Click OK to place the selected tags in the report.
Live Values
The Live Values button launches a function that brings the latest value of selected tags from the
Historian and inserts them into the selected cells. Note that because Excel does not automatically
refresh the data in the sheet, once the values are inserted, the function will not execute again until
the sheet is refreshed.
a. Click the Live Values button.
b. Select the desired Server in the Step 1 of 3 dialog box.
c. Select the Support multiple data types check box to allow for the selection of dissimilar data
types for the same query. That is, a mix of analog, discrete, string, and/or event tags.
d. Click the underscore button to the right of the Select cell range to insert tags field.
e. Select the cell(s) containing the tag names for your report, and click the button to close the
cell range selector.
f. If you want to use a named tag range variable instead, click Binding Options and then
configure the range. See the Help topic: Using Binding Options for more information.
g. Click Next.
h. In the Step 2 of 3 dialog box, specify the location of the worksheet cell(s) that will contain the
output.
i. Select the Enter the results as an array-formula check box to insert the results as an array
formula. An array formula can perform one or more calculations and then return either a single
result or multiple results. An array formula allows for the resending of the query, since the
query parameters are included in the cells that contain the query results.
j. Select the Select cells to specify format options check box to specify a range of cells that
contain formatting information. Click Next.
k. In the Live Values - Step 3 of 3 window, select the values you wish to display in your report.
Tag name: The unique name of the tag within the IndustrialSQL Server system.
Date time: The timestamp for the returned value. For delta retrieval, this is typically
the time at which the value was acquired by the IndustrialSQL Server. For cyclic
retrieval, this is the specific time requested or calculated (using a SQL function).
Include milliseconds: Used to include milliseconds in the timestamp.
Quality: The basic data quality indicator associated with the data value.
Replace poor quality values: The text string of "poor" will replace the current value if
the value has a quality <>0 or 133.
Detect date time: Only applicable to event tags. The timestamp reflecting when the
event was detected by the event system.
OPC Quality: The quality value received from the data source. Only available if you
selected the Support multiple data types check box in the Step 1 of 3 dialog box.
l. Click Finish.
Wonderware Training
The report displays:
History Values
The History Values button launches a function that brings the historical values of selected tags
from the Historian and inserts them into the selected cells. The method of retrieval can be
configured through the interface of the function. Note that because Excel does not automatically
refresh the data in the sheet, once the values are inserted, the function will not execute again until
the sheet is refreshed.
You can retrieve history data for specified analog, discrete, string, and/or event tags. However, you
cant retrieve data for event tags and other types of tags in the same query. To retrieve data for
event tags, create a separate query that only includes event tags.
a. Use the Tag Search button to enter one or more tagnames in the sheet.
b. Click the History Values button.
c. In the Servers list, click the name of the server to use in the Step 1 of 4 dialog box.
d. In the Select cell(s) containing tag name(s) list, specify the location of the worksheet cell(s)
that contains the tag name(s).
e. If you want to use a named tag range variable instead, click Binding Options and then
configure the range.
f. Click Next. The Step 2 of 4 dialog box appears.
g. In the Select cell for output list, specify the location of the worksheet cell(s) that will contain the
output.
h. Select the Enter the results as an array-formula check box to insert the results as an array
i. Select the Select cells to specify format options check box to specify a range of cells that
contain formatting information.Click Next.
j. Click Next. The History Values - Step 3 of 4 dialog box appears.
k. Configure the criteria for the query:
Display Options Tab
Select the information to be displayed for each tag.
Format Tab
Value based criteria (narrow tables)
There is one row for each value returned by each tag
Each row shows the timestamp and value for one tag
Tag based criteria (wide tables)
There is one row for each timestamp in the combined result sets of all the tags
Each row shows the values for all the tags at that time
Wonderware Training
Retrieval Tab, Main options sub-tab
Retrieval mode: Select the desired retrieval mode. Retrieval modes are discussed in
detail in Module 3, Storage Independent Retrieval Mode, page 3-13.
Query row limit: set the number of rows to retrieve in the query results
Cyclic attributes: Set the Interpolation type to Stairstep, Linear, or to the default Tag
setting
Delta retrieval deadbands: Set the time and Value % for delta retrieval deadbands
Retrieval Tab, Other sub-tab
History Version: The Historian supports versioning on the data in its extension tables. It
supports 2 versions for each data point:
Latest: The Latest value is the most recent update made to that data point.
Original: The Original value is the first value entered for a given data point (typically
the value acquired from an I/O Server).
Rules: Set the Time stamp and Quality rules for retrieval
State retrieval: Set the state calculation to Min, Max, Average, Total or Percent. This
option becomes enabled if Retrieval mode is set to ValueState.
Order Tab: Define the order for the results by selecting items on the left and clicking the >
arrow to move them to the list on the right.
Wonderware Training
Criteria Tab
Limit the results based upon selection criteria in the Criteria tab.
To configure criteria for a discrete tag select the first Value check box and set the
criteria to be either a 1 or a 0.
To configure criteria for an analog tag select the first Value check box and set the
criteria for the data value. For example, the value must be greater than ( >) 1500.
(Optional) Select the second Value check box and set another criteria for the data
value. For example, the value must be less than ( <) 2000.
(Optional) Select the Value not null check box to filter out NULL values from the
results.
(Optional) In the Quality list, click the quality criteria for the data. Only data values that
match the quality you specify (Good, Bad, Doubtful) are returned.
l. Click Next.
The History Values - Step 4 of 4 dialog box appears.
m. Configure the time for the report.
n. Click Finish.
The report displays.
Wonderware Training
Aggregate Values
You can view aggregated values for specified tags. Aggregations supported are count, minimum,
maximum, sum, average, and standard deviation. Aggregations are calculated using the standard
SQL Server aggregation functions.
a. Click the Aggregate Values button.
Format Tab
b. Select the desired format.
Narrow query format: In this format, there is one row for a single tag's value for a
particular timestamp.
Wide query format: In this format, there is one row for one or more tag values for a single
timestamp, thus providing a "wide" view of the data. To use the wide query format, you
must specify the timestamp and one or more tagnames as the column names in the query
syntax. The results will contain a column for the timestamp and columns for the value of
each specified tag at that timestamp.
Time Tab
c. In the Time area, use the time picker to select the start and end times for the query.
d. To return the data with a timestamp that reflects the time zone setting of the Historian, select
the Use time zone of the server check box.
e. To return the data with a timestamp that reflects a time zone setting, different than that of the
local client computer, click the name of the appropriate time zone to use in the Time Zone list.
Criteria Tab
f. To configure criteria for a discrete tag select the first Value check box and set the criteria to be
either a 1 or a 0.
g. To configure criteria for an analog tag select the first Value check box and set the criteria for
the data value. For example, the value must be greater than ( >) 1500.
h. (Optional) Select the second Value check box and set another criteria for the data value. For
example, the value must be less than ( <) 2000.
i. (Optional) Select the Value not null check box to filter out NULL values from the results.
j. (Optional) In the Quality list, click the quality criteria for the data. Only data values that match
the quality you specify (Good, Bad, Doubtful) are returned.
k. (Optional) In the Criteria applicability list, select the moment at which the edge detection
criteria is met.
None: true: Returns all rows that successfully meet the criteria; no edge detection is
Leading: first true: Returns only rows that are the first to successfully meet the criteria
(return true) after a row did not successfully meet the criteria (returned false). This is also
known as leading edge detection.
Trailing: no longer true: Returns only rows that are the first to fail the criteria (return
false) after a row successfully met the criteria (returned true). This is also known as
trailing edge detection.
Both: first true or no longer true: All rows satisfying both the leading and trailing
conditions are returned.
Calculations Tab
Use the Calculations tab to configure the aggregations to perform on the values for the selected
tag(s).
l. Display calculated values for each tag separately: If selected, one row of calculated values
is returned for each tag. If this check box is not selected, then all values for all specified tags
are included for a single aggregation.
m. Count: The total number of values for the tag.
n. Minimum: The minimum value for the tag.
o. Maximum: The maximum value for the tag.
p. Average: The average value for the tag.
q. Sum: The sum of all values for the tag.
r. Standard deviation: The statistical standard deviation of all values for the tag.
s. Decimal places: The number of decimal places to display for the data value. This applies only
to analog tags.
Retrieval Tab
Use the Retrieval tab to specify the granularity of the data to be returned.
t. In the Mode area, select the retrieval mode.
Cyclic: Cyclic based retrieval is the retrieval of stored data for the given time period based
on a specified cyclic retrieval resolution, regardless of whether or not the value of the
tag(s) has changed.
Delta: Delta retrieval, or retrieval based on exception, is the retrieval of only the changed
tag values for a tag(s) for the given time interval. That is, duplicate values are not returned.
If you selected the cyclic retrieval mode, configure additional options in the Cyclic area.
XX values over equal time intervals: The number of rows to be returned for a specified
time period. For cyclic retrieval, the rows are spaced evenly across the time period, and
the default row count is 100 rows. For cyclic retrieval, the row count is applied for each tag
in a query.
Values spaced every XX ms: The sampling rate, in milliseconds, for retrieving the data in
cyclic mode. The system will return values stored over the requested time period at the
interval specified by the resolution. For example, if you specify a 5000 ms resolution, the
system will query for all data during the time period and then only return those values that
occur at each 5000 ms interval, starting with the start date and ending with the end date.
Wonderware Training
If you selected the delta retrieval mode, configure additional options in the Delta area.
Limit to: The total number of consecutive rows to be returned, starting from the first row in
the record set.
Time deadband: The minimum time, in milliseconds, between returned values for a single
tag. Applies only to delta retrieval.
Value deadband: The percentage of full scale (range), in engineering units. Any value
changes that are less than this percentage will not be returned. Applies only to delta
retrieval. The default is 0.
Source Tab
Use the Source tab to specify the data version and type of table for the query.
u. In the Source area, specify the Historian tables from which data will be retrieved.
Manual history tables: Normal SQL Server tables that are used to store data. These are
the ManualAnalogHistory and ManualDiscreteHistory tables.
Extension tables: Logical tables that are populated from the IndustrialSQL Server data
files. These tables support the IndustrialSQL Server time domain extensions for handling
data.
Both: Select this option to retrieve data from both the manual and extension tables.
v. In the Version area, specify what version of data should be retrieved.
Original value: The original value as it was received from the data source (for example,
the I/O Server) to the IndustrialSQL Server.
Latest value: The latest value that is stored in the IndustrialSQL Server with the same
timestamp as the original value. Multiple versions are created as the result of data inserts
and updates.
Direct Query
You can use the Query client to build a query, which is inserted into the Query window. The Query
tool is discussed in greater detail in Module 6, ActiveFactory Query.
a. Click the Query button to start the Query client tool.
b. In the Servers list, click the name of the server to use.
c. In the Query window, type the SQL query to execute against the database.
d. Select the Enter the results as an array-formula check box to insert the results as an array
e. Select the Specify format options (select cells) check box to specify a range of cells that
contain formatting information. The formatting information in the cells will be applied to the
query results. For more information, see Selecting Cells.
f. In the Select cell for output list, specify the location of the worksheet cell(s) that will contain
the output. Click on the button to select the cell(s) using your mouse. For more information,
see Selecting Cells.
g. Click OK.
To edit the query, click in the cell that contains the red triangle.
Convert Function
Convert Function changes selected cells that contain functions to the results of the functions.
This converts an executable cell to a static value. Refreshing the function or the sheet after using
the Convert Function will not update the value of the cell.
a. Select the function to convert. If you want to convert an array formula, select any cell in the
array.
b. Click the Convert Function toolbar button.
Convert Sheet
Convert Sheet changes all the functions on the active sheet to the results of the functions. This
converts an executable worksheet to a static worksheet. Refreshing the function or the sheet after
using the Convert Sheet function will not update the value of the cell.
a. Select the sheet to convert.
b. Click the Convert Sheet to Values toolbar button.
Edit Function
The Edit Function button allows you to edit the function in the highlighted cell. If the function in
the cell was entered using one of the wizards (for example, History Values), then the dialog box for
that function will appear and allow you to modify the options that were entered.
a. Select the function to edit. If you want to edit an array formula, select any cell in the array.
b. Click the Edit Function toolbar button.
c. If applicable, the appropriate wizard opens, allowing you to edit the query.
Refresh Function
The Refresh Function button executes the function associated with the selected cells. You can
refresh any function or array formula in the worksheet.
a. Select the function to refresh. If you want to refresh an array formula, select any cell in the
array.
b. Click the Refresh Function toolbar button.
c. The function is executed and the results are returned.
Refresh Sheet
The Refresh Sheet button refreshes the active worksheet, and re-executes all the functions on
the worksheet.
a. Select any cell in the sheet.
b. Click the Refresh Sheet toolbar button.
c. The query is executed and the worksheet is updated with the returned results.
Wonderware Training
Tag Analysis
In addition to creating valuable reports, you can use ActiveFactory Workbook to generate
statistics, charts, and graphics that are useful for analyses. Wizards are provided to guide you
through selecting the required options.
a. Click ActiveFactory / Tag Analysis. The Tag Analysis Step 1 of 5 dialog box appears.
b. Select the tag analysis you want to run:
Analog Tag analysis: Analog Tag analysis (graph, statistics, etc.)
Batch analysis: Graph - analog tag over two time periods
Scatter analysis: Scatter plot - two analog tags
Discrete tag analysis: Discrete Tag analysis (graph, statistics, etc.)
Analog values at discrete transition analysis: Graph - analog tag values at discrete tag
transitions
Analog/Discrete: Graph - analog vs. discrete tags
Note: Selection of the Analog Tag analysis or the Batch analysis will result in a total of five
dialog boxes. Selection of any of the remaining analysis types will result in a total of four dialog
boxes. The following figures display the dialog boxes presented with the Analog tag analysis.
Differences in the dialog boxes are noted.
c. Click Next.
The Tag Analysis - Step 2 of 5 dialog box appears. The dialog box options will differ depending
upon what type of Analysis you selected.
d. In the Servers list, click the name of the Server to use.
e. In the tag field(s), specify the name of the tag(s) to analyze. Click the ellipsis button to open
the Tag Picker and browse for the tag.
f. Click Next.
The Tag Analysis - Step 3 of 5 dialog box appears.
g. In the Starting time, enter the starting time for the query. Click the down arrow to select a date
from a calendar. The Batch Analysis and Scatter Analysis will also include a second starting
time for a second time period to perform a an analysis over two time periods.
h. In the Duration lists, specify the duration and the duration unit. For example, 10 minutes.
The duration is used to calculate the end date for the query.
i. Click Next.
Wonderware Training
The Tag Analysis - Step 4 of 5 dialog box appears.
j. Configure the resolution for the data to be returned.
Number of rows: The number of rows to be returned for a specified time period using
cyclic retrieval. The rows are spaced evenly across the time period, and the default row
count is 50 rows. The row count is applied for each tag in a query.
Values spaced every: The sampling rate, in milliseconds, for retrieving the data in cyclic
mode. The system will return values stored over the requested time period at the interval
specified by the resolution. For example, if you specify a 5000 ms resolution, the system
will query for all data during the time period and then only return those values that occur at
each 5000 ms interval, starting with the start date and ending with the end date.
Number of rows: A second Number of rows field will display if the Analog-Discrete pair
analysis is selected.
k. Click Next. The Tag Analysis - Step 5 of 5 dialog box appears for the Analog Tag Analysis
and the Discrete tag Analysis only. If any of the remaining four analyses were selected, click
Finish.
l. Click Finish.
Information that you specified using the wizard are assigned to cells in the worksheet. The
following values will be returned based upon the type of Analysis you chose.
m. Click in the workbook to view the functions that are inserted to create the analysis report.
Analog Tag
analysis
Batch
Analysis
Scatter
Analysis
Discrete tag
Analysis
Analog values
at discrete
transition
Analysis
Analog/
Discrete
Server Server Server Server Server Server
Tag Tag Tag 1 Tag Discrete Tag Discrete Tag
Row or
Resolution
Start Time 1
Chart Legend
Tag 2 Row or
Resolution
Analog Tag Analog Tag
Start Time Row or
Resolution
Row or
Resolution
Start Time Row or
Resolution
Row or
Resolution
Duration Start Time Start Time 1 Duration Start Time Start Time
Low Limit Duration Duration Duration Duration
High Limit Start Time 2
Chart Legend
Start Time 2 Row or
resolution to
use for the
discrete tag
Start Time 2
Wonderware Training
Lab 8 Using ActiveFactory Workbook Basic
Functions
Introduction
The following lab will demonstrate the basic functionality of ActiveFactory Workbook.
Objective
Insert a Live Value Function
Insert a History Value Function
Report Historian process data within the Excel spreadsheet environment
Wonderware Training
Create a new ActiveFactory Workbook
1. From the Start button on the Windows Taskbar, select All Programs / Microsoft Office /
Microsoft Office Excel.
2. Enter a report heading in cell A1. For this lab, Meters is the heading.
3. Change the font face and size to Arial 14 Bold.
4. Enter =NOW() in cell A2. This cell will display the current date and time.
5. Press the Enter key.
6. Right-click cell A2 and select Format Cells from the submenu.
7. On the number tab, configure the format options as shown in the next figure.
8. Click OK.
The report should now look like the following figure:
Insert a Live Value Function
9. Select cell A4.
10. Select ActiveFactory / Tag Selection / Tag Selection from the main menu.
The Tag Selection dialog box appears:
Wonderware Training
11. Select the Historian icon.
12. In the Tag name: field of the Filter pane, enter %.PV.
13. Click the Exact match checkbox.
The Apply button becomes enabled.
14. Click Apply. All tags ending with .PV are displayed.
15. Pressing the Control key, select LIT_001.PV and TT_001.PV tags.
16. Ensure that the Select cell range to insert tags: field reads $A$4.
17. Click OK.
The tags appear from cells A4 through A5:
18. Select cell B3.
19. Select the Live Values button on the Workbook toolbar.
Note: Binding Options (accessed using the Binding Options >> command button) are
explained in a subsequent lab. Do not click the Binding Options>>button.
20. Insert your cursor into the Select cell(s) containing tag name(s): field in the Live Values
Step 1 of 3 dialog box.
21. Click on cell A4.
22. Press the left mouse button and drag the cursor over the remaining tagname cells.
23. Click Next.
24. Ensure the output location is cell B3 (using the previous steps).
25. Click Next.
Wonderware Training
26. Leave the default settings in the Live Values - Step 3 of 3 dialog box.
27. Click Finish.
The data is displayed in the spreadsheet:
Note: To view the function that was created, click in any cell containing results (this does not
include the headings). The function appears in the formula bar.
{=wwAnalogLive(" WWSYSPLATFORM2" ,Sheet1!$A$4:$A$6,TRUE,TRUE,FALSE,TRUE,
FALSE)}
28. Click the Refresh Sheet button in the Workbook toolbar to see the tag values change within
the cell fields. .
29. Save the report in C:\Wonderware Training\Labs as MyReport.xls.
Insert a History Value Function
30. Select the Sheet 2 tab.
31. Click the History Values button in the Workbook toolbar.
Step 1 of the History Values function wizard appears. The Tag reference field should
reference the two tags used in the previous task (if not, use the previous steps to reference
LIT_001.PV and TT_001.PV).
32. Click Next.
33. Ensure the output cell is A1 on Sheet 2 in the History Values - Step 2 of 4 dialog box, using the
previous steps, and click Next.
Wonderware Training
34. Click the More>> button to see all of the display options.
35. Select the wwRetrievalMode, wwCycleCount, and wwTimeZone options.
36. Click the Format tab.
37. In the Format tab, select the Tag based Criteria (wide tables) option.
38. Click the Retrieval tab.
39. Change the Retrieval mode to BestFit.
40. In the Cyclic attributes pane of the Retrieval / Main options tab change the Values over equal
time intervals to 100.
41. Click the Order tab.
42. Order by DateTime by selecting the DateTime field and clicking the > button.
43. Click Next.
44. Accept the (default) last 10 minutes. This defines the relative time period of the query
function.
45. Click Finish.
Wonderware Training
The query returns evenly spaced values for the specified time period.
46. Close MyReport.xls, leaving Excel running. Do not re-save the report; the version of the
report you saved earlier will be used in a subsequent lab.
Lab 9 Use Other ActiveFactory Workbook
Functions
Introduction
The following lab will demonstrate the functionality of the ActiveFactory Workbook Aggregate,
Named Ranges and Query Functions.
Objective
Insert an Aggregate Value Function
Configure Named Ranges
Report Historian process data within the Excel spreadsheet environment
Wonderware Training
Insert an Aggregate Value Function
Aggregate values are calculated from Historical values of selected Analog or Discrete Tags.
In this section, we will return the average value of the SysTimeSec tag for the past 5 minutes. This
is useful because it is a known value that can easily be verified.
1. Press the Ctrl+N keys. This creates a new document.
2. Enter SysTimeSec in cell A1.
3. Enter the words Start Time and End Time in cells A3 and A4, respectively.
4. Insert a start time value in cell B3. An example of the format for the time value is 1/12/2007
12:00.
Your instructor will assist you with definition of a time range.
Be sure to press the Enter key after inputting the date value.
5. Place an End time value (5 minutes after the previous time value) in cell B4.
6. Press the Enter key.
The worksheet should now appear similar to the following figure:
7. Click the Aggregate Values button within the
ActiveFactory toolbar . Notice the Aggregate Values
icon in the ActiveFactory toolbar is identical to the AutoSum icon in the Excel toolbar. Be sure
to select the correct icon.
8. Select cell A1 to define the SysTimeSec tag.
9. Click Next.
Ensure the output cell is Sheet1!$A$7.
10. Click Next.
Wonderware Training
11. Select the Calculations tab in the Aggregate Values Step 3 of 4 dialog box.
12. Select Average Calculation Type.
13. Click Next.
14. Select the Absolute Time option.
15. Click the first radio button after Absolute Time (upper field).
16. Insert your cursor into the left-hand Absolute Time (start) field.
17. Select cell B3 in the Excel worksheet. The cell animates and its address should appear in the
field.
18. Repeat the above steps to insert the End Time value into the second field. The end time is
contained in cell B4.
19. Click Finish.
The aggregate value appears in the worksheet:
20. Alter the times in cells B3 and B4. The tag Average should change accordingly.
Configure Named Ranges
Excel includes a useful feature called Named Range. You can assign a name to a group of cells,
and then refer to the name rather than the cell addresses. In this task we will reference a named
range containing several tagnames.
21. Highlight cell A1 on Sheet 2 of the Workbook.
22. Select ActiveFactory / Tag Selection / Tag Selection from the main menu.
Notice that the filter information is still applied.
23. Select the following tags using the Ctrl key:
LIT_001.PV
TT_001.PV
InletValve_001.PV
24. Click OK.
Wonderware Training
25. Select the first cell of the series (A1).
26. Press the Ctrl+Shift+Down Arrow keys. The entire column of tagnames will be selected.
27. Insert your cursor into the Excel name box and enter AnalogTags (no spaces).
28. Press the Enter key to ensure the entire range has been named.
29. Click Sheet 3 of the Workbook.
30. Highlight cell A1 on Sheet 3 of the Workbook.
31. Select ActiveFactory / Tag Values / Live Values from the main menu.
The Live Values - Step 1 of 3 dialog box appears.
32. Enter AnalogTags in the Select cell(s) containing tag name(s): field.
33. Click Next.
34. Ensure the output cell location is correct ($A$1) in the Live Values - Step 2 of 3 dialog box.
35. Click Next.
36. Accept the default display options in the Step 3 of 3 dialog box: Click Finish.
The tag range is inserted into the worksheet.
Note: You can also name cells containing the start and end times, and then reference them by
name in history and aggregate functions.
Lab 10 Use the Tag Analysis Wizard
Introduction
The following lab demonstrates the functionality of ActiveFactory Workbooks Tag Analysis Wizard
in order to display various chart analyses.
Objective
Use the Tag Analysis Wizard to add Process Data charts to an Excel report
Create applied data representations within Excel
Wonderware Training
Use the Tag Analysis Wizard
This task demonstrates configuration of a Scatter Analysis.
1. Click File / New to create a new Workbook.
2. Select ActiveFactory / Tag Analysis from the Excel main menu.
3. Select Scatter Analysis from the list in the Wizard.
4. Click Next.
5. Ensure that the server name displays your Historian within the Select Tags area.
6. Select the LIT_001.PV and TT_001.PV tags using the Ellipsis buttons in the dialog box to
open the Tag Selection control.
7. Click Next.
8. Select the time range you would like to use for the analysis.
For this task, your instructor will guide you in selecting an appropriate time range.
9. Click Next.
From this dialog box you can specify the resolution (number of rows and spacing).
10. For this lab, accept the default settings in the wizard.
11. Click Finish.
At the completion of the wizard steps, a new sheet is created and the input tags are inserted
into column A. This is true for each type of analysis.
12. Change one of the tags in the analysis by changing the text in Cell A2 from LIT_001.PV to
SysTimeSec.
Notice that the data in column B changes as well as the scatter plot. Cell B1 continues to read
LIT_001.PV.
13. Change cell B1 to read SysTimeSec.
14. Create a new Tag Analysis using the Analog tag analysis type. Excel will create a new sheet
automatically. Use the LIT_001.PV tag.
15. Accept all the defaults in steps 3 and 4.
Wonderware Training
16. Change the Limit 1 value to 20 and Limit 2 value to 80 as shown.
17. Click Finish.
The Tag Analysis will appear similar to the following figure:
18. To preserve the results of this tag analysis, use the Convert Sheet button on the Workbook
toolbar.
19. Save the report in the C:\Wonderware Training\Labs folder as TagAnalysis.xls.
Lab 11 Create an Hourly-Average Shift
Report
Introduction
The following lab demonstrates use of formatting, aggregate functions, and time ranges within
Excel.
Objective
Create and Format a New Report based on a specific time range
Create Shift Time Range
Insert Aggregate Value Function
Modify Cell Formulas
Wonderware Training
Create and Format a New Report
1. From Excels main menu, select File / New.
2. Select Blank Workbook.
3. In the upper left-hand area or within cell A1, enter a report name of your choice and select a
large font size for legibility.
This example is titled Hourly Average Data Acquisition IPS.
4. Highlight all the cells in which the name appears.
5. Right-click the cells and select Format Cells from the sub-menu.
6. Select the Alignment tab.
7. Select the Merge cells option.
8. Click OK.
9. Select cell A3.
10. Select the ActiveFactory menu and click Tag Selection / Tag Selection.
11. Locate the SysDataAcqOverallItemsPerSec tag and click OK.
Create Shift Time Range
12. Locate cell A5 and enter a start date and time.
Ensure the server is logging data for the specified time.
In this example, the datetime string 1/15/07 14:00 is the date time value at which the shift
report begins.
13. Select a range that includes 8 rows. The range will end with cell A12 (incl. A5-A12).
14. Right-click the cell range and select Format Cells from the sub-menu.
15. Select the Number tab.
16. Select Date from the Category: pane.
17. Select the 3/14/01 1:30 PM option string from the Type: pane.
18. Click OK.
The date and time now appear in cell A5.
The format will be the same in cells A6-A12.
19. Locate cell A6 and enter the formula =A5+1/24.
20. Press the Enter key. The cells should now appear similar to the following figure:
21. Select cell A6 and position the cursor over the lower right-hand corner of the cell. The cursor
should turn into a + icon, indicating a handle.
Wonderware Training
22. Drag the handle downwards to cell A12. This will increment each of the highlighted cells by
one hour.
The date and time should now appear in each of the cells. Your instructor will indicate what
time span to use.
Note: If cells need to be resized, a series of #s will appear in the cell fields. The cells can be
resized by double-clicking the column border at the top of the worksheet.
Insert Aggregate Value Function
23. Click the Aggregate Values button in the ActiveFactory toolbar.
The Aggregate Values Step 1 of 4 wizard appears.
24. Change the cell containing the Tag Name to Sheet1!$A$3.
25. Click Next.
26. Change the Select cell for output field to Sheet1!$C$5.
27. Click Next.
Note: (C5) is selected because the output will contain 2 cells: (C4) contains the tagname,
(C5) contains the aggregate value for that time (last hour of data).
The Step 3 of 4 dialog box appears.
28. Select the Calculations tab.
29. Change the Calculation Type to Average.
30. Select the Resolution tab.
Wonderware Training
31. Select the Values spaced every option (we want average values).
32. Set the number to 60000 ms. This value sets the data retrieval mode to Cyclic, at 1-minute
intervals.
33. Click Next.
34. Select the Absolute Time option.
35. Click the first radio button (not the checkbox) under Absolute time.
36. Insert your cursor into the top-left field just below the Single value checkbox.
37. In the main worksheet field, select cell A5. This is the cell containing the time at the beginning
of the aggregate time span.
38. Insert your cursor into the right-hand field below the Absolute Time option.
This is the cell that contains the ending time of the average period.
39. In the main worksheet field, select cell A6. This is the cell containing the time at the end of the
aggregate time span.
The dialog box should now look like the following figure:
40. Click Finish.
The average value for the hour appears along side the date/time cell:
Note: The value is calculated against the previous hour, so the first one appears at 9:00, the
second at 10:00, etc.
Modify Cell Formulas
41. Select cell C6.
The wwAggregate function string appears in the formula bar.
42. Modify the following time cell reference:
$A$5 to $A5
$A$6 to $A6
Changing the cell reference creates relative cell referencing and enables the average values
to be cascaded down the column.
43. Press the Enter key to save the changes.
44. Highlight cell C6 and drag it down to row 12.
The cell values are refreshed during the drag-down. This is because the wwAggregate formula
is being dynamically copied into each cell.
You can now change the tagname reference or the date/time from within the worksheet field
and Workbook will calculate the new values.
45. Save the report in the C:\Wonderware Training\Labs folder as ShiftAvg_DataAcq.xls.
It will be used in Lab 26, Publishing Workbook Reports.
Change $A$5 to $A5
Change $A$6 to $A6
Wonderware Training
Module 6
ActiveFactory Query
Lab 12 Use ActiveFactory Query 6-9
Lab 13 Use ActiveFactory Query in Excel 6-23
6-2 Module 6 ActiveFactory Query
Wonderware Training
Module Objectives
Introduce ActiveFactory Query.
Introduce, explain, and use Query to retrieve specific tag information.
This section explains the ActiveFactory Query uses and operations.
Introduction
ActiveFactory Query provides a point and click interface to construct and analyze the execution
of the queries specifically designed for the Historian.
Query provides an efficient and simple method to develop simple and complex queries for
reporting and custom application requirements. It is also an excellent way to learn the proper
syntax for developing queries for the Historian.
Query provides a point-and-click interface to build Structured Query Language (SQL) queries for
your reporting and custom application requirements. The query results are immediately available.
Query dynamically reconstructs and tests queries as the user makes changes. Query has easy
access to Historian data and thus provides easy construction of the SQL queries to perform tag
searches, obtain tag details, server information, and values (current, history, aggregate, summary,
and event snapshots).
This application supports construction of queries for use against the Historian version7.1 and later.
Query also utilizes and understands Historian custom extensions.
You can save queries to run at a later time, and you can also save results.
Query Operation
Numerous distinct query types can be selected from the query tool bar. These include custom
queries, and the Favorite Folder queries.
Each query selection results in a different workspace panel selection. The tag picker is present for
most query types. However, the selection panel for columns changes with the query type.
The Server dialog box contains all the servers that are configured in the Servers list configuration.
Changing the selected server in the server list will cause a corresponding change in the selected
server in the tag picker, and vice-versa.
The Database selection field is only enabled for the Custom query type. For all other queries, the
selected database is fixed to be the Runtime database.
Start Query
From the Start button on the Windows Taskbar, select All Programs / Wonderware /
ActiveFactory / Query. Before this client application can be used to query tag information from
the database, the server must be running and you must have access to the server.
Section Objective
Understand ActiveFactory Query uses and operation.
Wonderware Training
Note: Running any of the ActiveFactory applications for the first time will start the Server Setup
Wizard in order to connect to a server. The Wizard needs to run only once per server. Enter your
sa password to connect to your selected Historian. The Server Setup routine installs essential
server-side components as well as a promotional (45 day) license if there is no license already
installed.
Query Interface
The Query application consists of the following:
The main Toolbar
Query Type panel
The TagPicker
Columns panel (dynamic)
Results panel
Building Queries
The ActiveFactory Query Column Panel displays different tabs dependent upon the type of query
selected. Each tab provides various relevant configuration options to build your query.
The query is displayed in the SQL tab field. The query content is updated when each option is
selected.
The query results are displayed in the Data tab field. The results change dynamically whenever
the query itself is re-defined. To refresh your results use the Refresh button in the main toolbar.
The following table lists the available query types and the tag types available within the TagPicker
pane:
Query Types Description/Available Tags/Column/Tabs
Aggregate
Values
Use this to see aggregated (min, max, sum, average etc.) values of the tags that you
specify.
Tag Filter Options: Analog, Discrete.
Columns/Tabs: Format, Time, Criteria, Calculations, Retrieval, Source.
Alarm History For the query type Alarm History, there are two tag types: Analog and All.
Tag Filter Options:
Columns/Tabs: Columns, Time, Alarm limits, Retrieval, Source, Order
Alarm Limits Live Values:
Tag Filter Options: Analog.
Columns/Tabs: Alarm limits
Annotations Returns any annotations.
Tag Filter Options: Analog, Discrete, String, Event.
Columns/Tabs: Criteria, Time
Custom Construct your own query and view the results.
Tag Filter Options: N/A
Columns/Tabs: None (editor field)
Event history
values
Returns times of specified events (when they occurred).
Tag Filter Options: Event.
Columns/Tabs: Columns, Time, Order
Event
Snapshot
Return the values of snapshot tags associated with events at the time that the events
occur.
Tag Filter Options: Event. Select Analog, Discrete, String tag type.
Columns/Tabs: Tag set, Columns, Time, Order
Favorite Sample files containing advanced queries that leverage more complex SQL.
Select from these queries to learn SQL that does not appear in the standard query
options. Modify the queries and re-save for future use in your environment.
Columns/Tabs: Favorites (Browser/ellipsis button)
History values Returns the history of the tag values over time for specified tags.
Includes format configuration, and all the Historian time domain extensions. Specify a
wide range of criteria under which data is returned.
Tag Filter Options: Analog, Discrete, String, All.
Columns/Tabs: Columns, Time, Format, Criteria, Retrieval, Source, Order
Wonderware Training
IO Server Build queries to return list of tags, including summary tags.
Columns/Tabs: IO Server
Live values Returns the real time value of specified tags.
Tag Filter Options: Analog, Discrete, and String, All.
Columns/Tabs: Columns, Time
Number of
tags
Returns the number of tags by type.
Tag Filter Options: Analog, Discrete, String, Event, All.
Columns/Tabs: Count
Server version Returns current server version of target server selected from the Server drop-down list.
Columns/Tabs: None
Storage Returns statistics for Storage Type, Path, Max and Min size thresholds.
Columns/Tabs: Storage
Storage size
available
Returns available storage space value on Alternate, Buffer, Main, and Permanent
storage locations.
Columns/Tabs: None
Storage start
date
Returns earliest start date from v_HistoryBlock table.
Columns/Tabs: None
Summary
values
Use this to see the values calculated by the summary system of the tags that you specify.
Tag Filter Options: All.
Columns/Tabs: Columns, Time, Calculations, Order
Tag details Obtains the configuration information about the tags that you specify. Configuration
information defines how a tag is acquired, stored and displayed by default.
Tag Filter Options: Analog, Discrete, String, Event.
Columns/Tabs: Columns
Tag search Returns TagName and Description for selected tag type.
Tag Filter Options: Analog, Discrete, String, Event, Summary.
Columns/Tabs: Search
Time running Returns the total time (in minutes) the system has been running.
Columns/Tabs: None
Query Types Description/Available Tags/Column/Tabs
Building Queries
The ActiveFactory Query interface displays different tabs dependent upon the type of query
chosen. Each tab provides various options from which to select in order to build your query.
As each of these options are chosen, the query being constructed can be viewed in the window
when the Query tab is selected. The query will change as each option is selected.
The query results are viewed in the Data tab. The results change dynamically whenever the query
itself is re-defined. To refresh your results use the Refresh button in the main toolbar.
You can also keep a record of all the queries constructed. Choose the Options / Show All
Queries selection from the main menu, and a third tab named All Queries appears. Once this
option is enabled, all queries constructed can be viewed in the window of this tab.
Configuration Options
You can refresh the query results by clicking the Data tab, then clicking the Refresh query button
on the main toolbar.
ActiveFactory Query includes an option that records all of the queries. To assist in creating a
report, any query can be saved and referred to at a later time.
Click Options / All Queries from the ActiveFactory main menu. The All Queries tab field will
display all subsequent queries and make them available to be copied/pasted into other
applications, or saved to a Queries folder. If you click the All Queries tab, the results may take a
long time to display.
Wonderware Training
Lab 12 Use ActiveFactory Query
Introduction
In this lab, ActiveFactory Query is used to demonstrate the ease of constructing SQL queries to
return Historian process data.
Objective
To complete this lab, the following tasks must be completed successfully:
Start Query
Create SQL Queries and View the Results
Wonderware Training
Start Query
Use ActiveFactory Query to create SQL Queries and View the Results
1. From the Start button on the Windows Taskbar, select All Programs / Wonderware /
ActiveFactory / Query.
Your Historian should use the last or current active Server connection. If not, select Options /
Servers from the main menu and reconfigure a connection to your Historian.
Query 1 Simple Query
2. Click your Historian in the Servers pane of the Tag Picker.
3. Select Custom from the Query type drop-down field.
4. Insert the cursor into the SQL pane.
5. Enter the following query:
SELECT * FROM Tag
6. Click the Data tab.
Query executes the query against the selected server and returns the requested data:
The SQL pane can be used as a dynamic SQL editor, and the finished query can then be
saved for reuse.
Wonderware Training
Query 2 Tag Details
This task creates a SQL query that returns the description, acquisition rate, engineering units and
range, and raw value range for a group of analog tags.
7. Select Tag Details from the Query Type drop-down list.
Selecting a different Query type re-runs the query and displays that query types results with
the previously selected tags and configuration options.
Note: Other Query Types will be used in subsequent queries.
8. Expand the local server folder within the Servers pane in the TagPicker Pane.
9. Expand the Public Groups folder.
10. Select the Mixer group created in a previous lab.
The contents of the Public Group appear in the lower pane.
11. Using the Shift key on your keyboard, highlight all the tags in the Mixer folder (the query will
change dynamically).
Note: The Mixer Group contains only Analog tags. If other tag types exist in a particular group,
you must select another tag type using the tabs in the lower section of the Tags pane.
Wonderware Training
12. Select the options shown in the following figure (the SQL pane will change dynamically when
the options are selected or de-selected):
13. Select the Data Tab:
Use the scrollbar to display other tag properties. The columns in the above figure have been
resized for clarity.
Query 3 History Values
Using the previous steps, you will create a query that returns the description, quality, and
history values where the tag value exceeds the HiHi alarm limit.
14. Select History Values from the Query Type drop-down list.
15. Select the Analog tab in the Tags pane of the Tag Picker.
16. Select the TT_001.PV tag from the Mixer folder.
17. From within the Columns tab, select the Tag name, Description, Include milliseconds, and
Quality, Quality Detail, and Quality description options.
18. Leave the rest of the options at their default values.
19. Select the Time tab.
Wonderware Training
20. Select 2 hours from the drop-down list.
21. Select the Format Tab.
22. Ensure that the Narrow format option is selected.
23. Select the Criteria tab.
24. Check the Value option.
25. Select the > sign in the operator field.
26. Enter 188.00 in the Value field.
27. Click the Value not null checkbox.
29. Select Delta in the Retrieval mode drop-down list.
30. Enter 100 in the Query row limit field.
31. Select the Order tab.
32. Highlight DateTime and click the > button.
33. Select the Data tab to view the results of the query.
Query 4 Aggregate Values: Average
Return Multiple Aggregate Values from several tags, using cyclic retrieval.
ActiveFactory Query includes an Aggregate Values option that uses standard MS SQL Server
functions to execute the calculations.
34. Click the Criteria tab.
35. Uncheck the Value checkbox to remove the greater than 188.00 criteria.
36. Select Aggregate Values from the Query Type dropdown list.
37. Select the LIT_001.PV tag.
38. Select the Calculations tab.
39. Check the Average calculation checkbox, and uncheck all other options in the Calculations
tab.
41. Click the Values spaced every radio button. Enter 1000 Milliseconds.
42. Select the Data tab to view the results.
43. Select the SQL tab.
Notice that a full set of data is retrieved using cyclic retrieval mode, and then it is passed to MS
SQL Server for the Average calculation.
Instead, we can use the more efficient Time-weighted Average Retrieval Mode.
44. Select History Values from the Query Type list.
46. Change the Retrieval mode to Average.
47. In the Cyclic attributes pane, enter 1 in the Values over equal time intervals field.
48. Click the Data tab to view the query results.
Wonderware Training
49. Click the SQL tab. Notice that the query uses the Average Retrieval mode, retrieving one
single value from the Historian and avoiding the extra work that the MS SQL Server
calculation generated.
Query 5 Custom Query
You can create a custom query and save it for later use by using the editing functionality of Query.
For example, suppose you want to run a query using the Best Fit retrieval mode.
50. Select Custom from the Query Type drop-down list:
51. Enter the following query into the SQL tab:
FROM History
AND Datetime >= Dateadd(mi, -10, Getdate())
52. Execute the query (Select the Data tab).
An example result set is shown next:
53. Re-select the SQL tab.
Note: If the SQL tab is not selected at this time, the query results will be saved instead.
54. Click the Save button in the main toolbar to save changes.
55. Enter BestFit.sql in the File name: field.
56. Click Save.
57. Select Favorites from the Query Type drop-down list.
The new query appears immediately within the Favorite Queries list:
58. Click the BestFit.sql query in the Favorite Queries list.
59. Click the SQL tab to review the query syntax.
Wonderware Training
Query 6 - Annotations
Returns any annotations entered using Trend.
Recall that we added several annotations to the trend data we developed in a previous lab. The
annotations were added to the LIT_001.PV and TT_001.PV tags.
60. Select Annotations from the Query Type field.
61. Select the LIT_001.PV and TT_001.PV tags in the Tag Picker. They can be selected either
from the All Analog Tags tab, or by using the TagName filter as shown in the following figure:
62. Modify the time span to enclose the time of the annotation. For example, for one or more days
previously, enter (dd, -2, GetDate()) in the SQL pane or select the Time tab and choose 2
days in the Time field.
63. Select the Data tab for the Annotation information.
Query 7 Reporting
The procedure presented here is useful for preparation of reports.
The queries prepared in this section will be saved and re-used in SQL Server Management Studio.
Consider the case where we want to create a report for the Mixer.
To get report information, we want to create the following query:
When did the mixer level exceed the Hi Alarm Limit for the LIT_001.PV tag during the Last
Hour?
For this example, you will assume the Hi Alarm Limit is 90.
64. Create a History Values query for the LIT_001.PV tag.
65. Using the tab fields for the History Values query type, assign the following attributes:
66. Select the Data tab (Execute the query).
Tab or Pane Tab Field/Area Set the following Options to:
Query Type History Values
Tag Picker Pane Tag Type Analog
TagName LIT_001.PV
Columns Tagname
Date and Time (default)
Include milliseconds
Time 1 Hour
Format Narrow
Criteria Value > 90
Retrieval Delta: rows are returned only when data
changes.
Limit to first 0 rows
Note: Setting the number of rows to '0' will result in
all stored values being used.
Wonderware Training
67. Click the SQL tab.
68. Save the current Query in your Favorites Folder as MixerHiLevelAlarm.sql.
69. Open Windows Explorer.
70. Browse to: C:\Documents and Settings\[user]\Local Settings\Application
Data\Wonderware\ActiveFactory\Queries.
71. Double-click the MixerHiLevelAlarm.sql file to open it with SQL Server Management Studio.
72. Connect to the Server using a Login and Password of wwUser.
73. Change the database to Runtime.
74. Execute the query.
75. Compare the results in Microsoft SQL Server Management Studio to the results obtained in
ActiveFactory Query. They should be identical.
This enables you to build queries using ActiveFactory Query, and re-use them in any other SQL
Client.
Lab 13 Use ActiveFactory Query in Excel
Introduction
In the previous Module, you learned how to use ActiveFactory Workbook to return Historian tag
values. ActiveFactory Workbook also contains a query building tool called Direct Query which
allows you to embed entire queries in a Microsoft Excel Workbook.
Objective
Create SQL Queries and View the Results in Workbook
Wonderware Training
ActiveFactory Query in Excel
1. Start Microsoft Excel.
2. Select cell A1.
3. Select ActiveFactory / Direct Query from the ActiveFactory pull-down menu.
The Direct Query editor appears:
4. Click the Query Builder button. .
The Query Builder button launches a version of ActiveFactorys Query application.
Using Query, we can build a History Values query for display in Excel format.
5. Select History Values from the Query Type: drop-down list.
6. Select the Analog tab in the Tags pane of the Query builder.
7. Holding the Control key, select the following tags:
LIT_001.PV
TT_001.PV
TransferPump_001.SpeedAvg
TransferPump_001.TempAvg
8. Select 5 Minutes from the Time Tab.
9. Select Wide query format in the Format tab.
This format ensures the tagname will be the column title, which is easier to read for some
types of queries.
Leave all other settings. The Default mode for this query is Cyclic, with a row count of 100.
Wonderware Training
10. Select the Data tab to ensure that a valid result appears in the lower pane:
11. Click OK.
The Direct Query dialog re-appears. It now contains the query we just built:
12. Click OK.
The results appear on the spreadsheet in the selected format.
Note the red triangle in cell A1.
13. Click the cell field with the red triangle to display the query that was just built (The query is
inserted into cell A1, and a wwQuery function has been inserted into cell A3, which references
cell A1).
14. Right-click the tab (Sheet1 in the previous figure), and select Rename.
15. Rename the sheet Direct Query and press the Enter key.
16. Click Save.
17. Name the file QueryBuilder.xls and save it in the C:\Wonderware Training\Labs folder.
Wonderware Training
Module 7
ActiveFactory Report
Lab 14 Using ActiveFactory Report 7-7
Lab 15 Wildcard Time Options and Report Editing 7-15
7-2 Module 7 ActiveFactory Report
Wonderware Training
Module Objectives
Show and explain Report GUI elements/functionality.
Successfully use the Report application to create a Historian data report using the MS
Word document format.
This section introduces the ActiveFactory Report uses and operations.
Introduction
ActiveFactory Report is an add-in to Microsoft Word for Office 2000 and Office 2003 that facilitates
ActiveFactory Report is an add-in to Microsoft Office Word 2000 and above that facilitates
development of standard reports utilizing the Historian. ActiveFactory Report is compatible with
Office 2007.
Report inserts a field code into a Word document, or embeds a SQL query as a field code in the
document. This enables the user to produce an extremely sophisticated report.
When using Report, save a document as a .dot (document template) file. From there, your report
can be used as an e-mail or a web document by re-using the template.
The same query control you used to build and display a query in Excel is used to build a custom
query which is inserted into a Word document.
Add-In Installation
By default the document template add-in is installed during the ActiveFactory installation. You can
also load and unload add-ins via the Add-in Manager in Word.
The ActiveFactory toolbar displays automatically in Office 2003, and is also available from the
ActiveFactory menubar. To access the ActiveFactory toolbar in Office 2007 click the Add-Ins tab in
the Ribbon.
a. The Add-in Manager is accessed via the Tools / Templates and Add-Ins menu command in
Microsoft Word:
Section Objective
Understand ActiveFactory Report uses and operation.
Wonderware Training
b. If the HistClient.dot add-in is not checked, check it and click the Add button.
c. Click OK to exit the dialog box.
Wildcards
When running an ActiveFactory Report, you can use wildcards to simplify reuse of a given report.
Using the #Time(xx:xx) Variable:
#time(xx:xx) variable: The #time variable is used in time functions to represent 'Today'. The date
portion of datetime is the current date. The time portion of datetime is the time specified in the
brackets.
For example:
WHERE datetime >= #time(07:00) - 24h
AND datetime < #time(07:00)
Valid duration units for all variables include:
In this case, the query would be done over the previous 24 hours starting at 7:00am (similar to the
previous lab section). This enables reports to be based on 'Today' for a specified time period.
Note: If part of your job function is to prepare a daily report (like a production report) which covers
the same period each day you can use the #Time wildcard to create a template report that can be
run each day.
s seconds
mi minutes
h hours
d days
w weeks
mm months
Using the #Date(xx:xx) Variable:
#date(xx:xx) variable: The #date variable is used in time functions to represent a specific date.
This function is very similar to the #time function only it allows the date to be specified. The time
portion of datetime is the time specified in brackets.
For example:
WHERE datetime >= #date(07:00) - 2h
AND datetime < #date(07:00)
In this case, the query would be done 2 hours previous to 7:00am on the report date defined. This
allows reports to be based on the same time period.
Using the #ReportTime(xx:xx) Variable
This function is used in conjunction with #Time or #Date. When a report time is set, this wildcard is
replaced by the defined report time. A report time is set via the ActiveFactory / Options
command. This variable defaults to the current time if it is not specified.
For example:
WHERE datetime >= #time(#ReportTime) - 24h
AND datetime < #time(#ReportTime)
or:
WHERE datetime >= #date(#ReportTime) - 24h
AND datetime < #date(#ReportTime)
Note: The #Date and #ReportTime wildcards are ActiveFactory Report wildcards and are not
recognized by the Historian. Queries including these wildcards in ActiveFactory Query or MS
Query Analyzer will not work.
Wonderware Training
Lab 14 Using ActiveFactory Report
Introduction
In this lab you will create a report that embeds SQL statements directly into a Microsoft Word
document. By saving the report as a template you can easily rerun the embedded queries in new
reports.
Objective
Present process data within a Microsoft Word document format
Construct a Live Query in Report
Embed Query Format Options in Report
Create a Template
Create a Report
Specify the Report Date
Wonderware Training
Construct a Live Query in Report
1. Open Report (Start / All Programs / Wonderware / ActiveFactory / Report).
Note: A security warning may appear referring to trusted macros. Click the Always trust Macros
from this source checkbox and click Enable Macros.
Word opens a new document with a new ActiveFactory logo and menu command:
The Options dialog box appears.
3. Select the View tab, and check the Field codes option.
Setting the Field codes option enables viewing of the SQL queries that will be embedded
within the Word document at a later time.
The field codes are visible only on the active document.
4. Click OK to close the Options dialog box.
5. From the main Word menu, select ActiveFactory / Insert Query.
Note: If this is the first time running Report, you may be prompted that an ActiveX Control is about
to be run. Click OK to acknowledge the message.
The Direct Query dialog box appears.
6. Click the Query Form button .
The Query window appears.
7. In the Query type drop-down list, choose Live values.
8. Use the Ctrl key to select the following tags from the tag picker window:
InletValve_001.PV
LIT_001.PV
OutletValve_001.PV
TransferPump_001.PV
TT_001.PV
The completed query should look like the following figure:
Wonderware Training
9. Select the Data tab to verify the query result:
10. Click OK.
Your SQL query now appears in the Query field of the Direct Query dialog box.
11. Click the Format Table button.
The Table AutoFormat dialog box appears. These options enable the user to define the look
of the table.
12. For this lab, select the options displayed in the next figure.
13. Click OK after selecting the format options.
The Direct Query dialog box reappears.
14. Click OK to embed the connection information, query, and format options into the report.
Create a Template
Storing the embedded queries as a Word template rather than a document file creates re-usable
reports. Any new Word file can be created based on the pre-defined query template.
15. Select ActiveFactory / Save Report from the menubar.
16. Enter SampleReport in the File name: field.
17. Select Document Template (*.dot) from the Save as type: dropdown list.
18. Click Save.
19. Close the template file, leaving Microsoft Word running.
Wonderware Training
Create a Report
20. From the main Word menu, select ActiveFactory / Open Report.
21. Select the SampleReport.dot template icon in the General tab.
22. Click OK.
The query text appears.
23. Select ActiveFactory / Run Report from the main Word menu.
24. The report is now embedded in the Word document:
25. Close the file without saving it, leaving MS Word running.
Specify the Report Date
26. From the Word menubar, select ActiveFactory / Open Report.
27. Select the SampleReport.dot template icon in the General tab.
28. Click OK.
29. Place a blank line before the result area.
30. Place your cursor on the first blank line of the report, above the SQL query area.
31. From Words main menu, select ActiveFactory / Insert Report Date.
The field { RPT\Date } is inserted into the report field at the cursors location.
32. Run the report using the previous steps. The current date appears in the location at which the
field was inserted.
33. Close Microsoft Word without saving the file.
Wonderware Training
Lab 15 Wildcard Time Options and Report
Editing
Introduction
This lab demonstrates using Wildcard time options for report running, and editing a report
template.
Objective
Use Wildcard Time Options
Edit Report Queries
Save the Results as HTML
Wonderware Training
Use Wildcard Time Options
Next you will build an aggregate report using date/time wildcards.
You must first set the option that will allow wildcards to be included in the query.
1. Open ActiveFactory Report (Start / All Programs / Wonderware / ActiveFactory / Report.
2. Select ActiveFactory / Options from the main menu.
3. Click the Use date/time wildcards checkbox.

4. Click OK.
Whenever a new query is inserted, the time wildcard options will now appear.
5. On the first line of the new Word document, enter a report name.
For this report, Shift Report: Averages is used.
6. Select ActiveFactory / Insert Query from the Word main menu.
7. The Direct Query window appears. Click the Query Form button.
Query Builder appears.
8. Construct a query that returns averages for the LIT_001.PV, TransferPump_001.TempAvg
and TT_001.PV tags over the past 8 hours.
Build the report in the Wide Table format:
9. Select the Data tab to verify the results:
10. Click the OK button twice.
Wonderware Training
The Additional Time Options dialog box appears.
11. Select Yes, insert wildcards for query execution relative to a fixed time.
12. Select Date as specified in Report Options.
13. Select the Time specified in Report Options.
14. Click OK. The query is now embedded into the document.
15. Put a blank line below the report title and place your cursor on it.
16. Click ActiveFactory / Insert Report Date.
17. Type a comma and a space (, ) after the {RPT/Date} field.
18. Click ActiveFactory / Insert Report Time.
The report should now look similar to the following:
19. Save as a template as SampleReport_Wildcards.dot.
20. Close the report template.
21. Select ActiveFactory / Open Report from the main Word menu.
22. Open the SampleReport_Wildcards.dot file.
23. Choose ActiveFactory / Options.
24. Enter yesterdays date in the Report date: field.
25. Enter a report time that represents a moment in time when you know there is data in the
History Blocks. In this example 1:00 p.m. is used.
26. Click OK.
27. Click ActiveFactory / Run Report.
The report displays:
28. Close without saving.
Edit Report Queries
Next you will copy the query and modify it slightly to perform a different aggregation.
29. Select ActiveFactory / Open Report.
30. Highlight Sample Report_Wildcards.dot and click OK.
The query is now embedded into the document.
31. Copy the query to your clipboard.
32. Insert several blank lines beneath the original query.
33. Paste the new query into the document.
34. Insert the cursor into the body of the new query. The query field code will become shaded.
35. Select ActiveFactory / Edit Query.
Wonderware Training
36. Change each instance of AVERAGE to MAXIMUM.
37. Change each instance of AVG to MAX.
38. The editor should now look like the following figure:
39. Click OK.
The report should now look like the following:
40. Save the report template as ShiftReport_Avg_Max.dot and close it.
41. Open and Run the ShiftReport_Avg_Max template. The dates you selected for the last report
will apply to this report unless you change them in ActiveFactory / Options.
The two queries show in the report:
Create a Static Report to Present in a Browser
42. From the main menu, select ActiveFactory / Save Results as HTML.
43. Save the report as ShiftReport_Avg_Max.htm in the C:\Wonderware Training\Labs folder.
44. Select File / Web Page Preview to view the report in an Internet browser.
Wonderware Training
Module 8
Manual Data
Section 1 Manual Data Acquisition Service (MDAS) 8-3
Lab 16 Importing Original Data 8-7
Lab 17 Importing Versioned Data 8-11
8-2 Module 8 Manual Data
Wonderware Training
Module Objectives
Explain and define Old Data
Explain MDAS and how it acquires data
Acquire MDAS data
Section 1 Manual Data Acquisition Service (MDAS)
This section explains the Manual Data Acquisition Service (MDAS) and how it acquires data.
Introduction
MDAS is designed for ArchestrA and Wonderware Application Server to define tags and store
within the Historian. MDAS provides access to data storage, data retrieval and tag configuration
functionality in the Historian.
MDAS is part of the low-level retrieval system that makes it possible to enter old or legacy data
and provide update capabilities. It provides this capability for all users.
The MDAS service provides rich set of functionality, useful not only to internal Historian clients like
the OLE-DB Provider, but also to Historian external clients.
MDAS Overview
MDAS is a thin client-side internal component that provides high-speed remote access to Historian
for storing data in history (real-time data as well as original or modified old data), retrieving data
from history and configuring the tag database.
The primary benefits for MDAS are:
Rich functionality
Performance
Remote-ability
Ease of use
The Historian OLE-DB provider is an internal MDAS client.
Data Categories
The Historian distinguishes between two main categories of data, based on the timestamp of the
data and the time it is presented for historization.
Real-time data: Real-time data is defined as data arriving at the server in time sequential
order, with a time stamp that is within +999 milliseconds/-30 seconds of current server
time.
Old data: The term "old data" is loosely used to describe all non-real time data. Old data
can arrive at the server at any time, in any order and with any time stamp relative to
current server time (The Historian does not support historization of data in the future, i.e.
when the time stamp is ahead of server time). Old data includes real-time data arriving late
from a store/forward cache.
The Historian allows modification of historized data by either inserting one or more new values into
history after the original data for that time period had been historized, or by updating a value or a
time region of values.
All modifications are versioned, and previous versions are preserved in all cases, allowing the user
to view the original data prior to the modifications.
The term "original data" refers to the original set of values historized for a tag.
Section Objective
Explain MDAS and how it acquires data.
Wonderware Training
For example, a real-time stream of data from an I/O Server represents original data and is written
to disk as the original version. Inserts or updates performed on the original stream of data results
in a new version.
Data modification may be performed for any tag category (I/O Server, system or manual). For
manual tags, new data can be presented as either original data (non-versioned) or inserted data
(versioned).
Note: The Historian supports viewing of only the original version or the latest version of data.
Interim versions are preserved in history but are not exposed through the retrieval layer. Future
releases of the Historian may allow full access to all data versions.
MDAS has full store-and-forward support for real-time data.
MDAS supports storing real-time data for delta tags. Modifying data for both cyclic and delta tags is
supported, as well as cyclic and delta retrieval for all types of tags.
Importing History Data
History data can be imported into Historian extension tables in two ways:
Manually formatting it in a .csv file according to a specification and then copying the file
into a special folder on the Historian computer.
Existing InTouch history data can be imported using the InTouch History Importer utility.
.csv File Notes
The .csv file format should be used when small amounts of existing data need modification. The
insert of an entire .csv file results in a single new version of the data. If an inserted data point falls
exactly on an existing timestamp, the existing data value is updated.
For a normal import, the .csv file format and the format of the data contained within the file is very
flexible; however, this flexibility requires the system to perform a large amount of processing on the
data before it can be imported.
Thus, there is an inverse relationship between amount of data to process and import speed. The
time required to process a file is at least exponentially related to the number of values contained in
the file.
Additional considerations for a normal import are:
The total size of the .csv file is limited to less than 4 MB.
The .csv file may contain no more than 100,000 values.
The number of tags represented in the file may not exceed 1000.
Note: Formatting and importing a normal .csv file is demonstrated within the context of Lab 16,
Importing Original Data.
Fast Load .csv
Using the Fast Load .csv import mechanism, original data can be imported very quickly, using
essentially the same .csv file format as a normal import.
The following information applies to a fast load import scenario:
A fast load import is much faster than a normal .csv import. For example, a .csv file that is
4 MB will import approximately 100 times faster. For larger files, the speed improvement
gets substantially better. There are no restrictions on the size of the file to import, or the
number of tags or data values in the file. However, the data that is contained in the .csv file
for a fast load import must be formatted in time-sequential order.
It is this ordering that enables the system to process a fast load .csv file more quickly than a
normal .csv file.
A .csv file formatted for a fast load import is copied into a special \FastLoad import folder.
The fast load import should be used only when it is not feasible to perform a normal .csv import.
Use the following guidelines when considering a fast import:
You need to import very large .csv files.
You want storage rules applied to the data you are importing. A normal .csv import does
not apply storage rules; everything is stored as delta.
Do not use the fast load import if you need to import a large number of small inserts for the
same block. (The fast load import will create a new data stream for each imported fast
load .csv file.)
Do not import fast load data for a tag if there is existing stored data for that tag in the same
time range.
The data points must be sorted in time sequential order for a successful fast load import.
Format Differences
The format for the fast load .csv file is essentially the same as the normal format, with the following
exceptions:
All data in the file is treated as original data.
The OperationType field in the file header is ignored.
The Missing Block Behavior field in the header is used for a different purpose. A value of
10 denotes that tags in the file are specified by name, whereas a value of 11 denotes that
the wwTagKey attribute is used to specify tags.
By default, missing blocks are created as necessary.
The actual data values in the file must be in time sequential order, starting at the top of the
file.
Values that have out-of-sequence timestamps are ignored.
In other words, if a data value in the file has a timestamp that is earlier than the timestamp
in the previous line in the file, the data value is discarded, regardless of whether it belongs
to the same tag or a different tag.
The file should contain only one data value per line.
Wonderware Training
The following information explains the correct .csv format for use with MDAS:

If two multipoint update .csv files for the same tag are simultaneously copied to the
\DataImport directory, the update will span across the total time for the two files. A query
returning latest data will hide (mask) the original version of the data from the end of the first file
to the start of the second file.
For example, if the update in one file ranges from 00:00:00 to 00:05:00, and the other ranges
from 00:10:00 to 00:15:00, the result will be an update starting at 00:00:00 and ending at
00:15:00 ("latest"); the original data from 00:05:00 to 00:10:00 will be masked as "original"
data.
No data is lost. To view either data from a query, use the wwVersion column to specify either
"original" or "latest." By default, the latest data is displayed. To prevent the masking of the original
data, process the .CSV files one at a time.
Line Field Description
Header 1 0 Description of the .CSV file format, either UNICODE or ASCII.
2 0 Character that is used as a delimiter. This can be either a comma ( , ) or a pipe ( | ).
3 0 User name
3 1 Time format: 0 =UTC; 1 =Local.
3 2 Name of the time zone for the timestamps in the .CSV file.
3 If field 1 is set to 0, the value of this field is ignored. However, a value that is at least 1
character long must appear for this field.
3 If field 1 is set to 1, the value of this field should be the literal name of the time zone, as it
is specified in the TimeZone table.
3 To use the local time of the IndustrialSQL Server Historian, specify "Server Local" for this
field.
3 3 Default behavior if a missing history block is encountered: 0 =Do not create replacement
blocks; 1 =Create replacement blocks. If this field is set to 0, and data values in the .CSV
fall within a time period where no blocks are present, then no data will be inserted.
3 4 Time span for the replacement block(s): 0 =Recreate block from first data value to the
present time; 1 =Recreate block for the duration of the .CSV file data.
3 If field 3 is set to 0, then the value of this field is ignored.
3 If this field is set to 0, then history blocks will be recreated from the time of the first value to
the current time.
3 If this field is set to 1, only the history blocks necessary to import all data in file will be rec-
reated.
3 The start and end times for the history block is adjusted based on the current block dura-
tion setting or the start and end times of existing blocks.
Value 4n 0 Tagname
4n 1 Type of operation: 0 =Original value; 1 =Insert; 2 =Update; 3 =Multi-point update.
4n 2 Value start date, formatted as: YYYY/MM/DD
4n 3 Value start time, formatted as: HH:MM:SS.MSEC
4n 4 (This field is used only in the case of an update.) Value end date, formatted as: YYYY/MM/
DD
4n 5 (This field is used only in the case of an update.) Value end time, formatted as:
HH:MM:SS.MSEC
4n 6 Used to indicate whether the value is already in the proper format or whether you want to
scale the value after the import. Values are: 0 =Engineering units; 1 =Raw value.
4n 7 Value
4n 8n QualityDetail. Fields 2 through 8 can be repeated.
Lab 16 Importing Original Data
Introduction
This lab demonstrates how the Historian MDAS Acquisition engine takes data from a .csv file and
"pushes" it (automatically inserts it) into a viewable Historian tag. It is then available for analysis by
Query Analyzer or ActiveFactory Trend.
Participants use the ArchestrA System Management Console, MS Explorer, ActiveFactory Query,
and ActiveFactory Trend applications.
Objective
Use a .csv File to insert data values into a Historian tag as original data
View the Results Using Microsoft SQL Server Management Studio
View the Results Using ActiveFactory Trend
Wonderware Training
Prepare the Import .csv file.
In this section, you will insert original data for the LIT_001.PV tag into a time period where no data
was available.
1. Start Windows Explorer.
2. Browse to the MixerTemp-Original.csv file located in the C:\Wonderware Training folder.
Your instructor will update the file with a date from last week. The objective is to use a date
where there is no data in the LIT_001.PV tag.
3. Right-click the file and select Open With. The following figure shows the menu that appears
when the file has been opened previously (Notepad is in the submenu that appears).
4. If the file has not been opened before, scroll down to Notepad and highlight it.
5. Ensure the Always open using this program option is de-selected.
6. Click OK.
Note: Do not open this file with Excel!
Excel will change the datetime format and make the file unusable.
If the file is opened with Excel, close it without saving it.
This file contains values changing every second for the LIT_001.PV tag. There is no data available
for this tag in the history blocks within the period shown in the file, so this data will be inserted as
original data.
7. Close the file.
8. Copy the file to C:\InSQL\Data\DataImport.
After a moment the file will disappear.
9. Start ActiveFactory Query.
10. Open the VersionedData.sql file in C:\Wonderware Training.
Your instructor will have updated the file with the same dates used in the MixerTemp-
Original.csv file.
In the SQL tab, notice that both versions of data are being queried: original and latest.
Notice that the file uses 0 in
the second column of the data
rows, which means the data will
be inserted as original data.
Wonderware Training
Both versions retrieved the same value for each instance in time.
View the results in ActiveFactory Trend.
12. Start ActiveFactory Trend (keep ActiveFactory Query open).
13. Add the LIT_001.PV tag to the Trend.
14. Select the time range that reflects the date used in the last few steps.
17. Change the Interpolation type to Linear.
The Latest data for the LIT_001.PV tag displays.
18. Leave ActiveFactory Trend and Query open for the next lab.
Lab 17 Importing Versioned Data
Introduction
This lab demonstrates how the Historian MDAS Acquisition engine takes data from a .csv file and
"pushes" it (automatically inserts it) into a viewable Historian tag. It is then available for analysis by
Query Analyzer or ActiveFactory Trend.
Participants use the ArchestrA System Management Console, MS Explorer, ActiveFactory Query,
and ActiveFactory Trend applications.
Objective
Use a .csv File to insert data values into a Historian tag as updated data
View the Results Using Microsoft SQL Server Management Studio
View the Results Using ActiveFactory Trend
Wonderware Training
Prepare the Import .csv file.
In this section, you will modify the manual data you inserted during the previous lab.
1. Start Windows Explorer.
2. Browse to the MixerTemp-Corrected.csv file found in C:\Wonderware Training.
3. Right-click the file and select Open With / Notepad.
This file contains new values for the LIT_001.PV tag, and uses the same time range as the csv file
used in Lab 16, Importing Original Data. This data will be inserted as Latest data.
Your instructor will update the file with the date range used in Lab 16, Importing Original Data.
4. Close the file.
5. Copy the file to C:\InSQL\Data\DataImport.
After a moment the file will disappear.
6. Maximize ActiveFactory Query. (If you closed it, reopen the VersionedData.sql file).
7. Click the Refresh query button.
Notice now that the Latest and Original values are different for some values (10:02:00 AM,
10:02:30 AM for example).
8. Maximize ActiveFactory Trend.
Notice that the file uses 1 in
the second column of the data
rows, which means the data will
be inserted as latest data.
9. Add a second instance of LIT_001.PV to the Trend.
10. Right-click the second LIT_001.PV tag and select Configure.
13. Select the Other tab.
14. Click the Original radio button.
15. Click OK.
The Original and Latest data are easily compared:
Wonderware Training
Module 9
Historian Event System
Section 2 Defining Event Tags 9-9
Lab 18 Create Events 9-15
Section 3 ActiveEvent 9-33
Lab 19 Using ActiveEvent 9-37
9-2 Module 9 Historian Event System
Wonderware Training
Module Objectives
Introduce and explain the Historian Event System
Explain the Event Tables
Explain and define Historian Events
This section introduces and explains the Historian Event System.
Introduction
The purpose of the Event System is to enable administrators to setup the detection of pre-defined
events and associate actions with those events.
At a basic level, when something that we think is significant happens within the system, we call it
an event.
The Historian Event System can be configured to periodically check to see if an event has
occurred. This is called event detection. A subsequent action can then be configured and triggered
whenever the system detects that the event has occurred.
Note: The Event System is not a real-time system; rather, it operates on historical data. For real-
time alarming, use an application such as InTouch.
Within the Historian, the storage of an event encapsulates more than just the fact that something
happened. An event can be explained as a moment when a set of pre-defined criteria (based on
historical tag values) becomes true.
Attributes of an event include the date and time that the event occurred, the date and time that it
was detected, and the criteria that were satisfied.
The event system performs the following basic functions:
Detects when events have occurred using pre-defined and configurable criteria.
Optionally logs when events occurred into history.
Triggers a designated configurable action each time the event's detection criteria
becomes true.
The Event System will handle the loss of connection to the Historian and will recover when the
server comes back online.
Section Objective
Introduce and explain the Historian Event System.
Wonderware Training
Event System Components
The following table describes the event system components:
The ArchestrA System Management Console is used to configure all aspects of the Event System.
Benefits
You can obtain a number of distinct operational benefits from properly using the features of the
Event System. A list of key benefits is as follows:
Unlike real-time alarming, the Event System determines events from stored historical data and is
not dependent on real-time detection. No events will be missed unless the machine is severely
overloaded for a long period of time.
The Event System is SQL-based, thus providing a means of managing database-related tasks
within the system. You can use custom SQL queries as detectors, as well as create custom SQL-
based actions.
A number of pre-configured detectors and actions are available.
Detections may be made by external sources. A COM mechanism is available for invoking the
detector in the Event System.
Time-based detection (based on the system clock time) enables scheduling of certain tasks, such
as data aggregations (summaries).
The system has been designed to manage overload situations. If the system is currently busy (due
to some other processing) for a period of time, the Event System will "catch up" during off-peak
periods. If the overall Historian is continuously overloaded, the Event System will degrade in
functionality gradually. In other words, the system will not fail catastrophically.
You can select which actions have priority and can assign certain actions (preferably only a few)
never to be compromised, even under overload conditions. System tags are available for
monitoring Event System conditions.
Component Description
Historian Configuration
Editor
Part of the ArchestrA System Management Console. Used to set up event
definitions and possible actions.
Runtime database Used to store event definition information and all data generated by the Event
System, such as records of event detections, data summaries, and data
snapshots.
Event System Service Internal process that coordinates the event detection and action functions. This
process runs as a Windows service.
Using the ArchestrA System Management Console, you can configure the event
service to automatically start and stop at the same time as the Historian.
The event service is responsible for:
Reading the event definition information from the Runtime
database.
Creating event detectors and actions, including allocating the
necessary processing threads and establishing database
connections.
Initiating the event detection cycle.
SQL variables Available for use in event queries.
Event System Use
Generally, you should use the Event System for monitoring non-critical system conditions that
occur only occasionally. For example, possible event detections that you could set up include:
Detect all occurrences in history when the value of discrete tag was equal to 0.
Detect if the system clock is equal to a specified date and/or time.
Determine the state of information in the database via a SQL statement.
You can use event actions to perform tasks such as the following:
Send e-mail messages to remind managers about weekly maintenance checks.
Perform summaries to obtain statistical data for the plant over defined periods of time.
Take "snapshots" of system data.
Modify storage conditions (such as time and value deadbands).
Generally perform any database-related task.
The system is not designed for continually performing data transfer tasks and should not be used
in this manner. The only exception is for summary actions; the system can continually process
data aggregates so that they are available for reporting purposes.
In addition, the Historian Event System should not be used as an alarm system. An alarm system
such as provided within InTouch or Application Server can be used to alert operators to specific
conditions when they become true.
The InTouch alarm system is intended as a notification system to inform operators of process and
system conditions promptly upon their occurrence. The InTouch alarm system supports displaying,
logging, and printing capabilities for process alarms and system events. (Alarms represent
warnings of process conditions, while events represent normal system status messages.) For
more information on the InTouch alarm system, see your InTouch documentation.
In contrast, the Historian Event System is intended to initiate actions based upon historical event
detection. An alarm system presupposes an immediate message response will be propagated for
all configured alarms at the time the respective conditions are met.
In this sense, the Historian Event System is not an alarm system. The Event System queues up
detected events and processes them accordingly based upon pre-configured priorities.
Event System Resource Management
The Event System Service (InSQLEvtSys.Exe) manages all of the system resources required for
detecting events and processing actions. System resources are allocated for detectors and
actions via threads.
A thread is an operating system component that independently performs a particular function
within a larger process. Within the overall process of the Event System, event detectors and
actions are assigned different threads, so that they can execute independently of each other and
thus perform more efficiently.
The Event System uses two thread groups, or "pools." One thread pool is for detectors and the
other one is for actions. The Event Service automatically creates both of these thread pools if
there is at least one event tag defined.
Wonderware Training
Detector Thread Pooling
Other aspects of resource management include the number of database connections required by
event system components, and how the system handles event overloads and query failures.
The detector thread pool is made up of one or more threads allocated for SQL-based detectors
and a single thread for schedule detectors. Each thread maintains a connection to the database.
The detector thread pool is illustrated in the following diagram:
A SQL-based detector is assigned to a thread based on the time interval that is specified when the
event tag is defined.
Each time interval requires its own thread. For example, you define three event detectors and
assign them time intervals of 10, 15, and 20 seconds, respectively.
Each event detector will be running in its own thread, for a total of three threads.
As another example, you define three event detectors, assigning the first two a 10 second interval,
and the third a 15 second interval. The first two will be running under the same thread, while the
third will be running under its own thread, for a total of two threads.
For multiple detectors that are assigned to the same time interval, the SQL detection statement for
each event tag will be executed in sequential order. That is, the first SQL statement must return
results before the next statement can be executed. After each detection has taken place (results
are returned), the detection is logged into the EventHistory table and any associated action is
queued into the action thread pool.
All schedule detectors are assigned to a single thread.
The efficiency of the detector thread pool depends on how you have spread the load when
assigning time intervals to different event tags. Detections generally do not cause overloading on
the system -- the actions (especially snapshots and summaries) are where most processing and
resource loading occurs.
Action Thread Pooling
The action thread pool is essentially a pool of four threads that execute actions from three different
action queues. Each thread in the pool maintains a database connection.
The three action queues are:
Critical queue
Normal queue
Post-detector delay queue
Note: For detailed information about each of these queues, see Event Action Priorities in the
Historian online help files.
As a processor thread completes its previous task, a new action will be fetched from one of the
queues. If there are any actions in the critical queue, these will be processed first. Actions in the
critical queue are executed in the order in which they were added to the queue; that is, the oldest
action sitting in the queue will be processed first.
If the critical queue is empty, actions will be fetched from the post-detector delay queue. Actions in
the post-detector delay queue are ordered by time. Actions assigned the shortest post-detector
delay will be executed first.
If both the critical and post-detector delay queues are empty, actions will be fetched from the
normal queue. Like critical actions, normal actions are processed in the order in which they were
added to the queue.
Event Tables
Event tables contain definitions for events, including tags associated with events, detectors for
events, and actions for events. The event system tables can also store "snapshots" of tag values
at the time of an event, as well as details about the event itself.
A special type of event action is a summarization of tag values. A subset of the event tables
provides the supporting framework for fully automated summary generation for analog, discrete
and string tags.
The event system tables are:
ActionType SQLTemplate
AnalogSnapshot StringSnapshot
CalcType SummaryData
DetectorType SummaryHistory
DiscreteSnapshot SummaryOperation
EventHistory SummaryTagList
EventTag Tag
EventTagPendingDelete TimeDetectorDetail
Frequency TimeDetectorDetailPendingDelete
SnapshotTag
Wonderware Training
Section 2 Defining Event Tags
Event Tags
An event tag is a name for an event definition in the system. For example, if you wanted to log an
event when the temperature of a tank reached 100 degrees, you might define an event tag and
name it "TankAt100." Event tags differ from all of the other tag types in the Historian (analog,
discrete, and string). These tag types are the definitions of variables to be stored, but an event tag
is a named reference for the definition of the specific event you want to detect and what to do
when it occurs.
Event tags are created and maintained using the Historian. When you define an event tag, you
must specify:
A name, description, and other general configuration information
The event criteria, which describes the conditions that must exist for the event to occur
and how often the event system will check to see if the event has occurred.
Whether or not to log the event detection when it occurs.
Whether or not to enable/disable the event detection.
An optional action that to be triggered when the event is detected.
The following table describes the tables that are used for storing event tag definitions:
Section Objective
Explain and define Historian Event Tags and their characteristics.
Type of definition Table
Detection of a particular event and the possible
resulting action
EventTag, DetectorType, and ActionType
Time-based detections TimeDetectorDetail
Snapshots of analog, discrete, and string tags SnapshotTag
Summary actions SummaryOperation and SummaryTagList
Wonderware Training
Edge Detection
When detecting events, it is useful to pinpoint rows in a result set where criteria changed from true
to false, or vice-versa.
For example, you may want to know when the level of a tank goes above 5 feet. As the tank level
approaches 5 feet, the criteria does not return true. Only when the level crosses the line from not
satisfying the criteria to satisfying it, does the event actually occur. This imaginary "line" where the
change occurs is called the edge.
Over a period of time, there may be many instances where the criteria crosses the "edge" from
being satisfied to not satisfied, and vice-versa. The values on either side of this "edge" can be
detected if you configure your event tag to include this information. There are four possible options
for edge detection: none, leading, trailing, or both. You will get differing results based on which
option you use:
Edge detection only applies to analog and discrete value detectors. Also, edge detection is
handled slightly differently based on whether you are using analog tags or discrete tags.
Historical Logging of Events
The exact time at which a particular event actually occurred and the time at which it was detected
by the event system can be logged into a Historian table, called EventHistory. Each row in the
EventHistory table contains the name of a defined event tag, the date/time stamp for when all of
the detection criteria for that event tag were satisfied, the date/time stamp of when the event
detector detected the event, and an additional field that provides event detection information.
Note: You cannot disable event logging if analog and/or discrete snapshot actions are configured.
In addition to the conditions that must be met for an event, you must also have the event detection
process enabled for the event tag.
Tip: The EventHistory table can be used to determine if too many event tags have the same time
interval. If the latency between when the event actually occurs (stored in the DateTime column)
and when it was detected (stored in the DetectDateTime column) is constantly growing and/or
multiple event occurrences are being detected during the same detector time interval, you need to
move some of the event detectors to a different time interval.
Edge Detection Option Results
None Returns all rows that successfully meet the criteria; no edge detection is
Leading Returns only rows that are the first to successfully meet the criteria (return true)
after a row did not successfully meet the criteria (returned false).
Trailing Returns only rows that are the first to fail the criteria (return false) after a row
successfully met the criteria (returned true).
Both All rows satisfying both the leading and trailing conditions are returned.
System Thread Allocation for Events
A system thread is an object that independently performs a particular function within a process. In
the event system, threads are allocated for event detectors and actions.
Detector Thread Allocation
Two threads are allocated to handle event detections: one for all SQL-based detectors and one for
schedule detectors. Each of these threads uses a logon to the SQL Server.
Schedule detectors are processed in real-time and are executed at the scheduled time. Since
SQL-based detectors operate on historical data, they are ordered and then processed. The
detectors are first divided into groups, based on the time interval specified for the corresponding
event tags. The time interval is the rate at which the configured detector component will check to
see if an event occurred (this time interval is stored in the ScanRate column of the EventTag
table). The detectors are then sequentially ordered in the time interval group.
Note: Each detector thread maintains a database connection.
Action Thread Allocation
All actions are assigned to a thread pool. Within this pool are three different queues:
A "critical" queue, which contains any actions for event tags that have been assigned a
critical priority. You should categorize any events that are highly important as "critical"
events. All events that are given a critical priority will be processed first if a system
overload condition occurs. Use caution when assigning an event as critical. If all events
are assigned as critical, there is no protection in the system in the case of an overload.
Critical means that the system will always attempt to perform the action before any normal
actions.
A "normal" queue, which contains any actions for event tags that have been assigned a
normal priority. All non-critical events are labeled with a "normal" priority and will be
processed after the critical events if a system overload condition occurs.
A delayed action queue, which contains any actions for event tags that have been
assigned a post-detector delay. The post detector delay is the minimum amount of time
that must elapse after an event was detected before the associated action can be
executed.
Note: Each thread in the action thread pool maintains a database connection.
Wonderware Training
Latency
Latency is the amount of time between when an event actually occurred and when it is detected by
the event system. Latency is important when you want to quickly trigger an action after an event
occurs.
For example, if you created an event that detects when an instrument is starting to send non-
normal values, you would want an action to notify you to check the instrument as soon as possible.
You would create an event tag for this with a short time interval (scan rate) so that the event
system would frequently check to see if this event has occurred.
Other events (for example, when an operator ended a shift) are not as critical and latency is not as
important.
Use caution in assigning time intervals to event tags. Too many event tags assigned to the same
time interval may result in detector "overruns." While this should not have a negative impact on
actual detection of events, it may add to increased latency. Also, assigning short time intervals will
result in higher CPU loading and may lead to degraded performance.
Event Detectors
Each event tag has an associated event detector. An event detector is a mechanism for
determining when the set of event criteria for an event tag has been satisfied. An event detector
must be of a specified type listed in the DetectorType table. When you configure an event
detector, you must first configure its type and then configure the parameters associated with that
detector type.
The Historian is shipped with the following pre-configured event detectors.
For SQL-based detectors, the time that an event is detected may occur significantly after the
actual time that the event occurred, depending on event configuration parameters. For example,
you configure a detector to detect a particular event based on a time interval of 10,000 ms (10
sec). This means that every 10 seconds, the event detector will check to see if the event occurred.
If the event occurs 2,000 ms (2 sec) after the last check, the event detector will not detect that the
event occurred until the full 10 seconds has elapsed.
Schedule detectors, however, are real-time detectors; they run once every 1 second.
Detector Description
External Event detection is triggered via the ActiveEvent ActiveX control. For example, an
InTouch script can invoke necessary ActiveEvent methods to trigger a Historian
event. The external detector is not configurable.
Generic SQL Detects an event based on criteria that are outlined in a SQL statement. You can
use pre-configured SQL templates that are stored in the database as the basis
for your script, or you can create your own script from scratch.
Analog Specific Value Detects an event based on criteria applied to the value of a particular analog tag.
The value of an analog tag is compared (using operators) to a constant value.
Discrete Specific Value Detects an event based on criteria applied to the state of a particular discrete
tag. The state of a discrete tag is compared to a constant target state.
Schedule Detects an event based on the system clock being equal to or greater than a
specific time. For example, you could log an event every week on Monday at
2:00 p.m.
Event Actions
An event may or may not be associated with an event action. An event action is the action that is
configured to take place when the event detector determines that the event occurred. Event
actions are not required; there are times when you may want to store only when events happened.
The Historian is shipped with the following pre-configured event actions:
Event Components and Programs
The event system consists of the following components and programs:
The Event System Data Model, which is the schema that supports the data configuration
and history logging requirements of the event system.
The Event System Service (ESS), which is a Windows NT Service that coordinates the
event detection and action functions. The ESS is automatically started and stopped when
you start and stop the Historian system using Historian Control program; however, the
ESS can be started and stopped independently from the rest of the system using the
Services program in Control Panel.
A set of system event tags for pertinent system internal variables; similar to pre-defined
system tags.
The System Management Console, a system-wide configuration application that provides
an intuitive user interface in which you can create or delete event tags, configure event
detectors and event actions, and manage the event system.
Event system COM components for enumerators, detectors and actions.
Action Description
None Will not perform any action as the result of an event detection.
Generic SQL Triggers an action that is outlined in a SQL statement. You can use pre-
configured SQL templates that are stored in the database as the basis for your
script, or you can create your own script entirely from scratch.
Snapshot Records the values of selected analog tags or the states of selected discrete
tags or the string values of selected string tags at the time that the event
occurred. Quality is also recorded.
E-mail Sends a pre-configured Microsoft Exchange e-mail message.
Deadband Changes the time and/or value storage deadband for one or more analog tags
that are using delta storage (storage by exception).
Summary Performs one or more aggregations for one or more analog tags.
Wonderware Training
Event System Variables
The Event System uses a set of internal variables called tokens to facilitate event detections and
actions. During the Event Detection and Action, the variables are replaced with the associated
values by the event components just prior to executing the query. The query received by the
Historian does not contain the variables.
The variables are as follows:
Detector Strings use only the @StartTime and @EndTime tokens.
Action Strings use all 4 tokens.
The following figure shows Detector and Action tokens used in several Event Tags (created in the
subsequent lab):
A detection query executed by a detector component is similar to the following:
SELECT Dat eTi me
FROM Hi st or y
WHERE Tagname = ' Boi l er Pr essur e' AND Val ue > 75
AND Dat eTi me > ' @St ar t Ti me'
AND Dat eTi me < ' @EndTi me'
@StartTime and @EndTime are simply placeholders for the detector component to coordinate
event detection over a moving time range.
The following action query illustrates how the event variables could be used:
SELECT * I NTO TEMPTABLE
FROM Hi st or y
WHERE Dat eTi me = ' @Event Ti me'
AND TagName I N (
SELECT TagName
FROM Snapshot Tag
WHERE Event TagName = ' @Event TagName'
AND TagType = 1)
Note: These tokens only function in the internal context of the Event System and do not function
in queries from external client tools such as SQL Server Query Analyzer.
Variable Description
@EventTime Time of the detected event of the current detector.
@EventTagName Tagname associated with the detected event.
@StartTime Start date/time for the detector query.
@EndTime End date/time for the detector query.
Lab 18 Create Events
Introduction
This Lab is designed to teach Event tag creation within the Historian, including how SQL queries
are used as event actions and event validations.
Objective
Utilize the Historian Event System capabilities
Create the HiLevelEvent Tag
Create the TransferEvent Tag
Create the MixerSummary Tag
Create the ExternalEvent Event Tag
Wonderware Training
Create the HiLevelEvent Tag
1. Maximize the ArchestrA System Management Console.
2. Expand the Configuration Editor icon under your Historian server.
3. Expand the System Configuration folder.
4. Expand the Tag Configuration folder.
5. Right-click the Event Tags icon.
6. Select New Tag. from the sub-menu
The New Event Tag Wizard appears.
7. Enter HiLevelEvent in the Unique Tag Name field.
8. Click Next.
The New Event Tag - General dialog appears.
9. Enter Event triggered by Mixer HI Level in the Description: field.
Do not change the other default option settings.
10. Click Next.
11. The New Event Tag Detector dialog box appears:
This dialog box enables assignment of a detection time interval and selection of the tag to
which the event is assigned.
12. Enter 60000 ms in the Time Interval field.
13. Click the Search button in the Tag Name: area.
Wonderware Training
The Tag Finder dialog appears.
This dialog box contains a tagname filter that enables easy location of tags by name,
description, or tag type.
14. Enter LIT in the Tagname area.
15. Click the Find Now button.
The Filter will return tagnames that match the description:
16. Highlight the LIT_001.PV Tag Name in the Found Tags: area.
17. Click the > button that becomes enabled after the LIT_001.PV Tag Name is selected.
This will move the Tag Name to the Target Tags: list.
The tag is now placed in the Target Tag pane and is the tag from which the Event tag will
derive its information.
18. Click OK.
The Tag Name will now appear within the main Detector dialog box.
19. Select > from the Operator drop-down list.
20. Enter 95 in the Detection Value field.
21. Click Next.
The New Event Tag Action dialog appears:
Wonderware Training
22. Change the Action Type: to None.
23. Click Finish.
Creation of the HiLevelEvent tag is complete.
The HiLevelEvent tag now displays within the Event Tags Tag Name pane:
Create the TransferEvent Tag
24. Create a new event tag using the previous steps (Use the Tag Configuration area of the
ArchestrA System Management Console).
25. Enter a Tag Name of TransferEvent.
26. Click Next.
27. Enter Event triggered by Production Transfer in the Description field.
28. Click Next.
29. Use the Search button to insert Inletvalve_001.PV.IsActive1 in the Tag Name field.
30. Set the State Value to TRUE.
31. Click Next.
Wonderware Training
32. Click the Add button on the New Event Tag - Action dialog box.
33. Enter 001 in the Tag Name field and click Find Now.
34. Highlight the following tags:
LIT_001.PV
TT_001.PV
35. Press the > button to move the selected tags to the Target Tags pane.
36. Click OK.
37. Click Finish.
38. The TransferEvent tag is now visible in the Tag Name pane within the All Event Tags group.
Wonderware Training
Create the MixerSummary Tag
39. Create a new Event Tag called MixerSummary using the previous steps.
This event tag will perform an hourly Average summary calculation of the Mixer tag values.
40. Click Next.
41. Enter Hourly summary of mixer tags in the description field.
42. Click Next.
The Detector dialog box appears.
43. Configure the following event tag Detector attributes.
44. Click Next.
45. Select Summary for Action Type.
Now we need to select the Operation type and its properties.
46. Click the Add button on the New Event Tag - Action dialog box.
The Summary Operation Properties dialog box appears.
47. Configure the Calculation Type, Time Stamp, Resolution, and Duration to match the
following figure.
48. Click OK.
Wonderware Training
Next, associate tags to the action.
49. Highlight the Action type you just defined.
The Tags button is now enabled. At this time, you can also access the Operation properties or
delete the Operation.
50. Click Tags.
The Summary Tag List: MixerSummary dialog box appears, containing the operation
properties just defined.
51. Click Add.
The Tag Finder appears.
52. Add the following tags to the Target Tags: list:
LIT_001.PV
TT_001.PV
53. Click OK.
The Summary Tag List Tag Name pane appears similar to the following figure.
54. Click OK, then Finish.
The new MixerSummary tag now appears within the Tag Name pane of the All Event Tags
group.
Create the ExternalEvent Event Tag
For this task you will create an event tag that is triggered by an External action using Wonderware
Application Server instead of from within Historian. The trigger mechanism will be configured in a
subsequent lab.
55. Create a new Event tag called ExternalEvent using the previous steps.
56. Click Next.
57. Enter Triggered by Application Server within the Description: field.
58. Click Next.
Wonderware Training
The New Event Tag Detector dialog box appears.
59. Select External from the Detection Type: drop-down list.
60. Click Next.
61. Select None for the Action Type.
62. Click Finish.
Review Event History
63. Start ActiveFactory Query
Event History is stored in the Event History table in the Runtime database. You will write a custom
query to view that data.
64. Select Custom in the Query type drop-down list.
65. Enter the following query:
SELECT Tagname, Dat et i me, Det ect dat et i me
FROM Event hi st or y
66. Click the Data tab. You will see all the events generated so far in the Historian.
Notice that several HiLevelEvent records and TransferEvent records display in the query results:
Wonderware Training
You can also use the predefined Event History query in ActiveFactory Query to display event
history data.
67. Change the Query type to Event history values.
68. Check the Tag name, Date and time, and Detect date time checkboxes in the Columns tab.
69. Select 1 hour in the Time tab.
70. Select the HiLevelEvent in the Tag Picker.
The events for the HiLevelEvent tag display:
Review Event Snapshot Values
You will now query the Snapshot values generated by the SysStatusEvent tag.
72. Select Event Snapshot from the Query Type drop-down list.
73. In the Time tab, verify 2 hours is shown in the Time drop-down field.
74. Select the SysStatusEvent tag in the Tag Picker.
75. In the Tag set tab, from the Snapshot Tags list, select the tags shown in the following figure:
76. Select the Columns tab.
77. Select the DetectDateTime checkbox.
Wonderware Training
78. Review and analyze the SQL Query:
79. Select the Data tab again to view the query results.
Section 3 ActiveEvent
Introduction
ActiveEvent is an ActiveX control that allows you to notify the Historian event system when an
event has occurred in another application, such as InTouch. ActiveEvent is script-based and can
be used in any application that supports a COM-enabled scripting language to detect an event for
that application. COM-enabled scripting languages include InTouch scripting and Visual Basic.
After the ActiveEvent control is installed, it does not automatically appear in the list of available
ActiveX objects for use within WindowMaker. It must be registered on the InTouch node.
Use ActiveEvent for external event detection in cases where you want to cut processing overhead
used by the Historian Event Detector engine.
To enable external event detection for the Historian:
Create an event tag in the Historian to store the event occurrence information. Make sure
that the detection type is set to External.
The event tag can then be defined so that the event is associated with an action that is
triggered from the Historian, such as executing a SQL script, sending an e-mail message,
or recording the values of a set of tags at the time the event occurred.
Register (install on the host application) the ActiveEvent control so that it can be used in
the ActiveX container application (for example, in InTouch).
Configure the DCOM security attributes for the external detector that will be used with
ActiveEvent. Security attributes must be set up on the Historian computer.
Write a script that will notify the Historian event system of the external event.
The system time for the ActiveEvent computer should be synchronized with the system
time for the Historian. If the ActiveEvent computer time is ahead, the event system may
generate NULL values for snapshot data.
Scripting ActiveEvent
Use ActiveEvent's methods in scripts to connect to a Historian and detect an external event. An
external detector is triggered using the Historian ActiveEvent control. The ActiveEvent control
(which resides on a client machine) interacts with the event detector (which resides on the server
machine) in order to trigger events externally. The ActiveEvent control facilitates the remote
triggering of events on the Historian system by first initializing with the Historian computer name
and event tag, and then calling the InvokeEventEx() method.
ActiveEvent can be scripted using any scripting language that supports COM. For example, an
InTouch script can trigger a Historian event if you use this control in an InTouch application. You
could also trigger an event from a Visual Basic script.
For details on ActiveEvent Properties and Methods, see the Historian ActiveX Controls Guide.
Section Objective
Explain and define Historian Event Tags and their characteristics.
Wonderware Training
ActiveEvent Methods
Use ActiveEvent's methods in scripts to connect to a Historian and trigger an event. The
ActiveEvent control facilitates the remote triggering of events on the Historian system by first
initializing with the Historian computer name and event tag, and then calling the InvokeEventEx()
method.
ActiveEvent can be scripted using any scripting language that supports COM. For example, an
Application Server script can trigger a Historian event if you use this control in a Galaxy. You could
also trigger an event from a Visual Basic script.
AddEventTag()
Adds an event tag to the active event tag list.
InitializeEx()
Creates a connection to the Historian.
Method AddEventTag(string EventTag)
Parameter EventTag
Name of the event tag with which the ActiveEvent event detector is associated.
ActiveEvent is used with an external type event detector.
Returns Value 0 =Success.
2 =Unable to execute method because ActiveEvent is not initialized.
7 =Remote function call failed.
Method InitializeEx(string ComputerName)
Parameter ComputerName
Name of the computer on which the Historian is running. If you are not
connecting to the Historian over a network, use a blank string ("") for the
computer name.
Note You cannot use a Historian alias for this parameter.
1 =Unknown failure.
3 =Unable to initialize ActiveEvent.
4 =ActiveEvent is already initialized.
8 =Unable to determine local computer name.
Remarks Once you have initialized with a Historian, use the IsConnected property to
determine if the connection was successful. Also, you only need to initialize with
the server once; you can invoke an unlimited number of events after initialization
has occurred.
If you are using the InTouch, initialization will not occur unless the ActiveEvent
ActiveX control is part of an open window. This limits the use of the
InvokeEventEx method within InTouch Application Scripts, Condition Scripts,
Data Change Scripts, and so on. When you close an InTouch window, all
ActiveX controls are automatically uninstantiated.
InvokeEventAtTimeEx()
Triggers the event at a specified date/time.
InvokeEventEx()
Triggers the event at the time this method is called.
IsConnected
Determines whether a connection to the Historian exists.
RemoveEventTag()
Removes an event tag from the active event tag list.
Method InvokeEventAtTimeEx(string TagName, string EventDateTime)
Parameter TagName
EventDateTime
Date/time that you want the event triggered. This date is in local time for the Historian.
This parameter must be formatted as:
YYYY-MM-DD hh:mi:ss.mmm
1 =Unknown failure.
5 =Unable to perform date/time conversion due to invalid format.
6 =Date/time cannot be a future date.
Remarks You can invoke an unlimited number of events after you have initialized with a Historian.
Method InvokeEventEx(string EventTag)
Parameter EventTag
1 =Unknown failure.
Remarks You can invoke an unlimited number of events after you have initialized with a Historian.
Method IsConnected
Returns Value 1 =Connected to the Historian.
0 =Not connected.
Method RemoveEventTag(string EventTag)
Parameter EventTag
Name of the event tag to remove from the list of external events for the ActiveEvent
control.
7 =Remote DCOM call failed.
Wonderware Training
Lab 19 Using ActiveEvent
Introduction
This Lab is designed to demonstrate the use of the ActiveEvent ActiveX Control to trigger external
events in the Historian.
Objective
Import the ActiveEvent ActiveX Control into the Galaxy
Create a template and include a script to trigger an external event
Trigger the event from ObjectViewer
Use the ActiveEvent ActiveX Control to trigger External events in the Historian
Wonderware Training
Import the ActiveEvent ActiveX Control into the Galaxy
1. Start the ArchestrA IDE.
2. Connect to WWGalaxy on your local GR node.
3. Click Galaxy / Import / Script Function Library
4. Locate the file aahActiveEvent.dll, in C:\Program Files\Wonderware\InSQL\Server\.
5. Click Open.
An information dialog box displays:
6. Click OK.
The ActiveEvent ActiveX Control is ready to be used.
Modify the Mixer Template
7. Edit the Mixer template in the Training Objects Toolset.
8. Select the UDAs tab, and create a UDA with the following configuration:
Name: Trigger
Data Type: Boolean
Category: User Writeable
Initial Value: False (unchecked)
9. Click the Scripts tab, and create a new script called Trigger.
10. In the Declarations section, write the following:
di mHi st Event as AAHACTI VEEVENTLi b. aahEvent Cl ass; ' I nst ance of t he
Act i veEvent Cont r ol
11. Select Startup for Execution Type.
Wonderware Training
12. Add the following to the scripts area:
Hi st Event = new AAHACTI VEEVENTLi b. aahEvent Cl ass;
Hi st Event . I ni t i al i zeEx( " l ocal host " ) ; ' Connect s t o Wonder war e Hi st or i an
Hi st Event . AddEvent Tag( " Ext er nal Event " ) ; ' Regi st er s Event Tag
13. Select Execute for Execution Type.
14. In the Expression field, enter Me.Trigger.
15. Select OnTrue as Trigger Type.
16. Write the following in the script area:
I f Hi st Event . I sConnect ed( ) t hen
Hi st Event . I nvokeEvent Ex( " Ext er nal Event " ) ;
Endi f ;
Me. Tr i gger = f al se;
17. Lock all fields.
18. Save and Close the Editor.
Wonderware Training
19. Deploy the Mixer_XX0 and Mixer_XX1 instances.
Trigger and Monitor the Event
20. Right-click the Mixer_XX0 instance and launch ObjectViewer.
21. Locate the Trigger attribute and add it to the watch window.
22. Set the Trigger attribute to True. This will trigger the external event in the Historian.
23. Start ActiveFactory Query.
24. Change the Query type to Event history values.
25. Select ExternalEvent in the Tag Picker.
26. Click the Time tab.
27. Select a time period of 1 hour.
The event generated by Application Server displays:
Wonderware Training
Module 10
Introduction to Information Server
Section 1 Hardware and Software Requirements 10-3
Section 2 Information Server License Management 10-5
Lab 20 Licensing Management 10-9
10-2 Module 10 Introduction to Information Server
Wonderware Training
Section 1 Hardware and Software Requirements 10-3
Section 1 Hardware and Software Requirements
This section introduces you to the hardware and software required to install and operate a
Information Server.
Note: Information Server clients all access the server using Microsoft Internet Explorer 6.0 or
higher and require no other installations. The following sections will focus on setting up and
maintaining the server.
Server Hardware Requirements
Remember, you are building a Web Server and should plan accordingly. When using Information
Server, more memory is better.
Software Requirements
The following software components must be present to install Information Server 3.0. Before you
install Information Server, install any missing components according to their installation
instructions and the information below, and verify that they are working correctly.
The Information Server installation program scans for these components. If the MSXML and
Capicom components are not installed, the installation program silently installs them to the target
machine.
Section Objectives
Introduce Information Server hardware and software requirements
Minimum Suggested
2.5 GHz Pentium IV 3 GHz Pentium IV
1 GB RAM 2GB or more
5 GB Disk Space (NTFS required) 10 GB Disk Space (NTFS required) or more, depending on
the number of InTouch windows published
SVGA Monitor 800x600 with 256 Colors XVGA Monitor 1024x768 with 24-Bit Color
File system NTFS
Operating System Microsoft Windows Server 2003 R2 SP1
Module or
Component
Details Required Version
WSS/SPS 2.0 Windows SharePoint Services (to use MultiView feature) 2.0 SP2
SSRS 2005 SP1 SQL Server Reporting Services (to use ArchestrA Reporting
feature)
2005 SP1
MS Excel Microsoft Excel (to use ActiveFactory Reporting Website
feature)
2000, XP, 2003, or
2007
MSXML 4.0 SP2 Microsoft XML Parser / SDK 4.20.9818.0
Capicom Microsoft Capicom module 2.0.0.3
Microsoft ASP.NET Microsoft ASP.NET 2.0
IIS 6.0 Internet Information Services 6.0
IE Internet Explorer 6.0 SP1 or later
Wonderware Training
Note the following important information regarding individual components:
Windows SharePoint Services: To use the MultiView feature, you must install and configure
Windows SharePoint Services 2.0 SP2 before installing Information Server. Also install any WSS
Language Pack for languages you want Information Server to support. Using Windows SharePoint
Services 3.0 is not supported.
The Microsoft Windows SharePoint Services 2.0 and associated Service Pack 2 can be
downloaded from the Microsoft Download site http://www.microsoft.com/downloads. Follow the
instructions for downloading and installing Windows SharePoint Services. During the installation,
select Server Farm and manually configure the installation.
SQL Server Reporting Services: To use the ArchestrA Reporting feature, you must install and
configure SQL Server Reporting Services and set up a reporting database before installing
Information Server.
FrontPage Server Extensions: Windows SharePoint Services 2.0 is not compatible with FrontPage
Server Extensions. Before installing SharePoint, disable or remove FrontPage Server Extensions
as described in Microsoft Knowledge Base article 823378 (http://support.microsoft.com/
default.aspx?kbid=823378&product=winsps). While Information Server can be installed on a
system that has FrontPage Server Extensions enabled, this is not a supported configuration.
IMPORTANT! To use the MultiView feature, you may also need to install a Microsoft hotfix that
resolves an incompatibility issue between Windows SharePoint Services 2.0 SP2 and ASP.NET
2.0. For more information, see CR L00055978 in the Known Issues Found in Information Server
3.0 section.
The following table describes the minimum required software to provide particular functionality
within the Information Server:
Localization
The initial Information Server product supports English, German, French, and J apanese (with
additional character set installation). Other languages can be added using the Developer Edition.
Information Server detects what language the browser client is running and dynamically adjusts
the language of the Information Server Portal to match.
The Information Server components that are localized include:
Server Install
Converter Install
Factory built pages and framework
Popup dialog box
Show window dialog box
Product documentation
Help
License agreement
Release notes
Function Required Software
Provide data for browser-based windows InTouch 9.0 or later
Provide history data Historian 9.0
Provide alarm data InTouch 9.0 or later
Section 2 Information Server License Management
This section introduces you to the details of Information Server licensing, including viewing,
querying and configuring active and historical license data.
Licensing
Using the License Manager area of the Information Server, you can view and configure license
details of Server, Tag Server Write back and Client licenses, and monitor who is currently using a
license.
The Information Server supports concurrent, named user, and named device licensing. The
licensing policy located on the server determines how many browsers can access Information
Server at any given time. All of the license information is managed by a dedicated license
management component. When a client attempts to access Information Server through Internet
Explorer, Information Server checks to see if a license is available and grants or denies access to
the client depending on license availability.
You need enough client licenses for the number of users concurrently accessing the licensable
areas of the Information Server. Client access to these areas is on a first-come, first-served basis.
For example, if the Information Server is licensed for ten concurrent clients and an eleventh client
attempts to access the server, a message appears to the client stating that there are no additional
licenses available. However, if the eleventh client is an administrator, then he/she can access the
administrative areas only.
A session is created when a client user accesses the Information Server home page, and a license
is issued for the use of the core Information Server applications, such as Process Graphics,
Factory Alarms, and Historical Data. A user can access these and all custom areas and still only
use one license. All licenses are released for the user's session when the user clicks Log Off on
the main menu bar. If a user closes the browser without logging off, the current license session
times out after a certain length of time. By default, this is set to 20 minutes and can be changed by
the web server administrator for the Information Server application using the Internet Information
Services console application.
The license management feature lets you monitor activity and usage on the Information Server.
Licensing information is displayed in text format to allow analysis of peak usage times and
personnel.
Section Objectives
Introduce Information Server Licensing
View Active Licenses
View License History
Configure License Usage Logging
Query License History data
Wonderware Training
Viewing Active Licenses
You can view both the active licenses for the Information Server and for any applications that have
been integrated with the site. Active licenses indicate the license usage at the current time for
each application.
Different categories of license use are available:
Server Licenses - Shows various server licenses used by the Information Server and
their details including their status, Date/Time of issue, Type, License Server and Expiration
Date
Tag Server Writeback - Shows the availability of a Tag Server Writeback license
Client Licenses - Shows the Information Server client licenses and ActiveFactory web
client licenses in use with details including the User, Host, License, Date/Time of Issue,
Type and Expiration
To change the maximum number of records displayed in the Active Licenses panel, type the
new value in the Max records box and then click Refresh.
Configuring License Usage Logging
License usage can be recorded and logged into the Information Server administration database for
historical viewing.
a. Do one of the following:
Click the Log License usage to database checkbox to turn logging on
Uncheck the Log License usage to database checkbox to turn logging off
TIP: Though an administrator can control the maximum records that are displayed from the
database, the database will grow larger over time. You can improve performance by having a SQL
Server administrator trim the licensing history table by deleting older records.
Querying License History
The license history page provides prior license usage information. This information includes
whether a user was allowed or denied access to an application, what time this occurred, the type
of application used, and the login name of the user. This information enables the administrator to
correctly configure the Information Server with the appropriate number and type of licenses for the
users.
To query license history:
a. Select the start and end dates by using one of the following methods:
Select the month and year by using the drop down menus; select the day by clicking a
calendar day
Enter the dates by typing into the entry boxes using the format: YYYY-MM-DD. To specify
exact times, type into the entry boxes using the 24-hour format HH:MM or use the arrow
buttons
b. Type the number of records to display in the Max records box.
Wonderware Training
c. Click the Show License History button.
The License History page appears with the query results:
Lab 20 Licensing Management
Introduction
This lab will illustrate the steps necessary to review Information Server license usage information,
and configure some general parameters.
Objectives
Review License usage and history
Configure Session Time-outs for Information Server
Wonderware Training
Review License Information
1. Start Internet Explorer.
Start / All Programs / Internet Explorer
2. In the address line enter http://<node name>/wonderware, where <node name>is the name
of the Information Server.
The Information Server home page appears:
3. Expand Administration in the left navigation tree.
4. Click License Manager.
The License Manager page appears.
5. Click Active Licenses.
The following information is displayed:
Server Licenses: Shows various server licenses used by the Information Server, and
their details.
Tag Server Writeback: Shows the status (availability) of Tag Server Writeback licenses.
Client Licenses: Shows the Information Server client licenses and ActiveFactory Web
clients in use with other details.
6. Verify that the Log License usage to database option is enabled. This option enables the
Information Server to log the license usage in the Information Server administration database.
7. Enter 200 for Max records to change the maximum number of records displayed on the page.
Wonderware Training
8. Click the Refresh button to update the current Licensing information.
9. Click Query License History.
The Query License History panel appears.
10. Select one month ago as the Start Date.
11. Select todays date as the End Date.
12. Click the Show License History button.
Enter 200
The License History panel appears.
The following information is displayed:
Start time: Access date and time
User name: Name of User who logged in
Denied: Indication if access was denied because maximum number of concurrent user
log ins were exceeded (refer to your license agreement)
Application: Indicates application that accessed the database
13. Click the Log off link in the right corner of the Information Server window.
Note: If you exit your browser without Logging Off, the license will remain in use until it times
out. The default timeout is 20 minutes. Be sure to log off to release the license. You will modify
the timeout in the following section of this lab.
Wonderware Training
Change the Session Timeout Values
To change session timeout values:
14. Start Internet Information Services (IIS) Manager:
Start / Control Panel / Administrative Tools / Internet Information Services (IIS) Manager
The Internet Information Services console appears.
15. Expand your server icon next to your machine name.
16. Expand the Web Sites folder.
17. Expand the Default Web Site folder.
18. Right-click the Wonderware virtual directory (created during installation) and click Properties
from the context menu.
The Wonderware Properties dialog box appears with the Virtual Directory tab selected.
19. Click the Configuration button.
The Application Configuration window appears.
20. Click the Options tab.
Wonderware Training
21. In the Session timeout box, type 30 (timeout limit in minutes for client connection).
22. In the ASP script timeout box, type 180 (timeout limit in seconds for scripts).
23. Click OK.
24. If the following Inheritance Overrides window appears, click Select All and click OK.
25. Click OK again.
26. Click File / Exit to quit Internet Information Services. The timeout values you just configured
will apply next time you access the Information Server portal.
Module 11
Process Graphics
Section 1 Convert & View InTouch Windows Over the Web 11-3
Lab 21 Convert and View InTouch Windows Over the Web 11-25
Section 2 Configuring Write-Back for Factory Data Sources 11-37
Lab 22 Configuring Write-Back Access 11-39
11-2 Module 11 Process Graphics
Wonderware Training
Module Objectives
Prepare to convert InTouch windows to XML by installing the Win-XML Exporter
Introduce the technologies used to convert InTouch windows to XML
Convert InTouch windows to XML
Publish the converted windows to the Information Server and view the windows over the
Internet using Internet Explorer 6.0 or higher
Introduce the technologies used to assign write-back privileges
Enable write-back for factory data sources
Section 1 Convert & View InTouch Windows Over the Web
This section introduces and walks you through the tools and steps necessary to publish your
InTouch windows onto a Information Server web portal for Internet viewing.
Converting and Publishing InTouch Windows
InTouch windows will likely be a foundation of your Information Server portal information. The
process you will go through to make these windows accessible from your portal is actually quite
simple. The process behind-the-scenes is where the complexity lies.
Note: Plan the complexity of your InTouch windows for viewing over the Internet. Three hints:
Do not use navigation the user will have to click on.
Do not include excessive animations.
Do not convert InTouch windows that contain ArchestrA graphics; ArchestrA Graphics
within InTouch windows do not convert to XML format and will display an error message.
Converting and publishing InTouch application windows can be accomplished by using the Win-
XML Exporter application. The Win-XML Exporter can be installed from the Information Server
portal.
XML: Behind-the-Scenes Technology
XML is a mark-up language used to transmit code over the Internet and have it interpreted by a
browser. Using XML saves bandwidth and allows for interpretation of graphics to be quick and
consistent across many platforms.
The Win-XML Exporter is a converter tool used to convert InTouch windows to an XML format so
they can be viewed over the Internet. It is available as a free download from the Information Server
home page to the local machine.
The program is authenticated and signed by Wonderware. This provides the user with assurances
that they are not downloading a virus to their machine. Once the download is complete, it begins a
normal install process.
Before You Begin Converting and Publishing InTouch Windows
Once you have windows that have been optimized and you are in the administrator role on the
Information Server web portal; you download the Win-XML Exporter tool, convert the windows to
the XML format, and publish them to the portal site.
This requires knowledge of where the InTouch windows are located and which web server is
hosting the information.
If the InTouch windows need to be optimized, use InTouch WindowMaker to modify the existing
windows. Refer to the Using WindowMaker section of the latest version of the Wonderware
Section Objectives
Prepare to convert InTouch windows to XML by installing the Win-XML Exporter
Convert InTouch windows to XML
Publish the converted windows to the Information Server and view the windows over the
Internet using Internet Explorer 6.0 or higher
Wonderware Training
InTouch Users Guide for information about optimizing existing windows and designing new
windows for the browser environment.
Note: If you are using InTouch 10.0 and your InTouch windows contain ArchestrA Graphics, an
error message will display when the windows are converted to display in Information Server.
ArchestrA Graphics within InTouch windows do not convert to XML format.
Installing the Win-XML Exporter
The Win-XML Exporter can be installed from a link on the Information Server portal home page.
The Win-XML Exporter does not require a license.
The Win-XML Exporter setup program will:
Install the application to your local computer
Note: You can install the Win-XML Exporter on the Information Server portal.
We suggest that you install it on your local InTouch development node.
There is a Destination Location choice during the install process.
Add a shortcut to the Win-XML Exporter on your Windows Start menu.
(For example, Start / All Programs / Wonderware / InTouch/Win-XML Exporter.)
You must install the Win-XML Exporter on the same computer as InTouch WindowMaker if the
windows you want to convert contain ActiveX controls.
If a previous version of the Win-XML Exporter is currently installed, uninstall it prior to installing the
newer version.
To install the Win-XML Exporter:
Follow the steps to install the Win-XML Exporter with your instructor. The Win-XML is required for
a later lab.
a. Access the Information Server portal home page.
b. In the System access panel, expand Administration.
c. Click Win-XML Exporter.
The Win-XML Exporter page appears.
d. Click the Download Win-XML Exporter Now button.
The File Download-Security Warning dialog box opens.
e. Click the Run button.
The Internet Explorer-Security Warning dialog box opens.
Wonderware Training
f. Click the Run button.
The Information Server Win-XML Exporter Setup - Welcome dialog box opens.
g. Click the Next button.
The Information Server Win-XML Exporter Setup - License Agreement dialog box opens.
h. Select I accept the license agreement.
i. Click the Next button.
The Information Server Win-XML Exporter Setup - Destination Folder dialog box opens.
j. Click the Next button.
The Information Server Win-XML Exporter Setup - Ready to Install dialog box opens.
k. Click the Next button.
Wonderware Training
l. Click the Finish button.
Uninstalling the Win-XML Exporter
To uninstall the Win-XML Exporter:
a. Select Start / Control Panel/Add or Remove Programs.
The Add/Remove Programs dialog box appears.
b. Select Information Server Win-XML Exporter in the Currently installed programs pane.
c. Click the Remove button.
d. Follow the prompts to complete the uninstall.
Starting the Win-XML Exporter
To start the Win-XML Exporter:
a. Select Start / All Programs / Wonderware / InTouch / Win-XML Exporter.
The Win-XML Exporter opens:
The Win-XML Exporter has three panes:
The Project Browser: displays all of the associated WindowSets and windows
The InTouch Window Pane: lists InTouch windows available for conversion
The Results Pane: displays information regarding the success of a window
conversion (Information View) or a preview of the converted window that is selected in
the project browser (Preview)
This pane also displays any errors or cautions if the Win-XML Exporter detects a
problem with the conversion.
Project Browser
InTouch Window Pane
Results Pane
Wonderware Training
Win-XML Exporter Toolbar Buttons
The following table describes the toolbar buttons:
:
General Steps for Using the Win-XML Exporter
Some general steps for using the Win-XML Exporter are:
a. Create a new project file. The project file is used to store information such as the URL to the
Information Server portal where you will be publishing and the path to local project files. Local
project files also include converted windows, WindowSets, and default data source
information.
b. Rename the default WindowSet for the project to something meaningful to the project and
your naming conventions.
c. Open an InTouch application that contains the windows you want to convert.
d. Convert the InTouch application windows and view the status of the conversion.
e. (Optional) Create additional WindowSets to contain the converted windows from a single
InTouch application.
f. Publish the entire project to the Information Server portal. You may also publish incrementally.
There are a few WindowMaker elements that are not compatible with Internet technology,
however, all other elements, including text, graphics, action scripts and animation are
automatically converted for you.
Button Description
Create a new project file
Opens an existing project file
Switches the project to Online or Offline mode
Selects an InTouch application to convert
Opens the Help file
Working with Projects
Before you can publish windows, you will need to create a project. The project file will be used to
store all the configuration information for the InTouch windows you want to publish.
Creating a New Project
To create a new project:
a. Select New Project on the File menu.
The Project Properties dialog box appears:
b. Type a name for the project (up to 256 characters) in the Project Name box.
A new folder will be created using this name.
c. To change the default working folder for the project:
Click the ellipsis button to the right of the Local Project Path box.
This project path can browse to any folder on your computer.
d. Click the Next button.
Note: When accessing ArchestrA data via Information Server:
You must deploy a Wonderware Application Server Platform on the Information Server node to
allow Information Server access to the ArchestrA data source.
Wonderware Training
The Publishing Properties dialog box appears.
e. Type the URL where the Information Server portal is located in the Information Server URL
box. Converted windows will be published to this server. For example, http://MyWebServer/
Wonderware. You must include the /Wonderware virtual directory as part of the URL.
f. Click the Verify button.
g. Click the Next button once the connection is successful.
The Data Source Properties dialog box appears.
h. Select Change default data source if your application will not be receiving data from a
running WindowViewer application on the data node.
Configure the data source options:
Web Server URL
The URL for the web server that will serve as the data source. This server can be a different
web server than the one you will publish the converted windows to, allowing converted
windows to be hosted on one portal and retrieve data from another. If you are using secure
socket layers (SSL), remember to type "https:" instead of "http:"
Data Node Name
The name of the computer that provides the data. This can be either the computer on the plant
floor that is running the InTouch application, an I/O Server, Historian, and so on. This node will
supply the data for the converted window.
Application
The executable name of the application on the data node from which you want to receive data.
For example, for WindowViewer, you would specify VIEW.
Topic
The specific subgroup of data elements for the specified application. Examples of topics are
Tagname for InTouch, or the name of an Excel spreadsheet.
Note: If you choose to retrieve data from an I/O Server, you must select the Use Tagname as
Item Name option in the WindowMaker Tagname Dictionary when defining the tags for the
window that will be converted.
Wonderware Training
The New Project Information dialog box appears.
j. Verify the information is correct.
If it is incorrect, click the Back button and edit the information.
k. Click the Finish button if the information is correct.
The project you created now appears in the left pane of the Win-XML Exporter with the default
name of "WindowSet001."
Opening an Existing Project
To open an existing project:
a. Select Open Project on the File menu.
The Open dialog box appears.
b. Browse to the project file (.wxe) to open and then click Open.
c. Click the OK button.
Deleting a Project
You cannot delete a project from within the Win-XML Exporter. You will need to delete the project
files manually from your computer using Windows Explorer.
Working With WindowSets
WindowSets are used to group together converted InTouch windows so that you can operate on
them as a unit.
Creating a WindowSet
When creating a WindowSet, use the data source information of either a project or another
WindowSet by default.
To create a new WindowSet:
a. Right-click on either an existing WindowSet or project on which to base the new WindowSet in
the project browser.
b. Click New WindowSet. A new WindowSet is created in the project.
c. Change the WindowSet name, if desired.
d. Edit the default WindowSet properties, if desired.
Editing Properties for a WindowSet
To edit WindowSet properties:
a. Right-click an existing WindowSet in the project browser.
b. Click Properties.
The WindowSet Properties dialog box opens.
c. Check the Different than Project option to change the data source information. When you
change the data source for a WindowSet, all windows in that WindowSet will use the new data
source. Options are as follows:
Web Server URL
Used to specify the URL for the web server that will serve as the data source. This server can
be a different web server than the one you will publish the converted windows to, allowing
converted windows to be hosted on one portal and retrieve data from another. If you are using
secure socket layers (SSL), remember to type "https:" instead of "http:"
Data Node Name
The name of the computer to provide the data. This can be either the computer on the plant
floor that is running the InTouch application, an I/O Server, the Historian, and so on. This node
will supply the data for the converted window.
Application
The executable name of the application on the data node from which you want to receive data.
Topic
The specific subgroup of data elements for the specified application. Examples of topics are
Tagname for InTouch, or the name of an Excel spreadsheet.
Wonderware Training
d. Click the OK button.
Deleting a WindowSet
To delete a WindowSet:
a. Right-click on the WindowSet in the project browser.
b. Click Delete.
Working with InTouch Windows
Most InTouch windows can be converted into a viewable web page in Internet Explorer. However,
not all InTouch functionality is compatible with web technology.
Note: For best results use InTouch 9.0 or greater.
To open an InTouch application:
a. Select Open InTouch Application on the File menu.
The Browse for Folder dialog box appears.
b. Navigate to the InTouch application folder containing the window(s) to convert.
c. Click the OK button.
Wonderware Training
The available InTouch windows from the folder you selected now appear in the top right pane
of Win-XML Exporter:
For each window, the pane displays the caption name you assign it, the path, file name, and
the file size of the window.
Converting InTouch Windows
To convert an InTouch window:
a. Select the window to convert in the pane of available InTouch windows.
Tip: To select multiple consecutive windows, hold down the SHIFT key, select the first window,
and then select the last window. To select multiple windows: Hold down the CTRL key while
making your selections.
b. Drag-and-drop the window from the upper right pane onto the WindowSet name in the project
browser (left pane).
The conversion to XML is performed automatically during the drag-and-drop operation. The
converter will rename the window file.
By default, the bottom right pane of the Win-XML Exporter only shows the status of the LAST
window converted. Therefore, if you convert twelve windows at one time, and the first eleven
have errors, you will see a successful conversion message if the twelfth window converts with
no errors.
Note: If you are using InTouch 10.0 and your InTouch windows contain ArchestrA Graphics, an
error message will display when the windows are converted to display in Information Server.
ArchestrA Graphics within InTouch windows do not convert to XML format.
Viewing the Window Conversion Status
To view the conversion status for a particular window:
a. Select the desired window in the project browser.
b. Right-click on the window and select Information View.
c. Click the Information tab in the bottom right pane of the exporter.
d. Expand the Information item. If all elements successfully converted in the last window you
selected, you will see "Successful Conversion!!!
Wonderware Training
You will see other details if it is not successful. In this instance an InTouch 10.0 window containing
ArchestrA Graphics was converted to display in Information Server. ArchestrA Graphics within
InTouch windows do not convert to XMl format.
You may edit the window and convert it again.
e. Expand the different sections to see information about warnings or errors.
f. Click Report to view a list of items that were not converted.
ActiveX Controls in an Application
Win-XML Exporter will search for ActiveX Controls in your application. Win-XML receives data
from Windowmaker by reading the OCX.ini file.
When using ActiveX Controls in your application over the Internet, the ActiveX Control will be
converted and published to the web server using a compressed CAB file.
When the User tries to view a window that uses that ActiveX Control, the Control downloads to the
Users machine and registers itself without user intervention. If browser security is configured high,
the user will be given an option to accept or deny the ActiveX control installation. Wonderware
does not verify the authenticity of Third Party Controls.
The user will need a license to run a Third Party ActiveX Control.
Note: The default installation of IE 6.0 does not allow for unsigned controls to download to the
client side automatically. This may be a potential issue for a user because they may try to view a
certain Windowset that requires one of these ActiveX Controls. If they havent configured their
browser to accept unsigned Controls, they wont be able to perform that process and nothing will
happen.
There are ways to troubleshoot this issue if you are on the Internet. You can change the Internet
security level in IE to prompt you when an unsigned ActiveX Control is being downloaded or you
can obtain a signed version from the Third Party vender as well.
If you do not have this Control running with the application, you will see a window with an X
in the top left corner of the screen indicating that there is a missing control on that page.
Note: The most common error seen is: Error Publishing to the Server.
What causes this error?
Wonderware uses Microsoft Web Post .dlls to move information across the Internet while
Microsoft Front Page Server Extensions control the publishing process. Wonderware installs the
Web Post dlls if not already present on the Server. If they are installed, they are configured to work
with Information Server. The Installing User automatically becomes an Administrator by default
and is placed into the administrative group.
When a request is made to publish to a web server, the server confirms the protocol: FTP, HTTP,
or Front Page Server Extensions. Typically, if the Installing User is developing the project, this will
be done automatically.
After you have chosen a Control, a new screen opens with the InTouch applications listed in the
top of the window frame. This is a list of the windows that are in the application that are available
for publishing.
To convert the applications, drag them from the right pane and drop them on the Windowset of
your choice in the left pane.
Wonderware Training
Publishing Windows to the Information Server Portal
To publish a project or individual WindowSet:
Right-click on the project or WindowSet in the project browser and click Publish.
Previewing a Converted Window
The preview window has two modes: Online and Offline. The default mode is Offline. In Offline
mode, the preview window shows you how your converted window will look; however, you cannot
preview animations because the window is not currently receiving any data.
Popup windows will only be listed when you are in Offline mode. Popup windows are converted
and can be accessed by the user at runtime (in the browser). However, popup windows will not
display in the list of windows that the user sees in the browser. Therefore, no user can directly
access a popup window.
You must be assigned to the Administrator Role by your Information Server administrator in order
to use the Online mode. Even then, the preview pane only provides Read Only access; you will not
be able to test TouchLink input dialog boxes or any features that require write-back permissions.
In order to preview a runtime version of the window, you must first publish the window. After that, if
you specify the Online mode, an attempt will be made to establish a connection to the Information
Server Portal that you have specified for the window. If the portal has access to the data source,
animations will function as if you were viewing the window in a browser over the Internet/intranet. If
the animations are not working, the data source may not be operating, the data source
specifications may be incorrect, or the scripting that drives the animation may need to be modified.
Enabling Automatic Window Resizing
By default, the converted window is displayed full size as it was drawn in InTouch and is not scaled
to fit the Information Server portal window. Scroll bars appear, if necessary, to provide the user
access to the non-displayed areas of the screen. Enabling automatic window resizing in Win-XML
Exporter causes the application window to be scaled to fit the users browser.
Deleting a Window
If you are in Online mode, you can delete windows from the portal site with the proper security
clearance from the portal administrator. If you are offline, you can delete windows from the project
workspace.
Using Multiple Web Servers for WindowSets
Corporate portals usually have different requirements, and you may want to display only the
information that is important to the corporate casual users. Standard corporate InTouch windows
can be created and exported to multiple plants to publish on their web servers, allowing the
corporate casual user to view the same information from multiple plants without having to know the
names for all the different WindowSets at each company. This will save the corporate user a lot of
time when trying to access pertinent information about individual plants, as well as combining
information company wide.
When a casual user accesses the Information Server Portal for information, they are first
authenticated on the domain controller. After authentication, the web server will automatically
connect the user to the information they want, even if it is being hosted on another web server.
This is a good way to design a corporate portal. It still has all the security features built into
Windows and the portal, and the data retrieval is transparent to the casual user.
In the following example, the corporate computer is retrieving data from a web server in Texas, but
it only had to contact the Information Server web server in California. This computer could also
access information from Brazil during the same session, without any additional steps,
configuration, or security logons.
The client user never needs to worry about changing the connection to the data source, because
the portal administrator will have this configured before the client attempts to access the
Wonderware
Information
Server
(California)
Wonderware Training
information. The Win-XML Exporter is used to easily configure the data to come from different web
servers, as well as different nodes.
You can configure the data source for a WindowSet by modifying the properties in the WindowSet
Properties dialog box.
For example, a WindowSet titled "France Web Server" is configured to retrieve information from
Information Server web server titled "France," which has a computer name (node name) of
"Demo." The windows listed under the France Web Server name are all receiving information from
the Information Server web server France and node Demo.
Likewise, the windows listed under the WindowSet name "Brazil Web Server" are receiving their
information from the Information Server web server Brazil, which has a node name of Demo 2.
Tip: You can also use MultiViews to simulate the multiple window effect used in InTouch
applications or to view information from different sources in the same screen.
Lab 21 Convert and View InTouch Windows
Over the Web
Introduction
In this part of the lab, you will convert windows in an existing InTouch application to XML, and
publish these windows to your Information Server web portal. Using your Information Server
portal, view these windows over the Internet.
Objectives
Convert InTouch Windows to XML using the Win-XML Exporter conversion tool
Publish InTouch Windows to your Information Server Web Portal
View InTouch Windows over the Internet using your Information Server Web Portal
Wonderware Training
Start the Win-XML Exporter
1. Select Start / All Programs / Wonderware / InTouch / Win-XML Exporter.
2. Select File / New Project...
The Project Properties dialog box opens.
3. Enter the new Project Name: Mixer Windows.
4. The project will be saved in the default project path: C:\Wonderware\Mixer Windows.
5. Click the Next button.
The Publishing Properties dialog box opens.
6. Enter the Information Server URL.
The typical path is http://<your server name>/Wonderware
Note: Enter your computer name rather than localhost.
7. Click the Verify button.
The Success dialog box displays.
8. Click the OK button.
Wonderware Training
The Publishing Properties dialog box is active.
The Data Source Properties dialog box opens.
Notice that the Web Server URL and Data Mode Name parameters already point to your
local computer, so there is no need to make modifications at this point.
The New Project Information dialog box opens.
11. Click the Finish button.
A new windowset is created automatically with a default name of WindowSet001.
12. Name the new windowset Mixer Windows to contain the Windows for the new project and
press Enter.
Wonderware Training
Publish InTouch Windows Using the Win-XML Exporter
13. Select File / Open InTouch Application... in the Win-XML Exporter.
14. Browse to the C:\Wonderware Training\InTouch - Mixer Application folder. This folder
contains the InTouch application containing the windows we want to publish.
The Cab Dialog appears.
For this lab you will not need any of the listed ActiveX Controls.
The windows contained in the InTouch Application will now appear in the right pane.
17. Click and Drag the Mixer and Gauge windows to the Mixer Windows folder in the left pane.
Wonderware Training
18. The windows you dragged over are now converted and appear in the left pane.
19. Individually select each converted window to check the message in the Information View tab.
It should display Status: Successful conversion!!!
20. Right-Click each window.
21. Select Publish.
Note: To publish multiple windows in one step, Right-click on the Application or the
WindowSet folder name, then publish as above. You will not receive the same kind of detail
regarding errors and successes in the lower right pane when publishing multiple windows.
After each window has been published, the Success dialog box opens.
23. Repeat this process for each converted window.
Your windows are now published to the Information Server Web Portal and are ready to view
over the Internet.
View Your Published Window(s) on the Web Server
24. Return to the Information Server portal home page using Internet Explorer.
25. Expand the Process Graphics option in the left menu tree view.
26. If prompted, click the Download/Upgrade button.
Note: The Client-Side software download dialog box appears on the initial conversion only
Wonderware Training
27. Click Yes, I see it when you see the orange box.
28. Expand Mixer Windows.
29. Select the Mixer window.
The Mixer window appears.
After a few seconds, you should now see a fully animated window in your browser!
Wonderware Training
Section 2 Configuring Write-Back for Factory Data Sources 11-37
Section 2 Configuring Write-Back for Factory Data Sources
This section introduces you to the tools and steps necessary to enable write-back capabilities for
factory data sources using the Information Server portal.
Enabling Write-Back Privileges
Information Server allows you to give users write-back privileges, such as a running
WindowViewer application or an I/O Server, when running InTouch browser-based windows. This
allows you to put control of the factory floor onto the Internet by allowing authorized administrators
and engineers to modify certain plant devices through a browser. By default, write-back privileges
are disabled.
Write-back privileges are only available if:
The Information Server site and the default web site of the web server that supply the data
are set to use integrated Windows authentication
You have a separate license that gives you write-back capabilities
The user is in either the Administrator or Engineer roles
WARNING: Enabling write-back allows users to change the state of Plant-floor devices with
potentially LIFE-THREATENING consequences. Use caution when choosing these options.
Configuring Write-Back Options
You can enable write-back for all nodes or just for selected nodes. Know the name of the node
(computer name) before you start. Also, verify that you can connect to the node from the
Information Server portal.
Existing client sessions are not affected by writeback changes until they are terminated and
restarted. The browser must be closed and restarted.
In order to enable write-back, you must complete two important steps as the administrator:
Assign user-privileges (Roles) via the User Manager in the Administration area of
Information Server
Configure write-back options via the License Manager in the Administration area of
Information Server
Note: Only the administrator can configure write-back options and assign user-privileges.
For detailed steps on assigning user-privileges, refer to Securing and Customizing Your Portal
later in this course.
Section Objectives
Introduce the technologies used to assign write-back privileges
Enable write-back for single and multiple factory data sources (Nodes)
Wonderware Training
Lab 22 Configuring Write-Back Access
Introduction
In this part of the lab, you will use the License Manager to enable Tag-Server Write-Back for single
and multiple factory data sources (Nodes).
Objectives
Enable Tag-Server Write-Back
Disable Tag-Server Write-Back
Wonderware Training
Enable Write-Back in Information Server
1. In the System access panel, expand Administration.
2. Click on License Manager.
The License Manager page appears.
3. Click Tag Server Writeback.
Note: You must have a separate license to enable write-back. Confirmation of this license can
be seen in the Active Licenses panel of the License Manager window.
The Tag Server Writeback Configuration panel appears.
Note: Disabled is the default setting. If already set to this mode, the Save button will be
inactive.
4. Click Enabled for ALL tag server nodes.
5. Click the Save button.
A confirmation dialog box appears.
An alert dialog box appears.
Existing client sessions are not affected by writeback changes until they are terminated and
restarted. The browser must be closed and restarted.
8. Click the Logoff link at the top right corner of the page.
9. A confirmation dialog box appears. Click OK. This will close Internet Explorer and terminate
the Information Services client session properly.
10. Open the Windows Services panel from: Start / Control Panel / Administrative Tools /
Services.
Wonderware Training
11. Locate the Wonderware Runtime Database Handler service. Right-click and select Restart.
12. Connect to the Information Server using Internet Explorer.
13. Click on Process Graphics in the left navigation tree.
14. Browse for and display the Mixer window published previously.
15. Click the Open and Close buttons to change the Valve status. Since Writeback is enabled,
you will see the status of the valves change accordingly.
Module 12
Information Server Data Sources
Section 1 Configuring Data Sources 12-3
Section 2 Alarm Database Logger Utility 12-7
Lab 23 Configuring Data Sources 12-11
12-2 Module 12 Information Server Data Sources
Wonderware Training
Section 1 Configuring Data Sources
This section walks you through the tools and steps necessary to add and configure a variety of
data sources.
Configuring Data Sources
Using the Data Source Manager area of Information Server, you can add, modify, and delete the
different data sources used by the Information Server.
About Information Server Data Sources
All external data sources configured for Information Server use a common definition and
configuration, called a shared data source, regardless of the component accessing the database.
Shared data sources are shared by Information Server components such as ActiveFactory reports,
TableWeaver, Factory Alarms, and ArchestrA reporting. This lets you have a single data source
and use it in multiple components.
Modifying Data Sources
Shared data sources are named and configured by the administrator and can then be referred to
by name within Information Server applications. Shared data source names must be unique within
an Information Server installation.
The Data Source Manager includes five predefined data source types:
Alarm
Historian
Production
OLEDB
Other
Each data source type can have multiple named data source instances. However, only one of
each data source instance can be defined as the default. The default data source is used by
ArchestrA Reporting.
Note: The ArchestrA Reporting Services use the default data source for reporting. If the data
source used for reporting is not the default, the report fails. Be careful when changing the Default
Data Source setting.
Section Objectives
Introduce Data Sources available to connect with the Information Server
Introduce steps necessary to add, modify and delete Data Sources
Wonderware Training
The specifics of connecting to data sources will be discussed in detail later in this course. At this
stage of the installation, please keep the following information in mind:
The administrator connecting to data source information needs to know database, user
and server names as well as required passwords
The administrator will be assigning alias names to the data sources. They should be
familiar with the company naming convention(s). The alias name is the name that will be
displayed to the users of the Information Server portal. This is advantageous for security
purposes, since the end user will not see the computer name on the data source
Each data source must be properly configured with the correct connection information in order to
communicate with Information Server. Detailed steps for connecting to each data source type will
be provided in the following lab exercises.
To modify a shared data source:
a. In the System access panel, expand Administration and then click Data Source Manager.
The Data Source Manager window appears.
b. Select the data source that you want to modify in the List Of Data Sources list.
c. Click the Modify button.
The Modify Shared Data Source window appears:
Wonderware Training
d. Configure data source options as required:
Data Source Name: A unique name identifying the data source. The data source name
may be any name you wish (such as PrimaryAlarms or AlarmsTank3) and is not
necessarily the actual database name. No spaces are permitted in the name.
Description: A unique description that helps identify the purpose or function of the data
source.
Server: The server name (such as WWSYSTEMPLATFORM2). The server name is not
preceded by backslashes and no spaces are allowed.
Database: The name of the database as it appears on the server (such as WWALMDB).
No spaces are allowed.
Security Settings:
Select one of the following security settings:
Check the Integrated Security box to enable integrated Windows security for the
data source.
Type the SQL User Name and Password to access the database.
Default for this Data Source Type: A check in this box makes this data source the
default for this data source type. The Default shared data source is the data source used
by the ArchestrA Reports component.
Connection Timeout (in Sec): A value for the connection timeout. 0=No timeout.
Query Timeout (in Sec): A value for the query timeout. 0=No timeout.
e. Click the Test Connection button to verify your new settings.
A confirmation message appears at the bottom of your screen.
f. Click the Save button in the Modify Shared Data Source window of the Data Source
Manager.
The confirmation window appears:
g. Click OK.
Section 2 Alarm Database Logger Utility
This section describes the steps necessary to configure and start the Alarm Database Logger
utility in order to capture historical alarm data for viewing in Information Server.
The InTouch HMI Distributed Alarm Subsystem includes the Alarm DB Logger utility that logs
alarms and events to Microsoft
SQL Server and/or Microsoft
Data Engine (MSDE). It will be

necessary to configure database logging in order to capture data and view historical alarm
information in the next module.
Alarm DB Logger Configuration
Before you begin using the Alarm DB Logger, you must configure your database connection, your
query list, the logging mode and so on. This information is configured via the Alarm DB Logger
Manager.
To Use the Alarm DB Logger Utility
Follow the steps to configure the Alarm DB Logger with your intructor. It will be used in a later lab.
a. Start the Alarm DB Logger Manager: Start / All Programs / Wonderware / InTouch / Alarm
DB Logger Manager
b. Click the Settings button.
Section Objective
Configure the Alarm Database Logger Utility
Introduce the steps necessary to initiate logging to the database
Wonderware Training
The Alarm DB Logger Manager - Configuration dialog box appears.
c. In the SQL Server / MSDE group, click the Server Name arrow to open the listing of available
SQL/MSDE Servers and then select the name of the database server that you want to use.
d. In the User Info group, type in your User Name and Password in the respective entry boxes.
(All Password characters are displayed as ** for security reasons.)
e. Click Test Connection to test your connection to the target database.
f. If the database is not yet created, click Create to create new database/tables on the selected
server.
g. Click Next to access the Alarm DB Logger Manager - Query Selection dialog box.
The Alarm DB Logger Manager - Query Selection dialog box appears.
h. Enter the alarm query string in the Alarm Query entry area.
Note: Multiple query strings may be used. Enter one per line followed by a carriage return.
The Alarm DB Logger Manager - Advanced Setting dialog box appears.
j. Enter the frequency that you want to log alarm data. For example, 1000 m sec will log alarm
data once per second.
k. Click the Finish button.
Wonderware Training
l. The Alarm DB Logger Manager dialog box appears.
m. Click Start to begin logging data to the database for historical viewing.
The number of alarm records in the Smart Cache should begin to update.
Note: You can minimize the Alarm DB Logger Manager as an icon in the system tray.
n. Click the Stop button when you want to end the alarm logging process.
Lab 23 Configuring Data Sources
Introduction
This lab will illustrate the steps necessary to create and configure external data sources for
Information Server.
Objectives
Upon completion of this labyou will be able to:
Create and configure external data sources to be shared inside the Information Server
Add an Alarm Data Source
Add an Historian Data Source
Add an OLEDB Data Source
This lab assumes you completed the instructor-led steps to start the Alarm DB Logger starting on
page 12-7. If you did not, please do so now.
Wonderware Training
Create an Alarm Data Source
2. Click Data Source Manager.
The Data Source Manager appears in the right pane.
3. Click the Add button.
The Add New Shared Data Source page appears.
4. Select Alarm in the Data Source Type drop-down list.
5. Enter the following configuration values into the appropriate entry fields:
Parameter Value
Data Source Name wwAlarms
Description Alarm Data Source for System Platform Part 2 Class
Server Name [Your local computer name]
Database WWALMDB
Integrated Security [Unchecked]
User Name wwUser
Password wwUser
Default for this Data Source [Checked]
Connection Timeout 30
Query Timeout 60
6. Click the Test Connection button.
You should see a confirmation at the bottom of the Data Source Manager page.
7. Click the Save button in the Add New Shared Data Source window of the Data Source
Manager.
The Data Source confirmation dialog box appears.
You have successfully created an Alarm Data Source.
Wonderware Training
Your new Alarm Data Source should now be visible in the List of Data Sources area of the
Data Source Manager.
Note: This data source will be used in Module 13, Factory Alarms, to access alarm data
coming from your Wonderware Application Server Galaxy.
Create a Historian Data Source
9. Click the Add button in the Data Source Manager pane.
10. Select Historian for Data Source Type.
Manager.
Parameter Value
Data Source Name wwHistorian
Description Historian Data Source for System Platform Part 2 Class
Server Name [Your local computer name]
Database Runtime
Integrated Security [Unchecked]
User Name wwUser
Password wwUser
Default for this Data Source [Checked]
Connection Timeout 30
Query Timeout 60
Has HTTP Mode [Unchecked]
URL Connection [Empty]
Wonderware Training
You have successfully created a Historian Data Source.
Your new Historian Data Source should now be visible in the List of Data Sources area of the
Note: This data source will be used in Module 14, ActiveFactory Reporting,to access
History data coming from your Application Server database.
Create an OLEDB Data Source
15. Click the Add button in the Data Source Manager pane.
16. Select OLEDB for Data Source Type.
Enter the following configuration values into the appropriate entry fields:
Note: The USERNAME and PASSWORD entries above are case sensitive, and must be entered
as capital letters.
Manager.
Parameter Value
Data Source Name AdventureWorks
User Name sa
Password [Your instructor will provide the correct password]
Connection String Provider=sqloledb;Data Source=Your local computer name;
Initial Catalog=AdventureWorks;
User Id=#USERNAME#;Password=#PASSWORD#;
Wonderware Training
You have successfully created a OLEDB Data Source to a Microsoft SQL Server Database.
Your new OLEDB Data Source should now be visible in the List of Data Sources area of the
Module 13
Factory Alarms
Section 1 Visualizing Factory Alarms 13-3
Lab 24 Visualizing Factory Alarms 13-7
13-2 Module 13 Factory Alarms
Wonderware Training
Section 1 Visualizing Factory Alarms
This section introduces you to the steps necessary to configure and view current and historical
factory alarms.
Factory alarms let you browse your plant alarm systems, either by querying the live alarm systems
from the alarm providers or the alarm history databases.
Configuring Factory Alarms
Information Server supports both current and historical alarms from configured alarm data
sources. Once Factory Alarms are defined as a shared data sources and have been configured in
the Data Source Manager they may be added as Distributed Alarms in the Factory Alarm
Manager.
Adding Distributed Alarms
To add distributed alarms:
a. In the System access panel, expand Administration and then click Factory Alarm Manager.
Section Objectives
Introduce steps necessary to add and configure current and historical Factory Alarms
Introduce steps necessary to view Factory Alarm data
Wonderware Training
The Alarm Configuration window appears.
b. Click Add Distributed Alarms.
The Alarm Configuration window expands:
c. Enter information into the fields as required:
Alias - Enter the Data Source Name defined in the Data Source Manager
Description - Enter any meaningful identifying information that you choose here
Data Source - Select an alarm shared data source from the drop down list. This is the
connection to your alarm history database
Contact Name - You may optionally add an administrators name in this field
Distributed Alarm Query - Type the query string used to retrieve the current alarm
records from the alarm provider. The Distributed Alarm Query can also be used as a filter.
When a user chooses to see alarms for this provider, he/she only sees the alarms from
the alarm groups specified in this query. You can add as many providers as required, but
you must separate each query with a comma.
Viewing Alarm Data
To view an alarm database:
a. Expand Factory Alarms in the System access panel
If you have configured custom alarm connections, they will be visible in the tree view.
b. Click Factory Alarms.
The Factory Alarms page appears in the right pane.
c. Click Current.
The current InTouch alarms appear.
You will be able to view the alarms, but not acknowledge them.
Wonderware Training
d. Click History.
The historical InTouch alarms appear.
e. Click Configure.
Information Server allows you to configure several display and query options ad hoc.
Lab 24 Visualizing Factory Alarms
Introduction
This lab will illustrate the steps necessary to configure the Factory Alarm Manager and visualize
real time and historical alarms.
Objectives
Configure the Factory Alarm Manager to visualize real time and historical alarms coming
from a galaxy
Configure Distributed Alarms
Query for Real Time Alarms
Query for Historical Alarms
Modify Display Options
Wonderware Training
Configure a Connection to the Galaxy Alarm Provider
2. Click Factory Alarm Manager.
The Factory Alarm Manager appears with the Alarm tab already selected.
3. Click the Add Distributed Alarms button.
The Alarm Configuration page appears.
5. Click the Add button.
You have successfully configured Distributed Alarms.
Parameter Value
Alias Mixer Alarms
Description Alarms from Mixer Application
Data Source wwAlarms
Contact Name [your name]
Distributed Alarm Query \\[your local computer name]\Galaxy!Line1
Your new Distributed Alarm information should now be visible in the Factory Alarm Manager.
Query Real Time Alarms
6. Expand Factory Alarms in the left navigation tree.
7. Click Mixer Alarms.
8. Click Current.
Alarm data shown on this page is for viewing only, you will not be able to acknowledge it.
Wonderware Training
Query Historical Alarms
9. Click History in the Mixer Alarms pane.
The historical alarms coming from your Mixer object in the galaxy appear.
The alarm information displayed has been generated based on the default configuration
parameters in Information Server.
Modify Display Options
10. Click Configure in the Mixer Alarms pane.
The Select Display Properties screen appears.
11. Check Auto Refresh Current Alarms.
12. Change Refresh Interval to 5 seconds. This will automatically refresh the Current Alarms
page every 5 seconds when selected.
13. Change Time Display Options by clicking Last 30 Minutes. This will query the WWALMDB
database for the last 30 minutes of alarm records.
14. Click on the APPLY button.
To see the results of your changes do the following:
15. Click History at the top left of the Mixer Alarms page.
The historical alarms for the last 30 minutes should be displayed.
16. Click Current at the top left of the Mixer Alarms page.
Live Alarm data is now automatically refreshed every 5 seconds.
Wonderware Training
Module 14
ActiveFactory Reporting
Section 2 Reports 14-7
Lab 25 Publishing Trend Reports 14-17
Lab 26 Publishing Workbook Reports 14-25
Lab 27 Publishing Tag and Time Bound Reports 14-31
Section 3 Custom Folders 14-43
Lab 28 Creating Report Folders 14-45
14-2 Module 14 ActiveFactory Reporting
Wonderware Training
Module Objectives
Introduce the ActiveFactory Reporting Website.
Explain Basic Site Navigation.
Explain and Demonstrate Publishing from ActiveFactory Trend and Workbook.
This section provides an overview of the ActiveFactory Reporting Website component of
Information Server.
Overview
The ActiveFactory Reporting Website is a pre configured Information Server component that
allows web users to:
Generate reports using data from Historian databases
Trend history data from Historian
Build and execute SQL queries against data from Historian and other databases
The ActiveFactory Reporting Website can be accessed both directly or through Information Server.
When accessing the site directly, a custom starting page appears from which users can access the
various Reporting Website features. When accessing through Information Server, the Reporting
Website features appear under the ActiveFactory node in the Launch Pad.
Section Objectives
Provide an overview of the ActiveFactory Reporting Website component of Information
Server
Explain the benefits of ActiveFactory Reporting
Explain the functions of the ActiveFactory Reporting
Wonderware Training
Reporting Web Site Benefits
ActiveFactory application users can easily share their work by publishing it to ActiveFactory
Reporting from their desktops.
ActiveFactory Reporting enables published reports to be static, updated on demand, or
automatically updated based on a selected schedule.
Other benefits include:
Data can be presented in context by those who have analyzed it to those who need to
know.
The overall cost of deploying client applications can be significantly reduced.
End users do not need to learn to use the desktop applications. The number of people
benefiting from the information can be dramatically increased.
Provides a secure repository for generated reports at a single location.
Information Server enables the webmaster to create a wide variety of views. For example: on-
demand reports, scheduled reports and interactive sessions.
The Reporting Website section of Information Server can be used immediately after installation.
Reporting Website Functions
The Reporting Website leverages features of the Historian and Microsoft SQL Server.
When Information Server is installed, ActiveFactory Reporting is automatically configured to work
with a specific instance of the Historian.
Information Server ActiveFactory Reporting provides the following:
Reporting Website site files
Report Automation Services: handles content that is published to the site from
ActiveFactory. It also manages scheduled reports.
To understand the concept of publishing it is useful to consider the following functions/terms:
Publishing: Workbook and Trend contain menu commands that publish information to the
Reporting Tables.
The Reporting Tables are created within the Historian Runtime database together with
several other database objects to support publishing. The tables and other objects are
created during the ActiveFactory server-side setup.
Whenever a client publishes from the desktop applications the information is written to
the Reporting Tables.
Report Automati on Services: performs the following:
Retrieves information from the database and writes it to the appropriate place on Web
Server.
Generates .html documents from Workbooks on demand.
Generates .html documents from Workbooks when scheduled
Manages the threads and objects used in report generation.
Archives scheduled reports when configured to do so.
MS SQL Server Agent: triggers the schedules. Schedules in Agent modify the Report
Tables to let the Report Automation Services know what work to perform for that particular
schedule.
The Report Site serves up the documents requested by the users from their browsers. This
includes the generation of trend displays.
Excel Automation
The COM+application is responsible for the automation of Excel. Since Excel requires a real user
account (in contrast to a Local System account), and since the Report Automation Services need
to be able to execute with anybody logged in, the COM+application is configured to run with the
identity of a user who has access to Excel.
Each Reporting Web Site uses one Excel instanced controlled by the COM+app to render
dynamic reports. When the Win32 Service is running, the COM +application uses a separate
Excel instance to create the output of both static and Scheduled Excel reports. The Excel instance
is only created on demand.
Connectivity
When the ActiveFactory Reporting Web Site is installed, an attempt is made to create an alias for
the Historian that uses the TCP/IP network library. If for some reason, this alias cannot be created
and if TCP/IP is not the default network library, alternative network libraries will be used when the
site connects to the Historian.
Typically (but not always), Named-Pipes is available and the ActiveFactory Reporting Web Site will
attempt to use it.
If the network conditions require the use of the Named-Pipes Network Library and if the Historian
is not running on the same machine as the web server, a successful database connection will
depend on whether or not file-level permissions on the Historian machine are granted to the user
account that is attempting to make the database connection.
If you are experiencing database connectivity problems, determine whether or not the user
account under which the web-server is running has sufficient permissions to gain access to the
Historian machine. Please contact your network administrator for further assistance.
Wonderware Training
Section 2 Reports
This section introduces the reporting features available in ActiveFactory Reporting.
Introduction
The Reporting Website includes a number of built-in reports that can be used to view data
from the Historian. These reports are grouped as follows:
Predefined
System Support
Summary Reports
Manual Data Entry
Published Reports
Section Objectives
Introduce the built-in reports that are provided with ActiveFactory Reporting, including:
Predefined
System Support
Summary Reports
Manual Data Entry
Published Reports
Introduce the Trend and Query tools available in ActiveFactory Reporting
Wonderware Training
In addition to built-in reports, ActiveFactory Reporting also includes Trend and Query features,
Online Help, and the ability to select the desired Historian.
Report Options
Different options are available when displaying a built-in report. Options are properties of a report
and change depending on the selected report. Options are configured from within the Options
area beneath the Tag Picker pane.
Report Options include:
Enable report generation on selection: The report automatically runs/refreshes
when you select or change any of the report options.
Generate report in a new window: The report is displayed in a separate browser
window.
For the time options for a query, you will be able to select the current time, a specific
date, or a starting and ending date. For summary detail reports, you will be able to
specify the calculation type.
Publish and Trend Generated Reports
After a report is generated, it can also be published and/or Trended by clicking the Publish Report
button or the Trend Tags in Current Selection button (if applicable). Published
reports are saved in the Published Reports / On Demand Reports folder.
Predefined reports
Several Predefined reports are available upon installation of Information Server:
The Discrete Tag Analysis report, for example, provides a duty cycle analysis for a discrete tag
over a specified time period. The report returns the number of transitions (state changes), the
percentage of time spent in each state, and the total time spent in each state.
The datetime of each transition is also returned.
Wonderware Training
Generate a Predefined Report
Use the following steps to generate a Predefined Report:
a. From the Information Server Launch Pad, expand ActiveFactory / Reports / Predefined.
A list of predefined reports displays.
b. Click the name of the report you wish to generate.
c. Select the tags you wish to include, holding the Control key to select several non-contiguous
tags.
d. Select the date/time range you wish to include.
e. Click the Generate Report button.
The following Predefined Reports are available:
Report Name Tag Selection Description
Alarm History This report supports single, multiple as
well as group selections for the
following tag types: Analog
The Alarm History report provides the user with information
regarding the Datetime and value of when Analog tags
crossed alarm limits configured within Historian for each
Analog tag selected over a specified datetime range. This
report is not accessing information from the InTouch Alarm
Database.
Analog
Aggregation
This report supports single, multiple as
The Analog Aggregation report provides information on the
Minimum, Maximum and Average value of each Analog
tag selected.
Annotations The Annotations report provides the User with the details
of annotations over a specified datetime range. The report
returns annotations for all TagNames.
Discrete Tag
Analysis
This report supports single Discrete
tag selection only. If multiple tags or a
group folder has been selected, it will
only operate on the first Discrete tag in
the list.
The Discrete Tag Analysis Report provides information on
the number of occurrences, duration and percentage of
time a Discrete tag spent in the ON/OFF states.
It also displays the history of the Discrete tag. The report
can be used for Duty Cycle analysis of pumps, motors, etc.
Time in State This report supports single, multiple as
well as group selections for Discrete
tag types.
The Discrete Time in State report provides the user with
time in state values for a Historian Discrete tag(s) over a
specified datetime range.
Event
Snapshot
This report supports only a single tag
selection for the following tag types:
Event.If a group of tags is selected,
only the first Event tag in the group is
used.
The Event Snapshot report provides the User with
snapshot values for a Historian Event tag over a specified
datetime range.
History This report supports single, multiple as
following tag types: Discrete, Analog,
String and Event.
The History report provides the User with the historical
values of a Historian tag(s) over a specified datetime
range.
The report provides information on the Value, Quality and
the Quality Detail of each tag selected.
Tag Value This report supports single, multiple as
String and Event.
This report allows a single datetime selection. The default
selection is now. A specific datetime may be specified.
This report provides information on LastUpdateTime and
the Description of each tag selected.
System Support Reports
Several System Support reports are available upon installation of Information Server:
The Server Status report, for example, provides the user with the health status of the relevant
Historian tag(s) over a specified datetime range.
The following System Support reports are available:
Server Status This report supports single, multiple as
The Server Status report provides the user with the health
status of the relevant Historian tag(s) over a specified
datetime range.
Tag
Configuration
String and Event.
The Tag Configuration report provides the user with the
configuration values of a Historian tag(s).
Web Client
Information
String and Event.
The Web Client Information report provides the user with
Reporting Website Version Information including the
version number, build level, patch level, browser support,
Historian machine name, Historian version, and so on.
Wonderware Training
Summary Reports
Summary Reports are available upon installation of Information Server:
The following Summary Reports are available:
Summary
Configuration
The Summary Configuration report displays configured
summary information for an analog tag.
Summary
Detail
following tag types: Event
The Summary Detail report displays the operation details
for a summary event tag.
Manual Data Entry
Manual Data Entry allows users with the proper privileges to manually insert a value for a selected
tag(s) for a selected date/time. Inserted values will be stamped as latest data.
a. Select the Manual Data Entry link in the ActiveFactory / Reports folder.
The Manual Data Entry interface displays.
b. Select the appropriate Tag Name(s) and date/time.
c. Click Generate Report.
d. Enter the desired tag value(s) in the New Value field
e. Click Insert.
Wonderware Training
Published Reports and Trends
ActiveFactory application users can easily share their work by publishing it to ActiveFactory
Reporting from their desktops. ActiveFactory Reports enables published reports to be static,
updated on demand, or automatically updated based on a selected schedule. Publishing can be
performed from any system running ActiveFactory to any Information Server.
Two general types of publishing are available.
Static Report: document that is published once and then served up with the same data to
each user that requests the document.
Dynamic Report: A dynamically published document is one that will be generated
repeatedly after publishing with new data.
There are two types of Dynamic Reports:
On Demand Documents: Documents generate new data each time a user requests
the document.
Scheduled Documents: Documents are automatically generated according to a pre-
determined schedule. The Reporting Web Site includes a very sophisticated
scheduling mechanism that can be customized to support almost any degree of
complexity.
Trend
a. Select the Trend link in the ActiveFactory / Reports folder.
b. The aaHistClientTrend control is loaded into the page and is ready for use (the following figure
shows a pre-configured trend):
The Trend Page is a built-in report that will open the aaHistClientTrend ActiveX control. If you
do not have the aaHistClientTrend ActiveX control installed you will be prompted to download
it.
The aaHistClientTrend ActiveX control will only prompt for download if the Reporting Website
detects:
The browser supports downloading/running ActiveX controls; and
The browser can connect to the Historian directly (needed for aaHistClientTrend).
If the browser cannot connect directly to the Historian, the Reporting Website will automatically
create an image of the trend window as an html page (with embedded graphic).
This happens for published trends but not the for the Trend Page which is for ad hoc trending.
Wonderware Training
Query
a. Select the Query link in the ActiveFactory / Reports folder.
The Query Page allows aaHistClientQuery to be used on an ad hoc basis.
If the aaHistClientQuery ActiveX control is not installed, the Reporting Website will prompt for
it to be downloaded.
This will only happen if the Reporting Website detects that the browser can connect directly to
the Historian.
Lab 25 Publishing Trend Reports
Introduction
In this lab, we will publish Static and Dynamic Trend reports from the ActiveFactory application and
view them in Information Server.
Objective
Publish and view a Static Trend Report
Publish and view a Dynamic Trend Report
Wonderware Training
Publish a Static Trend Report
1. Open ActiveFactory Trend.
2. Click File / Open from the menubar and browse to the Mixer.aaTrend trend that you created
in Module 4 - Lab 5, Configure Public Groups and Trend Sets, located in C:\Wonderware
Training\Labs.
The Mixer.aaTrend window opens. Trend data should be displayed on the graph.
3. Select File / Publish / Static Trend from the main Trend toolbar.
The Publish dialog box appears.
4. Verify that Server and Report Site point to your local Historian and your local Information
Server respectively.
The ActiveFactoryWebsite notifies the user of the publishing status:
6. Click the Done button.
Wonderware Training
Viewing Published Static Trend
7. Connect to Information Server using Microsoft Internet Explorer.
8. Expand the ActiveFactory menu.
9. Expand Reports.
10. Expand Published Reports.
11. Expand Static Reports.
12. Click on Mixer.
Mixer is the static report that you published in the previous steps.
Static trend data for the Mixer is now displayed in the Information Server.
Create and Publish a Dynamic Trend Report
13. Switch to ActiveFactory Trend.
14. Create a new trend.
Double-click on the following tag names in the Tags pane to add them to the trend.
LIT_001.PV
InletValve_001.PV
15. Configure the time range to display the last 30 minutes.
16. Click the Stack Tag Traces icon to change the display to a Stacked format.
START TIME CURRENT TIME MOST RECENT # MINUTES
Wonderware Training
The new trend should look like the following figure:
17. Save the new trend as DynamicMixer.aaTrend in the C:\Wonderware Training\Labs folder.
18. Publish the new trend by selecting File / Publish / Dynamic Trend from the Trend menubar.
The Publish Report dialog box appears.
19. Verify that Server and Report Site point to your local Historian and your local Information
Server respectively.
20. Confirm that On demand is selected for the Report type.
21. Check all the boxes in the Lock down options area of this dialog box.
22. Click OK.
A confirmation dialog box appears indicating that the dynamic Trend report was successfully
published.
24. Return to Information Server.
25. Expand ActiveFactory in the left navigation tree.
26. Expand Reports.
27. Expand Published Reports.
28. Expand On Demand Reports.
Wonderware Training
29. Click DynamicMixer to generate the dynamic trend report.
The trend appears:
All the functionality that you specified through the check boxes when you published this
dynamic report from ActiveFactory Trend is available in the Information Server.
30. Modify a few parameters in the Trend to verify it is fully functional.
Lab 26 Publishing Workbook Reports
Introduction
This lab demonstrates publishing Static and Dynamic Excel reports to the Information Server using
the ActiveFactory Workbook application.
Objective
Publish Workbook-generated reports to Information Server.
Publish a Static Workbook Report
Publish a Dynamic Workbook Report
Publish a Scheduled Workbook Report
Wonderware Training
Publish a Static Workbook Report
1. Start Excel.
2. Open the ShiftAvg_DataAcq.xls file created previously in Lab 11, Create an Hourly-Average
Shift Report. (C:\Wonderware Training\Labs).
3. From the Excel ActiveFactory menu select Publish / Static Report.
4. The Publish Report dialog box appears.
A confirmation dialog box appears indicating that the static Workbook report was successfully
published.
6. Click the Browse button to connect to Information Server and view the report.
Information Server opens.
7. Expand the left navigation tree: ActiveFactory / Reports / Published Reports / Static
Reports.
8. Click ShiftAvg_DataAcq.
The report displays within the main report page.
Wonderware Training
Publish a Dynamic Workbook Report
9. Return to Excel and open the MyReport.xls file you created in Lab 8, Using ActiveFactory
Workbook Basic Functions (C:\Wonderware Training\Labs).
10. Select ActiveFactory / Publish / Dynamic Report.
11. Confirm the On Demand option is selected.
A confirmation dialog box appears indicating that the dynamic Workbook report was
successfully published.
15. Expand the left navigation tree: ActiveFactory / Reports / Published Reports / On Demand
Reports.
16. Click MyReport.
The MyReport window pane opens in the center portion of the screen.
17. Click the Generate report button.
Wonderware Training
18. The report appears in the right-hand pane of the report page:
19. Click the Generate Report button again to see the columns dynamically update with the most
recent data.
Publish a Scheduled Workbook Report
20. Return to the MyReport.xls file in Excel.
21. Publish MyReport: Select ActiveFactory / Publish / Dynamic Report.
22. Click the Scheduled option.
23. Select Every 15 minutes in the Schedules drop-down list.
24. Check the Run now checkbox.
A confirmation dialog box appears indicating that the dynamic Workbook report was
successfully published.
27. Return to Information Server and verify the report was generated.
Lab 27 Publishing Tag and Time Bound
Reports
Introduction
This lab demonstrates the steps necessary to publish Tag and Dynamic Excel reports to the
Information Server using the ActiveFactory Workbook application.
Objective
Configure and publish both Time-bound and Tag-bound reports and view them in
Information Server
Configure, Publish and View a Tag-Bound Report
Configure, Publish and View a Time-Bound Report.
Wonderware Training
Configure, Publish and View a Tag Bound Report
1. Open Microsoft Excel and create a new blank workbook.
2. Click the Live Values icon on the Excel toolbar.
3. Check Support multiple data types option.
4. Click the Binding Options button.
An additional option appears in the dialog box.
5. Select Use bounds tags in the range named AFTagBinding of type: option.
6. Ensure All is selected in the above-referenced drop-down field.
Note: This option ensures that all tag types can be browsed from within ActiveFactory
Reports.
The AFBindings confirmation dialog box appears.
Wonderware Training
9. Confirm the value in Select cell for output: field is $A$1.
11. Check the Tag name and Date time options.
12. Uncheck any other options that may be selected.
13. Click the Finish button.
The default tag information (from the named range in AFBindings) appears, beginning at cell
A1.
14. From the Excel menu bar select File / Save As.
15. Save the spreadsheet as MyReport_TT in the C:\Wonderware Training\Labs folder.
16. From the Excel menu bar select ActiveFactory / Publish / Dynamic Report....
A confirmation dialog box appears indicating that MyReport_TT was successfully published to
the server.
20. Expand the left navigation tree:
ActiveFactory / Reports / Published Reports / On Demand Reports
21. Click MyReport_TT.
The Tag Picker pane appears in the center of your screen.
22. Expand the Public Groups / All Analog Tags folder located under the Historian server.
23. Click on TT_001.PV in the lower window pane.
Wonderware Training
24. Click the Generate Report button.
The temperature meter value is inserted into the Tag Bound output cell:
To illustrate how you can mix different signal types (analog, discrete and string) in the same
report, do the following:
25. In the Tag Picker pane expand Public Groups / WWGalaxy / Plant / Production / Line1 /
Mixer_XX0, where XX is your student number.
26. Click on InletValve_001 [InletValve]
27. Click the All tab to select all signals coming from InletValve_001 and select all the tags in the
list.
28. Click the Generate report button.
All the signals from the InletValve_001 object appear as live values:
Wonderware Training
Configure, Publish and View a Time Bound Report
29. Return to Excel.
30. If not already open, open MyReport_TT created in the previous section of this lab.
31. Double-click the Sheet1 tab at the bottom of the Excel window and rename it LiveData.
32. Double-click the Sheet2 tab at the bottom of the Excel window and rename it HistData.
33. Click on the HistData tab if it is not already selected, and select the cell A1.
34. Click on the History values icon in the Excel Workbook toolbar.
Note: The Binding Options appear automatically. Excel 'remembers' that the binding option
was previously selected during the same session with a different file.
35. Click the Next button
36. Confirm that Select cell for output: is $A$1 (cell A1 of the HistData sheet).
38. Click on the Retrieval tab.
39. Change the number in Values over equal time intervals to 25.
41. Click on the Bound Times option. This option will let you specify the start and end times
dynamically using the time bar in Information Server.
42. Click Finish.
Wonderware Training
43. On the Excel menu bar click File / Save As.
44. Save the report as MyReport_TT2 in the C:\Wonderware Training\Labs folder.
45. On the Excel menu bar select ActiveFactory / Publish / Dynamic Report...
The Publish Report dialog box opens.
46. Confirm that On demand is selected.
A confirmation dialog box appears indicating that MyReport_TT2 was successfully published
to the server.
50. Expand the left navigation tree:
ActiveFactory / Reports / Published Reports / On Demand Reports
51. Click MyReport_TT2.
The MyReport_TT2 Tag Picker window opens in the middle of the screen.
If necessary, scroll down in the Tag Picker window to view Options.
Notice that the Time selection options are now visible.
52. Select 1 hour from the interval drop-down list.
This will display data for the most recent 1-hour period.
53. Click on TT_001.PV from the Tag Picker list.
54. Click the Generate Report button.
Wonderware Training
55. Click on the LiveData tab at the bottom of the of the right-hand pane.
Live data for TT_001.PV tag displays in the right hand pane.
56. Click on the HistData tab at the bottom of the of the right-hand pane.
The History report includes 25 rows of evenly-spaced data for the TT_001.PV tag for the most
recent hour.
Section 3 Custom Folders 14-43
Section 3 Custom Folders
This section explains how to add custom report folders, static report folders and subfolders, and
how to publish reports to custom folders.
Introduction
The Reporting Website is easily administered. This section explains:
Adding Static Folders: Additional Static Folders give you an easy way to organize
reports that are published from Trend or Workbook as 'static'.
By default, all static reports are saved to the following folder:
<installation_path>\<report_website_name>\Output\Static
All on demand reports are saved to the following folder:
<installation_path>\<report_website_name>\Output\OnDemand
Creating a custom folder for reports involves editing an XML file to include the report names and
descriptions. You can add multiple report folders, as well as nest folders within one another to
create an organized method of storing Static and OnDemand reports. Once folders are created,
Trend Reports and Workbook Reports can be published to the folders. Only after a report is
published to a new folder will that folder be visible on the ActiveFactory Reporting Website.
It is important to plan the folders and subfolders carefully before implementation. Once the folders
are created, several steps must be taken to make desired modifications.
.
Section Objectives
Explain adding custom report folders.
Create Static Report Folders and Subfolders.
Publish Trend Reports and Workbook Reports to Custom Folders.
Wonderware Training
Lab 28 Creating Report Folders
Introduction
In this lab you will create folders and sub-folders in the Static reporting folder. You will then publish
several reports to those folders, and view the results in the Information Server.
The folder hierarchy will be as follows:
Static
Mixer Reports
Trend Reports
Workbook Reports
System Reports
Trend Reports
Workbook Reports
Objective
Create report folders and sub-folders for the ActiveFactory Reporting Website
Edit the Configuration.config XML file
Publish reports to the custom folders
Stop and restart the HistClientReporting Service
View reports published to the custom folders
Wonderware Training
Edit the Configuration.config file
1. Open Windows Explorer.
2. Browse to the C:\Inetpub\wwwroot\AFweb folder.
3. Right-click the Configuration.config file.
4. Select Open With / NotePad from the context menus.
The Configuration.xml file displays in NotePad.
5. Select Edit / Find
6. Enter SCHEDULEDREPORTPATHS in the Find what field and click the Find Next button.
The first instance of SCHEDULEDREPORTPATHS is highlighted.
7. Click the Find Next button again to find the second instance of
SCHEDULEDREPORTPATHS.
8. Click Cancel to close the Find what window.
The second instance of SCHEDULEDREPORTPATHS is now highlighted.
9. Place your cursor at the beginning of the line beneath </SCHEDULEDREPORTPATHS> and
press the Enter key a few times to add a few blank lines to the file.
The file should now look like this:
2nd Instance
Add Extra Lines
Wonderware Training
10. From Windows Explorer locate the CustomReportFolders.txt file in the C:\Wonderware
Training folder.
11. Right-click CustomReportFolders.txt and select Open With / NotePad.
CustomReportFolders.txt opens.
12. Select Edit / Select All to highlight all the text.
13. Right-click and select Copy from the context menu.
14. Return to the Configuration.config file.
Wonderware Training
15. Position your cursor in the space you made earlier then right-click and select Paste from the
context menu.
Cursor location
Extra
Lines
Added
The text you copied from CustomReportFolders.txt appears in the Configuration.config XML
file as shown below.
16. Select File / Save from the NotePad menu bar to save the changes that you made to
Configuration.config.
17. Select File / Exit to close both the Configuration.config file and the CustomReportFolders.txt
file and end your NotePad session.
Wonderware Training
Stop and Start the aaHistClientReporting Service
It will be necessary to stop and restart the aaHistClientReportingService for the changes you
made to the Configuration file to take effect.
18. Open the Services utility program: Select Start / Control Panel / Administrative Tools /
Services.
The Services window displays.
19. Right-click aaHistClientReportingService
20. Select Stop from the context menu.
21. Right-click again on aaHistClientReportingService and select Start.
22. Close the Services utility.
Publish Reports to Custom Folders
23. Open the Mixer.aaTrend report you created in Lab 25, Publishing Trend Reports in the
C:\Wonderware Training\Labs folder.
The ActiveFactory Trend window opens.
24. Select File / Publish / Static Trend from the menu bar.
The Publish Report dialog box opens.
25. Click the Folder: down-arrow to display the available folders from the drop down list.
The folders you added to the Configuration.config file display.
26. Select the MIXER TREND REPORTS folder.
The Report successfully published dialog box appears.
Wonderware Training
30. Open the report in the new custom folder you created by selecting the following in the left
navigation tree:
ActiveFactory / Reports / Published Reports / Static Reports / MIXERREPORTS / TREND
and click Mixer.
.
31. The published report will display from the new custom folders you created.
Note: Though you defined several custom folders in the Configuration.config file, the only custom
folders that appear are those used for published reports (in this case MIXERREPORTS / TREND).
32. Publish another report in a different custom folder to see that custom folder display in the
menu tree.
New
Folders
Module 15
Table Weaver
Section 2 Defining Queries 15-9
Section 3 Defining Content Units 15-15
Lab 29 Define a Content Unit 15-19
Section 4 Defining Displays 15-27
Lab 30 Add Custom Displays to the Content Unit 15-33
Section 5 Defining Key Performance Indicators (KPIs) 15-45
Lab 31 Add KPIs to the Content Unit 15-49
Section 6 Defining Links 15-57
Lab 32 Add Links to the Content Unit 15-61
Lab 33 Create a Filter Query 15-73
15-2 Module 15 Table Weaver
Wonderware Training
This section introduces the Information Server Table Weaver add-on application. Table Weaver
provides a table and chart display with customizable queries and drill-down capabilities.
The Table Weaver feature makes it easy to present and navigate information from databases and
related web pages. It provides you with the building blocks for customizing contents, allowing you
to establish content relationships, provide contextual navigation, and configure information
displays in multiple formats. The Table Weaver Manager consists of six components, each giving
you the flexibility to build the content according to your needs.
The Table Weaver Manager consists of the following components:
Content Units
Data Sources
Queries
Displays
Links
Key Performance Indicators (KPIs)
Each Table Weaver Manager component is separated into its own subsection in the Table Weaver
Manager node. For each subsection, you can define the content for the specific definition unit. A
definition unit is the term Information Server uses to refer to the configuration for each Table
Waver Component.
Section Objectives
Introduce the Table Weaver.
Introduce Definition Units.
Wonderware Training
The Table Weaver Manager is accessed from the Administration link in the System Launch Pad of
the Information Server portal.
Each component is defined to build the Content Unit component which brings all the defined
settings into one access point. These components are defined independently to make it easy to
reuse portions of definition units across multiple Content Unit definitions.
Datasource and Query definition units are required to define a Content Unit. The Datasource
definition defines the source of data or information. The query defines the conditions to retrieve the
data from the Datasource. These definition units can define a Content Unit that will display the
result in a display format or as XML by default.
Display formats are defined in the Display definition unit. It defines how the portal user will
visualize data retrieved. The display types supported are:
Chart
Tabular
Web Content
Filter Entry
Each Display type contains its own set of configuration options that allow you to customize the
display. For example, the Sales Per Category chart and table are both configured from the same
data source and query, but the different display format configurations provide different
representations of the content.
Display, Link, and KPIs are optional components. Links provide more navigation between a
Content Unit and other contents. They provide related information regarding the selected item.
KPIs are visual indicators that express a value as either a color or an icon. Each KPI has one or
more targets with its own set of target conditions that display visual indicators when the target
condition is met. A KPI is typically applied to a subset of the data retrieved based on a defined
parameter.
Note: Note After clicking a Table Weaver component, the URL link is stored in the Internet
Explorer History browser.
Wonderware Training
Common Definition Unit Options
All Table Weaver definition unit pages contain a common set of options. The following table
provides a brief description of each option.
Creating a New Folder
You can organize definition units by creating folders. As you define different definition units,
storing definition units within folders makes it easier to later find what you are looking for.
To create a new folder
a. In the System access panel, expand Administration and then click Table Weaver Manager.
The Table Weaver Manager page appears.
b. Select a Table Weaver definition unit page, Displays, for example.
The corresponding definition unit list page appears.
c. Click New Folder.
The New Folder section appears.
User Option Description
New Folder Creates a new folder in the current definition list page.
New Create a new definition unit.
Delete Deletes the selected definition unit(s) and/or folder(s).
Copy Copies the selected definition unit. Copies can be placed in the same or
different folder.
Cancel Cancels all actions and returns to the parent page.
Save Saves changes for a new or existing definition unit. A dialog box will appear to
confirm the save or inform you of missing information that is required.
Reset Resets all properties to their original values.
d. In the Folder Name box, type a name for the folder.
This name will appear on the definition unit list page.
The folder name must be unique in the current folder and cannot contain spaces or special
characters (\ / : * ? <>& | ' ").
e. Click Save.
Deleting a Folder
To delete a folder
a. In the System access panel, expand Administration and then click Table Weaver Manager.
b. Select a Table Weaver definition unit page.
The corresponding definition unit list page appears.
c. Select the check box next to the folder(s) you want to delete.
You can delete folder(s) and definition unit ID(s) at the same time.
d. Click Delete. You will be prompted to verify the deletion.
e. Click OK.
Wonderware Training
Section 2 Defining Queries
This section uses the Query function of the Table Weaver to define queries for a specific data
source type.
A query contains the information necessary to extract data from a specific data source. A Query is
related to one of the various data source types registered with the Portal infrastructure. By
definition, the Query is associated with a certain data source type, since each data source has its
own requirements to return the requested data.
For example, a query includes the data source type (database or web content), SQL statement,
and parameters to pass. A query is one of the two mandatory definition units required to define a
Content Unit.
To use a query in a Content Unit, there must be a corresponding data source with the same type.
Use a database query with a database data source, and a web content query with a web content
data source. Database and web content queries allow parameter variables to be passed to the
query or data source.
Defining a Query
To define a query
a. Expand the Administration link in the System access panel.
Click Table Weaver Manager.
b. Click Query.
The Query List page appears.
c. Click New.
The Query page appears.
d. Select a data source type in the Data Source Type list.
The properties from the selected data source type appear.
Defining a Database Query
A database query includes information such as the data source, the query ID, and the SQL
statement, which will be executed against the database. Parameters can be defined for the query
that can be dynamically populated at execution time.
To define a database query
a. Click Database in the Data Source Type list.
The ODBC Query Properties area appears.
b. Enter a name for the query in the Query ID box.
The name must be unique in the current folder and not contain spaces or special characters
(\ / : * ? <>& | ' "). This name will appear in the Query List page.
c. Enter a description for the query in the Description box.
This description will appear in the Query List page.
Section Objectives
Define SQL Server database queries to be used in a Table Weaver Content Unit.
Wonderware Training
d. Enter a script or statement in the SQL Query box to be executed by the database.
e. Enter a caption in the Field Captions box that will replace the field name which is provided by
the data source. Captions must be separated by a semicolon.
If the Field Captions box is left blank, the field name provided by the data source will be used.
Information will be taken in the same order as provided by data source.
Another option is to set the field caption in the SQL query.
Most OLE DB providers support using the AS clause within the query to set the displayed
name.
For example, the following SQL query from the AdventureWorks database will include the
field caption name within the query:
SELECT Pr oduct I d as [ Pr oduct I D] , Suppl i er I d as [ Suppl i er ] , Uni t Pr i ce as
[ Pr i ce]
FROM Pr oduct s
f. Enter a numeric value in the Page Size box to limit the number of records that are returned
from the result.
For example, if the numeric value 10 is typed in the box, only the first 10 records are returned.
The page size is only considered if the value is a positive number.
This option has precedence over the Transact SQL's TOP functionality.
For example, the following Transact SQL query with page size set to 10 would only return the
first 10 records of the query result.
SELECT TOP 10 *
FROM pr oduct s
g. Configure the values in the Parameters area, to be passed through the parameters defined in
the SQL Query.
Note: Parameter names are case sensitive.

Note: It is possible to have multiple name-value parameter pairs.
Click More to add more parameters.
h. Click Save.
Name Name of the parameter in the SQL query.
Value Value that you want to pass in the parameter. This is the default value for a database
query parameter. It can be replaced by the value configured in a link parameter.
Examples of Database Queries
The database query allows you to pass parameters defined in the query.
For example, you want to create a query that retrieves the product names that start with a "c"
using data from the Products table in the AdventureWorks database. You would type in the
following values for the configuration options:
SQL Query:
SELECT *
FROM Pr oduct s
WHERE Pr oduct Name Li ke ' #I D#'
Parameter Name: I D
Parameter Value: c%. With no other defined parameters, the runtime query will be:
SELECT *
FROM Pr oduct s
WHERE Pr oduct Name Li ke ' c%'
Defining a Web Content Query
The web content query allows you to configure a query to retrieve content from the Web.
The web content can either be in the form of web pages or a list of URL links.
To define a Web Content query
a. Click Web Content in the Data Source Type list.
The Web Link Definition area appears.
b. Enter a name for the query in the ID box.
The name must be unique in the current folder and not contain spaces or special characters
(\ / : * ? <>& | ' "). This name will appear in the Query list page.
c. Enter a description for the query in the Description box.
This description will appear in the Query list page.
d. Select List or Page in the Link Type list to define the link type.
A List link type defines the link as a link, allowing multiple web content links within a query
definition.
A Page link type defines the link as content, allowing only one link definition per query.
Wonderware Training
Defining a Page Link Type
To define a page link type
a. The Web Link Definition area selects Page as the Link Type by default.
The Link Definition area appears.
b. Select GET or POST in the Method list for the http method of the link.
c. Type the http URL of the link in the URL box.
d. Enter the name and value of the parameter to pass to the URL in the optional Parameters
area.
Parameters for the GET method are passed as a query string.
Parameters for the POST method are passed as a form post.
Click More to add more parameters to the query.
e. Click Save.
Defining a List Link Type
The web content query differs from the Custom Links feature configured under Portal
Configuration because it allows parameter passing and includes the POST method to retrieve the
web link.
To define a list link type
a. Select List from the Link Type list.
b. Click Save.
The Web Link Collection area appears.
c. Click New Link.
d. Enter a name for the link in the Name box.
This name will appear in the web link collection for the defined web query.
e. Click GET or POST in the Method list for the http method of the link.
f. Type the http URL of the link in the URL box.
g. Enter the name and value of the parameter to pass to the URL in the optional Parameters
box.
Parameters for the GET method are passed as query a string. Parameters for the POST
method are passed as a form post.
Click More to add more parameters to the query.
h. Click Save.
Click New Link from the Web Link Collection area to add more links.
Examples of Web Content Queries
For web content queries that use the list type, you can define multiple links in a query definition.
For example, you want to define a list of links of search engines. You would type the following
values for the configuration options:
Link Type: Li st
Method: GET
URL: ht t p: / / www. googl e. com/ sear ch
Click New Link in the Web Link Collection properties to add another link to the web content
query.
The Link Type list is unavailable because the query definition is already defined as a list type.
There is no limit to the number of links defined in a web content query. The web content display of
the web links will display the links in a list.
With an appropriate Datasource and Display, this query will display a tabular list of all links defined
in the query. Each link is identified by the name specified in the query. Clicking on any item in the
list will launch the respective content.
For web content queries that use the page link type, only one link definition can be defined in a
web content query.
For example, you want to show the content of the Google search page in the French language
through the Information Server Table Weaver. You would type in the following values for the
configuration options:
Link Type: Page
Method: GET
URL: ht t p: / / www. googl e. com/ sear ch
Parameter Name: hl
Parameter Value: f r
With an appropriate Content Unit and Display, this query will display the Google search page in
French.
Wonderware Training
Section 3 Defining Content Units
This section uses the Content Unit area of the Table Weaver Manager to select the Data Source,
Query, Display, Link, and KPI definitions to define a Content Unit. You will define a Content Unit.
About Content Units
A Content Unit is a collection of previously-defined elements including:
Datasource (required)
Query (required)
Link (optional)
Display (optional)
KPI (optional)
It is the core definition item of Table Weaver Manager. The Content Unit is self-contained and
ready for processing to render content to its portal users.
Defining a Content Unit
A Content Unit requires a Datasource and Query definition.
Other Table Weaver Manager definition units are options that enhance the display of the content.
To define a Content Unit
b. Click Content Unit.
The Content Unit List page appears.
c. Click New.
The Content Unit page appears.
d. Enter a name for the Content Unit in the Content Unit ID box.
The Content Unit ID must be unique in the current folder and cannot have spaces or special
characters (\ / ? & : ""<>| * %). This name will appear on the Content Unit List page.
e. Enter a description for the Content Unit in the Description box.
This description will appear on the Content Unit List page and on the Table Weaver navigation
panel. Portal users can see the description(s) of the Content Unit(s) on the Table Weaver
navigation panel.
Section Objectives
Define a Content Unit.
Select a Data Source, a Query, a Display, a Link Collection, and a KPI Collection for a
Content Unit.
Wonderware Training
f. Select the data source to link to the Content Unit in the Data Source list.
The data source list contains all defined data sources from the data source definition. You can
edit the selected data source using the Browse button placed next to the Data Source list.
Note: You can edit definition components (data source, query, link, display, KPI) by using the
Browse button placed next to each definition component list.
g. Select the query to link to the Content Unit in the Query list.
The query list contains all defined queries from the query definition.
The selected data source and query must belong to the same data source type.
h. Select the link collection to attach to the Content Unit in the Link Collection list.
The link collection list contains all defined links from the link collection definition.
The selected link should match the selected data source and query combination.
i. Select the display definition to link to the Content Unit in the Display list.
The display list contains all defined displays from the display definition. When no display is
selected, the Content Unit displays the data in XML.
Note: Web content displays must be used for web content data sources and queries.
Table and chart displays can be used for database data sources and queries, but the data for
chart displays must include the selected columns.
j. Select the KPI collection to attach to the Content Unit in the KPI Collection list.
The selected KPI collection contains individual KPIs with target conditions for the specific
Content Unit.
The selected link and KPI definitions should match the selected data source and query
combination.
k. Select alternative displays for the Content Unit in the Alternative Display list.
The alternative display allows you to view your Content Unit in different display formats.
You must use the double right arrow button to move the selected display format name(s) into
the alternative display box.
For example, the Sales Per Category Content Unit displays a chart with an alternative tabular
display available for the same content.
l. Select the Display.
Click Attach Image to attach an image to the selected display format(s).
The Select an Image window appears.
m. Select an image from the list in the Image Library or upload your own image.
Only images with an extension of .gif, .jpg, .jpeg are allowed to be uploaded.
There is no limit on the size of uploaded images.
The uploaded images are stored in
/<SuiteVoyager Virtual Directory>/useng/main/contentbuilder/Imagelib.
Previews for both the images from the list and an uploaded image can be viewed in the box to
the right of the list.
Click OK to attach the image as an icon for the selected alternative display.
n. Select the Primary check box to specify the Content Unit as a Primary Content Unit.
Only Primary Content Units are listed in the Table Weaver navigation panel. A primary
Content Unit is a Content Unit that is self-contained and does not require any information from
other Content Units.
Secondary Content Units require parameter values from an associated link collection and are
only accessed by "drilling through" from another Content Unit.
The Primary check box is selected by default.
Note: You must refresh the Table Weaver node on the navigation panel to view newly
created Content Unit folders and/or Primary Content Units.
o. Enter a numeric value in the Refresh Timing box to indicate the time interval (seconds) to
refresh the Content Unit.
The browser will refresh the content automatically based on the refresh timing value.
If the box is left blank, the browser will not refresh.
p. Click Save.
Wonderware Training
Lab 29 Define a Content Unit
Introduction
The goal of this lab is to build a Content Unit. To do this, you will first create a Data Source and a
Query, two requirements for a Content Unit.
In later labs, you will enhance this Content Unit by adding Displays, Key Performance Indicators
and Links.
Note: Several of the queries are longer and not all lines are visible without scrolling. Tables have
been included in addition to the screen captures to display the full queries.
Objectives
Define a Query called AnalogLive
Define a Content Unit called AnalogLive
Preview the AnalogLive Content Unit
Wonderware Training
Define a Query
The first step to create a content unit is to define a query to retrieve the data that will be shown. In
the next few steps you will create a query to gather detailed information about the tags created in
your Historian, along with the Live values for those tags.
1. Expand the Administration link in the navigation tree.
2. Click Table Weaver Manager.
3. Click Query.
4. Click the New Folder button.
5. Enter SystemPlatform for Folder Name.
7. Click the SystemPlatform link to access the SystemPlatform folder.
8. Click the New button.
Wonderware Training
The Define Query properties appear.
9. Select Database for the Data Source Type in the drop-down list.
10. Enter the following properties into the ODBC Query Property fields. Your instructor will
provide the SQL Query text file.
11. Click the Save button after entering the appropriate values.
Parameter Value
Query ID AnalogLive
Description Analog Tag Live Values
SQL Query SELECT Tag. Tagname, Tag. Descr i pt i on, Engi neer i ngUni t . Uni t ,
Anal ogTag. Mi nEU, Anal ogTag. MaxEU, Li ve. Val ue,
Li ve. Dat et i me, Li ve. Qual i t ydet ai l ,
( Anal ogTag. MaxEU- Anal ogTag. Mi nEU) * 0. 1 +
Anal ogTag. Mi nEu as LoLi mi t , ( Anal ogTag. MaxEU -
Anal ogTag. Mi nEU) * 0. 7 + Anal ogTag. Mi nEU as Hi Li mi t
FROM Tag, Anal ogTag, Li ve, Engi neer i ngUni t
WHERE Tag. Tagname = Anal ogTag. Tagname
AND Anal ogTag. EUKey = Engi neer i ngUni t . EUKey
AND Li ve. Tagname = Anal ogTag. Tagname
AND Li ve. Val ue I S NOT NULL
ORDER BY Tag. Tagname ASC
The Save completed dialog box appears.
Define a Content Unit
Next you will create a Content Unit using the previously defined Query, and a predefined Table
Display.
13. Expand the Administration link in the navigation tree.
14. Click Table Weaver Manager.
15. Click Content Unit.
Wonderware Training
17. Enter SystemPlatform for Folder Name.
SystemPlatform is added to the Content Unit List.
The Content Unit Definition page appears.
21. Enter (or select from the drop-down lists) the following properties:
22. Click the Save button after entering the appropriate values.
24. Click the Preview button.
Parameter Value
Content Unit ID AnalogTagLive
Description Analog Tag Live Values
Data Source wwHistorian
Query \SystemPlatform\AnalogLive
Display Table
Wonderware Training
The Analog Tag Live Values data appears in a new full-screen window. Notice the Content
Unit displays detailed information like Description and Engineering Units along with the current
live value, calculated Low Limit and the calculated High Limit.
25. Use the Scroll bars to view all the contents of this window.
26. Close the Analog Tag Live Values window when finished.
Note: Since the preview window opens a full-screen pop-up window, closing it does not effect
the Information Server window below.
Section 4 Defining Displays
This section introduces the Display component of the Table Weaver and uses it to define a table
and a chart display. You will add a Display component to a Content Unit.
Displays define the visual presentation of the data returned by a query. They transform the raw
data returned by the query into a graphical representation, which is then displayed to the portal
user. You can configure different types of displays supported by Table Weaver to display the
content of the Content Unit.
About Displays
Table Weaver displays support:
Hyperlinks to related information
Value-based color or image selection (KPIs)
Reusable and parameterized queries
Web data sources
The Data Table and Charting applications provide a subset of Table Weaver functionality. They
are much simpler applications and connect to data sources in a different way.
Information Server 3.0 provides the following display types:
Chart
Table
Filter Entry
Web Content
Defining a Display
To define a display
a. Expand the Administration link in the System access panel
b. Click Display.
The Display List page appears.
c. Click New.
The Display page appears.
d. Select and click on a display type in the Display Type list.
The properties from the selected display type appear.
Section Objectives
Introduce Display options including: Tabular, Chart, Web Content and Filter Entry.
Define a Tabular Display.
Define a Chart Display.
Select Displays to be used in a Content Unit.
Wonderware Training
Defining a Tabular Display
To define a tabular display
a. Click Tabular in the Display Type list.
The Tabular Display Properties area appears.
b. Enter a name for the display in the Display ID box.
The name must be unique in the current folder and cannot contain spaces or special
characters (\ / : * ? <>& | ' ").
This name will appear in the Display List page.
c. Enter a description for the display in the Description box.
This name will appear in the Display List page.
d. Click Enable Numbering to number the rows in the display.
e. Click Show Timestamp to show the date and time the display was viewed.
The date and time is displayed in the client's time zone.
f. Enter a numeric value in the Rows per view box that will limit the number of rows to be
presented in a single view.
A zero value displays all data items in the table.
g. Select a color scheme for the display in the Color Scheme list.
The default color scheme is blue.
h. Enter the name of the column(s) in the table to hide from the table display in the Hidden
Columns box.
Hide columns that are used to perform KPI calculations.
Separate each column name with a semicolon.
i. Select Horizontal or Vertical to determine the orientation of the table in the Display Type list.
Use the vertical orientation when there are lots of columns and few rows from the query
results.
j. Click Save.
Defining a Chart Display
To define a chart display
a. Click Chart from the Display Type list.
The Chart Properties area appears.
The name must be unique in the current folder and cannot not contain spaces or special
characters (\ / : * ? <>& | ' "). This name will appear in the Display List page.
c. Enter a description in the Description box that will appear in the Display List page.
d. Configure the Graph Type options for the chart.
Single Series The single series graph displays a graph with two data fields (x-axis, y-axis).
The single series graph can select all of the chart types.
Multiple Series The multiple series graph displays a graph with three data fields (x-axis, y-axis,
series) with the option to display the graph as a single or separate multi-series
graph.
Separate Graph
per Series
Identifies whether the series data would be shown as a single graph or separate
graphs. This option is only applicable for multiple series. For example, the Tee
Chart displays a multiple series single graph.
The Equipment Status bar chart displays a multiple series graph with the
separate graph per series option.
Default Chart In the Default Chart list, click the type of chart in which to display the results. All
outputs will be plotted on a graph with an x-axis and y-axis, except for the pie
chart. The chart types for multiple series graph are limited to bar, horizontal bar,
stacked bar, stacked bar percentage and fast line. The chart default is set to line.
Type of Chart Description
Line Outputs all points by drawing a line between them in a trend format.
Bar Outputs a series of vertical bars, with the top edge of each bar indicating the
point value.
Horizontal Bar Outputs a series of horizontal bars, with the right edge of each bar indicating the
point value.
Stacked Bar Outputs a series of stacked bars, with the height of each bar indicating the point
value. Subsequent series are stacked to the prior series. For example, if the
series values for a point are 4, 5, and 11, then there would be bars from 0-4, 4-9,
and 9-15.
Stacked Bar
Percentage
Outputs a series of stacked bars, with the height of each bar indicating the
percentage of the total from all series.
Area Outputs all points by drawing a line between them and then filling the area
defined by the line and the bottom side of the chart.
Point Outputs all points by drawing individual point markers.
Pie Outputs all points by drawing slices that form an ellipse (oblong circle).
Fast Line Outputs all points by drawing a line between them (that is, a trend graph). A fast
line chart is drawn more quickly than a normal line chart, but it is not clickable
and does not support marks.
Volume Outputs a series of thin vertical lines, with the top edge of each bar indicating the
point value.
Wonderware Training
Note: The colors and font attributes are contained in .css files located at the following
(default) location:
C:\\Inetpub\wwwroot\SuiteVoyager\useng\main\contentbuilder\Tabular_DIC\styles
e. Enter the data field name from the data set that is used for the x-axis in the X-Axis Data Field
box. The name will appear in the chart results.
f. Enter the data field name from the data set that is used for the y-axis in the Y-Axis Data Field
box. The name will appear in the chart results.
g. Enter the data value to be used to group the data for a multi-series chart in the Series Data
Field box. This option is only applicable for multiple series charts.
h. Configure the Appearance options for the chart.
i. Configure the View Options for the chart.
j. Click Save.
Header Used to specify the header of the chart. You can type in a name or include a
parameter value with #param#syntax. This header will appear above the chart.
X-Axis Caption The caption that will be displayed on the x-axis of the chart.
Y-Axis Caption The caption that will be displayed on the y-axis of the chart.
Size %
(Width, Height)
Used to set the size of the width and height of the chart to be displayed in
percentage. The value must be positive integers. The default size is (100, 100)
Show Legend Used to show/hide the chart legend to the right of the chart. The legend lists all
item values in the chart.
3-D View Used to display the chart as a three-dimensional graphic.
Zoomable Used to zoom in/out on the chart display.
Show Marks Used to show/hide the marker for each data point on the graph.
Show Timestamp Used to display the data retrieval timestamp on the chart in client time zone.
Defining a Web Content Display
A web content display uses a web content query to display web content based on URL links. Web
content displays can be shown as a table list of web links or a web content page.
To define a web content display
a. Click Web Content in the Display Type list.
The Web Display Properties area appears.
The name must be unique in the current folder and cannot contain spaces or special
characters (\ / : * ? <>& | ' "). This name will appear in the Display List page.
c. Enter a description for the display in the Description box.
This description will appear in the Display List page.
d. Enter a title for the display in the Title box.
The title will appear on the top of the display.
Note: All web display configuration options after the Title are only used for a web query with a
list link type.
e. Select the Enable Numbering check box to number the rows in the display.
f. Select the Open Link in the New Window check box to have each link open a new window
instead of displaying the web content in the same window.
g. Select the Show Timestamp check box to show the date and time the data was retrieved.
The date and time is displayed in the portal user time zone.
h. Enter the number of links to be presented in a single view in the No. of Links per view box.
A zero value displays all links in the view.
i. Click Save.
Wonderware Training
Lab 30 Add Custom Displays to the Content
Unit
Introduction
The goal of this lab is to build Displays that you will use to enhance the Content Unit you created in
Lab 29.
In later labs, you will enhance this Content Unit by adding Key Performance Indicators and Links.
Objectives
Define a Tabular Display called AnalogLive-Tabular
Define a Chart Display called AnalogLive-Chart
Publish an InTouch symbol
Define a Symbol Display called AnalogLive-Symbol
Edit the Content Unit called AnalogTagLive to include Displays
Preview the Displays
Wonderware Training
Define a Tabular Display
In this section, you will create a custom table display to show the information in the AnalogLive
Content Unit created in the previous lab.
1. Expand the Administration link in the navigation tree and click Table Weaver Manager.
2. Click Display.
4. Enter SystemPlatform for Folder Name:
6. Click the SystemPlatform link to access that folder.
The Define Display properties appear.
8. Select Tabular from the Display Type: drop-down list.
9. The properties from the Tabular Display Properties appear.
11. Click the Save button after the appropriate values have been entered.
Property Name Value
Display ID AnalogLive-Tabular
Description Analog Tag Live Values - Tabular Display
Enable Numbering [Unchecked]
Show Timestamp [Unchecked]
Rows per view 10
Color Scheme Default
Hidden Columns LoLimit;HiLimit
Display Type Horizontal
Wonderware Training
Define a Chart Display
You might want to display the live values for your AnalogLive Content Unit as a chart. Next, you
will configure a custom chart display to accomplish this.
13. Click Display in the Table Weaver Manager pane.
16. Select Chart from the Display Type: drop-down list.
17. The properties for the Chart Display appear.
18. Enter (or select from the drop-down lists) the following properties.
Note: The values entered in the X-Axis Data Field and Y-Axis Data Field are case-sensitive.
Parameter Value
Display Type Chart
Display ID AnalogLive-Chart
Description Analog Tag Live Values - Chart Display
Graph Type Single Series
Default Chart Horizontal Bar
X-Axis Data Field Tagname
Y-Axis Data Field Value
Header Analog Tag Live Values
X-Axis Caption Tagname
Y-Axis Caption Value
Show Legend Checked
3-D View Checked
Wonderware Training
Publish an InTouch Symbol
You might also want to display data in the AnalogLive Content Unit using a graphical symbol. For
that, you first need to publish the InTouch symbol to be used in your display. You will do that next,
using WinXML Exporter.
21. Open Win-XML Exporter: select Start / All Programs / Wonderware / InTouch / Win-XML
Exporter
22. WinXML Exporter opens showing by default the Mixer Windows project created in Lab 21,
Convert and View InTouch Windows Over the Web.
23. Right-click the upper Mixer Windows and select New SymbolSet from the context menu.
24. Enter MixerSymbols for the SymbolSet name.
25. Select File / Open InTouch Application from the menu bar.
26. Locate the InTouch-Mixer Application you used in Lab 21, Convert and View InTouch
Windows Over the Web in the C:\Wonderware Training\Labs folder.
27. Click the OK button to select the application.
28. Click OK at the CAB Dialog box.
29. Select the Gauge window in the upper right window pane and drag it and drop it into the
MixerSymbols SymbolSet in the left pane.
30. Right-Click on the Gauge symbol under MixerSymbols and select Publish as Symbol from
the context menu.
The Successfully Published dialog box opens.
32. Close the Win-XML Exporter.
Define a Symbol Display
Next you will use the symbol published in the previous section to create a symbol display.
33. In Information Server, expand the Administration link in the navigation tree and click Table
Weaver Manager.
34. Click Display.
Wonderware Training
37. Select SmartSymbol from the Display Type: drop-down list.
The properties for the Symbol Display appear.
39. Click the Save button after the appropriate values have been entered
Parameter Value
Display ID AnalogLive-Symbol
Description Analog Tag Live Values -
Symbol Display
Symbol Gauge(MixerSymbols)
Total Number of Symbols 15
Symbols in a row 3
MinValue MinEU
MaxValue MaxEU
LiveValue Value
Tagname Tagname
Edit the AnalogTagLive Content Unit
In the next few steps you will add the previously defined custom displays to the Content Unit you
created earlier.
41. Click Content Unit under Table Weaver Manager in the left pane.
43. Select the AnalogTagLive previously defined Content Unit.
44. Select SystemPlatform\AnalogLive-Tabular from the Display drop-down list.
45. Select \SystemPlatform\AnalogLive-Chart in the left Alternate Display pane.
46. Click the right arrows to add it to the right pane.
47. Select \SystemPlatform\AnalogLive-Symbol in the left Alternate Display pane.
Wonderware Training
48. Click the right arrows to add it to the right pane.
50. Click the Preview button at the bottom of the Content Unit window.
A new window appears displaying the query results of the Analog Tag Live Values in table
format:
51. Click the Chart Icon at the top left corner of the Analog Tag Live Values window.
The Analog Tag Live Values appears as a color-coded Horizontal Chart:
52. Click the Symbol Icon at the bottom left corner of the chart.
Wonderware Training
The query results appear as symbols:
53. Close the pop-up Symbol window when you are finished.
Note: Since the preview window opens as a full-screen pop-up window, closing it does not
effect the Information Server window below.
Section 5 Defining Key Performance Indicators (KPIs)
This section introduces the Key Performance Indicator (KPI) component of the Table Weaver. You
will define a KPI and its parameters and then add it to a content unit to enhance the value of the
Display.
Key Performance Indicators (KPIs) are visual indicators that express a value as either a color or
an image. Each KPI has one or more targets with their own set of target conditions that display
visual indicators associated with the target when all target conditions are met. When a KPI
condition is met, a subset of the query will appear different than the rest of the display. Using the
KPIs function of the Table Weaver Manager, you can configure the KPI and target conditions to
display visual indicators in the displays when the target conditions are met.
Defining a KPI Collection
A KPI collection is a set of KPIs that is associated with one or more Content Units.
All KPIs must be defined in a KPI Collection.
To define a KPI collection
b. Click KPI.
The KPI Collection List page appears.
c. Click New.
The KPI Collection page appears.
d. Enter an identifier for the KPI Collection in the ID box.
The KPI Collection ID must be unique in the current folder and cannot contain spaces or
special characters (\ / ? : * <>& | "" %).
This ID will appear on the KPI Collection List page.
e. Enter a description for the collection in the Description box.
This description will appear on the KPI Collection List page.
f. Click Save.
The KPI List for the newly created KPI Collection appears.
Section Objectives
Define a KPI Collection
Define a KPI
Define a KPI Target
Select a KPI Collection for a Content Unit
Wonderware Training
Creating a KPI
A KPI is part of a KPI Collection. You can configure multiple KPIs in a KPI Collection.
To create a KPI
a. Select a KPI collection from the KPI Collection List page.
b. Click New KPI.
The KPI Definition properties appear.
c. Enter a name for the KPI in the Name box.
The name must be unique in the current KPI Collection.
The name will appear in the KPI Collection page.
d. Enter a description for the KPI in the Description box.
The description will appear in the KPI Collection page.
e. Click First, After or Last in the Position list to indicate the position of the KPI in the view.
If the After position is selected, the Column Position box will be enabled for you to type the
name of the field column for the KPI to be after.
In this example, the KPI named SalesPerCategory is positioned after CategoryName.
f. Select Color or Image in the Display Type list to indicate the display of the KPI.
The selected color or image will appear in the display as a default indicator when none of the
KPI targets are met.
Note: If you selected Color in the Display Type list, the Default Display will display a color
picker dialog box for a default color display. The selected color will appear as default when the
KPI target condition is not met.
Note: If you selected Image in the Display Type list, the Attach Image button allows you to
select an image for the KPI. You can select an image from the default list or attach an image
from your local drive.
g. Click Save.
Editing a KPI
To edit a KPI
b. Select the KPI you want to edit.
All information in the KPI definition can be modified except the KPI name.
You must define a new KPI to modify the KPI name.
c. Click Save.
Deleting a KPI
To delete a KPI
d. Expand the Administration link in the System access panel.
e. Click Table Weaver Manager.
f. Click KPI.
The KPI Collection List page appears.
g. Select the KPI collection ID in the KPI Collection List page that contains the KPI(s).
h. Select the check box next to the KPI(s).
i. Click Delete.
You will be prompted to verify the deletion.
j. Click OK.
Defining a KPI Target
A KPI can include multiple targets, each with its own set of target conditions. You can configure
the target display based on the KPI display selection of color or image. The target display will
appear in the Content Unit display(s) when the target conditions are met.
To define a KPI target
b. Select a KPI definition from the KPI collection.
c. Click New Target.
The Target Definition area appears.
d. Enter an ID name for the target in the ID box.
Target ID name must be unique within the selected KPI definition.
e. Enter a description for the KPI target in the Description box.
f. Based on the display type selected for the KPI, the Display box will provide the same display
type with the proper display options. If the KPI is defined with a color display, a color picker
dialog box will be available for you to select the color of the target definition. If the KPI is
defined with an image display, you can attach an image to the target definition.
g. In the Conditions area, set target condition. Enter a field and value in the Field and Value
boxes, respectively, and select an operator from the list. Each target condition is evaluated
with the data returned from the data source.
Click More to add multiple conditions to the target.
Note: Note Multiple conditions are linked together with an AND.
h. Click Save.
Wonderware Training
Editing a KPI Target
To edit a KPI target
a. Click on a KPI collection from the KPI Collection List page.
c. Select a target from the KPI target collection.
d. Edit the Target Definition properties.
All information in the target definition can be modified except the target name.
You must create a new KPI target to modify the target name.
e. Click Save.
Deleting a KPI Target
To delete a KPI target
a. Click on a KPI collection from the KPI Collection List page.
c. Select the KPI target that you want to delete.
d. Click Delete.
You will be prompted to verify the deletion.
e. Click OK.
Lab 31 Add KPIs to the Content Unit
Introduction
The goal of this lab is to build a Key Performance Indicator (KPI) you will use to enhance the
Content Unit you created in Lab 29, Define a Content Unit and Lab 30, Add Custom Displays to
the Content Unit.
In later labs, you will enhance this Content Unit by adding Links.
Objectives
Define a KPI Collection called AnalogLimits
Define a KPI Definition called KPI-LoLimit
Define a Target called LoTarget
Define a KPI Definition called KPI-HiLimit
Define a Target called HiTarget
Edit the Content Unit called AnalogTagLIve to include the KPI Collection
Wonderware Training
Define a Key Performance Indicator (KPI) Collection
In this section, you will create a KPI collection to show when the live value for a tag in the
AnalogLive Content Unit is in alarm.
KPIs provide a differentiator based on parameters in a Query.
1. Click KPIs under Table Weaver Manager.
The KPI Collection Definition properties appear.
3. Enter SystemPlatform as Folder Name.
5. The KPI Collection List appears.
6. Click on the SystemPlatform link to access that folder.
7. Click the New button to create a new KPI collection.
8. Enter AnalogLimits for the ID.
9. Enter Limit KPIs for Analog Tags for the Description.
10. Click the Save button when you are finished.
The Save Complete dialog box appears.
12. Click the New KPI button to define the values for a new KPI.
Wonderware Training
The KPI Definition properties appear.
13. Enter (or select from the choices provided) the following properties.
The Target Collection in KPI-LoLimit properties appear.
16. Click the New Target button.
Parameter Value
Display ID KPI-LoLimit
Description KPI for Low Limit Check
Position Last
Display Type Color
Default Display Blue
Blue
The Target Definition properties appear.
Click the Save button after the appropriate values have been entered.
19. Repeat the steps above to create a second KPI called KPI-HiLimit which is associated to the
HiLimit column in the query. The KPI-HiLimit will be added to the Analog Limits KPI
Collection you just defined. In other words, when you have completed this step, the Analog
Limits KPI Collection will contain two KPIs: the KPI-LoLimit and the KPI-HiLimit.
Parameter Value
ID LoTarget
Description Low Limit Target
Display Red
Field Value
Operator <=
Value #LoLimit#
Red
Wonderware Training
Edit the AnalogTagLive Content Unit
Next you will add a KPI Collection to the Content Unit you created earlier. Preview this Content
Unit and note the color differences in the Display.
20. Click Content Units under Table Weaver Manager.
24. Select \SystemPlatform\AnalogLimits for the KPI Collection from the drop-down list.
25. Click the Preview button to see the results.
Note: Note the color differences for the KPI HiLimit and LoLimit indicators that you just added.
Wonderware Training
Section 6 Defining Links
This section uses the Links component of the Table Weaver. You will define links and add them to
a Content Unit. These Links will create a drill-down capability for the Display created earlier. You
will create a Filter Query to create a search capability within a Content Unit.
Using the Links node of the Table Weaver Manager, you can define links to connect to various
contents.
A link is the way of connecting various contents to the Content Unit. Links are an optional definition
unit of a Content Unit definition. While processing a Content Unit that has a link association, Table
Weaver will process the link definition and put the link information into the data obtained by
running a query on the data source. The display definition unit will take the processed data and
provide hyperlinks to access related contents.
Links can be context-based or anonymous.
Link definition comprises the following properties:
When creating a new link, a link collection and an individual link are created with same name. In
other words, the first link created defines the collection name by default. The link can be deleted
but the collection name remains the same.
Additional links can then be added to the collection and they will have a name different from the
name of the collection.
Section Objectives
Define a Link Collection.
Define a Link.
Select a Link Collection for a Content Unit.
Property Name Description
ID Link Indentifier
Description Link Description
Binding A link can be bound to a complete data row or a specific data field/column
or a KPI. If the binding type is KPI, a KPI collection must be linked to the
Content Unit, or KPI binding is ignored.
Entity Name/Identity of the data field/column, in case of binding to a specific
field/column. If binding type is KPI, supply the name of the KPI in a KPI
collection: e.g. <MyCollection/FirstKPI>.
Target Can be a Content Unit within the Portal Infrastructure or web URL.
Content Unit The name of the target Content Unit. Applicable only when the target is
Content Unit and not a web URL.
URL Complete URL of the target. Applicable only when the target is the web
URL and not a Content Unit.
Parameters The parameters to be passed to the target (Content Unit or Web URL).
These are name-value pairs.
Wonderware Training
Defining a Link Collection
All links are part of a link collection. A link collection can contain one or more links.
To define a link collection
a. Expand the Administration link in the System access panel
b. Click Link.
The Link Collection List page appears.
c. Click New.
The Link Collection page appears.
d. Enter a name for the link collection in the ID box. The name must be unique in the current
folder and cannot contain spaces or special characters (\ / : * ? <>& | ' ").
This link will appear on the Link Collection List page.
e. Enter a description for the link in the Description box.
This description will appear on the Link Collection List page.
f. Click Save.
You can now define links within the link collection.
Defining a Link
To define a link
a. Click on a defined link collection from the Link Collection list page.
The link must be part of a link collection.
b. Click New Link.
c. Enter a name for the link in the Name box. The name should not contain spaces or special
characters (\ / : * ? <>& | ' ").
This link will appear on the selected Link Collection list page.
d. Enter a description for the link in the Description box.
This description will appear on the selected link collection list page and as mouse-over text in
the display.
e. Click the type of the link in the Binding list.
The link can be bound to a Record (data row), a Field (specific data column), or a KPI.
In order to bind the link to a KPI, a KPI collection must be selected for the Content Unit.
The link is bound to a record by default.
f. Type in the name of the column in the Entity box to bind to a specific column.
To bind to a KPI, type the name of the KPI in a KPI Collection.
g. Select Content Unit or Web Source to indicate the target of the link in the Target list.
If Content Unit is selected, a Content Unit list will appear for you to choose from.
If web source is selected, a URL box will appear for you to type the URL link.
h. Type the URL of the target in the URL box.
If the target is a Content Unit, select the name of the target Content Unit from the provided list.
i. Click Attach Image to attach an image to the link.
The Select an Image window will appear.
j. Select an image from the default list or upload an image from the local drive or network path.
Previews for both the images from the default list and an uploaded image can be viewed in the
right-hand box.
Click OK.
k. Click First, After or Last to indicate the position of the link in the view in the Position list.
If the After position is selected, type the name of the column that the link(s) will be placed after
in the PositionColumn box.
l. Select the New Window check box to display the link in a new window.
m. Configure the values to be passed through the parameters defined in the SQL Query in the
Parameters box. Click More to pass multiple name-value parameter pairs.
Note: Parameter names are case sensitive.
n. Click Save.
Editing a Link
To edit a link
b. Click Link.
c. Select a link collection ID in the Link Collection List page.
d. Click on the link name and start editing.
e. Click Save.
Deleting a Link
To delete a link
b. Click Link.
c. Select the link collection ID that contains the link(s) in the Link Collection List page.
d. Select the check box next to the link(s).
e. Click Delete. You will be prompted to verify the deletion.
f. Click OK.
Name Name of the parameter in the SQL query.
Value Value that you want to pass in the parameter. To pass a value from the associated data
source, specify the appropriate column name enclosed with the #symbol.
Wonderware Training
Example of Link Parameters
Link parameters can pass multiple parameter values to targeted queries to show detailed
information in the display. For example, you have a tabular display that shows the number of
suppliers from each country. You want to apply links to all the country names to show an individual
tabular display of the details for each supplier in the selected country.
Based on the link definition, hyperlinks are displayed for all the countries listed in the table. The
hyperlinks connect to another tabular display that shows specific information about the suppliers
for the selected country. The links are configured in the link definition which specifies the binding,
entity, and target of the link.
The link is bound to a field with the Country entity and targets a Content Unit that passes a
parameter value to a database query.
The link parameter passes in the #Country# parameter value to the targeted Content Unit
database query. In the database query properties, the SQL query searches through the Country
column for the value of the selected country. The value of #Country# becomes the name of the
country link selected by the portal user.
The parameter value passed into the database query returns a tabular display of the suppliers for
the selected country. Clicking the Australia hyperlink displays the supplier(s) information for
Australia.
Lab 32 Add Links to the Content Unit
Introduction
The goal of this lab is to create links that will connect live table data to history table data using the
AnalogTagLive list as the source.
This Link will enhance the Content Unit you created in the previous Lab 29 through Lab 31.
Creating these links take careful planning and involve several steps.
Objectives
Define a Query called AnalogHistory
Define a Content Unit called AnalogTagHistory
Define a Link Collection called HistoryLink
Define a Link called HistoryData
Wonderware Training
Define a Query for the target Content Unit
Next you will create a Query to the Runtime Database in MS SQL Server to get history data from
the Historian. This query will be used for the target Content Unit in a link you will define later.
1. Click Query under Table Weaver Manager.
4. Select Database for the Data Source Type in the drop-down list.
5. Enter the following properties into the ODBC Query Properties fields.
.
Parameter Value
Query ID AnalogHistory
Description Analog Tag History Values
SQL Query SELECT Datetime, Tagname, Value, QualityDetail
FROM History
WHERE Tagname ='#Tagname#'
AND Datetime >=Dateadd (mi, -10, GetDate())
AND Datetime <GetDate()
Parameters / Name Tagname
Parameters / Value SysTimeMin
6. Click the Save button after entering the appropriate values
Define a Chart Display for the target Content Unit
Since the target Content Unit you are about to define will display history data, you might want to
show that data in a chart. In this section, you will define a custom chart display for that Content
Unit.
8. Click Displays under Table Weaver Manager.
The Define Display properties appear.
11. Select Chart from the Display Type drop-down list.
Wonderware Training
The Analog History properties appear.
Define the target Content Unit
Now, you will create the Target Content Unit for your link. This Content Unit will display history data
for tags from your Historian.
Parameter Value
Display ID AnalogHistory-Chart
Description Analog Tag History Values - Chart Display
Graph Type Single Series
Default Chart Fast Line
X-Axis Data Field Datetime
Y-Axis Data Field Value
Header #Tagname#
X-Axis Caption DateTime
Y-Axis Caption Value
20. Click the Preview button.
Parameter Value
Content Unit ID AnalogTagHistory
Description History Tag Values
Query \SystemPlatform\AnalogHistory
Display \SystemPlatform\AnalogHistory-Chart
Alternate Display Table
Primary/Standalone Unchecked
Wonderware Training
21. History information for the SysTimeMin tag should now appear in a pop-up window.
22. Close the pop-up window when you are finished.
Note: Because the preview window opens as a full-screen pop-up window, closing it does not
affect the Information Server window below.
Define a Link Collection for the source Content Unit
Links are used in the Table Weaver to create a drill-down function in the Display results of the
Query. A Link Collection is what is added to a Content Unit. Next you will define a link collection to
link your AnalogTagLive Content Unit (source Content Unit) to the recently created
AnalogTagHistory Content Unit (target Content Unit).
23. Click Links under Table Weaver Manager.
24. Click New Folder.
The Define Folder page appears.
25. Enter SystemPlatform as the Folder Name.
The Link Collection Definition properties appear.
29. Enter HistoryLink as the ID.
30. Enter Link to History Data as the Description.
31. Click the Save button when you are finished.
Define a Link
33. In the Link Collection Definition page for the HistoryLink collection, click the New Link
button.
The Link Definition page appears.
Wonderware Training
Edit the source Content Unit to Include the Link Collection
Next you will add a Link Collection to the AnalogTagLive Content Unit.
Parameter Value
Name HistoryData
Description Link to History Data
Binding Field
Entity Tagname
Target ContentUnit
Content Unit \SystemPlatform\AnalogTagHistory
New Window Checked
Parameters / Value #Tagname#
40. Select \SystemPlatform\HistoryLink for the Link Collection using the drop-down list.
43. Click the Preview button to see the results in a new pop-up window.
44. Note the Tagname column now has underlined hyperlinks.
45. Test the Links by clicking items in the Tagname column.
Wonderware Training
46. Click the Tabular Display icon in the bottom left corner of the window to show the results in a
table format.
Hyperlinks
The History Tag Live Values for LIT_001.PV appear in tabular form.
47. Close the pop-up window when you are finished.
Wonderware Training
Lab 33 Create a Filter Query
Introduction
The goal of this lab is to build a Filter Query you will use with a new Content Unit. Filter Queries
are a great way to create one set of links that can be used for a myriad of searches. The user is
allowed to enter their own criteria to filter from the database in a common Display.
This filtering process takes a lot of planning. As long as the data is available, it all starts with the
Query. There are several steps to effectively use this filtering.
Objectives
Modify the AnalogLive Query you created earlier
Create a Query to the Microsoft SQL Server and generate a prompt for a filtered result
Define a Link Collection
Create an interface that accepts User Input for filtered criteria
Define a Content Unit that combines a Datasource, Query, Link Collection, and a User
Interface
Test the Filtered Query
Wonderware Training
Modify the AnalogLive Query
Next you will modify the AnalogLive Query so it can be filtered.
1. Click Queries under Table Weaver Manager.
3. Click AnalogLive.
4. Modify the query by adding the following lines to the second to last line in the SQL Query field:
AND Tag.Tagname Like Replace ('#Tagname#', '*', '%')
The entire Define Query properties are as follows.
Note: The Replace clause in this query is used to change the wildcard character from the more
commonly used * to %.
Parameter Value
SQL Query SELECT Tag. Tagname, Tag. Descr i pt i on, Engi neer i ngUni t . Uni t ,
Anal ogTag. Mi nEU, Anal ogTag. MaxEU, Li ve. Val ue, Li ve. Dat et i me,
Li ve. Qual i t ydet ai l , ( Anal ogTag. MaxEU- Anal ogTag. Mi nEU) * 0. 1 +
Anal ogTag. Mi nEu as LoLi mi t , ( Anal ogTag. MaxEU -
Anal ogTag. Mi nEU) * 0. 7 +Anal ogTag. Mi nEU as Hi Li mi t
FROM Tag, Anal ogTag, Li ve, Engi neer i ngUni t
WHERE Tag. Tagname = Anal ogTag. Tagname
AND Anal ogTag. EUKey = Engi neer i ngUni t . EUKey
AND Li ve. Tagname = Anal ogTag. Tagname
AND Li ve. Val ue I S NOT NULL
AND Tag.Tagname Like Replace ('#Tagname#', '*', '%')
ORDER BY Tag. Tagname ASC
Parameter /
Name
Tagname
Parameter /
Value
%
Wonderware Training
Define a Query for the filter Content Unit
Next you will create a Query to the Runtime Database in Microsoft SQL Server. The filter
Content Unit you are about to create requires a Query. This Query returns no result, but will
provide a user prompt for the Filtered Display. The prompt is determined by the string entered
in the Field Captions field.
7. Click Queries under Table Weaver Manager.
10. Select Database from the Data Source Type drop-down list.
The ODBC Query Properties for the selected data source type appear.
Click the Save button after the appropriate values have been entered.
Parameter Value
Query ID AnalogTagFilter
Description Analog Tag Filter
SQL Query SELECT ' ' as Tagname
Field Captions Enter a Tagname to search for (Use * for wildcard)
Define a Link for the source Content Unit
When you create a filter display, essentially you are creating a link to a filtered version of the target
Content Unit. In this section, you will define the Link Collection for your filter display.
14. Click Links under Table Weaver Manager.
The Link Collection List appears.
The Link Collection Definition properties appear.
17. Enter TagnameLink as the ID.
18. Enter Link to Tag List as the Description.
21. Click the New Link button.
Wonderware Training
The Link Definition properties appears.
Define a Filter Entry Display for the filter Content Unit
This process creates the interface that the user will access to enter the filter criteria. This
display will be associated with the filter Content Unit.
25. Click Displays under Table Weaver Manager.
27. Click New.
28. Select Filter Entry in the Display Type drop-down list.
The Filter Entry Display Properties appear.
29. Enter the following properties.
Parameter Value
Name TagSelect
Description Tag Selection Link
Binding Record
Target ContentUnit
Content Unit \SystemPlatform\AnalogTagLive
Position First
Parameters / Value #Tagname#
Parameter Value
Display ID AnalogTag-Filter
Description Tagname Filter Display
Wonderware Training
Define the filter Content Unit
Next you will create a Content Unit using the Data Source, Query, Link Collection and
Display you just created. This Content Unit ties together all the elements to create a working
Filter Query.
Parameter Value
Content Unit ID AnalogTagSearch
Description Analog Tag Search
Query \SystemPlatform\AnalogTagFilter
Link Collection \SystemPlatform\TagnameLink
Display \SystemPlatform\AnalogTag-Filter
Test the Filter Query
Now you will test the filter query you created earlier.
38. Collapse the Administration link in the navigation tree.
39. Expand the Table Weaver link in the navigation tree.
40. Expand the SystemPlatform link.
41. Click the Analog Tag Search link.
The Analog Tag Search filter query interface appears.
42. Enter sys* as the filter criteria into the data entry field.
43. Click the Go button.
Wonderware Training
The Analog Tag Live Values appear in a pop-up window using the SYS* filter you just
entered.
Notice the hyperlinks in the Tagname column.
44. Scroll to view all the results in this window.
45. Experiment by clicking on the hyperlinks to connect to History data for that item.
Note: Since the preview window opens as a full-screen pop-up window, closing it does not
effect the Information Server window below..
Module 16
MultiViews
Section 1 MultiViews 16-3
Lab 34 Configuring MultiViews 16-17
Section 2 Using Web Parts in MS SharePoint 16-33
16-2 Module 16 MultiViews
Wonderware Training
Module Objectives
Maximize the value of your portal through customization.
Introduce Web Part Technology.
Configure MultiViews and SubMultiViews.
Customize Your Portal Home Page and change its color scheme.
Section 1 MultiViews
This section introduces Web Part technology and walks you through the steps necessary to create
and view multiple Web Parts simultaneously.
Note on multilanguage use of MultiViews: When using multiple languages, your MultiViews
may not be accessible. As a best practice, you should create MultiViews using the language the
Users Browser will be set to. If users will be using multiple languages, the best way to avoid
problems is to create MultiViews in each language the users will be using.
Configuring MultiViews
Using the MultiView Manager area of the Information Server Portal, you can use pre-configured
web components, called Web Parts, to quickly and easily assemble custom information displays,
called MultiViews, for your users.
About Web Parts and MultiViews
You can configure web displays, called MultiViews, that contain Web Parts and then save these
displays on the portal.
A Web Part is a component that contains web-based content, such as HTML pages, scripts, or
Extensible Markup Language (XML) code. Web Parts are similar to ActiveX controls in that they
are stand-alone components, and can be reused in multiple web browser displays. Web Parts are
built to a Microsoft Web Part standard or are wrapped with a Web Part compliant shell so they can
be used in any Web Part compliant container, such as Information Server. Thus, you can use any
standard Web Part within Information Server. There are several default Wonderware and Microsoft
Web Parts available when Information Server is installed. You can import others including those
from third-party providers.
MultiViews allow multiple areas of your screen to host completely independent and varying content
displayed together on a single browser screen. You can easily add or remove Web Parts to and
from a MultiView, and modify the layout of the included Web Parts via a drag-and-drop interface.
The following is an example of a MultiView. In this example, there are four Web Parts used within
the "My Demo" view: a chart, an HTML page viewer, a process graphic, and an alarm display.
MultiViews are managed using Microsoft SharePoint technology.
Section Objectives
Introduce Web Part technology.
Configure MultiViews.
View MultiViews as an Information Server user.
Wonderware Training
Using the MultiView Manager
You can use the MultiView Manager to generate MultiViews. MultiViews are collections of
windows with content (Web Parts) arranged in a specific layout. Web Parts can be created by
Wonderware features, such as Process Graphics or Alarm Windows, native Microsoft Web Parts,
or third party Web Parts. You can use the MultiView Manager to:
Create a new Multiview
Edit or delete a MultiView
Import a MultiView created with a previous version of Information Server
Configuring MultiViews: Getting Started
Although there are many options that you can configure when creating a MultiView and adding
Web Parts, you will generally need to perform three basic steps:
a. Create a new MultiView and save it with a unique name.
b. Select Web Parts to display in the MultiView.
Typically, you will choose from an existing catalog.
c. Configure how the Web Parts will be arranged in the MultiView.
Creating a MultiView
When you create a MultiView, you will set options pertaining to how the MultiView will appear in the
browser window.
To create a MultiView:
a. Expand Administration in the System access panel.
b. Click MultiView Manager.
The MultiView Manager page appears in the right pane of the browser window.
c. Click the New MultiView button.
Wonderware Training
The Settings for New MultiView window appears.
d. Select a layout template from the Layout Template list. You can see an animated preview of
the selected layout on the right side. You can select from the following layout choices:
Full Page, Vertical
Header, Left Column, Body
Header, Right Column, Body
Header, Footer, 3 Columns
Header, Footer, 2 Columns, 4 Rows
Header, Footer, 4 Columns, Top Row
Left Column, Header, Footer, Top Row, 3 Columns
Right Column, Header, Footer, Top Row, 3 Columns
Note: When you select a Layout Template from the list, the graphic on the right side of the
screen will display an animation of that particular layout. You can test them all before deciding.
e. Click Yes to refresh the MultiView automatically and then specify the time span (in seconds)
between refreshes. Otherwise, click No.
Note: This can be annoying with large complex graphics or low bandwidth. The refresh will
barely be visible on simple windows.
f. Add desired Wonderware Web Parts by clicking on one of the categories under Wonderware
Web Parts Gallery. After you select an option, the corresponding features are configured in
Information Server, the section shows the Web Parts contained in the selected category.
These can be:
InTouch Windows
Names of the Windows contained in Process Graphics
Alarms
Historic or Current Alarms from the Distributed Alarm Database
Historical Data
Historical views from Historian
Table Weaver Content
Samples from Table Weaver
Data Tables
Charts
Data Tables and Charts
Third party applications that have been configured by Application Toolkit
Configuration of Third party Information Server applications
To import web parts from the selected category, select the check boxes next to the web parts
to import. Click the Import button.
The imported web parts appear under the section Selected Web Parts.
g. To save a MultiView after adding Wonderware Web Parts, click Save in the bottom left area of
the page.
The created MultiView appears in the list of MultiViews. You can edit or delete it by clicking on
the action link Edit or Delete next to the MultiView.
After you create a MultiView, the imported Wonderware Web Parts appear in different
locations, or zones in the screen layout. They are assigned automatically by the import
process. You can move them and change other properties of each Web Part using the
MultiView Edit feature.
Wonderware Training
Using the MultiView Editor
The MultiView Editor lets you:
Rearrange Web Parts within the layout
Add and delete Web Parts to the layout
Change Properties, such as Title, Description, Dimensions, Frame style, Visibility,
Orientation, Order, Icons and so on.
Note: The Fit to Window option works with Process Graphics, but does not work with
MultiViews. Please be aware of this when configuring MultiViews.
To Edit a MultiView
a. Expand Administration
b. Click on MultiView Manager. The MultiView Manager appears in the right pane in the browser
window.
c. Locate the MultiView you want to edit, and click Edit in the same line. The MultiView Editor
opens.
To Re-Arrange Web Parts within a MultiView
a. Open the MultiView for editing.
b. Click on the Title Bar of the Web Part you want to move and drag the Web Part to the new
destination zone.
Note: You can drag a Web Part to a zone that already contains another Web Part.
In that case, both Web Parts are arranged horizontally or vertically in the same zone.
To Add Additional Wonderware Web Parts to a MultiView
b. In the Task Pane, select a Gallery from the Add Web Parts Task Pane.
The corresponding Web Part List will be visible below.
This is now a place holder.
c. Drag the Information Server Content item to the destination zone.
OR
d. Click the arrow down icon of the dropped Web Part and select Modify Shared Web Part.
Wonderware Training
e. Select the Category from the Tool section.
This can be InTouch Windows, Alarms, Historical Data or Table Weaver Content. Depending
on which Category you select, the Select Item list shows the Web Parts.
f. Select a Web Part from the Web Part List in the middle or lower section of the Add Web Parts
Task Pane.
g. Click Apply.
The selected Web Part appears in the layout.
h. Click OK to retain changes when finished.
To Delete a Web Part from a MultiView
b. Locate the Web Part you want to delete from the layout.
Click the arrow down icon on its title bar.
c. Select Delete from the menu.
d. At the prompt, click OK to remove the Web Part from the layout.
Wonderware Training
To Change Properties of a Web Part in a MultiView
b. Locate the Web Part for which you want to change the properties.
Select Modify Shared Web Part.
Once the Web Part is selected for modification, it will be surrounded by a yellow dashed line.
c. In the Task Pane, expand the options Appearance, Layout and/or Advanced
d. Make the required changes to the property.
You can change the following properties:
Appearance
Title - specifies the title of the Web Part shown in the Web Part title bar
Height - specifies the height of the Web Part
Width - specifies the width of the Web Part
Frame State - specifies whether the Web Part appears minimized as a title bar, or
shows the full contents
Frame Style - specifies the frame style of the Web Part (Default, None, Title Bar and
Border, Title Bar Only)
Wonderware Training
Layout
Visible on Page - specifies to show or hide the Web Part
Direction - specifies the alignment of the content in the Web Part
(Default, Left to Right, Right to Left)
Zone - specifies the zone on the Web Part Page where the Web Part is located.
Changing this setting is the same as dragging the Web Part in the Zone area
Part Order - specifies the position of the Web Part in a zone when the zone contains
more than one Web Part. Every Web Part within a zone must have a unique Part
Order.
Advanced
Allow Minimize - specifies whether or not the Web Part can be minimized
Allow Close - specifies whether or not the Web Part can be removed from the Web
Part Page
Allow Zone Change - specifies whether or not the Web Part can be moved to a
different zone
Allow Export Sensitive - controls whether the values of one or more specific
properties when making changes to a Web Part Page in personal view can be
exported to a Web Part description file (.dwp)
Description - specifies the URL of a file containing additional information about the
Web Part
Help Link - specifies the location of a file containing help information about the Web
Part
Icon File (Large) - specifies the location of a file containing a large Web Part icon
(32 x 32 pixels)
Icon File (Small) specifies the location of a file containing a small Web Part icon
(16 x 16 pixels)
Missing Assembly Error - specifies a message that appears if the Web Part
assembly file is missing or incorrect
e. Click the Apply button at the bottom of the Tool section to apply the property changes to the
Web Part.
When using SharePoint, the default
setting allows the users to edit the
Web Part in Runtime. You need to
uncheck these items to prohibit this.
Wonderware Training
To Export a Web Part from a MultiView
b. Locate the Web Part to export, click the down arrow and select Export from the pulldown
menu. The File Download dialog appears.
c. Click Save.
The Save As dialog appears.
d. Browse to or specify a location where you want to save the Web Part.
Click Save.
A Web Part description file (.dwp) is created.
e. Click Close on the Download Complete dialog box.
To import a MultiView
Note: You can import MultiViews from earlier versions of Information Server. Please be aware that
SubMultiViews are not supported starting with Information Server 2.6 and will NOT be imported.
a. Open the MultiView Manager from the Administration section.
b. Click on Import MultiView. The Import panel appears.
c. Click the Browse button to select the MultiView, or enter the location of the MultiView in the
text field.
d. Click Import.
Lab 34 Configuring MultiViews
Introduction
In this lab, we will use the MultiView Manager to view multiple pre-configured web components,
called Web Parts, at the same time. This will allow users to quickly and easily assemble custom
information displays that allow the users to view multiple pieces of information simultaneously.
Objectives
Create a MultiView
Configure Web Parts for a MultiView
Edit a MultiView
Edit a Web Part Definition
View the modified MultiView
Wonderware Training
Create a MultiView
1. Expand Administration in the main Navigation Tree.
2. Click MultiView Manager.
The MultiView Manager appears.
3. Click the New MultiView button.
The Settings for New MultiView configuration page appears.
4. Enter a MultiView Name for your new MultiView: PlantOperator.
5. Select the Template Layout shown.
You will see a sample layout based on the Layout you selected.
Wonderware Training
Select Content for a MultiView
6. Click Intouch Windows from the Wonderware Web Parts Gallery.
You will see all the InTouch windows available to choose in the Name list.
7. Check the checkbox in front of Mixer Windows_Mixer to add it to the MultiView.
8. Click Import.
9. Click Alarms from the Wonderware Web Parts Gallery.
You will see all the Alarms Web Parts available to choose in the Name list.
10. Check the checkbox in front of Mixer Alarms(C) to add it to the MultiView.
11. Click Import.
12. Click Table Weaver Content from the Wonderware Web Parts Gallery.
You will see all the Table Weaver Content Web Parts available to choose in the Name list.
13. Check the checkbox in front of SearchEngines to add it to the MultiView.
14. Click Import.
The Selected Web Parts will display. This is what will be in your MultiView.
15. Click Save at the bottom of the screen.
Wonderware Training
Edit a MultiView
16. Click Edit to edit your new MultiView.
You will now see a live view of your new MultiView.
Note the Add Web Parts Task Pane on the right side while editing.
17. Click on Virtual Server Gallery in the Add Web Parts Task Pane on the right.
The available Web Parts appear in the Web Part List.
18. Drag Trend WebPart from the Web Part List and drop it in the Header window, just above
the Body window. A blue line will appear indicating the insertion point for the new Web Part.
The Trend WebPart window pane appears with a dashed line around it.
19. Click the Click here link to configure Trend in the new Trend WebPart window pane.
Wonderware Training
The Trend WebPart window pane opens on the right side of your screen.
20. Verify that Use Published Trend is selected.
21. Select DynamicMixer (On Demand Report) in the Use Published Trend drop-down list.
22. Click the Apply Button.
The new Trend Report is added to the MultiView Manager.
23. Locate the Right Column pane in the new MultiView (you might need to scroll down).
24. Click the down arrow on the right side of the bar entitled List of search engine links
(General).
25. Click Delete.
26. Click the OK button to permanently delete this Web Part.
Wonderware Training
Notice that the Right Column is now empty.
You will now add a Web Part to replace the one you just deleted.
27. Click MultiView Manager in the left navigation pane, and then click Edit to edit the
PlantOperator multiview.
28. Drag Page Viewer Web Part and drop it in the Right Column.
Since we are setting up a web page, you will need to define the link address.
29. Click open the tool pane.
The Page Viewer opens.
30. In the Link field type http://www.wonderware.com
31. Click (Test Link) if you want to verify your text entry or to confirm that this is a valid web page.
The web link will open in a separate window that you can close after verification.
Wonderware Training
32. Click the Apply button.
The new web page Web Part displays in the Right Column.
Now you will modify the height of the web page in the Right Column.
33. Click on the Blue Arrow in the Page Viewer Web Part to open a drop down list.
34. Click on Modify Shared Web Part.
35. Expand the Appearance menu.
36. In the Height field click Yes and type 400 Pixels.
37. Click the Apply button.
Wonderware Training
38. Click the OK button to save your configuration settings.
A preview of your MultiView appears.
Test the MultiViews
39. Expand MultiViews in the left Navigation Tree.
40. Click on PlantOperator.
This is the MultiView you just created.
The PlantOperator MultiView displays:
Wonderware Training
Section 2 Using Web Parts in MS SharePoint
Using Information Server Web Parts in Windows SharePoint
You can also use Information Server Web Parts directly in Windows SharePoint without using the
MultiView Manager and Editor. You can create customized web pages with Windows SharePoint
that include Information Server Web Parts, such as InTouch Windows, Alarms, Historical Data,
Table Weaver Content, Data Tables, Charts and third party applications created by Application
Toolkit and configure these with standard SharePoint properties, such as layout, size, visibility,
and many more. You can build web pages from web parts in a similar way as the MultiView Editor.
These Web Parts must first be configured in Information Server to be accessed by SharePoint.
Note: Viewing Information Server content via SharePoint does consume a Information Server
license.
To Add Information Server Web Parts to Windows SharePoint Web Pages
a. Open Internet Explorer and browse to http://[servername].
The SharePoint Home page of the Team Web Site appears.
b. Click on Modify Shared Page in the top right corner and select Add Web Parts, Browse.
The Tool area appears on the right.
This modifies the SharePoint Home Page.
Wonderware Training
c. Select Virtual Server Gallery and drag and drop SuiteVoyager Content Viewer to the Web
page.
d. Click on the arrow down of the SuiteVoyager Content Viewer Web Part you just added and
select Modify Shared Web Part. The right side of the screen is populated with the Content
Toolpart.
e. Select a category (for example, "Table Weaver Content") and an item (for example, "Sales Per
Category (AdventureWorks)") and click OK.
The selected Information Server Web Part is added to that Web Part page.
Wonderware Training
Module 17
ArchestrA Reports
17-2 Module 17 ArchestrA Reports
Wonderware Training
Module Objectives
Introduce the ActiveFactory Reporting Website
Explain Basic Site Navigation
Explain and Demonstrate Publishing from ActiveFactory Trend and Workbook
Overview
You can use Wonderware Information Server with the Microsoft SQL Server Reporting Services
infrastructure. Before you start, you should be familiar with SQL Server Reporting Services
terminology and concepts.
For general information on using SQL Server Reporting Services, see the Microsoft
documentation.
Note: Before installing and using ArchestrA reports, be sure the collation settings of the Historian
Runtime database and the databases on the Wonderware Information Server node match exactly.
The aaReports database uses the default collation settings on the SQL Server when it is installed.
What is ArchestrA Reporting?
ArchestrA Reporting is a set of features that publish reports using Wonderware Application Server,
Historian, and other system data. ArchestrA Reporting integrates Microsoft SQL Server Reporting
Services with Wonderware Information Server.
You can use ArchestrA Reporting features to provide reports on data stored by a variety of
Wonderware products and to view these reports from Wonderware Information Server.
ArchestrA Reporting offers the following:
Common reporting database and data source: All ArchestrA reports use the aaReports
database as their data source. The reporting database contains replicated views pointing
to linked servers. The linked servers, in turn, refer to the actual hosts and databases
from which you want to retrieve data. The reporting database serves as a central access
point to data from various databases and servers. For an example, see Concept Example:
Common Reporting Database on page 4.
All default data sources defined in Wonderware Information Server are automatically
added as linked servers that the views in the reporting database can refer to. For example,
when you change the host name or database name, the corresponding linked server
definition updates accordingly so that your reports automatically use the new data source.
The aaReports database resides on the same server as the Wonderware Information
Server database.
Report Deployment Utility: The ArchestrA Reports Deployment utility helps to deploy
reports to a Wonderware Information Server system. It automatically adds your report file
to a SQL Server Reporting Services folder, executes a SQL script that replicates views
from the database that contains the data you want to report on, and creates a linked
server that points to that database.
Note: In this context, deployment refers to report configuration and publishing, not to Industrial
Application Server object deployment.
Section Objectives
Provide an overview of the ArchestrA Reporting Website
Explain the Benefits of the ArchestrA Reporting Website
Explain the commonly used Functions of the ArchestrA Reporting Website
Wonderware Training
Integrated navigation: Reports show as nodes in the Launch Pad and can be viewed
within Wonderware Information Server.
Custom parameter input: For passing IndustrialSQL Server tagnames and start/end
times to a report, you can use the Tag Picker and Time Picker instead of typing in values.
Executing reports from a script: You can execute and print reports from an
Industrial Application Server script or an IndustrialSQL Server event action. You can
also execute reports using a URL, for example, to open a parameterized report from a
Table Weaver content unit.
Concept Example: Common Reporting Database
In the following example, a query is executed against the ArchestrA Reporting database that
requests data from two views. In the ArchestrA Reporting database, these views exist only as
dummy views that point to the real views located on two different computers.
Viewing Reports
All reports in the ArchestrA Reporting base folder that the current user is authorized to view are
available as nodes in the Launch Pad of Wonderware Information Server. The SnapShot Reports
are displayed as a node followed by datetime format items. To view a report, navigate to it just like
you would access any other node.
To view a report
a. In the Launch Pad, expand the Reports node. A tree of reports and/or subfolders appears.
b. Navigate to the report you want to view. If a report is configured for snapshots, expand it to see
the available snapshots.
c. Click the report or snapshot you want to view. If the report requires parameters, a parameter
input page appears.
d. Enter parameter values as required. Depending on how the report is configured, the Tag
Picker and/or Time Picker may be available.
If the report contains cascading parameters, select the Parent parameter, for
example, a tag group.
Press the Tab or Enter keys, or click outside the field. The tags in that group appear in
the next field.
You can also use wildcards to further narrow the search.
e. For more information, see Using the Time Picker on page 9. When you are done, click
Execute.
The report is generated, and the results appear in the content pane.
Wonderware Training
Using the Tag Picker
The Tag Picker shows which tag groups and tags exist in the IndustrialSQL Server historian that is
defined as the default data source for the Historian data source type.
Using the Tag Picker, you can quickly search the database for tags of a certain type and/or for tags
that match a particular search pattern. You can then select the ones you want to include in a
report.
The Tag Picker is comprised of the following three panes:
Server pane
Tags pane
Filter pane
To show or hide the Server or Filter pane, right-click the Tag Picker and then click the name of the
pane.
Using the Server Pane
The Server pane allows you to navigate through the folder structure (namespace) of the
IndustrialSQL Server historian.
You can add groups just as you would add a new folder in the Windows Explorer. For example,
you can create the "BoilerTags" group under in the existing "Private Groups" group. You can also
delete, cut, copy, paste, and drag-and-drop objects from one folder to another.
To add a group
a. Right-click on the folder under which you want to create a group and then click New Group.
b. A new folder appears in the Tag Picker.
c. Type a name for the folder and press ENTER.
To add a tag to a group
a. Select the system group folder that contains the tag that you want to add to your new group.
b. In the Tags pane, select the tag to add.
c. Do any of the following:
Drag-and-drop the desired tag from the Tags pane into the folder.
Server pane
Tags pane
Filter pane
Right-click on the desired tag in the Tags pane. Use the Copy and Paste commands in the
shortcut menu to copy the tag to the target folder.
When you add tags to a new group, the original reference still appears in the default system group.
To delete a group or tag
a. Select the group or tag in the pane.
b. Do any of the following:
Right-click on the group or tag and then click Delete.
Press the DELETE key.
When you delete a private group or tag reference in a private group, the group folder, any
subfolders that the group folder may contain, and all references to tags are deleted. The tags
themselves are not deleted, and the original references still appear in the default system group.
You cannot delete public folders or the tag references contained in them.
To rename a group
Note: You can rename a group that you have created in the Tag Picker. However, you cannot
rename a public folder.
a. Select the group in the pane.
b. Do any of the following:
Right-click on the group and then click Rename.
Press the F2 key.
c. Type a new name for the group and press ENTER.
To view server details
a. In the Server pane, right-click on the server and then click Server details. The Server Details
dialog box appears.
b. Click OK.
Wonderware Training
Using the Tags Pane
The Tags pane shows all the tags for the currently selected group in the Server pane.
To view only tags of a certain type, click the appropriate tab at the bottom of the pane.
To sort the table by a particular column, click the column heading.
Depending on the configuration of the report, the Tag Picker may show an additional Selected
Tags List. To add or remove tags from the Selected Tags list, use the > and < buttons. You can
also drag-drop the tags between the list panes.
Using the Filter Pane
Use the Filter pane to reduce the tags listed in the Tags pane according to criteria that you specify.
You can filter the tags according to name, description, and I/O address.
The filter mechanism allows for the following "wildcard" characters as part of the filter criteria:
For example, to find all tagnames ending with "level," type "%level."
When the Server pane and the Filter pane are both visible, the filter conditions apply to the
selected group in the Server pane. When the Server pane is hidden, the filter applies to all tags on
the IndustrialSQL Server historian.
Wildcard
Character
Filter Function
% Any string of zero or more characters.
_ Any single character.
[ ] Any single character within the specified range
or set. For example:
[a-f]
[abcdef]
[^] Any single character not within the specified
range or set. For example:
[^a - f]
[^abcdef]
To apply a filter
a. In the Tag name box, enter the string to match for the tagname.
b. In the Description box, enter the string to match for the description.
c. In the I/O Address box, enter the string to match for the I/O address.
d. Select the Exact match check box to search for tags that exactly match the entire string that
you provided for the tagname and/or description options.
For example, if you specify "level" as the tagname and do not select Exact match, any
tagname that contains the string "level" appears. For example, "ReactLevel," "ProdLevel," and
"$AccessLevel."
The Exact match option does not apply to the I/O address.
e. Click Apply to apply the filter criteria.
f. Click Clear to clear the Filter pane.
Using the Time Picker
The time picker allows you to select a time range by specifying a start time, end time, and/or
duration.
To specify a time period
a. On the Time toolbar, specify the start time, end time, and/or duration. To select a date from a
calendar, click the down arrow on the start time or end time list. To select a predefined
duration, click the down arrow on the duration list.
When you change one of the options, one of the other options is recalculated automatically. While
you change the option, a blue frame appears around the option that will be recalculated as a result
of the change.
The relation between changed and updated options is as follows:
:
If you change multiple options in a row, which option is updated depends on which two other
options you changed last. For example, if you change the start time and then the end time, the
duration is calculated accordingly. If you change the start time and then the duration, the end time
is calculated, and so on.
You change... The time picker updates...
Start time End time (based on duration)
End time Start time (based on duration)
Duration Start time (based on end time)
Start Time Duration End Time
Wonderware Training
Managing Reports
You can manage reports from Wonderware Information Server using the standard functionality of
SQL Server Reporting Services. For example, you can delete reports, configure default parameter
values, set snapshot options, and so on.
To manage reports
a. In the Launch Pad, expand the Administration node and click on Report Manager.
The SQL Server Reporting Services management page appears in the content pane. Use it just as
you would use it when accessing it directly. For more information, see the Microsoft
documentation.
Module 18
Information Server Security and Customization
Section 1 Managing Security 18-3
Lab 35 User Manager 18-15
Section 2 Panel Manager 18-29
Lab 36 Configuring Panel Manager 18-37
Section 3 Portal Configuration 18-49
Lab 37 Portal Configuration 18-55
Section 4 Backup and Restore Utility 18-63
18-2 Module 18 Information Server Security and Customization
Wonderware Training
Module Objectives
Introduce the security features in Information Server
Configure security for Internet Information Services (IIS)
Use roles and the User Manager to allow portal privileges
Enable Write-Back privileges
Configure security for publishing InTouch windows
Introduce and configure Panel Manager access for different users or groups of users
Section 1 Managing Security
This section introduces the security features of Information Server. It walks you through the steps
necessary to configure access, grant privileges using roles and enable write-back privileges.
Managing Security
Information Server can be deployed in an Internet environment. Since this connects sensitive
industrial information to the Internet and allows for the enabling of write-back to plant controllers,
the need for tight security is paramount. Information Server controls access to plant floor
information at the portal, user, and data source levels.
The first level of security is access to the Information Server Portal web server itself. Access to
the Information Server Portal is achieved by tight integration with Microsoft Windows security
(Kerberos) and the security mechanisms employed by Internet Information Services. For
additional security, the Information Server Portal also supports the Secure Sockets Layer (SSL),
password authentication, digital certificates, and Windows login dialog boxes. Information Server
is installed in a "safe state." This means the user who installs Information Server will be the only
person with privileges on Information Server. This user will have Information Server administrative
privileges and can add additional users from accessible domains. However, the "Everyone"
Windows group (all authenticated users from the same domain as the portal) is given "Read-Only"
access.
The second level of security determines what casual users (or groups of users) will be able to do
once they access the portal. The portal administrator can grant specific users (or groups)
privileges by assigning them to pre-configured security roles.
The third level of security is for write-back capability for factory data sources, such as those used
for InTouch browser-based windows.
WARNING! Enabling write-back will allow users to change the state of plant-floor devices, with
potentially life-threatening consequences.
Securing Access to the Information Server Portal
The Information Server Portal employs the integrated Windows authentication (Kerberos) security
mechanism provided with Microsoft Windows Server and Internet Information Services (IIS) in
order to grant users access to the portal site itself.
IIS also offers a variety of ways to further restrict access to the portal web site. Using IIS, you can
grant or deny access based on IP address, domain name, or computer name. Using NTFS, you
can assign ACLs (Access Control Lists) to files directly on the system.
When Information Server is installed, a COM+package for Information Server is added to the
Windows Component Services administration console. This package integrates to the Windows
Section Objectives
Introduce security features in Information Server
Clarify the difference between Authenticated and Anonymous Access
Configure security for IIS
Grant and deny portal privileges via roles
Enable and restrict Write-Back privileges
Wonderware Training
Active Directory User database and authorizes users authenticated within the Windows domain to
perform actions or execute links on the portal through an MTS (Microsoft Transaction Server)
based role system attached to the COM+package. Users can be assigned to roles either directly
by using the Component Services console or by using the Information Server Portal User
Manager.
For additional security, the Information Server Portal also supports the Secure Sockets Layer
(SSL), and digital certificates. To use digital certificates, you will need to install a digital server
certificate issued by a third-party company.
Tip: The IIS documentation is located on the web server as an online Help file and provides helpful
information on upgrading, security settings, and other valuable information about the web server. It
is recommended that you become familiar with this information in order to personalize your web
server to your companys policies and requirements.
Types of Access for Internet Information Services
Access to the web server is divided into two different categories:
Authenticated Access
Anonymous Access
With authenticated access, users will only be allowed to access the portal if they are valid
members of the same Windows domain as the web server (or a domain trusted by the web server
domain) and are a member of at least the Read-Only portal security role. With anonymous access,
however, everyone has access to the portal site, regardless of who they are, although they cannot
access the administrative functions or write-back to factory data sources.
Important! Wonderware does not recommend anonymous access. The Information Server Portal
supports both types of requests, but uses authenticated access by default. Information Server also
requires the default web site for the web server to enable integrated Windows authentication
before write-back is allowed. This is configured automatically at the time of installation.
Authenticated Access
Wonderware recommends that you use authenticated access to protect your web site from
unknown users. The authenticated access method is divided into the following additional options:
Basic Authentication
Basic Authentication sends passwords over the network as clear text. This type of authentication
transmits the passwords across the network unencrypted, making it easier for hackers to intercept
usernames and passwords. This type of authentication is not recommended.
In order to make this secure, Wonderware recommends that you use SSL and client certificates to
authenticate users when using basic authentication. Client certificates are issued by trusted third-
party organizations. This option may be required for some brands of proxy servers.
Digest Authentication for Windows Domain Servers
This method requires the support of a Windows domain controller. This method sends a hash
across the network, rather than a password, and works across proxy servers and firewalls.
Integrated Windows Authentication
This is the recommended and is the default setting for Information Server. Integrated Windows
authentication uses a cryptographic exchange with the user's Internet Explorer web browser to
confirm the identity of the user. During installation, Information Server will automatically be
configured to use the integrated Windows authentication security method. Using integrated
Windows authentication is a good way to secure your web server and those who have access to
the Information Server Portal.
When a client tries to access Information Server, IIS will check to make sure they are an
authenticated user in your Windows domain before allowing them access to the portal. Integrated
Windows authentication is very secure because it does not pass the username and password over
the network. Instead, the user's browser provides the password to the web server through a
cryptographic exchange with hashing.
Anonymous Access
Important! Wonderware does NOT recommend that you use anonymous access authentication,
since this will allow anyone to have access to your portal site.
Use the IIS administration console to configure the web server to use anonymous access.
If anonymous access is chosen as the authentication method, then writeback from the portal to
the plant floor devices will be disabled.
Wonderware Training
Configuring Security for Internet Information Services
To configure security for Internet Information Services:
Note: This method of security management is for those who are very familiar with Windows
security. It is included here for advanced Windows users and network administrators.
Most of your security needs will be met using the User Manager and the Panel Manager within
Information Server. This is a much simpler way to manage portal security than the advanced
Windows security.
a. Open the Windows Start menu, point to All Programs.
b. Select Administrative Tools.
c. Click Internet Information Services (ISS) Manager.
The Internet Information Services window appears.
d. Expand the computer name and then expand Default Web Site.
e. Right-click Information Server and then click Properties.
The Information Server Properties dialog box appears.
f. Click the Directory Security tab.
g. Click Edit in the Anonymous access and authentication control frame.
Wonderware Training
The Authentication Methods dialog box appears.
h. Select the access type.
i. Click OK to close the Authentication Methods dialog box.
j. Click OK to close the Information Server Properties dialog box.
Firewall/DMZ Compatibility
The Information Server Portal is designed to be "firewall compatible." That is, it supports
connections between itself and one or more clients through port 80 in a firewall (the standard
HTTP port). It is also DMZ-compatible, which is where the portal web server can exist between
one outward facing firewall and one inward facing firewall. In this configuration, the inner firewall
will need to open the SuiteLink port 5413 in order to access the plant floor I/O Servers on the
secure plant floor network. Additional ports may need to be opened for communication with
ArchestrA.
Information Server provides data access to SQL Servers through web services. The Information
Server SQL Server data provider web service may be purchased and installed separately from the
portal and will not require the SQL Server port to be opened on the inner firewall of the DMZ.
Simply install the SQL data provider web service on a web server located in the secure plant floor
network and register its HTTP address in the portal. Using this technique, you will provide the most
security to your plant floor SQL Server installations.
For more information about your organization's firewall, contact your Internet administrator.
Wonderware Technical Support has some general guidelines for Wonderware products.
Wonderware Training
Giving Users Portal Privileges Via Roles
The Information Server Portal administrator can give users privileges to read, write, or configure
the portal by assigning them to a pre-defined security role. Roles are an authorization mechanism
used by applications within the portal to determine user actions. A user assigned to a particular
role inherits the authorization associated with that role, which may have a different context for
different applications. The pre-defined system roles apply to the entire portal.
The Information Server Portal includes the following pre-defined security roles:
Information Server will automatically detect all domain controllers on the network and display a list
of users from each Windows domain. You simply select the users or groups to add to the pre-
defined security roles.
If you need to add a user to the domain, contact the domain administrator.
By default, the Windows user group "Everyone" is automatically added to the Read Only role. You
may remove the "Everyone" group and explicitly add users you want to have access to the
Information Server Portal.
If you do not have a domain controller in the network, the "Everyone" group will refer to all local
users created on the Information Server Portal server computer. To add local users, see the
Windows Server documentation.
Role Privileges
Administrator Has access to all portal information and has full administrative privileges, such as
configuring applications and data sources, assigning users to roles, creating access
panels, and customizing the portal. Can write back values to factory data sources
when running browser-based windows.
Engineer If the System access panel has been enabled for all users, users in this role will
have user-level access to the portal, but no administrative capabilities. Otherwise, a
user in this role will have the access assigned to them by the administrator (via
custom access panels) and can write back values to factory data sources when
running process graphics.
Read Only User Has user-level access to the portal, but no administrative capabilities. Cannot
configure or customize the portal, or create portal objects or MultiViews. Cannot
write back values to factory data sources when running process graphics.
No Access User No access to the portal. Cannot access the portal home page, even if authenticated
by IIS as a valid Windows domain user.
The No Access User role overrides all the other roles. This means that if a user is
assigned to both the Administrator role and the No Access role, the user will not be
able to access the Information Server Portal.
Adding a User to a Role
Individual Windows users or groups may be added to each role. Users and groups must exist in
the Windows security system, either in a trusted domain or on the local computer. For instructions
on creating new Windows users, see your Microsoft documentation.
A single user or group can belong to multiple Information Server roles.
To add a user to a role:
a. Expand Administration in the System access panel
b. Click User Manager.
The User Manager page appears.
c. Select the role in the Role list.
A list of all users who are currently assigned to that role will appear in the Role Users window.
d. Click the domain in the Domain list.
A list of all users in that domain will appear in the Domain Users window.
e. Select the user or user group you want to add.
f. Click << Add to assign the user to the role.
Removing a User from a Role
Changes to the users access rights will not take effect until the user logs off. In order to effect
changes immediately, you must stop and re-start the Internet Information Services. The exception
to this rule is for process graphic windows. The user's security role is checked each time a new
window is opened. The user does not need to log off in order to obtain a new role assignment.
To remove a user from a role:
b. Click User Manager.
The User Manager page appears.
c. Select the role in the Role list.
A list of all users who are currently assigned to that role will appear in the Role Users list box.
d. Select the user you want to remove.
e. Click Remove >>.
Wonderware Training
Granting Users Application Privileges Via Roles
An application role specifies what privileges a user has within a particular integrated application.
Application-specific roles may be defined during development of the application. If implemented,
these roles will appear in the User Manager area of the portal along with the default Information
Server security roles.
Applications can share roles or use the system roles defined in the portal. Be aware, however, that
if you delete an integrated application, all of its associated roles will be deleted as well, even if
other applications are using these roles.
Note: For more information on implementing security for a custom application, see the
Information Server
Toolkit Guide.
Updating the Windows Login for Information Server Components
Since Information Server is designed to run without anyone logged on locally to the server, its
COM+components must run under the authority of a valid Windows account. These components
use the Windows login that was specified during the Information Server installation, obtained from
the installing user at the time of the Information Server installation. If the password for this account
expires, must be changed, or if the login account itself is deleted, then you must set the COM+
package to run under the new identity. For security reasons, this login is not automatically
updated. For example, in some organizations, Windows passwords are set to automatically expire.
Also, you may want to manually change the Windows password from time to time for security
purposes.
If the Windows login information has changed, you will need to reconfigure it for Information Server
using the Windows Component Services utility.
To update the login:
a. Open the Windows Start menu, point to All Programs.
b. Select Administrative Tools.
c. Click Component Services.
The Component Services window appears.
d. Expand Component Services and then expand Computers.
e. Expand My Computer, and then expand COM+ Applications.
f. Right-click Wonderware SuiteVoyager and then click Properties.
Wonderware Training
The Wonderware SuiteVoyager Properties dialog box appears.
g. Click the Identity tab.
h. Type the updated password in the Password and Confirm Password boxes.
i. Click OK.
For more information, see your Microsoft Windows documentation.
Lab 35 User Manager
Introduction
In this lab, we will use the User Manager to secure access to our Information Server Information
Portal. We will add and remove pre-configured domain users from the four default roles in the
Information Server portal.
Objectives
Add valid Domain Users to each of the four existing User Roles
Remove valid Domain Users from at least one of the four existing User Roles
Review how Domain Users affects the license history log
Wonderware Training
Configure User Roles
2. Click User Manager.
The User Manager appears.
The list of all valid Domain Users will be visible, along with pre-defined Roles, available
Domains, and previously selected Role Users.
3. Verify that Training is selected in the Domain drop-down list.
4. Select Administrator from the Role drop-down list.
5. Click on isAdmin in the Domain Users list.
6. Click Add.
Training\ISADMIN appears in the Role Users list.
7. Select Engineer from the Role drop-down list.
8. Click on [isEngineers] in the Domain Users list.
6. Click Add.
Training\ISENGINEERS appears in the Role Users list. Notice that Training\ISENGINEERS
is a Windows group, therefore, all users belonging to that group have been assigned to the
Engineer role.
Wonderware Training
9. Select Read Only User from the Role drop-down list.
10. Type isReadOnly in the User / Group Names text entry box.
11. Click Add.
Training\ISREADONLY appears in the Role Users list.
12. Select No Access User from the Role drop-down list.
Select 3 users from the Domain Users list by doing the following:
13. Press and hold the CTRL key on your keyboard.
14. Click on isNoAccess, isNoAccess2, and isNoAccess3 in the Domain Users list so that all
three names are highlighted.
15. Click Add.
16. training\ISNOACCESS, training\ISNOACCESS2, and training\ISNOACCESS3 appears
in the Role Users list.
Verifying User Access
17. Click the Log off link in the upper right corner of the Information Server Home Page.
A Close Window dialog box appears.
18. Click Yes to end your Information Server session and close Internet Explorer.
Note: Make certain to properly log off Information Server by clicking the Log off link. If you
simply close Internet Explorer without logging off, you may exceed your concurrent user logins
the next time you or another isAdmin user tries to login (refer to your license agreement).
Wonderware Training
19. Select Start/ All Programs and right-click on Internet Explorer.
20. Click on Run as... in the context menu.
The Run As authentication dialog box appears.
21. Type into the User name drop-down list: training\isAdmin.
22. Enter the Password provided by your instructor.
23. Click OK.
Internet Explorer appears.
24. Type http://localhost/wonderware into the address bar.
25. Press the Enter key on your keyboard.
The Information Server Home Page appears.
Notice that the Administration link in the left-navigation tree is available as well as access to
the entire portal. This is because you are logged in with the Administrator role using the
isAdmin privileges you assigned in the previous steps.
26. Repeat steps 17 through 20 to logoff Information Server and reopen Internet Explorer as a
different user.
27. Type into the User name drop-down list: training\isEngineer.
29. Click OK.
Wonderware Training
Since you are logged in as training/engineer which is assigned to the Engineer role, the
Administration link and the Administration sub-category links are not visible in the left-
navigation tree.
Although the Engineer role does not have Administrators privileges, in this case, he/she does
have Write-back privileges as can be seen in the following steps.
32. Expand the Process Graphics link.
33. Expand the MixerWindows that you published in an earlier lab.
34. Click on Mixer.
35. Click on any of the interactive control buttons in the Mixer window.
You should be able to control these devices since you are in the Engineer role and the devices
are configured for write-back access.
different user.
37. Type into the User name drop-down list: training\isReadOnly.
39. Click OK.
Since you are logged in as training/isReadOnly which is assigned to the Read Only role, the
Administration link and the Administration sub-category links are not visible in the left-
navigation tree.
Additionally, in the Read Only role, you cannot access the write-back controls in the Mixer
window as can be seen in the following steps.
42. Expand the Process Graphics link in the left-navigation tree.
43. Expand the MixerWindows that you published in an earlier lab.
44. Click on Mixer.
45. Click on any of the interactive button controls in the Mixer window.
Write-back access is denied to ReadOnly users. You cannot control the device.
different user.
47. Type into the User name drop-down list: training\isNoAccess.
49. Click OK.
Wonderware Training
Since you are logged in as training/isNoAccess which is assigned to the No Access role,
you are denied access to the entire portal.
Reviewing License Usage
Log off your current Information Server session.
54. Select Start / All Programs / Wonderware / Information Server / Home Page.
Information Server Home Page appears.
55. In the left-navigation tree expand Administration / License Manager
56. Click on License History in the License Manager window pane.
Notice the license history is sorted by time, with current licenses displayed at the top of the list.
Domain Users are shown that have accessed the portal during this lab, including an entry for
the session which is currently open in your browser
Removing a User
57. Expand the Administration in the left-navigation tree.
58. Click on User Manager.
The User Manager window pane appears.
59. Select No Access User from the Role drop-down list.
60. Click on Training\ISNOACCESS.
61. Click Remove.
Current session
Wonderware Training
The training\isNoAcess user has been removed from the No Access role.
We will confirm the privilege changes you just made in the following steps:
Log off your current Information Server session.
Start Internet Explorer.
64. Select Start / All Programs and right-click on Internet Explorer.
65. Click on Run as... in the context menu.
66. Type into the User name drop-down list: training\isNoAccess.
68. Click OK.
Wonderware Training
Notice that you now have Read Only access to the portal. This is because you removed
isNoAccess from the No Access Role. Information Server automatically assigns everyone
Read Only access unless specified otherwise.
Since you are logged in with Read Only access, the Administration link and the
Administration sub-category links are not visible in the left-navigation tree.
71. You may further verify your Read Only status by opening the Mixer window you published
earlier and clicking on the interactive write-back buttons. Information Server will deny write-
back access to anyone with Read Only access.
Section 2 Panel Manager
This section introduces the Information Server Panel Manager and walks you through the steps
necessary to configure Access Panels.
Configuring Access Panels
An access panel is a logical grouping of navigation nodes (folders) and links that is only accessible
to particular users assigned to it. Access panels allow you to segregate portal objects (for
example, converted InTouch windows, alarm displays, and history reports) into groups of related
information. Then, each access panel can be configured to allow access by specific Windows
users and user groups (for example, plant maintenance personnel, operators, or managers), so
that each user or group will see only the portal objects that are pertinent to their area of the plant or
their user group.
For example, an Operators access panel might show InTouch graphics and charts for a particular
portion of the plant floor to just the plant operators assigned to that panel. A Maintenance access
panel might show only historical trends of plant equipment tags to plant maintenance personnel.
An access panel is accessible via a wide button-like tab that appears in the Launch Pad. By
default, Information Server includes a System access panel. You can add additional access
panels and populate them with nodes and links from the System access panel and include
additional customized links. By creating these additional access panels and dropping relevant
application and custom link nodes into them, you can easily establish access panels for different
limited access groups of users throughout the company.
Each access panel consists of three parts:
Display Name
Navigation Tree
User Access List
Section Objectives
Create and configure Access Panels for different users or groups.
Wonderware Training
About the System Access Panel
By default, Information Server includes the System access panel. The System access panel
shows all of the configuration and application folders and links that are available on the portal. The
System access panel can be visible to all users or just to administrators, but the links within it to
administration functions are only accessible to users assigned to the Administrators security role.
Since administrators have access to everything in the portal, the entire hierarchy of configured
folders and links will be visible to them within the System access panel.
This access panel can be considered the "master" list of folders and links. The organization of the
folders and links in the System access panel is fixed, except for the links pertaining to the
applications installed on the Information Server portal.
One of the first things an administrator will do is limit the access to the System Access Panel. By
default, every user has access to it.
About Custom Access Panels
Custom access panels cannot contain nodes from under the main administration node in the
System access panel, but may contain administrative nodes from other applications.
All role assignments still apply within the custom access panels. That is, even if a user has access
to a particular access panel, he or she may not be able to see all of the navigation tree nodes
within the access panel if those particular nodes require a certain role access that the user is not
in. For example, if a particular Data Table has been given the "Engineer" role assignment, then
only "Engineers" can see the node or execute it.
Each access panel contains one navigation tree, which consists of a hierarchy of nodes pertaining
to links and portal objects. However, all other access panels can have any number or arrangement
of custom nodes and links. For example:
Creating a Custom Access Panel
Theoretically there is no limit to the number of custom access panels you can create. However, it is
highly recommended that you not give any one user access to more than four panels, for
performance reasons.
To create a custom access panel:
b. Click Panel Manager.
The Configured Panels page appears.
c. Click New Panel in the Configured Panels area.
d. Type the access panel name in the box that appears.
This will appear on the tab (button) in the Launch Pad.
e. Press Enter on your keyboard. The new access panel will appear in the list.
Wonderware Training
Configuring the Navigation Tree for a Custom Access Panel
You must have already created a custom access panel in order to configure the navigation tree for
it.
To configure the navigation tree:
a. Select the panel in the Panel Manager page for which you want to configure the navigation
tree.
b. Click Edit in the Action column.
The Panel Content page appears.
Note: The System access panel cannot be edited.
c. Drag-and-drop the desired navigation node(s) from the System access panel node to the
node in the user access panel that you want it to appear under.
Note: Once you drag them to the new access panel, they will still be visible on the System
Panel. The System Panel is for the Portal Administrator. All configured nodes are always
available on the System Panel. This allows the System Administrator the option of configuring
the view to include any node for any user or group of users.
d. Right-click on a folder in the tree to create a new folder in the user access panel.
Click Add Folder.
e. Type a name for the folder in the dialog box that appears
Click OK.
Note: To delete a folder, right-click on the folder to delete and click Delete.
This will also delete all folders under it.
f. Click Save Panel Content when you are finished configuring the tree.
Wonderware Training
Configuring User Access for a Custom Access Panel
Due to bandwidth restraints and/or performance issues, it is highly recommended that you not give
any one user access to more than four panels.
To configure user access for a panel:
a. Click Panel Manager for a specific custom access panel if you are not already in the Panel
Manager, in Launch Pad.
b. Locate the name of the panel for which you want to configure access in the list of configured
access panels.
c. Click Edit in the Action column.
d. Click Users in the Panel Manager page.
The Panel User Access page appears.
e. Select the domain in the Domain list.
This list contains the user(s) or Windows security group(s) to add.
A list of all users in that domain will appear in the Domain Users window.
f. Select the user(s) or group(s) you want to give access.
g. Click Add to grant access to the panel.
Renaming a Custom Access Panel
To rename an access panel:
The Panel Manager page appears.
c. Select the access panel to rename in the list of configured panels.
d. Click Rename in the Action column.
e. Type the new name for the access panel in the box that appears.
f. Press Enter on your keyboard.
Deleting a Custom Access Panel
Panel navigation trees are made up of custom folders, logical references to System access panel
nodes, or copies of dynamically created System access panel nodes, so deleting a panel will not
delete any application nodes, static or dynamic, in the System access panel.
To delete an access panel:
c. Select the access panel in the list of configured panels.
d. Click Delete in the Action column.
Hiding the System Access Panel from Non-Administrators
You can configure the System access panel so that it is hidden from all users except for those who
are members of the Administrators security role. If you do not hide the System access panel,
any casual user might click on an administration link, only to receive a message that he/she has no
access.
If you have hidden the System access panel, non-administrative users can only see the
administrative pages if they have been granted access through a custom access panel, which you
must create.
To hide the System access panel:
a. Expand Administration in the System access panel
c. Click to select Show to administrator only for the System access panel.
Wonderware Training
Lab 36 Configuring Panel Manager
Introduction
In this lab, we will use the Panel Manager to add a navigation panel and populate it with nodes
from the System panel and/or add custom links. We will also define user access to this panel. This
is a useful tool for securing your website as well as adding convenience to individual or groups of
users.
Objectives
Create and Configure a Custom Access Panel
Verify Access to the Custom Access Panel
Restrict Access to the System Panel
Wonderware Training
Create an Access Panel & Configure the Navigation Tree
1. Expand Administration in the Navigation Tree.
2. Click Panel Manager.
The Panel manager appears.
3. Click New Panel.
4. A text entry box appears.
5. Type Plant Operator in the text entry box for the name of the new panel.
Your new Plant Operator panel appears in the list of Configured Panels.
7. Click Edit for the Plant Operator Panel.
Wonderware Training
Panel content for the new panel appears. The System Panel appears in the left column
displaying all available portal content. The right column displays the ROOT level of the new
Plant Operator panel.
8. Expand Process Graphics from the System Panel in the left column and expand Mixer
Windows.
9. Drag Mixer Windows to the ROOT of the Plant Operator panel in the right column.
Notice that the window(s) have been added to the your new panel.
Note: Be sure to drag from the System Panel in the Panel Manager window pane and not
from the Navigation Tree.
10. Right-click on ROOT and select Add Folder from the context menu.
11. Type Plant Data for the Folder Name.
12. Click OK.
13. Expand Factory Alarms in the System Panel pane in the left column.
14. Click on Mixer Alarms in the left column and drag it to the Plant Data folder in the right
column.
Notice that the window(s) have been added to the folder.
Wonderware Training
15. Expand MultiViews in the left column.
16. Click on Plant Operator in the System Panel pane in the left column and drag it to the Plant
Data folder in the right column.
Notice that the window(s) have been added to the folder.
17. Click Save Panel Content.
A confirmation dialog box appears.
18. Click OK.
19. Click Users in the panel content pane.
The Panel User Access configuration pane appears.
20. Verify that Training is selected from the drop-down Domain list.
21. Select isOperator from the Domain Users list.
22. Click <<Add.
The Plant Operator panel is now available for the isOperator user.
23. Repeat steps 21 through 23 to add isAdmin user to the Plant Operator Panel Users.
Wonderware Training
Verify User Access to the Custom Access Panel
24. Logoff your current session of Information Server.
Login as a different user by doing the following:
25. Select Start / All Programs and Right-click on Internet Explorer.
26. The Run As dialog box appears.
27. Type into the User name entry box: Training\isoperator.
28. Type the Password provided by your instructor.
29. Click OK.
30. Type into the address bar the following: http://localhost/wonderware
The Information Server home page appears.
Notice that the Plant Operator panel appears at the bottom of the navigation tree. Although
IsOperator was not assigned a specific Role, Information Server automatically assigns
everyone with Read Only access. Notice also that the Administration link is not available for
users with Read Only access.
31. Click on the Plant Operator panel at the bottom of the navigation tree.
The Plant Operator windows that you configured are available to this user.
32. Open these windows to confirm their read only status.
Wonderware Training
Restricting Access to the System Panel
In the previous steps, the System panel was available/visible to the Plant Operator user. In the
following steps you will hide the System panel so that the isOperator user will only have access
to the windows you configured for the Plant Operator.
34. Select Start / All Programs / Wonderware / Information Server / Home Page.
35. Expand Administration in the navigation tree.
36. Click Panel Manager in the navigation tree.
37. The Panel Manager appears displaying the currently configured Access Panels.
38. Check the Show to Administrators only option.
Login as a different user by doing the following:
40. Select Start / All Programs and right-click on Internet Explorer.
41. The Run As dialog box appears.
42. Type into the User name entry box: Training\isoperator.
Note: Do not use the drop-down arrow. Training\isoperator is not in the list.
43. Type the Password provided by your instructor.
44. Click OK.
45. Type into the address bar the following: http://localhost/wonderware
The Information Server home page appears.
Notice that the Plant Operator panel appears at the top of the navigation tree. Below it are the
windows that you configured for the Plant Operator. Also notice that there is no System panel
available/visible to the Plant Operator.
46. Repeat steps 40 trough 45 and login as Training/isAdmin.
47. Enter the password provided by your instructor.
Since this user has Administrator privileges, both the System panel and the Plant Operator
panels are visible in the navigation tree.
Wonderware Training
Section 3 Portal Configuration
This section walks you through the steps necessary to customize the Home Page of your
Information Server Web Portal.
Customizing the Portal
The portal administrator can completely customize the look and feel of the Information Server
Portal home page, such as:
Adding a custom logo or replacing the portal banner.
Replacing the default home page content.
Creating links to published reports, documents, other web sites, or resources.
All of this is accomplished through a series of easy-to-use menus, without leaving the Information
Server Portal. Users will see the changes when they refresh the current portal page.
Customizing the Home Page
You can customize three areas of the home page:
Custom Logo
You can specify a custom logo image to be placed in the banner area. The height of the image
should be 64 pixels -- anything smaller will be stretched to 64 pixels and anything larger will be
cut off. The width is resolution dependent.
Banner Pane
The portal banner is located at the top of the home page and is constantly displayed. You can
customize the banner by specifying a custom HTML or ASP page to appear in the banner
area. If you replace the banner with an HTML page, then the page will be resolution
dependent on the width only. If you replace it with an ASP page, the page will scale down to
the banner pane. The height of the banner page content should be 66 pixels, to avoid
distortion.
Tip: You will want to use a banner that coordinates with the color scheme you pick for the
portal.
Content Pane
You can change the default content that appears in the portal home page. You can specify an
ASP or HTML file for the content.
Section Objectives
Customize your portal Home Page.
Change your portal color scheme.
Wonderware Training
To customize the home page:
b. Click Portal Configuration.
The Portal Configuration page appears.
c. Click Home Page.
The Home Page customization page appears.
d. Click Custom Logo to change the logo.
e. Type the path to the file to upload in the File box or click Browse to locate the file.
f. Click Custom Banner URL to change the entire top banner.
g. Type the path to a configured banner .asp page in the Banner URL box.
Note: This can be a graphic file or a pre-configured .asp page.
h. Type the path to a configured content .asp page in the Home Page URL box to change the
content pane for the home page.
i. Click Save.
Important: Save the Logo or the Banner BEFORE changing them if you would like to restore
them without using the Information Server CD. Directions are included on the next page.
Reset Default Home Page Banner
To reset the Home Page to the installed default:
c. Click Home Page.
The Home Page customization page appears.
d. Select Custom Logo.
e. Click Browse.
The graphic file is stored in the following location:
c:\\InetPub\wwwRoot\Wonderware\HomePage\NamePlate.gif
f. Click Upload.
g. Click Save.
You can also reference the Banner page with the following instructions:
h. Select Custom Banner.
i. Type HomePage/Banner.asp in the Banner URL field.
j. Click Save in the upper right corner.
Note: The Home Page file is stored in the following location:
/Inet Pub/WWRoot/Wonderware/Home Page
Wonderware Training
Changing the Portal Color Scheme
You can change the portal color scheme to one of ten pre-configured, aesthetically pleasing
schemes. The scheme controls the background colors for the menu bar, Launch Pad background,
heading bars, and so on. You can view how a sample page will look with the new scheme before
you implement your changes.
In order to apply the new portal color scheme, you must have administrative privileges on the
computer on which the portal is installed.
To change the portal color scheme:
c. Click Color Scheme.
The Color Scheme page appears.
d. Click the desired color scheme.
The sample page will change to reflect your choice.
e. Click Save.
Creating Custom Links for Users
You can create a customized hierarchy of hyperlinks that will appear in the access panel of the
portal. These links can point to other web pages, send e-mail to a specified account, or open a
document file. For example, you might want to add a link to a legal disclaimer page, also called a
"terms of use" page.
Valid document file formats include: .html, .asp, .doc, .xls, .bmp, and .dwg. When a user clicks a
document link, the file will be opened in the appropriate editor, if installed on the client computer.
You should verify that your users will have the appropriate editors on their client computers in
order to open the document links that you post on the portal.
Client users must have a default e-mail application (for example, Microsoft Outlook) configured for
Internet Explorer in order to use a mailto link. If a user clicks on a mailto link in the navigation tree,
the client e-mail application will start up and display a blank e-mail message with the sender
address already configured.
c. Click Custom Links.
The Custom Links page appears.
d. Right-click on the tree and click Add Node to add a new node to the hierarchy.
For example:
Wonderware Training
The Node Name box appears.
e. Type the name of the node as you want it to appear in the navigation tree in the Node Name
box. For example, "Projects."
f. Click LEAF if this node will be the bottom node in the branch in the Node Type box. If you are
planning on adding additional levels under this node in the hierarchy (that is, one or more
"child" nodes), click NODE.
Note: A leaf node cannot have a child node.
g. To create a web page link:
Select HTTP in the Link Type area.
Type the address of the web page in the URL box. When the user clicks the link, the web
page will appear in the portal contents pane; a new browser window will not be opened.
You can specify HTTPS in the URL.
h. To create an e-mail link:
Select MAILTO in the Link Type area.
Type the e-mail address in the URL box.
i. To create a document link:
Select Upload Document.
Type the path to the file to upload in the File box or click Browse to locate the file.
Click Upload. The file will be copied to the correct location on the portal web server and
the URL box will be configured for you.
j. Click Update Node.
The new link appears under the selected category in the sample navigation tree to the right.
k. Verify that the new link is correct.
l. To delete a link, right-click on the link in the sample navigation tree and click Delete.
m. Click Save when you are finished creating all of your custom links.
Lab 37 Portal Configuration
Introduction
In this lab, we will use Portal Configuration to add custom links to information outside the
Information Server. We will quickly and easily change the color scheme of the entire portal. We will
quickly and easily change the look of the portal Home Page by changing the banner and logo.
Objectives
Add custom links
Change the color scheme of the portal
Change the Home Page banner and logo
Wonderware Training
Add Custom Links
2. Click Portal Configuration.
The Portal Configuration page appears in the right pane.
3. Right-click on Custom Links.
4. Click Add Node to add a new node.
5. Enter the information as displayed below in the configuration area in the right pane.
6. Click Update Node.
Wonderware Training
7. Right-click on Custom Links.
9. Enter the information as displayed below in the configuration area in the right pane.
10. Click Update Node. You have just added a new node to the custom link hierarchy.
11. Right-click on Historian Links.
13. Enter the information as displayed next in the configuration area in the right pane.
The complete file path for the Upload Document/File field is: C:\Program
Files\Wonderware\InSQL\Server\ReadMe.html.
14. Click Upload.
15. Click Update Node. You have just created a document link.
16. Click Save in the upper right hand corner to retain any changes made.
17. Click OK in the Save Completed dialog box.
Wonderware Training
18. Go to Custom Links in the left navigation tree and verify all the links are working properly.
Change the Color Scheme
20. Click Portal Configuration. The Portal Configuration page appears in the right pane.
21. Click on Color Scheme. The Color Scheme page appears, showing a preview of the different
available schemes.
22. Select the Olive color scheme.
23. Click Save in the upper right hand corner to save changes.
24. Click OK. You should now see the new color scheme in the Information Server portal.
Change the Home Page Appearance
26. Click Portal Configuration. The Portal Configuration page appears in the right pane.
27. Click on Home Page. The Home Page configuration page appears.
28. Select Custom Logo.
29. Browse for the Wonderware Logo.jpg file in the C:\Wonderware Training folder.
30. Click Upload.
The new logo is uploaded to your Information Server.
31. In the Home Page URL field enter http://www.wonderware.com. This will become the new
homepage for your Information Server.
32. Click Save in the upper right hand corner to save changes.
Wonderware Training
33. Click OK. Now you should see the new banner and home page in your Information Server
portal.
Section 4 Backup and Restore Utility
This section walks you through the steps necessary to backup and restore your Information Server
portal configuration.
Creating and Restoring Backups
The Backup/Restore Manager lets you create backups of the Wonderware Information Server
configuration. You can use a backup to restore the original site. This section will cover the
following topics:
Requirements
About Restoring Backups
Creating a Backup
Restoring a Backup
Troubleshooting Backup Failures
Troubleshooting Restoration Problems
Requirements
The Backup/Restore Manager for Wonderware Information Server 3.0 is not compatible with
previous versions of the software.
You can host the Wonderware Information Server configuration database on a remote SQL server
node. The SQL server must be running under a network account with the correct permissions.
These permissions are network share privileges that allow the Backup/Restore Manager to access
the remote nodes file system.
You must also be a local administrator of the Wonderware Information Server computer. In
addition, the user credentials must also have SQL Server system administrator privileges.
You must install the SQL Server client connectivity components on the Wonderware Information
Server computer.
About Restoring Backups
You can only restore a backup to the Wonderware Information Server with the same virtual
directory name for both the Wonderware Information Server and the ActiveFactory Reporting
Website from which it was created.
Section Objectives
Provide an overview of the steps required for backing up and restoring the configuration
for an Information Server portal.
Wonderware Training
The restoration process is as follows:
The existing Wonderware Information Server database is deleted. If the database is
corrupt, you must reinstall Wonderware Information Server to fix the database corruption
before restoring the backup.
A new Wonderware Information Server database is created.
Information in the database is restored with information from the backup.
All site customizations that are contained in the backup are restored. For more
information, see the Online Help topic: What Is Contained in a Backup.
You must first disconnect all clients from Wonderware Information Server, then start the
restoration process. The Internet Information Services (IIS) is stopped during the restoration
process. Also, the Wonderware Information Server database is inaccessible until restoration is
complete. However, all other databases in the same SQL Server continues to function and provide
data to clients. Typically, a system reboot is not required after the restoration process.
Note: You cannot create a backup from a Wonderware Information Server site on an operating
system in one language and restore it to a Wonderware Information Server site on an operating
system of a different language.
Creating a Backup
The Wonderware Information Server is accessible by clients during the backup process.
Note: If a backup already exists with the same name, it is overwritten automatically.
To create a backup
a. On the Start menu on the Windows Taskbar, point to All Programs, Wonderware, then to
Information Server, and then select Backup and Restore. The Backup/Restore dialog box
appears.
b. In the Backup File box, type or browse to the CAB backup file.
c. Select either Windows Authentication or SQL Server Authentication.
d. Click Backup/Restore. The status of each phase of the backup process appears in the
Backup Status box. For more information on error messages, see Troubleshooting Backup
Failures.
e. When the backup is complete, a log file is created in the backup destination directory. The log
file is named using the following convention: <backupname>_Backup.log. You can open the
log file with any text editor.
Restoring a Backup
Before you restore, make sure all open connections to the database are closed.
To restore a backup
f. On the Start menu on the Windows Taskbar, point to All Programs, Wonderware, then to
Information Server, and then select Backup and Restore. The Backup/Restore dialog box
appears.
g. Select Restore.
h. Specify the complete path to the backup file or click the button next to the Backup File box to
browse for the backup file. Select the .Cab file and click Open.
i. Select either Windows Authentication or SQL Server Authentication.
j. Click Backup/Restore.
k. When the restoration process begins, the Restoration Status dialog box appears.
l. If the restoration program could not restore an item, a message appears in the dialog box.
m. When the Restore is complete, click Close.
Wonderware Training
Appendix A
Supported Animations & Scripts
A-2 Appendix A Supported Animations & Scripts
Wonderware Training
Supported and Non-Supported Animations
Below is a list of conversions from InTouch to the Information Server. Please check for recent
updates.
Object Works
Basic Shapes Yes
Real Time Trend Yes
Cells Yes
Symbols Yes
Wizards
Alarm Displays No
Lights Yes
Switches Yes
Clocks
- Digital Time/Date W/ frame Yes
- Analog Clock Square Yes
- Analog Clock Round Yes
- Digital Time/Date Yes
- Digital Time Yes
Buttons
- Button w/ light Yes
- Set/Reset Display Yes
- Inc/Decr Buttons up/down Yes
- Inc/Decr Value Buttons Yes
- Inc/Decr Buttons Left/Right Yes
- Button w/ LED Yes
- Buttons w/ 3d & Light Yes
- Momentary Button Yes
- Inc/Dec Up /down Blue Yes
- Inc/Decr left/right blue Yes
- Round Panel Pushbutton Yes
- Inc/dec plus minus Yes
- Detent Button Yes
- Command Button Yes
- Inc/Decr +/- 2 Yes
- Windows Left Right Yes
- Windows Up/down Yes
- Color Pushbutton Yes
- Checkbox Yes
- Radio Button Yes
Frames
- Single embossed Yes
- Single Raised Yes
- Single Routed Yes
- Single Inset Yes
- Double Raised Frame Yes
Object Works
- Outer inset, Inner Raised Yes
- Outer Raised, Inner Inset Yes
Meters
- Speedometer Dial Yes
- Panel Meter Yes
- LED Meter Yes
- Thermometer Meter Yes
Panels
- Inset Yes
- Raised Yes
- Double Raised Yes
- Double Inset Yes
- Outer inset, Inner Raised Yes
- Outer Raised, Inner Inset Yes
Runtime Tools
- Alarm Point Monitor Yes
Sliders
- Vertical Slider
SPC Charts No
SPC Limits Wizard No
Text Displays
- Static 3d Text Yes
- Message Tag Display Yes
- I/O Message Display Yes
- Password Input Yes
- Message Expression Display Yes
History Wizards No
Value Displays
- I/O Analog Display Yes
- Analog Tagname Display Yes
- Analog Expression Display
- Analog Tagname Display
w/ tag text
Yes
Windows Controls
- Text Box Yes
- List Box Yes
- Check Box Yes
- Combo Box Yes
- Radio Button Group Yes
Appendix A Supported Animations & Scripts A-3
- Double Inset Yes
Scripts
Window Scripts
On Show Yes
On Hide No
While Showing No
*ShowAt
* Note: The horizontal and vertical pixel
location specified in ShowAt and
ShowTopLeftAt functions are ignored
during conversion to XML.
*Yes
*ShowTopLeftAt *Yes
Simple Button Scripts Yes
Condition Scripts No
Data Change Scripts No
ActiveX Event Scripts Yes
ActiveX Yes
SuperTags Yes
Bitmaps Yes
SQL Access No
Animation
Touch Links
User Inputs
- Discrete Yes
- Analog Yes
- String
Sliders
- Vertical Yes
- Horizontal Yes
Touch Push Buttons
- Discrete Value Yes
- Action Yes
- Show Window Yes
- Hide Window No
Line Color
Discrete Yes
Analog Yes
Discrete Alarm Yes
Analog Alarm Yes
Object Size
Height Yes
Width Yes
Miscellaneous
Object Works
Animation
Orientation Yes
Disable Yes
Fill Color
Discrete Yes
Analog Yes
Discrete Alarm Yes
Analog Alarm Yes
Location
Vertical Yes
Horizontal Yes
Value Display
Discrete Yes
Analog Yes
String Yes
Text Color
Discrete Yes
Analog Yes
Discrete Alarm Yes
Analog Alarm Yes
Percent Fill
Vertical Yes
Horizontal Yes
Tool Tips No
Wonderware Training
Visibility Yes
Blink Yes
Supported Functions
Abs( Number);
ArcCos( Number);
ArcSin( Number);
ArcTan( Number);
Cos( Number);
DText( Discrete_Tag,OnMsg,OffMsg);
Exp( Number);
HideSelf;
Int( Number);
Log( Number);
IOSetRemoteReferences(BaseAccess, NewAccess, MatchString, SubstituteString, Mode);
LogN( Number,Base);
Pi();
PrintWindow ("Window", Left, Top, Width, Height, Options);
Note: This will only print the current window/web page.
Round( Number,Precision);
Sgn( Number);
Show " Window";
Sin( AngleNumber);
ShowAt("Window", Horiz, Vert);
ShowTopLeftAt("Window", Horiz, Vert);
Sqrt( Number);
StringASCII(" Char"); Note: returns UNICODE value
StringChar(ASCII); Note: returns UNICODE character
StringFromIntg( Number,Base);
StringFromReal( Number,Precision,"Type");
Note: The Type parameter is not supported. All numbers come out as decimal values.
StringLeft("Text",Chars);
StringLen("Text");
StringLower("Text");
StringMid(" Text",StartChar,Chars);
StringRight(" Text",Chars);
StringSpace(NumSpaces);
StringToIntg(" Text");
StringToReal(" Text");
StringUpper("Text");
Tan( AngleNumber);
Trunc( Number);
wcDeleteItem( "ControlName",ItemIndex);
wcDeleteSelection( "ControlName");
wcAddItem( "ControlName","MessageTag");
Animation (continued)
Appendix A Supported Animations & Scripts A-5
wcClear( "ControlName");
GetPropertyD("ControlName.Property",Tagname);
GetPropertyI("ControlName.Property",Tagname);
GetPropertyM("ControlName.Property",Tagname);
SetPropertyD("ControlName.Property",DiscreteTag);
SetPropertyI("ControlName.Property", Integer);
SetPropertyM("ControlName.Property", "MessageTag");
wcFindItem( "ControlName", "MessageTag", DiscreteTag, Tagname);
wcGetItem("ControlName",ItemIndex,Tagname);
wcGetItemData( "ControlName",ItemIndex,Tagname);
wcSetItemData("ControlName",ItemIndex,Number);
wcErrorMessage(ErrorNumber);
wcInsertItem( "ControlName", ItemIndex, "MessageTag");
Supported Functions (continued)
Wonderware Training
Appendix B
Using Web Parts in MS SharePoint
B-2 Appendix B Using Web Parts in MS SharePoint
Wonderware Training
Using Wonderware Information Server Web Parts in Windows
SharePoint
You can use Wonderware Information Server Web Parts directly in Windows SharePoint, without
using the MultiView Manager and Editor. You can create customized web pages with Windows
SharePoint that include Wonderware Information Server Content. Wonderware Information Server
provides three web parts for use in Windows SharePoint.
Content Viewer: Displays Process Views, FactoryAlarms, and Table Weaver Content.
InTouch: For Process Views that have Industrial Application Server References. Use this
web part to allow configuring or real-time Application Object Reference switching through
web part connections. This web part uses InTouch applications that have been published
to Wonderware Information Server.
Trend: Displays ActiveFactory Trends, and published trends. You can also configure a
trend. The Trend web part allows real-time switching of published trends or configuring the
trend through web part connections.
Note: The Wonderware Information Server Web Parts provide the standard SharePoint Web part
Appearance, Layout, and Advanced options for configuration. For more Information see To
Change Web part properties in the Multiview Editor.
Appendix B Using Web Parts in MS SharePoint B-3
To add Wonderware Information Server Web Parts to Windows SharePoint web
pages
1. Open Internet Explorer and type the URL for your configured Windows SharePoint Site.
2. Click Modify Shared Page in the top-right corner and select Add Web Parts, then Browse.
The Add Web Parts pane appears on the right.
c. Select the Virtual Server Gallery and drag the Wonderware Information Server Web part you
want into a target zone on the Shared Page.
d. Click the menu arrow on the Wonderware Information Server Web Part you just added and
select Modify Shared Web Part. The right side of the screen shows the ToolPart Tool pane.
To configure the Wonderware Information Server Content Viewer Web Part
a. In the Web part ToolPart Pane, select a category such as Table Weaver Content and an
available Item.
b. Click OK to save the Web part configuration.
Wonderware Training
To configure the Wonderware Information Server InTouch Web Part
a. In the Web parts ToolPart Pane, select an InTouch Window that has Industrial Application
Server References. The Tool pane shows a list of existing References and a Text field for
configuring new references.
b. Configure the ApplicationObject references.
c. Click OK to save the WebPart configuration.
To configure the Wonderware Information Server Trend Web Part
a. To configure the web part to use a Published
ActiveFactory Trend, click the Use Published Trend option and select an available Trend.
b. Click OK to save the Trend configuration.
To configure a new trend
a. Click the Configure Tags option and configure the following:
Select a Historian data source.
Type the tag name.
Select a Pen Color, Width, and Style.
Configure a time offset and a Retrieval mode.
Add the Tag to the configuration list.
b. Repeat steps a - e until all tags are configured for the trend.
c. Configure the Trend Date mode by selecting Absolute or Relative time.
d. Configure the Start Time and Duration for the Trend.
e. Configure the Update mode to be enabled or disabled.
If Update mode is Enabled, configure the trend to be in Live or Replay mode.
For Replay mode, select a replay speed.
f. Configure the Trend Chart appearance by enabling or disabling the Tag Picker, Tool Bar, Time
Bar, Axis Label, and Grid visibility options.
g. Click OK to save the Trend configuration.
Using Web Part Connections with the Wonderware Information
Server Web Parts
SharePoint technology supports communications between web parts. This is achieved using web
part connections. In this context, one web part becomes a provider and one a consumer.
Connecting the InTouch WebPart
The InTouch web part supports InTouch Windows published to Wonderware Information Server
using the Win-XML Exporter. When you connect the InTouch WebPart, the first three tags shown
in the InTouch Toolpart are available for connections. The following graphic shows an existing
Connection for Parameter 1 of the InTouch WebPart. Detailed configuration steps are included in
the following section.
You can use SharePoint connection configuration to provide communication between web parts.
This is done by adding a SharePoint web part that connects with the InTouch WebPart provider.
This example shows you how.
Note: The following steps are an example of how to connect web parts. For more information
about web part connections, see Microsoft documentation.
To add a SharePoint web part
a. Open the default SharePoint Team Site where the InTouch WebPart is located and click
Documents and Lists on the main navigation bar.
b. Click Create.
c. Click Custom List.
d. Type any name and click the Create button. The new list appears as a blank panel.
e. Click Modify settings and columns in the left panel.
f. In the Columns area, click Add a new column. When the Add Column panel appears, do
the following:
Type InstanceName in the Column name field and ensure the Single line of text option
is selected.
Scroll down and ensure the Add to default view option is selected.
Click OK.
g. Click Documents and Lists and open your new list.
h. Click New Item and do the following:
Type any title.
Type the tag value in the InstanceName field. In this example, the instance name is
Tank_001.
i. Repeat the previous step and add more new items.
j. Click Save and Close.
Wonderware Training
To configure connections between web parts
a. Click Home in the main Team Web Site navigation bar.
b. Click Modify Shared Page and add the list you just created to the site. It is located in the
Team Web Site Gallery. The following graphic shows the List web part added to the Right
zone, with two InstanceNames.
c. Click the InTouch Web Part Menu arrow and click Modify Shared Web Part.
d. When the InTouch Toolpart appears, click the Web Part Menu arrow on the InTouch WebPart.
e. Click Connections and do the following:
Click Consumes Parameter 1 and select your web part from the menu. In the following
graphic, Test List is the web part we want to connect.
The Edit Connection dialog box appears.
Select the correct column from the Column list. In the following figure, the column is
called InstanceName.
Click Finish. The List appears with the updated Instance Names you entered in the List
web part.
f. Close the Add Web Parts panel. The following graphic shows the List web part after
completing the configuration.
g. When you want to switch tags, click an available InstanceName option.
Wonderware Training
Connecting the Trend Web Part
Use the ActiveFactory Trend WebPart from SharePoint to select and configure a published trend.
The published trend resides on the ActiveFactory Reporting Website of the Wonderware
Information Server. When published trends are not available, you can select a Historian node from
the Shared Data Source, and create your own trend using standard Trend functionality. The Trend
WebPart connects by using a published Trend, or by Configuring Tags. The ActiveFactory
functionality in Wonderware Information Server uses SharePoint technologies. The SharePoint
Team Site and the Wonderware Information Server are installed on the same server, and provide
integrated connection through the Trend WebPart.
To configure Trend WebPart connection options
a. On the Trend WebPart, click the Web Part Menu arrow and select Modify Shared Web Part.
b. With the Trend Tool Part open, click the Web Part Menu arrow on the Trend WebPart and
select Connections.
Use Published Trend
When you connect to a published trend, the following connections are supported:
Provides Published Trend: Provides the Trend WebParts URL as text to any other web
parts within the SharePoint site.
Consumes Published Trend: Consumes a published Trend URL as text from other web
parts within the SharePoint site.
Configure Tags
When you configure tags, you can select any Administrator from the top list. This list contains
Named Data Sources of the Historian type. The data source is configured in the Shared Data
Source Manager. For more information about trend properties, see the ActiveFactory Users
Manual.
The following connections are supported:
Provides InSQL Server: Provides the Historian node name to any other web part.
Provides Current Tag Name: Provides a tag name from a Historian node to any other
web part.
Consumes InSQL Server: Uses a Historian Shared Data Source provided by another
web part.
Consumes Current Tag Name: Uses a valid tag name from the Shared Data Source as
provided by another web part.
Consumes Retrieval Style: Uses a valid retrieval style value such as Cyclic, Averages,
Time In State, and so on as provided by another web part.
Consumes Start Date and End Date: Uses a start and end date provided by another web
part.
Consumes Trend Duration: Uses a duration value as provided by another web part.
Consumes Date Mode: Uses the Relative or Absolute time settings.
Wonderware Training

WWSystemPlatformCourse Part2 EntireManual

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

WWSystemPlatformCourse Part2 EntireManual

Hochgeladen von

Copyright:

Verfügbare Formate

Training Manual

technology to extend the capabilities of the System Platform.

application and include the following:

SQL Server, acquires plant data via

. The information in the Holding database is stored to a database file named

extensions, and the

SQL Server and/or Microsoft

Data Engine (MSDE). It will be

Das könnte Ihnen auch gefallen