Vous êtes sur la page 1sur 124

Proficy HMI/SCADA - iFIX

MT

UNDERSTANDING iFIX

Version 4.0 December 2005

All rights reserved. No part of this publication may be reproduced in any form or by any electronic or mechanical means, including photocopying and recording, without permission in writing from GE Fanuc Automation.

Disclaimer of Warranties and Liability


The information contained in this manual is believed to be accurate and reliable. However, GE Fanuc Automation assumes no responsibilities for any errors, omissions or inaccuracies whatsoever. Without limiting the foregoing, GE Fanuc Automation disclaims any and all warranties, expressed or implied, including the warranty of merchantability and fitness for a particular purpose, with respect to the information contained in this manual and the equipment or software described herein. The entire risk as to the quality and performance of such information, equipment and software, is upon the buyer or user. GE Fanuc Automation shall not be liable for any damages, including special or consequential damages, arising out of the user of such information, equipment and software, even if GE Fanuc Automation has been advised in advance of the possibility of such damages. The user of the information contained in the manual and the software described herein is subject to the GE Fanuc Automation standard license agreement, which must be executed by the buyer or user before the use of such information, equipment or software.

Notice
GE Fanuc Automation reserves the right to make improvements to the products described in this publication at any time and without notice. 2005 GE Fanuc Automation. All rights reserved. Microsoft is a registered trademark of Microsoft Corporation. Any other trademarks herein are used solely for purposes of identifying compatibility with the products of GE Fanuc Automation. We want to hear from you. If you have comments, questions, or suggestions about our documentation, send them to the following email address: doc@gefanuc.com

Table Of Contents
About This Guide ............................................................................................................................ 1 Introduction to iFIX.......................................................................................................................... 1 iFIX Components ........................................................................................................................ 2 Using iFIX with Other Proficy Applications.............................................................................. 3 Enabling Technologies................................................................................................................ 4 OLE for Process Control (OPC).............................................................................................. 4 Visual Basic for Applications (VBA) ........................................................................................ 5 ActiveX.................................................................................................................................... 5 System Architecture........................................................................................................................ 6 Understanding the iFIX Nodes.................................................................................................... 7 Nodes in iFIX .......................................................................................................................... 7 Universal Data Access................................................................................................................ 8 OLE, OPC, and ActiveX Support ............................................................................................ 9 Open Database Connectivity (ODBC) Support ....................................................................... 9 Dynamic Data Exchange (DDE) Support................................................................................ 9 I/O Drivers............................................................................................................................... 9 Data Flow.............................................................................................................................. 10 Process Database................................................................................................................. 10 Scan, Alarm, and Control Program ........................................................................................... 11 Time-Based Processing........................................................................................................ 12 Exception-Based Processing ................................................................................................ 12 One-Shot Processing............................................................................................................ 13 Scheduler.................................................................................................................................. 13 Distributed Networking.............................................................................................................. 13 Distributed Processing .......................................................................................................... 13 On Demand Data Transfer.................................................................................................... 14 Centralized Processing ......................................................................................................... 15 Failover ..................................................................................................................................... 15 Alarming.................................................................................................................................... 16 Types of Alarms and Messages............................................................................................ 16 Alarm Routing ....................................................................................................................... 17 Operator and Application Message Routing ......................................................................... 17 Security..................................................................................................................................... 18 Security Areas....................................................................................................................... 18

iii

Understanding iFIX

Security Application .............................................................................................................. 19 System Functions ......................................................................................................................... 19 Basic Functions ........................................................................................................................ 20 HMI and SCADA Functions ...................................................................................................... 20 Monitoring ............................................................................................................................. 21 Supervisory Control .............................................................................................................. 21 Alarming................................................................................................................................ 21 Control .................................................................................................................................. 21 Reporting Functions.................................................................................................................. 22 Data Archiving....................................................................................................................... 22 Reports ................................................................................................................................. 22 Open Architecture Functions .................................................................................................... 23 Application Functions................................................................................................................ 24 User Configuration Applications............................................................................................ 24 System Applications.............................................................................................................. 24 User Applications .................................................................................................................. 24 Using the Proficy iFIX WorkSpace................................................................................................ 25 Understanding the Proficy iFIX WorkSpace.............................................................................. 25 Starting the Proficy iFIX WorkSpace..................................................................................... 25 Command Line Parameters for Starting the iFIX WorkSpace............................................... 26 Shut Down the iFIX WorkSpace with a VBA Script............................................................... 29 Understanding the System Tree ........................................................................................... 30 Understanding the Work Area............................................................................................... 30 Using the Virtual Keyboard ................................................................................................... 31 Using the System Tree ............................................................................................................. 33 Understanding System Tree Paths ....................................................................................... 35 Showing and Hiding the System Tree................................................................................... 35 Navigating the System Tree.................................................................................................. 35 Opening and Closing Folders ............................................................................................... 36 Right-Clicking the System Tree ............................................................................................ 37 Dragging and Dropping Files ................................................................................................ 37 Starting Applications from the System Tree.......................................................................... 38 Understanding WorkSpace Environments ................................................................................ 38 Displaying the WorkSpace Full-Screen ................................................................................ 38 Enabling Environment Protection.......................................................................................... 39 Disabling Error Dialog Boxes ................................................................................................ 39 Disabling Proficy Historian Errors in the WorkSpace ............................................................ 39

iv

Table Of Contents

Working with Documents .......................................................................................................... 40 Opening Documents ............................................................................................................. 40 Deleting and Renaming Documents ..................................................................................... 40 Understanding Toolbars............................................................................................................ 40 Showing and Hiding Toolbars ............................................................................................... 42 Understanding Toolbar Owners ............................................................................................ 42 Customizing Toolbars ........................................................................................................... 42 Creating Toolbars ................................................................................................................. 43 Creating Buttons ................................................................................................................... 43 Sharing Toolbars and Toolbar Buttons ................................................................................. 44 Using Experts and the Task Wizard...................................................................................... 44 Setting User Preferences.......................................................................................................... 45 Understanding Picture, Shape, Drawing, and Chart Preferences......................................... 45 Saving Back-up Files ............................................................................................................ 45 Configuring Run-time Preferences........................................................................................ 46 Changing the Start-up Environment...................................................................................... 46 Animation Error Preferences................................................................................................. 46 Displaying the Visual Basic Editor ............................................................................................ 46 Managing iFIX Nodes ................................................................................................................... 47 Configuring the Local Computer ............................................................................................... 47 Sharing Files............................................................................................................................. 48 Configuring the Picture Path ................................................................................................. 48 Finding and Replacing Data...................................................................................................... 48 Using Wildcards .................................................................................................................... 50 Finding and Replacing Data in Scripts.................................................................................. 51 Using Find and Replace with User Globals........................................................................... 51 Backing up and Restoring Files ................................................................................................ 51 Overview of the Backup Process .......................................................................................... 54 Overview of the Restore Process ......................................................................................... 58 Using the Command Line Options ........................................................................................ 62 Using and Creating Factory Default Files ............................................................................. 65 Sample BackupRestore.ini.................................................................................................... 73 Specifying a Proficy Batch Execution Project ........................................................................... 76 Using the iFIX Information System ............................................................................................... 76 Using Electronic Books ............................................................................................................. 77 Accessing Information in Electronic Books ........................................................................... 77 Electronic Book Buttons........................................................................................................ 77

Understanding iFIX

Using the Table of Contents ................................................................................................. 78 Searching Electronic Books .................................................................................................. 79 Refining Your Search............................................................................................................ 80 Determining Your Location within the Electronic Books........................................................ 81 Printing Electronic Books ...................................................................................................... 82 Displaying or Hiding the Left Frame...................................................................................... 82 Copying and Pasting Text from an Electronic Book to Another Application.......................... 82 Using the Favorites Tab........................................................................................................ 83 Using Online Help..................................................................................................................... 83 Accessing Information in Online Help ................................................................................... 84 Searching Online Help .......................................................................................................... 85 Help Options Menu ............................................................................................................... 87 Annotating Online Help Topics ............................................................................................. 87 Copying and Pasting Text from Online Help to Another Application..................................... 88 Printing Online Help Topics .................................................................................................. 89 Bookmark Menu.................................................................................................................... 89 Using the iFIX Sample System ..................................................................................................... 91 Before You Begin...................................................................................................................... 92 User Accounts that Start the Sample System ....................................................................... 92 Running the Sample System with iFIX.................................................................................. 92 Using the Sample System with a Terminal Server................................................................ 92 Using the Sample System with Picture Caching ................................................................... 93 Starting the Sample System ..................................................................................................... 93 Accessing Other Desktop Applications ................................................................................. 94 Using the Sample System Help ................................................................................................ 95 Getting Help for an Object or Picture .................................................................................... 95 Displaying ToolTips............................................................................................................... 95 Clicking the Help File Button from a Picture ......................................................................... 95 Working with the Sample System Demos................................................................................. 95 Understanding the Alarm Summary, Trending Chart, and Reporting Screens ..................... 95 Using Configure and Run Modes.......................................................................................... 96 Navigating through the Demos ............................................................................................. 96 Quick Tour of the Discrete Manufacturing Demo ...................................................................... 96 The Annealing Process......................................................................................................... 96 Manufacturing Step Indicator ................................................................................................ 97 Alarm Summary Object......................................................................................................... 97 Quick Tour of the Water & Wastewater Demo .......................................................................... 97

vi

Table Of Contents

Exploring Tag Groups and Pop-up Pictures.......................................................................... 97 Quick Tour of the Chemical Demo............................................................................................ 98 Exploring Picture Layers ....................................................................................................... 99 Exploring ToolTips ................................................................................................................ 99 Exploring VisiconX .............................................................................................................. 100 Quick Tour of the Pharmaceutical Demo ................................................................................ 101 Signing When Starting and Stopping the Mixer .................................................................. 103 Signing When Using an Expert ........................................................................................... 103 Signing When Acknowledging Alarms ................................................................................ 103 Viewing the Audit Trail from a Relational Database............................................................ 104 Exploring Trending.................................................................................................................. 104 Exploring Alarms and Alarm Counters.................................................................................... 105 Index ........................................................................................................................................... 109

vii

Understanding iFIX

viii

About This Guide


The Understanding iFIX manual is intended for all iFIX users. It provides an overview of the structure and functions of iFIX, the Proficy iFIX WorkSpace, the iFIX Help and electronic books, and the iFIX Sample System. Reference Documents For related information on subjects discussed in this manual, refer to the following documents: Setting up the Environment Building a SCADA System Implementing Alarms and Messages Implementing Security Using Electronic Signatures Creating Pictures Writing Scripts Trending Historical Data Mastering iFIX

Introduction to iFIX
iFIX is the Windows-based HMI/SCADA component of GE Fanuc's family of software automation products. Based on open, component-based technology, iFIX is designed to allow easy integration and interoperability between your plant floor and business systems. It includes functional and architectural features that reduce the design time for automation projects, allow simple system upgrades and maintenance, provide seamless integration with third-party applications, and increase productivity. The SCADA portion of iFIX provides monitoring, supervisory control, alarming, and control functions. It guarantees the absolute integrity of data and provides complete distributed networking capabilities. The HMI portion of iFIX is the window into your process. It provides all the tools you need to develop pictures that operators can use to monitor your process.

Understanding iFIX

This manual covers several fundamental concepts in iFIX: For information on the structure and capability of iFIX, refer to the System Architecture and the System Functions chapters. For information on the Proficy iFIX WorkSpace, refer to the Using the Proficy iFIX WorkSpace chapter. For information on managing your nodes, refer to the Managing iFIX Nodes chapter. For information on the electronic books and online Help, refer to the Using the iFIX Information System chapter. For information on the Sample System provided with your iFIX software, refer to the Using the iFIX Sample System chapter.

iFIX Components
At the heart of iFIX is an enabling technology that provides a distributed architecture. iFIX is built on standard technologies, such as ActiveX, OPC, VBA, and Component Object Model (COM), to provide easy integration of third-party applications across wide area networks and the Internet. iFIX provides LAN failover to enhance system performance. The iFIX platform hosts a number of GE Fanuc and third-party application components, some of which are illustrated in the following figure.

GE Fanuc iFIX Platform An important component of iFIX is the Proficy iFIX WorkSpace. This interface organizes all system components into one integrated development environment (IDE). The Proficy iFIX WorkSpace allows you to navigate through, access, and manipulate all the components of your system.

Understanding iFIX

The Proficy iFIX WorkSpace The Proficy iFIX WorkSpace includes two fully-integrated environments known as configuration and runtime. The configuration environment provides all of the graphic, text, data, animation, and charting tools necessary to create displays that are attractive, organized, and easy to use and understand. The run-time environment provides the means necessary to view these displays in real-time. Switching between the run-time and configuration environments allows you to quickly test changes to displays while real-time alarming and data acquisition continue. It is important to note that while you are in the configuration environment, there is no interruption to your process. All the functions that control and monitor your system, such as alarming, reporting, and scheduling, continue to run in the background. For more information on creating and viewing displays in the Proficy iFIX WorkSpace, refer to the Creating Pictures manual.

Using iFIX with Other Proficy Applications


iFIX works with the following GE Fanuc Proficy software applications, as well as many third-party applications. Proficy Historian Proficy Historian is a high performance data archiving system designed to collect, store, and retrieve time-based information efficiently. Proficy Real-Time Information Portal Proficy Real-Time Information Portal is GE Fanuc's web-based product for the visualization and analysis of the data within your plant. Proficy Portal allows users to make business sense out of plant data by providing a personalized web environment where information from the Proficy Historian can be analyzed, trended, and reported on.

Understanding iFIX

Proficy Batch Execution Proficy Batch Execution is the high-performance automation application that lets you model your plant, manage recipes, execute batches, create electronic batch records, and generate reports based on any batch process. With Batch Execution, you'll have the tools necessary to reduce cycle time, increase flexibility, comply with regulatory demands, and track batch production. Proficy Plant Applications Equipment use and downtime are typically tracked and reported as key performance indicators in manufacturing companies. Proficy Plant Applications allows you to accurately report equipment efficiency, and extends your ability to analyze, understand, and address each source of downtime. Proficy View - Machine Edition The Proficy View - Machine Edition OPC Server can provide data directly into iFIX. You can display this data in your iFIX pictures, as you would with any other OPC data.

Enabling Technologies
As the solutions required by end users and system integrators become more complex, it becomes increasingly difficult to anticipate the individual needs of each customer. With this in mind, we incorporated the following industry-standard technologies into iFIX to provide a development environment that you can tailor to meet your specific requirements: OLE for Process Control (OPC) Visual Basic for Applications (VBA) ActiveX

OLE for Process Control (OPC)


OPC is a software standard designed to provide automation applications with easy access to industrial plant floor data. We have led the development of OPC through our active role in the founding of the OPC Task Force, a consortium of leading industrial automation suppliers formed to speed the development of an OLE-based communication standard. The goal of OPC is to define a standard interface based on Microsoft's Component Object Model (COM) technology that allows greater interoperability between automation and control applications; control devices; and business and office applications. Using OPC, the Proficy iFIX WorkSpace can communicate directly with any OPC server. You can add an OPC server to your iFIX node using the Data Server Installer program. This utility, located in your Proficy iFIX directory, lets you add, modify, and remove OPC servers from the list of data servers available to iFIX. For more information about using the Data Server Installer, refer to the program's online Help. If you need to communicate with a remote OPC server, specify the machine where the remote server resides in the Machine Name field when you add an OPC Server using the Data Server Installer. Alternatively, you can also use the OPC Client driver to communicate with a remote OPC server. This driver lets you communicate with any local or remote OPC server and store the information in the process database.

Understanding iFIX

Visual Basic for Applications (VBA)


VBA is a powerful scripting tool that is fully integrated into iFIX to let you quickly and easily automate operator tasks and create automation solutions. VBA scripts can be as simple or complex as you need them to be, allowing you to add custom functionality and extend iFIX as needed to accommodate your automation strategy. Its powerful and easy-to-use development environment allows you to reuse existing Visual Basic code. VBA replaces the scripting engine used in previous versions of FIX to provide a complete, integrated development environment that is familiar to millions of developers already using Visual Basic. It provides virtually unlimited power and extensibility for accessing other iFIX components and external objects and data. The GE Fanuc implementation of VBA provides: Access to all exposed properties, methods, and events for iFIX objects Support for multiple data sources, including the iFIX process database, any OPC server, properties of other objects, and SQL databases ODBC support Support for ActiveX controls Script Authoring Wizards and iFIX commands to help you write scripts for common tasks Secure Containment for third-party ActiveX controls

The Proficy iFIX WorkSpace provides access to the Visual Basic Editor (VBE), a built-in editor and debugger that allows you to view, halt, suspend, and resume active scripts. In the VBE, you can write scripts for all iFIX objects, create VBA forms, access any available data source, display objects using the Object Browser, and debug your scripts. You can also use VBA to write scripts for toolbar buttons and write scripts for entries in the Scheduler. iFIX exposes a global library of common global subroutines that can be easily changed in one place. It provides full support for thousands of commercially available objects and ActiveX controls. GE Fanuc's implementation of VBA includes a powerful find and replace feature, a high speed persistence feature that greatly reduces file retrieval time, and an enhanced cut and paste feature that copies all forms, modules, and scripts associated with a selected object. These enhancements significantly reduce development time and increase your system's overall performance. The unique architecture of iFIX has also allowed us to dramatically increase the speed and performance of VBA.

ActiveX
ActiveX is a set of programming technologies created by Microsoft that enables software components created in different languages to interact with one another in a networked environment. It evolved from the OLE development standard, which in recent years has expanded far beyond the concepts of object linking and embedding that formed the original acronym. iFIX is a container for ActiveX controls. Like OLE, ActiveX is built on the COM programming model to support the full integration of software components. It supports Distributed COM (DCOM) for the transparent integration of those same components across distributed networks, including the Internet and intranets. However, ActiveX has been optimized for size and speed to allow developers to use subsets of the complex OLE interface to create highly interactive applications. ActiveX allows any OCX (ActiveX control) developed by a third-party to behave just like any object created by GE Fanuc.

Understanding iFIX

To protect your system from possible problems with ActiveX controls, iFIX provides Secure Containment. Unlike most systems that support ActiveX controls, if an ActiveX control crashes while iFIX is running, it is sealed off and your system continues to run normally. With Secure Containment, there is no loss of data or interruption to your control process.

System Architecture
This chapter describes the system architecture of iFIX. It includes information about: Understanding the iFIX Nodes Universal Data Access Scan, Alarm, and Control Program Scheduler Distributed Networking Failover Alarming Security

Understanding iFIX

Understanding the iFIX Nodes

iFIX Node Types A node is any computer running iFIX. An actual node can be any of the node types described in the following section. To learn more about iFIX nodes, refer to the chapter Managing iFIX Nodes.

Nodes in iFIX
There are several types of nodes available using iFIX.

Understanding iFIX

Types of Nodes Type Local and Remote Description When working with a distributed iFIX system, local refers to the node on which you are currently working and remote refers to any node that you need a communication link to access. When working with a centralized iFIX SCADA system, stand alone refers to a node that performs all functions. Stand alone nodes do not use a network. A SCADA Server (or SCADA node) runs the data acquisition and management component of iFIX. Usually, a SCADA node resides on the plant floor and has direct connections to the process hardware. A blind SCADA Server (or blind SCADA node) uses no graphics display. This configuration frees up more of a computer's resources for data acquisition and network management functions. Graphics can be viewed using an iClient. A run-time node does not let you modify graphic displays or the process database. Pre-configured files are installed on these nodes so that you can monitor the process, change process settings, and acknowledge alarms. An iClient (or view node) is the most common type of node. View nodes display the real-time graphics that come with iFIX. The term view node means that the node runs the graphics display program, but the node can run other applications, as well. The iClient Read Only has the same functionality as an iClient, except that you cannot write to the iFIX database or to OPC servers. You also cannot construct SQL Insert or Update commands in an iClient Read Only node. You can, however, write to a relational database. The iClient Read Only is similar in functionality to PlantTV for FIX, with the added benefit of leveraging the iClient features, such as the event scheduler, VBA, and ActiveX controls.

Stand Alone

SCADA Server

Blind SCADA Server

Run-time

iClient

iClient Read Only

Universal Data Access


Typically, a plant is controlled through a network of sensors and controls connected to I/O devices, such as programmable logic controllers (PLCs). Although this type of system provides the automatic control that keeps the plant running, it is often difficult for plant personnel to see what's actually going on in the control process at any time. iFIX solves this problem by making data from various sources available to plant workers and managers in formats that are useful and easy to understand.

Understanding iFIX

A data source includes the data you want to access and the information needed to get that data. The data sources available with iFIX include tags, I/O addresses, object properties, historical data, picture properties, VBA events, global variables, and expressions. With the open architecture of iFIX, data can be accessed from a wide variety of sources using OLE, OPC, ActiveX, ODBC, and DDE. With comprehensive client and server support for these object technologies, iFIX is able to read data from and write data to the following sources: Third-party applications Other iFIX databases I/O drivers

It is this ability to access data universally that gives iFIX its remarkable power and versatility.

OLE, OPC, and ActiveX Support


iFIX includes comprehensive OLE, OPC, and ActiveX client and server support as the foundation for providing an integrated plug and solve architecture. This technology is the primary mechanism that lets you easily integrate third-party objects and controls into iFIX and embed iFIX objects into other applications. OLE Automation server support allows you to expose the properties of iFIX components. For example, it allows you to generate pictures without accessing the software's user interface.

Open Database Connectivity (ODBC) Support


ODBC support allows iFIX to access data from a database using Structured Query Language (SQL) as a standard language. Each database management system (DBMS) requires an ODBC driver, which is a dynamic-link library (DLL) used to gain access to a data source. Among the database management systems used by iFIX are Microsoft Access (local install only), Microsoft SQL Server, and Oracle. Refer to the Using SQL manual and Writing Scripts manual for more information on ODBC support.

Dynamic Data Exchange (DDE) Support


DDE is a form of communication that uses shared memory to exchange data between applications. With DDE support, if data in a linked application (a spreadsheet or word processor, for example) changes, the data in the process database also changes, and vice-versa. Refer to the Using DDE manual for complete information on DDE support.

