OA2installAn Installation Guide for OAenterprise®

License Terms. Any information furnished in this documentation ("Documentation") is the copyrighted work of ObjectAutomation, Inc. ("ObjectAutomation") and/or its suppliers. Use of the Software described herein ("Software") and Documentation is governed by the terms of the end user license agreement which accompanies or is included with the license file and/or installation of the Software ("License Agreement"), there is no transfer of title. An end user will be unable to install any Software that is accompanied by or includes a License Agreement, unless the end user first agrees to the License Agreement terms.

Use Restrictions. The Software and Documentation is made available solely for use by end-users according to the License Agreement. Any reproduction or redistribution of the Software and Documentation not in accordance with the License Agreement is expressly prohibited by law. Copying or reproduction of the Software and Documentation, in whole or in part, in print or to any other media, or in any other storage and retrieval system for further reproduction or redistribution is prohibited.

Warranty Disclaimer. THE SOFTWARE AND DOCUMENTATION IS WARRANTED, IF AT ALL, ONLY ACCORDING TO THE TERMS OF THE LICENSE AGREEMENT. EXCEPT AS WARRANTED IN THE LICENSE AGREEMENT, OBJECTAUTOMATION, INC. HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS WITH REGARD TO THE SOFTWARE AND DOCUMENTATION, INCLUDING ALL IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT.

Disclaimer Regarding Documents. ObjectAutomation and/or its respective suppliers make no representations about the suitability of the information contained in the Documents and related graphics published in this guide for any purpose. ALL SUCH DOCUMENTS AND RELATED GRAPHICS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. OBJECTAUTOMATION AND/OR ITS RESPECTIVE SUPPLIERS HEREBY DISCLAIM ALL WARRANTIES AND CONDITIONS WITH REGARD TO THIS INFORMATION, INCLUDING ALL IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. In no event shall ObjectAutomation and/or its respective suppliers be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of information available from this guide. The documents and related graphics published in this guide could include technical inaccuracies or typographical errors.

Notice Regarding Software, Documents and Services. In no event shall ObjectAutomation and/or its respective suppliers be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of software, documents, provision of or failure to provide services, or information available from these materials.

Restricted Rights Legend. Any Software and Documentation on this CD licensed for or on behalf of the United States of America or its agencies and/or organizations ("U.S. Government"), is provided with Restricted Rights. Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 or subparagraphs (c)(1) and (2) of the Commercial Computer Software - Restricted Rights at 48 CFR 52.227-19, as applicable. Manufacturer is ObjectAutomation, Inc., P.O. Box 51236, Irvine, CA 92619-1236.

Copyright and Trademark Notice. OAenterprise® is a registered trademark and ObjectAutomation is a trademark of ObjectAutomation™, Inc. Microsoft, Windows 2000, Windows NT, Windows XP and Windows Server 2003 are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Java and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. ObjectAutomation, Inc. is independent of Sun Microsystems, Inc. Other product and company names mentioned herein may be the trademarks of their respective owners. Any rights not expressly granted herein are reserved.

Copyright © 1999-2008 ObjectAutomation, Inc.

ObjectAutomation, Inc.P.O. Box 51236Irvine, CA 92619-1236

http://www.oa.com

i

Table of ContentsIntroduction.....................................................................................................iiiAbout this Guide...............................................................................................v

About the Tutorial.................................................................................................vDocument Conventions.....................................................................................vRelated Documentation .................................................................................viiAbout ObjectAutomation...............................................................................viii

Corporate Headquarters.....................................................................................viiiAccessing the ObjectAutomation Web Site.....................................................ix

To access the ObjectAutomation web site.............................................................ixContacting the Customer Satisfaction Team....................................................x

To open the Windows Task Manager.....................................................................xTo open the Windows Event Viewer log file...........................................................xTo create a System Information File ....................................................................x

Chapter 1

Quick Start Installation in Four Easy Steps.........................................................1

1 - Check Your Hardware/Software Configuration ..........................................12 - Install OAenterprise.................................................................................1Networked Computers..................................................................................1Single Computer..........................................................................................13 - Obtain the OAenterprise License Collection File.........................................24 - Install Your License Collection File on the Host Node.........................................................................................2

Chapter 2Setting Up an OAenterprise Installation.............................................................3

Planning the Installation..................................................................................3Running OAenterprise as a Stand-alone Node........................................................3Running OAenterprise as a Distributed System.......................................................3

Understanding the OAenterprise Cell................................................................................4Configuring an OAenterprise Cell.....................................................................................4

What is a Cell Manager?..............................................................................................4Where is the best place to install the Cell Manager?..................................................5

What is a Cell Client?...................................................................................................5Where is the best place to install a Cell Client?..........................................................6

Determining What to Run on an OAenterprise Cell Node................................................6Where is the best place to run control engines?........................................................6On what nodes should the HMI screens run?............................................................6What should I do, if response time deteriorates?.......................................................6

Installation Requirements................................................................................8Checking the README File....................................................................................8

To open the README file.....................................................................................8Checking System Requirements.............................................................................8Older Version of OAenterprise Installed?..............................................................10

Upgrading an OAenterprise Cell.....................................................................................10What Happens to Your Existing OAenterprise License File after Upgrading?......................10

Notes about Upgrading the Operating System .....................................................11Installing OAenterprise..................................................................................12

To initiate the setup program.............................................................................12To install a stand-alone node..............................................................................14To install a distributed OAenterprise system........................................................15

