Understanding iFIX
Understanding iFIX
UNDERSTANDING iFIX
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 Intelligent Platforms, Inc.
Disclaimer of Warranties and Liability The information contained in this manual is believed to be accurate and reliable. However, GE Fanuc Intelligent Platforms, Inc. assumes no responsibilities for any errors, omissions or inaccuracies whatsoever. Without limiting the foregoing, GE Fanuc Intelligent Platforms, Inc. 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 Intelligent Platforms, Inc. 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 Intelligent Platforms, Inc. 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 Intelligent Platforms, Inc. standard license agreement, which must be executed by the buyer or user before the use of such information, equipment or software.
Notice 2008 GE Fanuc Intelligent Platforms, Inc. All rights reserved. *Trademark of GE Fanuc Intelligent Platforms, Inc. Microsoft is a registered trademark of Microsoft Corporation, in the United States and/or other countries. All other brands or names are property of their respective holders.
We want to hear from you. If you have comments, questions, or suggestions about our documentation, send them to the following email address: [email protected]
Table of Contents
About this Guide ...............................................................................................................................1 Reference Documents ..............................................................................................................1 Introduction to iFIX ...........................................................................................................................3 iFIX Components ..........................................................................................................................3 Using iFIX with Other Proficy Applications ...............................................................................4 Enabling Technologies .................................................................................................................5 OLE for Process Control (OPC) ...............................................................................................5 Visual Basic for Applications (VBA) ..........................................................................................5 ActiveX ......................................................................................................................................6 System Architecture .........................................................................................................................7 Understanding the iFIX Nodes .....................................................................................................8 Nodes in iFIX ............................................................................................................................9 Universal Data Access ...............................................................................................................10 OLE, OPC, and ActiveX Support ............................................................................................10 Open Database Connectivity (ODBC) Support ......................................................................10 Dynamic Data Exchange (DDE) Support ...............................................................................10 I/O Drivers...............................................................................................................................10 Data Flow................................................................................................................................11 Process Database ..................................................................................................................11 Scan, Alarm, and Control Program.............................................................................................12 Time-Based Processing .........................................................................................................13 Exception-Based Processing..................................................................................................13 One-Shot Processing .............................................................................................................13 Scheduler....................................................................................................................................13 Distributed Networking ...............................................................................................................14 Distributed Processing ............................................................................................................14 On Demand Data Transfer .....................................................................................................15 Centralized Processing ...........................................................................................................15 Alarming......................................................................................................................................16 Types of Alarms and Messages .............................................................................................17 Alarm Routing .........................................................................................................................17 Operator and Application Message Routing ...........................................................................18 Security .......................................................................................................................................18 Security Areas ........................................................................................................................18
iii
Security Application ................................................................................................................19 System Functions ...........................................................................................................................21 Basic Functions ..........................................................................................................................21 HMI and SCADA Functions ........................................................................................................22 Monitoring ...............................................................................................................................22 Supervisory Control ................................................................................................................22 Alarming..................................................................................................................................22 Control ....................................................................................................................................23 Reporting Functions....................................................................................................................23 Data Archiving ........................................................................................................................23 Reports ...................................................................................................................................24 Open Architecture Functions ......................................................................................................24 Application Functions .................................................................................................................25 User Configuration Applications .............................................................................................25 System Applications ...............................................................................................................26 User Applications ....................................................................................................................26 Using the Proficy iFIX WorkSpace .................................................................................................27 Understanding the Proficy iFIX WorkSpace ...............................................................................27 Starting the Proficy iFIX WorkSpace ......................................................................................27 Command Line Parameters for Starting the iFIX WorkSpace ................................................28 Shut Down the iFIX WorkSpace with a VBA Script ................................................................31 Understanding the System Tree .............................................................................................32 Understanding the Work Area ................................................................................................33 Using the Virtual Keyboard .....................................................................................................33 Locating Classic View Menu Commands in Ribbon View ......................................................35 Using the System Tree ...............................................................................................................44 Understanding System Tree Paths.........................................................................................46 Showing and Hiding the System Tree ....................................................................................46 Navigating the System Tree ...................................................................................................47 Opening and Closing Folders .................................................................................................48 Right-Clicking the System Tree ..............................................................................................49 Dragging and Dropping Files ..................................................................................................49 Starting Applications from the System Tree ...........................................................................49 Understanding WorkSpace Environments .................................................................................50 Displaying the WorkSpace Full-Screen ..................................................................................50 Enabling Environment Protection ...........................................................................................50 Disabling Error Dialog Boxes..................................................................................................50
iv
Disabling Proficy Historian Errors in the WorkSpace .............................................................51 Working with Documents ............................................................................................................52 Opening Documents ...............................................................................................................52 Deleting and Renaming Documents .......................................................................................52 Using Word and Excel in the WorkSpace ..............................................................................52 Understanding Toolbars .............................................................................................................52 Showing and Hiding Toolbars.................................................................................................54 Understanding Toolbar Owners..............................................................................................54 Customizing Toolbars .............................................................................................................54 Creating Toolbars ...................................................................................................................55 Creating Buttons .....................................................................................................................56 Sharing Toolbars and Toolbar Buttons ...................................................................................56 Using Experts and the Task Wizard .......................................................................................57 Locating Toolbar Functions in Ribbon View ...........................................................................57 Understanding the Ribbon ..........................................................................................................72 Understanding the Quick Access Toolbar ..............................................................................74 Understanding the WorkSpace Button ...................................................................................74 Understanding KeyTips ..........................................................................................................74 Setting User Preferences ...........................................................................................................75 Understanding Picture, Shape, Drawing, and Chart Preferences ..........................................75 Saving Back-up Files ..............................................................................................................75 Configuring Run-time Preferences .........................................................................................76 Changing the Start-up Environment .......................................................................................76 Animation Error Preferences ..................................................................................................76 Choosing the User Interface ...................................................................................................76 Customizing the Ribbon User Interface ......................................................................................76 Displaying the Visual Basic Editor ..............................................................................................77 Multiple Monitors and iFIX ..........................................................................................................77 Valid Monitor Settings Example..............................................................................................77 Invalid Monitor Settings Example ...........................................................................................78 Configuration in iFIX ...............................................................................................................78 WorkSpace Dialog Boxes ...........................................................................................................78 Add Server Dialog Box ...........................................................................................................79 Button Properties Dialog Box .................................................................................................79 Configure the Proficy Historian Server(s) Dialog Box ............................................................80 Customize Toolbars Dialog Box .............................................................................................81 Data Server Installer Dialog Box ............................................................................................83
Expression Builder Dialog Box ...............................................................................................83 Find and Replace Dialog Box .................................................................................................93 Get Project Dialog Box ...........................................................................................................95 Import Toolbars Dialog Box ....................................................................................................96 Modify Server Dialog Box .......................................................................................................97 Multiple Command Script Wizard Dialog Box .........................................................................97 Proficy iFIX Project Backup Dialog Box..................................................................................98 Proficy iFIX Project Backup Wizard ........................................................................................98 Proficy iFIX Restore Wizard .................................................................................................100 Task Wizard Dialog Box .......................................................................................................102 Toolbars Dialog Box .............................................................................................................102 User Preferences Dialog Box ...............................................................................................102 How Do I... ................................................................................................................................124 Using the System Tree .........................................................................................................124 Working with Files.................................................................................................................125 Starting Applications and Experts.........................................................................................128 Working with the WorkSpace Environments ........................................................................130 Customizing the Ribbon User Interface ................................................................................132 Setting Preferences ..............................................................................................................136 Selecting Data Sources and Building Expressions ..............................................................142 Managing Files and Nodes ...................................................................................................145 Installing the Proficy Historian Server...................................................................................150 Working with Toolbars ..........................................................................................................158 Installing a Third-Party OPC Server .....................................................................................164 Managing iFIX Nodes ...................................................................................................................167 Configuring the Local Computer ...............................................................................................167 Sharing Files .............................................................................................................................167 Configuring the Picture Path.................................................................................................168 Finding and Replacing Data .....................................................................................................168 Using Wildcards ....................................................................................................................169 Finding and Replacing Data in Scripts .................................................................................170 Using Find and Replace with User Globals ..........................................................................171 Backing up and Restoring Files ................................................................................................171 Overview of the Backup Process..........................................................................................173 Overview of the Restore Process .........................................................................................177 Using the Command Line Options........................................................................................181 Using and Creating Factory Default Files .............................................................................184
vi
Sample BackupRestore.ini ...................................................................................................197 Specifying a Proficy Batch Execution Project...........................................................................201 Using the Electronic Books...........................................................................................................203 Accessing Information in Electronic Books ..............................................................................203 Electronic Book Buttons ...........................................................................................................203 Using the Table of Contents .....................................................................................................204 Searching Electronic Books......................................................................................................205 Refining Your Search ...............................................................................................................206 Using Quotes to Define a Phrase .........................................................................................206 Searching with Wildcard Expressions ..................................................................................206 Defining Search Terms .........................................................................................................206 Using Nested Expressions ...................................................................................................207 Using Other Searching Methods ..........................................................................................207 Determining Your Location within the Electronic Books ...........................................................207 Printing Electronic Books ..........................................................................................................207 Displaying or Hiding the Left Frame .........................................................................................208 Copying and Pasting Text from an Electronic Book to Another Application ............................208 Using the Favorites Tab ...........................................................................................................209 Using the iFIX Sample System .....................................................................................................209 Before You Begin......................................................................................................................210 User Accounts that Start the Sample System ......................................................................210 Running the Sample System with iFIX .................................................................................210 Using the Sample System with a Terminal Server ...............................................................210 Using the Sample System with Picture Caching ..................................................................211 Starting the Sample System .....................................................................................................211 Accessing Other Desktop Applications ................................................................................212 Using the Sample System Help ................................................................................................212 Getting Help for an Object or Picture....................................................................................212 Displaying ToolTips ..............................................................................................................213 Clicking the Help File Button from a Picture .........................................................................213 Working with the Sample System Demos ................................................................................213 Understanding the Alarm Summary, Trending Chart, and Reporting Screens ....................213 Using Configure and Run Modes .........................................................................................213 Navigating through the Demos .............................................................................................214 Parts of the Demos ...................................................................................................................214 Parts of the Water & Wastewater Demo ..............................................................................214 Parts of the Discrete Manufacturing Demo ..........................................................................215
vii
Parts of the Specialty Chemical Demo .................................................................................217 Parts of the Pharmaceutical Manufacturing Demo ...............................................................218 Quick Tour of the Discrete Manufacturing Demo .....................................................................221 The Annealing Process ........................................................................................................221 Manufacturing Step Indicator................................................................................................221 Alarm Summary Object ........................................................................................................221 Quick Tour of the Water & Wastewater Demo .........................................................................221 Exploring Tag Groups and Pop-up Pictures .........................................................................222 Quick Tour of the Chemical Demo ...........................................................................................223 Exploring Picture Layers .......................................................................................................223 Exploring ToolTips ................................................................................................................223 Exploring VisiconX ................................................................................................................224 Quick Tour of the Pharmaceutical Demo .................................................................................225 Signing When Starting and Stopping the Mixer....................................................................226 Signing When Using an Expert.............................................................................................227 Signing When Acknowledging Alarms ..................................................................................227 Viewing the Audit Trail from a Relational Database .............................................................227 Exploring Trending....................................................................................................................228 Exploring Alarms and Alarm Counters .....................................................................................229
viii
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. 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, refer to the Using the Electronic Books 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. The iFIX platform hosts a number of GE Fanuc and third-party application components, some of which are illustrated in the following figure.
Understanding iFix
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. 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.
Understanding iFix
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
Understanding iFix
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. 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 Alarming Security
Understanding iFix
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.
Understanding iFix
Nodes in iFIX
There are several types of nodes available using 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
Run-time
iClient
Understanding iFix
It is this ability to access data universally that gives iFIX its remarkable power and versatility.
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
10
Understanding iFix
I/O driver.
Data Flow
The flow of process data is summarized as follows: iFIX reads data from various data sources. 2. 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.
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. A chain is a series of connected blocks that create a control or monitoring loop. For example, in a
11
Understanding iFix
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.
12
Understanding iFix
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.
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
13
Understanding iFix
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. 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.
14
Understanding iFix
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.
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
15
Understanding iFix
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).
16
Understanding iFix
Delaying alarms. Triggering scripts based on alarms. Filtering alarms based on type, priority, sender, etc.
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
17
Understanding iFix
For detailed information about alarm routing refer to the Implementing Alarms and Messages manual.
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.
18
Understanding iFix
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.
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.
19
Understanding iFix
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.
20
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
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
21
Understanding iFix
processing. Once data is acquired, it is manipulated and channeled according to requests from your application software. This process is known as data management.
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
22
Understanding iFix
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.
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 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.
23
Understanding iFix
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. 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.
24
Understanding iFix
open architecture functions. Open Architecture Functions 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
25
Understanding iFix
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.
26
27
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) (Classic view) or on the Home tab, in the WorkSpace group, click Switch to Run (or Switch to Configure) (Ribbon view).
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"
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
28
Understanding iFix
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
29
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 right-side 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.
30
Understanding iFix
Dim Msg, Style, Title, Response Msg = "Are you SURE you want to exit the workspace?" 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.
32
Understanding iFix
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.
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.
33
Understanding iFix
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.
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 you activate the virtual keyboard by adding it to your Windows Startup folder. To activate the virtual keyboard from the Windows Startup folder: 1. 2. 3. In your Proficy iFIX directory, right-click on the MYTSOFT.EXE file and select Copy. In Explorer, navigate to the C:\Documents and Settings folder. If you are not using Windows Vista, drill down to the following folder:
C:\Documents and Settings\All Users\Start Menu\Programs\Startup
If you are using Windows Vista, drill down to this folder instead:
34
Understanding iFix
C:\Users\Administrator\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup
4. 5.
Right-click the white space area of the Startup folder, and select Paste Shortcut. If you want, rename the shortcut. The next time you start your computer, the keyboard will activate automatically.
NOTES: If you want to start the virtual keyboard when you start iFIX on Windows XP machines, in the SCU in the Task Configuration dialog box, add the Mytsoft2.exe application (startup mode Normal). The next time you start iFIX, the My-T-Soft virtual keyboard appears. If you want to display the My-T-Soft startup screen when you start iFIX, in the SCU in the Task Configuration dialog box, add the MTSOPEN.EXE application (startup mode Normal). The next time you start iFIX, the My-T-Soft screen appears and you can click Run My-T-Soft to launch the virtual keyboard. Do not add MYTSOFT.EXE to the startup task list in the SCU. If you do so, errors display when you start iFIX. For Windows XP, you can also use Mytsoft2.exe. While running on Windows Vista as a Power User, the MYTSOFT.EXE keyboard will prompt for elevation. Confirm the elevation to run the application. The MTSTUTOR program can only be run as an Administrator. When logged on as another user, including an Administrator with a different user name, you must right-click the shortcut and choose "Run as Administrator." Be aware that if you try to run DVTKINST.EXE more than once a unzipping error message will appear.
Schedule
Dynamo Set
35
Understanding iFix
Ribbon View Location WorkSpace button, select New, or Home tab, New group WorkSpace button WorkSpace button WorkSpace button WorkSpace button WorkSpace button WorkSpace button, Recent Documents list WorkSpace button Home tab, Editing group Home tab, Clipboard group Home tab, Clipboard group Home tab, Clipboard group Home tab, Clipboard group, Paste list Home tab, Clipboard group, Paste list Home tab, Editing group Home tab, Editing group Home tab, Editing group
Paste Special
36
Understanding iFix
Ribbon View Location Home tab, Editing group Tools tab Home tab, Editing group, Properties list, or Format tab, Picture group, Edit Picture Home tab, WorkSpace group Home tab, WorkSpace group, Show/Hide list, or View tab, Show/Hide group Home tab, WorkSpace group, Show/Hide list, or View tab, Show/Hide group Home tab, WorkSpace group, Show/Hide list Home tab, WorkSpace group, or Tools tab Home tab, WorkSpace group, Settings list Home tab, WorkSpace group, Settings list Home tab, WorkSpace group Right-click object Right-click object Solid Format tab, Styles group, Fill Style gallery
WorkSpace
Status Bar
Toolbox
User Preferences
Toolbars
37
Understanding iFix
Ribbon View Location Format tab, Styles group, Fill Style gallery Format tab, Styles group, Fill Style gallery Format tab, Styles group, Fill Style gallery Format tab, Styles group, Fill Style gallery Format tab, Styles group, Fill Style gallery Format tab, Styles group, Fill Style gallery Format tab, Styles group, Fill Style gallery
Horizontal
Vertical
Downward Diagonal Upward Diagonal Cross Hatch Diagonal Cross Hatch Gradient
Format tab, Styles group, Fill Style gallery Format tab, Styles group, Edge Style gallery Format tab, Styles group, Edge Style gallery Format tab, Styles group, Edge Style gallery Format tab, Styles group, Edge Style gallery Format tab, Styles group, Edge Style gallery Format tab, Styles group, Edge
Edge Style
Solid
Dash
Dot
Dash Dot
38
Understanding iFix
Ribbon View Location Style gallery Inside Frame Format tab, Styles group, Edge Style gallery Format tab, Styles group, Background Style gallery Format tab, Styles group, Background Style gallery Format tab, Styles group, Fade Type gallery Format tab, Styles group, Fade Type gallery Format tab, Styles group, Fade Type gallery Format tab, Styles group, Fade Type gallery Format tab, Picture group, or View tab, Zoom group Format tab, Picture group, or View tab, Zoom group Format tab, Picture group, or View tab, Zoom group Format tab, Picture group, or View tab, Zoom group View tab, Picture group, View list View tab, Picture group, View list
Background Style
Opaque
Transparent
Fade Type
Linear
Reflected
Radial
Concentric
View
Zoom
50%
100%
150%
200%
Default View
Full View
39
Understanding iFix
Ribbon View Location View tab, Picture group, Window list View tab, Picture group, Window list View tab, Picture group, Window list View tab, Picture group, View list Format tab, Styles group View tab, Window group View tab, Picture group Insert tab, Objects/Links group, Object/Links list Insert tab, Shapes group, Shapes list Insert tab, Shapes group, Shapes list Insert tab, Shapes group, Shapes list Insert tab, Shapes group, Shapes list Insert tab, Shapes group, Shapes list Insert tab, Shapes group, Shapes list Insert tab, Shapes group, Shapes
Refresh
Rectangle
Rounded Rectangle
Oval
Line
Polyline
Polygon
Arc
40
Understanding iFix
Chord
Insert tab, Shapes group, Shapes list Insert tab, Shapes group, Shapes list Insert tab, Shapes group, Shapes list Standard Chart Line Multiline Chart SPC - XBar Chart SPC - RBarChart SPC - SBar Chart Histogram Chart Insert tab, Charts group
Pie
Text
Chart
Bitmap
Insert tab, Objects/Links group, Object/Links list Insert tab, Objects/Links group, Object/Links list Insert tab, Objects/Links group, Object/Links list Insert tab, Objects/Links group, Object/Links list
Datalink
Pipe
Current Time
41
Understanding iFix
Ribbon View Location Insert tab, Objects/Links group, Object/Links list Insert tab, Objects/Links group, Object/Links list Insert tab, Objects/Links group, Object/Links list Insert tab, Objects/Links group, Object/Links list Format tab, Arrange group Format tab, Arrange group Format tab, Arrange group Top Format tab, Arrange group, Arrange list Format tab, Arrange group, Arrange list Format tab, Arrange group, Arrange list Format tab, Arrange group, Arrange list Format tab, Arrange group, Arrange list Format tab, Arrange group, Arrange list Format tab, Arrange group, Flip list Format tab, Arrange group, Flip
Alarm Summary
Push Button
Format
Bottom
Right
Vertical
42
Understanding iFix
Space Evenly
Horizontal
Format tab, Arrange group, Space Evenly list Format tab, Arrange group, Space Evenly list Format tab, Arrange group, Make Space Even list Format tab, Arrange group, Make Space Even list Format tab, Arrange group, Make Space Even list Format tab, Arrange group, Grid list Format tab, Arrange group, Grid list Format tab, Arrange group, Grid list View tab, Window group View tab, Window group View tab, Window group View tab, Window group View tab, Window group
Vertical
Height
Width
Both
Snap to Grid
Grid Settings
Window
Help
Help button
Help button
43
Understanding iFix
Ribbon View Location WorkSpace button, Options, Resources page WorkSpace button, Options, Resources page WorkSpace button, Options, Resources page Help button
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.
44
Understanding iFix
Contains global variables, user-defined variables, and threshold tables. Contains iFIX Help and electronic books.
Help & Information folder Historical Assignment I/O Drivers folder Mission Control
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.
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 Description Opens the Batch Execution electronic books.
45
Understanding iFix
System Tree Item Batch Execution Configuration Batch Execution Equipment Batch Execution Recipes
46
Understanding iFix
Resizing the System Tree If resizing the system tree does not give you the space you need, you can hide the tree completely.
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.
47
Understanding iFix
To... 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.
Left arrow key Right arrow key Home key End key
Open a folder.
Move to the top of the tree. Move to the bottom of the tree.
48
Understanding iFix
For more information on Dynamo objects, refer to the Creating Pictures manual. For information on user-defined variables and the global page, refer to the Writing Scripts manual.
49
Understanding iFix
50
Understanding iFix
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.
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
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:
51
Understanding iFix
[Historian] TimeoutSecs=10
Here, the time-out is set to 10 seconds. The valid range is 5 to 300 seconds, though not enforced.
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. NOTES: Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars.
52
Understanding iFix
In Ribbon view, toolbars cannot be docked. In Ribbon view, if you open a MS Word or Excel document in the WorkSpace, some of the menu items associated with those documents will not appear in the WorkSpace. If you need to edit an MS Word or Excel document, we recommend that you do in so in Classic view.
Toolbars provides buttons for common operations. For example, the Standard toolbar, shown in the following figure, lets you create, open, and print documents.
Proficy iFIX WorkSace 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.
53
Understanding iFix
Utilities Toolbar
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 Dynamo objects, 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
54
Understanding iFix
the option. NOTE: In Ribbon view, toolbars cannot be docked. 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. 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
55
Understanding iFix
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. 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.
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.
56
Understanding iFix
Locating Application Toolbar Functions in Ribbon View The following table details the location of the various Application functions in Ribbon view. NOTES: The following table includes only the default functions available on the Application toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open.
57
Understanding iFix
Toolbar Application
Function Key Macro Editor Tag Group Editor Database Manager Historical Trend Assign System Configuration Utility Security Configuration Utility Security Login
Ribbon View Location Applications tab, Utilities group Applications tab, Utilities group Applications tab, Process Database group
Not available
Applications tab, System & Security group, Security list Applications tab, Utilities group Applications tab, Utilities group Applications tab, Utilities group, Utilities list
Mission Control Alarm History Cross Reference Tool Electronic Books GE Fanuc Home Page Technical Support Silence Alarm Horn Startup Profile Manager
WorkSpace button, Options, Resources page Applications tab, Utilities group, Utilities list
58
Understanding iFix
Locating CAD Toolbar Functions in Ribbon View The following table details the location of the CAD toolbar functions in Ribbon view. NOTES: The following table includes only the default functions available on the CAD toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open. Function Extend Lines Trim Lines Convert Lines to Polyline Make Lines Horizontal Make Lines Vertical Convert Lines and Polylines to Pipe Modify Pipe Add Connection Point Delete Connection Point Line Connector Tool Right Angle Line Connector Tool Ribbon View Location Format tab, Picture group, Drawing Tools list Format tab, Picture group, Drawing Tools list Format tab, Picture group, Drawing Tools list
Toolbar CAD
Format tab, Styles group, Pipe Styles gallery Format tab, Picture group, Drawing Tools list
59
Understanding iFix
Toolbar
Locating Chart Group Toolbar Functions in Ribbon View The following table details the location of the Chart Group toolbar functions in Ribbon view. NOTES: The following table includes only the default functions available on the Chart Group toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open. Function Apply Chart Group Wizard to Chart Apply Chart Group File Configure Chart Group Files Ribbon View Location Tools tab, Charts Group, Chart Groups list
Locating Dynamo Toolbar Functions in Ribbon View The following table details the location of the Dynamo toolbar functions in Ribbon view. NOTES: The following table includes only the default functions available on the Dynamo toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open. Function Build Dynamo Ribbon View Location Tools tab, Dynamos Group, Dynamos list
Toolbar Dynamo
60
Understanding iFix
Toolbar
Function Quick Dynamo Updater Dynamo Updater Wizard Convert Dynamo Sets Quick Dynamo Converter Dynamo Converter Wizard
Locating Edit Toolbar Functions in Ribbon View The following table details the location of the Edit toolbar functions in Ribbon view. NOTES: The following table includes only the default functions available on the Edit toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open. Function Copy Cut Paste Undo Ribbon View Location Home tab, Clipboard group Home tab, Clipboard group Home tab, Clipboard group, Paste list Home tab, Editing group
Toolbar Edit
Locating Expert Toolbar Functions in Ribbon View The following table details the location of the Expert toolbar functions in Ribbon view.
61
Understanding iFix
NOTES: The following table includes only the default functions available on the Expert toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open. Function Fill Rotate Position Scale Visibility Edge Color Foreground Color Background Color Data Entry Expert Create Picture Open Picture Close Picture Replace Picture Open Digital Tag Close Digital Tag Toggle Digital Tag Ribbon View Location Tools tab, Animation group, Animations list Tools tab, Animation group, Animations list Tools tab, Animation group, Animations list Tools tab, Animation group, Animations list Tools tab, Animation group, Animations list Tools tab, Animation group, Animations list Tools tab, Animation group, Animations list Tools tab, Animation group, Animations list Tools tab, Tasks/Experts group Tools tab, Tasks/Experts group, Picture list Tools tab, Tasks/Experts group, Commands list Tools tab, Tasks/Experts group, Commands list Tools tab, Tasks/Experts group, Commands list Tools tab, Tasks/Experts group, Commands list Tools tab, Tasks/Experts group, Commands list Tools tab, Tasks/Experts group, Commands list
Toolbar Expert
62
Understanding iFix
Toolbar
Locating Shapes Toolbar Functions in Ribbon View The following table details the location of the Shapes toolbar functions in Ribbon view. NOTES: The following table includes only the default functions available on the Shapes toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open. Function Object Selection Tool Rectangle Line Oval Arc Rounded Rectangle Polygon Polyline Chord Ribbon View Location N/A
Toolbar Shapes
Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery
Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery
63
Understanding iFix
Toolbar
Function Pie Pipe Text Chart Bitmap Datalink Stamper Alarm Summary Push Button Variable OLE Object Timer Event Time Date
Ribbon View Location Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Objects/Links group, Objects/Links list Insert tab, Charts group Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list
Locating Standard Toolbar Functions in Ribbon View The following table details the location of the Standard toolbar functions in Ribbon view. NOTES: The following table includes only the default functions available on the Standard toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open.
64
Understanding iFix
Toolbar Standard
Function Open Close Save Print Open Picture Folder New Picture New Schedule New Dynamo Set Full Screen Switch to Run Visual Basic Editor Task Wizard
Ribbon View Location WorkSpace button WorkSpace button WorkSpace button WorkSpace button Home tab, WorkSpace group
Home tab, New group Home tab, New group Home tab, New group
Home tab, WorkSpace group Home tab, WorkSpace group Home tab, WorkSpace group
Locating Toolbox Toolbar Functions in Ribbon View The following table details the location of the Toolbox toolbar functions in Ribbon view. NOTES: The following table includes only the default functions available on the Toolbox toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open.
65
Understanding iFix
Toolbar Toolbox
Function Object Selection Tool Cut Copy Paste Time Date Rectangle Rounded Rectangle Oval Chord Polygon Pie Pipe Arc Line Polyline Text Push Button
Home tab, Clipboard group Home tab, Clipboard group Home tab, Clipboard group, Paste list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery
Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Shapes group, Shapes gallery Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list
66
Understanding iFix
Toolbar
Function OLE Object Datalink Stamper Alarm Summary Variable Timer Event Chart Bitmap Color Font Toggle Grid Space Evenly Vertical Space Evenly Horizontal Align Top Align Left Align Bottom Align Right Align Horizontal Center
Ribbon View Location Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Objects/Links group, Objects/Links list Insert tab, Charts group Insert tab, Objects/Links group, Objects/Links list Format tab, Styles group Format tab, Font group Format tab, Arrange group, Grid list Format tab, Arrange group, Space Evenly list
Format tab, Arrange group, Align list Format tab, Arrange group, Align list Format tab, Arrange group, Align list Format tab, Arrange group, Align list Format tab, Arrange group, Align list
67
Understanding iFix
Toolbar
Function Align Vertical Center Group Ungroup Bring to Front Send to Back Set Layer Display Layer Foreground Color Expert Fill Expert Rotate Expert Position Expert Scale Expert Visibility Expert Create Picture Expert Open Picture Expert Close Picture Expert Replace Picture Expert
Format tab, Arrange group Format tab, Arrange group Format tab, Arrange group Format tab, Arrange group Format tab, Picture group, Layers list Format tab, Picture group, Layers list Tools tab, Animation group, Animations list
Tools tab, Animation group, Animations list Tools tab, Animation group, Animations list Tools tab, Animation group, Animations list Tools tab, Animation group, Animations list Tools tab, Animation group, Animations list Tools tab, Tasks/Experts group, Picture list
68
Understanding iFix
Toolbar
Function Refresh Rate Expert Data Entry Expert VisiconX Data Control VisiconX Grid Control VisiconX List Box Control VisiconX Combo Box Control Undo Historical Data Link
Home tab, Editing group Insert tab, Objects/Links group, Objects/Links list
Locating Tools Toolbar Functions in Ribbon View The following table details the location of the Tools toolbar functions in Ribbon view. NOTES: The following table includes only the default functions available on the Tools toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open. Function Align Top Align Left Ribbon View Location Format tab, Arrange group, Align list Format tab, Arrange group, Align list
Toolbar Tools
69
Understanding iFix
Toolbar
Function Align Bottom Align Right Align Horizontal Center Align Vertical Center Group Ungroup Bring to Front Send to Back Space Evenly Vertical Space Evenly Horizontal Color Font Toggle Grid Set Layer Display Layer Refresh Rate Expert
Ribbon View Location Format tab, Arrange group, Align list Format tab, Arrange group, Align list Format tab, Arrange group, Align list
Format tab, Arrange group Format tab, Arrange group Format tab, Arrange group Format tab, Arrange group Format tab, Arrange group, Space Evenly list
Format tab, Styles group Format tab, Font group Format tab, Arrange group, Grid list Format tab, Picture group, Layers list Format tab, Picture group, Layers list Tools tab, Tasks/Experts group, Picture list
70
Understanding iFix
Locating Utilities Toolbar Functions in Ribbon View The following table details the location of the Utilities toolbar functions in Ribbon view. NOTES: The following table includes only the default functions available on the Utilities toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open. Function Add Database Block Modify Database Block Database Save Database Reload Resolve Files Export Picture Find Mouse Coordinates Save Files with Thumbnail Preferences Ribbon View Location Applications tab, Process Database group, Blocks list Applications tab, Process Database group, Blocks list Applications tab, Process Database group Applications tab, Process Database group Application tab, Utilities group, Utilities list Application tab, Utilities group, Utilities list Application tab, Utilities group, Utilities list
Toolbar Utilities
Locating VisiconX Toolbar Functions in Ribbon View The following table details the location of the VisiconX toolbar functions in Ribbon view. NOTES: The following table includes only the default functions available on the VisiconX toolbar. Although hidden by default, you can access and use toolbars in Ribbon view. To access a toolbar in Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. You can also open a toolbar from the WorkSpace tree, by opening the Project Toolbar Files folder and double-clicking the toolbar you want to open.
71
Understanding iFix
Toolbar VisiconX
Function VisiconX Data Control VisiconX Grid Control VisiconX List Box Control VisiconX Combo Box Control
72
Understanding iFix
Tabs includes the following: Home Insert Tools Format View Applications Administration
Groups for the illustrated tab, includes the following: Clipboard WorkSpace New Editing
Quick Access Toolbar and WorkSpace Button The Ribbon has a customizable Quick Access toolbar, which allows you to easily access the commands you use most often with just the click of the mouse. The Quick Access toolbar is located in the upper left corner of the toolbar, as seen in the following figure.
iFIX Ribbon - WorkSpace Button and Quick Access Toolbar WorkSpace button Quick Access Toolbar default commands include the following: Switch modes Save Activate Visual Basic Editor Full Screen Create a new picture
The WorkSpace button, illustrated in the preceding figure, provides access to commands as well as options for customizing the user interface.
73
Understanding iFix
iFIX Ribbon - Quick Access Toolbar Commands added to the Quick Access Toolbar Customize Quick Access Toolbar list. Commands that appear on the Quick Access Toolbar by default are listed above the command separator.
To use the commands on the Quick Access toolbar, click the desired command on the toolbar or click the Customize Quick Access Toolbar list and click one of the default commands listed there.
Understanding KeyTips
In Ribbon view, KeyTips replace underlined menu letters as indicators of keys to press to invoke a command. They appear when you press the ALT or F10 key. In the following figure, the KeyTips are circled in red. Each KeyTip corresponds to the command, tab or button to which it is closest. Notice that in the Quick Access toolbar that numbers 3, 5, and 6 are unavailable, indicating those commands cannot be accessed at the time. To access a command, tab or button, press <ALT>+<KeyTip>. For example, to access the Administration tab using the KeyTips illustrated in the following figure, you would press <ALT>+<D>.
74
Understanding iFix
75
Understanding iFix
76
Understanding iFix
Changing the color scheme of the WorkSpace. Determining how ScreenTips are displayed. Customizing the Quick Access toolbar. Creating and customizing keyboard shortcuts. Deciding whether or not to show KeyTips.
77
Understanding iFix
Configuration in iFIX
After you configure the overall monitor settings for your computer, you can configure iFIX to display multiple monitors. To configure multiple monitors in iFIX, in the User Preferences dialog box, on the General tab, select the Extend WorkSpace to support multiple monitors check box and click OK. Be aware that if you later disable this user preference, the WorkSpace shrinks to one monitor (Monitor 1), but it does not move any child windows back into the single monitor view. The child windows remain in the same location; you need to scroll and drag them back into the Monitor 1 area to view them again. For help with opening pictures across multiple monitors, you can use the Track Mouse Coordinates Tool in the iFIX WorkSpace. For more information, refer to the Using the Find Mouse Coordinates Tool section in the Creating Pictures e-book. This tool will help you quickly locate the coordinates of the upper left corner where you want a picture to open.
78
Understanding iFix
79
Understanding iFix
tab when you select the button. Screentip Lets you enter a text description of up to 128 characters for the button you are configuring. This text pops up when you place the cursor over the button. Edit Script Lets you open the Visual Basic Editor, and enter or edit the current buttons script.
80
Understanding iFix
Password Enter the password for the Historian server. Close Use this button to close the Configure the Proficy Historian Server(s) dialog box. Get Collectors Use this button to populate the Collector Name list. Collector Name List Lists only the collectors that use iFIX EDA, which includes the following : iFIX Native Collector OPC EDA Collector iFIX OPC Collector
NOTE: The Collector Name List only displays local collectors, even if you set a remote server as the default server. Set Default Use this button to set the collector in the Collector Name list as the default.
Lets you enable or disable text descriptions for every button on every toolbar. When enabled, you can display a description by placing the cursor over a button.
81
Understanding iFix
Description Lets you create a toolbar. Lets you modify the properties of the selected toolbar. Toolbars supplied with iFIX cannot be modified. Lets you delete the selected toolbar. Toolbars supplied with iFIX cannot be deleted. Lets you reset the selected toolbar to its default state. Any buttons removed from the toolbar and supplied by default are added back. All buttons not supplied with the toolbar are removed. Resetting a toolbar affects toolbars supplied with iFIX; toolbars you create are not affected.
Import
Lets you import custom toolbars shared among your iFIX nodes or created by a toolbar developer.
Buttons Tab Item Categories Add Category Rename Category Delete Category Buttons Area Description Lets you select a toolbar category. Lets you add a toolbar category.
Lets you rename the selected toolbar category. Categories supplied with iFIX cannot be renamed. Lets you delete the selected toolbar category. Categories supplied with iFIX cannot be deleted. Drag and drop a button from this group box onto a toolbar, or doubleclick a button in the toolbar to edit the VBA script. Displays a description of the selected button. Lets you add a button to the selected category.
82
Understanding iFix
Description Lets you modify the selected buttons properties. You cannot modify a button supplied with iFIX. Lets you delete the selected toolbar button. Buttons supplied with iFIX cannot be deleted.
83
Understanding iFix
FIX Database Tab Item Node Names List Box Node Names Filter Description Displays a filtered list of SCADA servers that the local node is communicating with. By default, all SCADA servers are displayed. Specifies the current SCADA server filter. You can edit the filter or select one from the list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters). Use this button to update the list of nodes based on the current SCADA server filter. Displays a filtered list of database blocks (tags) on the selected SCADA server. By default, all blocks are displayed. Specifies the current block name filter. You can edit the filter or select one from the list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters).
Node Names Filter Button Tag Names List Box Tag Names Filter
Use this button to update the list of blocks based on the current block filter. Displays a filtered list of fields available from the selected block. By default, all blocks are displayed. You can receive help on any field displayed in this list box by using the Block Field Reference and selecting the fields block from the list that appears.
A_* Button
Use this button to change the block field filter to display all A_ fields and selects the A_CV field, if available. Use this button to change the block field filter to display all F_ fields and selects the F_CV field, if available. Use this button to change the block field filter to display all E_ fields and selects the E_CV field, if available. Specifies the current block field filter. You can edit the filter or select one from the list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters).
F_* Button
E_* Button
84
Understanding iFix
Description Use this button to update the list of fields based on the current block field filter. Specifies the current expression. You can enter the expression directly or build it by making selections from the other fields and buttons on the tabbed page. Valid Characters: all alphanumeric characters, hyphen (-), underscore (_), exclamation point (!), less than (<), greater than (>), pound (#), percent (%), dollar sign ($), ampersand (&), forward slash (/), backslash (\), pipe (|), opening bracket ([), closing bracket (]), and single quote (). If a single quote () or a backslash (\) is a literal part of the addressing string syntax, it must be preceded by a backslash (\) in order for the character to be passed to the server as part of the address. For example, to enter a tag with the name TEST, you would enter the data source FIX32.THISNODE.\TEST\.F_CV.
Tolerance
Specifies the current connections rounding factor. Typically, iFIX uses this value when comparing a process value to a target value. If the process value is within the specified tolerance, iFIX assumes the two values are equal. For example, if the target value is 1.0, the tolerance is 0.1, and the current value of a data source is 0.8, iFIX does not assume the two values are equal because the data source is not within the specified tolerance. The value must be within the range 0.9 to 1.1 to equal the target value. Seven digits of precision are allowed for accuracy. Specifies the maximum fluctuation you want for the current connection before iFIX updates it. By entering a dead band value, you create a +/dead zone around the connections current value. As long as the value is within this range, iFIX does not update the value. However, once the value exceeds the maximum or minimum dead band, the value is updated. Seven digits of precision are allowed for accuracy. Specifies the rate at which iFIX updates the current connection. iFIX updates the connection no faster than the specified speed. For speeds less than 1 second, iFIX updates no faster than once every 50 milliseconds. For speeds greater than 60 seconds, iFIX updates no faster than once every 60 seconds. Use this button to check the syntax of your expression. A valid expression displays the message "Syntax check successful!" An error message appears if the syntax is invalid. Use this button to show or hide a keypad of numbers, and mathematical
Deadband
Refresh Rate
Mathematical
85
Understanding iFix
Pictures and Globals Tabs Item Objects List Box Description Displays a list of the open pictures (Pictures tab) or the global objects (Globals tab) available on this node. By expanding a picture or the user globals, you can display a filtered list of objects in the pictures or in the User Globals folder. Specifies the current filter for the selected item. You can edit the filter or select one from the filter list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters). Use this button to update the item list based on the current filter.
Object Filter
Specifies the properties for the currently selected picture or object. NOTE: If you have created an object-to-object connection, such as the fill percentage of one tank to another, or created a connection to a data source, the animated properties display in boldface.
Properties Filter
Specifies the current property filter. You can edit the filter or select one from the list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters).
Use this button to update the list of properties based on the current property filter.
86
Understanding iFix
Description Specifies the current expression. You can enter the expression directly or build it by making selections from the other fields and buttons on the tabbed page. Valid Characters: all alphanumeric characters, hyphen (-), underscore (_), exclamation point (!), less than (<), greater than (>), pound (#), percent (%), dollar sign ($), ampersand (&), forward slash (/), backslash (\), pipe (|), opening bracket ([), closing bracket (]), and single quote (). If a single quote () or a backslash (\) is a literal part of the addressing string syntax, it must be preceded by a backslash (\) in order for the character to be passed to the server as part of the address. For example, to enter a tag with the name TEST, you would enter the data source FIX32.THISNODE.\TEST\.F_CV.
Tolerance
Specifies the current connections rounding factor. Typically, iFIX uses this value when comparing a process value to a target value. If the process value is within the specified tolerance, iFIX assumes the two values are equal. For example, if the target value is 1.0, the tolerance is 0.1, and the current value of a data source is 0.8, iFIX does not assume the two values are equal because the data source is not within the specified tolerance. The value must be within the range 0.9 to 1.1 to equal the target value. Specifies the maximum fluctuation you want for the current connection before iFIX updates it. By entering a dead band value, you create a +/dead zone around the connections current value. As long as the value is within this range, iFIX does not update the value. However, once the value exceeds the maximum or minimum dead band, the value is updated. Specifies the rate at which iFIX updates the current connection. iFIX updates the connection no faster than the specified speed. For speeds less than 1 second, iFIX updates no faster than once every 50 milliseconds. For speeds greater than 60 seconds, iFIX updates no faster than once every 60 seconds. Use this button to check the syntax of your expression. A valid expression displays the message "Syntax check successful!" An error message appears if the syntax is invalid. Use this button to show or hide a keypad of numbers, and mathematical and Boolean operators you can use in your expressions.
Deadband
Refresh Rate
87
Understanding iFix
Data Servers Tab Item Data Servers Box Description Displays a list of the SCADA servers collecting historical data for the local node (Historical tab) or the third-party OPC servers that support browsing (Data Servers tab). By expanding a node, you can display a filtered list of the historical values being collected or the I/O points being monitored. Refer to the Entering Data Source Syntax section in the Creating Pictures electronic book for additional information about using third-party OPC servers. Specifies the current filter for the selected item. You can edit the filter or select one from the filter list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters). Use this button to update the item list based on the current filter.
Specifies the current expression. You can enter the expression directly or build it by making selections from the other fields and buttons on the tabbed page. Valid Characters: all alphanumeric characters, hyphen (-), underscore (_), exclamation point (!), less than (<), greater than (>), pound (#), percent (%), dollar sign ($), ampersand (&), forward slash (/), backslash (\), pipe (|), opening bracket ([), closing bracket (]), and single quote (). If a single quote () or a backslash (\) is a literal part of the addressing string syntax, it must be preceded by a backslash (\) in order for the character to be passed to the server as part of the address. For example, to enter a tag with the name TEST, you would enter the data source FIX32.THISNODE.\TEST\.F_CV.
Tolerance
Specifies the current connections rounding factor. Typically, iFIX uses this value when comparing a process value to a target value. If the process value is within the specified tolerance, iFIX assumes the two values are equal. For example, if the target value is 1.0, the tolerance is 0.1, and the current value of a data source is 0.8, iFIX does not assume the two values are equal because the data source is not within the specified tolerance. The value must be within the range 0.9 to 1.1 to equal the target value.
88
Understanding iFix
Item Deadband
Description Specifies the maximum fluctuation you want for the current connection before iFIX updates it. By entering a dead band value, you create a +/dead zone around the connections current value. As long as the value is within this range, iFIX does not update the value. However, once the value exceeds the maximum or minimum dead band, the value is updated. Specifies the rate at which iFIX updates the current connection. iFIX updates the connection no faster than the specified speed. For speeds less than 1 second, iFIX updates no faster than once every 50 milliseconds. For speeds greater than 60 seconds, iFIX updates no faster than once every 60 seconds. Use this button to check the syntax of your expression. A valid expression displays the message "Syntax check successful!" An error message appears if the syntax is invalid. Use this button to show or hide a keypad of numbers, and mathematical and Boolean operators you can use in your expressions.
Refresh Rate
Alarm Counters Tab Item Node Names List Box Node Names Filter Description Displays a filtered list of SCADA servers that the local node is communicating with. By default, all SCADA servers are displayed. Specifies the current SCADA server filter. You can edit the filter or select one from the list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters). Use this button to update the list of nodes based on the current SCADA server filter. Displays a filtered list of alarm areas on the selected SCADA server. Also displays the alarm counter (ALARMCOUNTERS) tag. By default, all areas are displayed. Specifies the current area name filter. You can edit the filter or select one from the list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters).
Node Names Filter Button Alarm Area Tag Names List Box
89
Understanding iFix
Item Alarm Area Tag Names Filter Button Alarm Counter Field Names List Box A_* Button F_* Button Alarm Counter Field Names Filter Alarm Counter Field Names Filter Button Current Expression Box
Description Use this button to update the list of areas based on the current area filter.
Displays a filtered list of fields available from the selected area. By default, all fields are displayed.
Use this button to change the field filter to display all A_ fields. Use this button to change the field filter to display all F_ fields. Specifies the current area field filter. You can edit the filter or select one from the list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters). Use this button to update the list of fields based on the current field filter.
Specifies the current expression. You can enter the expression directly or build it by making selections from the other fields and buttons on the tabbed page. Valid Characters: all alphanumeric characters, hyphen (-), underscore (_), exclamation point (!), less than (<), greater than (>), pound (#), percent (%), dollar sign ($), ampersand (&), forward slash (/), backslash (\), pipe (|), opening bracket ([), closing bracket (]), and single quote (). If a single quote () or a backslash (\) is a literal part of the addressing string syntax, it must be preceded by a backslash (\) in order for the character to be passed to the server as part of the address. For example, to enter a tag with the name TEST, you would enter the data source FIX32.THISNODE.\TEST\.F_CV.
Tolerance
Specifies the current connections rounding factor. Typically, iFIX uses this value when comparing a process value to a target value. If the process value is within the specified tolerance, iFIX assumes the two values are equal. For example, if the target value is 1.0, the tolerance is 0.1, and the current value of a data source is 0.8, iFIX does not assume the two values are equal because the data source is not within the specified tolerance. The value must be within the range 0.9 to 1.1 to equal the target value.
90
Understanding iFix
Item Deadband
Description Specifies the maximum fluctuation you want for the current connection before iFIX updates it. By entering a dead band value, you create a +/dead zone around the connections current value. As long as the value is within this range, iFIX does not update the value. However, once the value exceeds the maximum or minimum dead band, the value is updated. Specifies the rate at which iFIX updates the current connection. iFIX updates the connection no faster than the specified speed. For speeds less than 1 second, iFIX updates no faster than once every 50 milliseconds. For speeds greater than 60 seconds, iFIX updates no faster than once every 60 seconds. Use this button to check the syntax of your expression. A valid expression displays the message "Syntax check successful!" An error message appears if the syntax is invalid. Use this button to show or hide a keypad of numbers, and mathematical and Boolean operators you can use in your expressions.
Refresh Rate
Proficy Historian Tab NOTE: This tab only appears if the data source selected permits historical data. Item Servers Display Collector Name Check Box Node Names List Box Tag Names List Box Description List Box Description Displays a selection list of servers. Allows you to select whether Collector names are displayed.
Displays a filtered list of SCADA servers that the local node is communicating with. By default, all SCADA servers are displayed. Displays a filtered list of database blocks (tags) on the selected SCADA server. By default, all blocks are displayed. Displays a filtered list of descriptors of the selected SCADA server. By default, all descriptions are displayed.
91
Understanding iFix
Description Displays a filtered list of Collector Names for the selected SCADA server. By default, all Collector Names are displayed.
Specifies the current SCADA server filter. You can edit the filter or select one from the list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters). Specifies the tag name filter. You can edit the filter or select one from the list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters). Specifies the description filter. You can edit the filter or select one from the list. You can also include in the filter the wildcards ? (to represent a single character) or * (to represent two or more characters). Specifies the selected Collector type filter.
Description Filter
Collector Type Filter Apply Filter Button Reset Filter Button Filtered Tag Count Current Expression Box
Use this button to apply the selected filter to the item list.
Use this button to reset the item list based on the current filter.
Specifies the current expression. You can enter the expression directly or build it by making selections from the other fields and buttons on the tabbed page. Valid Characters: all alphanumeric characters, hyphen (-), underscore (_), exclamation point (!), less than (<), greater than (>), pound (#), percent (%), dollar sign ($), ampersand (&), forward slash (/), backslash (\), pipe (|), opening bracket ([), closing bracket (]), and single quote (). If a single quote () or a backslash (\) is a literal part of the addressing string syntax, it must be preceded by a backslash (\) in order for the character to be passed to the server as part of the address. For example, to enter a tag with the name TEST, you would enter the data source FIX32.THISNODE.\TEST\.F_CV.
92
Understanding iFix
Description Use this button to check the syntax of your expression. A valid expression displays the message "Syntax check successful!" An error message appears if the syntax is invalid.
Find Button
Match List
93
Understanding iFix
Description Use this button to stop the search or replace in progress. Use this button to jump to the object, picture, or schedule selected in the Match List list box. Before jumping, the Proficy iFIX WorkSpace closes the Find and Replace dialog box. If you jump to an object, the Proficy iFIX WorkSpace selects it after the dialog box closes.
Replace Tab Item Find What Replace With Match Case Description Specifies the text you want to search for (the search string). Specifies the text you want to substitute for the search string. Select this check box to limit your search to only the values that match the exact case of the search string. Select this check box to limit your search to 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 ("), an apostrophe (), or the following characters: (, ), {, }, [, ]. Select this check box to limit your search to only data sources that match the search string. Select this check box to expand your search to include the scripts associated with the current picture or schedule. Use this button to display any value that matches the search string. On the Replace tab, only values you can modify appear. These values can be picture and scheduler properties, or property values of objects in your pictures. Use this button to replace only the property value you select from the Match List box. Use this button to replace all property values found.
Find Button
94
Understanding iFix
Description Use this button to display the results of replacing all property values in the Match List list box. Displays the properties and property values that match the search string. On the Replace tab, a preview of the replaced text also appears when you click Replace Preview. You can jump to the current picture, schedule, or one of the objects in the list by double-clicking it.
Stop Button
95
Understanding iFix
Description Select this check box to restore your iFIX files to the factory default settings before retrieving the iFIX files from this project. If you do not select this check box, you can get the files, but you will not be able to run them in iFIX. Selecting this check box helps your project to run properly if the path is different from the default one listed when you select the project. It is highly recommended that you leave this check box selected.
SCU File Shows the SCU name of the currently selected project. If you change the project destination, be sure to take note of this name; you will need to locate it in the SCU to update it. Base Path Shows the base path of the currently selected project. This is the main iFIX folder. Other iFIX folders are usually subdirectories of the base path. If you change the project destination, be sure to take note of this path; you will need to change base path in the SCU to the local base path. Project Path Shows the project path of the currently selected project. This path includes project specific application files, such as pictures, databases, and tag groups. The default value for the Project Path is the base path. If you change the project destination, be sure to take note of this path; you will need to change the project path in the SCU to the destination path.
96
Understanding iFix
97
Understanding iFix
Up/Down buttons Click the Up or Down button to move a selected action up or down in the Configured Actions list box. Show/Hide action details button Click the Show or Hide button to display or hide the details of all actions in the Configured Actions list box. Modify selected action button Click this button to modify the selected action. Launch VB Editor Click this button to launch the Visual Basic Editor. Configured Actions List Box The Configured Actions list box displays the command or sequence of commands that have been configured for the selected object. You can click the plus symbol next to a command to expand it and display its configured properties.
98
Understanding iFix
Custom Backup Page 1 Item Backup Type Node Description Specifies the type of backup you selected. Specifies the name of the local node from which you are backing up files. Specifies the path on the local node from which you are backing up files. Select the types of files you want to back up. Select to backup security settings. This option is only enabled when security files are found on the system. Displays notes about the backup. You cannot edit this field.
Project Path
Page 2 Item Backup File Path and Filename Description Allows you to specify the path and name of the archive file to save. You can enter any valid file name and path, including a network path. The Wizard automatically appends the .FBK extension to the name you enter. Lets you select the path and file name of the archive file by browsing to it.
Browse Button
Full Backup Item Backup File Path and Filename Description Allows you to specify the path and name of the archive file to save. You can enter any valid file name and path, including a network path. The Wizard automatically appends the .FBK extension to the name you enter.
99
Understanding iFix
Description Lets you select the path and file name of the archive file by browsing to it.
Select this option to restore files into the project path specified in the archived SCU. Select this option to restore files to a new project path with a default sub-project 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.
SCU File
Specifies the path and name of the local nodes current SCU file.
100
Understanding iFix
Description Specifies the name of the local node. Specifies the project path of the local node. You can change the project path by overwriting the existing SCU file on the local node and entering a new path. The wizard uses the path in this field to restore its files, creating any non-existent relative paths defined in the archive file. Click to display the configured paths for the restored files within the project.
Restore File Options Item Delete All Existing Files Under Target Path Before The Restore Restore Default iFIX Files Before Restoring Your Backup Files Description Select this check box to delete all existing files under the selected project path 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. Select this check box to restore default iFIX files before restoring your backup files. 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. Select this option to maintain the current security settings and ignore security overwrites in the backup files during the restore.
Leave Current Security Settings Alone Replace Existing Security Files With Archived Files Delete Existing Security Files And Disable Security
Select this option to replace the current security settings with the security settings in the archived files.
Select this option to delete all existing security files from the current iFIX system and disable security upon restore. This field also displays the current status of security (Enabled or Disabled).
101
Understanding iFix
Restore File Selection Box Select the types of files you want to restore.
Show ScreenTips On Toolbars Lets you enable or disable text descriptions for every button on every toolbar. When enabled, you can display a description by placing the cursor over a button.
102
Understanding iFix
Animations Data Error Defaults Tab Shape Preferences Tab Picture Preferences Tab Chart Preferences Tab Drawing Options Tab Environment Protection Tab Background StartUp Tab StartUp Pictures Tab Change Management Tab
General Tab - User Preferences Dialog Box The General tab of the User Preferences dialog box displays the following items: WorkSpace Options Item Start WorkSpace In Run Mode Description Select this check box to indicate that the iFIX WorkSpace starts in the run-time environment. Clear this check box to indicate that the iFIX WorkSpace starts in the configuration environment. Select this check box to automatically save open documents when the iFIX WorkSpace switches to the run-time environment.
Auto Save Documents When Switching From Configure To Run Full Screen In Run Mode
Select this check box to display pictures in the run-time environment with the maximum screen space possible. When the iFIX WorkSpace displays full-screen in the run-time environment, the menu bar is hidden. The system tree and all toolbars are always hidden in this environment. Select this check box to automatically copy the previous version of a file to a back-up folder each time you save a new version. If a back-up file already exists, the new back-up file replaces it.
103
Understanding iFix
Description Select this check box to configure the Data Change event of an event object to fire only when there is new data after the initialization. Actions such as switching from the Configuration environment to the Run-time environment while an iFIX schedule is open will cause the DataChange event to trigger accordingly. If you select this option, iFIX fires the event when initializing the event object at the time you open a picture and switch to run mode. Clear this check box if you want events to fire only if the data source truly changes.
Select this check box if you plan to use multiple monitors with your iFIX displays.
Select this check box to use the Ribbon user interface in the iFIX WorkSpace. Clear this check box to use the Classic user interface in the iFIX WorkSpace.
Electronic Signature Options Item Perform Comments Table Name Create Default Perform Comments Table Verify Comments Table Name Description Specifies the name of the table that contains predefined perform comments for the Electronic Signature dialog box.
Use this button to create a new table containing predefined perform comments for the Electronic Signature dialog box.
Specifies the name of the table that contains predefined verify comments in the Electronic Signature dialog box.
104
Understanding iFix
Item Create Default Verify Comments Table Custom ActiveX Control ProgID
Description Use this button to create a new table containing predefined verify comments for the Electronic Signature dialog box.
Specifies the ProgID for the custom ActiveX control you want to use to replace the standard electronic signature ActiveX control used to capture user names and passwords for signatures. When the Electronic Signature dialog box opens, it checks this field for a ProgID. If no ProgID is found, the standard Esignature ActiveX control is displayed. If a ProgID is found, the Electronic Signature dialog box attempts to create the custom ActiveX control. However, if creation of the control fails, a message is displayed stating that the custom control could not be created and the standard Esignature ActiveX control is displayed instead.
Security Options User Accounts Disabled Message Specifies the message that appears from the Electronic Signature dialog box when a user account is no longer valid. Expression Editor Options Remember Last Filter Select this check box so that the last filter used in the Expression Builder dialog box is remembered. This is useful if you frequently use the same or similar information when building your expressions. Animations Data Error Defaults Tab - User Preferences Dialog Box The Animations Data Error Defaults tab of the User Preferences dialog box displays the following items: Linear Animation Object Defaults Item Configuration Description Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because the specified data source could not be found. You can define your own defaults for each type of animation by entering a new value into each field.
105
Understanding iFix
Description Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because the specified I/O point is off scan. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives an undefined error. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives questionable data. This data may be out of range or may be the result of combining good data with uncertain data. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives a network error. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because an OPC device did not respond. You can define your own defaults for each type of animation by entering a new value into each field.
Unknown
Uncertain
Comm
Device
Format Animation Object Defaults Item Configuration Description Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because the specified data source could not be found. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because the specified I/O point is off scan. You can define your own defaults for each type of animation by entering a new value into each field.
Out of Service
106
Understanding iFix
Item Unknown
Description Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives an undefined error. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives questionable data. This data may be out of range or may be the result of combining good data with uncertain data. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives a network error. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because an OPC device did not respond. You can define your own defaults for each type of animation by entering a new value into each field.
Uncertain
Comm
Device
Lookup Animation Object Defaults Numeric Table Entries Item Configuration Description Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because the specified data source could not be found. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives an undefined error. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives a network error. You can define your own defaults for each type of animation by entering a new value into each field.
Unknown
Comm
107
Understanding iFix
Description Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because the specified I/O point is off scan. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because an OPC device did not respond. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives questionable data. This data may be out of range or may be the result of combining good data with uncertain data. You can define your own defaults for each type of animation by entering a new value into each field.
Device
Uncertain
String Table Entries Item Configuration Description Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because the specified data source could not be found. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives an undefined error. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives a network error. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because the specified I/O point is off scan. You can define your own defaults for each type of animation by entering a new value into each field.
Unknown
Comm
Out Of Service
108
Understanding iFix
Item Device
Description Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation fails to receive data because an OPC device did not respond. You can define your own defaults for each type of animation by entering a new value into each field. Specifies the default OPC error values that iFIX returns when a linear, format, or lookup animation receives questionable data. This data may be out of range or may be the result of combining good data with uncertain data. You can define your own defaults for each type of animation by entering a new value into each field.
Uncertain
Color Table Entries Item Configuration Description Use this button to open the Select Color dialog box where you can choose the default color that iFIX displays when a lookup animation fails to receive data because the specified data source could not be found. Use this button to open the Select Color dialog box where you can choose the default color that iFIX displays when a lookup animation receives an undefined error. Use this button to open the Select Color dialog box where you can choose the default color that iFIX displays when lookup animation receives a network error. Use this button to open the Select Color dialog box where you can choose the default color that iFIX displays when a lookup animation fails to receive data because the specified I/O point is off scan. Use this button to open the Select Color dialog box where you can choose the default color that iFIX displays when a lookup animation fails to receive data because an OPC device did not respond. Use this button to open the Select Color dialog box where you can choose the default color that iFIX displays when a lookup animation receives questionable data. This data may be out of range or may be the result of combining good data with uncertain data.
Unknown
Comm
Out Of Service
Device
Uncertain
109
Understanding iFix
Shape Preferences Tab - User Preferences Dialog Box The Shape Preferences tab of the User Preferences dialog box displays the following items: Color Item Fade Color Description Use this button to open the Select Color dialog box where you can choose the default shape fade color. Use this button to open the Select Color dialog box where you can choose the default shape foreground color. Use this button to open the Select Color dialog box where you can choose the default shape background color. Use this button to open the Select Color dialog box where you can choose the default shape edge color.
Font Item Font Name Font Size Font Styles Description Specifies the default font for text objects.
Specifies the default size of text objects. Specifies the default text object style. The text can be regular, bold, italics, or bold italics.
General Item Edge Style Description Specifies the default shape edge style. Edges can be solid, transparent, dotted, or dashed. Specifies the default shape edge width. You can enter any width from 0 to 255 logical units.
Edge Width
110
Understanding iFix
Description Specifies the minimum distance the cursor can be from an object before highlighting the object. You can enter any distance from 0 to 255 logical units. Specifies how much of the fade color, in a percentage, will be mixed with the foreground color. The higher the percentage, the more the fade color is visible. Specifies the default shape foreground fill style. Fills can be solid, transparent, gradient, or a pattern. Specifies whether the default shape background is opaque or transparent. Specifies the default fade type for shape objects. Fade types can be linear, concentric, radial, or reflected.
Blend Percent
Fill Style
Drawing Options Tab - User Preferences Dialog Box Pipe Item Thickness Description Specifies the default thickness for pipe objects. You can enter any value from 10 to 300. Specifies the default elbow style for pipe objects. Elbow styles can be round or square. Specifies the default start cap for pipe objects. Start caps can be round, square, horizontal-diagonal, or vertical-diagonal. Specifies the default end cap for pipe objects. End caps can be round, square, horizontal-diagonal, or vertical-diagonal.
End Cap
Datalink Remove Leading and Trailing Spaces Select this check box to indicate whether iFIX should remove extra spaces when Data links are displayed in the run-time environment. This check box is selected by default, which means that all blank spaces before and after data within Data links will be stripped out. Also, note that this option only applies to Data links that display ASCII (A_) or Raw Format data. If you change this option, you
111
Understanding iFix
must restart the WorkSpace for the change to take effect. Text Remove Leading and Trailing Spaces Select this check box so that leading and trailing spaces are removed from text objects that you add to the WorkSpace. This setting only applies to text entered after you change the setting; it does not change existing text entries. By default, this check box is selected. Historical Datalink Item Show Time Stamp with Data Format for Bad Data Description Specifies that the Historical Datalink include the time stamp with the data. The time stamp appears only at run-time.
Specifies the format to use for displaying bad data received from Historian. This field requires four characters. The designated format appears only at run-time.
Picture Preferences Tab - User Preferences Dialog Box The Picture Preferences tab of the User Preferences dialog box displays the following items: Properties Item Window Size Description Specifies the default window size for pictures. You can create windows full size, half the height or width of the screen, or a quarter of the screen.
Select this check box to enable the Document Width and Document Height fields to allow you to define your own logical system that differs from the default 4:3 horizontal to vertical resolution. You should not change this setting unless you are familiar with the logical units system of measuring picture height and width. Otherwise, objects may not animate as expected. Specifies the default width, in logical units, for pictures.
112
Understanding iFix
Item Highlight Timeout Interval Grid Interval Background Color Fade Color
Description Specifies the length of time an object remains highlighted at run-time. When the specified interval expires, the highlight disappears. You can enter the time in hundredths of a second. Specifies the number of logical units between grid points. Use this button to open the Select Color dialog box where you can choose the default picture background color. Use this button to open the Select Color dialog box where you can choose the default picture fade color.
Basic Animation Dialog Item Prompt On Delete Description Select this check box to be prompted to confirm the deletion of an animation in the Basic Animation dialog box and the Command Expert dialog box. Select this check box to display the Basic Animation dialog box when you double-click an object or select Animations from an objects right-click menu. If this check box is cleared, the Advanced Animations dialog box appears.
Create Picture Wizard Show Picture Wizard From New Picture Menu Select this check box to display the Create Picture Wizard. If this check box is cleared, the Create Picture Wizard is unavailable.
113
Understanding iFix
Picture Translation Item Translate Picture On Open Description Select this check box if you want to replace the text strings in all of your pictures with a selected language file (if it exists) when you open them in the run-time environment. If this check box is selected, the TranslateOnOpen and LanguageDesired properties on each pictures Properties window cannot be changed. If this check box is cleared, you can configure the TranslateOnOpen and LanguageDesired properties at the individual picture level. Language Specifies the language that all of your pictures text strings will appear in when the pictures are opened in run mode. This field is available only when the Translate Picture on Open check box is selected.
Window Properties Item Title Bar Description Select this check box to indicate whether your pictures appear with or without title bars. Select this check box to indicate whether you are creating pictures with or without a System menu, or Maximize, Minimize, and Close buttons. Select this check box to indicate whether you can or cannot resize pictures. Select this check box to indicate that your pictures will automatically float on top of all other open documents. Typically, this feature is used to create detail pictures that you always want to display on top of other pictures. Select this check box to indicate whether or not the grid in pictures is automatically displayed. Select this check box to indicate whether or not your pictures will automatically align objects to the grid. Select this check box to indicate whether or not your pictures show or hide visual cues as to which objects can be selected and which object is currently selected.
114
Understanding iFix
Gradient Enable Gradient Select this check box to enable the Gradient fill style. The default fade type for the picture is linear. You can change the pictures fade type in the Edit Picture dialog box. Thumbnail Save Thumbnail Select this check box to save a thumbnail of each picture you create. Cache Item Enable Picture Cache Cache Size Description Select this check box to enable picture caching, which reads and opens previously opened pictures from memory. Clear this check box to indicate that picture files will be opened from the disk drive. Specifies the number of pictures (from 1-99) you want in the cache.
Auto Scale Disable Auto Scale Feature Select this check box to override the logical units to pixel ratio when changing the resolution of your screen. This may be helpful for multiple monitor configurations. Chart Preferences Tab - User Preferences Dialog Box NOTE: The following options apply only to Standard Charts. The Chart Preferences tab of the User Preferences dialog box displays the following items: Scroll Direction Item Scroll Right To Left Description Select this option to set the default scroll direction for all charts to a right-to-left scroll.
115
Understanding iFix
Description Select this option to set the default scroll direction for all charts to a leftto-right scroll. Specifies the percentage of the chart that moves when the plotted data reaches the left edge of the chart. For example, when you enter 25 into this field, the chart shifts right 25% along its time (X) axis and continues plotting data.
Time Axis Item Number Of Ticks Number Of Labels Description Specifies the default number of ticks to display on your charts time (X) axis. You can enter any value from 0 to 20 into this field. Specifies the default number of labels to display on your charts time (X) axis. You can enter any value from 0 to 20 into this field.
Value Axis Item Number Of Ticks Number Of Labels Description Specifies the default number of ticks to display on your charts value (Y) axis. You can enter any value from 0 to 20 into this field. Specifies the default number of labels to display on your charts value (Y) axis. You can enter any value from 0 to 20 into this field.
Time Axis Span Item Duration Days Description Specifies the amount of data your charts display along their time (X) axes. You can enter any value from 0 to 365 days in the Days field. In the Time field, enter the time in hours, minutes, and seconds. You can enter any time up to 23 hours, 59 minutes, and 59 seconds.
116
Understanding iFix
Description Specifies the amount of data your charts display along their time (X) axes. You can enter any value from 0 to 365 days in the Days field. In the Time field, enter the time in hours, minutes, and seconds. You can enter any time up to 23 hours, 59 minutes, and 59 seconds. Specifies the default interval between the data points on your charts. In the Time field, enter the time between data points in hours, minutes, and seconds. You can enter any time up to 23 hours, 59 minutes, and 59 seconds. The interval cannot be greater than half the duration. If you enter zero, iFIX automatically calculates the interval as the duration divided by the number of display points.
Interval Time
General Item Allow Time Axis Reset Description Select this check box to control changes to the limits on the X (time) axis in a chart. Initially, the limits are set to match the time specified on the Time tab of the Chart Configuration dialog box. However, when you select this check box, you enable the time axis limits of your chart to be reset after you right-click the object to zoom out. The chart resets the time axis limits to the values of the Start Time and End properties. Select this check box to control changes to the limit on the Y (value) axis in a chart. Initially, the limits are set to match the High and Low limits specified on the Pen tab of the Chart Configuration dialog box. However, when you select this check box, you enable the value axis limits of your chart to be reset after you right-click the object to zoom out. The chart resets the value axis limits to the values of the HiLimit and LoLimit properties. Select this check box to create a chart with a transparent background.
Transparent
Drawing Options Tab - User Preferences Dialog Box The Drawing Options tab of the User Preferences dialog box displays the following items:
117
Understanding iFix
Geometry Helper Options Item Always Extend Lines Description Specifies that the selected lines will always extend to the intersection point when the Extend Lines button on the CAD Toolbar is used. Specifies that the selected line will be extended to the intersection point only when the extension is shorter than half the line being extended. Specifies that the selected line will be extended to the intersection point only when the extension is shorter than the defined value. Specifies that the selected lines will always be trimmed at the intersection point when the Trim Lines button on the CAD Toolbar is used. Specifies that the selected line will be trimmed at the intersection point only when the trimmed area is shorter than the defined value.
Extend Only When The Extension Is Shorter Than Half The Line Extend Only When The Extension Is Shorter Than X Pixels Always Trim Lines
Graphics Connections Always Show Connection Nodes Select this check box to indicate that the connection nodes are always displayed on the shapes in a picture. If this check box is cleared, the connection points are not visible, but can be displayed using one of the following methods: Select a connector and move it towards the shape to anchor it to a certain connection point on the shape. - Or Select the shape and click either the Add Connection Point button or Delete Connection Point button on the CAD Toolbar.
Environment Protection Tab - User Preferences Dialog Box The Environment Protection tab of the User Preferences dialog box displays the following items: Enable Run Time Environment Protection Select this check box to enable environment protection for the local node. When enabled, you can select the specific options that you want to restrict access to. These options take effect when you switch to the run-time environment.
118
Understanding iFix
WorkSpace Title and Menu Options Item Disable Title Bar And Menu Bar Description Select this check box to hide the WorkSpace menu bar and title bar at run-time. NOTE: In Ribbon view, if this option is selected, the Title Bar takes on the appearance of Classic view, rather than Ribbon view.
Select this check box to hide the WorkSpace menu bar and title bar at run-time. Select this check box to disable the WorkSpace menu at runtime.
WorkSpace File Menu Accelerators Item Disable "WorkSpace" File Menu Accelerators Description Select this check box to disable both the Open (Ctrl+O) and Print (Ctrl+P) WorkSpace file menu accelerators while in the Run-time environment. Select this check box to disable the Open (Ctrl+O) WorkSpace file menu accelerator while in the Run-time environment. Select this check box to disable the Print (Ctrl+P) WorkSpace file menu accelerator while in the Run-time environment.
Other Options Item Disable <Ctrl> <Alt> <Del> Description Select this check box to disable the <Ctrl><Alt><Delete> key sequence at run-time, thereby restricting operators from accessing the Task Manager, changing their password, logging off, or shutting down the computer.
119
Understanding iFix
Description Select this check box to disable run-time task switching through <Alt><Tab> and the Start button. Select this check box to allow you to restrict access to the Visual Basic Editor at run-time. If access is not restricted, the editor appears when a compilation or run-time error occurs, allowing you to correct the error. When you restrict access, the iFIX WorkSpace suppresses the Visual Basic Editor even if an error occurs.
Background StartUp Tab - User Preferences Dialog Box The Background StartUp tab of the User Preferences dialog box displays the following items: Background Task StartUp Schedules List Box Displays the schedules configured to automatically load in the background task when the background task is started. By double-clicking in the list, you can enter or edit any scheduled entry. You can also select the schedule you want to add by browsing to it with the Browse button. New Button Use this button to add a schedule (Background Startup tab) or a picture (Startup Pictures tab) to the start-up list by entering its name and path. You can also select the file by browsing to it with the Browse button. Delete Button Use this button to delete the selected file from the start-up list. Move Up Button Use this button to move the selected file up in the start-up list. Move Down Button Use this button to move the selected file down in the start-up list. StartUp Pictures Tab - User Preferences Dialog Box The StartUp Pictures tab of the User Preferences dialog box displays the following items: StartUp Pictures List Box Displays the pictures you want to open automatically when the iFIX WorkSpace starts in the run-time environment. By double-clicking in the list, you can enter or edit any entry. You can also select the picture you want to add by browsing to it with the Browse button.
120
Understanding iFix
New Button Use this button to add a schedule (Background Startup tab) or a picture (Startup Pictures tab) to the start-up list by entering its name and path. You can also select the file by browsing to it with the Browse button. Delete Button Use this button to delete the selected file from the start-up list. Move Up Button Use this button to move the selected file up in the start-up list. Move Down Button Use this button to move the selected file down in the start-up list. Change Management Tab - User Preferences Dialog Box The Change Management tab of the User Preferences dialog box displays the following items: Enable Change Management Server Connection Select this check box to if you want to enable iFIX to connect to the Proficy Change Management Server. With this option selected, right mouse menu items for Change Management become available in the iFIX WorkSpace. NOTE: You cannot edit the fields in this dialog box if security is disabled, or after you connect to the Change Management Server. Logon Info Item Change Management Server Test Connection Description Enter the name of your Proficy Change Management Server. For instance, if your server is named MYSERVER, enter MYSERVER in this field. Click to test a connection to the Proficy Change Management Server. After you supply login credentials for the Change Management Server, a message box appears indicating whether a connection can be made.
121
Understanding iFix
Description Select this check box to log in to the Change Management Server when you start the iFIX WorkSpace. Clear this check box if you only want to login to the Change Management Server from the right-click menu. (In the system tree, right-click the node name, select Manage, and then click Logon.) TIP: If you have a very large iFIX project, it is recommended that you clear this check box. Otherwise, for large projects, it may take several extra minutes for the iFIX WorkSpace to start up.
Select this check box if you always want a dialog box requesting login credentials to appear when you logon to the Change Management Server. Clear this check box if you want to allow for automatic logon. NOTE: For an automatic logon to work, the user name and password must be identical on both the Change Management Server and in iFIX. If the user name and password does not match in both applications, or the iFIX user you are logged in as is not defined as a user on the Change Management Server (or vice versa), after an error message, the Logon dialog box appears, even with this check box cleared.
Change Management Project Name Enter the name of the Change Management project folder you want to open after you logon. Files you check out or check in will reside in this project folder. Require comments to check in and check out files Select this check box if you want to require that the user enter a comment when checking out or checking in a file. If you require comments, the OK button (found in the Check Out and the Check In dialog boxes) does not become available until you enter a comment. Electronic Signature Options Item Perform Comments Table Name Description Specifies the name of the table that contains predefined perform comments for the Electronic Signature dialog box used with Change Management actions in the iFIX WorkSpace. This table name can be the same as the one you use for iFIX Performed By electronic signatures, as defined on the General tab. Or, you can enter another table with perform comments applicable only to the Change Management Server.
122
Understanding iFix
Item Create Default Perform Comments Table Verify Comments Table Name
Description Use this button to create a new table containing predefined perform comments for the Electronic Signature dialog box that appears with Change Management actions in the iFIX WorkSpace.
Specifies the name of the table that contains predefined verify comments for the Electronic Signature dialog box used with Change Management actions in the iFIX WorkSpace. This table name can be the same as the one you use for iFIX Verfied By electronic signatures, as defined on the General tab. Or, you can enter another table with verify comments applicable only to the Change Management Server.
Use this button to create a new table containing predefined verify comments for the Electronic Signature dialog box that appears with Change Management verify actions in the iFIX WorkSpace.
Select this option if no iFIX electronic signature is required to perform a Change Management function from the WorkSpace. Select this option if an iFIX Performed By electronic signature is required to perform a Change Management function from the WorkSpace (in addition to the Change Management Server login). Select this option if a Performed By and Verified By electronic signature is required by iFIX in order to perform a Change Management function from the iFIX WorkSpace (in addition to the Change Management Server login). Select this check box to allow the operator to repeatedly sign for successive actions by supplying only a password, when electronic signatures are enabled. Continuous use applies only to the person performing an action and does not affect the person verifying an action.
Perform Only
Proficy Historian Tab - User Preferences Dialog Box The Proficy Historian tab of the User Preferences dialog box displays the following items: Configuration of Tags for Collection in Proficy Historian Use this option to configure all tags in your currently loaded database for collection by Historian. Collection begins when the Collector starts.
123
Understanding iFix
How Do I...
The following sections explain how to use the Proficy iFIX WorkSpace: Using the System Tree Working with Files Starting Applications and Experts Working with the WorkSpace Environments Setting Preferences Selecting Data Sources and Building Expressions Managing Files and Nodes Working with Toolbars Installing a Third-Party OPC Server
Click a section above for steps on how to use or configure this part of the Proficy iFIX WorkSpace.
Displaying a System Tree Path To display a system tree path: 1. 2. In the iFIX WorkSpace system tree, right-click any folder or document. A pop-up menu appears. From the pop-up menu, select Properties or File Properties.
Showing and Hiding the System Tree To show and hide the system tree: From the WorkSpace menu in the iFIX WorkSpace, select System Tree. If the system tree was hidden, the iFIX WorkSpace displays it. If the system tree was visible, the program hides it. Opening or Closing a Folder in the System Tree To open or close a folder in the system tree:
124
Understanding iFix
1. 2.
In the iFIX WorkSpace system tree, click the plus sign to open (expand) a folder. Click the minus sign to close (collapse) a folder.
Copying and Moving Objects To copy or move an object: 1. 2. 3. In the iFIX WorkSpace, open the source and target picture or Dynamo set. Click, drag, and drop the object into the target to move it. Using the system tree, click, drag, and drop the objects name over the targets name to move it. Hold the Control key down and drag and drop the object to copy it.
You can also copy and paste, or cut and paste objects when the source and destination do not appear on the screen simultaneously. Viewing Thumbnails To view picture and Dynamo set thumbnails: 1. 2. In the iFIX WorkSpace system tree, click the plus sign to open (expand) both the Dynamo Sets and the Pictures folders. Place the mouse pointer over a Dynamo set or picture file name. The thumbnail, if it exists, appears.
NOTES: You will not be able to view thumbnails if you are using Windows Vista and the Vista Basic Theme for your display. Windowless OLE objects will not display in thumbnails. Not all thumbnails appear in a uniform location; some may be centered while others appear in the upper left hand corner.
Creating Files The following sections provide steps on how to create files in the iFIX WorkSpace: Creating a New Picture, Schedule, or Dynamo Set Creating a New File
125
Understanding iFix
Creating a New Picture, Schedule, or Dynamo Set To create a new picture: In Classic view, in the iFIX WorkSpace, click the New Picture button on the Standard toolbar to create a picture. -OrIn Ribbon view, click the WorkSpace button, select New and then click Picture. The Create Picture Wizard appears. Use this wizard to set sizes, locations, and properties of your new pictures. NOTE: If a single untitled picture appears when you click the New Picture button, the Create Picture Wizard has been disabled. Enable it by selecting the following check box on the Picture Preferences tab of the User Preferences dialog box: Show Picture Wizard from New Picture Menu. To create a new schedule: In Classic view, in the iFIX WorkSpace, click the New Schedule button on the Standard toolbar to create a schedule. -OrIn Ribbon view, click the WorkSpace button, select New, and click Schedule. To create a new Dynamo Set: In Classic view, in the iFIX WorkSpace, click the New Dynamo Set button on the Standard toolbar to create a Dynamo Set. -OrIn Ribbon view, click the WorkSpace button, select New, and click Dynamo Set. Creating a New File To create a new file: 1. In Classic view, in the iFIX WorkSpace, from the File menu, select New, and then Others. -OrIn Ribbon view, click the WorkSpace button, select New, and click Others. 2. From the New FIX Object list box, select the document type.
Opening Files The following sections provide steps on how to create files in the iFIX WorkSpace: Opening a File Opening a Back-up File Opening Pictures Automatically at Run Time
126
Understanding iFix
Opening a File To open a file: 1. In Classic view, in the iFIX WorkSpace, from the Standard toolbar, click the Open button. -OrIn Ribbon view, click the WorkSpace button and then Open. 2. Select the file you want to open.
TIP: You can also open a file from the system tree by expanding a folder and double-clicking the file you want to open. Opening a Backup File To open a backup file: 1. In Classic view, in the iFIX WorkSpace, from the Standard toolbar, click the Open button. -OrIn Ribbon view, click the WorkSpace button and then Open. 2. 3. 4. 5. Select the path containing your backup file. Double-click the backup file you want to open. From the File menu, select Save As. Rename the backup file and save it in the iFIX Picture path.
Opening Pictures Automatically at Run Time To open pictures automatically at run time: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. Click the Startup Pictures tab. Click the Add button and enter a file name (GRF files) for the picture you want to load when the iFIX WorkSpace enters the run-time environment. Optionally, click the Browse button to locate the file. Repeat step 3 until you have added all the files you want to load at run time. Select a file and click the Delete button to remove any pictures you no longer want to load at run time. Double-click any existing entry to modify it, as needed.
4. 5. 6.
Saving and Deleting Files The following sections provide steps on how to save and delete files in the iFIX WorkSpace: Saving a File Saving Files Automatically
127
Understanding iFix
Saving a File To save a file: 1. In Classic view, in the iFIX WorkSpace, on the Standard toolbar, click the Save button. -OrIn Ribbon view, click on the Application button, and then Save. 2. If you are saving a new file, the iFIX WorkSpace prompts you for a file name. To save the new file, enter a name and a file type for the file.
Saving Files Automatically To automatically save open documents when switching to the run-time environment: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. Click the General tab. Select the Auto Save Documents when Switching from Configure to Run check box.
Renaming Files To rename a file: 1. 2. 3. In the iFIX WorkSpace system tree, right-click a closed file. From the pop-up menu, select Rename. Enter the new name when prompted.
Deleting Files To delete a file: 1. 2. In the iFIX WorkSpace system tree, right-click a closed file. From the pop-up menu, select Delete.
128
Understanding iFix
Configuring a Button
Starting iFIX Applications To start an iFIX application: In Classic view, in the iFIX WorkSpace, on the Application toolbar, click the button for the application you want to start. -Or In Ribbon view, on the Applications tab, select the application you want to start. -OrDouble-click the application from the iFIX WorkSpace system tree.
Starting the Visual Basic Editor To start the Visual Basic Editor from the iFIX WorkSpace: In Classic view, in the iFIX WorkSpace, on the Standard toolbar, click Visual Basic Editor. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Visual Basic Editor. Running Experts With the Task Wizard To run Experts with the Task Wizard: 1. In Classic view, in the iFIX WorkSpace, select an object from the current picture and click the Task Wizard button on the Standard toolbar. -OrIn Ribbon view, on the Tools tab in the Tasks/Experts group, click the Tasks/Experts dialog box launcher. 2. 3. Select a category from the Task Category list. In the Tasks list box, double-click the specific task or Expert you want to complete.
NOTE: If you want to specify multiple commands for the object, select Multiple Commands Expert from the Command category to open the Multiple Command Script Wizard. Configuring a Button To configure a button: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab in the WorkSpace group, click Setting, and then click Toolbars. 2. Click Customize.
129
Understanding iFix
3. 4. 5.
Click the Buttons tab. Select the category for the button you want to modify. Click Modify Button. NOTE: You can only modify buttons in user-created categories.
6.
From the Bitmaps area, select the bitmap for the button. If you want to use your own bitmap, browse for it and select it. Make sure the image size is no more than 20 x 20 and uses no more than 16 colors. In the Name field, enter the buttons name. In the Description field, enter text describing the button. In the ScreenTip field, enter the buttons ToolTip.
7. 8. 9.
10. Click Edit Script to launch the Visual Basic Editor. 11. Write a script for the button.
Switching Between Environments To switch between the configuration environment and the run-time environments: 1. In Classic view, in the iFIX WorkSpace configuration environment, click Switch to Run on the Standard toolbar. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Switch to Run. 2. In the run-time environment, select Switch to Configure from the WorkSpace menu. TIP: You can also use the shortcut, Ctrl+W to switch between environments.
Setting the WorkSpace's Start-up Environment The following sections provide steps on how to use the start-ip environment for the Proficy iFIX WorkSpace: Starting the iFIX WorkSpace in the Run-time Environment Starting the iFIX WorkSpace in the Configuration Environment
Starting the iFIX WorkSpace in the Run-time Environment To configure the iFIX WorkSpace to start in the run-time environment: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences.
130
Understanding iFix
-OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. Click the General tab. Select the Start WorkSpace in Run Mode check box.
Starting the iFIX WorkSpace in the Configuration Environment To configure the iFIX WorkSpace to start in the configuration environment: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. Click the General tab. Clear the Start WorkSpace in Run Mode check box.
Configuring Environment Protection The following sections provide steps on how to configure environment protection in the iFIX WorkSpace: Enabling Environment Protection Disabling Environment Protection
Enabling Environment Protection To enable environment protection: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. 4. Click the Environment Protection tab. Select the Enable Environment Protection check box. Select the options you want to enable.
Disabling Environment Protection To disable environment protection: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select User Preferences. -OrIn Ribbon view on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. Click the Environment Protection tab. Clear the Enable Environment Protection check box.
131
Understanding iFix
Showing KeyTips To show KeyTips: NOTE: The following procedure applies only to Ribbon view. 1. 2. 3. 4. Click the Application button and then on the Application menu, click Options. If not already selected, in the Navigation pane, click Popular. Select Show KeyTips. Click OK.
Disabling KeyTips To disable KeyTips: NOTE: The following procedure applies only to Ribbon view. 1. 2. 3. 4. Click the Application button and then on the Application menu, click Options. If not already selected, in the Navigation pane, click Popular. Deselect Show KeyTips. Click OK.
Changing the WorkSpace Color Scheme To change the WorkSpace Color Scheme: NOTE: The following procedure applies only to Ribbon view. 1. 2. 3. Click the Application button and then on the Application menu, click Options. If not already selected, in the Navigation pane, click Popular . From the Color Scheme list, select the desired color scheme .
132
Understanding iFix
4.
Click OK.
Changing the ScreenTip Style To change the ScreenTip style: NOTE: The following procedure applies only to Ribbon view. 1. 2. 3. 4. Click the Application button and then on the Application menu, click Options. If not already selected, in the Navigation aane, click Popular . From the ScreenTip style list, select the desired ScreenTip style. Click OK.
Adding Commands to the Quick Access Toolbar There are three methods you can use to add commands to the Quick Access toolbar. NOTE: The following procedures apply only to Ribbon view. To add commands to the Quick Access toolbar (method 1): 1. 2. In the iFIX WorkSpace, in the Ribbon, right-click the command you want to add to the Quick Access toolbar. Click Add to Quick Access Toolbar.
To add commands to the Quick Access toolbar (method 2): 1. 2. 3. 4. 5. 6. Click the Application button and then on the Application menu, click Options. In the Navigation pane, click Customize. In the Choose Commands From list, click the category that contains the command you want to add the to the Quick Access toolbar. In the Commands list, click the command you want to add to the Quick Access toolbar and click Add. Repeat Step 4 until all desired commands are added. To change the order of which the commands appear on the Quick Access toolbar: a. b. c. 7. Click the command to move. Use the up or down arrow to move the command in the desired direction. Repeat steps a and b until commands are in the desired order.
Click OK.
To add commands to the Quick Access toolbar (method 3): 1. 2. 3. On the Quick Access toolbar, click Expand. Click the desired command to add. To view a complete list of commands, click More Commands.
133
Understanding iFix
4. 5. 6. 7.
In the Choose Commands From list, click the category that contains the command you want to add the to the Quick Access toolbar. In the Commands list, click the name of the command or other item you want to add the to the Quick Access toolbar and click Add. Repeat Step 5 until all desired commands are added. To change the order of which the commands appear on the Quick Access toolbar: a. b. c. Click the command to move. Use the up or down arrow to move the command in the desired direction. Repeat steps a and b until commands are in the desired order.
8.
Click OK.
Moving the Quick Access Toolbar There are three methods you can use to move the Quick Access toolbar either above or below the Ribbon. NOTE: The following procedures apply only to Ribbon view. To move the Quick Access toolbar (method 1): 1. 2. In the iFIX WorkSpace, click the Quick Access toolbar. Click the available command: either Show Quick Access Toolbar Below the Ribbon or Show Quick Access Toolbar Above the Ribbon.
To move the Quick Access toolbar (method 2): 1. 2. 3. 4. 5. Click the Application button and then on the Application menu, click Options. In the Navigation Plane, click Customize. To show the Quick Access toolbar below the Ribbon, select Show Quick Access Toolbar Below the Ribbon. To show the Quick Access toolbar above the Ribbon, deselect Show Quick Access Toolbar Below the Ribbon. Click OK.
To move the Quick Access toolbar (method 3): 1. 2. Click Expand on the Quick Access toolbar. . Click the available command, either Show Below the Ribbon or Show Above the Ribbon.
Removing Commands from the Quick Access Toolbar There are three methods you can use to remove commands from the Quick Access toolbar. NOTE: The following procedures apply only to Ribbon view.
134
Understanding iFix
To remove commands from the Quick Access toolbar (method 1): 1. 2. In the iFIX WorkSpace, on the Quick Access toolbar, right-click the command you want to remove. Click Remove from Quick Access Toolbar.
To remove commands from the Quick Access toolbar (method 2): 1. 2. 3. 4. Click the Application button and then on the Applications menu, click Options. In the Navigation pane, click Customize. In the list of commands in the box on the right, click the name of the command to remove and click Remove. Click OK.
To remove commands from the Quick Access toolbar (method 3): 1. 2. 3. 4. Click Expand on the Quick Access toolbar. Click More Commands. In the list of commands in the box on the right, click the name of the command to remove and click Remove. Click OK.
Resetting the Quick Access Toolbar To reset the default commands on the Quick Access toolbar: NOTE: The following procedure applies only to Ribbon view. 1. 2. 3. 4. 5. Click the Application button and then click Options. In the Navigation pane, click Customize. Click Reset. Click OK. Click OK.
Customizing Keyboard Shortcuts To customize keyboard shortcuts: NOTE: The following procedure applies only to Ribbon view. 1. 2. 3. Click the Application button and then on the Application menu, click Options. In the Navigation pane, click Customize. Click Customize.
135
Understanding iFix
4. 5. 6. 7. 8. 9.
In the Categories list, click the category that contains the command for which you want to create a shortcut. In the Commands list, click the name of the command for which you want to create a shortcut. Any shortcut keys that are currently assigned appear in the Current Keys box. Click in the Press New Shortcut Key box and press the desired keyboard shortcut. The combination appears in the Press New Shortcut Key box. In the Set Accelerator for list, choose the desired option. Click Assign. Click OK.
Setting Preferences
The following sections provide steps on how to set preferences in the iFIX WorkSpace: Setting Monitor Preferences Setting Picture, Shape, Drawing, and Chart Preferences Setting Run-time Preferences Setting the WorkSpace's Start-up Environment Configuring Environment Protection
Setting Monitor Preferences To enable the use of multiple monitors: IMPORTANT: You configure the overall monitor settings for your computer, before you can configure iFIX to display multiple monitors. 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. 4. Click the General tab. Select the Extend WorkSpace to support multiple monitors check box. Click OK.
Setting the iFIX WorkSpace User Interface To set the iFIX WorkSpace User Interface: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. Click the General tab.
136
Understanding iFix
3. 4. 5. 6.
To enable Ribbon view, select the Enable Ribbon User Interface check box. To enable Classic view, clear the Enable Ribbon User Interface check box. Click Ok. Restart the WorkSpace for changes to take effect.
Enabling Database Tag Collection by Historian To enable database tag collection by Historian: NOTES: 1. Enabling this feature causes all of your database tags to be collected by Historian. During database reload, if an iFIX tag already exists in Historian, the information is read from Historian, not iFIX; the update in the iFIX database contains the Historian fields. You can enable collection, one tag at a time, on the Historian tab of the database block itself. For more information, see Enabling or Disabling Block Collection by Historian. This feature does not work if you have a run-time only license for iFIX. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. 4. 5. Click the Proficy Historian tab. Select Automatically Configure Tags for Collection in Historian. Click OK. Restart the WorkSpace and reload the database for changes to take effect.
Setting Picture, Shape, Drawing, and Chart Preferences The following sections provide steps on setting picture, shape, drawing, and chart preferences in the iFIX WorkSpace: Setting Picture Preferences Globally Translating Picture Text Enabling Picture Caching Setting Shape Preferences Setting Drawing Options Setting Save Preferences Setting Chart Preferences
137
Understanding iFix
Setting Picture Preferences To set picture preferences: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. 4. 5. Click the Picture Preferences tab. From the Window Size list, select the default window size. In the Window Properties area, select the window properties you want to enable. If you are familiar with the logical units system of measuring picture height and width, clear the Automatically determine document size check box. Then, in the Document Height and Document Width fields, enter, in logical units, the default height and width for your pictures. In the Highlight Timeout Interval field, enter the length of time, in seconds, that an object in your picture should stay selected. In the Grid Interval field, enter the space, in logical units, between grid points for your pictures. Click the Background Color button and choose the default picture background color. Click the Fade Color button and choose the default picture fade color.
6. 7. 8. 9.
10. In the Gradient area, select the Enable Gradient check box. 11. In the Thumbnail area, select the Save Thumbnail check box. 12. In the Basic Animation Dialog area, select from the following options: Prompt on Delete Prompts you to confirm the deletion of an animation in the Basic Animation dialog box and the Command Expert dialog box. Always Show Basic Animation Dialog Displays the Basic Animation dialog box when you double-click an object or select Animations from an objects right-click menu. If this check box is cleared, the Advanced Animations dialog box appears.
12. Enable picture caching. 13. In the Create Picture Wizard area, select the Show Picture Wizard From New Picture Menu check box. If this check box is cleared, the Create Picture Wizard is not available. 14. Select the Disable Auto Scale Feature check box to override the logical units to pixel ratio when changing the resolution of your screen 15. If applicable, set global language settings. Globally Translating Picture Text To configure global picture language settings: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. Click the Picture Preferences tab.
138
Understanding iFix
3. 4. 5.
Select the Translate Picture on Open check box. From the Language list, choose the language you want all picture text strings to appear in, provided that you add translations to an exported CSV file. Open your pictures in run mode. The displayed text strings are automatically translated into the selected language.
Enabling Picture Caching To enable picture caching: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. 4. Click the Picture Preferences Tab. Select the Enable Picture Cache check box. Enter a number from 1 to 99 to indicate the number of pictures to be cached. This number represents preload and run-time pictures.
Setting Shape Preferences To set shape preferences: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. 4. 5. 6. 7. 8. 9. Click the Shape Preferences tab. In the Color area, click each button and select the shapes fade, foreground, background, and edge colors. In the Font area, select the default font, size, and style for text objects. From the Edge Style and Fill Style lists select the default shape edge and fill styles, respectively. In the Edge Width field, enter the default edge thickness, in logical units. From the Background Style list, select the default background style. In the Hit Test Size field, enter the minimum distance, in logical units, required to select an object. When the cursor is within the specified distance, iFIX selects the object. From the Fade Type list, choose the default fade type.
10. In the Blend field, enter how much of the fade color, in a percentage, will be mixed with the foreground color. 11. In the Thickness field, enter the default thickness for pipe objects. You can enter any value from 10 to 300. 12. From the Elbow Style list, choose the default elbow style for pipe objects. 13. From the Start Cap and End Cap lists, choose the default start and end caps for pipe objects.
139
Understanding iFix
14. Select the Remove Leading and Trailing Spaces check box to indicate that iFIX should remove extra spaces when Data Links are displayed in the run-time environment. Setting Drawing Preferences To set drawing preferences: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. 4. 5. Click the Drawing Options tab. In the Extend Options area, select the default option for extending line objects to an intersection point. In the Trim Options area, select the default option for trimming line objects to an intersection point. Select the Always Show Connection Nodes check box to display the connection nodes when using the LineConnector Tool, the Rightangleline Connector, or the Pipe Connector.
Setting Save Preferences To set the save preferences: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. Click the General tab. Select the Always Create Backup Copy check box to automatically create a backup copy each time you save a file. Clear the check box to disable the option.
Setting Chart Preferences NOTE: You can only set preferences for Standard Charts. To set chart preferences: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. 4. 5. Click the Chart Preferences tab. From the Scroll Direction area, select the scroll direction. If you choose a Left to Right scroll, in the Reset field, enter the percentage of the chart to repaint when the plotted data reaches the left edge of the chart. In the Time Axis and Value Axis areas, enter the number of ticks and labels for the X and Y axes, respectively.
140
Understanding iFix
6. 7. 8.
In the Duration area, enter the length of time the X axis spans. In the Interval area, enter the length of time between plotted data points. Select the Allow Time Axis Reset check box to enable the time axis limits of your chart to be reset after you right-click the object to zoom out. The time axis limits are reset to the values of the Start Time and End properties. Select the Allow Value Axis Reset check box to enable the value axis limits of your chart to be reset after you right-click the object to zoom out. The value axis limits are reset to the values of the HiLimit and LoLimit properties.
9.
10. Select the Transparent check box to make the charts background transparent. Clear the check box to make the background opaque. Setting Run-time Preferences The following sections provide steps on how to set run-time preferences in the iFIX WorkSpace: Saving Files Automatically Displaying the WorkSpace Full Screen Opening Pictures Automatically at Run-time Running Schedules in the Background Defining OPC Connection Error Preferences
Displaying the WorkSpace Full-Screen To display the WorkSpace at full-screen: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. Click the General tab. Select the Full Screen in Run Mode check box.
Running Schedules in the Background To select the schedules you want to run in the background: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. 4. 5. Click the Background Startup tab. Click the Add button and enter a file name (EVS files) for the schedule you want to run when iFIX starts. Optionally, click the Browse button to locate the file. Repeat step 3 until you have added all the files you want to run in the background. Select a file and click the Delete button to remove any schedules you no longer want to run in the background.
141
Understanding iFix
6.
Setting OPC Connection Error Preferences To set the OPC connection error preferences: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. 3. 4. 5. 6. Click the Animations Data Error Defaults tab. In the Linear Animation Object Defaults area, enter the default numeric values to use when an error occurs scaling a value. In the Format Animations Object Defaults area, enter the default strings to display in a Data link when an error occurs. In the Numeric Table Entries and the String Table Entries areas, enter the default numeric and string values to use when an error occurs in a lookup table. In the Color Table Entries area, click each button and select the color to use when an error occurs in a lookup table.
Browsing the Process Database To browse the process database: 1. In the iFIX WorkSpace, open a dialog box that displays a Data Source field. For instance, double-click a datalink to display the Datalink dialog box, or open an Expert dialog box to add a basic animation. Click the Browse button to the right of the Data Source field. The Expression Builder dialog box appears. Click the FIX Database tab. From the Node Names, Tag Names, and Field Names list boxes, respectively, select the SCADA server, block, and field you want. If a list box has many entries you do not want to display, filter the data source. Enter the tolerance, deadband, and refresh rate for this connection.
2. 3. 4.
5.
142
Understanding iFix
Building an Expression To build an expression: 1. In the iFIX WorkSpace, open a dialog box that displays a Data Source field. For instance, double-click a datalink to display the Datalink dialog box, or open an Expert dialog box to add a basic animation. Click the Browse button to the right of the Data Source field. The Expression Builder dialog box appears. Click the tab that contains the items you want to use in your expression, as follows: To include a data source in an expression, click the node, block, and field from the FIX Database tab. To include properties of picture objects, click the Pictures tab. To include historical data, click the Historical tab. (Data links only) To include global objects, click the Globals tab. (Data links only) To include I/O points from third-party OPC servers, click the Data Servers tab. NOTE: Not all tabs are available for all objects. 3. 4. 5. 6. 7. Expand the list to display the items you want and select them. If a tab has many entries you do not want to display, filter the data source. If you want to combine two expressions, click the Mathematical Functions button and an operator button followed by a numeric value or another expression. Repeat steps 2 through 4, moving from tab to tab until you have included all the items you want in the expression. Enter the tolerance, deadband, and refresh rate for this connection. Click the Check Syntax button to verify that your expression is valid. A valid expression displays the message "Syntax check successful!". An error message is displayed for an invalid expression. NOTE: If you have created an object-to-object connection, such as the fill percentage of one tank to another, or created a connection to a data source, the animated properties display in boldface in the Properties list of the Pictures tab for the selected object. Filtering Data Sources To filter data sources: 1. In the iFIX WorkSpace, open a dialog box that displays a Data Source field. For instance, double-click a datalink to display the Datalink dialog box, or open an Expert dialog box to add a basic animation. Click the Browse button to the right of the Data Source field. The Expression Builder dialog box appears. Click the tab you want to display. Enter the text you want to display, including any wildcards, in the Filter field. Click the Filter button.
2. 3.
2. 3. 4. 5.
143
Understanding iFix
Remembering the Last Filter To remember the last filter: 1. In Classic view, from the iFIX WorkSpace menu, select User Preferences. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Preferences. 2. Select the Remember last filter check box on the General tab. The most recently used filter(s) used on the Expression Builder dialog box will be remembered.
Specifying the Tolerance, Deadband, and Refresh Rate To specify the tolerance, deadband, and refresh rate: 1. In the iFIX WorkSpace, open a dialog box that displays a Data Source field. For instance, double-click a datalink to display the Datalink dialog box, or open an Expert dialog box to add a basic animation. Click the Browse button to the right of the Data Source field. The Expression Builder dialog box appears. Click the FIX Database tab. In the Tolerance field, enter the maximum allowable rounding factor for the data source or expression you are building. If the value of the data source or expression is within the tolerance of a target value, iFIX assumes the two values are equal. In the Deadband field, enter the maximum fluctuation you want for the data source or expression. If the value of the data source or expression exceeds the maximum or minimum deadband, iFIX updates the object with the new value. In the Refresh Rate field, select how often to update the data source or expression, in seconds.
2. 3. 4.
5.
6.
Using the Proficy Historian Tab in the Expression Builder Dialog Box Using the Proficy Historian Tab The following sections provide steps on how to use the Proficy Historian tab when working with the iFIX WorkSpace: Sorting Fields in the Tag List Applying Filters to the Tag List Resetting Tag Filters
Sorting Fields in the Tag List To sort a field in the tag list: 1. Click the appropriate field header name (Node, Tag, Description, or Collector Name). An arrow appears. The up arrow indicates that the field is sorted in ascending order. The down arrow indicates that the field is sorted in descending order. Click the field header name again to reverse the sort order.
2.
144
Understanding iFix
NOTE: By default, the fields are sorted in ascending order by the node name. Applying a Filter to the Tag List To apply a specified filter to the tag list: 1. 2. Enter your filter criteria in the appropriate filter drop-down box (Node, Description, Tag, or Collector Type). Select the Apply Filter button.
Resetting Tag Filters To reset filter specifications: Select the Reset button.
Sharing iFIX Files To share iFIX files: 1. In Classic view, in the iFIX WorkSpace, click the System Configuration Utility button on the toolbar. -OrIn Ribbon view, on the Applications tab, in the System & Security group, click SCU. 2. 3. Click the Paths button on the SCU toolbox. In the appropriate field(s, enter the network path(s) you want to use. For example, enter a network path in the Picture field, such as C:\Program Files\GE Fanuc\Proficy iFIX \PIC, to change the Picture path. Copy all the files in the shared paths from your local node to your file server.
4.
Starting iFIX with an SCU File from a Different Path To start iFIX with an SCU file from a different path: NOTE: The following steps describe how to modify an SCU file with a path outside the install path, so that you run it in iFIX.
145
Understanding iFix
1. 2. 3. 4.
Shut down iFIX. On the Start menu, point to Programs, Proficy HMI SCADA - iFIX, and then System Configuration to open the SCU. The SCU window appears. From the SCU Configure menu, click Paths. The Path Configuration dialog box appears. In the Path Configuration dialog box, change the base path and NLS path to point to the local install path. Change the project path to point to the project destination folder, if it does not already do so. From the SCU Configure menu, click Tasks. The Task Configuration dialog box appears. In the Task Configuration dialog box, change the path of the configured tasks to the local install path, make sure that you include the same command line options. From the SCU Configure menu, click Network. The Network Configuration dialog box appears. In the Network Configuration dialog box, confirm the information is correct and make changes if necessary. From the SCU Configure menu, click SQL, and then click Configure SQL Tasks. The SQL Task Configuration dialog box appears.
5. 6. 7. 8. 9.
10. In the SQL Task Configuration dialog box, make sure that the Primary and Secondary paths are correct, if used. 11. From the SCU Configure menu, click Local Startup. The Local Startup Definition dialog box appears. 12. In the Local Startup Definition dialog box, change the path to the folder you copied the project to with the get command. 13. From the SCU File menu, click Save. 14. Restart iFIX. Getting a Different iFIX Project from the Change Management Server To get a different iFIX project from the Change Management Server: 1. From the iFIX WorkSpace system tree, right-click the node name, point to Manage, and then click Get Other Project. The Get Project dialog box appears. NOTE: The Manage right-click menu is unavailable if you are not logged into the Change Management Server from iFIX. 2. 3. In the Select Project drop-down list, select a project name. In the Project Destination field, if the path is the same as your local iFIX install, enter a different path. By doing this, you prevent the get command from overwriting your current iFIX project files. By default, the path in the Project Destination field is set to the path that the project was last checked in with. If you want to delete any existing files before you get the project files, select the Delete all existing files under Project Destination check box. If you want to copy iFIX default files into the folder before retrieving the project, select the Initialize Project Destination with iFIX default Files check box. It is recommended that you leave this check box selected. Otherwise, you will not be able to run the project you get in iFIX.
4. 5.
146
Understanding iFix
6. 7.
Click Get. A status box appears as the iFIX project files are copied to your local computer. If you want to start iFIX using the SCU from the project you just got, follow the steps below.
To start iFIX with that projects SCU: NOTE: These steps start iFIX with an SCU from a different path (a path outside the install path). 1. 2. 3. 4. Shut down iFIX. On the Start menu, point to Programs, Proficy HMI SCADA - iFIX, and then System Configuration to open the SCU. The SCU window appears. From the SCU Configure menu, click Paths. The Paths Configuration dialog box appears. In the Path Configuration dialog box, change the base path and NLS path to point to the local install path. Change the project path to point to the project destination folder, if it does not already do so. From the SCU Configure menu, click Tasks. The Tasks Configuration dialog box appears. In the Task Configuration dialog box, change the path of the configured tasks to the local install path, make sure that you include the same command line options. From the SCU Configure menu, click Network. The Network Configuration dialog box appears. In the Network Configuration dialog box, confirm the information is correct and make changes if necessary. From the SCU Configure menu, click SQL, and then click Configure SQL Tasks. The SQL Task Configuration dialog box appears.
5. 6. 7. 8. 9.
10. In the SQL Task Configuration dialog box, make sure that the Primary and Secondary paths are correct, if used. 11. From the SCU Configure menu, click Local Startup Paths. The Local Startup Definition dialog box appears. 12. In the Local Startup Definition dialog box, change the path to the folder you copied the project to with the get command. 13. From the SCU File menu, click Save. 14. Restart iFIX. Creating a Factory Default Backup File To create a factory default backup file: From the command line, enter
BackupRestore.exe /FactoryDefault [/l=<user ini file>]
NOTE: You can modify the BackupRestore.ini file to create user specific defaults. For more information, refer to the BackupRestore.ini file. Finding and Replacing Data The following sections provide steps on how to find and replace data in the Proficy iFIX WorkSpace:
147
Understanding iFix
Finding Data in Pictures, Schedules, and Scripts To find data in pictures, schedules, and scripts: 1. In Classic view, in the iFIX WorkSpace, from the Edit menu, select Find and Replace. -OrIn Ribbon view, on the Home tab, in the Editing group, click Find and Replace. 2. 3. In the Find What field, enter the text you want to locate. Select one or more of the following check boxes to set the appropriate options: 4. Select the Match Case check box to do a case-sensitive search. Select the Whole Word Only check box to locate whole words that match the search string. Select the Data Source Only check box to locate only data sources. Select the Include Scripts check box to locate the search string in the scripts associated with the picture or schedule.
Click Find.
Replacing Data in Pictures, Schedules, and Scripts To replace data in pictures, schedules, and scripts: 1. 2. 3. 4. Using the Find and Replace dialog box, find the data you want to replace. Click the Replace tab in the Find and Replace dialog box. In the Replace With field, enter the text you want to substitute for the search string. Click one or more of the following buttons to replace the values as needed: Click Replace Preview to view the results of replacing all the property values found without changing them. Click Replace Selected to replace the value selected from the Match List list box. Click Replace All to replace all the property values found.
Using the Backup and Restore Wizard The following sections provide steps on how to use the Backup and Restore wizard in the Proficy iFIX WorkSpace: Archiving Selected Files Restoring Files From an Archive Defining the Archive iBatch Project
Archiving Selected Files To archive selected files, or create a new factory default file:
148
Understanding iFix
1.
From the iFIX submenu, open the Backup & Restore Wizard: a. b. From the Windows Start menu, point to Programs, Proficy HMI SCADA - iFIX, Tools, and then Backup and Restore Wizard. From the iFIX submenu, choose Backup & Restore Wizard. The Proficy iFIX Project Backup dialog box appears.
NOTE: To run the Backup and Restore wizard with the Factory Default option, run the application with the /FactoryDefault command line option. For instance, in the Run dialog box, type: backuprestore.exe /FactoryDefault. In Factory Default mode, the Custom and Full Backup options are unavailable. 2. 3. 4. 5. 6. Select the Custom Backup or Factory Default Backup option and click the Project Backup Wizard button. The Proficy iFIX Project Backup Wizard appears. From the Backup File Option list, select the check box(es) for the types of files you want to archive. To archive all your files, select the Backup the Entire System check box. If you have Security files and want to add those to your archive file, select the Include security files in archive check box. Click Next and specify the path and archive file to use. You can also click the Browse button to locate the path and file. Click Finish to archive the selected files.
To create an archive of all your files: 1. From the iFIX submenu, select the Backup & Restore Wizard as follows: a. From the Windows Start menu, point to Programs then point to Proficy HMI SCADA iFIX.. From the iFIX submenu, choose Backup & Restore Wizard. The Proficy iFIX Project Backup dialog box appears.
b.
2.
In the Backup Type area, select the Full Backup option and click the Project Backup Wizard button. The Proficy iFIX Project Backup Wizard appears. Enter the path and archive file to use. You can also click the Browse button to locate the path and file. Click Finish to archive the selected files.
3.
4.
Restoring Files From an Archive To restore files from an archive: 1. 2. Shut down iFIX if it is running. From the iFIX submenu, select Backup & Restore Wizard as follows: a. From the Windows Start menu, point to Programs, Proficy HMI SCADA - iFIX, Tools, and then Backup and Restore Wizard. From the iFIX submenu, choose Backup & Restore Wizard. The Proficy iFIX Project Backup dialog box appears.
b.
149
Understanding iFix
3. 4. 5.
Click the Project Restore Wizard button. The Proficy iFIX Restore Wizard appears. Click the Browse button and select the archive file from which to restore files. Click Next and select the appropriate Restore Destination Option. The corresponding destination information displays in the Destination Info fields.
6. 7. 8.
To perform a clean restore and delete all files before restoring the archive, select the Delete all existing files under target project path before the restore option. To restore the iFIX files to their default state before restoring your archive, select the Restore default iFIX files before restoring your backup files option. If security files are located in the archive, select to leave the security settings alone, replace existing security files with archived files, or delete all existing security files and disable security. Select the check box(es) of the specific files you want to restore or select the Restore the entire system check box to restore all files in the archive.
9.
Defining the Active Batch Execution Project To define the active Batch Execution project: 1. 2. 3. 4. 5. From the system tree, double-click the Batch configuration icon. The Batch Configuration dialog box appears. Click the Project tab. In the Active Project field, enter the name of the project or click the Create New Project button and enter the name of the project in the dialog box that appears. Click OK. Restart the iFIX WorkSpace.
Configuring Proficy Historian and iFIX You must shut down Historian services and licensing prior to installing iFIX and Historian. To use the integrated Proficy Historian features in iFIX, you must choose to install Historian during the iFIX install. By default, the Historian 3.1 install is included on the iFIX 5.0 DVD; it includes the Proficy
150
Understanding iFix
Historian Server and all of the collectors you need. To configure Proficy Historian and iFIX: After the iFIX and Historian install, do the following: 1. 2. Restart your computer. Manually install SP1 for Proficy Historian, IH31_SP1.exe. To do so: a. Locate and open IH31_SP1.exe. The Installation Folder dialog box appears with the path listed. NOTE: SP1 can be found on the iFIX product install DVD in the Proficy\Historian31SP folder or on the DVD installation screen. b. c. d. e. f. g. h. i. j. 3. Leave the default path or click Browse to select a folder. Click Next. The Create Folder dialog box appears. Click Yes. The Installation Program Setup dialog box appears. Click Next. The Software License Agreement dialog box appears. Click Yes. The Start Copying Files dialog box appears. Click Next. The progress displays on screen as the files are copied. After a few moments, the Setup Complete dialog box appears. Select View Release Notes and click Finish. The Release Notes appear. Close the Release Notes. The Setup Complete dialog box appears. Select Yes, I want to restart my computer now. Click Finish.
Manually install a SIM for Proficy Historian, IH31_1462289414.exe. a. Locate and open IH31_1462289414.exe. The Installation Folder dialog box appears with the path listed. NOTE: The SIM can be found on the iFIX product install DVD in the Proficy\Historian31SP folder or on the DVD installation screen. b. c. d. e. f. g. Leave the default path or click Browse to select a folder. Click Next. The Create Folder dialog box appears. Click Yes. The Installation Program Setup dialog box appears. Click Next. The Software License Agreement dialog box appears. Click Yes. The Start Copying Files dialog box appears. Click Next. The progress displays on screen as the files are copied. After a few moments, the Setup Complete dialog box appears. NOTE: If a CIMPLICITY error message appears, ignore it and click OK. h. i. j. Select View Readme and click Finish. The Release Notes appear. Close the Readme. The Setup Complete dialog box appears. Select Yes, I want to restart my computer now. Click Finish.
4.
151
Understanding iFix
a. b. c. d. 5. 6.
On the Start menu, click Programs, Proficy Historian, and then Historian Administrator. The Historian Administrator program starts. Log into Proficy Historian Administrator. Click Collectors. Verify that all of your collectors appear in the Collectors area, especially the iFIX collector.
Start iFIX, the WorkSpace and the iFIX collector. Classic view only: Insert the Proficy Historian toolbar. To do so: a. b. In the WorkSpace system tree, double-click the Project Toolbar Files folder, and then the Toolbars folder. Double-click Proficy Historian. The Proficy Historian toolbar displays in the WorkSpace.
7.
Change Historians. To do so: a. In Classic view, on the Proficy Historian toolbar, click Change Historian. -OrIn Ribbon view, on the Administration tab, in the Proficy Historian Group, click Configure Historian, and then click Change Historian. b. c. Select Proficy Historian, and then click OK. Close and restart the WorkSpace.
8.
Configure the Historian Server. To do so: a. In Classic view, in the Proficy Historian toolbar, select Configure the Historian Server. -OrIn Ribbon view, on the Administration tab, in the Proficy Historian Group, click Configure Historian, and then click Configure Historian Server. b. c. d. e. Click Get Collectors. The Collector Name list is populated. Select the iFIX collector, and then click Set Default. Click Close. Restart the WorkSpace.
9.
In the iFIX Database Manager, add the blocks that you want to start collecting on. To do so: a. In the Database Manager, in Classic view, on the Database Manager's toolbar, click Open. -OrIn Ribbon view, click the Main Button, and then click Open. b. c. d. e. Double-click the SCADA server you want to connect to. The database displays. Double-click in a blank cell in the spreadsheet. The Select a Block Type dialog box appears. Select the type of block you want to add and click OK. The block's dialog box appears. Complete each tab. Use the Proficy Historian tab to enter the information from Historian, and then click Save.
152
Understanding iFix
f. g.
Repeat Steps C-E for each block you want to add. Save your database. In Classic view, on the Database Manager's toolbar, click Save. -OrIn Ribbon view, click the Main Button, and then click Save. NOTE: For instructions on modifying blocks, see Modifying Blocks.
10. After approximately two minutes, in the Historian Administrator, check that your tag was added. To do so: a. b. c. d. On the Start menu, click Programs, Proficy Historian, and then Historian Administrator. The Historian Administrator program starts. Log into Proficy Historian Administrator. Click Tags. Verify that all of your tags appear in the tags area. NOTE: The confighist.txt file is the log file in the iFIX LOCAL folder. Use this log file to troubleshoot if your tags do not get added to Historian. 11. Verify your configuration. To do so: a. Add a historical data link to your picture from the toolbox. In Classic view, from the Toolbox, click Historical Datalink. -OrIn Ribbon view, on the Insert tab, in the Objects/Links group, click Objects/Links, and then click Historical Datalink. b. Switch to run mode. In Classic view, from the WorkSpace menu, select Switch to Run. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Switch to Run. c. View the last value collected in the data link. NOTE: There will be a delay of approximately two minutes between data updates. Adding a Server to the Proficy Historian Server List To add a server to the Proficy Historian server list: 1. In Classic view, locate the Proficy Historian toolbar and then click the Configure iHistorian Server button, which is the third of the four buttons. -OrIn Ribbon view, on the Administration tab, in the Proficy Historian group, click Configure Historian, and then click Configure Historian Server. 3. 4. 5. 6. Click Add Server. In the Alias Name field, enter an alias. In the Server Name field, enter a server name. If required, in the User Name and Password fields, enter a user name and password, respectively.
153
Understanding iFix
7. 8. 9.
Deleting a Server from the Proficy Historian Server List To delete a server from the Proficy Historian server list: 1. In Classic view, locate the Proficy Historian toolbar and then click the Configure iHistorian Server button, which is the third of the four buttons. -OrIn Ribbon view, on the Administration tab, in the Proficy Historian group, click Configure Historian, and then click Configure Historian Server. 3. 4. 5. From the Alias Name/Server Name list, select the server to delete. Click Delete. Click Close.
Modifying a Server on the Proficy Historian List To modify a server on the Proficy Historian server list: 1. In Classic view, locate the Proficy Historian toolbar and then click the Configure iHistorian Server button, which is the third of the four buttons. -OrIn Ribbon view, on the Administration tab, in the Proficy Historian group, click Configure Historian, and then click Configure Historian Server. 3. 4. 5. From the Alias Name/Server Name list, select a server to modify. Click Modify. Click Close.
Setting the Default Proficy Historian Server To set the default Proficy Historian server: NOTE: You must select a default Historian server. Otherwise, Historian will not work correctly in the WorkSpace. 1. In Classic view, locate the Proficy Historian toolbar and click the Configure iHistorian Server button, which is the third of the four buttons. -OrIn Ribbon view, on the Administration tab, in the Proficy Historian group, click Configure Historian, and then click Configure Historian Server. 3. 4. From the Alias Name/Server Name list, select a server. Click Set Default. The selected server is set as the default Historian server.
154
Understanding iFix
Setting the Default Collector To set the default collector: 1. In Classic view, locate the Proficy Historian toolbar and then click the Configure iHistorian Server button, which is the third of the four buttons. -OrIn Ribbon view, on the Administration tab, in the Proficy Historian group, click Configure Historian, and then click Configure Historian Server. 3. 4. 5. Click Get Collectors. From the Collector Name list select a collector. Click Set Default. The selected collector is set as the default Historian collector. NOTES: For iFIX 5.0 automatic collection, you must select the iFIX collector. If you are upgrading your system, set your existing collector as the default collector. If you have redundant servers, for each server, set the primary server's collector as the default collector. For more information about redundancy and Historian, refer to the Proficy Historian and Enhanced Failover section. Because this feature only supports collectors that read data from iFIX, the collectors available for selection are limited to the following: iFIX Native Collector OPC Collector reading from Intellution.OPCEDA or Intellution.OPCiFIX OPC servers
Troubleshooting Proficy Historian and iFIX The following table lists some specific troubleshooting information for configuring Proficy Historian and iFIX. Scenario I reloaded my database. I have a tag named AI1; I have set Enable Collection on this tag and updated the necessary Historian fields. However, the tag does not seem to be collected. Solution/Explanation Verify that: The default Collector is configured. A connection exists between iFIX and Historian. You have configuration privileges.
There are a number of reasons why tags are not collected. If none of the preceding reasons seem to be the cause, check the confighist.txt file and review the error log. Also, check the alarm history information.
155
Understanding iFix
Scenario I have a tag named Fix.AI1.F_CV in Historian already collecting. What will happen if I reload or import a database and the database already contains a tag named AI1?
Solution/Explanation Proficy Historian always configures tags using the following format for the tag name: NodeName.TagName.F_CV. Hence, if you are already collecting a tag with the same name, when you: Reload at the time of reload, iFIX will detect that there is already another tag with the same name being collected and all the information from Historian for that tag will be updated in the iFIX block named AI1. Import or Add When importing or adding a tag to the database, the tag from Historian will be overwritten with the tag of the same name from the iFIX database.
I do not want to install integrated Historian, and want to continue using Historian as I did before.
Never do the following: Select the Automatically Configure Tags for Collection in Historian on the Proficy Historian tab of the User Preferences dialog box. Use Proficy Historian fields in the iFIX Database Manager to configure anything in Historian.
We recommend avoiding this practice. Use the feature that best accommodates the collection requirements of the particular tag. If you decide to use both products at once, changes made in iFIX take precedence and will overwrite settings made using Historian Administrator. If you are using Historian Administrator, do not use iFIX block fields for those tags.
156
Understanding iFix
Scenario I upgraded from iFIX 4.5 to iFIX 5.0. What will happen to my database blocks?
Solution/Explanation All of the database blocks will be upgraded to include all of the new fields and they will be initialized to default values for Historian fields. Additional considerations: By default collection is not enabled If some of the blocks are already being collected, they will receive the information from Historian for the collection fields at the time of reload.
I have configured redundant SCADA nodes. How does this feature affect my configuration? I selected the Automatically Add Tags for Collection check box. I have some tags already configured for collection in Historian. What will happen to my tags?
iFIX always adds tags to the primary collector, so if you have collector redundancy configured correctly, there should be no problem. Since at reload time information from Historian is updated in iFIX, this option will not take effect for your existing tags; you will have to update them manually. The log in configHist.txt will show that the tag already exists and in the Database Manager you can see that the tag has pulled up information from Historian. In the Task Configuration dialog box of the SCU tool, add the collector. Let the collector run at least one time on your system. Check the confighist.txt file, located in the Local folder, to determine if you exceeded the licensed tag collection amount. If so, you may need to purchase more tags. When using iFIX and Historian together, and the Collector is running, there is approximately a two minute delay between when changes are made and when they appear. When you reload the database, all of the new database tags are added to Historian. In addition, all of the tags from the previous database are hidden from Historian. It may seem as though those tags are deleted, but they are not.
There is a long time between when changes are made in the database and when they appear.
I reloaded my database and some tags seem to have disappeared from Historian. What happened?
157
Understanding iFix
Scenario I decided to uninstall Historian. Now I get the error message "Could not load an object..." when I open WorkSpace. On the Configure the Proficy Historian Server dialog box, the Get Collectors and Set Default buttons are unavailable.
The Get Collectors and Set Default buttons are unavailable in iFIX if you are attempting to configure the default collector on a View node.
Showing and Hiding Toolbars To show or hide toolbars: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. 2. 3. Select the owner for the toolbars you want to show or hide. Select the check box of each toolbar you want to display and clear the check box for each toolbar you want to hide.
Customizing Toolbars The following sections provide steps on how to customize toolbars in the Proficy iFIX WorkSpace: Adding a Button to a Toolbar Removing a Button from a Toolbar Arranging Buttons on a Toolbar Enabling and Disabling Toolbar Docking Resetting Standard Toolbars
158
Understanding iFix
Adding a Button to a Toolbar To add a button to a toolbar: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. 2. 3. 4. Click Customize. Click the Buttons tab and select the category for the button you want to add. Click, drag, and drop the button you want to add onto the toolbar. NOTE: The buttons in the Scheduler category are for internal use only. Removing a Button From a Toolbar To remove a button from a toolbar: 1. In Classic view, from the iFIX WorkSpace menu, select Toolbars . -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. 2. 3. Click Customize. Click, drag, and drop the button you want to delete off of the toolbar.
Arranging Buttons on a Toolbar To arrange buttons on a toolbar: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. 2. 3. Click Customize. Click, drag, and drop the button to its new location on the toolbar. NOTE: The buttons in the Scheduler category are for internal use only. Enabling and Disabling Toolbar Docking To enable and disable toolbar docking: NOTE: In Ribbon view, toolbars cannot be docked. 1. 2. 3. 4. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. Click Customize. Select the owner of the toolbar you want to modify. Select the floating toolbar you want to modify. If the toolbar is hidden, select the toolbars check box to display it.
159
Understanding iFix
5.
Select the Enable Docking for Selected Toolbar check box to enable docking. To disable docking, clear the check box.
Resetting Standard Toolbars To reset a standard toolbar: 1. In Classic view, from the iFIX WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, in the Settings list, click Toolbars. 2. 3. Click Customize. Select the toolbar you want to reset and click Reset. If the button is grayed out, the toolbar is supplied with iFIX.
Creating Toolbars The following sections provide steps on how to create and work with toolbars in the Proficy iFIX WorkSpace: Creating a Toolbar Deleting a Toolbar Modifying Toolbar Properties Editing the Script of a Toolbar Button
Creating a Toolbar To create a toolbar: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. 2. 3. 4. 5. 6. Click Customize. Click the Toolbars tab. Click Add Toolbar. Enter a name for the toolbar. Select the toolbars owner from the Owner list. If the owner you want does not appear: a. b. 7. 8. 9. Close the Customize Toolbars dialog box. Open a document of the associated type. For example, open a picture to select Picture as an owner.
Repeat steps 1 through 6. Add buttons to the toolbar. Edit each buttons script as needed.
160
Understanding iFix
Deleting a Toolbar To delete a toolbar: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. 2. 3. 4. Click Customize. Click the Toolbars tab. Select the owner of the toolbar you want to delete from the Owner list. If the owner you want does not appear: a. b. Close the Customize Toolbars dialog box. Open a document of the associated type. For example, open a picture to select Picture as an owner. Repeat steps 1 through 4.
c. 5. 6.
Modifying Toolbar Properties To modify a toolbars properties: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. 2. 3. 4. Click Customize. Click the Toolbars tab. Select the toolbars owner from the Owner list. If the owner you want does not appear: a. b. c. 5. 6. 7. Close the Customize Toolbars dialog box. Open a document of the associated type. For example, open a picture to select Picture as an owner. Repeat steps 1 through 4.
Select the toolbar you want to modify. Click Modify Properties. Change the toolbars name and owner as needed.
Editing the Script of a Toolbar Button To edit the script of a toolbar button:
161
Understanding iFix
1.
In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars.
2. 3. 4.
Click Customize. Double-click the button you want to modify from a toolbar or click the Buttons tab and double-click the button. Click Edit Script to open the Visual Basic Editor. Edit the buttons script with the VBE.
Creating Buttons The following sections provide steps on how to create button in the Proficy iFIX WorkSpace: Creating or Renaming a Category Deleting a Category Creating a Button Deleting a Button Modifying a Button's Properties Displaying a Toolbar Importing a Toolbar
Creating or Renaming a Category To create or rename a category: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. 2. 3. 4. Click Customize. Click the Buttons tab. Click Add Category or Rename Category and enter a category name. Category names can be up to 31 letters long. You cannot include numbers, a space, period (.), exclamation mark (!), or the characters @, &, $, # in the name. In addition, category names cannot match the name of any other toolbar, category, picture, schedule, or Dynamo set. NOTE: You can rename user-created categories only. Deleting a Category To delete a category: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click
162
Understanding iFix
Toolbars. 2. 3. 4. 5. Click Customize. Click the Buttons tab. Select the category you want to delete. Click Delete Category. NOTE: You can delete user-created categories only. Creating a Button To create a button: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab in the WorkSpace group, click Settings, and then click Toolbars. 2. 3. 4. 5. 6. Click Customize. Click the Buttons tab. Select the category you want to assign the button to. Click Add Button. Configure the button. NOTE: You can create buttons for user-created categories only. Deleting a Button To delete a button: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. 2. 3. 4. 5. 6. Click Customize. Click the Buttons tab. Select the category for the button you want to delete. Select the button and click Delete Button. Click OK when you are prompted to confirm the deletion. NOTE: You can delete buttons only from user-created categories. Modifying Button Properties To modify a buttons properties: 1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -Or-
163
Understanding iFix
In Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. 2. 3. 4. 5. 6. Click Customize. Click the Buttons tab. Select the category for the button you want to modify. Click Modify Button. Configure the button. NOTE: You can modify buttons only in user-created categories. Displaying a Toolbar To display a toolbar: 1. 2. 3. Open the iFIX Workspace. In the WorkSpace system tree, double-click the Project Toolbar Files folder, and then the Toolbars folder. Double-click the name of the toolbar you want to display. The toolbar should now display in the WorkSpace.
Importing a Toolbar To import a toolbar: 1. 2. Copy the toolbar file (.TBX) you want to import to the Local path of your computer. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars. -OrIn Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars. 3. 4. 5. 6. Click Customize. Click Import. From the Toolbars list box, select the file. From the Owner list, select the owner. If the owner you want does not appear: a. b. c. 7. Close the Customize Toolbars dialog box. Open a document of the associated type. For example, open a picture to select Picture as an owner. Repeat steps 1 through 6.
Click Import.
164
Understanding iFix
Adding or Modifying an OPC Server To add or modify an OPC server: 1. 2. 3. 4. 5. 6. On the Start menu, point to Programs, Proficy HMI SCADA - iFIX, Tools, and then Data Server Installer. Click Add or double-click the data server you want to modify. In the Data Server field, enter an OPC data source name. Make sure the name is not already in use. From the OPC server list, select an OPC driver. In the Machine Name field, enter the local or remote computer name where the OPC Server resides. Select the Set as Default Server check box to make the server the default. NOTE: You must have rights to write to the registry in order to perform this task. Deleting an OPC Server To delete an OPC server: 1. 2. 3. On the Start menu, point to Programs, Proficy HMI SCADA - iFIX, Tools, and then Data Server Installer. The Data Server Installer dialog box appears. Select the OPC server you want to delete. Click Remove. NOTE: You must have rights to write to the registry in order to perform this task. Troubleshooting OPC Server Installations You can add third-party OPC servers into iFIX by installing them with the Data Server Installer. The Data Server Installer can be accessed from the Start menu by pointing to Programs, Proficy HMI SCADA - iFIX, Tools, and then Data Server Installer. If you have difficulty accessing data from the OPC server, use the following steps to troubleshoot. To troubleshoot your OPC Server installation: 1. 2. 3. From the Start menu, select Run and enter Regedit. Open the key HKEY_CLASSES_ROOT\FIX32\DataSources. Ensure that each subkey in the DataSources folder represents an OPC server installed into iFIX, and that it contains the following:
(Default) = "DataSourceName" DefaultServer = 0 (1, if server is the default) OpcAccessPath = "" OpcDataSource = "AnyString"
165
Understanding iFix
For example, the subkey for the FIX OPC server appears as follows:
(Default) = "FIX32" DefaultServer = 1 OpcAccessPath = "" OpcDataSource = "Intellution OPC EDA Server" OpcProgID = "Intellution.OPCEDA" OpcServerMachineName = ""
Setting up DCOM Support in the WorkSpace To setup DCOM support in the WorkSpace: 1. If necessary, install the driver: a. b. c. d. 2. Insert the I/O Drivers and OPC Servers CD into your CD-ROM drive. The CD spins up and the Driver CD splash screen appears. Click the Install Driver button. Select the driver name from the menu. For example for the MBE driver, select MBE - Modbus Eithernet v7.x. Click the Install Now button.
Run the Data Server Installer. You can launch this application from the Start menu by pointing to Programs, Proficy HMI SCADA - iFIX, Tools, and then Data Server Installer. The Data Server Installer dialog box appears. Click Add to add an OPC server. The Add Server dialog box appears. Enter an OPC data source name in the Data Server field. For example, for the MBE driver, you might enter MBESOURCE in this field. Select the OPC server from the drop-down list in the OPC Server field. For example, for the MBE driver you would select Intellution.MBEOPC. In the Machine Name field, enter the local or remote computer name where the OPC Server resides. Click OK to save your changes. Configure the server from the iFIX program group. For example, for the MBE driver, select the MBE PowerTool option.
3. 4. 5. 6. 7. 8.
166
To learn more about the SCU, refer to the Setting up the Environment manual.
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.
167
Understanding iFix
168
Understanding iFix
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 [email protected] and enter j*com as your search string in the Find What field, the [email protected] 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: 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.
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:
169
Understanding iFix
* 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. 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-
170
Understanding iFix
FixScriptGlobal object. Refer to the Writing Scripts manual and the iFIX Automation Interfaces Help file for more information.
171
Understanding iFix
A Full Backup includes all of your iFIX files in the following folders: ALM path (*.*) APP path (*.*) HTR path (*.*) HTRDATA path (*.*) 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 browse (...) button 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, Tools, 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.
172
Understanding iFix
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.
173
Understanding iFix
Backup and Restore Wizard - Custom Backup 3. 4. 5. 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. 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,
174
Understanding iFix
\\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.
175
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. NOTE: The Include security files in archive option is not available for a Factory Default backup. 5. 6. 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 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. 7. Click the Finish button to begin archiving your selected files.
176
Understanding iFix
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.
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.
177
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.
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.
178
Understanding iFix
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. 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
179
Understanding iFix
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
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
180
Understanding iFix
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.
181
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.
/FactoryDefault /P
/P=UseINI
/A
182
Understanding iFix
Deletes all existing files under the selected project path before restoring a Custom or Full Backup file. Includes security files in the backup. 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.
/BackupSec /RestoreSec
/DelSec /S
/Y
/I
/?
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
183
Understanding iFix
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
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. 1 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.
184
Understanding iFix
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 Dynamo objects, 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.
185
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
186
Understanding iFix
HTR\ChartGroup3.csv
Local Files LOCAL\alarm.ini LOCAL\AnimationTasks.tbc LOCAL\Applications.tbc LOCAL\ApplicationToolbar.tbx LOCAL\ApplicationToolbar.xbt LOCAL\Association.dat LOCAL\BackupRestore.ini LOCAL\BuildDynamo.bmp LOCAL\CADToolbar.tbx LOCAL\CADToolbar.xbt LOCAL\CADTools.tbc LOCAL\ChartGroups.tbc LOCAL\ChartGroupToolbar.tbx LOCAL\ChartGroupToolbar.xbt LOCAL\CommandTasks.tbc LOCAL\CreateObjects.tbc LOCAL\CrossReference.ini LOCAL\CustomButton1.bmp LOCAL\CustomButton10.bmp LOCAL\CustomButton2.bmp LOCAL\CustomButton3.bmp LOCAL\CustomButton4.bmp LOCAL\CustomButton5.bmp LOCAL\CustomButton6.bmp LOCAL\CustomButton7.bmp LOCAL\CustomButton8.bmp
187
Understanding iFix
LOCAL\CustomButton9.bmp LOCAL\databasemanager.ini LOCAL\DatabaseTasks.tbc LOCAL\DataEntryTasks.tbc LOCAL\ddeclnt.ini LOCAL\default.fmt LOCAL\default.qry LOCAL\default.rft LOCAL\default.srt LOCAL\draw.ini LOCAL\dwnarrow.ico LOCAL\dwndwnarrow.ico LOCAL\DynamoToolbar.tbx LOCAL\DynamoToolbar.xbt LOCAL\DynamoTools.tbc LOCAL\Edit.tbx LOCAL\Edit.xbt LOCAL\Experts.tbx LOCAL\Experts.xbt LOCAL\filterederrors.ini LOCAL\FindReplace.csv LOCAL\fix.ini LOCAL\fixodbc.ini LOCAL\FixUserPreferences.ini LOCAL\FormatObjects.tbc LOCAL\Horn.ico LOCAL\htd.ini LOCAL\iFixScreenSaver.bmp LOCAL\iFIXSysMgmt.ini LOCAL\ImportToolbars.txt LOCAL\logmsg.tov LOCAL\NoHorn.ico
188
Understanding iFix
LOCAL\PictureExporter.tbc LOCAL\PictureTasks.tbc LOCAL\ProficyHistorian.tbx LOCAL\ProficyHistorian.xbt LOCAL\ProficyHistorianCat.tbc LOCAL\ReportTasks.tbc LOCAL\RestoreLog.txt LOCAL\Ribbon.ini LOCAL\SCADASync.ini LOCAL\Scheduler.tbc LOCAL\SECNET.ini LOCAL\SetupComServerApp.ini LOCAL\Shapes.tbx LOCAL\Shapes.xbt LOCAL\Standard.tbc LOCAL\StandardCategories.txt LOCAL\StandardToolbar.tbx LOCAL\StandardToolbar.xbt LOCAL\SystemTree.csv LOCAL\Toolbox.tbx LOCAL\Toolbox.xbt LOCAL\Tools.tbx LOCAL\Tools.xbt LOCAL\TranslationToolbar.tbx LOCAL\TranslationToolbar.xbt LOCAL\uparrow.ico LOCAL\upuparrow.ico LOCAL\Utilities.tbx LOCAL\Utilities.xbt LOCAL\view.ini LOCAL\VisiconXControls.tbc LOCAL\VisiconXToolbar.tbx
189
Understanding iFix
LOCAL\VisiconXToolbar.xbt
PDB Files PDB\aa61.tbl PDB\ai61.tbl PDB\ao61.tbl PDB\ar61.tbl PDB\bb61.tbl PDB\bl61.tbl PDB\ca61.tbl PDB\CGW.csv PDB\da61.tbl PDB\dc61.tbl PDB\Default.SM2 PDB\di61.tbl PDB\do61.tbl PDB\dr61.tbl PDB\dt61.tbl PDB\empty.pdb PDB\etr61.tbl PDB\etr73.tbl PDB\ev61.tbl PDB\fn61.tbl PDB\hs61.tbl PDB\ll61.tbl PDB\mdi61.tbl PDB\pa61.tbl PDB\pg61.tbl PDB\pid61.tbl PDB\rb61.tbl PDB\rm61.tbl PDB\sc61.tbl
190
Understanding iFix
PIC Files PIC\TagStatus PIC\3D_TEXT.SBL PIC\aa.bdf PIC\ai.bdf PIC\ao.bdf PIC\ar.bdf PIC\bb.bdf PIC\bl.bdf PIC\BORDERS.SBL PIC\BUNGEE.odt PIC\BUNGEE.SVA PIC\BUNGEE.VGA PIC\BUTTONS.SBL PIC\ca.bdf PIC\ChartGroupDemo.grf PIC\CHARTS1!.SBL PIC\CHARTS2!.SBL PIC\CHARTS3!.SBL PIC\CHARTS4!.SBL PIC\CHKBOX!.SBL PIC\CHKBOX2!.SBL PIC\da.bdf
191
Understanding iFix
PIC\di.bdf PIC\do.bdf PIC\dr.bdf PIC\draw.kmx PIC\dt.bdf PIC\DTALNK1!.SBL PIC\DTALNK2!.SBL PIC\etr.bdf PIC\ev.bdf PIC\EmergencyStopButtons.fds PIC\ExpertGlobal.fxg PIC\ExpertGlobals2.fxg PIC\FACEPLT!.SBL PIC\FactoryGlobals.fxg PIC\fn.bdf PIC\FREEFALL.odt PIC\FREEFALL.SVA PIC\FREEFALL.VGA PIC\GaugesHozizontalLarge.fds PIC\GaugesHozizontalMedium.fds PIC\GaugesHozizontalSmall.fds PIC\GaugesRoundLarge.fds PIC\GaugesRoundMedium.fds PIC\GaugesRoundSmall.fds PIC\GaugesVerticalLarge.fds PIC\GaugesVerticalMedium.fds PIC\GaugesVerticalSmall.fds PIC\HANGTEN.odt PIC\HANGTEN.SVA PIC\HANGTEN.VGA PIC\Historical.fds PIC\hs.bdf
192
Understanding iFix
PIC\INLINE.odt PIC\INLINE.SVA PIC\INLINE.VGA PIC\ISA-S55A.SBL PIC\ISA-S55B.SBL PIC\ISA-S55C.SBL PIC\ISA-S55D.SBL PIC\ISA-Y32A.SBL PIC\ISA-Y32B.SBL PIC\ISA-Y32C.SBL PIC\ISA-Y32D.SBL PIC\ISA-Y32E.SBL PIC\ISA-Y32F.SBL PIC\ISA-Y32G.SBL PIC\ISA-Y32H.SBL PIC\ISA-Y32I.SBL PIC\KEYPAD!.SBL PIC\ll.bdf PIC\LocalAsBackup.grf PIC\LocalAsPrimary.grf PIC\LUGE.odt PIC\LUGE.SVA PIC\LUGE.VGA PIC\mdi.bdf PIC\METERS!.SBL PIC\METERS2!.SBL PIC\Miscellaneous.fds PIC\MOTORS!.SBL PIC\Motors.fds PIC\MOTORS.SBL PIC\NetworkStatusDisplay.grf PIC\NetworkStatusOverview.grf
193
Understanding iFix
PIC\NetworkStatusRedundancyDisplay.grf PIC\on.bdf PIC\pa.bdf PIC\PanelButtonsLarge.fds PIC\PanelButtonsMedium.fds PIC\PanelButtonsSmall.fds PIC\PC_PLC.SBL PIC\pg.bdf PIC\pid.bdf PIC\PilotLightsLarge.fds PIC\PilotLightsMedium.fds PIC\PilotLightsSmall.fds PIC\Pipes.fds PIC\PIPES1.SBL PIC\PIPES2!.SBL PIC\PIPES2.SBL PIC\PIPES3!.SBL PIC\PIPES3.SBL PIC\PipesAnim.fds PIC\PlugandSolve.fxg PIC\PSHBTN1!.SBL PIC\PSHBTN2!.SBL PIC\PTV.odt PIC\PTV.SVA PIC\PTV.VGA PIC\PUMPS!.SBL PIC\Pumps.fds PIC\PumpsLarge.fds PIC\PumpsSmall.fds PIC\PUMPS.SBL PIC\PumpsAnim.fds PIC\RADIO!.SBL
194
Understanding iFix
PIC\RADIO2!.SBL PIC\rb.bdf PIC\rm.bdf PIC\ROWERS.SBL PIC\RUNTASK!.SBL PIC\sc.bdf PIC\sd.bdf PIC\Shades Of Blue.ftb PIC\Shades Of Cyan.ftb PIC\Shades Of Gray.ftb PIC\Shades Of Green.ftb PIC\Shades Of Magenta.ftb PIC\Shades Of Red.ftb PIC\Shades Of Yellow.ftb PIC\SHAPES.SBL PIC\SLIDERS!.SBL PIC\SPIKE.odt PIC\SPIKE.SVA PIC\SPIKE.VGA PIC\sqd.bdf PIC\sqt.bdf PIC\StorageTanksLarge.fds PIC\StorageTanksAnim.fds PIC\ss.bdf PIC\SwitchesLarge.fds PIC\SwitchesMedium.fds PIC\SwitchesSmall.fds PIC\System Default.ftb PIC\SYSTEM!.SBL PIC\TANKS!.SBL PIC\Tanks.fds PIC\TANKS.SBL
195
Understanding iFix
PIC\TanksAnim1.fds PIC\TanksAnim2.fds PIC\TICMARKS.SBL PIC\tm.bdf PIC\tr.bdf PIC\tt.bdf PIC\tx.bdf PIC\UpDownButtons.fds PIC\VALVES!.SBL PIC\Valves.fds PIC\VALVES.SBL PIC\ValvesAnim.fds PIC\ValvesISAHorizLarge.fds PIC\ValvesISAHorizSmall.fds PIC\ValvesISAVertLarge.fds PIC\ValvesISAVertSmall.fds PIC\VBARS!.SBL PIC\view.kmx PIC\WizLayouts.tpl PIC\TagStatus\Aa_TS.Grf PIC\TagStatus\AI_TS.grf PIC\TagStatus\AO_TS.Grf PIC\TagStatus\Ar_TS.Grf PIC\TagStatus\Bb_TS.Grf PIC\TagStatus\Bl_TS.Grf PIC\TagStatus\Ca_TS.Grf PIC\TagStatus\Da_TS.Grf PIC\TagStatus\DI_TS.Grf PIC\TagStatus\Do_TS.Grf PIC\TagStatus\Dr_TS.Grf PIC\TagStatus\Dt_TS.Grf PIC\TagStatus\Etr_TS.grf
196
Understanding iFix
PIC\TagStatus\Ev_TS.Grf PIC\TagStatus\Fn_TS.Grf PIC\TagStatus\Hs_TS.Grf PIC\TagStatus\Ll_TS.Grf PIC\TagStatus\Mdi_TS.grf PIC\TagStatus\Pa_TS.Grf PIC\TagStatus\Pg_TS.Grf PIC\TagStatus\Pid_TS.grf PIC\TagStatus\QuickTrend.grf PIC\TagStatus\Rb_TS.Grf PIC\TagStatus\Rm_TS.Grf PIC\TagStatus\Sc_TS.Grf PIC\TagStatus\Sd_TS.Grf PIC\TagStatus\Sqd_TS.grf PIC\TagStatus\Sqt_TS.grf PIC\TagStatus\Ss_TS.Grf PIC\TagStatus\TagControlPanel.grf PIC\TagStatus\Tm_TS.Grf PIC\TagStatus\Tr_TS.Grf PIC\TagStatus\TS.ini PIC\TagStatus\Tt_TS.Grf PIC\TagStatus\Tx_TS.Grf
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
197
Understanding iFix
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. 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
198
Understanding iFix
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=
199
Understanding iFix
; ;Database ASCII files (*.GDB), PDBPATH GDBIncludeExtn= GDBExcludeExtn= ; ;Driver Configuration Binary files (*.*), PDBPATH DrvIncludeExtn= DrvExcludeExtn= ; ;Database/Driver CSV files (*.CSV), PDBPATH 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=
200
Understanding iFix
; ;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=
201
Understanding iFix
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.
202
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.
203
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://support.gefanuc.com) if an Internet connection is available.
204
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.
205
Understanding iFix
4.
Click Display to display the topic in the right frame, or double-click the topic.
To find a topic using full-text search: 1. 2. 3. 4. 5. 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.
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")
206
Understanding iFix
207
Understanding iFix
2. 3. 4.
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.
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.
208
Understanding iFix
209
Understanding iFix
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.
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.
210
Understanding iFix
2. 3. 4.
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. 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.
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.
211
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.
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
212
Understanding iFix
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.
213
Understanding iFix
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.
214
Understanding iFix
NOTE: The historical chart used in the Water & Wastewater, Chemical, and Discrete demo and the Reports screen available to each demo are hard-coded in the English (United States) format. To ensure compatibility with your system, you must set your computer to also use the English format. You can check these settings in the Regional Options folder in the Control Panel. To add a pen, select an historical or real-time pen from one of the combo boxes, then click the appropriate Add Pen button. Alarms Picture This is the alarm summary screen for all of the industry samples. This screen is designed to show several features of GE Fanucs alarming including: Alarm Areas, Alarm Counters, and the Alarm Summary OCX. Alarm areas are a powerful way of filtering the alarms that an operator can see and acknowledge 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 Summary OCX (ActiveX control) is the grid that you are currently viewing, which allows you to filter and sort the alarms based on your preferences. In this sample system, we separate each of the four industries into four different alarm areas: Water & Wastewater, Batch Production, Discrete Manufacturing, and Pharmaceutical. Therefore, when you are in the Water & Wastewater demo, you only see alarms for that particular industry. Similarly, all of the alarm counters are also filtered based on the particular alarm area. As you change industries, notice how the same picture shows very different information. Reports Picture This is the main reporting screen for each industry demo. iFIX does not currently ship with a reporting package. You must have Crystal Report XI or Crystal Reports XI run-time files installed to view reports in iFIX. As such, the reports in this screen are simulated examples. All the reports use the iFIX ODBC drivers for historical data. If Crystal were installed with the Sample System, when you click the Display Report button, iFIX would build a simple ODBC query string that contained the tags and other parameters that you selected, and send it to the report. Crystal Reports would execute the query and print the report as an HTML file on the local hard disk. We then use a Microsoft Web Browser control (part of Internet Explorer) to display the HTML file. In addition, you can print the report to your default printer and export it to any one of several formats. All of these functions come from the Crystal Reports engine. Note also, that as with other portions of the system, only those tags that are relevant to a particular industry are available for you to execute a report. The historical chart used in the Water & Wastewater, Chemical, and Discrete demo and the Reports screen available to each demo are hard-coded in the English (United States) format. To ensure compatibility with your system, you must set your computer to also use the English format. You can check these settings in the Regional Options folder in the Control Panel.
215
Understanding iFix
database. When you start the production line (by switching to Auto), a set of Program Blocks (PG) in the process database take on the role of a PLC and write values to the AI and DI tags to simulate the process. As the tubes move down the assembly line, the total number of tubes produced and number of rejects updates automatically. In addition, all of the graphics are created using iFIX objects. No bitmaps are used in this picture. Trending Picture This screen is designed to show some of the power and flexibility of the iFIX trending object. One of its main features is the ability to display real-time process data, historical and archived data, and lab data from a file or database. You can customize most properties, from colors to scroll directions, in either configure or run-time environment. Note also, that as with the Alarms picture, only those realtime and historical tags that pertain to the particular industry you are in are available. NOTE: The historical chart used in the Water & Wastewater, Chemical, and Discrete demo and the Reports screen available to each demo are hard-coded in the English (United States) format. To ensure compatibility with your system, you must set your computer to also use the English format. You can check these settings in the Regional Options folder in the Control Panel. To add a pen, select an historical or real-time pen from one of the combo boxes, then click the appropriate Add Pen button. Alarms Picture This is the alarm summary screen for all of the industry samples. This screen is designed to show several features of GE Fanucs alarming including: Alarm Areas, Alarm Counters, and the Alarm Summary OCX. Alarm areas are a powerful way of filtering the alarms that an operator can see and acknowledge 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 Summary OCX (ActiveX control) is the grid that you are currently viewing, which allows you to filter and sort the alarms based on your preferences. In this sample system, we separate each of the four industries into four different alarm areas: Water & Wastewater, Batch Production, Discrete Manufacturing, and Pharmaceutical. Therefore, when you are in the Water & Wastewater demo, you only see alarms for that particular industry. Similarly, all of the alarm counters are also filtered based on the particular alarm area. As you change industries, notice how the same picture shows very different information. Reports Picture This is the main reporting screen for each industry demo. iFIX does not currently ship with a reporting package. You must have Crystal Report XI or Crystal Reports XI run-time files installed to view reports in iFIX. As such, the reports in this screen are simulated examples. All the reports use the iFIX ODBC drivers for historical data. If Crystal were installed with the Sample System, when you click the Display Report button, iFIX would build a simple ODBC query string that contained the tags and other parameters that you selected, and send it to the report. Crystal Reports would execute the query and print the report as an HTML file on the local hard disk. We then use a Microsoft Web Browser control (part of Internet Explorer) to display the HTML file. In addition, you can print the report to your default printer and export it to any one of several formats. All of these functions come from the Crystal Reports engine. Note also, that as with other portions of the system, only those tags that are relevant to a particular industry are available for you to execute a report.
216
Understanding iFix
The historical chart used in the Water & Wastewater, Chemical, and Discrete demo and the Reports screen available to each demo are hard-coded in the English (United States) format. To ensure compatibility with your system, you must set your computer to also use the English format. You can check these settings in the Regional Options folder in the Control Panel.
217
Understanding iFix
click the Commit button, the data controls write the new value to the database and re-calculate the production totals using standard SQL (Structured Query Language) commands. As you select different products, note that the 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. CIP Picture 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 iFIX real-time process database. The SQT and SQD blocks (which were not included with the sample system) automatically inserted the records as the CIP took place. By selecting a different CIP route, you can see the usage summary, batches produced, CIP supplier information and statistics update. All the data is returned and evaluated using VisiconX data controls with no scripting. This works because all of the data controls are linked together so that as one updates, any dependent controls automatically re-query the database to get the latest information. Alarm History Picture This picture demonstrates two of GE Fanucs technologies: the Alarm ODBC driver and VisiconX. The Alarm ODBC driver is a service that sends all alarms and system events to a relational database such as SQL Server or Oracle. This picture uses two VisiconX data controls to let you select the alarms for either all the tags or a specific tag based on your selection in the drop down combo box. This is done automatically without the use of scripts or code in the background. Reports Picture This is the main reporting screen for each industry demo. iFIX does not currently ship with a reporting package. You must have Crystal Report XI or Crystal Reports XI run-time files installed to view reports in iFIX. As such, the reports in this screen are simulated examples. All the reports use the iFIX ODBC drivers for historical data. If Crystal were installed with the Sample System, when you click the Display Report button, iFIX would build a simple ODBC query string that contained the tags and other parameters that you selected, and send it to the report. Crystal Reports would execute the query and print the report as an HTML file on the local hard disk. We then use a Microsoft Web Browser control (part of Internet Explorer) to display the HTML file. In addition, you can print the report to your default printer and export it to any one of several formats. All of these functions come from the Crystal Reports engine. Note also, that as with other portions of the system, only those tags that are relevant to a particular industry are available for you to execute a report. The historical chart used in the Water & Wastewater, Chemical, and Discrete demo and the Reports screen available to each demo are hard-coded in the English (United States) format. To ensure compatibility with your system, you must set your computer to also use the English format. You can check these settings in the Regional Options folder in the Control Panel.
218
Understanding iFix
eight positions, or states: State 1 State Name Ready to Change At Base State Description Mixing bowl off screen. Enabled Change Mixing Bowl
Remove Mixing Bowl Load Mixing Bowl Unload Mixing Bowl Start (requires two electronic signatures). Cut Away
Stopped
Running
Changing
Mixing bowl moving right-toleft, to base of mixer. Mixing bowl rising from base of mixer to mixing position. Mixing bowl lowering from mixing position to base of mixer. Mixing bowl moving left-toright, from base of mixer.
None
Raising
None
Lowering
None
Removing
None
All graphic animations are executed in program blocks and are based on the state of the mixing bowl. The mixing bowl state controls which buttons are enabled and the text on the buttons. Changing the temperature set point requires a performed by electronic signature for the current mixer. Starting and stopping the mixing operation requires both a performed by and a verified by electronic signature for the current mixer. Acknowledging alarms in the Pharm_process alarm group also requires an electronic signature. You can view valid user names and passwords by clicking the Users button in the upper right corner of the screen picture. This displays a picture with the always on top attribute set, which enables you to refer to the information in the picture, as needed, when performing tasks that use electronic signatures. The requirement for electronic signatures is enabled at the tag level using the database manager application. This ensures that all pictures writing to the tag, regardless of node, require the operator to enter an electronic signature.
219
Understanding iFix
User Security Matrix Picture Be aware that to access this picture, you must click the Users button. The Users button is only available when the High Sheer Mixer picture is open in the demo (in run mode). The User Security Matrix picture shows a list of users and their corresponding security areas and application feature privileges. This picture is configured as always on top so you can refer to it when using electronic signatures in the pharmaceutical portion of the demo. The username consists of the persons first initial and last name; the password is the first and last initial. Alarms Picture This is the alarm summary screen for all of the industry samples. This screen is designed to show several features of GE Fanucs alarming including: Alarm Areas, Alarm Counters, and the Alarm Summary OCX. Alarm areas are a powerful way of filtering the alarms that an operator can see and acknowledge 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 Summary OCX (ActiveX control) is the grid that you are currently viewing, which allows you to filter and sort the alarms based on your preferences. In this sample system, we separate each of the four industries into four different alarm areas: Water & Wastewater, Batch Production, Discrete Manufacturing, and Pharmaceutical. Therefore, when you are in the Water & Wastewater demo, you only see alarms for that particular industry. Similarly, all of the alarm counters are also filtered based on the particular alarm area. As you change industries, notice how the same picture shows very different information. NOTE: In order to acknowledge alarms within the Pharmaceutical industry will require the user to enter an e-signature. Audit Trail View Picture This picture shows an audit trail containing electronic signature data. This information is based on two of GE Fanucs technologies: Alarm ODBC driver and VisiconX. The Alarm ODBC driver is an easyto-configure service that sends all signed operator actions to a relational database, such as Microsofts SQL Server or Oracle. These actions include set point changes, start/stop actions, and alarm acknowledgements in the pharmaceutical process area that each requires electronic signatures. The operators full name and optional comment, and the supervisors full name and optional comment are some of the fields that are stored in the record sent to the relational database. Based on which option button you select (Users or Batch ID), a script changes the query for the criteria VisiconX object. This filtered data then displays in a VisiconX list box without the use of scripting. When you select an item from the list box, its associated audit trail messages display in the corresponding VisiconX grid at the bottom of the picture. Reports Picture This is the main reporting screen for each industry demo. iFIX does not currently ship with a reporting package. You must have Crystal Report XI or Crystal Reports XI run-time files installed to view reports in iFIX. As such, the reports in this screen are simulated examples. All the reports use the iFIX ODBC drivers for historical data. If Crystal were installed with the Sample System, when you click the Display Report button, iFIX would build a simple ODBC query string that contained the tags and other parameters that you selected, and send it to the report. Crystal Reports would execute the query and print the report as an HTML file on the local hard disk. We then use a Microsoft Web Browser control (part of Internet Explorer) to display the HTML file. In addition, you can print the report to your default printer and export it to any one of several formats.
220
Understanding iFix
All of these functions come from the Crystal Reports engine. Note also, that as with other portions of the system, only those tags that are relevant to a particular industry are available for you to execute a report.
221
Understanding iFix
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.
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 the browse (...) 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.
222
Understanding iFix
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
223
Understanding iFix
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. 3. 4. 5. 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. 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 browse (...) 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 browse (...) 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 browse (...) button, then click the object or grid.
224
Understanding iFix
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 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 browse (...) button, then click the object or grid.
The current state of the mixer displays and changes as you use these controls. Modifying Temperatures The mixer temperature controls featured in this demo allow you to change the temperature setpoint using any of these Experts: Data Entry
225
Understanding iFix
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 Mixer 1 Application Feature(s)
GCLARK
GC
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
PSMITH
PS
LJONES
LJ
Mixer 2
226
Understanding iFix
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.
227
Understanding iFix
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.
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. 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.
228
Understanding iFix
Manipulate the grid like this... 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 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 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.
229
Understanding iFix
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 right-click 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 the browse (...) 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. 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.
230
Index
A acknowledging alarms signing for alarms in the Pharmaceutical demo ....................................................... 227 ActiveX in iFIX ............................................................ 6 integrating documents .................................. 27 support .......................................................... 10 ActiveX controls iFIX as a container.......................................... 6 in iFIX ............................................................ 5 adding buttons to a toolbar ....................................... 54 toolbar buttons to a category ........................ 56 toolbar categories.......................................... 56 adding a button to a category .......................... 163 adding a button to a toolbar ............................ 159 adding a category............................................ 162 adding an OPC server ..................................... 165 alarm areas, defined .......................................... 17 alarm areas ........................................................ 17 alarming as a system function...................................... 22 in iFIX .......................................................... 16 alarms routing .......................................................... 17 tasks .............................................................. 16 types ............................................................. 17 alarms and alarm counters, exploring in Sample System ........................................... 229 application functions ....................................................... 25 starting .......................................................... 49 toolbar .......................................................... 52 applying a filter to the tag list .........................145 architecture open ............................................................. 24 system ............................................................ 8 archiving data .................................................148 arranging, toolbar buttons ................................ 54 arranging buttons on a toolbar ........................159 audit trail, viewing from a relational database in the Pharmaceutical demo .........227 automatic save ................................................128 automatically open pictures ............................127 B backing up data ...............................................148 backup and restore ..........................................171 Backup and Restore Wizard ...........................148 backup files Backup and Restore Wizard .......................171 saving........................................................... 75 blind SCADA server .......................................... 9 block alarms, defined ....................................... 17 block messages ................................................ 17 blocks chains ........................................................... 11 primary ........................................................ 11 secondary ..................................................... 11 browsing the process database ........................142 building an expression ....................................143 buttons configuring .................................................. 56 creating for toolbars ..................................... 56 deleting from a category .............................. 56 modifying .................................................... 56
231
Understanding iFix
modifying properties .................................... 56 C categories ........................................................ 163 centralized processing ...................................... 15 chains ................................................................ 11 Change Management ...................................... 146 changing paths ................................................ 145 chart preferences............................................. 140 charts, setting preferences ................................ 75 Chemical demo exploring picture layers .............................. 223 exploring ToolTips ..................................... 223 exploring VisiconX .................................... 224 overview ..................................................... 223 closing folders ................................................ 124 COM ................................................................... 5 command line parameters for WorkSpace ........ 28 communicating to a remote OPC server from the WorkSpace ................................... 166 Component Object Model (COM) ...................... 5 components, iFIX ............................................... 3 components......................................................... 3 configuration environment, described .............. 50 configuration environment ................................. 3 configure mode, using in Sample System....... 213 configuring buttons .......................................................... 56 electronic books .......................................... 204 run-time preferences ..................................... 76 the picture path ........................................... 168 your local computer .................................... 167 control............................................................... 23 copying, toolbar categories ............................... 56 copying an object, electronic books ............... 208 copying an object............................................ 125 Create New Picture wizard ............................. 126 creating
dynamo sets ................................................. 52 new document .............................................. 52 new pictures ................................................. 52 new schedules .............................................. 52 toolbar buttons ............................................. 56 toolbar categories ......................................... 56 toolbars ........................................................ 55 creating a Dynamo set ....................................126 creating a new file...........................................126 creating a new picture .....................................126 creating a new schedule ..................................126 creating a toolbar ............................................160 creating backup copies....................................140 creating files ...................................................126 Crystal Reports, using with iFIX ..................... 24 D data accessing ...................................................... 10 archiving ...................................................... 23 flow .............................................................. 11 retrieving...................................................... 21 Data Server Installer .......................................... 5 data sources, defined........................................ 10 data transfer on demand ................................... 15 database control strategies ............................... 11 DCOM ............................................................... 6 DDE ................................................................. 10 deadband .........................................................144 defining the active iBatch project ...................150 deleting buttons from a category ............................... 56 document from the system tree .................... 52 toolbar categories ......................................... 56 toolbars ........................................................ 55 deleting a button from a category ...................163 deleting a category ..........................................162 deleting a toolbar ............................................161
232
Understanding iFix
deleting an OPC server ................................... 165 deleting files ................................................... 128 disabling error dialog boxes ......................................... 50 Proficy Historian errors ................................ 51 disabling environment protection ................... 131 disabling toolbar docking ............................... 159 Discrete Manufacturing Demo, overview....... 221 Discrete Manufacturing Demo ....................... 215 display the WorkSpace full-screen ................. 141 displaying, system tree path ............................. 46 displaying a system tree path .......................... 124 displaying the Visual Basic Editor ................. 129 distributed processing ....................................... 14 docking ........................................................... 159 documents creating ......................................................... 52 integrating with iFIX from other programs ................................................... 27 opening ......................................................... 52 saving ........................................................... 52 working with................................................. 52 drawing options, setting preferences ................75 drawing preferences........................................ 140 dropping and dragging objects ....................... 125 dynamic connection .......................................... 14 Dynamic Data Exchange (DDE) ...................... 10 dynamo sets, creating ....................................... 52 E editing the script of a toolbar button ............... 161 electronic books accessing information ................................. 203 buttons ........................................................ 203 changing the color of search hits ................ 209 Contents tab ................................................ 204 copying and pasting text ............................. 208 display options ............................................ 208
features .......................................................203 Index tab .....................................................205 Locate button ..............................................207 printing .......................................................207 Search tab ...................................................205 enabling environment protection ....................131 enabling picture caching .................................139 enabling toolbar docking ................................159 environment protection ...................................131 environments changing the start-up ................................... 76 configuration................................................ 50 described ...................................................... 50 run-time ....................................................... 50 switching between ....................................... 50 exception-based processing ............................. 13 Experts and the Task Wizard .................................... 57 using signing in the Pharmaceutical demo..227 exploring Trending .........................................228 expression builder ...........................................142 expressions .....................................................143 F file server, using to share files among nodes ..167 file server ........................................................167 files backing up and restoring .............................171 saving backup .............................................. 75 sharing ......................................................... 15 sharing among nodes ..................................167 storing .......................................................... 15 filtering data sources.......................................143 finding data .....................................................148 folders .............................................................124 full screen .......................................................141 G globally translating picture text ......................138
233
Understanding iFix
H hiding the system tree ..................................... 124 hiding toolbars ................................................ 158 HMI, functions ................................................. 22 HMI .................................................................. 22 I I/O drivers, using the OPC Toolkit ................... 10 I/O drivers ........................................................ 21 iBatch ............................................................. 150 iClient components ..................................................... 3 enabling technologies ..................................... 5 enabling technologies, ActiveX ...................... 5 enabling technologies, OPC ........................... 5 plug-in components ........................................ 4 iClient ................................................................. 9 importing ........................................................ 164 importing a toolbar, electronic books ............. 205 importing a toolbar ......................................... 164 Internet, iWebServer........................................... 4 iVisualize, working with iFIX ............................ 4 iWebServer, working with iFIX ......................... 4 K keyboard, virtual ............................................... 33 keyless entry ..................................................... 33 L local node ........................................................... 9 Locate button .................................................. 207 login, security ................................................... 19 M message routing .......................................................... 18 types ............................................................. 17 modifying, button properties ............................ 56 modifying a buttons properties ....................... 163 modifying a toolbars properties ...................... 161 modifying an OPC server ............................... 165
monitoring ....................................................... 22 moving an object ............................................125 N navigating through the Sample System demos..........................................................214 networking ....................................................... 14 nodes blind SCADA server ...................................... 9 iClient ............................................................ 9 local ............................................................... 9 remote ............................................................ 9 run-time ......................................................... 9 SCADA server ............................................... 9 stand alone ..................................................... 9 nodes .................................................................. 8 O ODBC .............................................................. 10 OLE, using to access data ................................ 10 OLE ................................................................. 10 OLE for Process Control (OPC) ........................ 5 on-demand data transfer .................................. 15 one-shot processing ......................................... 13 OPC, using with iFIX ........................................ 5 OPC ................................................................165 opc connection ................................................144 OPC connections ............................................142 OPC error preferences ....................................142 OPC server, customizing error strings ............. 76 OPC server......................................................165 OPC Toolkit..................................................... 10 open architecture.............................................. 24 Open Database Connectivity (ODBC) ............. 10 opening, document........................................... 52 opening backup files .......................................127 opening files ...................................................127 opening folders ...............................................124 operator messages ............................................ 17
234
Understanding iFix
overview Chemical demo ........................................... 223 Discrete Manufacturing demo .................... 221 of sample system ........................................ 209 Pharmaceutical demo.................................. 225 Water & Wastewater demo......................... 221 P passwords, entering .......................................... 33 paths, specifying network path as iFIX path .. 167 Pharmaceutical demo overview ..................................................... 225 signing when acknowledging alarms .......... 227 signing when starting and stopping the mixer....................................................... 226 signing when using an Expert ..................... 227 viewing the audit trail from a relational database .................................................. 227 Pharmaceutical Manufacturing Demo ............ 218 picture caching ............................................... 139 picture layers exploring in the Chemical demo ................. 223 exploring in the Water & Wastewater demo ....................................................... 223 picture preferences.......................................... 138 picture text, translating ................................... 138 pictures creating ......................................................... 52 setting preferences ........................................ 75 pictures ........................................................... 148 plug-in components, iFIX ................................... 4 pop-up window ................................................. 28 preferences animation error ............................................. 76 charts ............................................................ 75 configuring run-time ..................................... 76 drawing options ............................................ 75 pictures ......................................................... 75 saving backup files ....................................... 75
setting in WorkSpace ................................... 75 shapes .......................................................... 75 start-up environment .................................... 76 primary blocks, electronic books ....................207 primary blocks ................................................. 11 process data flow ............................................. 11 process database .............................................. 11 process databases ............................................142 processing centralized.................................................... 15 distributed .................................................... 14 exception-based ........................................... 13 one-shot ....................................................... 13 time-based.................................................... 13 Proficy Batch Execution specifying a project .....................................201 working with iFIX ......................................... 4 Proficy Historian disabling errors ............................................ 51 working with iFIX ......................................... 4 Proficy iFIX WorkSpace ................................... 3 Proficy Machine Edition .................................... 4 Proficy Plant Applications, working with iFIX ............................................................... 4 Proficy Real-Time Information Portal ............... 4 R refresh rate ......................................................144 remote node ....................................................... 9 removing, toolbar buttons ................................ 54 removing a button to a toolbar ........................159 renaming document in the system tree ........................ 52 toolbar categories ......................................... 56 renaming a category........................................162 renaming files .................................................128 replacing data..................................................148 reporting .......................................................... 24
235
Understanding iFix
resetting a standard toolbar ............................. 160 resetting filters ................................................ 145 restoring, files ................................................. 171 run mode, using in the Sample System........... 213 running Experts .............................................. 129 running schedules in the background ............. 141 run-time environment configuring preferences ................................ 76 described....................................................... 50 run-time environment ..................................... 130 run-time node ..................................................... 9 run-time preferences ....................................... 141 S SAC .................................................................. 12 Sample System accessing other desktop applications .......... 212 exploring alarms and alarm counters .......... 229 exploring ToolTips ..................................... 223 exploring trending ...................................... 228 exploring VisiconX .................................... 224 features demonstrated ................................. 209 main menu .................................................. 211 overview ..................................................... 209 requirements ............................................... 210 restrictions .................................................. 210 starting ........................................................ 211 user account requirement ............................ 210 using configure and run modes ................... 213 using Help................................................... 212 using with a Terminal Server...................... 210 Sample System demos navigating ................................................... 214 understanding the alarm summary, Trending chart and reporting screens ..... 213 working with............................................... 213 Sample System Help displaying ToolTips .................................... 212
getting Help for an object or picture ...........212 save preferences..............................................140 saving backup files .................................................. 75 document ..................................................... 52 saving backup files .........................................140 saving files ......................................................128 saving files automatically ...............................128 SCADA server, functions ................................ 22 SCADA server ................................................... 9 Scan, Alarm, and Control program .................. 12 Scheduler ......................................................... 13 schedules, creating ........................................... 52 schedules.........................................................148 scripting in iFIX ........................................................... 5 using VBA ..................................................... 5 scripts..............................................................161 SCU configuring your local computer ................167 path definitions for system tree.................... 46 starting ........................................................167 SCU ................................................................145 Search tab electronic books ..........................................205 searching data .................................................148 secondary blocks.............................................. 11 secure containment ............................................ 5 security areas ............................................................. 18 configuration................................................ 19 login ............................................................. 19 security ............................................................ 18 selecting a data source ....................................142 sessions ............................................................ 14 setting chart preferences .................................140 setting drawing preferences ............................140
236
Understanding iFix
setting OPC connection error preferences ...... 142 setting picture preferences .............................. 138 setting preferences, WorkSpace ....................... 75 setting shape preferences ................................ 139 setting up DCOM support in the WorkSpace . 166 shape preferences ........................................... 139 shapes, setting preferences ............................... 75 sharing, files among nodes ............................. 167 sharing files .................................................... 145 showing the system tree.................................. 124 showing toolbars............................................. 158 sorting fields in the tag list ............................. 144 Specialty Chemical Demo .............................. 217 specify the tolerance ....................................... 144 specifying, network path as iFIX path ............ 167 specifying the deadband ................................. 144 specifying the refresh rate .............................. 144 SQL .................................................................. 10 stand alone node ................................................. 9 starting and stopping the mixer, signing in the Pharmaceutical demo ............................ 226 starting iFIX applications ............................... 129 starting in the configuration environment....... 131 starting in the run-time environment .............. 130 starting sample system.................................... 211 start-up, changing the environment .................. 76 Structured Query Language .............................. 10 supervisory control ........................................... 22 switching, between WorkSpace environments ................................................ 50 switching environments .................................. 130 system applications........................................... 26 system messages ............................................... 17 system tree described....................................................... 32 displaying the path ........................................ 46 dragging and dragging files .......................... 49 hierarchy ....................................................... 44
item description ........................................... 44 navigating .................................................... 47 paths............................................................. 46 resizing ........................................................ 46 right-clicking ............................................... 49 showing and hiding ...................................... 46 starting an application .................................. 49 system tree ......................................................124 T tag groups, exploring in the Water & Wastewater demo .......................................222 tag list .............................................................145 Task Wizard....................................................129 Terminal Server, using with Sample System ..210 time-based processing...................................... 13 tolerance .........................................................144 toolbar buttons ................................................159 toolbar categories adding .......................................................... 56 adding buttons ............................................. 56 copying ........................................................ 56 defined ......................................................... 54 deleting ........................................................ 56 renaming ...................................................... 56 toolbar categories............................................163 toolbars adding buttons ............................................. 54 adding categories ......................................... 56 application ................................................... 52 arranging buttons ......................................... 54 configuring buttons ...................................... 56 copying categories ....................................... 56 creating ........................................................ 55 creating buttons............................................ 56 customizing.................................................. 54 deleting ........................................................ 55 deleting buttons from a category ................. 56
237
Understanding iFix
deleting categories ........................................ 56 importing ...................................................... 56 modifying a button's properties .................... 56 modifying properties .................................... 55 owners .......................................................... 54 removing buttons .......................................... 54 renaming categories ...................................... 56 resetting ........................................................ 54 sharing .......................................................... 56 showing and hiding....................................... 54 utilities .......................................................... 52 WorkSpace ................................................... 52 toolbars ........................................................... 159 ToolTips, exploring in the Chemical demo .... 223 touch-screen environment ................................ 33 translating picture text globally ...................... 138 translations...................................................... 138 trending, exploring in Sample System ............ 228 troubleshooting OPC server installations ....... 165 U Universal Data Access...................................... 10 user applications ............................................... 26 user configuration applications ......................... 25 using configure and run modes in sample system ......................................................... 213 using Help in Sample System ......................... 212 utilities toolbar .................................................. 52 V VBA using the Visual Basic Editor ....................... 27 using with iFIX ............................................... 5 writing scripts ............................................... 77 VBA ................................................................... 5 VBE .................................................................... 5 virtual keyboard ................................................ 33
VisiconX, exploring in the Chemical demo....224 Visual Basic Editor described ...................................................... 27 displaying .................................................... 77 Visual Basic Editor .........................................129 Visual Basic Editor (VBE) ................................ 5 Visual Basic for Applications (VBA) ................ 5 W Water & Wastewater Demo exploring picture layers ..............................223 exploring pop-up pictures ...........................222 exploring tag groups ...................................222 overview .....................................................221 Water & Wastewater Demo ............................214 work area, described ........................................ 33 WorkSpace configuring run-time preferences................. 76 copying objects ............................................ 49 customizing toolbars .................................... 54 described ...................................................... 27 displaying full screen ................................... 50 enabling environment protection ................. 50 iFIX ............................................................... 3 moving objects............................................. 49 saving backup files ...................................... 75 setting animation error preferences.............. 76 setting user preferences................................ 75 specifying an iBatch project .......................201 starting ......................................................... 27 starting an application .................................. 49 start-up options ............................................ 76 system tree ................................................... 32 toolbar .......................................................... 52 working with documents.............................. 52 WorkSpace command line parameters ............ 28
238