I/O Drivers
GE Fanuc provides a wide variety of high-performance I/O drivers that support best-selling and specialty I/O devices. We also offer the OPC Toolkit, a plug-in component to iFIX that lets you easily write high performance, reliable I/O servers that communicate between your process hardware and your iFIX, OLE Automation, and OPC client applications. High performance I/O drivers provide such capabilities as automatic communication error detection, reporting, and recovery; built-in datascopes; and support for redundant communications. Receiving information from third-party servers is also supported, but typically does not offer any of the high data integrity of a GE Fanuc high-performance I/O driver.

Understanding iFIX

Data Flow
The flow of process data is summarized as follows: 1. 2. iFIX reads data from various data sources. Internal iFIX database access functions read the data from local or remote databases and transfer it to the requesting software applications. This transfer occurs without any operator interaction. For example, the Scan, Alarm, and Control (SAC) program processes the data and transfers the data to the process database or the Historical Chart presents the data directly to you.

Data may also be written to the data sources by executing these steps in reverse.

Typical Data Flow Diagram

Process Database
The iFIX process database is a representation of the process created by linking together blocks of process control logic. The process database consists of blocks and chains. A block (also called a tag) is a coded set of process control instructions provided by GE Fanuc that perform a specific task. Most blocks can hold only one data point. Each block requires you to provide several parameters. In general, there are two types of blocks: Primary blocks start a logical chain and provide the scheduling for the chain. Typically have a scan time and handle all input and output from the database. Secondary blocks take data from the upstream block and perform some type of action or calculation.

10

Understanding iFIX

A chain is a series of connected blocks that create a control or monitoring loop. For example, in a particular control loop, you need to read a data point, manipulate it with a standard formula, and write it out. The chain that executes this control strategy might consist of an Analog Input block connected to a Calculation block connected to an Analog Output block. In iFIX, calculations needed for scaling or combining multiple I/O data points can also be handled directly in the graphics dynamic links. The following figure displays both control strategies.

Database Control Strategies For complete information on creating and maintaining a database, refer to the Building a SCADA System manual.

Scan, Alarm, and Control Program


The Scan, Alarm, and Control program (SAC) is a system application that runs on a SCADA node. This program is responsible for executing the logic of the database chains. SAC performs the following functions: Retrieves data from various data sources Translates the data into the format expected by the database Checks the data against the alarm limits and generates alarm messages

11

Understanding iFIX

Executes the control logic Detects exceptions Makes requested writes to the database

Each database chain also contains the information that determines whether SAC processes the chain based on time-based, exception-based, or one-shot processing. A node can perform both time-based and exception-based processing simultaneously. This feature gives you the ability to use the best processing strategy for each data point in your system.

Time-Based Processing
Most applications work by acquiring and calculating data at regular intervals, defined in seconds, minutes, or hours. iFIX can perform any combination of time-based processing. This allows you to balance system resources between data that needs to be acquired quickly and data that can be acquired over longer intervals. SAC can perform time-based processing in: Subseconds (0.05 seconds to 0.95 seconds) Seconds Minutes Hours

The frequency with which SAC retrieves data is called the scan time. For more information on scan times, refer to the Building a SCADA System manual.

Exception-Based Processing
Often, it is more efficient to process data after key events occur, such as the changing of a set point or the closing of a contact. Processing that is triggered by events rather than time is known as exceptionbased processing. Exception-based processing is essential for true distributed SCADA applications that monitor a large number of I/O devices. For example, an oil field may be monitoring pipelines through a large network of remote terminal units (RTUs). The data from the RTUs changes infrequently, so there's no need to acquire data at a fixed interval. However, when the data does change, oil field operators need to know about it immediately. iFIX senses the changed value and processes it immediately. SAC can perform exception-based processing on the following events: Data changes in the database. Unsolicited messages from the process hardware. Operator actions. Instructions from software applications.

12

Understanding iFIX

One-Shot Processing
When the first block in a chain has a scan time of zero, SAC processes the chain only when the primary block goes on scan. This is known as one-shot processing.

Scheduler
There are certain tasks that you will want to perform at a specified time or interval or when a change occurs in the process. To schedule these tasks, you will need to define the time or event that triggers the action that you want to occur. The Scheduler is a iFIX application that runs in the foreground or background, monitoring the system and triggering actions based on timers or events. It can be run as a service under Windows, allowing you to log in and out of a Windows node without affecting or triggering scheduled events regardless of whether or not the iFIX WorkSpace is running. The spreadsheet design of the Scheduler lets you easily create and edit schedules in the configuration environment and view the status and statistics in the run-time environment. It provides you with the ability to create as many schedules as you need to organize your work logically and efficiently, and to run multiple schedules at the same time. Within each schedule you can create as many tasks, known as entries, as you need to run as often as you require. The Scheduler can trigger actions based on five events. These events can use most available data sources as a trigger. Time-based entries are not tied to data sources, and actions are triggered based on a monthly, daily, continuous, or one-shot basis. Script Authoring Experts are provided for common events, such as opening a picture, running a report, or closing a contact. These Experts prompt you for information pertinent to the operation, generate a Visual Basic script, and tie the script to the appropriate event. For complete information on using the Scheduler, refer to the Scheduler section in the Mastering iFIX manual. For more information on VBA scripting, refer to the Writing Scripts manual.

Distributed Networking
iFIX networking design incorporates two basic principles: true distributed processing and on-demand data transfer. The following sections provide more information on: Distributed Processing On Demand Data Transfer Centralized Processing

Distributed Processing
Many systems operate in a hierarchical fashion that leave individual computers vulnerable to system failures anywhere on the network. The architecture of iFIX allows plants to distribute critical functions among all nodes on the network. In a distributed processing network, each node independently executes the tasks assigned to it. One advantage of this strategy is that nodes can be taken off-line without bringing the whole network down. When a node looks for data from an off-line node, the networking application notifies the requesting node, so that the node handles the missing data gracefully. Even though each node has integrity as an independent station, nodes can also access data anywhere on the network. For example, an iClient can display a picture with links to many different SCADA nodes without requiring additional configuration work or the need to have a local copy of the database.

13

Understanding iFIX

Sessions With iFIX, you can selectively configure which nodes can access data from a SCADA node on the network. A communication link between two nodes over a network is called a session. When a node establishes a session with a SCADA node, data and alarms can be sent between the nodes. The following figure illustrates session communication.

Network Session Dynamic Connections You can also configure your node to automatically make connections online to remote SCADA nodes that are not specifically configured on your node. These connections, called dynamic connections, are described in more detail in the Configuring Remote Nodes section in the Setting up the Environment manual.

On Demand Data Transfer


Most industrial automation software systems require every node that uses data from a SCADA node to have a copy of the entire database stored locally. The resulting network traffic can use significant system resources. To conserve system resources for local tasks, iFIX reads and writes data on demand and only moves requested data over the network. File Storing and Sharing Using iFIX and the built-in file sharing capabilities of Windows, you can store data that is needed by several nodes in one convenient location. Using the Windows Explorer, you can establish a networked drive connection to any other node in your local network. Once established, you have instant access to any shared files on that node, including databases, pictures, schedules, and other important iFIX files.

14

Understanding iFIX

Access to shared iFIX files by other computers can be controlled by implementing Windows security features. Refer to your Windows documentation for more information on file sharing and security.

Centralized Processing
Some applications only need one node to perform the required functions. It is easy to convert a distributed node to a stand alone node or a stand alone node to a distributed node. iFIX operates just as smoothly in a single computer environment as it does in a distributed computer environment. The following figure shows a distributed and centralized process.

Distributed and Centralized Processing

Failover
iFIX includes a powerful failover feature that maximizes system performance by recognizing multiple paths to your data. Should a SCADA node or LAN connection become unavailable, iFIX can switch from one path to another automatically. The process of switching from one connection to another is known as failover. Failover works the same whether you are using SCADA server failover or LAN redundancy. iFIX failover allows you to connect an iClient to both primary and backup SCADA nodes that are connected to the same PLC. If the connection to the primary SCADA node is lost, iFIX automatically

15

Understanding iFIX

fails over to the backup SCADA node. With LAN redundancy, you can establish two physical network connections between an iClient and a SCADA node so that if one network path is lost, iFIX automatically fails over to the other network path. These two features can be used together for the highest level of reliability. For more detailed information on failover, refer to the Failover and Redundancy section of the Mastering iFIX manual.

Alarming
iFIX has a sophisticated system for generating, displaying, and storing alarms and messages. You may selectively route alarms and messages to the following: Any node on the network. Printers connected to a node. Disk-based files. Alarm summary displays. Alarm history windows. Relational databases.

For more information, refer to Alarm Routing. On a local node, the programs that perform these alarm functions are called alarm tasks. iFIX also provides built-in support for the following functions: Acknowledging remote alarms. Suspending alarms (for example, during startup). Delaying alarms. Triggering scripts based on alarms. Filtering alarms based on type, priority, sender, etc.

Types of Alarms and Messages


iFIX generates one type of alarm and four types of messages: Block Alarm database blocks generate alarms when block values fall outside pre-defined limits, when a change of state occurs, or when communication errors occur. Event Message blocks can also send messages to printers and the alarm history file to indicate that an event occurred at that block. These messages do not appear in operator displays and do not require operator acknowledgment. Operator Message applications generate messages that create a history of important operator actions. These include messages that are generated by electronic signatures.

16

Understanding iFIX

System Message applications generate alarm messages that track system alerts and problems. Application Message applications, such as Recipe and Historical Collect, can also send messages to printers and the alarm history file to provide records of activity on that application.

Alarm Routing
iFIX uses a selective alarm configuration based on alarm areas, which are physical or functional divisions of your plant. An unlimited number of alarm areas are provided to serve as distribution points for alarms and messages. Each of these alarm areas can be custom named to easily identify it within your system. The first 16 alarm areas in iFIX are labeled A through P by default. Each alarm area can then be routed to send alarms and messages to selected alarm destinations. For example, suppose you have two production lines and want to show all the alarms generated on these lines. You also want to show a separate alarm whenever the level of the tank in either production line falls below a certain level. One way to do this is to create two separate alarm areas called LINES and TANKS. Assign all the blocks that monitor these production lines to LINES and only the blocks that monitor the tanks to TANKS, as shown in the following figure. If an alarm occurs on either line, but not in the tanks, only NODE1 would receive the alarm.

Alarm Areas For detailed information about alarm routing refer to the Implementing Alarms and Messages manual.

Operator and Application Message Routing


Operator and application messages can be independently routed to alarm areas. This feature allows you to separate operator and application messages from alarms. SCADA nodes act as alarm servers and distribute alarms and messages over the network. Other nodes act as alarm clients and receive alarms. When you set up a SCADA node to distribute alarms over the network, it sends the alarms and messages to every node that has a session established with it. A non-SCADA node that generates operator messages and system alarms directs those messages to its respective SCADA nodes.

17

Understanding iFIX

Security
iFIX provides a powerful and sophisticated user-based security system which allows you to protect against unauthorized: Access to iFIX applications. Access to critical application functions. Access to operator display files (pictures) and recipes. Write access to database blocks.

Security Areas
To protect database blocks from unauthorized writes, iFIX employs security areas. You can think of a security area as a group of database blocks with the same security level. Operators with rights to a particular security area can write to any database block that is a member of that security area. The following figure illustrates how iFIX uses security areas.

Security Areas In this example, there are two security areas known as LINE1 and LINE2. All four database blocks shown belong to LINE1, but only the two database blocks on the right belong to LINE2. The Engineering group is assigned rights to LINE1 and the Operations group is assigned rights to LINE2. Since all database blocks belong to LINE1, the Engineering group can write to all four database blocks. The Operations group is assigned rights to LINE2, but not to LINE1. Therefore, the Operations group can only write to the two database blocks on the right.

18

Understanding iFIX

Security Application
The Security application consists of two parts: Security Configuration and Login. For complete information on configuring security and logging in, refer to the Implementing Security manual. Security Configuration The Security Configuration program allows you to do the following: Enable or disable security on a node. Create and edit user and group accounts. Establish automatic login at startup. Assign users rights to use programs and program functions, as well as write access to database blocks. Assign user names and passwords. Assign security area names.

NOTE: You can assign security protection to individual pictures in the iFIX WorkSpace and recipes in Recipe Builder. Login Once a node has security protection, operators must access the Login program and enter their user name and password. After logging in, operators can access the protected features of the node to which they have rights.

System Functions
iFIX provides real-time data to plant personnel and to other software applications throughout a plant. This real-time data presentation is the key to more efficient use of resources and personnel, and ultimately, to more automation. SCADA functions include: Basic Functions HMI and SCADA Functions Reporting Functions Open Architecture Functions Application Functions

19

Understanding iFIX

Basic Functions
iFIX performs basic functions that enable specific applications to perform their assigned tasks. The two most basic functions are data acquisition and data management. The following figure illustrates the basic functions of iFIX.

iFIX Basic Functions Data acquisition is the ability to retrieve data from the plant floor and process that data into a usable form. Data can also be written to the plant floor, thereby establishing the critical two-way link required by control software. iFIX uses OPC to request and utilize plant floor data. OPC is a client/server model with a common interface that allows iFIX to communicate with standard objects, methods, and properties. For additional information on OPC, refer to the OLE for Process Control (OPC) section. iFIX requires no proprietary hardware to acquire data. It communicates directly with I/O devices already in place through a software interface called an I/O driver. In most cases, iFIX can work with the I/O hardware installed in your plant. Even if your plant has I/O devices from different manufacturers on the same network, I/O drivers can access and work with all of them. We currently offer an extensive catalog of I/O drivers that support best-selling and specialty I/O devices. We also offer the OPC Toolkit, a development tool that allows you to quickly and easily write high performance, reliable OPC enabled I/O servers. Any server written with the toolkit can talk to OLE automation or OPC client applications. The toolkit includes an online training session, online help, and universal OLE Automation interfaces. Servers written with the OPC toolkit are open, reliable and high performing servers that incorporate multi-threading, queue-based messaging, and event-based processing. Once data is acquired, it is manipulated and channeled according to requests from your application software. This process is known as data management.

HMI and SCADA Functions


One of the most important goals of automation is to use plant resources more efficiently. Traditionally, plant floor operations have been monitored and controlled through control room panels. iFIX can enhance or replace many of these traditional control room functions, including: Monitoring Supervisory Control Alarming Control

20

Understanding iFIX

The following figure illustrates the HMI and SCADA functions.

HMI and SCADA Functions

Monitoring
Monitoring is the ability to gather and display real-time plant-floor data to all relevant personnel. Powerful numeric, text, and graphical formats are available to make real-time data more accessible, easier to read, and easier to understand.

Supervisory Control
Supervisory control is the ability to monitor real-time data coupled with the ability to change set points and other key values directly from your computer. With iFIX, you can easily control who has access rights to this data and which data points can be changed.

Alarming
Alarming is the ability to recognize exceptional events within your process and immediately report those events to the appropriate personnel. Alarms are generated based on the control limits you establish and can be reported in a variety of ways. For additional information refer to the Implementing Alarms and Messages manual.

Control
Control is the ability to automatically apply algorithms that adjust process values and thereby maintain those values within set limits. Control goes one step beyond supervisory control by removing the need for human interaction. iFIX includes continuous control, batch control, and statistical process control capabilities. It can be used to control your whole process or part of your process.

21

Understanding iFIX

Reporting Functions
Real-time data is only one level of information processing. Many plants require the ability to report or store real-time data for later analysis. iFIX allows you to use any third-party reporting application that supports ODBC queries to create reports based on critical system and process information. The following figure illustrates the reporting functions.

Data Analysis Functions

Data Archiving
Any data point in the system can be sampled and stored in data files at operator-specified rates. This archived data represents a powerful tool for process optimization and correction. At any time, the data can be retrieved from the data files to create trend displays of historical data. Managers and engineers can use this data to examine the events leading up to a critical event after addressing more immediate problems.

Reports
Detailed reports are important tools for reviewing the performance of a process. They allow you to quickly grasp the relationships between specific pieces of manufacturing process data so that you can make effective decisions. Using any third-party reporting application that supports ODBC queries, you can create customized reports based on iFIX real-time and historical data. When you use iFIX realtime data, you generate the report with current data extracted from the iFIX database. When you create a report using iFIX historical data, you generate the report based on data gathered over a period of time. For example, suppose you are the production manager of a cookie factory. At the end of each shift you want to generate a customized report that shows the amount of down time on each production line.

22

Understanding iFIX

You would use the Scheduler to request this report at certain times using iFIX historical data. In addition, if a failure occurs on a particular line you want to have your system automatically generate a report showing the tank level of each ingredient, the state of the mixer and dropper, and the temperature of the oven at the time of the failure. When a failure occurs, the requested iFIX real-time data is extracted from the iFIX database and displayed in a report. The data in this report can then be analyzed to help prevent future failures. For your reporting solution, we recommend using Crystal Reports XI. This reporting application uses ODBC to access iFIX data sources, allowing you to create professional, customized reports. The Crystal Report wizards make the process of defining your query and designing the layout of your report quick and easy. Crystal Reports also provides superior sorting capabilities and lets you insert informative graphs that help you to effectively analyze your process data. Once created, your queries can be saved so you can quickly generate future reports based on these predefined queries. For complete information on using Crystal Reports, refer to the Crystal Reports help. If you plan to create Crystal Reports run-time files so that you can run reports on a target node without a full development copy of the product, refer to the Crystal online help. Licensing restrictions apply. The Business Objects web page provides more information on licensing: http://www.businessobjects.com/products/reporting/crystalreports/licensing/default.asp.

Open Architecture Functions


Many plants have unique needs that can be solved through access to real-time data. iFIX provides read and write access to any data point in the system. This open architecture allows you to use custom and third-party applications to resolve your unique automation needs. The following figure illustrates the open architecture functions.

Open Architecture Functions

23

Understanding iFIX

The iFIX architecture also allows you to write scripts that provide key real-time data. Visual Basic for Applications is integrated directly into iFIX to allow you to quickly and easily develop scripts that interact with plant-floor data. For more information, refer to the Writing Scripts manual.

Application Functions
iFIX is a multi-tasking system. Each node can run several different applications simultaneously. Internally, critical programs have priority access to system resources and applications may be preempted to respond to a more critical resource request. All iFIX applications can be classified into three types: User configuration applications System applications User applications

User Configuration Applications


User configuration applications allow you to create the instructions and logic that monitor and control your process. These applications create configuration files. When started, system applications read the configuration files and use the information found here to execute the assigned tasks. The Event Scheduler is an example of a user configuration application. In the Event Scheduler, you define the event that triggers an action (for example the time of day or a change in your process) and the action that you want to occur. Once the event is scheduled, the action automatically triggers when the event occurs. No further interaction is required.

System Applications
System applications work with your process in real-time. These applications receive instructions from configuration files and require little or no interaction. In general, system applications have priority access to system resources. Historical Collect is an example of a system application. Once started, it retrieves data and stores it in the Historical Data directory defined in the SCU. It requires no interaction and the system can be configured to automatically start Historical Collect when iFIX starts up.

User Applications
User applications are programs that you interact with in order to work with the process or process data. User applications also create and use configuration files. The Alarm Summary Object (OCX) is an example of a user application. It requires you to interact with the system by manipulating the Alarm Summary Object that is embedded in your picture. Some programs may serve as more than one kind of application. For example, the Database Manager is a user configuration application for creating process databases. However, Database Manager also acts as a user application because it allows you to display real-time data in spreadsheet form.

24

Understanding iFIX

Using the Proficy iFIX WorkSpace


The Proficy iFIX WorkSpace is your starting point for using iFIX. It provides an integrated and flexible configuration environment that lets you create and modify documents for the local node. As part of this environment, the Proficy iFIX WorkSpace also launches and is integrated with iFIX applications, eliminating the need to switch to other programs. Instead the Proficy iFIX WorkSpace provides a work area with all the necessary tools to add a picture, create a schedule, or change a script. Using the Proficy iFIX WorkSpace, you can also integrate ActiveX documents from other programs, such as Word and Excel, with your iFIX files. Like iFIX documents, ActiveX documents appear in the work area that the Proficy iFIX WorkSpace supplies. And if you create your own custom ActiveX documents, the WorkSpace automatically displays the menus and toolbars that these documents define when you open them. You can display a hierarchical view of your files with the Proficy iFIX WorkSpace. This view serves as a navigational tool to help you locate iFIX documents and acts as a launch pad for iFIX and thirdparty applications. The Proficy iFIX WorkSpace also lets you access the Visual Basic Editor (VBE). This editor lets you integrate Visual Basic for Applications (VBA) scripts into your iFIX files. By writing a VBA script, you can customize and automate the behavior of iFIX. For example, you can write a script to handle custom run-time data entry instead of using the data entry mechanisms provided with iFIX. But the Proficy iFIX WorkSpace is not only a configuration tool. It also provides a run-time environment as well that lets operators display and run your iFIX documents. This environment lets you enable security restrictions that lock operators into a pre-defined set of pictures. This chapter discusses how to use the Proficy iFIX WorkSpace and navigate the system tree. It also explains the available options and describes the two Proficy iFIX WorkSpace environments.

Understanding the Proficy iFIX WorkSpace


Before you begin using the Proficy iFIX WorkSpace, you should understand certain key concepts. Within the WorkSpace are the system tree and the work area. Before you use either one, you should use the System Configuration Utility (SCU) to properly configure the nodes on which you will use the WorkSpace. To learn more about the SCU, refer to the Setting up the Environment manual.

Starting the Proficy iFIX WorkSpace


After you install and configure iFIX, you can begin using the Proficy iFIX WorkSpace. In Configure Mode By default, the WorkSpace starts when you start iFIX. This is because the WorkSpace is configured to run as a startup task, by default. When the iFIX WorkSpace opens in the default mode, it starts in configure mode. You can also start the WorkSpace in configure mode by clicking Start and pointing to Programs, Proficy HMI SCADA - iFIX, and then the iFIX WorkSpace. Additionally, you can start the Proficy iFIX WorkSpace in configure mode using this command line:
WORKSPACE "C:\My Path\Filename.grf"

25

Understanding iFIX

Use this command to open a specified picture on startup. For more information on configuring startup tasks, refer to the iFIX Background Tasks section. In Run Mode You can start the iFIX WorkSpace in run mode by using additional command line parameters. For example, here you use the /fo command to specify a picture that you want to open in run mode:
WORKSPACE /fo "C:\My Path\Filename.grf"

For more information, refer to the Command Line Parameters for the iFIX WorkSpace section. Once you start the WorkSpace, you can toggle between configure mode and run mode by using the Ctrl+W shortcut, or by clicking WorkSpace and then Switch to Run (or Switch to Configure).