Licensing OAenterprise..................................................................................16

http://www.oa.com

ii

To license OAenterprise for a stand-alone node environment................................16To license OAenterprise for a distributed cell environment ...................................16

Important Notes about Licensing.........................................................................17Generating an OAkey..........................................................................................18

If you are running one (or more) Stand-alone Node(s)....................................................18If you are running an OAenterprise distributed cell.........................................................18

How do I decide which node I want to manage licensing?...........................................18To generate an OAkey.......................................................................................18

Obtaining a License (COL) File.............................................................................20To obtain your license collection file through email or phone ...............................20

Installing the License File....................................................................................21To install the license collection file......................................................................21

http://www.oa.com

iii

IntroductionWelcome to OAenterprise, ObjectAutomation’s™ Industrial Automation software platform. OAenterprise integrates real-time, distributed Object-Based Control™ into production management systems to provide a responsive, rules-based solution. OAenterprise's interactive data representation means better communication and control between and within business and operational systems—all personnel, from management to operations, will have timely access to the information they need to perform their jobs more effectively. And, with OA2webAccess, authorized users and systems can access critical data and control operations through the Internet. OAenterprise enables creation and maintenance of applications that monitor and control diverse manufacturing operations and business processes from a network of computers running Microsoft Windows 2000, XP, XP Embedded and/or Server 2003. OAenterprise can be used in a wide variety of applications—including discrete, process, batch, distribution, motion control, and numerical control—and provides services that bridge these applications into enterprise planning and scheduling systems. OAenterprise is built on an open, distributed object framework based on Microsoft operating systems and technology. This framework allows transparent distribution of an application across a local or wide-area network of computers, while keeping the appearance, and simplicity, of running on a single, local computer.Providing the foundation for building mission-critical, real-time Industrial Automation, Control, and Operational Intelligence solutions, OAenterprise includes: • OAframework - The foundation for OAenterprise, the OAframework provides a single,

coherent process model for manufacturing operations, business processes, and the supply chain, and includes the basic network-computing infrastructure, resource management, and communication services for enterprise-wide control.

• OAworkbench - The primary user interface for designing, operating and maintaining OAenterprise solutions, OAworkbench hosts a variety of user interface tools that provide specific configuration, viewing, and editing functions.

• OA2control - The brain behind Operational Intelligence and Control, providing system design and execution of business rules, data consolidation scripts, process control algorithms and industrial automation logic. OA2control includes the real-time execution engine, strategy editor, and associated program editors for OAenterprise.

• OA2view - The eyes for seeing and hands for controlling operations managed by OAenterprise. OA2view provides the tools to build, maintain, and view animated graphical representations of manufacturing operations and business processes..

• OA2alarms - Provides the services to configure, detect, and manage alarm conditions and system events anywhere in manufacturing operations and along the supply chain. While OA2alarms is an integral part of OAenterprise, its user interface components can be used either in OA2view or any standard ActiveX container.

• OA2history - Provides process data storage, retrieval, and presentation services to give operators, engineers, and managers a way of viewing current, recent, and past operational details as a function of time. Like OA2alarms, OA2history services are integrated with the OAenterprise model and its user interface components can be used in OA2view and any other standard ActiveX container.

http://www.oa.com

iv

• OA2inform - Provides HTML-based information management by linking a variety of local, Intranet- or Internet-based documents, such as operating procedures and maintenance instructions, to OAenterprise classes and objects. OA2inform includes a pre-configured set of HTML pages that provide detailed information about classes, objects, groups, and cells.

• OA2webAccess - Provides access to and interaction with OAenterprise solutions through an internet connection. OA2webAccess provides secure access to OAenterprise resources using standard web-based protocols. The OA2webAccess components use HTTP and XML to extend the reach of the OAenterprise cell to the Internet.

Collectively, OAenterprise provides the core features required for any monitoring and control system: real-time data acquisition, control, visualization, historization, and alarm detection and management. With OAenterprise you can create your own Enterprise-wide Control console—integrating mission critical systems and allowing your users to proactively effect change based on business opportunities.

http://www.oa.com

v

About this GuideThis guide is divided into two chapters and one appendix. • Chapter 1 is a "quick start" road map to installing OAenterprise. • Chapter 2 gives you more in-depth information about configuration, installation, and

licensing. • The appendix contains system configuration recommendations.

About the TutorialA quick start guide to using OAenterprise, called OA2start, is included with OAenterprise in electronic format as a Microsoft Word document.

The OA2start.doc MS Word file is located in the C:\Program Files\OA\OA2help folder (or the location where you installed OAenterprise).

Document ConventionsThis document uses the following typographic conventions.

Example of Convention Description

Java Virtual Machine (JVM) Acronyms are spelled out the first time they are used.

CTRL, TAB Small capital letters are used for key names, key combinations, and key sequences.

CTRL+ALT+DEL A plus sign (+) between key names indicates a combination of keystrokes. In this case, you hold down the CTRL key while pressing the ALT and DEL keys.

File menu

OK

Properties dialog box

In procedures, the following appear in bold letters:

menu names

commands on menus and buttons

dialog box titles and options

NOTEIn supplemental text, menu names, dialog boxes, and other user interface elements will appear capitalized, but not in bold letters.

Type Tank In procedures, italic bold letters indicate

http://www.oa.com

vi

Example of Convention Description

information that you type in exactly as shown.

Type your password In procedures, italic letters indicate placeholders for information you supply. Italic letters also are used occasionally for emphasis.

