Understanding iFIX
Understanding iFIX
Understanding iFIX
iFIX 2022
Understanding iFIX
No part of this publication may be reproduced in any form, or stored in a database or retrieval system, or transmitted or distributed in any
form by any means, electronic, mechanical photocopying, recording or otherwise, without the prior written permission of General Electric
Company. Information contained herein is subject to change without notice.
Trademark Notices
GE, the GE Monogram, and Predix are either registered trademarks or trademarks of General Electric Company.
Microsoft® is a registered trademark of Microsoft Corporation, in the United States and/or other countries.
We want to hear from you. If you have any comments, questions, or suggestions about our documentation, send them to the following email
address:
doc@ge.com
Table of Contents
Understanding iFIX 1
Reference Documents 1
Introduction to iFIX 1
iFIX Components 1
Proficy Historian 2
GE Batch Execution 2
GE Plant Applications 3
Enabling Technologies 3
ActiveX 4
System Architecture 5
Nodes in iFIX 6
I/O Drivers 8
Data Flow 8
Process Database 9
Time-Based Processing 11
Exception-Based Processing 11
One-Shot Processing 11
Scheduler 11
Distributed Networking 12
Distributed Processing 12
Dynamic Connections 13
Centralized Processing 14
Alarming 14
Alarm Routing 15
Security 16
Security Areas 16
Security Application 17
Security Configuration 17
Login 18
In Configure Mode 19
In Run Mode 20
Example 22
Examples 36
Opening Documents 36
Understanding Toolbars 37
Customizing Toolbars 39
Docking Toolbars 39
Resetting Toolbars 39
Creating Toolbars 39
Creating Buttons 40
Modifying Buttons 41
Ribbon Structure 53
Understanding KeyTips 56
Configuration in iFIX 61
Data Server 62
OPC Server 62
Machine Name 62
Preview 62
Category 62
Name 62
Description 62
Screentip 63
Edit Script 63
Set Default 64
Add Server 64
Modify 64
Delete 64
Alias Name 64
Server Name 64
User Name 64
Password 64
Close 64
Get Collectors 64
Toolbars Tab 65
Buttons Tab 65
Data Servers 66
OPC Server 66
Machine Name 66
Add 66
Remove 66
Modify 66
Find Tab 74
Replace Tab 74
Select Project 75
Project Destination 75
Get Options 75
SCU File 76
Base Path 76
Project Path 76
Toolbars Box 76
Owner 76
Import 76
Data Server 76
OPC Server 76
Machine Name 76
Configured Actions 77
Backup Type 78
Custom Backup 78
Full Backup 78
Page 1 79
Page 2 79
Task Categories 80
Tasks 80
Perform Task 80
Owner 80
Toolbars 81
Customize 81
WorkSpace Options 81
Color 86
Font 86
General 86
Pipe 87
Properties 87
Picture Translation 88
Window Properties 88
Gradient 89
Thumbnail 89
Cache 89
Scroll Direction 89
Time Axis 90
Value Axis 90
General 90
Graphics Connections 91
Other Options 92
New Button 93
Delete Button 93
Move Up Button 93
New Button 93
Delete Button 93
Move Up Button 93
Logon Info 94
SSL Security 96
Export Configuration 96
Viewing Thumbnails 98
Creating Files 98
Opening Files 99
To start the Visual Basic Editor from the iFIX WorkSpace: 102
To switch between the configuration environment and the run-time environments: 104
Setting the Display Options for the Ribbon in Run Mode 105
Disabling the Ribbon Auto Hide Feature in Full Screen Run Mode 105
To disable the Ribbon auto hide feature in full screen run mode: 105
To enable the Ribbon auto hide feature in full screen run mode: 105
To remove commands from the Quick Access toolbar (method 1): 109
To remove commands from the Quick Access toolbar (method 2): 109
To remove commands from the Quick Access toolbar (method 3): 109
Getting a Different iFIX Project from the Change Management Server 121
To get a different iFIX project from the Change Management Server: 122
To create a common Historian Server configuration (also known as global Historian ali-
asing): 128
Monitoring 143
Alarming 144
Control 144
Reports 145
Examples 164
Copying and Pasting Text from an Electronic Book to Another Application 182
Index 183
The Understanding iFIX manual is intended for all iFIX® users. It provides an overview of the structure
and functions of iFIX, the iFIX WorkSpace, and the iFIX Help and electronic books.
Reference Documents
For related information on subjects discussed in this manual, refer to the following documents:
Introduction to iFIX
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 pic-
tures that operators can use to monitor your process.
l For information on the structure and capability of iFIX, refer to the System Architecture and the
System Functions chapters.
l For information on the iFIX WorkSpace, refer to the Using the iFIX WorkSpace chapter.
l For information on managing your nodes, refer to the Managing iFIX Nodes chapter.
l For information on the electronic books, refer to the Using the Electronic Books chapter.
iFIX Components
iFIX Platform
An important component of iFIX is the iFIX WorkSpace. This interface organizes all system components
into one integrated development environment (IDE). The iFIX WorkSpace allows you to navigate through,
access, and manipulate all the components of your system.
The 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 envir-
onment 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 alarm-
ing 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 iFIX WorkSpace, refer to the Creating Pictures manual.
iFIX works with the following GE software applications, as well as many third-party applications.
Proficy Historian
Proficy Historian is a high performance data archiving system designed to collect, store, and retrieve
time-based information efficiently.
GE Batch Execution
GE Batch Execution is the high-performance automation application that lets you model your plant, man-
age recipes, execute batches, create electronic batch records, and generate reports based on any batch
GE Plant Applications
Equipment use and downtime are typically tracked and reported as key performance indicators in man-
ufacturing companies. GE Plant Applications allows you to accurately report equipment efficiency, and
extends your ability to analyze, understand, and address each source of downtime.
The 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 incor-
porated the following industry-standard technologies into iFIX to provide a development environment
that you can tailor to meet your specific requirements:
OPC is a software standard designed to provide automation applications with easy access to industrial
plant floor data. We have led the development of OPC through our active role in the founding of the OPC
Task Force, a consortium of leading industrial automation suppliers formed to speed the development of
an OLE-based communication standard. The goal of OPC is to define a standard interface based on
Microsoft's Component Object Model (COM) technology that allows greater interoperability between
automation and control applications; control devices; and business and office applications.
Using OPC, the iFIX WorkSpace can communicate directly with any OPC server. You can add an OPC
server to your iFIX node using the Data Server Installer program. This utility, located in the Tools sub-
folder of your iFIX Windows program folder, lets you add, modify, and remove OPC servers from the list of
data servers available to iFIX. For more information about the Data Server Installer, refer to the Data
Server Installer Dialog Box topic.
If you need to communicate with a remote OPC server, specify the machine where the remote server
resides in the Machine Name field when you add an OPC Server using the Data Server Installer. Altern-
atively, you can also use the OPC Client driver to communicate with a remote OPC server. This driver lets
you communicate with any local or remote OPC server and store the information in the process data-
base.
VBA is a powerful scripting tool that is fully integrated into iFIX to let you quickly and easily automate
operator tasks and create automation solutions. VBA scripts can be as simple or complex as you need
them to be, allowing you to add custom functionality and extend iFIX as needed to accommodate your
automation strategy. Its powerful and easy-to-use development environment allows you to reuse exist-
ing Visual Basic code.
VBA replaces the scripting engine used in previous versions of FIX to provide a complete, integrated devel-
opment environment that is familiar to millions of developers already using Visual Basic. It provides vir-
tually unlimited power and extensibility for accessing other iFIX components and external objects and
data. The GE implementation of VBA provides:
l Access to all exposed properties, methods, and events for iFIX objects
l Support for multiple data sources, including the iFIX process database, any OPC server, properties
of other objects, and SQL databases
l ODBC support
l Support for ActiveX controls
l Script Authoring Wizards and iFIX commands to help you write scripts for common tasks
l Secure Containment™ for third-party ActiveX controls
The 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.
This implementation of VBA includes a powerful find and replace feature, a high speed persistence fea-
ture 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 devel-
opment 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.
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:
A node is any computer running iFIX. An actual node can be any of the node types described in the fol-
lowing section. To learn more about iFIX nodes, refer to the chapter Managing iFIX Nodes.
Nodes in iFIX
Types of Nodes
Type Description
Local When working with a distributed iFIX system, local refers to the node on which you are currently
and working and remote refers to any node that you need a communication link to access.
Remote
Stand When working with a centralized iFIX SCADA system, stand alone refers to a node that per-
Alone forms all functions. Stand alone nodes do not use a network.
SCADA A SCADA Server (or SCADA node) runs the data acquisition and management component of iFIX.
Typically, a plant is controlled through a network of sensors and controls connected to I/O devices, such
as programmable logic controllers (PLCs). Although this type of system provides the automatic control
that keeps the plant running, it is often difficult for plant personnel to see what's actually going on in the
control process at any time. iFIX solves this problem by making data from various sources available to
plant workers and managers in formats that are useful and easy to understand.
A data source includes the data you want to access and the information needed to get that data. The
data sources available with iFIX include tags, I/O addresses, object properties, historical data, picture
properties, VBA events, global variables, and expressions.
With the open architecture of iFIX, data can be accessed from a wide variety of sources using OLE, OPC,
ActiveX, and ODBC. With comprehensive client and server support for these object technologies, iFIX is
able to read data from and write data to the following sources:
l Third-party applications
l Other iFIX databases
l I/O drivers
It is this ability to access data universally that gives iFIX its remarkable power and versatility.
iFIX includes comprehensive OLE, OPC, and ActiveX client and server support as the foundation for provid-
ing an integrated plug and solve architecture. This technology is the primary mechanism that lets you eas-
ily integrate third-party objects and controls into iFIX and embed iFIX objects into other applications.
OLE Automation server support allows you to expose the properties of iFIX components. For example, it
allows you to generate pictures without accessing the software's user interface.
ODBC support allows iFIX to access data from a database using Structured Query Language (SQL) as a
standard language. Each database management system (DBMS) requires an ODBC driver, which is a
dynamic-link library (DLL) used to gain access to a data source.
Among the database management systems used by iFIX are Microsoft Access (local install only),
Microsoft SQL Server, and Oracle. Refer to the Using SQL manual and Writing Scripts manual for more
information on ODBC support.
I/O Drivers
GE 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 per-
formance, 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 high-performance I/O driver from GE.
Data Flow
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 pro-
cess 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 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 par-
ticular 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.
For complete information on creating and maintaining a database, refer to the Building a SCADA System
manual.
The Scan, Alarm, and Control program (SAC) is a system application that runs on a SCADA node. This pro-
gram is responsible for executing the logic of the database chains. SAC performs the following functions:
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.
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.
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 exception-
based 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.
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
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 abil-
ity to create as many schedules as you need to organize your work logically and efficiently, and to run mul-
tiple 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:
l Distributed Processing
l On Demand Data Transfer
l Centralized Processing
Distributed Processing
Many systems operate in a hierarchical fashion that leave individual computers vulnerable to system fail-
ures 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
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.
Most industrial automation software systems require every node that uses data from a SCADA node to
have a copy of the entire database stored locally. The resulting network traffic can use significant system
resources. To conserve system resources for local tasks, iFIX reads and writes data on demand and only
moves requested data over the network.
Using iFIX and the built-in file sharing capabilities of Windows, you can store data that is needed by sev-
eral nodes in one convenient location. Using the Windows Explorer, you can establish a networked drive
connection to any other node in your local network. Once established, you have instant access to any
shared files on that node, including databases, pictures, schedules, and other important iFIX files. Access
to shared iFIX files by other computers can be controlled by implementing Windows security features.
Refer to your Windows documentation for more information on file sharing and security.
Some applications only need one node to perform the required functions. It is easy to convert a dis-
tributed 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 fol-
lowing figure shows a distributed and centralized process.
Alarming
iFIX has a sophisticated system for generating, displaying, and storing alarms and messages. You may
selectively route alarms and messages to the following:
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:
Block Alarm – database blocks generate alarms when block values fall outside pre-defined limits, when
a change of state occurs, or when communication errors occur.
Event Message– blocks can also send messages to printers and the alarm history file to indicate that an
event occurred at that block. These messages do not appear in operator displays and do not require
operator acknowledgment.
Operator Message– applications generate messages that create a history of important operator
actions. These include messages that are generated by electronic signatures.
SystemMessage– applications generate alarm messages that track system alerts and problems.
Application Message– applications, such as Recipe, can also send messages to printers and the alarm
history file to provide records of activity on that application.
Alarm Routing
iFIX uses a selective alarm configuration based on alarm areas, which are physical or functional divisions
of your plant. An unlimited number of alarm areas are provided to serve as distribution points for alarms
and messages. Each of these alarm areas can be custom named to easily identify it within your system.
The first 16 alarm areas in iFIX are labeled A through P by default. Each alarm area can then be routed to
send alarms and messages to selected alarm destinations.
For example, suppose you have two production lines and want to show all the alarms generated on these
lines. You also want to show a separate alarm whenever the level of the tank in either production line
falls below a certain level. One way to do this is to create two separate alarm areas called LINES and
TANKS. Assign all the blocks that monitor these production lines to LINES and only the blocks that mon-
itor 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.
For detailed information about alarm routing refer to the Implementing Alarms and Messages manual.
Operator and application messages can be independently routed to alarm areas. This feature allows you
to separate operator and application messages from alarms.
SCADA nodes act as alarm servers and distribute alarms and messages over the network. Other nodes
act as alarm clients and receive alarms. When you set up a SCADA node to distribute alarms over the net-
work, it sends the alarms and messages to every node that has a session established with it.
A non-SCADA node that generates operator messages and system alarms directs those messages to its
respective SCADA nodes.
Security
iFIX provides a powerful and sophisticated user-based security system which allows you to protect
against unauthorized:
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 par-
ticular security area can write to any database block that is a member of that security area.
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 inform-
ation on configuring security and logging in, refer to the Configuring Security Features manual.
Security Configuration
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.
The iFIX WorkSpace is your starting point for using iFIX. It provides an integrated and flexible con-
figuration environment that lets you create and modify documents for the local node. As part of this envir-
onment, the iFIX WorkSpace also launches and is integrated with iFIX applications, eliminating the need
to switch to other programs. Instead the iFIX WorkSpace provides a work area with all the necessary
tools to add a picture, create a schedule, or change a script.
Using the iFIX WorkSpace, you can also integrate ActiveX documents from other programs, such as Word
and Excel, with your iFIX files. Like iFIX documents, ActiveX documents appear in the work area that the
iFIX WorkSpace supplies. And if you create your own custom ActiveX documents, the WorkSpace auto-
matically displays the menus and toolbars that these documents define when you open them.
You can display a hierarchical view of your files with the iFIX WorkSpace. This view serves as a nav-
igational tool to help you locate iFIX documents and acts as a launch pad for iFIX and third-party applic-
ations.
The iFIX WorkSpace also lets you access the Visual Basic Editor (VBE). This editor lets you integrate
Visual Basic for Applications (VBA) scripts into your iFIX files. By writing a VBA script, you can customize
and automate the behavior of iFIX. For example, you can write a script to handle custom run-time data
entry instead of using the data entry mechanisms provided with iFIX.
But the iFIX WorkSpace is not only a configuration tool. It also provides a run-time environment as well
that lets operators display and run your iFIX documents. This environment lets you enable security
restrictions that lock operators into a pre-defined set of pictures.
This chapter discusses how to use the iFIX WorkSpace and navigate the system tree. It also explains the
available options and describes the two iFIX WorkSpace environments.
Before you begin using the iFIX WorkSpace, you should understand certain key concepts. Within the
WorkSpace are the system tree and the work area.
Before you use either one, you should use the System Configuration Utility (SCU) to properly configure the
nodes on which you will use the WorkSpace. To learn more about the SCU, refer to the Setting up the
Environment manual.
After you install and configure iFIX, you can begin using the iFIX WorkSpace.
In Configure Mode
By default, the WorkSpace starts when you start iFIX. This is because the WorkSpace is configured to run
as a startup task, by default. When the iFIX WorkSpace opens in the default mode, it starts in configure
mode.
You can also start the WorkSpace in configure mode by clicking Start and pointing to Programs, iFIX, and
then the iFIX WorkSpace.
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).
You can start the iFIX WorkSpace (WorkSpace.exe) in run mode, from a command line, by using the para-
meters listed in the following table. To open a specific picture within the WorkSpace use the /FileOpen or
/FO command. Additionally, you can use other command line parameters to specify the size of the
WorkSpace window, and whether the menu and status bar display when the WorkSpace opens. For
example:
workspace /fo "C:\Program Files (x86)\GE\iFIX\PIC\filename.grf" /WL 50 /WT 100 /WB 700 /WR 800 /MT n
Be aware that if you use these command line parameters to open an iFIX WorkSpace picture on startup,
the command line parameters override the settings defined in the StartUp Pictures tab of the User
Preferences dialog box. These settings also override any configured Window Properties (Title Bar, Res-
izable, 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.
The following table lists the command line parameters available for starting the iFIX WorkSpace.
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 (x86)\GE\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.
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 /?
Example
This example uses the command-line options to open the iFIX WorkSpace in run mode:
workspace.exe /FO "C:\Program Files (x86)\GE\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.
When the iFIX WorkSpace is open in run mode, one way to shut down the WorkSpace is through a VBA
command script using the Quit Method. This method is helpful when you restrict other portions of the
WorkSpace, such as the title bar and menus, that you would normally use to exit the WorkSpace applic-
ation in run mode.
For instance, if Environment Protection is enabled with menu and title bar restrictions, you may want to
provide a button that shuts down the WorkSpace in run mode.
Be aware that if security is enabled, the logged-in user must have the WorkSpace Runtime Exit security
feature.
For more information about configuring security features, refer to the Application Features section of the
Configuring Security Features manual.
TIP: You can also shut down the WorkSpace in run mode by using the ALT+F4 keyboard shortcut, provided your Envir-
onment Protection and security is configured to allow the user to shut down the WorkSpace.
Example
The following script uses the Quit method from a push button in an iFIX picture. The push button includes
a caption "Close Window" within the picture. When the Close Window button is clicked in run mode, the
script displays a message box indicating whether you want to close the WorkSpace. Click Yes to close the
WorkSpace window.
Private Sub CommandButton1_Click()
Dim lAccess As Long
Dim Msg, Style, Title, Response
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.
Your main navigational tool for locating files is the system tree. This tool appears as a hierarchical display
of folders, as the following figure shows. By opening and closing folders, you can locate and display your
documents in one step.
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.
iFIX WorkSpace
For example, when you double-click a picture, it appears in the work area window and all the tools asso-
ciated 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 iFIX WorkSpace or search for the appropriate application to launch.
All of the tools you need are built-in and ready to use.
iFIX provides a virtual alpha-numeric keyboard that installs with iFIX installation. This keyboard allows
you to work in touch-screen environments or to use a mouse to enter passwords and other data. When
you activate the virtual keyboard, it is available by clicking the following button:
Virtual Keyboard
l Use the SzUp and SzDn buttons to resize the keyboard to one of the twelve available sizes.
l Use the minimize button to dock the keyboard on the right side of the current application win-
dow's title bar.
l Use the Kybd, Help, Edit, Info, Num, Win, Mag, Macro and Calc buttons to toggle display of the
options.
l Click and drag any non-button area of the keyboard to move the keyboard on your desktop.
l Access the Help and the tutorial for the virtual keyboard, as well as general setup and con-
figuration 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 Ter-
minal Server, each licensed client has access to a copy of the virtual keyboard.
Activating the Keyboard
It is recommended 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. In your iFIX directory, right-click on the MYTSOFT.EXE file and select Copy.
2. In Explorer, navigate to the C:\Documents and Settings folder.
3. Drill down to the following folder:
C:\Users\Administrator\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup
4. Right-click the white space area of the Startup folder, and select Paste Shortcut.
5. If you want, rename the shortcut.
The next time you start your computer, the keyboard will activate automatically.
NOTES:
If you are switching from using Classic view to Ribbon view, you will notice that the location of many of
the commands is different. As an aid, use the following table to determine the locations of Classic view
menu items in Ribbon view.
The system tree provides a hierarchical view of the files on the local node. When you first start the iFIX
WorkSpace, the system tree shows the local node name at the top of the tree and the following folders
and applications:
If your computer has Batch Execution or greater installed, you will also see the following items:
Associated with each application and folder in the system tree is an iFIX path. These paths show where
the files reside on your computer and are defined in the System Configuration Utility (SCU).
To learn how to change an iFIX path, refer to the Setting up the Environment manual.
When the system tree is docked, you can only resize its width, as the following figure shows.
If resizing the system tree does not give you the space you need, you can hide the tree completely.
You can move up and down the system tree by selecting items with the mouse or by using the following
keys:
Use To...
the...
Up arrow Move up the system tree.
key
Down Move down the system tree.
Opening and closing folders is similar to using Windows Explorer, as the following figure shows:
With the iFIX WorkSpace, you can copy and move objects by dragging and dropping them into open doc-
uments. In general, you can drag an object, such as a Dynamo object, from an open picture, an open
Dynamo set, or the system tree and drop it into:
l An open picture.
l An open Dynamo set.
l A user-defined global file.
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.
You can start any application in the system tree by double-clicking its icon. The iFIX WorkSpace starts the
associated application and, when possible, displays the application in the workarea. In some cases, the
application opens in its own window on top of the iFIX WorkSpace.
The WorkSpace provides both a configuration and a run-time environment. The configuration envir-
onment provides all necessary development tools, including access to toolbars and the files in the system
tree. In addition, any process-monitoring background tasks that may be running, such as your I/O drivers
and enabled alarm services, continue to run while the configuration environment is active.
The run-time environment, on the other hand, is designed for operators. With this environment, oper-
ators can display pictures and monitor your process. Typically, the run-time environment is configured to
restrict operator access to other parts of iFIX by hiding menu bars and disabling the ability to task switch.
You can toggle between the two environments to test and run your pictures and schedules. As you switch
environments, the status bar updates. In the configuration environment, the text Configure appears.
When you switch to the run-time environment, the text changes to Run.
Documents open in one environment remain open even when you switch to the other environment. For
example, if you have two pictures and one schedule open in the configuration environment, these files
remain open when the run-time environment becomes active. If you close one of the pictures in the run-
time environment and switch back, the picture that you closed is now closed in the configuration envir-
onment. The other picture and the schedule both remain open.
The same restrictions apply to scripts running in pictures. You cannot close a picture until all running
scripts complete.
Switching to the run-time environment also hides the system tree, if it is displayed, and your toolbars.
Switching back reverses the process.
NOTES: To improve performance, close unnecessary, open documents before switching between environments to test
a picture.
You can display the WorkSpace full-screen in either or both of its environments. Displaying the
WorkSpace full-screen lets you see the exact same scale and display sizes that operators will experience.
When you display the WorkSpace full-screen, it hides its menu bar and any docked toolbars. Floating tool-
bars remain visible. The WorkSpace also hides the system tree in the configuration environment if it is
docked. In the run-time environment, the system tree and all toolbars are always hidden.
You can restrict operator access to the menu bar and pop-up menus, and prevent task switching by
enabling environment protection. Once enabled, environment protection takes effect when you switch to
the run-time environment.
For a detailed description of environment protection and how to enable it, refer to the Setting Up the
Environment manual.
If an error occurs in the run-time environment, an error dialog box displays requiring user intervention.
You can disable error dialog boxes for particular errors by editing the FILTEREDERRORS.INI file in the
Local path. For example, you may want to suppress the error dialogs when network sessions are lost. In
order to do this, add the error codes you want filtered in the INI file as follows:
;To add an error code to be filtered increment the count and set
;the Error equal to the return code
[ErrorCodes]
Count = 4
Error1 = 1620
Error2 = 1914
Error3 = 1915
Error4 = 8517
After you edit the FILTEREDERRORS.INI file, restart the WorkSpace to ensure your changes take effect.
1. Add a new section [iHistErrorCodes] if it is not already present in the .ini file.
2. Add a new key Count = the number of error codes you want to suppress.
3. Add a new key iHistError and set it equal to the return code.
Examples
If you want to suppress two Historian errors, you would modify the filterederrors.ini file as follows:
[iHistErrorCodes]
Count =2
iHistError1 = -3
iHistError2 = -2
If you want to suppress additional errors, increment the key value of Count as follows:
Count = 3
During a failed write attempt to the Proficy Historian Server, the iFIX WorkSpace becomes inactive. You
can control how long this lasts by setting the number of seconds you allow for the connection time-out.
The default is 90 seconds.
To configure the time-out, add this setting to the FixUserPreferences.ini file in the iFIX Local folder:
[Historian]
TimeoutSecs=10
Here, the time-out is set to 10 seconds. The valid range is 5 to 300 seconds, though not enforced.
Once the iFIX WorkSpace starts and the system tree appears, you can create and open documents. The
iFIX WorkSpace Standard toolbar provides buttons for creating new pictures, schedules, and Dynamo
sets. In Classic view, you can create other types of ActiveX documents with the New command from the
File menu. Or, in Ribbon view, you can access these functions by clicking the WorkSpace button and
selecting New.
Opening Documents
To open a document, double-click the document's icon in the system tree. The iFIX WorkSpace activates
the associated tools or starts the required application depending on the selected document.
If you want to open a document that is not in the system tree, click the Open button from the Standard
toolbar (Classic view) or click the WorkSpace button and click Open (Ribbon view) and select the file you
want to open.
You can delete or rename any closed document in the system tree by right-clicking it and selecting Delete
or Rename from the pop-up menu.
When you rename a document, the iFIX WorkSpace prompts you for the new name. Once you enter a
name, it appears in the system tree.
IMPORTANT: Only 31 characters are allowed when renaming (and naming) files in the Documents folder in the sys-
tem tree in the iFIX WorkSpace.
Using the iFIX WorkSpace, you can integrate documents from Word and Excel with your iFIX files. When
you open the documents, they appear in the iFIX WorkSpace.
In Classic view, you can perform all of the functions associated with each application directly in the
WorkSpace. However, in Ribbon view, there are some limitations. They include:
l Global commands, which are those that apply to any open document, such as Print, are not
accessible. However, all formatting commands are available.
l When working in Full Screen mode, you must have a picture open so that you can activate it,
which allows you to access the WorkSpace menu and keyboard shortcuts.
Understanding Toolbars
With the 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:
l 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.
l In Ribbon view, toolbars cannot be docked.
l In Ribbon view, if you open a MS Word or Excel document in the WorkSpace, some of the menu items asso-
ciated with those documents will not appear in the WorkSpace. If you need to edit an MS Word or Excel doc-
ument, we recommend that you do in so in Classic view.
Toolbars provides buttons for common operations. For example, the Standard toolbar, shown in the fol-
lowing figure, lets you create, open, and print documents.
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 pic-
ture's I/O points and the process database. This process is called resolving your pictures..
Utilities Toolbar
You can show or hide any toolbar by selecting or deselecting it from the Toolbars dialog box in the con-
figuration environment. Switching to the run-time environment hides all toolbars displayed in the con-
figuration environment.
All toolbars are owned by an application or a document. The toolbar's owner defines when the toolbar
appears. For example, WorkSpace toolbars appear while the WorkSpace runs, picture toolbars appear
only while the WorkSpace displays one or more pictures, and Scheduler toolbars are available when you
open a schedule. If you switch from a picture to a schedule, the WorkSpace hides the picture toolbars and
displays the Scheduler toolbars.
Customizing Toolbars
The 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 iFIX WorkSpace provides many toolbar categories from which you can select buttons. These cat-
egories 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 but-
ton 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 dis-
abling a toolbar's docking option. When enabled, this option lets you dock a toolbar by dragging it to any
edge of the screen. To keep the toolbar floating regardless of its screen position, you can disable the
option.
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 tool-
bars should be reset if you have customized the standard toolbars and you want to undo these changes.
When you reset a toolbar, the WorkSpace:
Creating 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 prop-
erties 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 pic-
tures open. If you subsequently open a schedule, the WorkSpace hides the picture toolbars and shows
the Scheduler toolbars. The 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. The name is limited to 31 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 res-
olution or move the toolbar to another computer. Consequently, it is recommended that you keep your toolbars within
the 800x600 portion of your screen.
In addition, the iFIX WorkSpace does not wrap docked toolbars. Consequently, if you dock a large toolbar, it appears as
a long line of buttons. Depending on the toolbar's size, some buttons may not be visible and may move other toolbars
beyond the visible portion of the screen.
Creating Buttons
You can create custom buttons with the iFIX WorkSpace. Typically, these buttons provide custom fea-
tures. 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 iFIX
WorkSpace cannot be modified.
You can create a new category by entering a name for it. Like toolbar names, category names must con-
form 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, pic-
ture, 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
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 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.
You can share any custom toolbar among your iFIX nodes. Using the WorkSpace, you can share them by:
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 com-
puter'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 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.
iFIX provides many Experts that automate the configuration of objects in pictures or the creation of an
object's script. For example, the Foreground Color Expert can dynamically change the foreground color of
an object. The Enable Alarm Expert, on the other hand, adds a script to the selected object. The script
enables alarms for the data source you specify.
You can access many Experts from picture toolbars (Classic view) or on the Tools tab in the Animations
and Tasks/Experts group (Ribbon view) or the Toolbox. However, with the Task Wizard, you can access
every Expert through an easy-to-use menu that does not require toolbars. Consequently, if your toolbars
occupy valuable screen space, you can hide them without losing functionality.
For more information on Experts, the Task Wizard, and the Multiple Command Script Wizard, refer to the
Creating Pictures ebook.
In Ribbon view, all functions, with the exception of Translation and Migration, are available directly from
the Ribbon. This makes the use of toolbars, in Ribbon view, virtually unnecessary.
The following sections detail the locations of the various toolbar functions in Ribbon view.
l Application Toolbar
l CAD Toolbar
l Chart Group Toolbar
l Dynamo Toolbar
l Edit Toolbar
l Expert Toolbar
l Web_HMI Toolbox Toolbar
l Shapes Toolbar
l Standard Toolbar
l Toolbox Toolbar
l Tools Toolbar
l Utilities Toolbar
l VisiconX Toolbar
The following table details the location of the various Application functions in Ribbon view.
NOTES:
l The following table includes only the default functions available on the Application toolbar.
l 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.
l 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.
The following table details the location of the CAD toolbar functions in Ribbon view.
NOTES:
l The following table includes only the default functions available on the CAD toolbar.
l 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.
l 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.
The following table details the location of the Dynamo toolbar functions in Ribbon view.
NOTES:
l The following table includes only the default functions available on the Dynamo toolbar.
l 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.
l 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.
The following table details the location of the Edit toolbar functions in Ribbon view.
NOTES:
The following table details the location of the Expert toolbar functions in Ribbon view.
NOTES:
l The following table includes only the default functions available on the Expert toolbar.
l 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.
l 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.
The Web_HMI group is available in Ribbon View and allows you to select to:
The following table details the location of the Shapes toolbar functions in Ribbon view.
NOTES:
l The following table includes only the default functions available on the Shapes toolbar.
l 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.
l 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.
The following table details the location of the Standard toolbar functions in Ribbon view.
NOTES:
The following table details the location of the Toolbox toolbar functions in Ribbon view.
NOTES:
l The following table includes only the default functions available on the Toolbox toolbar.
l 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.
l 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.
The following table details the location of the Tools toolbar functions in Ribbon view.
NOTES:
l The following table includes only the default functions available on the Tools toolbar.
l 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.
l 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.
The following table details the location of the Utilities toolbar functions in Ribbon view.
NOTES:
l The following table includes only the default functions available on the Utilities toolbar.
l 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.
l 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.
The following table details the location of the VisiconX toolbar functions in Ribbon view.
NOTES:
l The following table includes only the default functions available on the VisiconX toolbar.
l 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.
l 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.
Beginning with iFIX 5.0, you can choose either Classic view or Ribbon view for your user interface.
The Ribbon contains all of the commands associated with the menus in Classic view, as well as almost all
of the options previously only available on the toolbar. Not only does this make toolbars almost unne-
cessary in Ribbon view, it makes the Ribbon easier to use than Classic view.
Ribbon Structure
The Ribbon is organized in tabs. Each tab contains groups, as the following figure illustrates.
WorkSpace button
Quick Access Toolbar – default commands include the following:
l Switch modes
l Save
l Activate Visual Basic Editor
l Full Screen
l 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.
The Quick Access toolbar provides a way to quickly execute frequently used commands. The Quick Access
toolbar is customizable, allowing you to add as many or as few commands to the toolbar as you want.
In the following figure, commands have been added to the Quick Access toolbar, indicated by the number
one. Typically, the five default commands that appear on toolbar are those listed in the toolbar list, indic-
ated by number two.
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.
The WorkSpace button, located in the upper left corner of the WorkSpace, provides access to commands
located on the File menu in Classic view, such as New, Open, and Save. It also provides access to further
options, such as ways to customize the user interface in Ribbon view, or contact Technical Support.
Understanding KeyTips
In Ribbon view, KeyTips replace underlined menu letters as indicators of keys to press to invoke a com-
mand. They appear when you press the ALT or F10 key.
The following figure the illustrates KeyTips. Each KeyTip corresponds to the command, tab or button to
which it is closest.
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>.
In run mode, you can access the Ribbon, which displays the Historical tab and the Global Time Control, as
seen in the following figure. By default, the Ribbon is minimized in run mode, which allows for a larger dis-
play area for pictures. To display the Ribbon, click the Historical tab.
If the Ribbon is hidden and you want to use the Global Time Control or any other feature available on the
Ribbon at run time, you only need to clear the Minimize the Ribbon option on the Quick Access Tool list
while in run mode, as illustrated in the following figure.
The Minimize the Ribbon Option for the Ribbon in Run Mode
While in full screen run mode, the Ribbon is not visible, by default. However, you can use the Alt key to dis-
play it. Clicking on a picture causes the Ribbon, if it is visible, to return to a non-visible state. To always
display the Ribbon when in full screen run mode, clear the Minimize the Ribbon options on the Quick
Access Tool list while in run mode, as illustrated in the following figure.
The iFIX WorkSpace provides several options that you can configure. These options include:
l Picture, shape, drawing, and standard chart preferences. Refer to the Understanding Picture,
Shape, Drawing, and Standard Chart Preferences section for more information.
l Save preferences. Refer to the Saving Back-up Files section for more information.
Picture preferences include the default size and background color, and whether the picture includes a
title bar, system bar, and the ability to resize. You can also specify whether your pictures will use a gradi-
ent fill, will save a thumbnail, can be cached, and can be auto scaled.
Shape preferences let you specify the default colors of new objects in a picture and default styles, such
as fill and edge style. If the fill style is Gradient, you can specify fade type. You can define default pipe
properties, and the default font name, point size, and styles.
Drawing preferences let you specify the line extension and line trimming options and whether or not to
display connection nodes on objects.
Standard Chart preferences let you select the defaults for Standard Chart objects only. These defaults
include the number of ticks per axis, the number of labels per axis, the direction in which the chart scrolls,
and the length of time the chart displays. To learn more about all picture, shapes, drawing, and chart pref-
erences, refer to the Creating Pictures manual.
Each time you save a file, the iFIX WorkSpace copies the previous version to a back-up subfolder and
saves the new version. If a back-up file already exists for the current file, the new back-up replaces it.
Back-up subfolders reside inside the system tree folders but do not appear in the system tree. For
example, the Pictures back-up subfolder resides inside the Pictures folder and contains back-ups of mod-
ified pictures.
Depending on the amount of free disk space you have and the size of your pictures, you may want to dis-
able the back-up option to save space.
l Saving your open documents automatically when you switch to the run-time environment. Using
this feature, you can toggle between the two environments without worrying about saving your
changes. By default, this option is disabled. If you enable it and you want to test a change to a pic-
ture or schedule without saving the modification, you must disable the preference before
The start-up environment option lets you specify the environment in which the iFIX WorkSpace starts. By
default, the iFIX WorkSpace starts in the configuration environment.
However, when you have finished configuring each node, you may want to configure the iFIX WorkSpace
to start up in the run-time environment automatically.
Each animated object in a picture uses OPC protocols to receive data and report errors. The animation
error preferences define the default error strings and values that the object uses when an error occurs.
For example, by default, when a communication error occurs, Data links display the text "@@@@".
You can customize the animation error defaults by entering new values in the Animations Data Error
Defaults tab. By changing the defaults, you make the default error messages more intuitive for your
industry. For example, when a communication error occurs, you can have Data links display the following
text by entering it into the Comm field of the Format Animation Object Defaults area:
Cannot communicate with server
The iFIX WorkSpace provides two options for user interfaces. They are:
l Classic view – this user interface was the only one available prior to iFIX 5.0. It uses a number of
toolbars in addition to menu driven commands.
l Ribbon view – this user interface is available beginning with iFIX 5.0. Almost all functions pre-
viously available in Classic view via the toolbar can now be accessed on the Ribbon, without open-
ing or importing toolbars.
In Ribbon view, you can customize the look and feel of the user interface. Customization choices include:
You can write Visual Basic for Applications scripts for any picture, toolbar button, schedule, or iFIX object.
Using VBA gives you complete control over your process automation solution because it lets you create
custom scripts and automate iFIX for your needs.
You can begin writing scripts by displaying the Visual Basic Editor. The VBE provides access to all the avail-
able methods, properties, and events for your iFIX objects.
You can display the VBE in many ways, such as by selecting Visual Basic Editor from the WorkSpace menu
(Classic view) or on the Home tab, in the WorkSpace group, click Visual Basic Editor (Ribbon view), or
right-clicking an object and selecting Edit Script from the pop-up menu, and creating a schedule and click-
ing VB Editor from the Add Event Entry or Add Timer Entry dialog box.
To learn how to use the VBE, refer to its online Help. To learn how to write scripts for iFIX objects, but-
tons, pictures, and schedules, refer to the Writing Scripts manual. For information on iFIX methods, prop-
erties, and events, refer to the iFIX Automation Interfaces Help file.
The iFIX WorkSpace supports the use of multiple monitors for displaying pictures in an expanded (or inde-
pendent) and spanned (or stretched) space. You must configure your video driver (following the instruc-
tions from your hardware vendor) to enable your desktop space to be expanded (or independent) or
spanned (or stretched) for all your monitors.
For multiple monitors to work properly with iFIX, you must have the identical resolution set on all mon-
itors. The primary monitor (Monitor 1) should always be set to the topmost, and leftmost area in the Win-
dows Display Properties dialog box.
Configuration in iFIX
When using expanded (or independent) display settings, in the User Preferences dialog box on the Gen-
eral 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. To view the child windows again, change the picture’s WindowLeftPercentage and Win-
dowTopPercentage to 0 to get them back into the Monitor 1 area.
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 whelp you quickly locate the coordinates of the upper left
corner where you want a picture to open.
The WorkSpace application includes the following dialog boxes (listed in alphabetical order):
Data Server
Specifies a name for the OPC driver. This name identifies the driver to iFIX and is used in data sources to
access the selected OPC driver. Make sure the name you enter contains no spaces and is not already
used by another data server.
OPC Server
Machine Name
Specifies the local computer name, or the remote computer name that the OPC Server resides on.
Select this check box to set the current OPC server as the default server. iFIX will use this server when
you do not explicitly enter a server name in a data source.
Displays a list of bitmaps in the iFIX Local path. You can select one of these bitmaps for the button or you
can select a custom bitmap of your own by browsing to it. If you select a custom bitmap, the image can
be no more than 20 x 20 pixels and use no more than 16 colors.
Preview
Displays a preview of the bitmap highlighted in the Current Directory bitmap list.
Category
Name
Specifies the name of the button you are configuring. You can edit this name by entering the text you
want.
Description
Lets you enter a text description for the button you are configuring. This text appears on the Buttons tab
when you select the button.
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 button's script.
The Configure the Proficy Historian Server(s) dialog box displays the following items. Be aware that you
must restart the iFIX Workspace to apply changes from this dialog box.
Select this check box to create a common Historian Server configuration that can be used across multiple
Windows user accounts. The common Historian server configuration is available in any session type
including: iClient, iClientTS, and Webspace clients. When the option is disabled, you can create a custom
Historian Server configuration for each Windows user.
For example, say you are logged into Windows with a user account named “Joe” and you save the His-
torian Server configuration with the option enabled. Then, you log in with a user account called “Tom” and
start iFIX and the WorkSpace. The WorkSpace will be able to use the Historian Server configuration you
created earlier, even though you are logged in with a different user account. Conversely, if you are logged
in to Windows as “Joe” and you save the Historian Server configuration with the option disabled, when
you log in as “Tom” and start iFIX and the WorkSpace, you will need to create the Historian Server con-
figuration. This Historian Server configuration will only be available when the “Tom” user account is
logged in to Windows.
There are some special considerations when iFIX runs in a Terminal Server environment. When iFIX runs
in an iClientTS session, there is another option, TSCommonHistConfig*, that comes into play. When the
“Enable Historian aliases for all sessions” option is enabled, it overrides the TSCommonHistConfig option.
When it is disabled, when iFIX run as an iClientTS it uses the common Historian Server configuration if
TSCommonHistConfig is enabled; it uses the user-based Historian Server configuration if TSCom-
monHistConfig is disabled.
WebSpace client sessions use the common Historian sSrver configuration that was created on the
WebSpace server. WebSpace client sessions are not affected by the “Enable Historian aliases for all ses-
sions” or TSCommonHistConfig options.
The following table summarizes how the “Enable Historian aliases for all sessions” and TSCom-
monHistConfig options work in different session types:
iFIX is Run- and the and the TSCom- the Historian Server con-
ning as an... “Enable His- monHistConfig option* is… figuration is…
torian aliases
for all ses-
sions” option
is…
iClient enabled enabled or disabled common
iClient disabled enabled or disabled user-based
* The TSCommHistConfig option is configured in the [Historian] section of the FixUserPreferences.ini file.
** When using iFIX in a Terminal Server environment with “Enable Historian aliases for all sessions” dis-
abled and TSCommonHistConfig enabled, take care to save the Historian Server configuration from the
Terminal Server console. Changes made to the Historian Server configuration from an iClientTS session
will be saved as user-based.
Set Default
Use this button to set the server selected in the Alias Name/Server Name list as the default Historian
server.
Add Server
Modify
Delete
Use this button to delete the selected server from the Alias Name/Server Name list.
Alias Name
Enter the alias name in this field. This field is unavailable if the default server is selected. Do not use spe-
cial characters, such as @, $, a period (.), or #, in this field.
Server Name
User Name
Password
Close
Use this button to close the Configure the Proficy Historian Server(s) dialog box.
Get Collectors
Lists only the collectors that use iFIX EDA, which includes the following :
Set Default
Use this button to set the collector in the Collector Name list as the default.
Toolbars Tab
Item Description
Owner Lets you select a toolbar owner. Only active owners appear in the list.
Toolbars Lets you show and hide the selected toolbar.
Enable Docking for Lets you enable or disable toolbar docking.
Selected Toolbar
Show ScreenTips Lets you enable or disable text descriptions for every button on every tool-
on Toolbars bar. When enabled, you can display a description by placing the cursor
over a button.
Add Toolbar Lets you create a toolbar.
Modify Properties Lets you modify the properties of the selected toolbar. Toolbars supplied
with iFIX cannot be modified.
Delete Toolbar Lets you delete the selected toolbar. Toolbars supplied with iFIX cannot
be deleted.
Reset Lets you reset the selected toolbar to its default state. Any buttons
removed from the toolbar and supplied by default are added back. All but-
tons 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 Description
Categories Lets you select a toolbar category.
Add Category Lets you add a toolbar category.
Rename Category Lets you rename the selected toolbar category. Categories supplied with
iFIX cannot be renamed.
Delete Category Lets you delete the selected toolbar category. Categories supplied with
iFIX cannot be deleted.
Buttons Area Drag and drop a button from this group box onto a toolbar, or double-click
The Data Server Installer dialog box displays the following items:
Data Servers
Displays the available OPC servers and lets you select the server you want to modify or delete.
OPC Server
Machine Name
Specifies the local computer name, or the remote computer name that the OPC Server resides on.
Add
Remove
Modify
NOTE: If a tab is not displayed, you can click the Available Data Sources drop-down to select the applicable one
that you want to bring into view. The following figure illustrates where the Available Data Sources drop-down appears
in the Expression Builder dialog box.
Item Description
Node Names List Box Displays a filtered list of SCADA servers that the local node is com-
municating with. By default, all SCADA servers are displayed.
Node Names Filter 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 char-
acters).
Node Names Filter Use this button to update the list of nodes based on the current SCADA
Button server filter.
Tag Names List Box Displays a filtered list of database blocks (tags) on the selected SCADA
server. By default, all blocks are displayed.
Tag Names Filter 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).
Tag Names Filter But-Use this button to update the list of blocks based on the current block fil-
ton ter.
Field Names List Box 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 field's 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.
F_* Button Use this button to change the block field filter to display all F_ fields and
selects the F_CV field, if available.
E_* Button Use this button to change the block field filter to display all E_ fields and
selects the E_CV field, if available.
Block Field Filter 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).
Block Field Filter But- Use this button to update the list of fields based on the current block
ton field filter.
Current Expression Specifies the current expression. You can enter the expression directly
Box or build it by making selections from the other fields and buttons on the
tabbed page.
Item Description
Objects List Box 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.
Object Filter 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).
Object Filter Button Use this button to update the item list based on the current filter.
Properties List Box Specifies the properties for the currently selected picture or object.
Item Description
Data Servers Box 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
If you use tag group substitution and the object of your substitution is
an element in an OPC server address that includes double quotes sur-
rounding its data items, it is recommended that you add single quotes
surrounding the tag group symbol. For example, the following sub-
stitution for the PDS driver will fail:
Item Description
Node Names List Box Displays a filtered list of SCADA servers that the local node is com-
municating with. By default, all SCADA servers are displayed.
Node Names Filter 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 char-
acters).
Node Names Filter Use this button to update the list of nodes based on the current SCADA
Button server filter.
Alarm Area Tag Displays a filtered list of alarm areas on the selected SCADA server.
Names List Box Also displays the alarm counter (ALARMCOUNTERS) tag. By default, all
areas are displayed.
Alarm Area Tag Specifies the current area name filter. You can edit the filter or select
Names Filter one from the list. You can also include in the filter the wildcards ? (to
represent a single character) or * (to represent two or more char-
acters).
Alarm Area Tag Use this button to update the list of areas based on the current area fil-
Names Filter Button ter.
Alarm Counter Field Displays a filtered list of fields available from the selected area. By
Names List Box default, all fields are displayed.
A_* Button Use this button to change the field filter to display all A_ fields.
F_* Button Use this button to change the field filter to display all F_ fields.
Alarm Counter Field Specifies the current area field filter. You can edit the filter or select
Names Filter one from the list. You can also include in the filter the wildcards ? (to
represent a single character) or * (to represent two or more char-
acters).
Alarm Counter Field Use this button to update the list of fields based on the current field fil-
Names Filter Button ter.
Current Expression Specifies the current expression. You can enter the expression directly
Box or build it by making selections from the other fields and buttons on the
tabbed page.
Item Description
Servers Displays a selection list of servers.
Display Collector Allows you to select whether Collector names are displayed.
Name Check Box
Node Names List Box Displays a filtered list of SCADA servers that the local node is com-
municating with. By default, all SCADA servers are displayed.
Tag Names List Box Displays a filtered list of database blocks (tags) on the selected SCADA
server. By default, all blocks are displayed.
Description List Box Displays a filtered list of descriptors of the selected SCADA server. By
default, all descriptions are displayed.
Collector Names List Displays a filtered list of Collector Names for the selected SCADA
Box server. By default, all Collector Names are displayed.
Filter fields Displays four drop-down lists that you can use filter what displays in the
tag list. Any combination of four filters can be selected at one time:
For all fields, except Collector Type and Data Type, when building a filter
expression, you can include a wildcard ? (to represent a single char-
acter) or * (to represent two or more characters) in the filter.
Apply Filter Button Use this button to apply the selected filter to the item list.
Reset Filter Button Use this button to reset the item list based on the current filter.
Filtered Tag Count Displays the number of tags found that meet filter criteria.
Maximum Count Displays the maximum number of tags that the search can return from
Proficy Historian.
Current Expression Specifies the current expression. You can enter the expression directly
Box or build it by making selections from the other fields and buttons on the
tabbed page.
The Find and Replace dialog box displays the following items:
Item Description
Find What Specifies the text you want to search for (the search string).
Match Case Select this check box to limit your search to only the values that match the
exact case of the search string.
Whole Word Only 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: (, ), {, }, [, ].
Data Source Only Select this check box to limit your search to only data sources that match the
search string.
Include Scripts Select this check box to expand your search to include the scripts associated
with the current picture or schedule.
Find Button 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.
Match List Displays the properties and property values that match the search string after
you click the Find button.
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 Use this button to stop the search or replace in progress.
Go To Button Use this button to jump to the object, picture, or schedule selected in the
Match List list box. Before jumping, the iFIX WorkSpace closes the Find and
Replace dialog box. If you jump to an object, the iFIX WorkSpace selects it
after the dialog box closes.
Replace Tab
Item Description
Find What Specifies the text you want to search for (the search string).
Replace With Specifies the text you want to substitute for the search string.
Match Case Select this check box to limit your search to only the values that match the
exact case of the search string.
Whole Word Only 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: (, ), {, }, [, ].
Data Source Only Select this check box to limit your search to only data sources that match the
search string.
Include Scripts Select this check box to expand your search to include the scripts associated
with the current picture or schedule.
Select Project
Select a project name from the drop-down list. The names in this list represent iFIX project names that
you can retrieve from the Change Management Server.
Project Destination
The path that the project was last checked in with. Change this path if it is the same as your local iFIX
path.
IMPORTANT: Do not get a project directly into your local iFIX path. Doing so copies over your existing iFIX files, which
may create problems the next time you start iFIX. If you try to get a project to your local iFIX path, an error message
appears.
TIP: If you later want to start iFIX with the SCU associated with this project, open the SCU, and modify the path con-
figuration (the base and NLS paths should point to the local install, while the project path should point to folder you
copied the files to). You also should modify the startup tasks, network configuration, SQL tasks, and local startup defin-
ition so that the appropriate paths point to the local iFIX install. Save the SCU and restart iFIX to start iFIX with this new
SCU.
Get Options
Item Description
Delete all existing Select this check box to delete all existing files in the path you specify, and
files under Project replace them with the ones in this project. If you select this check box, it is
Destination strongly recommended that you select the Initialize Project Destination
with iFIX Default Files check box.
Initialize Project Select this check box to restore your iFIX files to the factory default set-
Destination with tings before retrieving the iFIX files from this project. If you do not select
iFIX default files 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 dif-
ferent from the default one listed when you select the project. It is highly
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 pro-
ject path in the SCU to the destination path.
Toolbars Box
Owner
Lets you select an owner for the toolbar you are importing.
Import
Data Server
Specifies a name for the OPC driver. This name identifies the driver to iFIX and is used in data sources to
access the selected OPC driver. Make sure the name you enter contains no spaces and is not already
used by another data server.
OPC Server
Machine Name
Specifies the local computer name, or the remote computer name that the OPC Server resides on.
Select this check box to set the current OPC server as the default server. iFIX will use this server when
you do not explicitly enter a server name in a data source.
The Multiple Command Script Wizard lets you use one or more command Experts to build a sequence of
actions that can be triggered by a mouse click on an object, a Scheduler entry, or a key macro.
The Multiple Command Script Wizard dialog box displays the following items:
The Select Action to Append drop-down list contains pre-defined Experts that you can add to your com-
mand sequence. When you select an action from the list, its associated Expert launches. After you con-
figure the Expert for use in the sequence, it will appear in the Configured Actions list box.
NOTE: If the Expert you want to append is already displayed in the drop-down list, you can click the Append action but-
ton to launch the Expert.
Configured Actions
Click this button to open the Expert currently displayed in the Select Action to Append list.
Click this button to delete all actions in the Configured Actions list box.
Up/Down buttons
Click the Up or Down button to move a selected action up or down in the Configured Actions list box.
Click the Show or Hide button to display or hide the details of all actions in the Configured Actions list
box.
Launch VB Editor
The Configured Actions list box displays the command or sequence of commands that have been con-
figured for the selected object. You can click the plus symbol next to a command to expand it and display
its configured properties.
Use this button to copy iFIX data and configuration files from the local node to a compressed archive file.
Backup Type
Custom Backup
Allows you to select specific files within the project path to backup.
Full Backup
Select to backup all files, including security files, within the project path.
Use this button to copy iFIX data and configuration files from a compressed archive file to the local node.
Custom Backup
Page 1
Item Description
Backup Type Specifies the type of backup you selected.
Node Specifies the name of the local node from which you are backing up files.
Project Path Specifies the path on the local node from which you are backing up files.
Backup File Option Select the types of files you want to back up.
Include Security Files In Select to backup security settings. This option is only enabled when security
Archive files are found on the system.
Backup Notes Displays notes about the backup. You cannot edit this field.
Page 2
Item Description
Backup File Allows you to specify the path and name of the archive file to save. You can enter any
Path and valid file name and path, including a network path. The Wizard automatically appends the
Filename .FBK extension to the name you enter.
Browse But- Lets you select the path and file name of the archive file by browsing to it.
ton
Full Backup
Item Description
Backup File Allows you to specify the path and name of the archive file to save. You can enter any
Path and valid file name and path, including a network path. The Wizard automatically appends the
Filename .FBK extension to the name you enter.
Page 1
Specifies the name of the archive file you want to copy files from and the path to it.
Browse Button
Lets you select the path and file name of the archive file by browsing to it.
Page 2
Backup Type
Displays the type of archive you are restoring (Custom, Full, or Factory Default), and displays the location
of the archive file.
Item Description
Use the Cur- Select this option to restore files into the current project path.
rent SCU
Use SCU File Select this option to restore files into the project path specified in the archived SCU.
From Archive
NOTE: When you select the Use SCU File from Archive option, be sure check the default
iFIX path configurations in the SCU in each of your iFIX projects after you restore your
files. For example, if you installed the latest version of iFIX to a 64-bit path (C:\Program
Files (x86)\GE\iFIX), and your previous picture files were installed to a 32-bit path (C:\Pro-
gram Files (x86)\GE\iFIX), you will need to make sure you update these paths in the SCU
to 64-bit.
Create a New Select this option to restore files to a new project path with a default sub-project path.
Project 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 node's current SCU file.
Node Specifies the name of the local node.
Project Path Specifies the project path of the local node. You can change the project path by over-
writing 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.
View Project Click to display the configured paths for the restored files within the project.
Path Con-
figuration
Item Description
Delete All Existing Select this check box to delete all existing files under the selected project path
Files Under Target before restoring a Custom or Full backup file. This option will not delete existing
Path Before The security files or the current SCU file loaded in local startup.
Restore
Restore Default iFIX Select this check box to restore default iFIX files before restoring your backup
Files Before Restoring files. For Custom and Full restores, the default iFIX files are restored from the
Your Backup Files FactoryDefault file.
Task Categories
Specifies a task category. Each category contains Experts related to the category name. For example,
the Database category contains Experts that let you create and modify database blocks.
Tasks
Perform Task
Owner
Lets you select a toolbar owner. Only active owners appear in the list.
Customize
Lets you:
Lets you enable or disable text descriptions for every button on every toolbar. When enabled, you can dis-
play a description by placing the cursor over a button.
Click a link below for more information about the tabs featured in the User Preferences dialog box.
l General Tab
l Animations Data Error Defaults Tab
l Shape Preferences Tab
l Picture Preferences Tab
l Standard Chart Preferences Tab
l Drawing Options Tab
l Environment Protection Tab
l Background StartUp Tab
l StartUp Pictures Tab
l Change Management Tab
l Operations Hub Tab
l Historian Tab
The General tab of the User Preferences dialog box displays the following items:
WorkSpace Options
Item Description
Start Select this check box to indicate that the iFIX WorkSpace starts in the run-time
WorkSpace In environment. Clear this check box to indicate that the iFIX WorkSpace starts in
Run Mode the configuration environment.
Auto Save Select this check box to automatically save open documents when the iFIX
Documents WorkSpace switches to the run-time environment.
When Switch-
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.
Extend Select this check box if you plan to use multiple monitors with your iFIX displays.
WorkSpace
to Support
Multiple Mon-
itors
Enable Rib- Select this check box to use the Ribbon user interface in the iFIX WorkSpace.
bon User Clear this check box to use the Classic user interface in the iFIX WorkSpace.
Interface
Zoom To Fit In run mode, select this check box to suppress the scroll bars and to show the
in Run Mode entire picture in the current picture window. Only pictures using Enhanced
Coordinates that are opened in Run mode will honor this setting. If you do not
want to apply this setting to a specific picture, then a script change under the
picture initialization code is required. For more information, refer to the
ZoomToFit Method section in iFIX Automation Reference e-book.
Enable High Select this check box to create high performance graphics in iFIX pictures that
Performance use the High Performance color set and the high performance settings for
HMI Graphics shapes and picture creation. For more information, refer to the Creating High
Performance Pictures e-book.
Item Description
Perform Com- Specifies the name of the table that contains predefined perform comments
ments Table for the Electronic Signature dialog box.
Name
Create Default Use this button to create a new table containing predefined perform com-
Perform Com- ments for the Electronic Signature dialog box.
ments Table
Verify Com- Specifies the name of the table that contains predefined verify comments in
ments Table the Electronic Signature dialog box.
Name
Create Default Use this button to create a new table containing predefined verify comments
When the Electronic Signature dialog box opens, it checks this field for a Pro-
gID. If no ProgID is found, the standard Esignature ActiveX control is dis-
played. 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
Specifies the message that appears from the Electronic Signature dialog box when a user account is no
longer valid.
Expression Editor Options
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.
The Animations Data Error Defaults tab of the User Preferences dialog box displays the following items:
Linear Animation Object Defaults
Item Description
Configuration 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.
Out of Ser- Specifies the default OPC error values that iFIX returns when a linear, format,
vice 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 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.
Uncertain 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.
Comm 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.
Item Description
Configuration 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.
Out of Ser- Specifies the default OPC error values that iFIX returns when a linear, format,
vice 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 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.
Uncertain 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.
Comm 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.
Device 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 enter-
ing a new value into each field.
Item Description
Configuration 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.
Unknown 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.
Comm 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.
Out Of Ser- Specifies the default OPC error values that iFIX returns when a linear, format,
vice 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.
Item Description
Configuration 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.
Unknown 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.
Comm 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.
Out Of Ser- Specifies the default OPC error values that iFIX returns when a linear, format,
vice 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.
Device 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 enter-
ing a new value into each field.
Uncertain 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.
Item Description
Configuration 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.
Unknown 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.
Comm 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.
Out Of Ser- Use this button to open the Select Color dialog box where you can choose the
vice default color that iFIX displays when a lookup animation fails to receive data
because the specified I/O point is off scan.
The Shape Preferences tab of the User Preferences dialog box displays the following items:
Color
Item Description
Fade Color Use this button to open the Select Color dialog box where you can choose the
default shape fade color.
Foreground Use this button to open the Select Color dialog box where you can choose the
Color default shape foreground color.
Background Use this button to open the Select Color dialog box where you can choose the
Color default shape background color.
Edge Color Use this button to open the Select Color dialog box where you can choose the
default shape edge color.
Font
Item Description
Font Specifies the default font for text objects.
Name
Font Size Specifies the default size of text objects.
Font Specifies the default text object style. The text can be regular, bold, italics, or bold
Styles italics.
General
Item Description
Edge Style Specifies the default shape edge style. Edges can be solid, transparent, dotted, or
dashed.
Edge Width Specifies the default shape edge width. You can enter any width from 0 to 255
pixels.
Hit Test Specifies the minimum distance the cursor can be from an object before high-
Size lighting the object. You can enter any distance from 0 to 255 pixels.
Blend Per- Specifies how much of the fade color, in a percentage, will be mixed with the fore-
cent ground color. The higher the percentage, the more the fade color is visible.
Fill Style Specifies the default shape foreground fill style. Fills can be solid, transparent,
gradient, or a pattern.
Background Specifies whether the default shape background is opaque or transparent.
Style
Pipe
Item Description
Thickness Specifies the default thickness for pipe objects. You can enter any value from 10 to
300.
Elbow Specifies the default elbow style for pipe objects. Elbow styles can be round or
Style square.
Start Cap Specifies the default start cap for pipe objects. Start caps can be round, square,
horizontal-diagonal, or vertical-diagonal.
End Cap Specifies the default end cap for pipe objects. End caps can be round, square, hori-
zontal-diagonal, or vertical-diagonal.
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 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.
Select this check box to specify that the Historical Datalink include the time stamp with the data. The
time stamp appears only at run-time.
The Picture Preferences tab of the User Preferences dialog box displays the following items:
Properties
Item Description
Window Size 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.
Automatically Select this check box to enable the Document Width and Document Height
Determine Docu- fields to allow you to define your own coordinate system that differs from
ment Size the default logical coordinate system of 4:3 horizontal to vertical res-
olution. You should not change this setting unless you are familiar with the
coordinate system used for measuring picture height and width. Other-
wise, objects may not animate as expected.
Document Height Specifies the default picture height in logical units or postscript points.
Item Description
Prompt On Delete Select this check box to be prompted to confirm the deletion of an anim-
ation in the Basic Animation dialog box and the Command Expert dialog
box.
Always Show Select this check box to display the Basic Animation dialog box when you
Basic Animation double-click an object or select Animations from an object's right-click
Dialog menu.
If this check box is cleared, the Advanced Animations dialog box appears.
Select this check box to display the Create Picture Wizard. If this check box is cleared, the Create Picture
Wizard is unavailable.
Picture Translation
Item Description
Translate Pic- Select this check box if you want to replace the text strings in all of your pic-
ture On Open tures with a selected language file (if it exists) when you open them in the run-
time environment.
If this check box is cleared, you can configure the TranslateOnOpen and Lan-
guageDesired 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 Trans-
late Picture on Open check box is selected.
Window Properties
Item Description
Title Bar Select this check box to indicate whether your pictures appear with or without title
bars.
System Menu Select this check box to indicate whether you are creating pictures with or without a
System menu, or Maximize, Minimize, and Close buttons.
Resizable Select this check box to indicate whether you can or cannot resize pictures.
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 picture's 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 Description
Enable Picture Select this check box to enable picture caching, which reads and opens previously
Cache opened pictures from memory. Clear this check box to indicate that picture files will be
opened from the disk drive.
Cache Size Specifies the number of pictures (from 1-99) you want in the cache.
Select this check box to override the logical units to pixel ratio (Logical Coordinate System) when chan-
ging the resolution of your screen. This may be helpful for multiple monitor configurations.
For the Enhanced Coordinate System, Auto Scale calculates the picture window size percentages based
on the resolution of the window with the current view of the picture. Disabling this feature will calculate
the window sizes based on the resolution where this picture was last saved.
The Standard Chart Preferences tab of the User Preferences dialog box displays the following items:
Scroll Direction
Item Description
Scroll Right To Left Select this option to set the default scroll direction for all charts to a right-to-
left scroll.
Time Axis
Item Description
Number Of Ticks Specifies the default number of ticks to display on your chart's time (X) axis.
You can enter any value from 0 to 20 into this field.
Number Of Labels Specifies the default number of labels to display on your chart's time (X) axis.
You can enter any value from 0 to 20 into this field.
Value Axis
Item Description
Number Of Ticks Specifies the default number of ticks to display on your chart's value (Y) axis.
You can enter any value from 0 to 20 into this field.
Number Of Labels Specifies the default number of labels to display on your chart's value (Y) axis.
You can enter any value from 0 to 20 into this field.
Item Description
Duration Days Specifies the amount of data your charts display along their time (X) axes. You
can enter any value from 0 to 999 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.
Duration Time Specifies the amount of data your charts display along their time (X) axes. You
can enter any value from 0 to 999 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.
Interval Time 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.
General
Item Description
Allow Time Axis Reset 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.
The Drawing Options tab of the User Preferences dialog box displays the following items:
Geometry Helper Options
Item Description
Always Extend Lines Specifies that the selected lines will always extend to the intersection
point when the Extend Lines button on the CAD Toolbar is used.
Extend Only When The Exten- Specifies that the selected line will be extended to the intersection
sion Is Shorter Than Half The point only when the extension is shorter than half the line being exten-
Line ded.
Extend Only When The Exten- Specifies that the selected line will be extended to the intersection
sion Is Shorter Than X Pixels point only when the extension is shorter than the defined value.
Always Trim Lines Specifies that the selected lines will always be trimmed at the inter-
section point when the Trim Lines button on the CAD Toolbar is used.
Trim Only When The Trimmed Specifies that the selected line will be trimmed at the intersection
Area Is Shorter Than X Pixels point only when the trimmed area is shorter than the defined value.
Graphics Connections
Select this check box to indicate that the connection nodes are always displayed on the shapes in a pic-
ture. If this check box is cleared, the connection points are not visible, but can be displayed using one of
the following methods:
l Select a connector and move it towards the shape to anchor it to a certain connection point on
the shape.
- Or -
l Select the shape and click either the Add Connection Point button or Delete Connection Point but-
ton on the CAD Toolbar.
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.
Item Description
Disable Title Select this check box to hide the WorkSpace menu bar and title bar at run-time.
Bar And
NOTE: In Ribbon view, if this option is selected, the Title Bar takes on the appear-
Menu Bar
ance of Classic view, rather than Ribbon view.
Enable When the WorkSpace title bar is disabled, there is no way to shut down the
ALT+F4 WorkSpace application in run mode. Select this check box to allow the use of the
ALT+F4 keyboard shortcut to shut down the WorkSpace in run mode when the
WorkSpace title bar is disabled. The logged-in user must have the Enable Task
Switching and Workspace Runtime Exit security features enabled.
Disable Select this check box to disable the WorkSpace menu bar at run-time.
Menu Bar
Disable Select this check box to disable the WorkSpace menu at run-time.
"WorkSpace"
Menu Pull-
down
NOTES:
l When WorkSpace is running with the Ribbon in full screen mode and you enable the Run Time Environment
Protection and Disable Title bar and Menu Bar options, the Ribbon bar will be displayed when the Alt key is
pressed. This will allow access to the Historical tab with Global Time Control. All other menus will be removed
or disabled and the WorkSpace cannot be dragged, minimized, or closed using the Ribbon bar.
l The historical tab with Global Time Control can be removed by modifying the DyanmicRibbon.ini file in the iFIX
install ADDON folder and setting [StandardTabs] Historical=0. If the tab is removed and no other tabs are vis-
ible on the run mode Ribbon (because you also enabled the enable the Run Time Environment Protection and
Disable Title bar and Menu Bar options) , the Ribbon bar will not display when the Alt key is pressed.
Item Description
Disable "WorkSpace" Select this check box to disable both the Open (Ctrl+O) and Print
File Menu Accel- (Ctrl+P) WorkSpace file menu accelerators while in the Run-time envir-
erators onment.
Disable Open Accel- Select this check box to disable the Open (Ctrl+O) WorkSpace file menu
erator accelerator while in the Run-time environment.
Disable Print Accel- Select this check box to disable the Print (Ctrl+P) WorkSpace file menu
erator accelerator while in the Run-time environment.
Other Options
Item Description
Disable <Ctrl> <Alt> Select this check box to disable the <Ctrl><Alt><Delete> key sequence
<Del> at run-time, thereby restricting operators from accessing the Task
Manager, changing their password, logging off, or shutting down the
computer.
Disable Task Switching Select this check box to disable run-time task switching through
<Alt><Tab> and the Start button.
NOTE: The Shift + F10 key macro does not work if you select this
option.
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.
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 pic-
ture 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.
Use this button to move the selected file down in the start-up list.
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 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 Man-
agement Server.
Logon Info
Item Description
Change Management Enter the name of your Change Management Server. For instance, if your server
Server is named MYSERVER, enter MYSERVER in this field.
Test Connection Click to test a connection to the Change Management Server. After you supply
login credentials for the Change Management Server, a message box appears
indicating whether a connection can be made.
NOTE: If you do not have iFIX security Change Management application priv-
ileges, you will receive an error message when you click Test Connection. For
more information refer to the Overview of iFIX Configuration Steps in the
Change Management and iFIX ebook.
Logon at WorkSpace Select this check box to log in to the Change Management Server when you start
Startup 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.
Prompt For User Select this check box if you always want a dialog box requesting login credentials
Name And Password to appear when you logon to the Change Management Server.
At Logon
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.
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 Description
Perform Comments Specifies the name of the table that contains predefined perform comments for
Table Name 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 elec-
tronic signatures, as defined on the General tab. Or, you can enter another
table with perform comments applicable only to the Change Management
Server.
Create Default Per- Use this button to create a new table containing predefined perform comments
form Comments Table for the Electronic Signature dialog box that appears with Change Management
actions in the iFIX WorkSpace.
Verify Comments Specifies the name of the table that contains predefined verify comments for
Table Name 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 elec-
tronic signatures, as defined on the General tab. Or, you can enter another
table with verify comments applicable only to the Change Management Server.
Create Default Verify Use this button to create a new table containing predefined verify comments
Comments Table for the Electronic Signature dialog box that appears with Change Management
verify actions in the iFIX WorkSpace.
None Select this option if no iFIX electronic signature is required to perform a Change
Management function from the WorkSpace.
Perform Only Select this option if an iFIX Performed By electronic signature is required to per-
form a Change Management function from the WorkSpace (in addition to the
Change Management Server login).
Perform And Verify 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).
Allow Continuous Use 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.
The Operations Hub tab of the User Preferences dialog box displays the following items:
Item Description
Server Name Enter the network name of the Operations Hub Server.
SSL Security
Item Description
Require Trusted Con- Select this option if a trusted connection is required to export or publish pic-
nection tures.
View Certificate Select this option to view your trusted certificate.
Export Configuration
Item Description
Mimic Export Path Enter that path where you want Operations Hub to look for your exported pic-
tures.
Publish to Operations Select this option to publish your iFIX pictures to Operations Hub. If the Publish
Hub to Operations Hub option is not selected, pictures are only exported and not
published to Operations Hub. By default, this option is disabled.
The Historian tab of the User Preferences dialog box displays the following items:
Automatically Configure Tags for Collection in Historian
Use this option to configure all tags in your currently loaded database for collection by Proficy Historian.
Collection begins when the Collector starts.
How Do I...
Click a section above for steps on how to use or configure this part of the iFIX WorkSpace.
The following sections provide steps on how to use the system tree in the iFIX WorkSpace:
1. In the iFIX WorkSpace system tree, right-click any folder or document. A pop-up menu appears.
2. From the pop-up menu, select Properties or File Properties.
From the WorkSpace menu in the iFIX WorkSpace, select System Tree. If the system tree was hid-
den, the iFIX WorkSpace displays it. If the system tree was visible, the program hides it.
1. In the iFIX WorkSpace system tree, click the plus sign to open (expand) a folder.
2. Click the minus sign to close (collapse) a folder.
1. In the iFIX WorkSpace, open the source and target picture or Dynamo set.
2. Click, drag, and drop the object into the target to move it. Using the system tree, click, drag, and
drop the object's name over the target's name to move it.
3. 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
1. In the iFIX WorkSpace system tree, click the plus sign to open (expand) both the Dynamo Sets and
the Pictures folders.
2. Place the mouse pointer over a Dynamo set or picture file name. The thumbnail, if it exists,
appears.
NOTES:
l Windowless OLE objects will not display in thumbnails.
l Not all thumbnails appear in a uniform location; some may be centered while others appear in the upper left
hand corner.
The following sections provide steps on how to work with files in the iFIX WorkSpace:
l Creating Files
l Opening Files
l Saving Files
Creating Files
The following sections provide steps on how to create files in the iFIX WorkSpace:
Creating a New File
Opening Files
The following sections provide steps on how to create files in the iFIX WorkSpace:
l Opening a File
l Opening a Back-up File
l Opening Pictures Automatically at Run Time
To open a file:
1. In Classic view, in the iFIX WorkSpace, from the Standard toolbar, click the Open button.
-Or-
In 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.
The following sections provide steps on how to save and delete files in the iFIX WorkSpace:
l Saving a File
l Saving Files Automatically
l Renaming a File
l Deleting a File
Saving a File
To save a file:
1. In Classic view, in the iFIX WorkSpace, on the Standard toolbar, click the Save button.
-Or-
In 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.
Renaming Files
To rename a file:
1. In the iFIX WorkSpace system tree, right-click a closed file.
2. From the pop-up menu, select Rename.
3. Enter the new name when prompted.
Deleting Files
The following sections provide steps on how to start applications and Experts in the iFIX WorkSpace:
l In Classic view, in the iFIX WorkSpace, on the Application toolbar, click the button for the applic-
ation you want to start.
-Or-
l In Ribbon view, on the Applications tab, select the application you want to start.
-Or-
l Double-click the application from the iFIX WorkSpace system tree.
In Classic view, in the iFIX WorkSpace, on the Standard toolbar, click Visual Basic Editor.
-Or-
In Ribbon view, on the Home tab, in the WorkSpace group, click Visual Basic Editor.
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.
-Or-
Configuring a Button
To configure a button:
1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars.
-Or-
In Ribbon view, on the Home tab in the WorkSpace group, click Setting, and then click Toolbars.
2. Click Customize.
3. Click the Buttons tab.
4. Select the category for the button you want to modify.
5. 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.
7. In the Name field, enter the button's name.
8. In the Description field, enter text describing the button.
9. In the ScreenTip field, enter the button's ToolTip.
10. Click Edit Script to launch the Visual Basic Editor.
11. Write a script for the button.
The following sections provide steps on how to work with environments in the iFIX WorkSpace:
1. In Classic view, in the iFIX WorkSpace configuration environment, click Switch to Run on the Stand-
ard toolbar.
-Or-
In 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.
The following sections provide steps on how to use the start-up environment for the iFIX WorkSpace:
Starting the iFIX WorkSpace in the Configuration Environment
The following sections explain how to set the display options for the Ribbon in run mode:
To disable the Ribbon auto hide feature in full screen run mode:
1. Press the Alt key to view the Quick Access toolbar.
2. On the Quick Access toolbar, from the Customize Quick Access Tool list, clear Auto Hide the Rib-
bon.
Enabling the Ribbon Auto Hide Feature in Full Screen Run Mode
To enable the Ribbon auto hide feature in full screen run mode:
1. Press the Alt key to view the Quick Access toolbar.
2. On the Quick Access toolbar, from the Customize Quick Access Tool list, select Auto Hide the Rib-
bon.
The following sections provide steps on how to configure environment protection in the iFIX WorkSpace:
Disabling Environment Protection
The following sections provides steps on how to customize the Ribbon user interface.
l Showing Keytips
l Disabling Keytips
l Changing the WorkSpace Color Scheme
l Changing the Screentip Style
l Adding Commands to the Quick Access Toolbar
l Moving the Quick Access Toolbar
l Removing Commands from the Quick Access Toolbar
l Resetting the Quick Access Toolbar
l Customizing Keyboard Shortcuts
Showing KeyTips
Disabling KeyTips
To disable KeyTips:
There are three methods you can use to add commands to the Quick Access toolbar.
1. In the iFIX WorkSpace, in the Ribbon, right-click the command you want to add to the Quick Access
toolbar.
2. Click Add to Quick Access Toolbar.
To add commands to the Quick Access toolbar (method 2):
1. In the iFIX WorkSpace, on the Ribbon, click the Application tab.
2. Right-click an empty portion of the Ribbon, and select Customize Quick Access Toolbar. The Cus-
tomize dialog box appears.
3. In the Choose Commands From list, select the category that contains the command you want to
add the to the Quick Access toolbar.
4. In the Commands list, for each the command you want to add to the Quick Access toolbar, select
it and then click Add.
5. Repeat Step 4 until all desired commands are added.
6. To change the order of which the commands appear on the Quick Access toolbar:
a. Click the command to move.
b. Use the up or down arrow to move the command in the desired direction.
c. Repeat steps a and b until commands are in the desired order.
7. Click OK.
To add commands to the Quick Access toolbar (method 3):
1. Right-click the Quick Access toolbar, and select Customize Quick Access Toolbar. The Customize
dialog box appears.
2. In the Choose Commands From list, select the category that contains the command you want to
add the to the Quick Access toolbar.
3. In the Commands list, for each the command you want to add to the Quick Access toolbar, select
it and then click Add.
4. Repeat Step 3 until all desired commands are added.
5. To change the order of which the commands appear on the Quick Access toolbar:
a. Click the command to move.
b. Use the up or down arrow to move the command in the desired direction.
c. Repeat steps a and b until commands are in the desired order.
6. Click OK.
There are three methods you can use to move the Quick Access toolbar either above or below the Rib-
bon.
NOTE: The following procedures apply only to Ribbon view.
1. Click the Application button and then on the Application menu, click Options.
2. In the Navigation Plane, click Customize.
3. To show the Quick Access toolbar below the Ribbon, select Show Quick Access Toolbar Below the
Ribbon.
4. To show the Quick Access toolbar above the Ribbon, deselect Show Quick Access Toolbar Below
the Ribbon.
5. Click OK.
To move the Quick Access toolbar (method 3):
There are three methods you can use to remove commands from the Quick Access toolbar.
NOTE: The following procedures apply only to Ribbon view.
1. In the iFIX WorkSpace, on the Quick Access toolbar, right-click the command you want to remove.
2. Click Remove from Quick Access Toolbar.
To remove commands from the Quick Access toolbar (method 2):
1. Click the Application button and then on the Applications menu, click Options.
2. In the Navigation pane, click Customize.
3. In the list of commands in the box on the right, click the name of the command to remove and click
Remove.
4. Click OK.
To remove commands from the Quick Access toolbar (method 3):
Setting Preferences
The following sections provide steps on how to set preferences in the iFIX WorkSpace:
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.
-Or-
In Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Prefer-
ences.
2. Click the General tab.
3. Select the Extend WorkSpace to support multiple monitors check box.
4. Click OK.
1. In Classic view, from the iFIX WorkSpace menu, select User Preferences.
-Or-
In Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Prefer-
ences.
2. Click the General tab.
3. To enable Ribbon view, select the Enable Ribbon User Interface check box.
4. To enable Classic view, clear the Enable Ribbon User Interface check box.
5. Click Ok.
6. Restart the WorkSpace for changes to take effect.
NOTES:
l Enabling this feature causes all of your database tags to be collected by Historian.
l 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.
l You can enable collection, one tag at a time, on the Historian tab of the database block itself. For more inform-
ation, see Enabling or Disabling Block Collection by Historian.
l This feature does not work if you have a run-time only license for iFIX.
1. In Classic view, from the iFIX WorkSpace menu, select User Preferences.
-Or-
In Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Prefer-
ences.
The following sections provide steps on setting picture, shape, drawing, and chart preferences in the iFIX
WorkSpace:
Setting Picture Preferences
Globally Translating Picture Text
Setting Drawing Preferences
Setting Save Preferences
Setting Standard Chart Preferences
The following sections provide steps on how to set run-time preferences in the iFIX WorkSpace:
The following sections provide steps on how to select data sources and build expressions in the iFIX
WorkSpace:
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 anim-
ation.
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 anim-
ation.
2. Click the Browse button to the right of the Data Source field. The Expression Builder dialog box
appears.
3. Click the tab that contains the items you want to use in your expression, as follows:
l To include a data source in an expression, click the node, block, and field from the FIX Data-
base tab.
l To include properties of picture objects, click the Pictures tab.
l To include historical data, click the Historical tab.
l To include global objects, click the Globals tab.
l 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. 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.
4. If you want to combine two expressions, click the Mathematical Functions button and an operator
button followed by a numeric value or another expression.
5. Repeat steps 2 through 4, moving from tab to tab until you have included all the items you want in
the expression.
6. Enter the tolerance, deadband, and refresh rate for this connection.
7. 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.
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 anim-
ation.
2. Click the Browse button to the right of the Data Source field. The Expression Builder dialog box
appears.
3. Click the tab you want to display.
4. Enter the text you want to display, including any wildcards, in the Filter field.
5. Click the Filter button.
1. In Classic view, from the iFIX WorkSpace menu, select User Preferences.
-Or-
In Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click User Prefer-
ences.
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.
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 anim-
ation.
2. Click the Browse button to the right of the Data Source field. The Expression Builder dialog box
appears.
3. Click the FIX Database tab.
4. In the Tolerance field, enter the maximum allowable rounding factor for the data source or expres-
sion you are building. If the value of the data source or expression is within the tolerance of a tar-
get value, iFIX assumes the two values are equal.
5. 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.
6. In the Refresh Rate field, select how often to update the data source or expression, in seconds.
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
The following sections provide steps on how to manage files and nodes in the iFIX WorkSpace:
l Sharing Files
l Starting iFIX with an SCU file from a different path
l Getting a Different iFIX Project from the Change Management Server
l Creating a Factory Default
l Finding and Replacing Data Overview
l Using the Backup and Restore Wizard Overview
1. In Classic view, in the iFIX WorkSpace, click the System Configuration Utility button on the toolbar.
-Or-
In Ribbon view, on the Applications tab, in the System & Security group, click SCU.
2. Click the Paths button on the SCU toolbox.
3. In the appropriate field(s, enter the network path(s) you want to use. For example, enter a net-
work path in the Picture field, such as C:\Program Files (x86)\GE\iFIX\PIC, to change the Picture
path.
4. Copy all the files in the shared paths from your local node to your file server.
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.
1. Shut down iFIX.
2. On the Start menu, point to Programs, iFIX, and then System Configuration to open the SCU. The
SCU window appears.
3. From the SCU Configure menu, click Paths. The Path Configuration dialog box appears.
4. 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.
5. From the SCU Configure menu, click Tasks. The Task Configuration dialog box appears.
6. 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.
7. From the SCU Configure menu, click Network. The Network Configuration dialog box appears.
8. In the Network Configuration dialog box, confirm the information is correct and make changes if
necessary.
9. From the SCU Configure menu, click SQL, and then click Configure SQL Tasks. The SQL Task Con-
figuration dialog box appears.
10. In the SQL Task Configuration dialog box, make sure that the Primary and Secondary paths are cor-
rect, 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.
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. In the Select Project drop-down list, select a project name.
3. 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.
4. 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.
5. If you want to copy iFIX default files into the folder before retrieving the project, select the Ini-
tialize 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.
6. Click Get. A status box appears as the iFIX project files are copied to your local computer.
7. If you want to start iFIX using the SCU from the project you just got, follow the steps below.
To start iFIX with that project's SCU:
NOTE: These steps start iFIX with an SCU from a different path (a path outside the install path).
1. Shut down iFIX.
2. On the Start menu, point to Programs, iFIX, and then System Configuration to open the SCU. The
SCU window appears.
3. From the SCU Configure menu, click Paths. The Paths Configuration dialog box appears.
4. 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.
5. From the SCU Configure menu, click Tasks. The Tasks Configuration dialog box appears.
6. 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.
7. From the SCU Configure menu, click Network. The Network Configuration dialog box appears.
8. In the Network Configuration dialog box, confirm the information is correct and make changes if
necessary.
9. From the SCU Configure menu, click SQL, and then click Configure SQL Tasks. The SQL Task Con-
figuration dialog box appears.
10. In the SQL Task Configuration dialog box, make sure that the Primary and Secondary paths are cor-
rect, 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.
NOTE: You can modify the BackupRestore.ini file to create user specific defaults. For more information, refer to
the BackupRestore.ini file.
The following sections provide steps on how to find and replace data in the iFIX WorkSpace:
l Finding Data
l Replacing Data
Finding Data in Pictures, Schedules, and Scripts
Replacing Data in Pictures, Schedules, and Scripts
The following sections provide steps on how to use the Backup and Restore wizard in the iFIX
WorkSpace:
Restoring Files From an Archive
Defining the Active Batch Execution Project
The following sections provide steps on how to install and use the Historian server in the iFIX WorkSpace:
You must shut down Historian services and licensing prior to installing iFIX and Historian. To use the integ-
rated Proficy Historian features in iFIX, you must install Historian.
To configure Proficy Historian and iFIX:
1. Restart your computer. Manually start the Proficy Historian Archiver through the Windows Service
Control Panel, if it is not already running.
2. Confirm that the Collectors installed. To do so:
a. On the Start menu, click Programs, Proficy Historian, and then Historian Administrator. The
Historian Administrator program starts.
b. Log into the Historian Administrator.
c. Click Collectors.
d. Verify that all of your collectors appear in the Collectors area, especially the iFIX collector.
To create a common Historian Server configuration (also known as global Historian aliasing):
1. In Classic view, locate the Proficy Historian toolbar and then click the Configure Historian Server
button, which is the third of the four buttons.
-Or-
In Ribbon view, on the Administration tab, in the Proficy Historian group, click Configure Historian,
and then click Configure Historian Server.
3. Click Add Server.
4. In the Alias Name field, enter an alias.
5. In the Server Name field, enter a server name.
6. If required, in the User Name and Password fields, enter a user name and password, respectively.
7. Click Add Server.
1. In Classic view, locate the Proficy Historian toolbar and then click the Configure Historian Server
button, which is the third of the four buttons.
-Or-
In Ribbon view, on the Administration tab, in the Proficy Historian group, click Configure Historian,
and then click Configure Historian Server.
3. From the Alias Name/Server Name list, select the server to delete.
4. Click Delete.
5. Click Close.
1. In Classic view, locate the Proficy Historian toolbar and then click the Configure Historian Server
button, which is the third of the four buttons.
-Or-
In Ribbon view, on the Administration tab, in the Proficy Historian group, click Configure Historian,
and then click Configure Historian Server.
3. From the Alias Name/Server Name list, select a server to modify.
4. Click Modify.
5. Click Close.
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 Historian Server but-
ton, which is the third of the four buttons.
-Or-
In Ribbon view, on the Administration tab, in the Proficy Historian group, click Configure Historian,
and then click Configure Historian Server.
1. In Classic view, locate the Proficy Historian toolbar and then click the Configure Historian Server
button, which is the third of the four buttons.
-Or-
In Ribbon view, on the Administration tab, in the Proficy Historian group, click Configure Historian,
and then click Configure Historian Server.
3. Click Get Collectors.
4. From the Collector Name list select a collector.
5. Click Set Default. The selected collector is set as the default Historian collector.
NOTES:
l For iFIX 5.1 automatic collection, you must select the iFIX collector.
l If you are upgrading your system, set your existing collector as the default collector.
l 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 Historian and Enhanced Failover sec-
tion.
l Because this feature only supports collectors that read data from iFIX, the collectors available for selec-
tion are limited to the following:
l iFIX Native Collector
l OPC Collector reading from Intellution.OPCEDA or Intellution.OPCiFIX OPC servers
The following table lists some specific troubleshooting information for configuring Proficy Historian and
iFIX.
Scenario Solution/Explanation
I reloaded my database. I Verify that:
have a tag named AI1; I
l The default Collector is configured.
have set Enable Collection
on this tag and updated l A connection exists between iFIX and Historian.
the necessary Historian
l You have configuration privileges.
fields. However, the tag
does not seem to be col- There are a number of reasons why tags are not collected. If
lected. none of the preceding reasons seem to be the cause, check the
The following sections provide steps on how to work with toolbars in the iFIX WorkSpace:
1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars.
-Or-
In Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars.
2. Select the owner for the toolbars you want to show or hide.
3. 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 iFIX WorkSpace:
Removing a Button From a Toolbar
Arranging Buttons on a Toolbar
Enabling and Disabling Toolbar Docking
Resetting Standard Toolbars
The following sections provide steps on how to create and work with toolbars in the iFIX WorkSpace:
l Creating a Toolbar
l Deleting a Toolbar
l Modifying Toolbar Properties
l 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.
-Or-
In Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars.
2. Click Customize.
3. Click the Toolbars tab.
4. Click Add Toolbar.
5. Enter a name for the toolbar.
6. Select the toolbar's owner from the Owner list. If the owner you want does not appear:
a. Close the Customize Toolbars dialog box.
b. Open a document of the associated type. For example, open a picture to select Picture as
an owner.
7. Repeat steps 1 through 6.
8. Add buttons to the toolbar.
9. Edit each button's script as needed.
Deleting a Toolbar
To delete a toolbar:
1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars.
-Or-
In Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars.
2. Click Customize.
3. Click the Toolbars tab.
Modifying Toolbar Properties
Editing the Script of a Toolbar Button
Creating Buttons
The following sections provide steps on how to create button in the iFIX WorkSpace:
Deleting a Category
To delete a category:
1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars.
-Or-
In Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars.
2. Click Customize.
3. Click the Buttons tab.
4. Select the category you want to delete.
5. Click Delete Category.
NOTE: You can delete user-created categories only.
To create a button:
1. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars.
-Or-
In Ribbon view, on the Home tab in the WorkSpace group, click Settings, and then click Toolbars.
2. Click Customize.
3. Click the Buttons tab.
4. Select the category you want to assign the button to.
5. Click Add Button.
6. 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.
-Or-
In Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars.
2. Click Customize.
3. Click the Buttons tab.
4. Select the category for the button you want to delete.
5. Select the button and click Delete Button.
6. Click OK when you are prompted to confirm the deletion.
NOTE: You can delete buttons only from user-created categories.
Modifying Button Properties
Displaying a Toolbar
To display a toolbar:
1. Open the iFIX Workspace.
2. In the WorkSpace system tree, double-click the Project Toolbar Files folder, and then the Toolbars
folder.
3. 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. Copy the toolbar file (.TBX) you want to import to the Local path of your computer.
2. In Classic view, in the iFIX WorkSpace, from the WorkSpace menu, select Toolbars.
-Or-
In Ribbon view, on the Home tab, in the WorkSpace group, click Settings, and then click Toolbars.
3. Click Customize.
4. Click Import.
5. From the Toolbars list box, select the file.
6. From the Owner list, select the owner. If the owner you want does not appear:
a. Close the Customize Toolbars dialog box.
b. Open a document of the associated type. For example, open a picture to select Picture as
an owner.
c. Repeat steps 1 through 6.
7. Click Import.
The following sections provide steps on how to install and use a third-party OPC server in the iFIX
WorkSpace:
1. On the Start menu, point to Programs, iFIX, Tools, and then Data Server Installer.
2. Click Add or double-click the data server you want to modify.
3. In the Data Server field, enter an OPC data source name. Make sure the name is not already in
use.
4. From the OPC server list, select an OPC driver.
5. In the Machine Name field, enter the local or remote computer name where the OPC Server
resides.
6. 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.
1. On the Start menu, point to Programs, iFIX, Tools, and then Data Server Installer. The Data Server
Installer dialog box appears.
2. Select the OPC server you want to delete.
3. Click Remove.
NOTE: You must have rights to write to the registry in order to perform this task.
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, 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. From the Start menu, select Run and enter Regedit.
2. Open the key HKEY_CLASSES_ROOT\FIX32\DataSources.
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 = ""
System Functions
l Basic Functions
l HMI and SCADA Functions
l Reporting Functions
l Open Architecture Functions
l 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.
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 prop-
erties. 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 hard-
ware 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 per-
formance, reliable OPC enabled I/O servers. Any server written with the toolkit can talk to OLE auto-
mation 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
Once data is acquired, it is manipulated and channeled according to requests from your application soft-
ware. This process is known as data management.
One of the most important goals of automation is to use plant resources more efficiently. Traditionally,
plant floor operations have been monitored and controlled through control room panels. iFIX can
enhance or replace many of these traditional control room functions, including:
l Monitoring
l Supervisory Control
l Alarming
l Control
Monitoring
Monitoring is the ability to gather and display real-time plant-floor data to all relevant personnel. Power-
ful numeric, text, and graphical formats are available to make real-time data more accessible, easier to
read, and easier to understand.
Supervisory Control
With iFIX, you can easily control who has access rights to this data and which data points can be changed.
Alarming
Alarming is the ability to recognize exceptional events within your process and immediately report those
events to the appropriate personnel. Alarms are generated based on the control limits you establish and
can be reported in a variety of ways.
For additional information refer to the Implementing Alarms and Messages manual.
Control
Control is the ability to automatically apply algorithms that adjust process values and thereby maintain
those values within set limits. Control goes one step beyond supervisory control by removing the need for
human interaction.
iFIX includes continuous control, batch control, and statistical process control capabilities. It can be used
to control your whole process or part of your process.
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. Man-
agers and engineers can use this data to examine the events leading up to a critical event after address-
ing more immediate problems.
Reports
Detailed reports are important tools for reviewing the performance of a process. They allow you to
quickly grasp the relationships between specific pieces of manufacturing process data so that you can
make effective decisions. Using any third-party reporting application that supports ODBC queries, you
can create customized reports based on iFIX real-time and historical data. When you use iFIX real-time
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
Many plants have unique needs that can be solved through access to real-time data. iFIX provides read
and write access to any data point in the system. This open architecture allows you to use custom and
third-party applications to resolve your unique automation needs. The following figure illustrates the
open architecture functions.
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.
User configuration applications allow you to create the instructions and logic that monitor and control
your process. These applications create configuration files. When started, system applications read the
configuration files and use the information found here to execute the assigned tasks.
The Event Scheduler is an example of a user configuration application. In the Event Scheduler, you define
the event that triggers an action (for example the time of day or a change in your process) and the action
that you want to occur. Once the event is scheduled, the action automatically triggers when the event
occurs. No further interaction is required.
System Applications
System applications work with your process in real-time. These applications receive instructions from
configuration files and require little or no interaction. In general, system applications have priority access
to system resources.
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.
This chapter explains how to manage your iFIX nodes with the iFIX WorkSpace by backing up and restor-
ing your files. The chapter also describes other management tasks you can complete with the
WorkSpace, such as configuring the local computer, finding and replacing data in iFIX, and specifying the
active Batch Execution project.
Your main tool for configuring your computer for use with iFIX is the System Configuration Utility (SCU).
This program lets you configure the computer's:
l Network connections.
l Alarm routing and destinations.
l SCADA and I/O driver options (for SCADA servers only).
l Security options (when iFIX is running).
l iFIX paths.
l Start-up tasks.
l Alarm area configuration.
To learn more about the SCU, refer to the Setting up the Environment manual.
To create projects, you use the iFIX System Configuration Utility (SCU). For each project you create, there
is a separate, unique SCU file.
To access the SCU, double-click the SCU icon in the WorkSpace system tree, or click the Start button and
point to Programs, iFIX, and then SCU. You can also start the SCU directly from the iFIX Startup dialog
box, also known as the Launch application. Make sure you shut down iFIX before starting the SCU. You
cannot make edits in the SCU while iFIX is running.
3. In the Project field, enter a path for the project. For example, a valid path that you might enter for
a developer would be: C:\Program Files (x86)\GE\iFIX\PRJ\Dev1.
5. Click Yes. The project path information from the Project field is appended to the other project
path fields, such as Local, Database, Picture, Application, and so on.
For instance, if you enter C:\Program Files (x86)\GE\iFIX\PRJ\Dev1 in the Project field, the SCU
automatically adds \PRJ\Dev1 to the other project fields as well. For instance the Local path in
this dialog box would now read: C:\Program Files (x86)\GE\iFIX\PRJ\Dev1\Local. The Database
path would read: C:\Program Files (x86)\GE\iFIX\PRJ\Dev1\PDB, and so on.
NOTE: While the paths displayed in the Path Configuration dialog box appear to be added at this point, the
actual folders for these paths have not been created yet. While you can view the new paths from this dialog,
you will not be able to view them from the Windows Explorer until you complete the remaining steps in this
section.
6. If there are any paths that you want to change, such as to a shared directory, manually edit the
path fields.
7. Click OK from the Path Configuration dialog box. A message box appears asking you to create the
folders for the configured paths.
8. Click Create All. A message box may appear indicating you do not have a valid Alarm Area Data-
base file.
9. Click Proceed to continue.
iFIX creates the paths for the project folders. You should be able to view the new folders in Win-
dows Explorer.
10. On the File menu, click Save As. The Save File As dialog box appears.
11. Browse to the Project's Local folder. For instance, for Developer1 browse to the C:\Program Files
(x86)\GE\iFIX\PRJ\Dev1\Local folder.
12. Enter a name for the SCU file.
Valid SCU file names can be up to eight characters long. SCU file names can include alphanumeric
characters, but must begin with a letter. Special characters, such as symbols and punctuation
marks, cannot be used.
For example for Developer1, you might enter Dev1.
13. Click Save. A message box appears asking you if this is the SCU file that you want to use next time
you restart iFIX.
14. Click No.
15. If you have a template folder with iFIX files that you want to copy into one or more project folders,
use the Windows Explorer to copy the files from the template folders into the new project folders.
After you have created all the projects, you can go back later and edit all the other SCU settings for each
project that require changing. For more detailed information about configuring the rest of the options for
the SCU files, refer to the Configuring iFIX Using the SCU chapter in 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 dis-
plays 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 net-
work drive, such as Z:\Program Files (x86)\GE\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.
If you are using a shared PIC directory on a drive other than the one on which iFIX is installed, you must
enter the full path in the SCU.
For example, if you want to use a shared PIC directory on the G:\drive, you must enter G:\PIC in the SCU.
If you enter G:\, your WorkSpace will not open correctly.
Many process environments are expansive, and may include pictures or schedules that reference many
sources of data for operations in different locations throughout your plant. If you need to reroute certain
data to another node, or globally change a data source throughout a plant, you can do so quickly, without
disrupting operation or using valuable resources by finding and replacing data.
Finding data locates values of picture and schedule properties that match the search string. It also loc-
ates property values of objects in your pictures. The search string you enter indicates the data you want
to locate and optionally replace. Any property value that matches this text appears on the Find tab. On
the Replace tab, only values you can modify appear.
Match Case – Finds text that matches the exact case of the search string.
Whole Word Only – Finds only whole words that match the search string. A whole word is any text
delimited by a carriage return, a line feed, a space, a hyphen (-), a semi-colon (;), a colon (:), a comma
(,), a period (.), an underscore (_), an exclamation point (!), quotation marks ("), apostrophe ('), par-
enthesis ( ), braces { }, or brackets [ ]. This means that a typical data source, such as
Fix32.MIXER1.AI1.F_CV contains five words.
Data Source Only – Finds only data sources that match the search string.
NOTE: If a data source used to animate an object has its Data Conversion type set to Object, the data source is ignored
during all Find operations.
Include Scripts – Finds text in the scripts associated with the current picture or schedule.
Replace Options
When replacing data, you can select from the following options:
Replace Preview – Displays the results of replacing all property values in the Replace Value With
column.
NOTE: You cannot undo a Find and Replace operation and the text you enter as the replacement string appears exactly
as you enter it.
Notes on Special Characters in Search Strings
When you use wildcard characters such as the * or ? character in your search string, text containing the
following special characters will not be found even if it satisfies the search criteria:
" ' ( ) * + ; ? @ ^ ' { } ~
For instance, if you want to locate joe@company.com and enter j*com as your search string in the Find
What field, the joe@company.com term is not found, since the text includes a special character (@).
Example: Finding and Replacing Data
Assume you want to replace all of the tags in a picture from MIXER.AI_VALVE_OPEN to MIXER.AI_VALVE_
CLOSED. One way you can change these value is to perform a whole word find and replace.
To perform a whole word find and replace:
Using Wildcards
One of the most powerful options you have when finding and replacing data is the ability to include wild-
cards in search strings and the replacement text you enter. You can enter any of the following wildcards:
? – Finds any single character. For example, the search string TAN? locates the string TANK. It also loc-
ates 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.
l If the search string has wildcard characters, the replacement string must have the same wildcard
characters or none at all.
l If the search string has no wildcard characters, the replacement string cannot have any wildcard
characters.
l Do not use * and ? in the same search string.
The table below details some examples of using wildcards with Find and Replace.
iFIX lets you add find and replace capabilities to your scripts using the FindReplace interface in the
FixScriptGlobal object. Refer to the Writing Scripts manual and the iFIX Automation Interfaces Help file
for more information.
In order to use the Find and Replace command on User Globals, you must right-click the User icon in the
Globals folder in the system tree, and select Find and Replace from the menu. You cannot perform a Find
and Replace on User Globals by selecting Find and Replace from the Edit menu (Classic view) or on the
Home tab, in the Editing group, click Find and Replace (Ribbon view). That menu belongs to the active doc-
ument only.
Note that the Find and Replace dialog box displays the name of the document being searched in its title
bar. For example, if you perform a Find and Replace on User Globals, Find and Replace User appears in
the title bar.
To help you manage your iFIX files, use the iFIX Backup and Restore feature. Access this feature through
the Backup and Restore Wizard or from the command line. Command line parameters are available to
automate backup or restore operations in scripting or external programs.
With this feature, you can backup your entire iFIX system or portions of it. You can later use these backed
up files to restore your iFIX system, or specific parts of it. Additionally, you can restore your iFIX system
to the factory default settings and files – a clean restore. This feature is helpful in configuring new com-
puters with the same configuration, or in disaster recovery.
Overview of Files
A Custom Backup of iFIX includes a subset of the following files:
l SCU files
l Configuration files
l Pictures and Dynamo sets
l Process and alarm area databases
l I/O driver configuration files and exported databases
l Alarm files
l Historical configuration and data files
l Tag groups
A Full Backup includes all of your iFIX files in the following folders:
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:
l To backup and restore driver configuration files, you must add the driver in the SCU's SCADA Configuration dia-
log 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.
l 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 (x86)\GE\iFIX\PDB.
l Be sure check the default iFIX path configurations in the SCU in each of your iFIX projects after you restore your
files. For example, if you installed the latest version of iFIX to a 64-bit path C:\Program Files (x86)\GE\iFIX), and
your previous picture files were installed to a 32-bit path (C:\Program Files (x86)\GE\iFIX), you will need to
make sure you update these paths in the SCU to 64-bit.
Accessing the Backup and Restore Wizard
To access the Backup and Restore wizard, click the Start button and point to Programs, iFIX, Tools, and
then Backup and Restore Wizard. You can also access the application by locating and running the
BackupRestore.exe file in the iFIX folder, which is the folder where you installed iFIX. If you want to
The following figure shows the main screen that appears when you open the Backup and Restore Wizard.
The Backup and Restore Wizard allows you to perform the following types of backup:
l Custom Backup – Allows you to select the specific files within the project path to backup.
l Full Backup – Archives all files, including security and INI files within the project path. This
includes all files in the APP, HTR, HTRDATA, LOCAL, PDB, PIC, RCC, and RCM folders.
l Factory Default Backup – Allows you to create a new factory default backup file. The Factory
Default is a set of default iFIX files used to perform a clean restore. A standard FactoryDefault.IFD
file is provided with the iFIX product. You can create a new, customized one, and save it under
another name or the same name, using this option.
The steps below explain how to perform a backup with the Backup and Restore Wizard. For steps on how
to use the command line, refer to the Using the Command Line Options section.
To perform a custom backup:
1. In the Backup and Restore Wizard main screen, select the Custom Backup option.
2. Click the Backup button. The following figure appears.
3. Verify that the Backup Source Info is correct. For more information about modifying the project
path, refer to the Best Practices for Managing Multiple iFIX Users section.
4. In the Backup File Option section, select the specific files or folders that you would like to back up.
5. 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 secur-
ity files in archive option does not appear.
6. Click the Next button.
7. 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 (x86)\GE\iFIX\ProjectBackup\nodename.FBK; how-
ever, 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:\
1. In the Backup and Restore Wizard main screen, select the Full Backup option.
2. Click the Backup button.
3. 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 (x86)\GE\iFIX\ProjectBackup\nodename.FBK; how-
ever, 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.
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. Click the Next button.
6. 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\Proficy\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 Fact-
ory 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.
You can restore your archived files to any computer that has iFIX installed. Prior to restoring the files, you
can select the individual types of files you want to restore or you can restore the entire archive.
The Backup and Restore Wizard includes the following restore features:
l Ability to select a specified destination for the restored files, as well as the individual files you
want to restore.
l Ability to delete all existing files under a target project path before performing a restore. This
action removes any existing application files in the destination paths, with the exception of the
security files.
l Ability to restore the iFIX factory defaults of your original install before restoring the backup files.
l Option to retain the current SCU security settings for the restore, replace the SCU settings with
the ones in the archive, or create a new project requiring the input of a new project folder to com-
plete the restore.
The steps below explain how to perform a restore with the Backup and Restore Wizard. For steps on
how to use the command line, refer to the Using the Command Line Options section.
To restore an archive:
1. In the Backup and Restore Wizard main screen, select the Restore button.
2. 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 (x86)\GE\iFIX\ProjectBackup folder.
3. Click Next to continue. The following dialog box appears, allowing you to select the appropriate
restore options.
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. In the Backup and Restore Wizard main screen, select the Restore button.
3. 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 (x86)\GE\iFIX
folder.
4. Click Next to continue.
5. 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 choose to overwrite an existing SCU file, be sure to verify that the computer's hardware key sup-
ports 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 soft-
ware 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 over-
write the existing SCU file. The Node field defines the node name stored in the archived SCU file; the Pro-
ject 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 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.
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 can-
not 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 exist-
ing 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
more information, refer to the BackupRestore.ini file.
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 set-
tings 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 secur-
ity 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 pro-
ject.
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 des-
tination:
Are security files present in current Are security files Destination of restored
iFIX configuration? present in archive? security files:
1 No No N/A
2 No node.dov Target local path
3 No Display.dov Target local path
4 node.dov node.dov Target local path
5 node.dov Display.dov Target local path
6 Display.dov node.dov Target local path
7 Display.dov Display.dov Current global security
path
NOTE: In the previous table, node.dov denotes that local security settings related to a single project are found. Dis-
play.dov denotes that global security settings are found.
In the 2nd and 3rd configurations shown in the table, the security files are restored to the target local
path. The user receives no warning message.
In the 4th and 5th configurations, the security files are also restored to the target local path. A warning
message displays the current security path and the new security path. As node.dov relates to a specific
single project, if the current path is not equal to the target path, the existing security settings remain and
the archived security settings are restored to a new project path. If the current path is equal to the tar-
get 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 secur-
ity 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.
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.
You can also run the Backup and Restore utility from the command line. This is especially useful if you
want to automate the backup and restore operations through scripting or external programs.
l 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.
l 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.
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.
/? Opens the Help for the command line options.
NOTE: If you do not define the /P option while running a Backup, the source path is taken from the current SCU setting.
If you do not define the /P or /A option while running a Restore, the destination is the current SCU setting.
Examples
This command performs a custom backup silently including security files, without displaying the Backup
and Restore Wizard:
BackupRestore.exe /B="C:\Program Files (x86)\GE\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 (x86)\GE\iFIX\ProjectBackup\FIX.fbk" /S /RestoreSec
This command performs a project restore to the project path archived in the SCU, and shows a progress
bar for restore process:
BackupRestore.exe /R="C:\Program Files (x86)\GE\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 (x86)\GE\iFIX\ProjectBackup\FIX.ifd" /S
Return Code
The Backup and Restore application returns the following exit codes after it runs.
When you run the user interface for the Backup and Restore, instead of using the com-
mand 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 .
2 Backup or Restore action unable to start, for any reason. For example: an invalid com-
mand 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 (x86)\GE\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 inform-
ation and the time when the BackupRestore.exe program started.
The Factory Default is a set of default iFIX files used to perform a clean restore. A standard Fact-
oryDefault.IFD file is provided with the iFIX product. Refer to the Files Included in the FactoryDefault
Backup File section below for a list of files included in the standard .IFD file.
NOTE: Be aware that if you later install an iFIX SIM as a product update, and that SIM contains updated iFIX factory
default files, the SIM installer prompts you to update the original FactoryDefault.IFD file as a part of the SIM installation.
You can also create your own Factory Default file, with the .IFD file extension, to include custom toolbars,
custom 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 over-
write the original FactoryDefault.IFD file, or create a new one. Most likely, you will want to leave the ori-
ginal Factory Default file, and save the file under another name.
IMPORTANT:
l 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.
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.
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 fact-
ory default files, the SIM installer prompts you to update the original FactoryDefault.IFD file as a part of SIM the install-
ation.
Sample BackupRestore.ini
Use the BackupRestore.ini to specify default and custom settings that appear in the Backup and Restore
Wizard, and when you run BackupRestore.exe from a command line. The BackupRestore.ini file is located
in the iFIX LOCAL folder. If you installed iFIX to the default location, you can find the BackupRestore.ini in
the C:\Program Files (x86)\GE\iFIX\LOCAL folder.
l [Version] – used to determine iFIX product version in archive header signature. This section is
required. Do not change this value.
l [DefaultSubProject] – used to determine default sub-project paths for the Create New Project
option in the Restore operation.
l [FactoryDefaultExtension] – used to determine which files are included in Factory Default set-
tings.
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 from the iFIX LOCAL folder that includes all four of
the sections defined above:
;BackupRestore.ini - Customizing your BackupRestore.ini file
;
;[Version]
; Do not change the Version key.
; If you create your own .ini file using the /I option, this section and key are required.
;
;[DefaultSubProject]
; 1. If you select the "Create New Project" destination option,
; define the sub-project folders here.
; 2. If you use the /P option during backup, the sub-project folders defined here are archived.
; 3. If you use the /P option during restore, the archive files are restored to the sub-project
; folders defined here.
;
;[FactoryDefaultExtension]
; If you generate your own FactoryDefault file, use this section to define which files to
; include in your FactoryDefault backup.
;
;[WizardSettings]
; Use the FACTORYDEFAULT key in your FactoryDefault file when select the "Restore default
; iFIX files before restoring your backup files" option during a restore.
;
; The FACTORYDEFAULT_PATH key is used for your FactoryDefault file path. If this section is blank,
; your current BASEPATH is used.
; For example: FACTORYDEFAULT_PATH=C:\MySetting (do not add "\" at the end)
;
;[AddCustomExtension]
; If you like to add file type to custom backup, it allows you to define
; additional extension for each categories to include/exclude files to backup.
; To make it enabled, change AddExtension to True.
; AddExtension=TRUE
; Then, add file name or file type for specific key in categories. For example:
; [AddCustomExtension]
; AddExtension=TRUE
; PicIncludeExtn=*.bmp,*.jpg
; PicExcludeExtn=aaaa.bmp
If you have Batch Execution installed on your computer, you can configure the local node by specifying a
name for the current project with the iFIX WorkSpace. In Batch Execution, a project is the entire set of
files needed to deliver a batch solution. Typically, a project includes:
l Pictures
l An equipment database
l Recipes
l Configuration files
However, a project can also include Word files, Excel spreadsheets, or documents from other OLE-com-
pliant applications.
You can display the Contents, Index, or Search navigation tools in the left frame by clicking the appro-
priate tab. Text and graphics in the electronic book appear in the frame on the right side of the screen. Ini-
tially, the collapsed table of contents is displayed in the left frame and the cover page is displayed in the
right frame.
The following buttons are displayed at the top of the electronic book window.
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.
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.
You can navigate through the electronic books using the tables of contents. The Contents tab appears on
the top of the left frame.
l Double-click the book title to expand the table of contents and display section titles in the book.
The closed book icon changes to an open book icon.
l 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.
l 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 right-clicking the left
frame and selecting Close All from the menu.
You can search for topics in the iFIX electronic books by using either the Index tab or the Search tab:
Index – Lets you search all iFIX books for topics by keyword. The index displays entries that match or
begin with the keyword.
Search – Lets you search all iFIX electronic books for a specific text string. A list of all topics that contain
that search string is displayed.
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 vari-
ations, 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 oper-
ators, and the expected topic(s) will not be found in the search. For example, both of the following search strings should
find the appropriate topics:
"items not supported"
("items not supported")
Searching with Wildcard Expressions
You can use the * symbol to search for multiple unknown characters in a word or phrase. You can also
use the ? symbol for a single unknown character in a search. For example, the entry iW* would display
iWebServer and iWebCast. The entry ?DO would display topics for both ADO and RDO.
Defining Search Terms
The AND, OR, NOT, and NEAR operators enable you to precisely define your search by creating a rela-
tionship between search terms.
Using Nested Expressions
Nested expressions allow you to create complex searches for information. For example, "control AND
((active OR opc) NEAR window)" finds topics containing the word "control" along with the words "active"
and "window" close together, or containing "control" along with the words "opc" and "window" close
together.
The basic rules for searching Help topics using nested expressions are as follows:
l You can use parentheses to nest expressions within a query. The expressions in parentheses are
evaluated before the rest of the query.
l If a query does not contain a nested expression, it is evaluated from left to right. For example:
"Control NOT active OR opc" finds topics containing the word "control" without the word "active,"
or topics containing the word "opc." On the other hand, "control NOT (active OR opc)" finds topics
containing the word "control" without either of the words "active" or "opc."
l You cannot nest expressions more than five levels deep.
l Search titles only: Allows you to search for words in the titles of HTML files.
l Match similar words: Enables you to include minor grammatical variations for the phrase you
search. For example, a search on the word "add" will find "add," "adds," and "added." This feature
only locates variations of the word with common suffixes. For example, a search on the word
"add" will find "added," but it will not find "additive."
l Search previous results: Enables you to narrow a search that results in too many topics found.
You can search through your results list from a previous search by using this option. If you want to
search through all of the files in a Help system, this check box must be cleared.
When you select a topic from the Search tab or from the Index tab, the topic appears in the right frame
while the left frame continues to display either the search results or the Index. You can see the relative
position of the topic within the table of contents by clicking the Click to Show Browse Buttons... link, and
then clicking the Locate button from the electronic books toolbar.
If you have the Contents tab displayed, the title of the current topic is highlighted in the table of contents
as you browse through the book.
The steps that follow describe how to print from the electronic books.
You can copy all or part of any topic in an electronic book and paste it into any application that accepts
text from the clipboard. For example, you may want to copy an example from the Writing Scripts manual
and paste it directly into the Visual Basic Editor.
1. Display the topic from which you want to copy text.
2. Highlight the text that you want to copy.
3. Press CTRL+C, or right-click the highlighted text and select Copy.
4. Paste the text into another application, such as Word.
1. Display the topic from which you want to copy text.
2. Press CTRL+A, or right-click anywhere within the right frame and select Select All.
3. Press CTRL+C, or right-click the highlighted text and select Copy.
4. Paste the text into another application, such as Word.
NOTE: You cannot copy graphics from an electronic book.
The steps below explain how to add links to the Favorites tab in HTML Help.
1. Locate the Help topic you want to make a favorite topic.
2. Click the Favorites tab, and then click Add.
NOTES:
l To return to a favorite topic, click the Favorites tab, select the topic, and then click Display.
l If you want to rename a topic, select the topic, and then type a new name in the Current topic
box.
l To remove a favorite topic, select the topic and then click Remove.
open 146
iFIX as a container 4 B
defined 15 blocks 9
alarming 14 chains 9
in iFIX 14 secondary 9
types 15 configuring 40
components 1 data 142
described 34 archiving 145
configuring 148 flow 8
buttons 40 retrieving 142
toolbar categories 40
creating 36
folders 97 iWebServer 2
GE Machine Edition 2 K
H login, security 17
I types 15
operator messages 15
N
networking 12 P
nodes 5 passwords 24
iClient 7 paths 150
pictures 58, 123
O
creating 36
ODBC 7
setting preferences 58
OLE 7
plug-in components, iFIX 2
using to access data 7
pop-up window 20
OLE for Process Control (OPC) 3
preferences
on-demand data transfer 13
animation error 59
one-shot processing 11
charts 58
OPC 3
configuring run-time 58
using with iFIX 3
drawing options 58
opc connection 119
pictures 58
OPC connections 117
saving backup files 58
OPC error preferences 117
setting in WorkSpace 57
OPC server 59
shapes 58
customizing error strings 59
start-up environment 59
OPC Toolkit 8
primary blocks 9
open architecture 146
electronic books 181
Open Database Connectivity (ODBC) 8
process data flow 8
opening 36
process database 9
processing 11 SAC 10
centralized 14 save preferences 115
exception-based 11 saving 36
one-shot 11 backup files 58
time-based 11 document 36
Proficy Historian saving backup files 115
disabling errors 35 saving files 101
working with iFIX 2 saving files automatically 101
SCADA server 6
R
Scan, Alarm, and Control program 10
refresh rate 119
Scheduler 11
remote node 6
schedules 36, 123
removing 39
creating 36
toolbar buttons 39
scripting 4
removing a button to a toolbar 133
in iFIX 4
renaming 40
using VBA 4
document in the system tree 37
scripts 136
toolbar categories 40
SCU 121, 148
renaming a category 137
configuring your local computer 148
renaming files 101
path definitions for system tree 31
resetting a standard toolbar 134
starting 148
resetting filters 120
Search tab 179
restoring 153
electronic books 179
files 153
searching data 123
run-time environment 2, 104
secondary blocks 9
configuring preferences 58
secure containment 4
described 34
security 16
run-time node 7
areas 16
running Experts 102
security paths, global 148
running schedules in the background 116
shapes 58 hierarchy 30
sharing 150 navigating 32
deleting 39
W
deleting buttons from a category 40
work area 23
deleting categories 40
described 23
importing 41
WorkSpace
modifying a button's properties 40
configuring run-time preferences 58
modifying properties 39
copying objects 34
owners 38
described 18
removing buttons 39
displaying full screen 35
renaming categories 40
enabling environment protection 35
sharing 41
moving objects 34
showing and hiding 38
saving backup files 58
touch-screen environment 24
setting animation error preferences 59
translating picture text globally 113
setting user preferences 57
translations 113
specifying an iBatch project 175
troubleshooting OPC server installations 140
start-up options 59
U starting 19
VBA 3