Command Line Parameters for Starting the iFIX WorkSpace


You can start the iFIX WorkSpace (WorkSpace.exe) in run mode, from a command line, by using the parameters listed in the following table. To open a specific picture within the WorkSpace use the /FileOpen or /FO command. Additionally, you can use other command line parameters to specify the size of the WorkSpace window, and whether the menu and status bar display when the WorkSpace opens. For example:
workspace /fo "C:\Program Files\GE Fanuc\Proficy iFIX\PIC\filename.grf" /WL 50 /WT 100 /WB 700 /WR 800 /MT n

Be aware that if you use these command line parameters to open an iFIX WorkSpace picture on startup, the command line parameters override the settings defined in the StartUp Pictures tab of the User Preferences dialog box. These settings also override any configured Window Properties (Title Bar, Resizable, Always on Top fields) in the Picture Preferences tab of the User Preferences dialog box. It does not change the User Preferences; it just overrides them. NOTE: Do not use startup commands after the iFIX Workspace is already running. FIX Desktop and WSPROXY Commands Be aware that the /FileOpen and /FO commands, as well as the other commands listed in the table below, are iFIX Workspace start up commands only. In FIX Desktop Draw and View, if you want to use any other WSPROXY commands along with the WorkSpace command line parameters, make sure that the WSPROXY commands appear after the WorkSpace command line. For example, if you want to open a picture in the iFIX WorkSpace, you can use command line parameters to define how you want the WorkSpace window to appear when it opens. You can then use the WSPROXY OPENPIC command to open the actual picture, as demonstrated in this example:
RUNTASK WORKSPACE "/WL 50 /WT 100 /WB 700 /WR 800 /MT n" RUNTASK WSPROXY "OPENPIC {C:\My Path\FILENAME.grf}"

By using the WorkSpace command line parameters before the WSPROXY command, you can designate how you want the WorkSpace window to appear when it opens the picture. This is called a pop-up window. Be aware that if the picture path contains spaces, and you are using the WORKSPACE startup command in the Command Language Editor in the FIX Desktop environment, enclose the path and picture name in brackets {} like this:
RUNTASK workspace "/fo {C:\Temp Files\MyPicture.grf} /WL 50 /WT 100 /WB 700 /WR 800 /MT n

26

Understanding iFIX

Do not use WorkSpace startup commands, like the one illustrated above from the Command Language Editor, after the iFIX Workspace is already running. Use WSPROXY instead, as described in the previous example. List of Command Line Parameters The following table lists the command line parameters available for starting the iFIX WorkSpace. iFIX WorkSpace Command Line Parameters Parameter /FileOpen filename Alternative /FO filename Description Opens a specified iFIX picture in run mode, where filename is the path and file name of the picture you want to open. Use the full path when specifying the picture name to open. Use quotes to surround a path with spaces. For example:
workspace /fo "C:\Program Files\GE Fanuc\Proficy iFIX\PIC\filename.grf"

If you do not specify a file name, the Open dialog box appears when the WorkSpace opens, so you can browse and select a file to open. NOTE: When you use the /FileOpen command line parameter, the WorkSpace starts up without using the settings saved in the UserPreferences.ini file. Instead, the WorkSpace starts with the attributes provided by the command line parameters of the /FileOpen command.

/WindowLeft num

/WL num

Indicates the x-coordinate of the screen's top left corner, where num is the number of pixels between the left-side of the desktop screen and the left-side of the Workspace window you open. Indicates the y-coordinate of the screen's top left corner, as a positive number, where num is the number of pixels between the top of the desktop screen and the top of the Workspace window you open. Indicates the y-coordinate of the screen's bottom right corner, as a positive number, where num is the number of pixels from the top of the desktop screen to the bottom of the Workspace window you open.

/WindowTop num

/WT num

/WindowBottom num

/WB num

27

Understanding iFIX

iFIX WorkSpace Command Line Parameters Parameter /WindowRight num Alternative /WR num Description Indicates the x-coordinate of the screen's bottom right corner, where num is the number of pixels from the left-side of the desktop screen to the rightside of the Workspace window you open. Indicates whether the WorkSpace hides or displays the main menu and title bars in the window when it opens. Use y to show the title bar and menus. Use n to hide the title bar and menus. /StatusBar (y|n) /SB (y|n) Indicates whether the WorkSpace hides or displays the status bar when it opens. Use y to show the status bar. Use n to hide the status bar. /Help /? Displays a help dialog with all the supported options for the /FileOpen command. For example, this command would display the help dialog box: workspace /?

/MenuAndTitleBar (y|n)

/MT (y|n)

Example This example uses the command-line options to open the iFIX WorkSpace in run mode:
workspace.exe /FO "C:\Program Files\GE Fanuc\Proficy iFIX\PIC\ChartGroupDemo.grf" /WL 50 /WT 100 /WB 700 /WR 800 /MT n

In this example, the iFIX Workspace displays the picture's top left corner at 50 pixels across, 100 pixels down. The width of the WorkSpace is 750 pixels (WindowRight - WindowLeft). The height of the WorkSpace is 600 pixels (WindowBottom-WindowTop). The following figure illustrates the WindowTop, WindowLeft, WindowBottom, and WindowRight values for this example.

28

Understanding iFIX

Shut Down the iFIX WorkSpace with a VBA Script


When the iFIX WorkSpace is open in run mode, one way to close the WorkSpace window is through a VBA command script using the Quit Method. This method is helpful when you restrict other portions of the WorkSpace window, such as the title bar and menus, that you would normally use to exit the WorkSpace application in run mode. For instance, if environment protection is enabled with menu and title bar restrictions, you may want to provide a button that closes the open WorkSpace window in run mode. Another example would be from View, if you open a pop-up window of the iFIX WorkSpace in run mode that does not include the menu or title bar. In this scenario, you may also want to include a button in your picture that you can click to close the WorkSpace window. Be aware that if security is enabled, the user profile should not restrict the "WorkSpace Runtime Exit" feature. For more information about configuring security features, refer to the Application Features section of the Implementing Security manual. TIP: You can also close an open WorkSpace window in run mode by using the ALT+F4 keyboard shortcut, provided your security is configured to allow the user to shut down the WorkSpace. Example The following script uses the Quit method from a push button in an iFIX picture. The push button includes a caption "Close Window" within the picture. When the Close Window button is clicked in run mode, the script displays a message box indicating whether you want to close the WorkSpace. Click Yes to close the WorkSpace window.
Private Sub CommandButton1_Click() Dim lAccess As Long Dim Msg, Style, Title, Response Msg = "Are you SURE you want to exit the workspace?"

29

Understanding iFIX

Style = vbYesNo + vbQuestion Title = "Workspace Exit" Response = MsgBox(Msg, Style, Title) If Response = vbYes Then Application.Quit 3 End If End Sub

NOTE: It is not required to include a message box with a confirmation when you create this script. You can use the Quit method without a message box.

Understanding the System Tree


Your main navigational tool for locating files is the system tree. This tool appears as a hierarchical display of folders, as the following figure shows. By opening and closing folders, you can locate and display your documents in one step.

Proficy iFIX WorkSpace System Tree The system tree also acts as a program launcher. By double-clicking an application in the system tree, you can start any iFIX or third-party application.

Understanding the Work Area


The work area, shown in the following figure, is the window that displays your iFIX and ActiveX

30

Understanding iFIX

documents. Whenever you open a document, the Proficy iFIX WorkSpace displays the file in the work area and automatically activates the tools needed to modify it.

Proficy iFIX WorkSpace For example, when you double-click a picture, it appears in the work area window and all the tools associated with modifying a picture become active. It's almost as if you started a separate graphics program and opened the picture. This feature makes creating and modifying iFIX documents fast and easy because you do not need to leave the Proficy iFIX WorkSpace or search for the appropriate application to launch. All of the tools you need are built-in and ready to use.

Using the Virtual Keyboard


iFIX provides a virtual alpha-numeric keyboard that installs with iFIX installation. This keyboard allows you to work in touch-screen environments or to use a mouse to enter passwords and other data. When you activate the virtual keyboard, it is available by clicking the following button:

This button is on the right side of the current window's title bar. Clicking the button brings up the keyboard, as shown in the following figure.

31

Understanding iFIX

Virtual Keyboard To resize the keyboard and configure keyboard options: Use the SzUp and SzDn buttons to resize the keyboard to one of the twelve available sizes. Use the minimize button to dock the keyboard on the right side of the current application window's title bar. Use the Kybd, Help, Edit, Info, Num, Win, Mag, Macro and Calc buttons to toggle display of the options. Click and drag any non-button area of the keyboard to move the keyboard on your desktop. Access the Help and the tutorial for the virtual keyboard, as well as general setup and configuration information, through the Menu button on the keyboard.

To use the virtual keyboard, you must have a valid hardware key for iFIX 3.0 or higher. If you are using Terminal Server, each licensed client has access to a copy of the virtual keyboard. Activating the Keyboard GE Fanuc recommends that, to activate the virtual keyboard, you add it to your Windows Startup folder. To activate the virtual keyboard from the Windows Startup folder: 1. 2. 3. 4. In your Proficy iFIX directory, right-click on the MYTSOFT.EXE file. Select Copy from the list. Navigate to the C:\Documents and Settings folder. Drill down to the following folder:

32

Understanding iFIX

C:\Documents and Settings\All Users\Start Menu\Programs\Startup 5. 6. 7. Right-click in the white space of the Startup directory. Select Paste Shortcut. If you want, rename the shortcut.

The next time you start your computer, the keyboard will activate automatically.

Using the System Tree


The system tree provides a hierarchical view of the files on the local node. When you first start the Proficy iFIX WorkSpace, the system tree shows the local node name at the top of the tree and the following folders and applications: System Tree Item Alarm History Description

Lets you display the last 200 alarms and messages received by the local computer. Lets you create and modify process databases.

Database Manager Documents folder

Lets you create any Word and Excel documents. If you save these documents in the Application path, they appear in the system tree. Only Word files with the extension .DOC and Excel files with the extension .XLS appear. Contains Dynamo sets.

Dynamo Sets folder FIX Recipes folder Globals folder Help & Information folder Historical Assignment

Contains your control and master recipes.

Contains global variables, user-defined variables, and threshold tables. Contains iFIX Help and electronic books.

Lets you create historical collection groups.

33

Understanding iFIX

System Tree Item I/O Drivers folder Mission Control

Description

Contains I/O drivers configured for the local node.

Lets you monitor background tasks. These tasks include: Historical Collect, I/O Control, Auto Alarm Manager, Alarm ODBC services, and the Scan, Alarm, and Control (SAC) program. Contains your pictures. Contains reports generated by your reporting package. Contains your schedules. Contains the Security Configuration and Login programs. These programs let you define your security configuration and login to the local node once security is enabled. Lets you configure the local node.

Pictures folder Reports folder Schedules folder Security folder

System Configuration

If your computer has Proficy Batch Execution or greater installed, you will also see the following items: System Tree Item Batch Execution Books Batch Execution Configuration Batch Execution Equipment Batch Execution Recipes Description Opens the Batch Execution electronic books. Lets you configure Batch Execution.

Contains your equipment database. Contains the Batch Execution procedures, unit procedures, and operations.

34

Understanding iFIX

Understanding System Tree Paths


Associated with each application and folder in the system tree is an iFIX path. These paths show where the files reside on your computer and are defined in the System Configuration Utility (SCU). To learn how to change an iFIX path, refer to the Setting up the Environment manual.

Showing and Hiding the System Tree


By default, the system tree is docked on the left side of the screen. You can dock it on the other side of the screen by dragging it. Likewise, if you want more screen space for your pictures and schedules, you can set the system tree to float on top of your open documents by dragging it away from the sides of the screen. You can resize the system tree while it floats by dragging its edges. When the system tree is docked, you can only resize its width, as the following figure shows.

Resizing the System Tree If resizing the system tree does not give you the space you need, you can hide the tree completely.

Navigating the System Tree


You can move up and down the system tree by selecting items with the mouse or by using the following keys:

35

Understanding iFIX

Use the... Up arrow key Down arrow key Page Up key Page Down key Left arrow key Right arrow key Home key End key

To... Move up the system tree.

Move down the system tree.

Move up through the system tree quickly. If you have resized the system tree, you can move over the visible portion of the system tree with the Page Up key. Page down through the system tree quickly. If you have resized the system tree, you can move over the visible portion of the system tree with the Page Up key. Close a folder.

Open a folder.

Move to the top of the tree. Move to the bottom of the tree.

Opening and Closing Folders


Opening and closing folders is similar to using Windows Explorer, as the following figure shows:

36

Understanding iFIX

Right-Clicking the System Tree


You can right-click any item in the system tree to display a pop-up menu. The contents of the menu depends on the item you select. For example, the pop-up menu of the Picture folder lets you create a new picture and display the folder's path. The pop-up menu of a rectangle, on the other hand, lets you edit the object's scripts, change the object's properties, and modify the object by cutting, copying, pasting, deleting, and duplicating it.

Dragging and Dropping Files


With the Proficy iFIX WorkSpace, you can copy and move objects by dragging and dropping them into open documents. In general, you can drag an object or a Dynamo from an open picture, an open Dynamo set, or the system tree and drop it into: An open picture. An open Dynamo set. A user-defined global file.

For more information on Dynamos, refer to the Creating Pictures manual. For information on userdefined variables and the global page, refer to the Writing Scripts manual.

37

Understanding iFIX

Starting Applications from the System Tree


You can start any application in the system tree by double-clicking its icon. The Proficy iFIX WorkSpace starts the associated application and, when possible, displays the application in the workarea. In some cases, the application opens in its own window on top of the Proficy iFIX WorkSpace.

Understanding WorkSpace Environments


The WorkSpace provides both a configuration and a run-time environment. The configuration environment provides all necessary development tools, including access to toolbars and the files in the system tree. In addition, any process-monitoring background tasks that may be running, such as your I/O drivers, Historical Collect, and enabled alarm services, continue to run while the configuration environment is active. The run-time environment, on the other hand, is designed for operators. With this environment, operators can display pictures and monitor your process. Typically, the run-time environment is configured to restrict operator access to other parts of iFIX by hiding menu bars and disabling the ability to task switch. You can toggle between the two environments to test and run your pictures and schedules. As you switch environments, the status bar updates. In the configuration environment, the text Configure appears. When you switch to the run-time environment, the text changes to Run. Documents open in one environment remain open even when you switch to the other environment. For example, if you have two pictures and one schedule open in the configuration environment, these files remain open when the run-time environment becomes active. If you close one of the pictures in the run-time environment and switch back, the picture that you closed is now closed in the configuration environment. The other picture and the schedule both remain open. You cannot switch to the configuration environment in the Proficy iFIX WorkSpace while a script is running. Similarly, you cannot exit the application. Once the script completes, you can switch environments and exit normally. The same restrictions apply to scripts running in pictures. You cannot close a picture until all running scripts complete. Switching to the run-time environment also hides the system tree, if it is displayed, and your toolbars. Switching back reverses the process. NOTE: To improve performance, close unnecessary, open documents before switching between environments to test a picture.

Displaying the WorkSpace Full-Screen


You can display the WorkSpace full-screen in either or both of its environments. Displaying the WorkSpace full-screen lets you see the exact same scale and display sizes that operators will experience. When you display the WorkSpace full-screen, it hides its menu bar and any docked toolbars. Floating toolbars remain visible. The WorkSpace also hides the system tree in the configuration environment if it is docked. In the run-time environment, the system tree and all toolbars are always hidden.

38

Understanding iFIX

Enabling Environment Protection


You can restrict operator access to the menu bar and pop-up menus, and prevent task switching by enabling environment protection. Once enabled, environment protection takes effect when you switch to the run-time environment. For a detailed description of environment protection and how to enable it, refer to the Setting Up the Environment manual.

Disabling Error Dialog Boxes


If an error occurs in the run-time environment, an error dialog box displays requiring user intervention. You can disable error dialog boxes for particular errors by editing the FILTEREDERRORS.INI file in the Local path. For example, you may want to suppress the error dialogs when network sessions are lost. In order to do this, add the error codes you want filtered in the INI file as follows:
;To add an error code to be filtered increment the count and set ;the Error equal to the return code [ErrorCodes] Count = 4 Error1 = 1620 Error2 = 1914 Error3 = 1915 Error4 = 8517

In this example, all typical network session errors are suppressed. After you edit the FILTEREDERRORS.INI file, restart the WorkSpace to ensure your changes take effect.

Disabling Proficy Historian Errors in the WorkSpace


To suppress the Proficy Historian errors, you need to edit the filterederrors.ini file found in the C:\Program Files\GE Fanuc\Proficy iFIX\local path and add the Historian error codes you want filtered. To edit the fiterederrors.ini file: 1. 2. 3. Add a new section [iHistErrorCodes] if it is not already present in the .ini file. Add a new key Count = the number of error codes you want to suppress. Add a new key iHistError and set it equal to the return code.

Examples If you want to suppress two Historian errors, you would modify the filterederrors.ini file as follows:
[iHistErrorCodes] Count =2 iHistError1 = -3 iHistError2 = -2

39

Understanding iFIX

If you want to suppress additional errors, increment the key value of Count as follows:
Count = 3

Add a new iHistError3, and set it equal to the error code. Historian Server Connection Time-out During a failed write attempt to the Proficy Historian Server, the iFIX WorkSpace becomes inactive. You can control how long this lasts by setting the number of seconds you allow for the connection time-out. The default is 90 seconds. To configure the time-out, add this setting to the FixUserPreferences.ini file in the iFIX Local folder:
[Historian] TimeoutSecs=10

Here, the time-out is set to 10 seconds. The valid range is 5 to 300 seconds, though not enforced.

Working with Documents


Once the Proficy iFIX WorkSpace starts and the system tree appears, you can create and open documents. The Proficy iFIX WorkSpace Standard toolbar provides buttons for creating new pictures, schedules, and Dynamo sets. You can create other types of ActiveX documents with the New command from the File menu.

Opening Documents
To open a document, double-click the document's icon in the system tree. The Proficy iFIX WorkSpace activates the associated tools or starts the required application depending on the selected document. If you want to open a document that is not in the system tree, click the Open button from the Standard toolbar and select the file you want to open.

Deleting and Renaming Documents


You can delete or rename any closed document in the system tree by right-clicking it and selecting Delete or Rename from the pop-up menu. When you rename a document, the Proficy iFIX WorkSpace prompts you for the new name. Once you enter a name, it appears in the system tree.

Understanding Toolbars
With the Proficy iFIX WorkSpace, you can customize the toolbars provided with iFIX. You can also create custom toolbars and toolbar buttons, and share them among multiple computers. This section explains how to complete these tasks. Toolbars provides buttons for common operations. For example, the Standard toolbar, shown in the following figure, lets you create, open, and print documents.

40

Understanding iFIX

Proficy iFIX WorkSpace Standard Toolbar The Application toolbar also lets you complete common tasks. The buttons on this toolbar allow you to launch iFIX applications without the system tree and to access information from the iFIX electronic books and the GE Fanuc web site.

Application Toolbar The other WorkSpace toolbar, the Utilities toolbar, lets you complete common database operations without Database Manager, as the following figure shows. You can update the connection between a picture's I/O points and the process database. This process is called resolving your pictures. You can also export pictures to use in the Proficy Portal application.

Utilities Toolbar

41

Understanding iFIX

Showing and Hiding Toolbars


You can show or hide any toolbar by selecting or deselecting it from the Toolbars dialog box in the configuration environment. Switching to the run-time environment hides all toolbars displayed in the configuration environment.

Understanding Toolbar Owners


All toolbars are owned by an application or a document. The toolbar's owner defines when the toolbar appears. For example, WorkSpace toolbars appear while the WorkSpace runs, picture toolbars appear only while the WorkSpace displays one or more pictures, and Scheduler toolbars are available when you open a schedule. If you switch from a picture to a schedule, the WorkSpace hides the picture toolbars and displays the Scheduler toolbars. NOTE: Picture toolbars are available to all pictures and Scheduler toolbars are available to all schedules. You cannot assign specific toolbars to individual pictures or schedules.

Customizing Toolbars
The Proficy iFIX WorkSpace provides toolbars with buttons that provide access to frequently-used functions, such as creating pictures and starting iFIX applications. You can customize the toolbars by arranging or removing these buttons as needed. Typically, you should remove buttons that you do not need. For example, if you set up a workstation dedicated to creating pictures and Dynamos, you may want to remove the New Schedule button from the Standard toolbar. Once you remove a button, you can always add it back. Adding a button requires you to select a toolbar category. A toolbar category is a logical grouping of buttons. For example, the Standard category contains the buttons on the Standard WorkSpace toolbar and the CreateObjects category contains the buttons on the Shapes toolbar. The Proficy iFIX WorkSpace provides many toolbar categories from which you can select buttons. These categories cannot be renamed or deleted. Likewise, the buttons in these categories cannot be modified or deleted. However, you can modify any button you add to a toolbar. The WorkSpace treats the added button as a copy of the original and lets you modify the new button in the toolbar with the Visual Basic Editor. Any changes to the copy do not affect the original. Docking Toolbars In addition to adding, removing, and arranging buttons, you can customize a toolbar by enabling or disabling a toolbar's docking option. When enabled, this option lets you dock a toolbar by dragging it to any edge of the screen. To keep the toolbar floating regardless of its screen position, you can disable the option. Resetting Toolbars You can restore any standard iFIX toolbar to its default state using the Reset button. Typically, these toolbars should be reset if you have customized the standard toolbars and you want to undo these changes. When you reset a toolbar, the WorkSpace: Deletes any custom buttons you have added. Adds any standard buttons you have deleted.

42

Understanding iFIX

Resets the toolbar's docking option back to its default state. This means if you reset a toolbar that has the docking option disabled, the WorkSpace enables the option. Moves the toolbar back to its default screen position. Consequently, if you reset a floating toolbar that is docked by default the toolbar, the WorkSpace docks the toolbar when you reset it.

NOTE: Resetting a standard toolbar does not affect any custom toolbar you have created.