Attributes In text, italic letters indicate the introduction of a new term.

\OA\oaj Both upper and lower case letters are used in paths and filenames.

TIPIn general, to complete a procedure quickly, follow the items that appear in boldface.

http://www.oa.com

vii

Related Documentation OAenterprise includes a number of documentation tools designed to help you learn and use the product. Everything that there is to know about using OAenterprise is available in the documentation set that was installed with the product and that you can view while you are working in OAworkbench™.The OAenterprise Documentation Set includes:• Readme - The Readme file lists any changes to the OAenterprise documentation

since the publication date. It can be found at the root directory of the compact disc and in the \OA folder after you install the product. Check this file for any new information, before installing OAenterprise.

• OAenterprise Library - Includes all of the User and Reference Guides that are available for OAenterprise. The library is accessible from the Help menu, the OAenterprise Program Group (click OA2documentation), and the OA2help window within OAworkbench.

The User Guides explain development concepts and techniques, especially for building and integrating applications into OAworkbench:

OA2start Guide - This quick start guide includes basic setup and installation instructions and a tutorial broken into separate lessons to familiarize you with the process of creating an application and using features in OAenterprise. [A printed version of this guide shipped with the OAenterprise compact disc.]

OAenterprise User's Guide - This guide describes configuration and development techniques, as well as an in-depth look at OAworkbench, OA2browse, OA2help, OApackager, and OA2inform. It also explains the concepts that you should understand before setting up your OAenterprise environment and creating an OAenterprise application.

Additional User Guides – Depending on the products purchased, you may have additional user guides available to you—such as the OA2control User's Guide, OA2alarms User's Guide, OA2history User's Guide, OA2view User's Guide, and so forth. These guides include setup, concepts, and development techniques for the particular product.

The Reference Guides include programmer's references, definitions of OA2control snippets, function libraries, and function blocks, as well as detailed information about the OAenterprise automation objects, and so forth.

• Help - Provides quick answers to questions that occur while using OAenterprise. Help topics are available from the Help menu, by pressing F1, or by clicking the Help button found on many of the dialog boxes.

NOTETo use the online documentation, you should be familiar with using a mouse, opening a menu, and choosing menu and dialog box options.

http://www.oa.com

viii

About ObjectAutomationObjectAutomation™, Inc. (OA) is a Southern California-based Corporation specializing in leading edge industrial automation, control, and operational intelligence software. OA technologies and products encapsulate existing plant equipment such as sensors and actuators, the latest Windows Embedded controllers, Programmable Logic Controllers (PLCs), Distributed Control Systems (DCSs), PCs, machines, work cells, and other plant systems. OA tools encourage users to embrace legacy systems by wrapping them in application component containers. When planning for the future, users now have the choice of utilizing existing assets while leveraging new technologies and adopting future products in a real-time platform for industrial automation, control, and operational intelligence.OA's primary product suite, the OAenterprise, utilizes an open, multi-tier control architecture based on Microsoft Windows . The OAenterprise foundation is a distributed object management tool called the OAframework, which extends Windows 2000, XP Professional, XP Embedded, Server 2003, and COM+ models for manufacturing automation applications. A simple, intuitive User Environment (UI) called the OAworkbench, based on Active Document technology, sits on top of the OAframework, providing a common development and runtime host for the applications in the OAenterprise suite. All of the products in the OAenterprise suite share common facilities to increase performance and interaction between modules. OA2control adds intelligence to operations by turning raw data in to key performance indicators (KPI), by running optimization algorithms, and by controlling components, machines, work cells, or entire process lines. OA2view provides Human Machine Interface (HMI) capabilities and allows users to interact with any process using intuitive graphics and canvases. OA2history is a comprehensive distributed storage and retrieval system. OA2alarms rounds out the suite with a sophisticated, flexible tool for handling simple, complex, or hierarchical alarm scenarios.OA2webAccess extends the reach and power of OAenterprise to the Internet by providing access to application data through an Internet connection. Adding the OA2webAccess tool to OAenterprise means authorized users can securely access and interact with all OAenterprise cell resources using standard web-based protocols, such as HTTP and XML.

Corporate Headquarters

Address ObjectAutomation, Inc.13700 Alton ParkwaySuite 154-143Irvine, CA 92618U.S.A.

Telephone +1 (877) 622-2899Office Hours Monday through Friday

8:00 A.M. - 5:00 P.M. Pacific Standard TimeE-mail support@oa.comInternet http://www.oa.com

http://www.oa.com

ix

Accessing the ObjectAutomation Web SiteThe ObjectAutomation web site provides additional information about OAenterprise and ObjectAutomation.

To access the ObjectAutomation web site

• In your Internet browser, type the ObjectAutomation World Wide Web address: http://www.oa.com

TIPYou also can access the Web site when you are working in the OAworkbench. On the Help menu, point to ObjectAutomation on the Web, and then select from options, such as Downloads, Online Support, and so forth.

http://www.oa.com

x

Contacting the Customer Satisfaction TeamFor general support questions, contact our Customer Satisfaction Team. Internet SupportE-mail: support@oa.com Web address: http://www.oa.com/ Telephone SupportToll Free for US and Canada: +1 (877) 622-2899Europe: +31 497 383818It would be helpful if you have the following information available:• Your customer ID Number.

This number was e-mailed or faxed to your designated installation contact at the time of purchase. You also can find this by opening OAworkbench and, on the Help menu, selecting About.