Creating Toolbars
While you can customize the toolbars supplied with the Proficy iFIX WorkSpace, you cannot modify their properties. In addition, WorkSpace toolbars cannot be renamed or deleted. To eliminate these restrictions, you can create your own toolbars. Creating a toolbar is similar to customizing one. Both tasks require you to click and drag the buttons you want onto your toolbar. However, when you create a toolbar, you also define its properties. These properties include the toolbar's owner and name. The owner identifies the document or application that owns the toolbar. This owner must be active for the toolbars it owns to appear. For example, picture toolbars appear while you have one or more pictures open. If you subsequently open a schedule, the WorkSpace hides the picture toolbars and shows the Scheduler toolbars. The Proficy iFIX WorkSpace, pictures, and schedules are the available owners. A toolbar name conforms to VBA naming conventions. These rules require the first character to begin with a letter, prohibit the use of a space, period (.), exclamation mark (!), or the characters @, &, $, # in the name, and limits the name to 255 characters. In addition, toolbar names cannot match the name of any other toolbar, category, picture, schedule, or Dynamo set. However, it is possible to create a toolbar with the name of a closed document. Similarly, you can save a picture or schedule with the name of a hidden toolbar. When either situation occurs, the WorkSpace can only open one of these items at a time. For example, if you open a picture named ALARMS.GRF, the WorkSpace cannot show a toolbar named Alarms. You must close the picture first. Once the toolbar is displayed, you cannot open the picture until you hide the toolbar. Creating Toolbars with VBA iFIX does not contain the automation interfaces necessary to create toolbars. Do not use VBA to create toolbars in the WorkSpace. Doing so causes unpredictable results. NOTE: The WorkSpace saves the position of top left corner of the each floating and docked toolbar on the screen. If you move a toolbar outside the 800x600 portion of the screen, you may not be able to see it if you reduce the screen resolution or move the toolbar to another computer. Consequently, GE Fanuc recommends keeping your toolbars within the 800x600 portion of your screen. In addition, the Proficy iFIX WorkSpace does not wrap docked toolbars. Consequently, if you dock a large toolbar, it appears as a long line of buttons. Depending on the toolbar's size, some buttons may not be visible and may move other toolbars beyond the visible portion of the screen.

Creating Buttons
You can create custom buttons with the Proficy iFIX WorkSpace. Typically, these buttons provide custom features. For example, you could create a button to launch a custom application. Creating a button requires you to create a category for it. Remember, categories supplied with the Proficy iFIX WorkSpace cannot be modified.

43

Understanding iFIX

You can create a new category by entering a name for it. Like toolbar names, category names must conform to VBA conventions. These rules require that the first character begin with a letter, prohibit the use of a space, period (.), exclamation mark (!), or the characters @, &, $, # in the name, and limits the name to 255 characters. In addition, category names cannot match the name of another toolbar, category, picture, schedule, or Dynamo set. However, it is possible to create a category with the name of a closed document. Similarly, you can save a picture or schedule with the name of an existing category. When either situation occurs, the WorkSpace can only display one of these items at a time. For example, if you open a picture named OVERVIEW.GRF, the category Overview does not appear in the WorkSpace category list. To display it, close the picture. When you finish modifying the category, you can re-open the picture. You can make button categories appear in the Task Wizard by including the text "tasks" to the end of the name. For example, a category called Sample displays in the Task Wizard when you create a category with the name SampleTasks; the category's buttons also appear as tasks you can perform. Once you create a category, you can add custom buttons to it. Each button you add has properties that you can configure. These properties include the button's name, description, and ScreenTips. You can also edit the button's script. For more information on writing scripts for custom buttons, refer to the Writing Scripts manual. Modifying Buttons When you drag a button to a toolbar, the Proficy iFIX WorkSpace duplicates the button and its properties. However, no association exists between the two buttons. As a result, if you modify either button, the other is not updated. However, if you modify the button in the category, all future buttons you create with it will contain your changes.

Sharing Toolbars and Toolbar Buttons


You can share any custom toolbar among your iFIX nodes. Using the WorkSpace, you can share them by: Importing a toolbar's TBX file. Copying a toolbar category's TBC file.

Typically, you import a toolbar when you want to add toolbars created by a toolbar developer but you do not want others to reuse the toolbar's buttons. Copying a toolbar category, on the other hand, is done when you want to create one or more toolbars locally from the buttons in the toolbar category. Each TBX and TBC file defines a toolbar or a toolbar category, respectively. These files reside in the Local path on the source computer. You can share the TBX and TBC files by copying them to the target computer's Local path. When sharing toolbars, you must subsequently import the TBX file with the WorkSpace. Toolbar files (*.TBX, *.TBC, *.XBT, ASSOCIATION.DAT) saved as read-only cannot be used in the Proficy iFIX WorkSpace. NOTE: If you use a toolbar button to launch a custom ActiveX control, the OCX must be installed and registered on the target computer.

Using Experts and the Task Wizard


iFIX provides many Experts that automate the configuration of objects in pictures or the creation of an object's script. For example, the Foreground Color Expert can dynamically change the foreground color of an object. The Enable Alarm Expert, on the other hand, adds a script to the selected object. The script enables alarms for the data source you specify.

44

Understanding iFIX

You can access many Experts from picture toolbars or the Toolbox. However, with the Task Wizard, you can access every Expert through an easy-to-use menu that does not require toolbars. Consequently, if your toolbars occupy valuable screen space, you can hide them without losing functionality. For more information on Experts, refer to the Creating Pictures manual.

Setting User Preferences


The Proficy iFIX WorkSpace provides several options that you can configure. These options control: Picture, shape, drawing, and chart preferences Save preferences Run-time preferences OPC connection (animation error) preferences The iFIX WorkSpace's start-up environment

Understanding Picture, Shape, Drawing, and Chart Preferences


Picture preferences include the default size and background color, and whether the picture includes a title bar, system bar, and the ability to resize. You can also specify whether gradient fill will be used with your pictures and whether your pictures can be cached. Shape preferences let you specify the default colors of new objects in a picture and default styles, such as fill and edge style. If the fill style is Gradient, you can specify fade type. You can define default pipe properties, and the default font name, point size, and styles. Drawing preferences let you specify the line extension and line trimming options and whether or not to display connection nodes on objects. Chart preferences let you select the defaults for chart objects. These defaults include the number of ticks per axis, the number of labels per axis, the direction in which the chart scrolls, and the length of time the chart displays. To learn more about all picture, shapes, drawing, and chart preferences, refer to the Creating Pictures manual.

Saving Back-up Files


Each time you save a file, the Proficy iFIX WorkSpace copies the previous version to a back-up subfolder and saves the new version. If a back-up file already exists for the current file, the new backup replaces it. Back-up subfolders reside inside the system tree folders but do not appear in the system tree. For example, the Pictures back-up subfolder resides inside the Pictures folder and contains back-ups of modified pictures. Depending on the amount of free disk space you have and the size of your pictures, you may want to disable the back-up option to save space.

45

Understanding iFIX

Configuring Run-time Preferences


The Proficy iFIX WorkSpace has several run-time preferences, which include: Saving your open documents automatically when you switch to the run-time environment. Using this feature, you can toggle between the two environments without worrying about saving your changes. By default, this option is disabled. If you enable it and you want to test a change to a picture or schedule without saving the modification, you must disable the preference before switching to the run-time environment. If you do not, the WorkSpace automatically saves the change. Displaying the Proficy iFIX WorkSpace full-screen. This feature provides maximum screen space for creating and displaying pictures. When you display the WorkSpace full-screen, it hides its menu bar, system tree, and any docked toolbars. Floating toolbars remain visible. Opening specific pictures automatically when the Proficy iFIX WorkSpace starts in the runtime environment. Use this option to define the specific files you want to open automatically for your operators. Opening specific schedules you want to open in the background. Use this option to indicate the specific files you want the FixBackgroundServer task to load on start-up.

Changing the Start-up Environment


The start-up environment option lets you specify the environment in which the Proficy iFIX WorkSpace starts. By default, the Proficy iFIX WorkSpace starts in the configuration environment. However, when you have finished configuring each node, you may want to configure the Proficy iFIX WorkSpace to start up in the run-time environment automatically.

Animation Error Preferences


Each animated object in a picture uses OPC protocols to receive data and report errors. The animation error preferences define the default error strings and values that the object uses when an error occurs. For example, by default, when a communication error occurs, Data links display the text "@@@@". You can customize the animation error defaults by entering new values in the Animations Data Error Defaults tab. By changing the defaults, you make the default error messages more intuitive for your industry. For example, when a communication error occurs, you can have Data links display the following text by entering it into the Comm field of the Format Animation Object Defaults area:
Cannot communicate with server

Displaying the Visual Basic Editor


You can write Visual Basic for Applications scripts for any picture, toolbar button, schedule, or iFIX object. Using VBA gives you complete control over your process automation solution because it lets you create custom scripts and automate iFIX for your needs. You can begin writing scripts by displaying the Visual Basic Editor. The VBE provides access to all the available methods, properties, and events for your iFIX objects.

46

Understanding iFIX

You can display the VBE in many ways, such as by selecting Visual Basic Editor from the WorkSpace menu, right-clicking an object and selecting Edit Script from the pop-up menu, and creating a schedule and clicking VB Editor from the Add Event Entry or Add Timer Entry dialog box. To learn how to use the VBE, refer to its online Help. To learn how to write scripts for iFIX objects, buttons, pictures, and schedules, refer to the Writing Scripts manual. For information on iFIX methods, properties, and events, refer to the iFIX Automation Interfaces Help file.

Managing iFIX Nodes


This chapter explains how to manage your iFIX nodes with the Proficy iFIX WorkSpace by backing up and restoring your files. The chapter also describes other management tasks you can complete with the WorkSpace, such as configuring the local computer, finding and replacing data in iFIX, and specifying the active Proficy Batch Execution project. Refer to the following sections for more information: Configuring the Local Computer Sharing Files Finding and Replacing Data Backing up and Restoring Files Specifying a Proficy Batch Execution Project

Configuring the Local Computer


Your main tool for configuring your computer for use with iFIX is the System Configuration Utility (SCU). This program lets you configure the computer's: Network connections. Alarm routing and destinations. SCADA and I/O driver options (for SCADA servers only). Security options (when iFIX is running). iFIX paths. Start-up tasks. Alarm area configuration.

To learn more about the SCU, refer to the Setting up the Environment manual.

47

Understanding iFIX

Sharing Files
Using iFIX, you can share files among your nodes by placing these files on a file server and changing the local node's paths. The files you share depend on your configuration; you may want to share operator displays or schedules. Frequently, the alarm area database is shared to ensure that all SCADA servers have access to an identical set of alarm areas. Likewise, sharing your security files ensures that operators can log in from any node. The path you specify for sharing files also depends on your configuration. You can specify any mapped network drive, such as Z:\Program Files\GE Fanuc\Proficy iFIX\ALM. NOTE: iFIX stores different types of files in the paths it uses. For example, the Picture path holds pictures, user globals, color tables, and named colors. Sharing this path gives access to all these files. The iFIX pictures are not backwards compatible for earlier versions of iFIX. If you use multiple versions of iFIX, store your pictures locally or use a separate shared pictures path for each version of iFIX.

Configuring the Picture Path


If you are using a shared PIC directory on a drive other than the one on which iFIX is installed, you must enter the full path in the SCU. For example, if you want to use a shared PIC directory on the G:\drive, you must enter G:\PIC in the SCU. If you enter G:\, your WorkSpace will not open correctly.

Finding and Replacing Data


Many process environments are expansive, and may include pictures or schedules that reference many sources of data for operations in different locations throughout your plant. If you need to reroute certain data to another node, or globally change a data source throughout a plant, you can do so quickly, without disrupting operation or using valuable resources by finding and replacing data. Finding data locates values of picture and schedule properties that match the search string. It also locates property values of objects in your pictures. The search string you enter indicates the data you want to locate and optionally replace. Any property value that matches this text appears on the Find tab. On the Replace tab, only values you can modify appear. Find Options You can select any of the following options when finding data: Match Case Finds text that matches the exact case of the search string. Whole Word Only Finds only whole words that match the search string. A whole word is any text delimited by a carriage return, a line feed, a space, a hyphen (-), a semi-colon (;), a colon (:), a comma (,), a period (.), an underscore (_), an exclamation point (!), quotation marks ("), apostrophe ('), parenthesis ( ), braces { }, or brackets [ ]. This means that a typical data source, such as Fix32.MIXER1.AI1.F_CV contains five words. Data Source Only Finds only data sources that match the search string. NOTE: If a data source used to animate an object has its Data Conversion type set to Object, the data source is ignored during all Find operations.

48

Understanding iFIX

Include Scripts Finds text in the scripts associated with the current picture or schedule. Replace Options When replacing data, you can select from the following options: Replace Selected Replaces only the property values you select. Replace All Replaces all property values found. Replace Preview Displays the results of replacing all property values in the Replace Value With column. NOTE: You cannot undo a Find and Replace operation and the text you enter as the replacement string appears exactly as you enter it. Notes on Special Characters in Search Strings When you use wildcard characters such as the * or ? character in your search string, text containing the following special characters will not be found even if it satisfies the search criteria:
" ' ( ) * + ; ? @ ^ ' { } ~

For instance, if you want to locate joe@company.com and enter j*com as your search string in the Find What field, the joe@company.com term is not found, since the text includes a special character (@). Example: Finding and Replacing Data Assume you want to replace all of the tags in a picture from MIXER.AI_VALVE_OPEN to MIXER.AI_VALVE_CLOSED. One way you can change these value is to perform a whole word find and replace. To perform a whole word find and replace: 1. 2. 3. 4. 5. On the Edit menu, click Find and Replace. In the Find What field, enter MIXER1.AI_VALVE_OPEN. Click the Replace tab, and enter MIXER1.AI_VALVE_CLOSED in the Replace With field. Click Replace Preview to view the resulting values in the Replace Value With column. Click Replace All.

If you find and replace a tag which returns numeric data only, such as F_CV, with a tag that returns non-numeric data, such as A_CUALM, Data links that are connected to this tag will no longer appear to update. For example:

49

Understanding iFIX

If you replace... F_CV

With...

Then the Replace will...

A_CV

Works for analog tags where the A_CV is simply a string containing a number. Work without errors. Not work. Not work because the tag was originally a number.

A_CV F_CV F_CV

F_CV A_MODE A_CV and then A_MODE

Using Wildcards
One of the most powerful options you have when finding and replacing data is the ability to include wildcards in search strings and the replacement text you enter. You can enter any of the following wildcards: * Finds zero or more characters. ? Finds any single character. For example, the search string TAN? locates the string TANK. It also locates the string TANKS. When replacing data, the wildcard only lets you substitute one character for the wildcard. For example, if you replace TAN? with TANZ, the resulting strings are TANZ and TANZS. \ Finds wildcard characters in the search string. For example, \* locates an asterisk (*) in the property values being searched. To make your searches more effective, use these guidelines: If the search string has wildcard characters, the replacement string must have the same wildcard characters or none at all. If the search string has no wildcard characters, the replacement string cannot have any wildcard characters. Do not use * and ? in the same search string.

The table below details some examples of using wildcards with Find and Replace.

50

Understanding iFIX

Find and Replace Wildcard Examples Property Value NODE1.AI1 NODE1.AI1 NODE1.AI1 NODE1.AI2 MIXER1.AI3 *Alarm Area Mixer* Search String N*.A* *.AI1 *.* NOD*.AI* MIXER1.A?? \*Alarm Area Mixer\* Replacement Text M*.B* NEWNODE.A N2.A2 BE*.CO* MIXER1.D?? -Alarm Area MixerModified Value MODE1.BI1 NEWNODE.A N2:A2 BEE1.CO2 MIXER1.DI3 -Alarm Area Mixer-

Finding and Replacing Data in Scripts


By default, finding and replacing data in the Proficy iFIX WorkSpace does not search in the scripts associated with the current picture or schedule. However, you can search in event scripts by selecting the Include Scripts check box. Declarations, forms, class modules, and other scripts are not searched by iFIX. To search in these scripts, use the Visual Basic Editor (VBE). For more information on using the VBE, refer to its online Help. iFIX lets you add find and replace capabilities to your scripts using the FindReplace interface in the FixScriptGlobal object. Refer to the Writing Scripts manual and the iFIX Automation Interfaces Help file for more information.

Using Find and Replace with User Globals


In order to use the Find and Replace command on User Globals, you must right-click the User icon in the Globals folder in the system tree, and select Find and Replace from the menu. You cannot perform a Find and Replace on User Globals by selecting Find and Replace from the Edit menu. That menu belongs to the active document only. Note that the Find and Replace dialog box displays the name of the document being searched in its title bar. For example, if you perform a Find and Replace on User Globals, Find and Replace User appears in the title bar.

Backing up and Restoring Files


To help you manage your iFIX files, use the iFIX Backup and Restore feature. Access this feature through the Backup and Restore Wizard or from the command line. Command line parameters are available to automate backup or restore operations in scripting or external programs. With this feature, you can backup your entire iFIX system or portions of it. You can later use these backed up files to restore your iFIX system, or specific parts of it. Additionally, you can restore your

51

Understanding iFIX

iFIX system to the factory default settings and files a clean restore. This feature is helpful in configuring new computers with the same configuration, or in disaster recovery. Overview of Files A Custom Backup iFIX backup includes a subset of the following files: SCU files Configuration files Pictures and Dynamo sets Process and alarm area databases I/O driver configuration files and exported databases Alarm files Historical configuration and data files Tag groups Application files Toolbars Schedules Global definition files and named colors Chart group wizard files Startup profiles FIX32 picture and key macro files Security files Master and control recipes

A Full Backup includes all of your iFIX files in the following folders: ALM path (*.*) APP path (*.*) HTR path (*.*) HTRDATA path (*.*)

52

Understanding iFIX

LOCAL path (*.*) PDB path (*.*) PIC path (*.*) RCC path (*.*) RCM path (*.*)

IMPORTANT: A Full Backup includes version dependent files. Do not restore a Full Backup from one version of iFIX to another version. Instead, use the Custom Backup option if you want to restore specific files from one version of iFIX to another. Be aware that you can even backup and restore application files across multiple iFIX projects using the Project Path concept. For more information about modifying the project path, refer to the Best Practices for Managing Multiple iFIX Users section. IMPORTANT: To backup and restore driver configuration files, you must add the driver in the SCU's SCADA Configuration dialog box. To add the I/O driver, from the SCU Configure menu, click SCADA. In the I/O Driver Definition area, click the ? to select the I/O driver name, and then click Add. Be aware that configuration files for 7.x series drivers saved outside of the iFIX database directory will not be backed up with the Backup and Restore Wizard. If you installed iFIX to the default location, the path to the iFIX database directory is: C:\Program Files\GE Fanuc\Proficy iFIX\PDB.

Accessing the Backup and Restore Wizard To access the Backup and Restore wizard, click the Start button and point to Programs, Proficy HMI SCADA - iFIX, and then Backup and Restore Wizard. You can also access the application by locating and running the BackupRestore.exe file in the Proficy iFIX folder, which is the folder where you installed iFIX. If you want to restore files, you must shut down iFIX before running the Backup and Restore wizard. Otherwise, iFIX should be running. The following figure shows the main screen that appears when you open the Backup and Restore Wizard.

53

Understanding iFIX

Backup and Restore Wizard

Overview of the Backup Process


The Backup and Restore Wizard allows you to perform the following types of backup: Custom Backup Allows you to select the specific files within the project path to backup. Full Backup Archives all files, including security and INI files within the project path. This includes all files in the APP, HTR, HTRDATA, LOCAL, PDB, PIC, RCC, and RCM folders. Factory Default Backup Allows you to create a new factory default backup file. The Factory Default is a set of default iFIX files used to perform a clean restore. A standard FactoryDefault.IFD file is provided with the iFIX product. You can create a new, customized one, and save it under another name or the same name, using this option.

The steps below explain how to perform a backup with the Backup and Restore Wizard. For steps on how to use the command line, refer to the Using the Command Line Options section. To perform a custom backup: 1. 2. In the Backup and Restore Wizard main screen, select the Custom Backup option. Click the Backup button. The following figure appears.

54

Understanding iFIX

Backup and Restore Wizard - Custom Backup 3. Verify that the Backup Source Info is correct. For more information about modifying the project path, refer to the Best Practices for Managing Multiple iFIX Users section. In the Backup File Option section, select the specific files or folders that you would like to back up. Optionally, select the Include security files in archive option to backup all of your security files. NOTE: If the Backup and Restore wizard does not detect any security files in the project path, the Include security files in archive option does not appear. 6. 7. Click the Next button. Enter a backup file name and path into the field or browse to select one.

4.

5.

55

Understanding iFIX

NOTE: By default, this archive and path is C:\Program Files\GE Fanuc\Proficy iFIX\ProjectBackup\nodename.FBK; however, you can specify any local path and file name. If you want to use a network path, you must use a mapped network drive. For instance, \\MyServer\folder will not work, but a network drive mapped to Y:\folder (where Y:\ is the map to \\MyServer) would work. 8. Click the Finish button to begin archiving your selected files.

To perform a full backup: 1. 2. 3. In the Backup and Restore Wizard main screen, select the Full Backup option. Click the Backup button. Enter a backup file path and filename into the field or browse to select one. NOTE: By default, this archive and path is C:\Program Files\GE Fanuc\Proficy iFIX\ProjectBackup\nodename.FBK; however, you can specify any local path and file name. If you want to use a network path, you must use a mapped network drive. For instance, \\MyServer\folder will not work, but a network drive mapped to Y:\folder (where Y:\ is the map to \\MyServer) would work. 4. Click the Finish button to begin archiving all of your files.

To create a new factory default file: 1. Start the Backup and Restore Wizard with the /FactoryDefault option. For example:
BackupRestore.exe /FactoryDefault

Refer to the Using the Command Line Options section for more information on /FactoryDefault startup options. 2. In the Backup and Restore Wizard main screen, select the Factory Default option. NOTE: The Full Backup and Custom Backup options are unavailable when you start the Backup and Restore Wizard in Factory Default mode. 3. Click the Backup button. The following dialog box appears.

56

Understanding iFIX

Backup and Restore Wizard - Factory Default Backup 4. In the Backup File Option section, select the specific files or folders that you would like to back up. Optionally, select the Include security files in archive option to back up all of your security files. NOTE: The Include security files in archive option is not available for a Factory Default backup. 6. 7. Click the Next button. Enter a backup path and file name into the field, or browse to select one. NOTE: By default, this archive and path is C:\Program Files\GE Fanuc\Proficy iFIX\ProjectBackup\nodename.ifd; however, you can specify any local path and any file name. Most likely, you will want to leave the original Factory Default file, and save the file

5.

57

Understanding iFIX

under another name. If you want to use a network path, you must use a mapped network drive. For instance, \\MyServer\folder will not work, but a network drive mapped to Y:\folder (where Y:\ is the map to \\MyServer) would work. 8. Click the Finish button to begin archiving your selected files. TIP: If you enter a new name in step 7, you may want modify the [WizardSettings] section of BackupRestore.ini file to point this custom Factory Default file. For more information, refer to the Using and Creating FactoryDefault Files and the Sample BackupRestore.ini sections.

Overview of the Restore Process


You can restore your archived files to any computer that has iFIX installed. Prior to restoring the files, you can select the individual types of files you want to restore or you can restore the entire archive. The Backup and Restore Wizard includes the following restore features: Ability to select a specified destination for the restored files, as well as the individual files you want to restore. Ability to delete all existing files under a target project path before performing a restore. This action removes any existing application files in the destination paths, with the exception of the security files. Ability to restore the iFIX factory defaults of your original install before restoring the backup files. Option to retain the current SCU security settings for the restore, replace the SCU settings with the ones in the archive, or create a new project requiring the input of a new project folder to complete the restore.

The steps below explain how to perform a restore with the Backup and Restore Wizard. For steps on how to use the command line, refer to the Using the Command Line Options section. To restore an archive: 1. 2. In the Backup and Restore Wizard main screen, select the Restore button. On the first page of the wizard, enter the backup file name to restore or click browse to select one. By default, backup files are stored in the C:\Program Files\GE Fanuc\Proficy iFIX\ProjectBackup folder. 3. Click Next to continue. The following dialog box appears, allowing you to select the appropriate restore options.

58

Understanding iFIX

iFIX Restore Wizard 4. Select the required options and click Finish.

To restore a factory default file: 1. Start the Backup and Restore Wizard with the /FactoryDefault command line option. For example:
BackupRestore.exe /FactoryDefault

Refer to the Using the Command Line Options section for more information on /FactoryDefault startup options. 2. 3. In the Backup and Restore Wizard main screen, select the Restore button. On the first page of the wizard, enter the file name of the factory default backup or click browse to select one. To restore iFIX with the standard factory defaults, select the FactoryDefault.IFD file. If you installed iFIX to the default location, you can find this file in the C:\Program Files\GE Fanuc\Proficy iFIX folder. 4. 5. Click Next to continue. Select the required options and click Finish.

59

Understanding iFIX

Restore Destination Options The Restore Destination Options allow you to select whether you restore the files to the current project path, the project path specified in the archived SCU, or into a separate new project path. The Create New Project option does not modify the existing SCU settings. If you select to use the SCU file from the archive, this overwrites the SCU file on the target computer. Typically, you would only want to overwrite an SCU file if the target computer does not have an SCU file, or if you want to restore the target computer to its previous state. If you choose to overwrite an existing SCU file, be sure to verify that the computer's hardware key supports all of the enabled SCU options and the software for these options is installed. For example, if SCADA support is enabled, verify that the hardware key has SCADA support and that the SCADA software is installed on the target node. You should also verify that the path for each start-up task, listed in the Task Configuration dialog box, is correct. You can modify the node name and project path stored in the archived SCU file when you select to overwrite the existing SCU file. The Node field defines the node name stored in the archived SCU file; the Project Path field defines the project path. When the restoration process begins, the wizard reads the text in the Node and Project Path fields to determine where to restore the files you selected. Next, the wizard restores the files using the relative paths stored in the selected SCU file. The wizard creates any non-existent paths. NOTE: If multiple SCU files exist in the archive when you are restoring files, iFIX copies all existing SCU files to the Local path. The SCU file that was in use continues to be used by the system. If you choose to Create a New Project, files are restored to a new project path with a default subproject path. To modify the default sub-project paths, refer to the BackupRestore.ini or user-specified .INI file. Optionally, once you have restored the file, you can create a new SCU file and point to these new paths. Destination Info The Destination Info section of the Restore screen displays the SCU file, node, and project path that the archive will be restored to. To display the configured paths for the restored files within the project, click the View Project Path Configuration button. The configured paths are determined by the destination option you selected. If you selected: Use the current SCU the paths are determined by the SCU file currently loaded. Use SCU from archive the paths are determined by the SCU file in the archive. You can modify the node name and project path. Sub-project paths are determined by the SCU file in the archive and cannot be modified. Create a new project the project path is determined by user input. Sub-project paths are determined by the .INI file settings. Refer to the BackupRestore.ini file for more information. Restore File Options To perform a clean restore, the Backup and Restore wizard allows you to delete all existing files or to restore default iFIX files before restoring the archive. Select the Delete all existing files under target project path before the restore option to delete all existing files before restoring a Custom or Full backup file. This option will not delete existing security files or the current SCU file loaded in local startup.

60

Understanding iFIX

Select the Restore default iFIX files before restoring your backup files option to return the files to their default state before performing a restore. For Custom and Full restores, the default iFIX files are restored from the FactoryDefault file. To modify the default settings, modify the FactoryDefault definitions in the BackupRestore.ini file. For more information, refer to the BackupRestore.ini file. Security File Option If the Restore Wizard locates any security files in the archive that you are restoring, you can select from the following options: Leave the current security settings alone Select this option to maintain the current security settings and ignore security overwrites in the backup files during the restore. Replace existing security files with archived files Select this option to replace the current security settings with the security settings in the archived files. Delete all existing security files and disable security Select this option to delete all existing security files from the current iFIX system and disable security upon restore. This option also displays the current status of security (Enabled or Disabled). If you select this option, ensure that the Restore default iFIX files before restoring your backup files option is also selected to use the active iFIX project. The restore destination for security files is determined by the presence of security files in the current iFIX system and the archive. The following table shows the sample configurations and the determined destination: Are security files present in current iFIX configuration? Are security files present in archive? Destination of restored security files: N/A Target local path Target local path Target local path Target local path Target local path Current global security path

1 2 3 4 5 6 7

No No No node.dov node.dov Display.dov Display.dov

No node.dov Display.dov node.dov Display.dov node.dov Display.dov

61

Understanding iFIX

NOTE: In the previous table, node.dov denotes that local security settings related to a single project are found. Display.dov denotes that global security settings are found. In the 2nd and 3rd configurations shown in the table, the security files are restored to the target local path. The user receives no warning message. In the 4th and 5th configurations, the security files are also restored to the target local path. A warning message displays the current security path and the new security path. As node.dov relates to a specific single project, if the current path is not equal to the target path, the existing security settings remain and the archived security settings are restored to a new project path. If the current path is equal to the target path, the existing security files are deleted and then the archive is restored. In the 6th configuration, the global security settings are removed and the security files are restored to the target local path. A warning message appears displaying the current security path and the new security path. In the 7th configuration, security files are restored to the current global security path. A warning message displays, alerting the user that the current security path is the same as the new security path and will be overwritten. Restore File Selection Once you select the appropriate restore options, select which specific files you would like to restore to the project path. If you would like to restore all files, select the Restore the entire system check box.

Using the Command Line Options


You can also run the Backup and Restore utility from the command line. This is especially useful if you want to automate the backup and restore operations through scripting or external programs. The syntax for the BackupRestore.exe command line is as follows: Syntax for Backup
BackupRestore.exe [/FactoryDefault] /B=<file name with full path> [/F] [/P=<project path> or /P=UseINI] [/BackupSec] [/S or /Y] [/I=<ini file name>]

Syntax for Restore


BackupRestore.exe [/FactoryDefault] /R=<file name with full path> [/A] [/A=<project path> [/N=<node name>] [/X]] [/P=<project path> or /P=UseINI]] [/C] [[/RestoreSec] or [/DelSec]] [/S or /Y] [/I=<ini file name>]

62

Understanding iFIX

Notes on the Syntax The brackets ( [ ] ) indicate that a parameter is optional. The brackets are not part of a command; if a bracketed option is desired, type only the text that is inside the brackets, and not the brackets themselves. Italics are used to represent the information that the user must supply to run the command. The information in italics is not typed exactly as it appears. Instead, the user enters the information specific to the italicized expression.

The following table lists the command line options available for BackupRestore.exe. Available Command Options Command Option /F Description

Specifies a Full Backup of all files within a project path, including security files. Peforms a factory default backup or restore. Specifies the source project path for the Backup or the destination project path for the restore. Specifies the source project path for the Backup or the destination project path for the Restore. Allows you to specify the full path for all sub-project paths within the INI file settings. Uses the archived SCU file to determine the destination project path of the Restore. Specifies the destination project path for the Restore, and sets it to the extracted SCU file. Specifies the node name of the node you want to restore. Used with the /A option. Specifies that you do not want to rename the current node name with the name of the restored node. Used with the /A option. Deletes all existing files under the selected project path before restoring a Custom or Full Backup file. Includes security files in the backup.

/FactoryDefault /P

/P=UseINI

/A

/A=<project path> /N=<node name> /X

/C

/BackupSec

63

Understanding iFIX

Available Command Options Command Option /RestoreSec Description

Replaces the current security settings with the security settings in the archived files during the restore. Deletes all existing security files and disables security upon restore. Runs the Backup or Restore project in silent mode, with no progress bar or user prompt. Automates the user prompt and displays the progress bar while the backup or restore runs in silent mode. Specifies an .INI file and path, if you want to use an .INI file other than the BackupRestore.ini file. By default, Backup and Restore reads the BackupRestore.ini file in the Local folder. By using the /l command, you can specify another .INI file name. The format must be the same as the BackupRestore.ini file however. Refer to the Sample BackupRestore.ini section for more information.

/DelSec /S

/Y

/I

/?

Opens the Help for the command line options.

NOTE: If you do not define the /P option while running a Backup, the source path is taken from the current SCU setting. If you do not define the /P or /A option while running a Restore, the destination is the current SCU setting. Examples This command performs a custom backup silently including security files, without displaying the Backup and Restore Wizard:
BackupRestore.exe /B="C:\Program Files\GE Fanuc\Proficy iFIX\ProjectBackup\FIX.fbk" /S /BackupSec

This command performs a project restore to the current project path silently, without displaying the Backup and Restore Wizard:
BackupRestore.exe /R="C:\Program Files\GE Fanuc\Proficy iFIX\ProjectBackup\FIX.fbk" /S /RestoreSec

This command performs a project restore to the project path archived in the SCU, and shows a progress bar for restore process:
BackupRestore.exe /R="C:\Program Files\GE Fanuc\Proficy iFIX\ProjectBackup\FIX.fbk" /A /Y

64

Understanding iFIX

NOTE: When including the /A command, you may need to review the SCU to see if the base path has changed. This command performs a factory default backup, without displaying the Backup and Restore Wizard:
BackupRestore.exe /FactoryDefault /B="C:\Program Files\GE Fanuc\Proficy iFIX\ProjectBackup\FIX.ifd" /S

This command performs a factory default restore, without displaying the Backup and Restore Wizard:
BackupRestore.exe /FactoryDefault /R="C:\Program Files\GE Fanuc\Proficy iFIX\ProjectBackup\FIX.ifd" /S

Return Code The Backup and Restore application returns the following exit codes after it runs. Exit Code 0 Description

Backup or Restore action completed without errors. When you run the user interface for the Backup and Restore, instead of using the command line, the exit code also will be 0.

Backup or Restore action aborted with an error. This usually indicates that the error occurred during the action. For example: a backup file was unable to be opened, a backup file is corrupted, or security settings could not be adjusted . Backup or Restore action unable to start, for any reason. For example: an invalid command was detected, or a specified file was not found. Also, when you run the BackupRestore.exe /? help command, the exit code is 2.

When the BackupRestore.exe program returns a 1 or 2, the action failed. If an error is detected before an action log file opens, these errors are recorded in the BackupRestoreDefaultLog.txt file. By default, this file is located in the iFIX base path. If you installed iFIX to the default location, then the base path is the C:\Program Files\GE Fanuc\Proficy iFIX folder. If a 1 or 2 is returned, look to the BackupRestoreDefaultLog.txt first for details on the error. If there is no information there, then look at actual action log (BackupLog.txt or RestoreLog.txt). Be aware that the BackupRestoreDefaultLog.txt log also contains full command line parameter information and the time when the BackupRestore.exe program started.

Using and Creating Factory Default Files


The Factory Default is a set of default iFIX files used to perform a clean restore. A standard FactoryDefault.IFD file is provided with the iFIX product. The FactoryDefault.IFD file also includes your FIX Desktop files. Refer to the Files Included in the FactoryDefault Backup File section below for a list of files included in the standard .IFD file.

65

Understanding iFIX

NOTE: Be aware that if you later install an iFIX SIM as a product update, and that SIM contains updated iFIX factory default files, the SIM installer prompts you to update the original FactoryDefault.IFD file as a part of the SIM installation. You can also create your own Factory Default file, with the .IFD file extension, to include custom toolbars, custom dynamos, application specific picture templates, or user specific .INI settings. To do this, you use the Factory Default command line option for the Backup and Restore application. You can overwrite the original FactoryDefault.IFD file, or create a new one. Most likely, you will want to leave the original Factory Default file, and save the file under another name. IMPORTANT: Be aware that whatever files are included in the FactoryDefault.IFD file are also used in the restore process, by default, when you select the Restore default iFIX files before restoring your backup files check box in the iFIX Restore Wizard. If you overwrite the original FactoryDefault.IFD file, you change the files that get restored when that check box is selected. Use caution when overwriting the original FactoryDefault.IFD file. If you want this check box to reference another Factory Default file, modify the [WizardSettings] section of BackupRestore.ini file. On the FACTORYDEFAULT=FactoryDefault.IFD, replace FactoryDefault.IFD with the name of your new factory default file. For more information on the BackupRestore.ini file, refer to the Sample BackupRestore.ini file section.

To create a Factory Default backup file, type the following at the command line and press ENTER:
BackupRestore.exe /FactoryDefault

This command starts the Backup and Restore application with the Create New Factory Default file option enabled. To restore the files in a Factory Default file, use the same command line option:
BackupRestore.exe /FactoryDefault

When the /FactoryDefault option is specified, the Backup and Restore Wizard appears with the Custom and Full Backup buttons unavailable, as shown in the following figure. To create a new Factory Default file, click the Project Backup button to open the Project Backup Wizard. To restore a Factory Default file, click the Project Restore button to open the Project Restore Wizard.

66

Understanding iFIX

For more information on using Command Line options, refer to Using the Command Line Options section. Files Included in the Factory Default Backup File The following is a list of files included in the FactoryDefault.IFD file provided with the iFIX product. If you select the Restore default iFIX files before restoring your backup files option during a restore, these files will be restored to your system before the archive is restored. IMPORTANT: Be aware that if you later install an iFIX SIM as a product update, and that SIM contains updated iFIX factory default files, the SIM installer prompts you to update the original FactoryDefault.IFD file as a part of SIM the installation. The FactoryDefault.IFD file includes the following files:
ALM Files None APP Files BuildDynamoInstall.grf ChartGroupInstall.grf iDetective.tbx sqlerr.txt HTR Files ChartGroup1.csv ChartGroup2.csv ChartGroup3.csv HTRDATA Files None Local Files alarm.ini AnimationTasks.tbc Applications.tbc ApplicationToolbar.tbx ApplicationToolbar.xbt Association.dat BackupRestore.ini

67

Understanding iFIX

BuildDynamo.bmp BuildDynamo.tbc BuildDynamoToolbar.tbx BuildDynamoToolbar.xbt CADToolbar.tbx CADToolbar.xbt CADTools.tbc ChartGroups.tbc ChartGroupToolbar.tbx ChartGroupToolbar.xbt CommandTasks.tbc CreateObjects.tbc CrossReference.ini CustomButton1.bmp CustomButton10.bmp CustomButton2.bmp CustomButton3.bmp CustomButton4.bmp CustomButton5.bmp CustomButton6.bmp CustomButton7.bmp CustomButton8.bmp CustomButton9.bmp DatabaseManager.ini DatabaseTasks.tbc DataEntryTasks.tbc ddeclnt.ini default.fmt default.qry default.rft default.srt draw.ini dwnarrow.ico dwndwnarrow.ico Edit.tbx Edit.xbt Experts.tbx Experts.xbt FilteredErrors.ini FindReplace.csv FIX.BAT fix.ini FIX.SCU FIXODBC.ini FixUserPreferences.ini FormatObjects.tbc GeometryHelper.ini Horn.ico HTD.INI iFixScreenSaver.bmp iFIXSysMgmt.ini ImportToolbars.txt logmsg.tov NoHorn.ico PictureExporter.tbc PictureTasks.tbc ReportTasks.tbc Scheduler.tbc

68

Understanding iFIX

Shapes.tbx Shapes.xbt Standard.tbc StandardCategories.txt StandardToolbar.tbx StandardToolbar.xbt SystemTree.csv SystemTreeError.TXT TableConversion.lst Toolbox.tbx Toolbox.xbt Tools.tbx Tools.xbt TranslationToolbar.tbx TranslationToolbar.xbt uparrow.ico upuparrow.ico Utilities.tbx Utilities.xbt view.ini VisiconXControls.tbc VisiconXToolbar.tbx VisiconXToolbar.xbt PDB Files aa61.tbl ai61.tbl ao61.tbl ar61.tbl bb61.tbl bl61.tbl ca61.tbl CGW.csv da61.tbl dc61.tbl DEFAULT.SM2 di61.tbl do61.tbl dr61.tbl dt61.tbl empty.pdb etr61.tbl ev61.tbl fn61.tbl hs61.tbl ll61.tbl mdi61.tbl pa61.tbl pg61.tbl pid61.tbl rb61.tbl rm61.tbl sc61.tbl sd61.tbl sqd61.tbl sqt61.tbl ss61.tbl tm61.tbl tr61.tbl

69

Understanding iFIX

tt61.tbl tx61.tbl PIC Files 3D_TEXT.sbl aa.bdf ai.bdf ao.bdf ar.bdf bb.bdf bl.bdf BORDERS.sbl BUNGEE.odt BUNGEE.SVA BUNGEE.VGA BUTTONS.sbl ca.bdf ChartGroupDemo.grf CHARTS1!.sbl CHARTS2!.sbl CHARTS3!.sbl CHARTS4!.sbl CHKBOX!.sbl CHKBOX2!.sbl da.bdf di.bdf do.bdf dr.bdf DRAW.KMX dt.bdf DTALNK1!.sbl DTALNK2!.sbl etr.bdf ev.bdf ExpertGlobal.fxg ExpertGlobals2.fxg FACEPLT!.sbl FactoryGlobals.fxg FixDesktop.fxg fn.bdf FREEFALL.odt FREEFALL.SVA FREEFALL.VGA HANGTEN.odt HANGTEN.SVA HANGTEN.VGA Historical.fds hs.bdf infoAgent.fds INLINE.odt INLINE.SVA INLINE.VGA ISA-S55A.sbl ISA-S55B.sbl ISA-S55C.sbl ISA-S55D.sbl ISA-Y32A.sbl ISA-Y32B.sbl ISA-Y32C.sbl

70

Understanding iFIX

ISA-Y32D.sbl ISA-Y32E.sbl ISA-Y32F.sbl ISA-Y32G.sbl ISA-Y32H.sbl ISA-Y32I.sbl KEYPAD!.sbl ll.bdf LocalAsBackup.grf LocalAsPrimary.grf LUGE.odt LUGE.SVA LUGE.VGA mdi.bdf METERS!.sbl METERS2!.sbl Miscellaneous.fds MOTORS!.sbl Motors.fds MOTORS.sbl NetworkStatusDisplay.grf NetworkStatusRedundancyDisplay.grf on.bdf pa.bdf PC_PLC.sbl pg.bdf pid.bdf Pipes.fds PIPES1.sbl PIPES2!.sbl PIPES2.sbl PIPES3!.sbl PIPES3.sbl PipesAnim.fds PlugandSolve.fxg PSHBTN1!.sbl PSHBTN2!.sbl PTV.odt PTV.SVA PTV.VGA PUMPS!.sbl Pumps.fds PumpsAnim.fds RADIO!.sbl RADIO2!.sbl rb.bdf rm.bdf ROWERS.sbl RUNTASK!.sbl sc.bdf sd.bdf Shades Of Blue.ftb Shades Of Cyan.ftb Shades Of Gray.ftb Shades Of Green.ftb Shades Of Magenta.ftb Shades Of Red.ftb Shades Of Yellow.ftb

71

Understanding iFIX

SHAPES.sbl SLIDERS!.sbl SPIKE.odt SPIKE.SVA SPIKE.VGA sqd.bdf sqt.bdf ss.bdf System Default.ftb SYSTEM!.sbl Tables.lst TagStatus TANKS!.sbl Tanks.fds TANKS.sbl TanksAnim1.fds TanksAnim2.fds TICMARKS.sbl tm.bdf tr.bdf tt.bdf tx.bdf VALVES!.sbl Valves.fds VALVES.sbl ValvesAnim.fds VBARS!.sbl VIEW.KMX WizLayouts.tpl TagStatus\Aa_TS.Grf TagStatus\AI_TS.grf TagStatus\AO_TS.Grf TagStatus\Ar_TS.Grf TagStatus\Bb_TS.Grf TagStatus\Bl_TS.Grf TagStatus\Ca_TS.Grf TagStatus\Da_TS.Grf TagStatus\DI_TS.Grf TagStatus\Do_TS.Grf TagStatus\Dr_TS.Grf TagStatus\Dt_TS.Grf TagStatus\Etr_TS.grf TagStatus\Ev_TS.Grf TagStatus\Fn_TS.Grf TagStatus\Hs_TS.Grf TagStatus\Ll_TS.Grf TagStatus\Mdi_TS.grf TagStatus\Pa_TS.Grf TagStatus\Pg_TS.Grf TagStatus\Pid_TS.grf TagStatus\QuickTrend.grf TagStatus\Rb_TS.Grf TagStatus\Rm_TS.Grf TagStatus\Sc_TS.Grf TagStatus\Sd_TS.Grf TagStatus\Sqd_TS.grf TagStatus\Sqt_TS.grf TagStatus\Ss_TS.Grf

72

Understanding iFIX

TagStatus\TagControlPanel.grf TagStatus\Tm_TS.Grf TagStatus\Tr_TS.Grf TagStatus\TS.ini TagStatus\Tt_TS.Grf TagStatus\Tx_TS.Grf RCC Files None RCM Files None