• The OAenterprise product version number.You can find this by opening OAworkbench and, on the Help menu, selecting About.

• A problem description (exact wording of screen messages or error numbers).

• A description of what you were trying to do when the problem occurred and how you tried to solve the problem.

• The memory status at the time of the error (if applicable).This information is found in the Windows Task Manager utility on the Performance tab.

• The Windows Event Viewer log.

• The Windows System Information file.

To open the Windows Task Manager

1 On a blank area of the taskbar, right-click. 2 On the shortcut menu, click Task Manager.

To open the Windows Event Viewer log f i le

1 On your desktop, click the Start button, point to Programs, point to OAenterprise, and then click Event Viewer.

2 Do one of the following: Save the logs as Event Log files (with .EVT extension) and attach the files to an

e-mail. Save the logs as Text files (with .TXT extension), print the files, and fax them.

To create a System Information Fi le

1 On your desktop, click the Start button, point to Programs, point to Accessories, point to System Tools, and then click System Information.The System Information window appears.

2 In the System Information window, on the Action menu, click Save As System Information. This creates a file with the extension "nfo" (*.nfo).

http://www.oa.com

xi

3 Send the System Information File (*.nfo) to support@oa.com.

TIPIf you do not have an Internet connection, you can print the file to fax. In the System Information window, right-click System Information, and then click Print.

http://www.oa.com

1

Chapter 1

Quick Start Installation in Four Easy StepsThis chapter outlines in four easy steps how to install OAenterprise. For more details and step-by-step procedures, refer to Chapter 2.

1 - Check Your Hardware/Software Configuration OAenterprise will effectively install and run on any PC running one of the following operating systems: Windows 2000, Windows XP or Windows Server 2000 and 2003. The optimum configuration is a function of the eventual OAenterprise application load that will run on any given machine.

2 - Install OAenterprise

CAUTIONIf you are upgrading to OAenterprise, make sure you check the README.TXT file located at the root of the compact disc for important steps to take before upgrading.

TIPIf you installed the trial license during installation, you may run the product for 14 days before you must complete the licensing procedure, outlined in steps 3-5.

http://www.oa.com

Single ComputerRun the setup program and choose the Stand-alone Node configuration option.

Networked ComputersRun the setup program and choose either the Cell Manager or the Cell Client configuration option. Given the installation options for a distributed system, we highly recommend that you familiarize yourself with these, before installing a distributed system.

2

3 - Obtain the OAenterprise License Collection File

4 - Install Your License Collection File on the Host Node

Congratulations!You are now ready to start OAenterprise. On your desktop, double-click the OAworkbench icon. For a quick introduction to OAenterprise, see the OA2start tutorial. See "About the Tutorial" for information about accessing the tutorial.

http://www.oa.com

Via Email or PhoneEmail or telephone your Host Name, Host Code, Customer ID Number, Password, contact name and current address to the Customer Satisfaction Team.Email: support@oa.comPhone: +1 (877) 622-2899 (Toll Free for US, Canada) Your license collection file(s) will be mailed to you.

When you receive your license collection file, copy it to the C:\Program Files\OA\License folder (or the location where you installed the ObjectAutomation software), on the License Host node. If necessary, delete the install.tmp temporary license file from the \License folder. Shut down and then restart OAframework services on the License Host node and all associated cell nodes.

3

Chapter 2Setting Up an OAenterprise InstallationThis chapter covers the things you should consider before installing OAenterprise, the installation requirements and recommendations, the installation procedure, and the licensing procedure.

TIPIf you have not seen it already, please check Chapter 1 "Quick Start Installation in Four Easy Steps."

Planning the InstallationOAenterprise is a very powerful program that covers the spectrum from simple stand-alone HMI to fully distributed control. It can run equally well on either a single computer or a group of networked computers (a multi-node distributed OAenterprise cell). This scalability allows you to create a small, single-computer control system and then expand it as your needs change.Regardless of which configuration you choose (stand-alone or distributed), everything begins with installation, and, while the simplest installations can be done without much forethought, it is important to consider the layout or topology of your system for larger, distributed systems.This section provides an overview of the two OAenterprise configurations and of the things to consider when designing an OAenterprise distributed system.

Running OAenterprise as a Stand-alone NodeThe OAenterprise stand-alone system (referred to as a stand-alone node) is a self-sufficient workstation that contains all of the services necessary to run OAenterprise. It does not need to be part of a network and will not be able to share OAenterprise resources with other OAenterprise systems.The stand-alone node normally is installed on a standard Windows 2000 / XP Professional workstation but can be installed on a Windows 2000 / 2003 Server.The setup program always gives you the option of configuring a workstation as a stand-alone node. For more details, see "Installing OAenterprise”.

TIPWhile it is possible to later upgrade an OAenterprise system configured as a stand-alone node to a distributed OAenterprise cell, it is not as easy a process as expanding a single-node OAenterprise cell to multiple nodes. If you will be expanding in the future, it is recommended that you select the Cell Manager option during installation rather than the Stand-alone Node option. Refer to the "Running OAenterprise as a Distributed System" section, for more information.

Running OAenterprise as a Distributed SystemOAenterprise may be run on a single computer using a local database (a stand-alone node) or on several networked computers using shared, distributed databases (an OAenterprise cell). An OAenterprise cell is a distributed system that provides the ability to

http://www.oa.com

4