Sample BackupRestore.ini
Use the BackupRestore.ini to specify default and custom settings that appear in the Backup and Restore Wizard, and when you run BackupRestore.exe from a command line. The BackupRestore.ini file is located in the iFIX LOCAL folder. If you installed iFIX to the default location, you can find the BackupRestore.ini in the C:\Program Files\GE Fanuc\Proficy iFIX\LOCAL folder. The BackupRestore.ini file can contain information in the following sections: [Version] used to determine iFIX product version in archive header signature. This section is required. Do not change this value. [DefaultSubProject] used to determine default sub-project paths for the Create New Project option in the Restore operation. [FactoryDefaultExtension] used to determine which files are included in Factory Default settings. [WizardSettings] used to determine file name and path (if it is different than your iFIX base path) of the Factory Default file when you select the "Restore default iFIX files before restoring your backup files" option during a Restore operation. [AddCustomExtension] used if you want to include or exclude any additional files or file types in your custom backup. By default, the AddExtension feature is set to False. Set AddExtension to True to enable this feature. Each category has keys to include (xxxIncludeExtn=) and exclude (xxxxExcludeExtn=) files. The xxxxExcludeExtn key is used to exclude files from xxxxIncludeExtn key, not to exclude a default extension. The entire key can be up to 2048 characters long, in total. If you exceed this length, for instance if the path is too long, an error message appears and the custom file or file extension is ignored when you attempt the backup. IMPORTANT: Make sure that you do not include the same file or file extension (from the same location) in more than one category. If you back up the same file or file type in more than one category, you will experience issues restoring your files. Configure your custom settings carefully. By default, the Backup and Restore application references the BackupRestore.ini file when it runs. If you want to change the name of the .INI file, you must run BackupRestore.exe with the /i command line option, and specify the file name of the custom .INI file. If you create a custom .INI file, it must follow the same format described above.

73

Understanding iFIX

The following is an example of the BackupRestore.ini that includes all four of the sections defined above:
[Version] Version=4.00 [DefaultSubProject] LOCPATH=LOCAL PDBPATH=PDB NLSPATH=NLS PICPATH=PIC APPPATH=APP HTCPATH=HTR HTDPATH=HTRDATA HTRDATA=HTRDATA ALMPATH=ALM RCMPATH=RCM RCCPATH=RCC AADPPATH=PDB AADBPATH=PDB [FactoryDefaultExtension] ALM_EXTN=*.* APP_EXTN=*.grf,*.tbx,sqlerr.txt HTR_EXTN=*.csv HTRDATA_EXTN=*.* LOCAL_EXTN=Association.dat,default.fmt,FindReplace.csv,SystemTree.csv,def ault.qry,default.rft,default.srt,logmsg.tov,StandardCategories.txt,*.tbc, *.tbx,*.xbt,*.ico,*.bmp,*.ini PDB_EXTN=CGW.csv,Default.SM2,FIX.sm2,empty.pdb,*.tbl PIC_EXTN=WizLayouts.tpl,*.fds,*.ftb,*.fxg,*.grf,*.SBL,*.BDF,*.odt,*.SVA,* .VGA,*.kmx,*.CSV,TS.ini RCC_EXTN=*.* RCM_EXTN=*.* [WizardSettings] FACTORYDEFAULT=FactoryDefault.IFD FACTORYDEFAULT_PATH= [AddCustomExtension] AddExtension=FALSE ; ;Configuration files (*.SCU,*.INI,*.CFG), LOCPATH SCUIncludeExtn= SCUExcludeExtn= ; ;Picture files (*.GRF,*.FDS,*.FTB,*.LST), PICPATH PicIncludeExtn= PicExcludeExtn= ; ;Database files (*.PDB,*.AAD), PDBPATH PDBIncludeExtn= PDBExcludeExtn= ; ;Database ASCII files (*.GDB), PDBPATH GDBIncludeExtn= GDBExcludeExtn= ; ;Driver Configuration Binary files (*.*), PDBPATH DrvIncludeExtn= DrvExcludeExtn= ; ;Database/Driver CSV files (*.CSV), PDBPATH

74

Understanding iFIX

DBCSVIncludeExtn= DBCSVExcludeExtn= ; ;Historical Config files (.CFG,*.HGP,*.DAT), HTCPATH HistConfigIncludeExtn= HistCOnfigExcludeExtn= ; ;Tag Group files (*.TGD,*.TGS,*.TGE), PICPATH TagGroupIncludeExtn= TagGroupExcludeExtn= ; ;Recipe Control files (*.RCC,*.RCY), RCCPATH RCPIncludeExtn= RCPExcludeExtn= ; ;Master Recipe files (*.RCM,*.RCX), RCMPATH RCMIncludeExtn= RCMExcludeExtn= ; ;Application files (*.*), APPPATH APPIncludeExtn= APPExcludeExtn= ; ;Project Toolbar files(*.TBX,*.TBC), LOCPATH ToolbarIncludeExtn= ToolbarExcludeExtn= ; ;Event Schedule files (*.EVS), PDBPATH ScheduleIncludeExtn= ScheduleExcludeExtn= ; ;Project Global Definition Files(*.FXG), PICPATH FXGIncludeExtn= FXGExcludeExtn= ; ;Chart Group Wizard files(*.CSV), HTCPATH CGWIncludeExtn= CGWExcludeExtn= ; ;FIX32 Picture files(*.ODF,*.ODT,*.SBL), PICPATH FIX32PicIncludeExtn= FIX32PicExcludeExtn= ; ;FIX32 KeyMacro files(*.KMX), PICPATH Fix32KMEIncludeExtn= Fix32KMEExcludeExtn=

75

Understanding iFIX

Specifying a Proficy Batch Execution Project


If you have Proficy Batch Execution installed on your computer, you can configure the local node by specifying a name for the current project with the Proficy iFIX WorkSpace. In Proficy Batch Execution, a project is the entire set of files needed to deliver a batch solution. Typically, a project includes: Pictures An equipment database Recipes Configuration files

However, a project can also include Word files, Excel spreadsheets, or documents from other OLEcompliant applications. Associated with each Batch Execution project is an actual project file. This file stores project-related information. When you specify a project in iFIX, you are selecting the project file you want to open the next time the Proficy Batch Execution Server starts. As a result, you must restart the iFIX WorkSpace and then the Batch Executon Server to load the project you specify.

Using the iFIX Information System


The iFIX Information System consists of electronic books and online Help. Electronic books provide conceptual information about iFIX, including how iFIX works and how to design your system. Online Help gives detailed operating information, such as step-by-step procedures for completing specific tasks and descriptions of window and dialog box components. If you want to access the GE Fanuc web site from the Information System, you need to have an Internet connection. However, an Internet connection is not required to use the Information System. This chapter describes the features of the Information System and describes the relationship among iFIX, electronic books, and online Help. Refer to the Using Electronic Books section for information on using electronic books; refer to the Using Online Help section for information on using online Help. If you have comments about the Information System, please use the feedback link at the bottom of every topic in the electronic books. This link opens a page that allows you to send an e-mail directly to the documentation department at GE Fanuc.

76

Understanding iFIX

Using Electronic Books


This section describes how to: Access electronic books from iFIX and jump between the conceptual information in the electronic book and the related procedures in the online Help. For example, if you are reading about redundancy configuration in the electronic book, you can jump to the online Help procedure for configuring redundancy in the SCU. Use the table of contents and the index for the document set, and the text and figures in the books themselves. Search for information across all iFIX books using the index or full-text search feature. Use Boolean, wildcard, and nested expressions for advanced full-text searches. You can also limit the full-text search to previous results, match similar words, or search topic titles only. Print individual topics from electronic books. Hide or show the frame that contains the Contents, Index, and Search tabs. Copy text and paste it into another application, such as Microsoft Word. Create a personalized list of favorite Help topics using the Favorites tab.

Accessing Information in Electronic Books


You can access the electronic books: In the WorkSpace tree, by double-clicking the Help and Information folder. On the Help menu in any iFIX application, by clicking Electronic Books. By clicking the Start button, pointing to Programs, Proficy HMI SCADA - iFIX, and then Electronic Books.

You can display the Contents, Index, or Search navigation tools in the left frame by clicking the appropriate tab. Text and graphics in the electronic book appear in the frame on the right side of the screen. Initially, the collapsed table of contents is displayed in the left frame and the cover page is displayed in the right frame.

Electronic Book Buttons


The following buttons are displayed at the top of the electronic book window.

77

Understanding iFIX

Electronic Book Toolbar Buttons Hide/Show Lets you toggle the display of the frame that contains the Contents, Index, and Search tabs. Locate Displays the contents heading that corresponds to the current topic. Back Displays the last topic that you accessed. Forward Displays the next topic in a previously viewed sequence. Stop Stops downloading file information if you are connected to the Internet. Refresh Reloads the current file if you are connected to the Internet. Print If the Contents tab is displayed, provides options for printing pages, headings, sub-topics, or the entire table of contents. If the Index or Search tab is displayed, allows you to print the current topic. Options Displays menu commands that correspond to the electronic book toolbar buttons. It also allows you to toggle highlighting of search hits using the Highlighting Off/On command. After you select Highlighting Off, selecting Highlighting On takes effect beginning with the next topic you search for. (This feature is supported in Internet Explorer 4.0 and later.) Help Displays information on how to use iFIX electronic books. GlobalCare Opens the main support web page (http://globalcare.gefanuc.com) if an Internet connection is available.

Using the Table of Contents


You can navigate through the electronic books using the tables of contents. The Contents tab appears on the top of the left frame. From the Contents tab, you can: Double-click the book title to expand the table of contents and display section titles in the book. The closed book icon changes to an open book icon.

78

Understanding iFIX

Click the plus (+) icon to the left of a section title to display subsection titles within that section. A chapter or section is completely expanded when the minus (-) icon appears to the left of the title. Click a topic title to display that topic in the right frame.

You can fully expand the table of contents by right-clicking anywhere within the left frame and selecting Open All from the menu. Likewise, you can fully collapse the table of contents by rightclicking the left frame and selecting Close All from the menu. The following figure shows a fully-expanded table of contents.

Electronic Book with a Fully-Expanded Table of Contents

Searching Electronic Books


You can search for topics in the iFIX electronic books by using either the Index tab or the Search tab: Index Lets you search all iFIX books for topics by keyword. The index displays entries that match or begin with the keyword. Search Lets you search all iFIX electronic books for a specific text string. A list of all topics that contain that search string is displayed. To find a topic using the index: 1. 2. Open the iFIX Electronic Books. Click the Index tab to display the master index for the electronic books.

79

Understanding iFIX

3.

Enter the keyword for which you want to display topics. As you enter the word, the topic list scrolls to display the first topic that begins with or matches the keyword you entered. Click Display to display the topic in the right frame, or double-click the topic.

4.

To find a topic using full-text search: 1. 2. 3. Open the iFIX Electronic Books. Click the Search tab to perform a search for a text string throughout all electronic books. Enter the text for which you want to search. For more information, refer to the Refining Your Search section. Click List Topics. Select the topic that you want to display and click Display, or double-click the topic.

4. 5.

Refining Your Search


When you search for a word in the iFIX electronic books, you obtain a list of all topics in which that word appears. If you enter more than one word, every topic that includes all of the search words appears in the topics list. There are several ways to refine your search: Using Quotes to Define a Phrase Enclosing multiple words in quotes generates a list of topics in which that phrase appears. For example, if you enter the search string:
database blocks

in the Search tab, the topics list includes all topics in which both words appear. The words can appear in any order anywhere in the topic text. If you enter:
"database blocks"

enclosed in quotes, the topics list only includes those topics in which the exact phrase (or slight variations, such as database block) appears in the topic text. NOTE: Be aware that if the text you search for contains the words AND, OR, NOT, or NEAR, you must surround the search phrase with quotes, or quotes surrounded by parentheses. Otherwise, these words will be treated as search operators, and the expected topic(s) will not be found in the search. For example, both of the following search strings should find the appropriate topics:
"items not supported" ("items not supported")

Searching with Wildcard Expressions You can use the * symbol to search for multiple unknown characters in a word or phrase. You can also use the ? symbol for a single unknown character in a search. For example, the entry iW* would display iWebServer and iWebCast. The entry ?DO would display topics for both ADO and RDO.

80

Understanding iFIX

Defining Search Terms The AND, OR, NOT, and NEAR operators enable you to precisely define your search by creating a relationship between search terms. Using Nested Expressions Nested expressions allow you to create complex searches for information. For example, "control AND ((active OR dde) NEAR window)" finds topics containing the word "control" along with the words "active" and "window" close together, or containing "control" along with the words "dde" and "window" close together. The basic rules for searching Help topics using nested expressions are as follows: You can use parentheses to nest expressions within a query. The expressions in parentheses are evaluated before the rest of the query. If a query does not contain a nested expression, it is evaluated from left to right. For example: "Control NOT active OR dde" finds topics containing the word "control" without the word "active," or topics containing the word "dde." On the other hand, "control NOT (active OR dde)" finds topics containing the word "control" without either of the words "active" or "dde." You cannot nest expressions more than five levels deep.

Using Other Searching Methods There are three other options available for searches at the bottom of the search window that you can click. These options are as follows: Search titles only: Allows you to search for words in the titles of HTML files. Match similar words: Enables you to include minor grammatical variations for the phrase you search. For example, a search on the word "add" will find "add," "adds," and "added." This feature only locates variations of the word with common suffixes. For example, a search on the word "add" will find "added," but it will not find "additive." Search previous results: Enables you to narrow a search that results in too many topics found. You can search through your results list from a previous search by using this option. If you want to search through all of the files in a Help system, this check box must be cleared.

Determining Your Location within the Electronic Books


When you select a topic from the Search tab or from the Index tab, the topic appears in the right frame while the left frame continues to display either the search results or the Index. You can see the relative position of the topic within the table of contents by clicking the Click to Show Browse Buttons... link, and then clicking the Locate button from the electronic books toolbar. If you have the Contents tab displayed, the title of the current topic is highlighted in the table of contents as you browse through the book.

81

Understanding iFIX

Printing Electronic Books


The steps that follow describe how to print from the electronic books. To print a single section: 1. 2. 3. 4. Select the topic that you want to print. Click Print. Click Print the Current Page to print the selected topic. Select the printer and printer options, if necessary.

To print a topic from the Search or Index tab: 1. 2. 3. Select the topic or sub-topic from the list. Click Print. Select the printer and printer options, if necessary.

NOTE: If you want to print an entire book or large sections of a book, use the associated .PDF file and print from Acrobat Reader. Contact your GE Fanuc representative for more information on obtaining .PDF files.

Displaying or Hiding the Left Frame


You can choose whether or not to display the left frame, which contains the Contents, Index, and Search tabs. To hide the left frame, click Hide. To show the left frame, click Show.

Copying and Pasting Text from an Electronic Book to Another Application


You can copy all or part of any topic in an electronic book and paste it into any application that accepts text from the clipboard. For example, you may want to copy an example from the Writing Scripts manual and paste it directly into the Visual Basic Editor. To copy selected text in a topic: 1. 2. 3. 4. Display the topic from which you want to copy text. Highlight the text that you want to copy. Press CTRL+C, or right-click the highlighted text and select Copy. Paste the text into another application, such as Word.

82

Understanding iFIX

To copy all of the text in a topic: 1. 2. 3. 4. Display the topic from which you want to copy text. Press CTRL+A, or right-click anywhere within the right frame and select Select All. Press CTRL+C, or right-click the highlighted text and select Copy. Paste the text into another application, such as Word.

NOTE: You cannot copy graphics from an electronic book.

Using the Favorites Tab


The steps below explain how to add links to the Favorites tab in HTML Help. To create a list of favorite Help topics: 1. 2. NOTES To return to a favorite topic, click the Favorites tab, select the topic, and then click Display. If you want to rename a topic, select the topic, and then type a new name in the Current topic box. To remove a favorite topic, select the topic and then click Remove. Locate the Help topic you want to make a favorite topic. Click the Favorites tab, and then click Add.

Using Online Help


This chapter describes how to: Access online Help for procedural information and explanations for dialog boxes, windows, and buttons you are currently using. Search for online Help topics using the full-text search feature. Add custom comments to online Help using the annotation feature. Copy text and paste it into another application, such as Microsoft Word. Customize Help by changing the font size and by using system colors. Mark a Help topic for future reference using the bookmark feature.

83

Understanding iFIX

Accessing Information in Online Help


You can access online Help as described in the following table: Select the... Help Topics command from the Help menu. To access the... Table of contents, index, or full-text search feature. Procedures on how to use the dialog box. What's This? Help for the dialog box control.

Help button.

The dialog box control that you want Help on and press Shift+F1, F1, or click the question mark button, if available, at the top right of the dialog box and select the dialog box control.

Help Contents Tab Selecting Help Topics from the Help menu displays either the table of contents (Contents), the index (Index), or the full-text search feature (Find) depending on what you selected the last time you displayed the Help file. Click the Contents tab to display the table of contents if it is not already displayed. The following figure shows a sample table of contents:

Sample Online Help Table of Contents

84

Understanding iFIX

Initially, each major heading is represented by a closed book. Double-click the heading title to display the Help topics within the heading. The closed book icon changes to an open book. The page (?) icon denotes a Help topic. To display the Help topic, double-click a Help topic title (or click the Help topic title and then click the Display button). The selected topic is displayed in a separate window and the table of contents is closed. Click Help Topics to redisplay the table of contents. The following figure shows a sample online Help topic:

Sample Online Help Topic What's This? Help Use What's This? Help to view information about a dialog box control in a pop-up window. The following table lists how to access What's This? Help. To... View Help for the selected dialog box control. View Help for any field in the dialog box. Select... The field for which you want Help and press Shift+F1.

The What's This? button and then select the control for which you want Help.

Searching Online Help


The full-text search feature of online Help works by building a word list based on the options you choose. Once the list has been built, you do not need to rebuild it unless you want to change it. The options you select when building the list determine the size of the list, which, in turn, determines how effective the list is for various types of searches. Basic searching requires a small word list and is faster than advanced searching, which requires a large word list.

85

Understanding iFIX

When you select the Find tab for the first time, or if you choose to rebuild the word list, the Find Setup Wizard runs. You can choose to build: The minimum size word list for basic searching. The maximum size word list for advanced searching. A custom word list using only the options you select.

When creating a custom word list, you can choose from the following options: Include untitled topics The word list will contain words found in untitled topics. For example, pop-up definitions are untitled. Include phrase searching The word list will include phrases, thus enabling the feature The Words You Typed in Exact Order from the Options button in the full-text search tool. For example, you could search for a person's first and last name, enclosed in quotation marks. Display matching phrases The word list will include phrases and allow the search tool to display matching phrases when you type in more than one word for search criteria. Support similarity searches The full-text search tool allows you to mark topics found based on your search criteria. Later, you can perform similarity searches on the marked topics. To create a word list for the first time: 1. 2. 3. On the Help menu, click Help Topics. Select the Find tab to display the Find Setup Wizard. Select the type of word list you want to create and click Next. If you select Custom search capabilities, several more screens are displayed, which allows you to select the desired options. Select Finish to redisplay the Find tab with the word list.

4.

You can rebuild the list and change the options selected at any time by clicking Rebuild in the Find tab. The process repeats as described above. To search the Help file once you create the word list: 1. 2. 3. 4. 5. On the Help menu, click Help Topics. Click the Find tab. Enter the text you want to find in the Type the word(s) you want to find field. Select the words you want to look for from the list of matching words to narrow the search. Select the topic you want to display from the topic list and click Display.

86

Understanding iFIX

For more information on searching online Help files, select Using Help from any iFIX application's Help menu.

Help Options Menu


From any Help topic or pop-up window, click Options or right-click the topic to display the Options menu. The following commands are available: Annotate Lets you add comments to Help topics. Refer to the Annotating Online Help Topics section for more information. Copy Lets you copy Help topic text and paste it into another application. Refer to the Copying and Pasting Text from Online Help to Another Application section. Print Topic Lets you print the displayed Help topic. Refer to the Printing Online Help Topics section. Font Lets you reduce or enlarge the text in the Help window. Keep Help on Top Lets you keep the Help window on top of all other windows. Use System Colors Lets you use the current operating system colors in the online Help window.

Annotating Online Help Topics


The online Help annotation feature allows you to add comments to iFIX online Help topics. For example, you can add the exact network configuration settings to the topic that explains how to configure your network in the SCU. A paper clip icon in the top left of the Help screen indicates that you have annotated this topic.

Annotated Online Help Topic

87

Understanding iFIX

To annotate a Help topic: 1. 2. 3. Display the topic you want to annotate. Click Options. The annotate dialog box appears. Enter your text in the Current annotation box and click Save. The topic is redisplayed with a paper clip in front of the topic title to indicate that this topic has an annotation.

You can edit the annotation at any time by selecting Annotate from the Options menu. You can also copy and paste text to and from the Annotate dialog box and the clipboard using the Copy and Paste buttons. To view the annotation for a displayed topic: 1. Click the paper clip to the left of the topic title. The Annotate dialog box appears and displays the comments. Click Cancel to return to the Help topic.

2.

To delete the annotation for a displayed topic: 1. Click the paper clip to the left of the topic title. The Annotate dialog box appears and displays the comments. Click Delete to remove the annotation and return to the Help topic.

2.

The annotation file has the same name as the Help file except it has an .ANN extension. For example, annotations created for topics in the SCHEDULER.HLP file are stored in the SCHEDULER.ANN file. Annotation files are located in the Windows Help directory and, once created, can be copied to other nodes. You can create read-only annotation files for access over a network by storing the file in the same location as the Help file. Users can view the annotations but cannot edit them. They can, however, create their own annotations locally. NOTE: If you install an iFIX upgrade, all annotation (.ANN) files are removed from your computer and must be recreated. However, if you re-install the same software version, the files are preserved. For more information on annotating online Help files, select Using Help from any iFIX application's Help menu.

Copying and Pasting Text from Online Help to Another Application


You can copy all or part of any online Help topic to the Windows clipboard. From there, you can paste it into any application that accepts text from the clipboard, including another annotation. For example, you may want to incorporate instructions on configuring your network into a Microsoft Word document. By copying the pertinent procedure, you can then paste it directly into your Word document, eliminating the need to retype the text.

88

Understanding iFIX

To copy Help topic text: 1. 2. Display the topic from which you want to copy text. To copy the entire topic, on the Options menu, click Copy. To copy a section of the topic, highlight the text you want to copy and press CTRL+C. 3. You can now paste the text into another application, such as Word, or paste it into an annotation in the Help file. NOTE: You cannot copy graphics from a Help file. For more information on copying and pasting text from online Help files, select Using Help from any iFIX application's Help menu.

Printing Online Help Topics


Online Help allows you to print topics and pop-up windows. To print a single topic: 1. 2. 3. Display the topic or pop-up that you want to print. On the Options menu, click Print Topic. Select the printer and options that you want and click OK.

To print a pop-up window: 1. 2. Right-click the pop-up that you want to print. Select Print Topic.

To print multiple topics: 1. 2. 3. Display the table of contents for the Help file. Select the book that contains the topics you want to print and click Print. Select the printer and options that you want and click OK. All of the topics in the selected book are printed.

For more information on printing online Help files, select Using Help from any iFIX application's Help menu.

Bookmark Menu
Bookmarks are useful when you frequently refer to the same topic. By defining a bookmark for a topic, you can bypass the table of contents and quickly access the topic from any other topic in the Help file.

89

Understanding iFIX

Once you have defined a bookmark, you can select it from the Bookmark menu and display the associated Help topic. NOTE: If the Help topic does not have a Bookmark menu, you cannot add a bookmark to the Help topic. To create a bookmark for an online Help topic: 1. 2. Access the online Help topic for which you want to create a bookmark. On the Bookmark menu, click Define. The Bookmark Define dialog box appears. If the Help topic does not have a Bookmark menu, you cannot add a bookmark to the Help topic. Enter a name for the bookmark or keep the default (which is the same as the topic title) and click OK to create the bookmark.

3.

To access a bookmarked online Help topic from any other topic: On the Bookmark menu, click the bookmark of the topic that you want to display and click OK. To delete a bookmark: 1. 2. 3. On the Bookmark menu, click Define. Select the bookmark of the Help topic that you want to delete and click Delete. Click OK to return to the Help file.

Bookmarks are stored in the WINHLP32.BMK file, located in the Windows Help directory. For more information on creating bookmarks in online Help files, select Using Help from any iFIX application's Help menu.

90

Understanding iFIX

Using the iFIX Sample System


iFIX includes a Sample System which consists of four industry demos: Water & Wastewater, Chemical, Discrete, and Pharmaceutical manufacturing. The Sample System demonstrates the power and flexibility of iFIX, while providing a learning tool for new users. You can dissect and study these demos to assist you as you create your own applications. All animations and controls in the Sample System are driven by GE Fanuc's real-time process database using the simulation driver that comes with every installation of iFIX. This driver provides several test signals, including a ramp, sine wave, and I/O addresses that you can use to simulate pump and motor control, sequencing, and so forth. None of the animations are driven by scripts or code. Every object, picture, tool, and function in the system was developed using the tools included on your iFIX CD, including the context-sensitive Help provided throughout the Sample System. The demos in the Sample System collectively demonstrate the following features in iFIX: Tag groups Pop-up pictures Alarm counters Trending Reports Picture layers VisiconX Simulation database iFIX graphics ToolTips Electronic signatures Electronic records

While using the Sample System, you may use pictures you find that work well in your own application. Many of the pictures were designed to be flexible for this purpose. For example, the trending screen's Start Date/Time form list has a drop-down box that lists dates with historical data. Instead of hard-coding in the dates that came with the Sample System, the form looks at the historical data path for the machine and returns all the available dates that are on the machine. So, with minor modifications, you can use it on your system. For more detailed information on any of the features demonstrated in the Sample System, refer to the iFIX electronic books.

91

Understanding iFIX

Before You Begin


Before you begin using the Sample System, you should be aware of the restrictions and requirements discussed in this section.

User Accounts that Start the Sample System


Any user account that starts the Sample System must be a member of either the Administrators group or the Power Users group in Windows. If the logged-in user account is not a member of either of these groups, iFIX will start instead of the Sample System when you try to start the Sample System. For example, if the logged user is only a member of the ordinary Users group, the Sample System does not run correctly. But, if that same user is a member of Power Users or Administrators group instead, the Sample System does run correctly.

Running the Sample System with iFIX


The Sample System runs on a special demo version of iFIX; therefore, you cannot run the Sample System and iFIX simultaneously. When you start iFIX, a dialog box appears, giving you the choice of starting iFIX normally, starting the Sample System, or always starting iFIX normally.

Using the Sample System with a Terminal Server


If you use multiple Sample System sessions with a Terminal Server, you should be aware of the following: Terminal Server requires that each node have a unique node name. For the Sample System, every session starts with the node name SAMPLE. Multiple Sample System sessions use the same LOCAL directory and the same .tbx (toolbar) files. The first session that runs accesses the toolbar. All subsequent sessions are unable to load the toolbars. Multiple Sample System sessions use the same PIC directory and the same .TGS (Tag Group Storage) files. The first session to run using a .TGS file gets exclusive access. A Subsequent Sessions Report error displays.

To avoid these Sample System node name-related problems, use LAUNCH.EXE to start the Sample System with a unique node name as described below for each terminal server user. To use Launch.exe to start the Sample System: 1. Copy the Sample System directory into a unique directory. For example, C:\Program Files\GE Fanuc\Proficy iFIX\Sample2. Open the .SCU file in the new \local directory of the directory you created. In the SCU, select Configure Paths and change all paths to match your new directory.

2. 3.

92

Understanding iFIX

4.

Create a new LAUNCH shortcut to start your new system, for example:
Launch.exe /t /nNEWNODENAME /sNEWPATH

Where NEWNODENAME is the unique node name, NEWPATH is the new path to the SCU file. For example:
Launch.exe /t /nSAMPLE2 /s"C:\Program Files\GE Fanuc\Proficy iFIX\SAMPLE2\LOCAL\SAMPLE2.SCU"

For more information on using the LAUNCH.EXE program, refer to the section Running iFIX from the Command Line in the Setting Up the Environment manual. NOTE: When using the Sample System with Terminal Server, we recommend that you disable picture caching for better performance.

Using the Sample System with Picture Caching


Disable picture caching when using the Sample System.

Starting the Sample System


Start the Sample System using either method: Double-click the Sample System icon on your desktop. Click the Start button and point to Programs, Proficy HMI SCADA - iFIX, and then iFIX Sample System.

You cannot run the Sample System and iFIX simultaneously. If iFIX is already running when you attempt to start up the Sample System, a dialog box appears asking if you want to shut down iFIX and start another configuration. If iFIX is not running when you start up the Sample System, the Sample System starts immediately and displays the following main menu.

93

Understanding iFIX

Sample System Main Screen From this screen you can: Enter any of the four industry demos. Visit the GE Fanuc web site. Open the Sample System Help. View web-based Microsoft PowerPoint slides that describe the technology innovation of GE Fanuc's software. Read the iFIX electronic books. Locate the address of other GE Fanuc offices worldwide. Exit the Sample System.

Help is available for each category of information on the main menu. Click the ? button, then click on an item for additional information.

Accessing Other Desktop Applications


The Sample System opens in full screen view. Screen elements, such as scroll bars, toolbars and menus are not visible. Therefore, you must press Alt+Tab to access other applications that you are running on your desktop.

94

Understanding iFIX

Using the Sample System Help


The Sample System uses Help to describe the functionality demonstrated in each picture. The Help describes special features and technologies being highlighted, and in many cases, describes how an animation or function was created. Many of the objects in a picture, for example, a pump, tank, or valve, have Help that describes how the object was created, and the purpose of that object within the picture. Therefore, it is important that you understand how to use the Help system.

Getting Help for an Object or Picture


The ? button is available on each screen of every picture. If you are not sure what an object does or how it was created, click the ? button, then click on the object (field, button, tank, pump, valve, and so forth) to display Help for that object. You can also click the ? button, then click anywhere on the picture for general information about the picture. Press Shift+F1 to display the ? button, then you can click an object to display help.

Displaying ToolTips
ToolTips are used throughout the Sample System. Place your cursor over an object for a few seconds to display the ToolTip for that object, if one exists.

Clicking the Help File Button from a Picture


Clicking the Help File button from a picture displays the table of contents for the entire Sample System Help. From this Help window you can display Help topics by navigating through the table of contents, or you can search for a topic by clicking the Index or Find tabs.

Working with the Sample System Demos


Before you begin using the Sample System demos, it is helpful to understand basic information about the demos such as how the Alarm Summary, Trending, and Reporting screens were setup, how to use the configure and run modes, and how to navigate through the demos. Refer to the following sections for more information: Understanding the Alarm Summary, Trending Chart, and Reporting Screens Using Configure and Run Modes Navigating through the Demos

Understanding the Alarm Summary, Trending Chart, and Reporting Screens


The Sample System uses one Alarm Summary, Trending Chart, and Reporting screen for all industry demos. For example, instead of placing and configuring an Alarm Summary object in each picture, the Sample System uses a single picture that stays on top of the other pictures. For alarms, each of the four industries is separated into four different alarm areas: Water_WasteWater, Batch_Production, Discrete_Mfg, and Pharm_Process. Therefore, when you are in the Water & Wastewater demo, you see alarms only for that industry.

95

Understanding iFIX

Similarly, all of the alarm counters are also filtered based on the particular alarm area. Each time the alarm summary picture opens it loads the appropriate Tag Group file to filter the alarms and restrict the alarm counters to the specific area you are in. For the Trending Chart screen, only the real-time and historical tags for the industry you are in are available. For the reporting screen, only the tags for the industry you are in are available. As a result, the Alarm Summary Object, Trending Chart, and Reporting screens show different information as you change industries. Because all demos share one alarm summary and trending screen, the specific details of these features are discussed in the Exploring Alarms and Alarm Counters and Exploring Trending sections. You can explore these features from any demo.

Using Configure and Run Modes


Press Ctrl+W to toggle between run mode and configure mode in each of the demos. Configure mode opens the WorkSpace and allows you to drill down into the components of an object to see how it was created. You can add data or try a new feature, then press Ctrl+W again to see that object's behavior in run mode. NOTE: When you switch to configure mode, some pictures have variables that are set based on which buttons you clicked. Therefore, after you make changes in configure mode, the picture may not always display correctly. To ensure that the picture displays correctly after you have made changes, either shutdown and re-start the WorkSpace, or close all pictures and open the main menu picture (iFix1_Splash.grf), then switch to run mode and navigate to the picture you changed.

Navigating through the Demos


Each picture in the Sample System contains Previous and Next buttons that let you move through the screens in each picture. The Next button takes you to the next screen in the demo, and the Previous button takes you to the last screen that you viewed within a demo. If you switch to another demo, the Previous button will not work. You can change industry demos by clicking the appropriate button from the current demo.

Quick Tour of the Discrete Manufacturing Demo


The Discrete Manufacturing demo shows a picture tube annealing assembly line. This is the simplest of the four demos and demonstrates the use of the simulation database and iFIX graphics capability. All the graphics in this picture were created using iFIX objects. No bitmaps are used in this picture. To start the production line and view the picture tube annealing process, click the Start button.

The Annealing Process


In the Discrete Manufacturing demo, picture tubes move from right to left down the assembly line. There are three stages in this process, as shown at the top of the picture: pre-heating stage, annealing stage, and the cool down stage. The tubes are pre-heated, then rotated as the tube necks are annealed on. Finally, they move under the cooling flange which drops over the necks to cool them before they move on to the rest of the production line. The entire annealing process is driven by Analog Input (AI) and Digital Input (DI) tags in the process database. When you start the production line, a set of Program Blocks (PG) in the process database act as a PLC and write values to the AI and DI tags to simulate the process.

96

Understanding iFIX

Manufacturing Step Indicator


The Manufacturing Step Indicator to the left in the picture shows which steps are currently being performed on the production line. Notice the red arrows and flashing red text that indicate which processes are currently being performed on the production line. As the tubes move down the assembly line, the total number of tubes produced and the number of rejects updates automatically in the Total, Target Qty, and Rejects fields located at the bottom of the Manufacturing Step Indicator. Click on the ? button, then click on any of these fields for a description of how the field was created and its purpose within the picture.

Alarm Summary Object


The alarm summary object is located at the bottom of the screen and shows only one alarm. As explained earlier, all four demos use one alarm summary screen which filters the alarms based on the demo that you are viewing. Although you can right-click on the alarm summary in this picture to perform other functions, we recommend that you explore the alarm summary feature using the Chemical or Wastewater demo. These demos contain a greater number of alarms which will allow you explore more of the functionality available in the alarm summary object. To see a larger more expanded view of the Alarm Summary screen, click on the Alarms button. For more information on the simulation database, refer to the section Using the Simulation Driver (SIM) in the Building a SCADA System manual. For more information on creating graphics, refer to the Creating Pictures manual.

Quick Tour of the Water & Wastewater Demo


The Water & Wastewater demo shows a picture of a water filtration and chemical feed system. This demo shows the use of tag groups, pop-up pictures, alarm counters, trending, and reports. All graphics in this picture were created using iFIX objects. This section guides you through exploring tag groups and pop-up pictures. To explore alarms, alarm counters, and trending, refer to the Exploring Alarms and Alarm Counters and Exploring Trending sections. The chemical feed picture in the Water & Wastewater demo shows two storage tanks of Sodium Hydroxide connected to three pumps that control input to the tanks. This picture uses tag groups for pump and valve control, and Multistate Digital Input blocks. The use of tag groups and Multistate Digital blocks show how you can use a single database tag to indicate one of several conditions such as Stop, Fail, Auto, and Manual. This picture also includes a Backwash Filter sequencing process. Instead of having three different pictures for each backwash filter, we use only one picture and use tag groups to substitute the appropriate tags for each filter. Click on the Next button to display the Backwash Filter screens. From the Backwash Filter screen you can select one of the three different filters to display, start, or stop the sequence, and control the various blowers and valves.

Exploring Tag Groups and Pop-up Pictures


Tag groups provide a way to let you use one picture multiple times with different tags. For example, the Water & Wastewater picture uses a single valve pop-up picture to control any number of different valves by opening the picture with a different tag group file. Tag groups support in-line substitution which allow you to easily open a picture with a different tag file group. With in-line substitution, if only a small part of a tag name changes between any two data sources, you only have to replace that part. The tag groups used in this picture have only two entries: the node name and the equipment ID (which is the filter number). Notice also that the Sample System

97

Understanding iFIX

is a single node application. We could have used only one entry. Therefore, if you choose a good tag naming convention, it is possible to have very few entries in your tag group file for a picture with many tags. For example, the influent valve has the following data source:
Fix32.@NODE_NAME@.IFIX1_H20_@EQUIPMENT_ID@_INLS0305.A_TAG

Where @Node_Name@, substitute the node name, and where @Equipment_ID@, substitute the filter number (BW1, BW2, or BW3). So, for Filter 1 on the node called Thisnode, the link is:
Fix32.THISNODE.IFIX1_H2O_BW1_INLS0305.A_TAG

For more information on creating tag groups, refer to the Using Tag Groups in Pictures chapter in the Creating Pictures manual. The following are some ways to explore tag groups and pop-up pictures in the Wastewater demo:

Do this.... Select the Chemical Feed button, then click one of the three pumps to open the picture as a pop-up.

And notice... A pop-up picture that is used to control the pumps. Notice that if you keep the pop-up picture open and click on a different pump on the main picture, a new tag group is loaded in the pop-up picture without having to first close it. For more information about the objects in the pop-up window, click on the ? button in the pop-up window, then click on any object in the pop-up window.

Click the Backwash Filter button.

The entire picture uses tag groups. Clicking on one of the Backwash Filter buttons loads a different tag group and causes the same picture to display different tags. Deciding which tag group file loads when you click on a valve or blower (which opens a pop-up) is also based on tag groups.

Quick Tour of the Chemical Demo


The Chemical demo shows some of the various tank, pipe, and valve Dynamos in iFIX. The tank levels, mixers, temperatures, and valve positions come from simulation I/O points in the real-time database using Analog Input (AI) and Digital Input (DI) blocks. The pipe flows are calculated using calculation (CA) blocks. All of the pipe colors come from a global color threshold table that contains a single set of color definitions for values of 0 100%. This demo demonstrates picture layers, ToolTips, VisiconX, alarms, and reports. This section guides you through exploring picture layers, ToolTips, and VisiconX. For a detailed look at alarms, alarm counters, and trending, refer to the Exploring Alarms and Alarm Counters and Exploring Trending sections.

98

Understanding iFIX

Exploring Picture Layers


Picture layers are a fast way to show or hide objects in a picture based upon the object's layer. A picture can have up to 30 layers, and an object can have one or more layers assigned to it. So, for example, if all the pipes in a picture are assigned to layer 5, they are only displayed when the picture's visible layer includes level 5. Objects can also belong to more than one layer, so if pipes belong to layer 5 and layer 10, they are displayed when either of those two layers are displayed. The following are some ways to view picture layers in the Chemical demo: Do this... Click the Select Layers to Show button. And notice... A dialog box appears that allows you to show or hide different objects in the picture. The objects have layer numbers assigned from 1 through 13. Some objects, like the buttons, have no layer assigned because we want them to always display. Notice also that all check boxes are selected and all layers are displayed. Clear the check box next to one of the objects in the dialog box. Click the check box next to the same object again. The object is hidden from view instantly.

The object is instantly displayed.

Picture layers are also used in the Waster & Wastewater demo. To view the use of picture layers in the Water & Wastewater demo, click the Wastewater button from the Chemical demo, and select the Backwash Filter button. Click the Show Tags button and notice the tag names for the various objects appear on the screen. This was done by changing the picture display layer. Notice also that as you change different filters, the tag names change also. For more information on picture layers, refer to the Creating Complex Objects section in the Creating Pictures manual.

Exploring ToolTips
You can add a ToolTip for each object on a screen. A ToolTip is a small window that appears over an object when you hold your mouse over the object for a few seconds. To view a ToolTip, place your mouse over any object, for example, the Select Layers to Show button. Notice the small window of information that appears. To add a ToolTip in configure mode: 1. 2. Press CTRL+W to switch to configure mode. Right-click on the object for which you want to add the ToolTip, then select Animations from the right-click menu.

99

Understanding iFIX

3. 4. 5.

In the Descriptions field, enter the ToolTip. Click on the Enable ToolTips check box and click OK. Press CTRL+W to switch to run mode, then place your mouse over the object to see the ToolTip displayed.

Exploring VisiconX
VisiconX is a set of ActiveX controls developed by GE Fanuc to bring data from an OLE or ODBC database (for example, SQL, Oracle, and Microsoft Access) into the Proficy iFIX WorkSpace. Click on the Batch Data button to view the Batch and CIP summary screens which use VisiconX. You can also view an Alarm History screen, populated from an Access database. For more information about any object on any of these screens, click the ? button, then click on the object. For more information about using VisiconX, refer to the Using VisiconX manual. Batch Data Summary Screen To view the Batch Summary screen, click the Batch Data button. The batch summary screen shows a sample product line with some profit and production values from a Microsoft Access database. All the data is returned and evaluated using only VisiconX data controls. To see how VisiconX is used in this picture, select a product in the Available Products grid to the left of the picture. Notice that the batch summary grid updates automatically to show the information for that particular product. This is done automatically because the two grids are linked together by animating the ADO Records property of the Batch Summary grid to the selected entry of the Available Products grid. You can also change the unit cost of a selected product in the Available Products grid to the left of the picture, then click the Commit button to write the new value to the database and re-calculate the production totals. For more information about any object or grid on this screen, click the ? button, then click the object or grid. Clean In Place (CIP) Summary Screen To view the CIP Summary screen, click the CIP button from the Batch Data screen. This screen shows a sample Clean In Place (CIP) summary for a specialty chemical/batch process. The data comes from a Microsoft Access database that was populated using the SQL Trigger (SQT) and SQL Data (SQD) database blocks in the real-time process database. To see how VisiconX is used in this picture, select a different CIP route, and notice that the usage summary, batches produced, CIP supplier information and statistics data are updated. All the data is returned and evaluated using only VisiconX data controls. All data controls are linked together so that as one updates, any dependent controls automatically re-query the database to get the latest information. For more information about any object or grid on this screen, click the ? button, then click the object or grid. Alarm History Screen To view the Alarm History screen, click on the Alarm Hist button on the CIP Summary screen. The Alarm History screen demonstrates the Alarm ODBC driver and VisiconX. The Alarm ODBC driver is

100

Understanding iFIX

a service that sends all alarms and system events to a relational database, such as Microsoft Access, SQL and Oracle. The picture uses two VisiconX data controls to let you select the alarms from either all the tags or a specific tag based on your selection in the drop-down combo box. To see how VisiconX is used in this picture, click on the drop-down box and choose a tag. Notice that the alarm history changes each time you select a different tag in the drop-down box. You can also manipulate the data in the grid in the following ways: Click the Create SQL Wizard button to create your own custom SQL expression and display it in a grid. When you click this button, a series of dialog boxes display from which you can select a table, row, a selection criteria and sort order. Select the Merge Rows check box to merge the information in each column that is the same.

For more information on any object or grid on the screen, click the ? button, then click the object or grid.

Quick Tour of the Pharmaceutical Demo


The Pharmaceutical demo shows a high shear mixing machine picture. This demo shows how to use electronic signatures to sign for database changes and alarm acknowledgements. It also shows an audit trail containing electronic signature data. To get started with the Pharmaceutical demo, select the mixer you want to work with by clicking the appropriate button, High Shear Mixer 1 or High Shear Mixer 2. The name of the mixer you select displays in the upper-left corner of the picture. Modifying Controls You can perform the following activities by clicking the indicated button: Button Load/Unload Mixing Bowl Change/Remove Mixing Bowl Function Load or unload the mixing bowl from the mixer. Change or remove the mixing bowl from the mixer. Start or stop the mixer. Display or hide the mixing blades in the mixing bowl.

Start/Stop Cut Away

The current state of the mixer displays and changes as you use these controls.

101

Understanding iFIX

Modifying Temperatures The mixer temperature controls featured in this demo allow you to change the temperature setpoint using any of these Experts: Data Entry Slider Ramp

Using Electronic Signatures This demo requires that you enter electronic signatures for these actions: When you start or stop a mixer, you must enter a Performed By and a Verified By signature. When you use any one of the Experts to change the setpoint temperature, you need to enter only a Performed By signature. When you acknowledge an alarm, you need to enter only a Performed By signature.

For the purposes of this demo, fictitious users were created and assigned corresponding security areas and application feature privileges. You can display this information in the User Security Matrix picture by clicking the Users button at the top of the Pharmaceutical demo picture. The following table shows these users, their passwords, and their designated security areas and application features. User Full Name George Clark Thomas White User Name Password Security Area Application Feature(s)

GCLARK

GC

Mixer 1

Electronic Signature - Perform By. Electronic Signature - Perform By. Electronic Signature Verify By. Electronic Signature - Perform By. Electronic Signature - Perform By. Electronic Signature Verify By.

TWHITE

TW

Mixer 1 and Mixer 2

Peter Smith Laura Jones

PSMITH

PS

Mixer 2

LJONES

LJ

Mixer 2

102

Understanding iFIX

Signing When Starting and Stopping the Mixer


You should experiment with the users available in the User Security Matrix interchangeably to sign for an action you perform. To maximize your understanding of how signing privileges work, sign for an action with a valid user, and then sign for that same action with an invalid user. The following three scenarios suggest how you may want to try signing for your actions in the Pharmaceutical demo. Scenario 1 Start or stop Mixer 1. You must enter a Perform By and Verify By user. Enter George Clark as the Perform By user; enter Thomas White as the Verify By user. According to the User Security Matrix, these are valid users, and the electronic signature works. Scenario 2 Start or stop Mixer 2. You must enter a Perform By and Verify By user. Enter George Clark as the Perform By user. George is not qualified to sign for Mixer 2, so an unauthorized access attempt message appears. Now enter Peter Smith as the Perform By user and Laura Jones as the Verify By user. These are valid users, and the electronic signature works. Scenario 3 Start or stop Mixer 2. You must enter a Perform By and Verify By user. Enter Laura Jones as the Perform By user and as the Verify By user. Although Laura Jones has permission to perform and verify a signed action for Mixer 2, the same user can never sign both signatures for the same action. A message displays to indicate this condition, and you are prompted to enter a different user name. Enter Thomas White as the Verify By user. These are valid users, and the electronic signature works. Continue to experiment with a variety of users to test the power of electronic signatures.

Signing When Using an Expert


You can change the temperature setpoint of the mixer using the Data Entry, Slider, or Ramp Expert, as indicated on the Mixer Temperature picture. Each time you change a value using one of these Experts, you have to enter a Perform By signature. Refer to the User Security Matrix picture for a list of authorized users. If you sign with an unauthorized user's name or an invalid password, an error message displays.

Signing When Acknowledging Alarms


You can acknowledge an alarm from the Alarm Summary object, located at the bottom of the Pharmaceutical demo, or you can click the Alarms button to display a full-screen view of the Alarm Summary object. When you double-click an alarm in this demo, the Performed By electronic signature box appears. All alarms are configured to require the perform by signature only. All users listed in the User Security Matrix picture are authorized to acknowledge an alarm. If you sign with an unauthorized user's name or an invalid password, an error message displays. Acknowledging All Alarms The Electronic Signature option does not support Acknowledge All alarms capability. When you click the Acknowledge All button, you are actually acknowledging the alarms on the displayed page only.

103

Understanding iFIX

If you select Acknowledge All from the right-mouse menu, a warning message displays, indicating that one or more alarms require electronic signature. In these instances, alarms that are not connected to tags that require electronic signature are acknowledged. You must acknowledge the remaining alarms individually.

Viewing the Audit Trail from a Relational Database


The Pharmaceutical demo provides a VisiconX object that displays audit trail records in a relational database. When an operator signs for an action or alarm acknowledgement, the Alarm ODBC driver sends information about that action to a relational database. This information can include information about the users, such as the Perform By operator's full name and optional comment, and the Verify By operator's full name and optional comment. The information can also include information about the data that changed, such as the data source identifier, its original value, and its new value. You can sort and search the records of the audit trail by batch ID or users.

Exploring Trending
The Trending screen shows some of the power and flexibility of the iFIX chart object. One of its main features is the ability to display real-time process data, historical/archived data, and lab data from a file or database. You can customize most properties, from colors to scroll directions, in the configure or run-time environment. To begin exploring the trending feature, click the Trending button from the Chemical or Wastewater demo. The following are examples of ways that you can explore the trending feature: Do this... Select a tag from the Historical pens list, then click the Add Pen button. And notice... A pen is added to the chart. This pen shows data for the tag you selected. It shows the values of the tag or process. A second pen is added to the chart that shows the real-time values of the tag or process. NOTE: Each pen you add is given a different color and the corresponding tag is listed at the bottom of the chart in the same color as the pen.

Select a tag in the real-time Pens list, then click the Add Pen button.

Choose the trending criteria: Click the Start Date/Time button to choose the date and time from which to begin showing data. Click one of the Duration times to specify the time period for which to display data.

When you choose the date, time, interval, and duration, the dates and times at the bottom of the chart changes accordingly.

104

Understanding iFIX

The following table provides examples of what happens when you manipulate the grid in the indicated manner. Manipulate the grid like this... Click the Change Colors button to change the pen color. Click the Scroll Left To Right button to change the scroll direction. Click the Multiple Times and Multiple Values button to simultaneously display times and values for each pen on the chart. Click the tag name in the lower left corner of the chart to view the time and value legend for each pen. Change zoom directions and percentage. And notice... The color of the pen and legend information changes. The direction in which the data scrolls changes. The time and value legend for each pen displays at the same time. To return to the default, click these buttons again. The color of the time and value legend changes to reflect the tag you clicked.

The data on the chart sizes accordingly. Click Reset Zoom to return to the default setting. The currently selected pen is deleted. The currently selected pen is the pen whose time and value legends are currently displayed. The data on the chart moves accordingly.

Click the Delete Pen button to delete a pen.

Click the arrow buttons to move forward or backward by 25 or 50%. NOTE: You can also double-click the chart to display the Chart Configuration dialog box, which contains many of these functions.

Click the Lab Data from the MS Access button to retrieve data from a relational database.

A third pen is added that shows the lab data.

Exploring Alarms and Alarm Counters


You can explore alarms and alarm counters in all industry demos. However, we recommend that you use either the Chemical or Wastewater demo because they contain more alarms which will allow you to more fully explore the alarm functionality. All industry demos use the same alarm summary screen. In this Sample System, we separate each of the four industries into four different alarm areas: Water_WasteWater, Batch_Production, Discrete_Mfg, and Pharm_Process. Therefore, when you are in the Water & Wastewater demo, you only see alarms for the Wastewater picture. Similarly, all of the alarm counters are also filtered based on the particular alarm area. As you change industries, the same picture shows different information.

105

Understanding iFIX

While there are many ways of doing this, in the Sample System, every time the alarm summary picture opens it loads the appropriate Tag Group file to filter the alarms and restrict the alarm counters to the specific area you are in. The alarm summary screen shows several features of GE Fanuc's alarming feature including: alarm areas, alarm counters, and the alarm summary object. The alarm summary object, sometimes referred to as the alarm summary OCX (ActiveX control), is the grid that you view that allows you to filter and sort the alarms based on your preferences. Alarm areas allow you to filter the alarms in the grid so that an operator can see and acknowledge them based on a physical or logical method of grouping equipment. Alarm counters enable you to get a quick summary of the number and type of alarms in your plant. The alarm counter summary is located at the bottom of the Alarm Summary screen. The alarm summary object is shown at the bottom of each picture in a minimized screen. To display the Alarm summary in full screen view, click on the Alarms button. The following are some ways to explore alarms and alarm counters: Do this... Click on one alarm in the alarm summary grid, then click the Acknowledge Alarms button. You can also select multiple alarms by pressing and holding Ctrl while clicking additional alarms. And notice... When you click the Acknowledge Alarm button, the alarm is acknowledged and a check mark appears to the left of the alarm. (By default, acknowledged alarms are deleted from the alarm summary, however, you can change this feature in the SCU.) Notice also that the alarm counter summary totals change to reflect the acknowledged alarm. Sort the alarms by clicking on the Sort field (located in the lower right corner of the screen) and choosing a sort criteria. You can also rightclick on the alarm summary and select Sort from the right-click menu, or click the column name to perform a quick sort. Right-click on the alarm summary and select Pause Alarm Read to pause the alarm summary. You can also pause the alarm summary by selecting multiple alarms. Click the Enable Alarm Horn button to enable the Alarm horn. The alarms are sorted according to the sort criteria you chose. Notice also that when you change the sort criteria, the summary bar at the bottom of the alarm summary object (to the left of the alarm summary status) changes to reflect the new sort criteria. The alarm summary status indicator changes to reflect the state of the alarm summary. When the alarm summary is paused, no new alarms are displayed. The alarm horn beeps through your PC's speakers.

The alarm counter summary at the bottom of the Alarm screen shows at a glance the number of acknowledged and unacknowledged alarms by alarm priority (CRITICAL, HIHI, HIGH, MEDIUM, LOW, LOLO, INFO) for a particular alarm area. Click on the ? button, then click on a field in the alarm counter grid for an explanation of that field. You can also press Ctrl+W to see how the grid was created.

106

Understanding iFIX

You can also enable or disable alarms for a particular object (pump, tank, and so forth) as demonstrated in the Wastewater demo. Click on the Wastewater button to switch to the Wastewater demo, then click on the Alarm Inhibit button. A dialog box displays a list of objects for which you can enable or disable alarms. Select one or more objects, then click Exit. Alarms are disabled for the selected objects. Notice that when you disable alarms, the Alarm Inhibit button turns yellow to alert you that there are disabled alarms. To view the number of disabled alarms, refer to the Disabled column in the Alarm Counter summary at the bottom of the Alarms screen. For more information on the alarms and alarm counters, refer to the Implementing Alarms and Messages manual.

107

Understanding iFIX

108

Index
A acknowledging alarms, Pharmaceutical demo .......................................................... 103 ActiveX in iFIX ........................................................... 5 integrating documents.................................. 25 support ........................................................... 9 ActiveX controls................................................ 5 adding buttons to a toolbar ...................................... 42 toolbar buttons to a category........................ 43 toolbar categories......................................... 43 alarm areas....................................................... 17 alarming as a system function..................................... 21 in iFIX ......................................................... 16 alarms routing.......................................................... 17 tasks ............................................................. 16 types............................................................. 16 alarms and alarm counters, Sample System... 105 annotating online Help..................................... 87 application functions ...................................................... 24 starting ......................................................... 38 toolbar.......................................................... 40 architecture ........................................................ 7 archiving data .................................................. 22 arranging, toolbar buttons................................ 42 audit trail, Pharmaceutical demo ................... 104 B backup and restore ........................................... 51 C centralized processing...................................... 15 chains ............................................................... 10 charts, setting preferences................................ 45 Chemical demo exploring picture layers ............................... 99 exploring ToolTips ...................................... 99 exploring VisiconX.................................... 100 overview ...................................................... 98 COM .................................................................. 4 command line parameters for WorkSpace ....... 26 Component Object Model (COM) ..................... 4 components, iFIX .............................................. 2 configuration environment................................. 2 configure mode, Sample System...................... 96 backup files Backup and Restore Wizard ........................ 51 saving........................................................... 45 blind SCADA server.......................................... 7 block alarms..................................................... 16 block messages ................................................ 16 blocks chains ........................................................... 10 primary......................................................... 10 secondary ..................................................... 10 buttons configuring................................................... 43 creating for toolbars ..................................... 43 deleting from a category .............................. 43 modifying..................................................... 43 modifying properties.................................... 43

109

Understanding iFIX

configuring buttons ......................................................... 43 run-time preferences .................................... 46 the picture path ............................................ 48 your local computer ..................................... 47 Contents tab electronic books........................................... 78 online Help .................................................. 84 control.............................................................. 21 copying toolbar categories............................... 44 copying and pasting text electronic books........................................... 82 online Help .................................................. 88 creating dynamo sets ................................................. 40 new document.............................................. 40 new pictures................................................. 40 new schedules .............................................. 40 toolbar buttons ............................................. 43 toolbar categories......................................... 43 toolbars ........................................................ 43 Crystal Reports, using with iFIX ..................... 22 D data accessing........................................................ 8 archiving ...................................................... 22 flow.............................................................. 10 retrieving...................................................... 20 data Server Installer ........................................... 4 data sources ....................................................... 8 data transfer on demand................................... 14 database control strategies ............................... 10 DCOM ............................................................... 5 DDE................................................................... 8 deleting buttons from a category ............................... 43 document from the system tree.................... 40

deleting (cont.) toolbar categories......................................... 43 toolbars ........................................................ 43 disabling error dialog boxes ........................................ 39 Proficy Historian errors ............................... 39 Discrete Manufacturing demo ......................... 96 displaying system tree path.............................. 35 distributed processing ...................................... 13 documentation.................................................. 76 documents creating ........................................................ 40 deleting and renaming.................................. 40 integrating with iFIX from other programs .................................................. 25 opening ........................................................ 40 saving........................................................... 40 working with................................................ 40 drawing options, setting preferences................ 45 dynamic connection ......................................... 13 Dynamic Data Exchange (DDE)........................ 9 dynamo sets, creating....................................... 40 E electronic books accessing information .................................. 77 buttons ......................................................... 77 changing the color of search hits ................. 83 Contents tab ................................................. 78 copying and pasting text .............................. 82 display options ............................................. 82 features......................................................... 77 Index tab ...................................................... 79 Locate button ............................................... 81 printing......................................................... 82 Search tab .................................................... 79 environment protection .................................... 39

110

Index

environments changing the start-up ................................... 46 configuration................................................ 38 described...................................................... 38 run-time ....................................................... 38 switching between ....................................... 38 exception-based processing ............................. 12 Experts and the Task Wizard .................................... 44 using signing in the Pharmaceutical demo. 103 exploring Trending ........................................ 104 F failover............................................................. 15 file server, using to share files among nodes ... 48 files backing up and restoring.............................. 51 saving backup .............................................. 45 sharing ......................................................... 14 sharing among nodes ................................... 48 storing .......................................................... 14 Find tab, online Help ....................................... 85 H HMI functions ................................................. 20 I I/O drivers, using the OPC Toolkit.................... 9 iClient ................................................................ 7 iFIX components.................................................... 2 enabling technologies .................................... 4 enabling technologies, ActiveX..................... 4 enabling technologies, OPC........................... 4 manuals........................................................ 76 plug-in components ....................................... 3 using documentation.................................... 76 Index tab electronic books........................................... 79 online Help .................................................. 85

iVisualize, working with iFIX ........................... 3 K keyboard, virtual .............................................. 31 keyless entry .................................................... 31 L local node........................................................... 7 Locate button ................................................... 81 login, security .................................................. 19 M manuals............................................................ 76 message routing.......................................................... 17 types............................................................. 16 modifying button properties............................. 43 monitoring ....................................................... 21 N navigating through the Sample System demos........................................................... 96 nodes blind SCADA server...................................... 7 iClient ............................................................ 7 local ............................................................... 7 remote ............................................................ 7 run-time ......................................................... 7 SCADA server ............................................... 7 stand alone ..................................................... 7 O ODBC ................................................................ 8 OLE, using to access data .................................. 8 OLE for Process Control (OPC) ........................ 4 on-demand data transfer................................... 14 one-shot processing ......................................... 13 online Help accessing information .................................. 84 adding bookmarks........................................ 89 annotating .................................................... 87 Contents tab ................................................. 84

111

Understanding iFIX

online Help (cont.) copying and pasting text .............................. 88 features ........................................................ 83 Find tab........................................................ 85 printing ........................................................ 89 using bookmarks.......................................... 89 What's This? Help........................................ 84 OPC, using with iFIX ........................................ 4 OPC server, customizing error strings............. 46 OPC Toolkit....................................................... 9 open architecture.............................................. 23 Open Database Connectivity (ODBC)............... 9 opening a document......................................... 40 operator messages............................................ 16 overview Chemical demo ............................................ 98 Discrete Manufacturing demo ..................... 96 of sample system ......................................... 91 Pharmaceutical demo................................. 101 Water & Wastewater demo.......................... 97 P passwords ........................................................ 31 paths................................................................. 48 Pharmaceutical demo overview .................................................... 101 signing when acknowledging alarms......... 103 signing when starting and stopping the mixer...................................................... 103 signing when using an Expert.................... 103 viewing the audit trail from a relational database ................................................. 104 picture layers exploring in the Chemical demo.................. 99 exploring in the Water & Wastewater demo ........................................................ 99 pictures creating ........................................................ 40 setting preferences ....................................... 45

plug-in components, iFIX .................................. 3 pop-up window ................................................ 26 preferences animation error............................................. 46 charts............................................................ 45 configuring run-time .................................... 46 drawing options ........................................... 45 pictures......................................................... 45 saving backup files ...................................... 45 setting in WorkSpace ................................... 45 shapes........................................................... 45 start-up environment .................................... 46 primary blocks ................................................. 10 printing electronic books ........................................... 82 online Help................................................... 89 process data flow ............................................. 10 process database............................................... 10 processing centralized.................................................... 15 distributed .................................................... 13 exception-based ........................................... 12 one-shot ....................................................... 13 time-based.................................................... 12 Proficy Batch Execution specifying a project...................................... 76 working with iFIX ......................................... 3 Proficy Historian disabling errors ............................................ 39 working with iFIX ......................................... 3 Proficy iFIX WorkSpace ................................... 2 Proficy Machine Edition.................................... 3 Proficy Plant Applications ................................. 3 Proficy Real-Time Information Portal ............... 3 R redundancy....................................................... 15 remote node ....................................................... 7

112

Index

removing toolbar buttons................................. 42 renaming document in the system tree ........................ 40 toolbar categories......................................... 43 reporting .......................................................... 22 restoring files ................................................... 51 run mode, Sample System ............................... 96 run-time environment configuring preferences ............................... 46 described...................................................... 38 run-time node..................................................... 7 S SAC ................................................................. 11 Sample System accessing other desktop applications ........... 94 exploring alarms and alarm counters ......... 105 exploring ToolTips ...................................... 99 exploring trending...................................... 104 exploring VisiconX.................................... 100 features demonstrated .................................. 91 main menu ................................................... 93 overview ...................................................... 91 requirements ................................................ 92 restrictions ................................................... 92 starting ......................................................... 93 user account requirement............................. 92 using configure and run modes.................... 96 using Help.................................................... 95 using with a Terminal Server....................... 92 Sample System demos navigating .................................................... 96 understanding the alarm summary, Trending chart and reporting screens....... 95 working with................................................ 95 Sample System Help displaying ToolTips..................................... 95 getting Help for an object or picture............ 95

saving backup files.................................................. 45 document ..................................................... 40 SCADA server functions ................................. 20 Scan, Alarm, and Control program .................. 11 Scheduler ......................................................... 13 schedules, creating........................................... 40 scripting ............................................................. 5 SCU configuring your local computer.................. 47 path definitions for system tree.................... 35 starting ......................................................... 47 Search tab, electronic books ............................ 79 searching electronic books ........................................... 79 online Help................................................... 85 secondary blocks.............................................. 10 secure containment ............................................ 5 security areas ............................................................. 18 configuration................................................ 19 login ............................................................. 19 sessions ............................................................ 13 setting preferences, WorkSpace....................... 45 shapes, setting preferences............................... 45 sharing files among nodes................................ 48 specifying network path as iFIX path .............. 48 SQL.................................................................... 9 stand alone node ................................................ 7 starting and stopping the mixer signing in the Pharmaceutical demo .......... 103 starting sample system ..................................... 93 start-up, changing the environment.................. 46 Structured Query Language ............................... 9 supervisory control .......................................... 21 switching between WorkSpace environments................................................ 38

113

Understanding iFIX

system applications.......................................... 24 system messages .............................................. 16 system tree described...................................................... 30 displaying the path....................................... 35 dragging and dragging files ......................... 37 hierarchy ...................................................... 33 item description ........................................... 33 navigating .................................................... 35 paths............................................................. 35 resizing ........................................................ 35 right-clicking ............................................... 37 showing and hiding...................................... 35 starting an application.................................. 38 T tag groups, Water & Wastewater demo ........... 97 Task Wizard..................................................... 44 Terminal Server, Sample System .................... 92 time-based processing...................................... 12 toolbar categories adding .......................................................... 43 adding buttons.............................................. 43 copying ........................................................ 44 defined ......................................................... 42 deleting ........................................................ 43 renaming ...................................................... 43 toolbars adding buttons.............................................. 42 adding categories ......................................... 43 application ................................................... 40 arranging buttons ......................................... 42 configuring buttons...................................... 43 copying categories ....................................... 44 creating ........................................................ 43 creating buttons............................................ 43 customizing.................................................. 42 deleting ........................................................ 43

toolbars (cont.) deleting buttons from a category.................. 43 deleting categories ....................................... 43 importing ..................................................... 44 modifying a button's properties.................... 43 modifying properties.................................... 43 owners.......................................................... 42 removing buttons ......................................... 42 renaming categories ..................................... 43 resetting ....................................................... 42 sharing ......................................................... 44 showing and hiding...................................... 42 utilities ......................................................... 40 WorkSpace................................................... 40 ToolTips, Chemical demo................................ 99 touch-screen environment................................ 31 trending, Sample System ............................... 104 U Universal Data Access ....................................... 8 user applications .............................................. 24 user configuration applications........................ 24 using configure and run modes in sample system .......................................................... 96 using Help in Sample System .......................... 95 using iFIX documentation ............................... 76 utilities toolbar................................................. 40 V VBA using the Visual Basic Editor....................... 25 using with iFIX .............................................. 5 writing scripts .............................................. 46 VBE ................................................................... 5 virtual keyboard ............................................... 31 VisiconX, Chemical demo............................. 100 Visual Basic Editor described ...................................................... 25 displaying..................................................... 46

114

Index

Visual Basic Editor (VBE) ................................ 5 Visual Basic for Applications (VBA)................ 5 W Water & Wastewater demo exploring picture layers ............................... 99 exploring pop-up pictures ............................ 97 exploring tag groups .................................... 97 overview ...................................................... 97 What's This? Help............................................ 84 work area ......................................................... 30 WorkSpace configuring run-time preferences................. 46 copying objects ............................................ 37 customizing toolbars.................................... 42 described...................................................... 25 displaying full screen................................... 38

WorkSpace (cont.) enabling environment protection ................. 39 iFIX................................................................ 2 moving objects............................................. 37 saving backup files ...................................... 45 setting animation error preferences.............. 46 setting user preferences................................ 45 specifying an iBatch project ........................ 76 starting ......................................................... 25 starting an application.................................. 38 start-up options ............................................ 46 system tree ................................................... 30 toolbar.......................................................... 40 working with documents.............................. 40 WorkSpace command line parameters............. 26

115

Understanding iFIX

116