distribute application components (objects) transparently across a network of processors. To the end-user, however, it looks like a single application.To setup a distributed OAenterprise cell, the machines involved should be in the same domain. (Other situations can be accommodated but are beyond the scope of this discussion. If you have multiple domains, workgroups or similar situations, please contact OA customer support.)

Understanding the OAenterprise CellAn OAenterprise cell is a group of computers (referred to as nodes or cell members) that share a common set of OAenterprise resources. Resources include classes, objects, canvases, control worksheets, and so forth. Resources can be distributed among the nodes of a cell, and each member of a cell can access a resource without regard to its physical location. This means that you can grow your control system simply by adding a new node to a cell and moving resources onto it. The addition of a new node affords your system the additional computing power and storage space of that machine – as well as another display screen. After adding a new node, you can move control engines, history vaults, objects, and so forth, to that new resource.At the minimum, an OAenterprise cell consists of one cell manager node and usually – but doesn’t necessarily - one cell client node.Assuming the appropriate licensing is in place, every node within the same cell has the potential to develop, maintain, modify and monitor an application. And, as alluded to earlier, objects can be moved easily from one node within a cell to another node to balance the processing load and increase efficiency.You can run multiple OAenterprise cells within a single Microsoft Windows domain or across multiple domains. Because each cell has its own cell manager, the cell client nodes in one cell are not affected, if nodes in another cell fail or are shutdown. For the most part, cells can be administered independently and can be started, stopped, or upgraded without impacting other cells. If you install multiple OAenterprise cells, it is possible for objects in one cell to communicate with the objects in another cell. This is referred to as cross-cell communication and is true whether the cells are located within the same Windows domain or across domains. Cross-cell communication includes reading data from, writing data to, and registering with the attributes of, objects in remote cells.

Configuring an OAenterprise CellThe setup program installs OAenterprise on your workstation. During the installation, the setup program prompts you to choose how to configure the node.You can choose from three options:1 Cell Manager2 Cell Client3 Stand-alone NodeThe first two are related to setting up a distributed system, known as an OAenterprise Cell, and the third one is for a self-contained, stand-alone system. This section addresses the first two options.

What is a Cell Manager?

http://www.oa.com

5

An OAenterprise Cell Manager is the host for an OAenterprise cell. The cell manager has OAworkbench and all products installed on it and provides the core OAframework services for the cell. The cell manager is responsible for maintaining class definitions, a cell-wide object directory, and other centralized information. It also is responsible for tracking the status of the other members of the cell. In all other respects, though, the cell manager node functions as any other client node – it can be used to host objects, view graphics, and so forth.

Where is the best place to instal l the Cell Manager?

Although the members of a cell will be able to continue ongoing operations if the cell manager becomes unavailable, they will not be able to locate additional objects on other nodes or start new objects. For this reason, the cell manager should be installed on a high-availability machine running either Windows 2000 Professional, Windows 2000 Server, Windows XP Professional or Windows Server 2003.The setup program gives you the option of configuring as a cell manager node when it detects your workstation is part of a Windows domain. For more details, see "Installing OAenterprise".

What is a Cell Client?

An OAenterprise cell client runs as a node in an OAenterprise cell. OAworkbench and all products are installed on it. The cell client participates with other cell clients and the cell manager to share OAenterprise resources and data. All of the nodes in a cell access a common set of classes, objects, canvases, graphics, and so forth.

http://www.oa.com

6

Where is the best place to instal l a Cell Cl ient?

The cell client normally is installed on a standard Windows 2000 Professional workstation or Windows XP Professional, but can be installed on a Windows 2000 Server or Windows Server 2003.The setup program gives you the option of configuring as a cell client node when it detects the following two conditions:1 Your workstation is part of a Windows domain.2 A cell manager exists in the domain.

Determining What to Run on an OAenterprise Cell Node

While the configuration types designate a node as either a Cell Manager or Cell Client, it is important to realize that either type can support many roles within your application, including:• Running a Control Engine and Objects

• Hosting the History Vault and/or Repository

• Hosting the Alarm Area

• Acting as the I/O source

• Displaying Operator Screens (HMI)

While the placement of all of these can be decided after the installation, it helps to plan your system beforehand. A few common questions might help you with the task:

Where is the best place to run control engines?

It is a good idea to run your control as near as possible to your I/O servers, therefore, it is recommended that you run your control engines and store your objects on the same nodes.

On what nodes should the HMI screens run?

Depending on the type of animation taking place in these screens, this could be a CPU-intensive operation. Such operations are not desirable on a node that is running critical processes. If a node is going to be used primarily for operator viewing, consider running the control engines on a different node in the cell.

What should I do, i f response time deteriorates?

If you notice that the user-interface response time is deteriorating or CPU load is peaking, consider the following:• Moving all screen processing (HMI and ControlView) to a node that is not running

control.

• Putting control on a dedicated node where the primary task is running control.

• Moving history processing by moving the history vaults to a separate node(s).

There are few requirements regarding where system components can reside. In fact, as long as you respect the close relationship that I/O connectivity, control, and objects have, you are able to move objects to any node.

http://www.oa.com

7

You can measure CPU utilization with the Windows Task Manager. You also can use the ComputerSummary class to build this monitoring capability into your HMI screens. For more information about using the ComputerSummary class, please refer to "The ComputerSummary Application" topic in the online OAenterprise User's guide.

http://www.oa.com

8

Installation RequirementsBefore you install OAenterprise, make sure that:1 You check the README file for any changes regarding installation.2 Your computer meets the system requirements.3 You are logged on as member of the local computer’s Administrator group so that

the OAenterprise services can be registered on the computer.

Checking the README FileThe README.TXT file contains last minute changes to the OAenterprise documentation since its publication and can contain the latest instructions for the setup program.

To open the README fi le

In Windows Explorer, navigate to the root directory of the OAenterprise compact disc, and then double-click readme.

Check the first section of the file for any new information about installing OAenterprise. After installing OAenterprise, the README file also is available in the C:\Program Files\OA folder (or the location where you installed the ObjectAutomation software).

Checking System RequirementsBefore installing OAenterprise, verify that each workstation meets the minimum hardware and software requirements required to support OAenterprise.

Hardware RequirementsOAenterprise will install and run on any modern PC platform including laptops, desktops, “servers” and small form factor industrial PCs. As a point of reference, OAenterprise was originally designed and developed to run entirely on Pentium 166 MHz machines with as little as 64 MB of RAM, Super VGA graphics, and less than a half gigabyte of disk space! So, any machine on the market today – with the possible exception of special purpose, low power devices with extremely limited hardware resources – will run OAenterprise. Of course, certain applications may require more disk space, fast graphics, more memory, faster CPUs; this is a system architecture/design problem and is, therefore, beyond the scope of this document. This said, these considerations should be viewed as the exception and not the rule, so for testing, evaluation, and even for most modest application purposes, any modern machine will do. (If you have questions about your configuration, please contact the Customer Satisfaction Team.)

Software Requirements OAenterprise will install and run properly on any (combination, in the case of a distributed, multi-node cell) of the following Windows operating system versions:

• Microsoft Windows 2000 SP2 or later

• Microsoft Windows 2003 Server SP1 or later

• Microsoft Windows XP SP2

http://www.oa.com

9

The following software also is required, and, if not detected, is installed as part of OAenterprise.• MSVCRT.DLL

• Microsoft SDK for Java 4.0

• Microsoft Java Virtual Machine

OAenterprise User AccountWhen running OAenterprise as a distributed system, it is necessary to have a domain-level user account available for OAenterprise use. This is the account OAenterprise uses to run its services, and it should be a Domain User as well as a Local Administrator on all nodes in the OAenterprise cell. During installation, when configuring a cell manager, you will be prompted for this account user name and password.Since all nodes in a given cell should use the same account to run their services, it is recommended that you create an OAenterprise-specific domain account called OASYSTEM that can be used for all nodes.

TIPYou can use the same user account for multiple cell managers in a single domain.

NOTEYou also will need to make sure that the node that will manage licensing has a default administrator account with the user name "Administrator." This account is created, by default, when Windows is installed. Do not remove or rename this account. (You may, however, change the administrator password to conform to your site's security guidelines.)

For more information about creating user accounts, please refer to the Microsoft Windows documentation.

http://www.oa.com

10

Older Version of OAenterprise Installed?If you are upgrading OAenterprise, make sure you (1) back up your existing OAframework database or package your application classes, objects, worksheets, canvases, and graphic libraries and (2) check the README.TXT file located at the root of the compact disc for important steps to take before upgrading. For more information about backing up your existing OAframework database, and packaging your application, respectively, please refer to the online documentation as referenced below.

See Also"System Administration" in the online OAenterprise User's Guide"Lesson Five – Packaging the Application," in Chapter 3 of the OA2start tutorial

If you are not installing OAenterprise and would like to remove OAenterprise manually, refer to the "Removing OAenterprise" in the System Administration chapter in the online OAenterprise User's Guide.

Upgrading an OAenterprise CellBefore starting the setup program to upgrade, shut down OAenterprise (including OAworkbench and all OA services) on all cell client nodes and then on the cell manager node. Run the setup program on the cell manager node first, and then run it on each cell client node.

CAUTIONIt is highly recommended that you upgrade all nodes in the target cell; whereas OAenterprise may function in an environment that has mixed versions, it is not a supported configuration.

What Happens to Your Existing OAenterprise License File after Upgrading?If you are upgrading from any previous version of OAenterprise, you need a new license file. After the installation process is finished, you must regenerate the OAkey and obtain a new license collection file from ObjectAutomation, before you can run OAenterprise.

http://www.oa.com

11

Notes about Upgrading the Operating System • If you have Windows NT installed, you must upgrade your operating system to

Windows 2000, XP or Server 2003 before installing OAenterprise.

• It is not necessary to remove current versions of OAenterprise before upgrading the operating system. Although previous versions of OAenterprise do not run on Windows 2000, XP, or Server 2003, the databases will remain intact through the operating system upgrade process. (We do recommend that you back up your data before upgrading your operating system.)

http://www.oa.com

12

Installing OAenterpriseThe setup program installs OAenterprise on your computer. Specifically, it installs the OAenterprise program files, the online Help system, the OAenterprise documentation library, prepackaged graphics that you can use in OA2view canvases, function blocks that you can use in your control methods, example applications, and other product components from the CD-ROM to your hard disk. You must use the setup program to install OAenterprise, because it decompresses and installs files in specific directories. You cannot simply copy files from the CD-ROM to your hard disk to run OAenterprise.

CAUTIONIf you are running in a cell environment, remember to run the setup program on the cell manager node first, and then run it on each cell client node. OAenterprise does not support environments with mixed OAenterprise versions.

If you are upgrading OAenterprise, make sure that you (1) back up your existing OAframework database or package your application classes, objects, worksheets, canvases and graphic libraries, and (2) check the README.TXT file located at the root of the compact disc for additional steps to be taken before upgrading.

To init iate the setup program

1 Log on to your workstation with a domain account that is a member of the local workstation's Administrator group so that the OAenterprise services can be registered on the workstation.

2 If you have any Windows-based programs (including a screen saver) running, close them, before continuing.

3 Do one of the following: If you are installing OAenterprise from a local CD-ROM drive, then insert the

compact disc in the CD-ROM drive. If you are installing OAenterprise from a network share, then map the network

drive to a drive letter.4 Do one of the following:

If the OAenterprise Welcomes You! window automatically opens when you insert the compact disc, continue with step 5.

If AutoPlay is not enabled or if you are installing from a network share, then in Windows Explorer, navigate to the root directory of the OAenterprise compact disc, and click OASplash. This opens the OAenterprise Welcomes You! window.

http://www.oa.com

13

5 In the OAenterprise Welcomes You! window, click OA2install.

6 The setup program prompts you through the installation process. Follow the onscreen instructions.

TIPTo find out more about options during setup and installation, click the Help button available on many dialog boxes.

NOTEOAenterprise requires that certain software be installed on the node, prior to installing OAenterprise. Each of these is available from the OAenterprise compact disc, and, if any are not detected, the appropriate installation program(s) will be launched by the OAenterprise installation. Follow the onscreen instructions for each, including the instruction to reboot your computer.

http://www.oa.com

OA e n te rp r i s e W e lc om e s You ! w i n d o w

14

To instal l a stand-alone node

1 In the OAframework Configuration dialog box, click Stand-alone Node.

2 When the first part of the installation is finished, you will be prompted to restart your workstation to complete the installation. Click Finish to close the dialog box, and restart your workstation.

3 After the second part of the installation process is complete, the OAenterprise Installation is complete message appears.

Installation is finished and you are ready to proceed with licensing your software.

TIPIf you installed the trial license during the installation procedure, you may run the product for 14 days, before you must complete the licensing procedure and obtain a registered license.

http://www.oa.com

S ta n d -a l o n e No d e OA f ram e wo rk Co n f i g u ra t i o n o p t i o n

15

To instal l a distr ibuted OAenterprise system

1 In the OAframework Configuration dialog box, click the option corresponding to the distributed cell node you are configuring.

2 When the first part of the installation is finished, you will be prompted to restart your workstation to complete the installation. Click Finish to close the dialog box and restart your workstation.

3 If you are installing a cell client, the Select the cell to join dialog box appears. Click the cell you want to join, and then, click OK.

4 After the second part of the installation process is complete, the OAenterprise Installation is complete message appears.

Installation is finished and you are ready to proceed with licensing your software.

TIPIf you installed the trial license during the installation procedure, you may run the product for 14 days, before you must complete the licensing procedure and obtain a registered license.

http://www.oa.com

C e l l Ma n a g e r n o d e OA f ram e wo rk c o n f i g u ra t i o n op t i o n

16

Licensing OAenterpriseIf you installed the trial license during the OAenterprise installation procedure, you may run the product for 14 days, before obtaining a registered license from ObjectAutomation. When you are ready to obtain a registered license, follow the procedure relevant to your system environment: a Stand-alone Node or an OAenterprise Cell (multi-node cell).To license OAenterprise, you must generate an OAkey on, and install a license collection file to, the OA\License folder on each stand-alone node and on (at least) one node within an OAenterprise distributed cell.

To l icense OAenterprise for a stand-alone node environment

1 Generate an OAkey on the node. 2 Send the OAkey information to ObjectAutomation to obtain a license collection file. 3 Install the license file.4 Shut down, and then, restart the OAframework services on the License Host node

and all associated cell nodes.5 Repeat steps 1-4 for each stand-alone node.

To l icense OAenterprise for a distr ibuted cel l environment

1 Decide on which node you want to run the license collection file. This is known as the License Host node.

NOTEYou may want to designate more than one License Host node. If you do, then you will follow this procedure for each License Host node.

2 Generate an OAkey on the designated License Host node. 3 Send the OAkey information to ObjectAutomation to obtain a license collection file. 4 Install the license file. 5 Shut down, and then, restart the OAframework services on the License Host node

and all associated cell nodes.

http://www.oa.com

17

Important Notes about Licensing• Make sure that the node(s) that will manage licensing has a default administrator

account with the user name "Administrator." This account is created, by default, when Windows is installed. Do not remove or rename this account. You may, however, change the administrator password to conform to your site's security guidelines.

• Changing the name of the node invalidates your license file. You will not be able to run OAenterprise on the node, and other OAenterprise nodes in the OAenterprise cell will not be able to access any objects on the node after the name change. For more information, refer to "Renaming a Node After Installing OAenterprise" in the online OAenterprise User's Guide.

• Installing OAenterprise 5.4 over OAenterprise 5.3 (or earlier) invalidates your existing OAenterprise license file. Generate a new OAkey and contact ObjectAutomation for a new license collection file.

• Reinstalling Windows on the License Host node, after running OAenterprise, invalidates your license file. Generate a new OAkey and contact ObjectAutomation for a new license collection file.

• You can use the License Viewer to view and verify information about all of the licenses available in an OAenterprise system and print license reports. It gathers information from all License Managers running in a given OAenterprise cell; collates the information; and displays it in a tabular format. For more information about using the License Viewer, refer to "Working with the License Viewer" in the online OAenterprise User's Guide.

http://www.oa.com

18

Generating an OAkeyThe OAkey is the Host Name and Host Code of the node that will manage the OAenterprise licensing.

If you are running one (or more) Stand-alone Node(s)Each stand-alone node manages its own licenses. You will generate an OAkey on each stand-alone node.

If you are running an OAenterprise distributed cellBecause the OAenterprise License Manager (OA License Manager) is installed automatically on every node on which OAenterprise is installed, you can designate which node in the cell you want to manage the OAenterprise licensing. This node is referred to as the License Host node. You will generate an OAkey on the License Host node. If you want to have more than one License Host node in a cell, generate an OAkey on each one of those designated License Host nodes.

How do I decide which node I want to manage licensing?

Any node can manage the OAenterprise licenses. However, keep in mind that if the License Host node is shutdown or otherwise stops running or communicating with the network, nodes that try to obtain a license (after the communication loss), will be unable to do so.

CAUTIONAfter running OAenterprise, renaming the License Host node invalidates your license file. You will not be able to run OAenterprise on the node, and other OAenterprise nodes in the OAframework cell will not be able to access any objects on the node after the name change. Your license file also will be invalidated, if, after running OAenterprise, you reinstall Windows 2000 on the License Host node. In either case, you must regenerate the OAkey on that node and contact ObjectAutomation for a new license collection file.

To generate an OAkey

Repeat this procedure on each stand-alone node and on at least one node in each OAenterprise cell.1 On the desktop of the node that you want to manage OAenterprise licensing (the

License Host node), click the Start button, point to Programs, and then, point to OAenterprise.

http://www.oa.com

19

2 On the OAenterprise program group menu, click OAconfigure.The OAframework System Configuration dialog box appears.

3 Click OAkey. This generates the OAkey information needed to obtain your license file from

ObjectAutomation. The OAkey dialog box appears displaying the Host Name and Host Code for this node.

4 Copy the Host Name and Host Code into a text file using Notepad or any other text editor.

5 Close the OAkey dialog box, and then click OK to close OAconfigure.

http://www.oa.com

OA f ram e wo rk S ys te m C o n f i g u ra t i o n d ia l o g b o x

OA k e y d i a l o g b o x

20

Obtaining a License (COL) File• The next step is to send your OAkey to ObjectAutomation to obtain your license

collection file:

To obtain your l icense col lection f i le through email or phone

1 Email or telephone the Host Name, Host Code, your 8-digit Customer ID Number, Password, Contact Name and Current Address to the Customer Satisfaction Team. Email: license@oa.com Phone: +1 (877) 622-2899 (Toll Free for US and Canada); +31 497 383818

(Europe)

Your Customer ID Number and Password were e-mailed or faxed to your designated Installation Contact at the time of purchase.

2 The Customer Satisfaction Team will mail a floppy disk with the license collection file(s) to you.

3 After receiving the license file (*.COL), copy it to a safe backup area. (Do not rename the license file; renaming the file invalidates it.) It is recommended that you archive this backup file.The next step is to install the license collection file(s).

http://www.oa.com

21

Installing the License FileThe next step is to install the license collection file(s) on the node(s).

To instal l the l icense col lection f i le

1 When you receive the license file(s), copy it to the C:\Program Files\OA\License folder (or to the location where you installed the ObjectAutomation software) on the License Host node. Also, remember to make a backup of your license collection file and archive it.

2 If a file called install.tmp exists in the \License folder, delete it. 3 Now, you will shut down the OAframework services on the License Host node and on

all cell nodes that will be using licenses from this license collection file. (This includes any node from which you deleted the install.tmp file.) If this is a distributed cell, shut down cell client nodes before cell manager nodes. On the desktop, on the Taskbar, right-click the OAenterprise tray (OAtray)

icon.

On the shortcut menu, click Shutdown OAenterprise. In the confirmation dialog box, click Yes.

This shuts down all of the running objects and the OAframework services on the node. When the services are shutdown, the OAenterprise icon in the Taskbar tray turns red.

4 If this is a distributed cell, repeat step 3 to continue shutting down OAframework services on nodes as required.

5 Now, you can begin to restart the OAframework services. If this is a distributed cell, restart the services on cell manager nodes before cell client nodes. On the desktop, on the Taskbar, right-click the OAenterprise tray icon again. On the shortcut menu, click Start OAenterprise. In the confirmation dialog box, click Yes.

This starts the OAframework services on the node. When the services are started, the OAenterprise icon in the Taskbar tray turns green.

6 If this is a distributed cell, repeat step 5 to continue restarting OAframework services on nodes as required.

Congratulations!You are now ready to start OAenterprise! On your desktop, double-click the OAworkbench icon. The first time you start an OAenterprise application that requires a license—for example, OAworkbench–-the OA License Manager loads the license file.

TIPYou can use the License Viewer to view and verify information about all of the licenses available in an OAenterprise system and print license reports. It gathers information from all License Managers running in a given OAenterprise cell; collates the information; and displays it in a tabular format. To open the License Viewer, on any node in the OAenterprise cell, open OAconfigure (from the Start menu, point to Programs, point to OAenterprise, and then click OAconfigure.) In the OAframework System Configuration dialog box, on the System tab, click License Viewer. For more information about using the License Viewer, refer to "Working with the License Viewer" in the online OAenterprise User's Guide.

http://www.oa.com