2PAA107391-510 A en Smart Client For 800xa 5.1 Installation and Configuration PDF

Smart Client for 800xA
Installation & Configuration

System Version 5.1
Power and productivity

for a better world
TM
Smart Client for 800xA

Installation & Configuration
System Version 5.1
NOTICE
This document contains information about one or more ABB products and may include a
description of or a reference to one or more standards that may be generally relevant to
the ABB products. The presence of any such description of a standard or reference to a
standard is not a representation that all of the ABB products referenced in this document
support all of the features of the described or referenced standard. In order to determine
the specific features supported by a particular ABB product, the reader should consult the
product specifications for the particular ABB product.
ABB may have one or more patents or pending patent applications protecting the intellectual property in the ABB products described in this document.
The information in this document is subject to change without notice and should not be
construed as a commitment by ABB. ABB assumes no responsibility for any errors that
may appear in this document.
In no event shall ABB be liable for direct, indirect, special, incidental or consequential
damages of any nature or kind arising from the use of this document, nor shall ABB be
liable for incidental or consequential damages arising from use of any software or hardware described in this document.
This document and parts thereof must not be reproduced or copied without written permission from ABB, and the contents thereof must not be imparted to a third party nor used
for any unauthorized purpose.
The software or hardware described in this document is furnished under a license and
may be used, copied, or disclosed only in accordance with the terms of such license. This
product meets the requirements specified in EMC Directive 2004/108/EEC and in Low
Voltage Directive 2006/95/EEC.
TRADEMARKS
All rights to copyrights, registered trademarks, and trademarks reside with their respective owners.
Copyright 2003-2011 by ABB.

All rights reserved.
Release:
Document number:
December 2011
2PAA107391-510
Table of Contents
Table of Contents
About This User Manual
General ..............................................................................................................................9
User Manual Conventions .................................................................................................9
Warning, Caution, Information, and Tip Icons..................................................................9
Terminology.....................................................................................................................10
Released User Manuals and Release Notes.....................................................................11
Section 1 - Introduction
System Architecture ........................................................................................................13
Valid Combination for Node Type Installation ....................................................16
Section 2 - Smart Client Excel Interface Installation

Prerequisites ....................................................................................................................17
Installing the Smart Client Excel Interface ..................................................................18
Section 3 - Smart Client Installation

Prerequisites ....................................................................................................................23
Disable User Account Control (UAC) .................................................................25
Installation Procedure ......................................................................................................27
Smart Client Server Installation ...........................................................................30
Smart Client 800xA Data Provider Installation ...................................................33
Smart Client Server and 800xA Data Provider Installation .................................40
Smart Client Aspect Installation ..........................................................................41
Licensing .........................................................................................................................41
Loading 800xA and Smart Licenses ....................................................................41
Installation of NLS Package ............................................................................................42
Section 4 - Post Installation

Verifying Installation .......................................................................................................47
Firewall Settings ..............................................................................................................49
2PAA107391-510
Table of Contents
Configuring the Event Services....................................................................................... 50

Configuring the 800xA History Services ........................................................................ 52
Verifying the Data Provider Status.................................................................................. 54
Loading System Extensions ............................................................................................ 57
Section 5 - Configuration
Configuration Tools......................................................................................................... 63
Object Type Configuration Tool .......................................................................... 63
Date Format Configuration Tool.......................................................................... 70
User Configuration Tool ...................................................................................... 72
Special Character Rules ....................................................................................... 83
Smart Client Database Backup and Restore.................................................................... 84
Backup Command Line Tool ............................................................................... 84
Restore Command Line Tool ............................................................................... 85
Section 6 - System Upgrade

Upgrade Smart Client v2.1 to v2.2.................................................................................. 87
Appendix A - Data Providers

Communication Port ....................................................................................................... 89
Alarm and Event (EVT800xA) ....................................................................................... 89
Program Name ..................................................................................................... 89
Default Startup Command ................................................................................... 89
Command Line Arguments.................................................................................. 89
Other Parameters.................................................................................................. 90
ActiveX Data Object (ADO) ........................................................................................... 91
Program Name ..................................................................................................... 91
Command Line Arguments.................................................................................. 92
Other Configuration Parameters ......................................................... 93
COM ............................................................................................................................. 94
Program Name ..................................................................................................... 94
2PAA107391-510
Table of Contents
Command Line Arguments ..................................................................................94

Other Configuration Parameters..........................................................94
Distributed Data Repository (DDR) ................................................................................95
Program Name .....................................................................................................95
Default Startup Command....................................................................................95
Other Configuration Parameters..........................................................97
Browser (BRW800xA) .........................................................................................97
Program Name .....................................................................................................98
Default Startup Command....................................................................................98
Other Parameters .................................................................................99
General Utilities (UTI) ....................................................................................................99
Program Name .....................................................................................................99
Default Startup Command..................................................................................100
Command Line Arguments ................................................................................100
Other Parameters ...............................................................................101
PPA
............................................................................................................................101
Program Name ...................................................................................................101
Search (SEA800xA) ......................................................................................................103

Program Name ...................................................................................................103
OPC DA (OPCDA800xA).............................................................................................105
Program Name ...................................................................................................105
2PAA107391-510
Table of Contents
OPC HDA (OPCHDA800xA)....................................................................................... 109

Program Name ................................................................................................... 109
Default Startup Command ................................................................................. 109
Command Line Arguments................................................................................ 110
Other Parameters................................................................................................ 111
2PAA107391-510

General
Any security measures described in this User Manual, for example, for user
access, password security, network security, firewalls, virus protection, etc.,
represent possible steps that a user of an 800xA System may want to consider
based on a risk assessment for a particular application and installation. This risk
assessment, as well as the proper implementation, configuration, installation,
operation, administration, and maintenance of all relevant security related
equipment, software, and procedures, are the responsibility of the user of the
800xA System.
The Smart Client for 800xA is an application that retrieves information from the
System 800xA to a personal computer located within a process plant or in a remote
location.
This user manual is recommended for the users having knowledge of using the
800xA system.
User Manual Conventions

Microsoft Windows conventions are normally used for the standard presentation of
material when entering text, key sequences, prompts, messages, menu items, screen
elements, etc.
Warning, Caution, Information, and Tip Icons

This User Manual includes Warning, Caution, and Information where appropriate to
point out safety related or other important information. It also includes Tip to point
2PAA107391-510
Terminology
out useful hints to the reader. The corresponding symbols should be interpreted as
follows:
Electrical warning icon indicates the presence of a hazard that could result in
electrical shock.
Warning icon indicates the presence of a hazard that could result in personal
injury.
Caution icon indicates important information or warning related to the concept
discussed in the text. It might indicate the presence of a hazard that could result
in corruption of software or damage to equipment/property.
Information icon alerts the reader to pertinent facts and conditions.
Tip icon indicates advice on, for example, how to design your project or how to
use a certain function
Although Warning hazards are related to personal injury, and Caution hazards are
associated with equipment or property damage, it should be understood that
operation of damaged equipment could, under certain operational conditions, result
in degraded process performance leading to personal injury or death. Therefore,
fully comply with all Warning and Caution notices.
Terminology
A complete and comprehensive list of terms is included in System 800xA System
Guide Functional Description (3BSE038018*). The listing includes terms and
definitions that apply to the 800xA System where the usage is different from
commonly accepted industry standard definitions and definitions given in standard
dictionaries such as Websters Dictionary of Computer Terms.
Term/Acronym
DDR
Description
Dynamic Data Repository component which is a part of Smart
Client Server.
For a list of Smart Client terminologies, refer to Smart Client for 800xA, User Guide
(2PAA106886*).
10
2PAA107391-510
Released User Manuals and Release Notes

A complete list of all User Manuals and Release Notes applicable to System 800xA
is provided in System 800xA Released User Manuals and Release Notes
(3BUA000263*).
System 800xA Released User Manuals and Release Notes (3BUA000263*) is
updated each time a document is updated or a new document is released. It is in pdf
format and is provided in the following ways:
Included on the documentation media provided with the system and published
to ABB SolutionsBank when released as part of a major or minor release,
Service Pack, Feature Pack, or System Revision.
Published to ABB SolutionsBank when a User Manual or Release Note is

updated in between any of the release cycles listed in the first bullet.
A product bulletin is published each time System 800xA Released User Manuals
and Release Notes (3BUA000263*) is updated and published to ABB
SolutionsBank.
2PAA107391-510
11
12
2PAA107391-510
Section 1 Introduction
The Smart Client for 800xA is an application that retrieves information from the
System 800xA to a personal computer located within a process plant or in a remote
location.
The Smart Client application includes functions to graphically present real-time
data in any format. The data can be retrieved from an ABB control system
connected to the 800xA System or any third party control system connected to the
800xA System through OPC or other protocols.
The Smart Client for 800xA provides intelligent data access and display features to
assist the personnel for decision making and thereby improving performance.
System Architecture
The Smart Client for 800xA consists of the following four components:
1.
Smart Client Server - The Smart Client Server is a web server that can be
installed in the Microsoft Windows Server node. The configured data is stored
and retrieved from the Smart Client Server.
2.
Smart Client Data Provider - The Smart Client Data Provider is an

application to which the server application of the Smart Client connects, to
fetch information. The Data Provider must be installed in an 800xA node with
Information Management or an 800xA Connectivity node. Some of the data
providers are OPC DA and OPC HDA.
The Events do not function if the Smart Client Data Provider is installed in an
800xA Connectivity node. This supports only the data access, history data access,
PG2 graphics, and PPA trend.
3.
Smart Client Aspect Node - The Smart Client configuration aspects in the
800xA system, that is, the services related to Smart Client in the 800xA system
2PAA107391-510
13
System Architecture
and the Smart Client objects created in the 800xA workplace, are installed in
the Smart Client Data Provider Node by default. To view these aspects from
any 800xA node (other than the Smart Client Data Provider Node), the Smart
Client Aspect Node installation is required.
4.
Smart Client Desktop Node - The Smart Client Desktop is a .NET application
downloaded from a web server. It uses a TCP/IP network to connect to the
Smart Client Server and subscribes to real time data. The data is fetched from
the Smart Client Data Provider.
The Smart Client Desktop allows the user to create presentation displays.
These displays are used to monitor different areas in a process plant. The Smart
Client Desktop also allows the user to use the existing PG2 graphic displays
created in the 800xA system. Trend displays can also be used from the 800xA
system.
Figure 1 shows the architecture of the Smart Client application.
14
2PAA107391-510
System Architecture
Figure 1. System Layout

The Smart Client Desktop is launched through the Internet Explorer. This connects
to the Smart Client Server through a TCP/IP port and subscribes to real-time data.
The real-time data is retrieved from the Smart Client Data Provider Node.
The Smart Client Data Provider must be a part of the 800xA system, in a node
with Information Management or in a Connectivity Server.
The Smart Client Data Provider connects to the 800xA system to subscribe to
data, which is retrieved from an ABB control system connected to the 800xA
system.
2PAA107391-510
15
Valid Combination for Node Type Installation
The Smart Client product consists of a distributed set of server nodes and Smart
Client Desktop nodes residing on a network.
The Client/Server network is used for communication between the servers.
The Control network is used to connect controllers to the servers. This is a Local
Area Network (LAN) that is optimized for high performance and reliable
communication with good response times.
An aspect server provides the aspect directory and services related to object
management, object names, structure names, and security to access the aspects and
objects. A connectivity server provides access to controllers.
Valid Combination for Node Type Installation

This section provides information on the nodes where the Smart Client components
can be installed.
Smart Client Aspect Node

The Smart Client Aspect Node installation must be done only in an 800xA
node. The Smart Client Aspect Node installation provides the option to
engineer Smart Client related objects available in the 800xA system.
Smart Client Data Provider Node

The Smart Client Data Provider installation can be done in an 800xA node with
Information Management (this is preferable). The events in Smart Client will
be available when the Smart Client Data Provider is installed in an 800xA node
with Information Management.
The Smart Client Data Provider can also be installed in an 800xA Connectivity
Server. In this case, the 800xA based events will not be available in Smart
Client.
The Smart Client Aspect Node is automatically installed on installing the
Smart Client Data Provider.
Smart Client Server Node

The Smart Client Server Node must be installed in an independent machine
(this is preferable). It is also possible to combine the installation of the Smart
Client Data Provider and Smart Client Server.
16
2PAA107391-510
Section 2 Smart Client Excel Interface

Installation
This section describes the procedure to install the Smart Client Excel Interface
application.
For more information on using the Smart Client Excel Interface application, refer
to Smart Client for 800xA, Smart Client Excel Interface (2PAA107390*).
Prerequisites
The following prerequisites should be installed on the Smart Client node before
installing the Smart Client Excel Interface:
1.
Microsoft Office 2007 Suite with SP2 Installed.
2.
Microsoft Excel 2010 must be installed.
3.
Adobe Reader 5.0 or above.
4.
Patch Installation Order (for the All Users Installation Option)
Install the patch KB976477 after installing the Microsoft Office 2007
Suite with SP2 (this must be a manual installation, the patch should be
download and installed as distribution is not allowed in the Installer).
Install the patch KB980210 after installing the patch KB976477 (this must
be a manual installation, the patch should be download and installed as
distribution is not allowed in Installer).
5.
Windows Installer (This is available by default in Windows 7 Operating

System).
6.
.NET Framework 3.5 SP1 (This is available by default in Windows 7 Operating

System).
2PAA107391-510
17
Installing the Smart Client Excel Interface
Section 2 Smart Client Excel Interface Installation
7.
Primary Interop Assemblies 2007
8.
The Visual Studio 2005 Tools for Office runtime (vstor 3.0 SP1).

Execute the following steps to install the Smart Client Excel Interface:
Click Back to navigate to the previous wizard pages.
Click Cancel to cancel the installation.
1.
Double-click the Setup.exe file located in the root directory of the CD drive.
Figure 2 appears if the prerequisites are not installed in the system.
Figure 2. Prerequisites
2.
18
Click Install to install the prerequisites.
The Welcome Wizard (see Figure 3) appears after installing the prerequisites.
2PAA107391-510
Figure 3. Welcome window

3.
Click Next. The Ready to Install the Program wizard appears (see Figure 4).
Figure 4. Ready to Install window
2PAA107391-510
19
4.
Click Install to begin the installation.
5.
Click Next. The Select Installation Folder wizard appears (see Figure 5).
Click Browse to specify the installation path. By default, the path is C:\
Program Files\ ABB\ ABB Smart Client Excel Interface.
Figure 5. Select Installation Folder

6.
20
Click Next to continue the installation. The Confirm Installation wizard

appears (Figure 6).
2PAA107391-510
Figure 6. Confirm Installation

7.
Click Next to proceed with the installation.
8.
Click Close after the successful installation of Smart Client Excel Interface
(see Figure 7).
2PAA107391-510
21
Figure 7. Installation Complete

For more information, refer to Smart Client for 800xA, Smart Client Excel
Interface (2PAA107390*).
22
2PAA107391-510
Section 3 Smart Client Installation

This section includes the procedure to install the Smart Client application for
different Smart Client node types when retrieving data from an 800xA system.
Prerequisites
Table 1 shows the prerequisites to be installed in different nodes to use the Smart
Client application.
Table 1. Prerequisites for each Node
Prerequisites
Internet Information Services 7.0 (see
Enabling Internet Information Services
(IIS))
Internet Explorer 6.0 and later versions
To be Installed in Smart Client Nodes

Smart Client Server
Smart Client Server

Smart Client Data Provider
Smart Client Desktop
Adobe Reader 5.0 or above
Smart Client Server

Oracle 11g, installed with 800xA

Information Management node
(optional)
2PAA107391-510
Smart Client Data Provider (for viewing Events in

Smart Client)
23
Prerequisites
Table 1. Prerequisites for each Node

Prerequisites
To be Installed in Smart Client Nodes
Microsoft Visual C++ 2008 Runtime

Libraries (is available on the Smart
Client media and prompts if it is not
available in the system to install. Hence
no manual installation is required.)
Smart Client Server
Microsoft Visual J# .Net Redistributable

Package 2.0
Smart Client Server

Microsoft .NET Framework 3.5 SP1 (is Smart Client Server

available on the Smart Client media and Smart Client Data Provider
available as default option in Windows 7
Operating System. Hence it need not be
installed for Windows 7)
Table 2 shows the Operating System which is compatible with the different nodes.
Table 2. Operating System for each Node
Supported Operating Systems
Windows Server 2003
Smart Client Nodes

Smart Client Server
Windows Server 2008
Smart Client Server

Windows XP

Windows 7

24
2PAA107391-510
Disable User Account Control (UAC)
Table 3 shows the versions of the Smart Client Data Provider and the Smart Client
Server that supports the corresponding version of the 800xA system.
Table 3. Supported versions
800xA System
Smart Client Server
System Version 5.0 SP2

Rev D
Version 2.1 SP1
Version 2.2
System Version 5.1 Rev A
Version 2.2
Version 2.2
System Version 5.1 FP1
Version 2.2
Version 2.2

Perform the following procedure to disable UAC.
Windows Server 2008
1.
Open Windows Control Panel.
2.
Change Windows Control Panel to Classic View.
3.
Double-click User Accounts.
4.
Select Turn User Account Control on or off.
5.
Clear the Use User Account Control (UAC) to help protect your computer
check box and click OK.
Windows 7
1.
Open Windows Control Panel.
2.
Change Windows Control Panel to Large Icons view.
3.
Click User Accounts.
4.
Select User Accounts > Change User Account Control Settings.
5.
Slide the bar to Never notify and click OK.
Enabling Internet Information Services (IIS). Configure the following roles in the
Internet Information Services 7.0:
2PAA107391-510
25
This configuration is only required if the Smart Client Server component is

installed in the Windows 7 or Windows 2008 Server operating systems.
To verify that IIS is enabled, execute the following steps:
1.
In Windows 7, navigate to Internet Information Services in Control Panel >

Programs and Features > Turn Windows features on or off and configure
the roles specified in Step 3.
2.
In Windows 2008 Server,
3.
26
a.
Navigate to Start > All Programs > Administrative Tools > Server
Manager.
b.
In the Server Manager dialog, select Roles in the left window pane.
c.
In the Server Manager dialog, select Roles Summary and click Add
Roles in the right window pane.
d.
In the Add Roles Wizard dialog, select Server Roles and select the Web
Server (IIS) check box.
e.
Select Role Services in Web Server (IIS) and configure the roles
specified in Step 3.
Configure the following roles for the Windows 7 and Windows 2008 Server
operating systems.
a.
Web Management Tools (in Windows 7) or Management Tools (in

Windows 2008 Server)
IIS Management Console
IIS Management Scripts and Tools
IIS Management Service
b.
Application Development Features
ASP
ASP.NET
.NET Extensibility
ASP (The dependent feature for ASP is ISAPI Extension)
2PAA107391-510
ISAPI Filters
Server Side Includes
c.
Security
Basic Authentication
Request Filtering
Windows Authentication
d.
Common HTTP Features
Default Document
Static Content
Directory Browsing
HTTP Errors
HTTP Redirection
Installation Procedure
Execute the following steps to install Smart Client application:
1.
Double-click the Setup.exe file located in the root directory of the CD drive.
Figure 8 appears if the prerequisites are not installed in the system.
The system detects only the following software:
Microsoft .NET Framework 3.5 SP1
Microsoft Visual J# .NET Redistributable Package 2.0
Microsoft Visual C++ 2008 Runtime Libraries
Microsoft XML 4.0 SP3 parser
The remaining software specified in Prerequisites should be installed manually

by the user.
2PAA107391-510
27
Figure 8. Prerequisites
28
Click Install to install the prerequisites.
2.
The Welcome Wizard appears after installing the prerequisites.
3.
Click Next to proceed. The Installation Type wizard appears to select the type
of installation (see Figure 9).
2PAA107391-510
Figure 9. Selecting Installation Type
2PAA107391-510
Select the Server Node check box for installing the Smart Client Server
(see Smart Client Server Installation on page 30).
Select the 800xA Data Provider Node check box for installing the Smart
Client Data Providers (see Smart Client 800xA Data Provider Installation
on page 33). The Aspect Node check box is selected automatically, and
the user cannot clear the selection of this check box.
Select the Aspect Node check box for installing the Smart Client aspects
(see Smart Client Aspect Installation on page 41).
Select the Server Node check box and the 800xA Data Provider Node
check box for installing the Smart Client Server and the Smart Client Data
Provider on the same node (see Smart Client Server and 800xA Data
Provider Installation on page 40).
29
Smart Client Server Installation

Before installing the Smart Client Server:
(a) A Windows user account should be created. This user account should have the
privileges of an Administrator account. The Windows user account can be a local
user or must exist on the same domain as the Smart Client Server.
(b) The user should install the Central Licensing Server (CLS). For more
information on CLS, refer to System 800xA, Configuration (3BDS011222*).
(c) The user should install Internet Information Services 7.0. For more
information, refer to Enabling Internet Information Services (IIS).
Execute the following steps to install the Smart Client Server:
1.
Select the Server Node check box as the installation type (see Figure 9).
2.
Click Next. The Smart Client Server Details wizard appears (see Figure 10).
Figure 10. Server Details
30
2PAA107391-510
3.
In Smart Client administrator account, enter the Windows administrator

account name (created in Step (a) in the above information). By default, the
account name is Administrator.
4.
Select the Security Level as High or Low. By default, the security level is
High.
5.
High - If the Windows user account does not exist in the same domain as
the Smart Client Server, the system prompts for a user name and password
for a valid Windows account. The Windows user account must be
registered in the Smart Client user database available in the Smart Client
Server.
Low - A remote user is allowed to access the Smart Client Server without
providing a user name and password, if the Windows user account is
registered in the Smart Client user database.
Click Next. The Choose Destination Location wizard appears (see Figure 11).
Figure 11. Selecting Destination Location
2PAA107391-510
31
6.
Click Browse and select the destination folder to install the Smart Client
Server. By default, the destination path is C:\ Program Files \ ABB Smart
Client.
7.
A summary of the installation settings is displayed (see Figure 12).
Figure 12. Review Settings

Click Next to continue the installation. The InstallSheild Wizard Complete
wizard appears on completing the installation (see Figure 13).
32
2PAA107391-510
Smart Client 800xA Data Provider Installation
Figure 13. Installation Complete

8.
Click Finish to complete the installation.

A Windows user should have the Administrator privileges.
The Smart Client 800xA Data Providers should be installed on an 800xA
Connectivity Server or 800xA Information Manager node.
The 800xA events are not visible in the Smart Client if the 800xA Data Provider
is installed in the 800xA Connectivity Server. This displays only the real-time
values and basic history.
To access the Information Management History and Events, install the 800xA
Data Provider on an 800xA node with Information Manager.
Execute the following steps to install the Smart Client 800xA Data Provider:
1.
2PAA107391-510
Select the 800xA Data Provider Node check box as the installation type (see
Figure 9).
33
On selecting the 800xA Data Provider Node check box, the Aspect Node
check box is selected by default.
Figure 14. 800xA Data Provider Node and Aspect Node

2.
34
Click Next. The System Name wizard appears (see Figure 15).
2PAA107391-510
Figure 15. System Name Details

3.
In System Name, enter a name of the 800xA System (this is preferred) or any
user specific string (for example, PM1, Mill1, Power).
The System Name is used to configure the of Smart Client Services in this
node. This is also used as a reference when browsing for Tags in the Smart
Client application.
By default the System Name is set to Computer Name that can be modified by
the user.
NOTE: The System Name must be unique among the Data Provider node
installation.
4.
2PAA107391-510
Click Next. The Smart Client Server Node Host Name wizard appears (see
Figure 16).
35
Figure 16. Smart Client Server Node Host Details

5.
Step 6 to Step 10 is applicable only for the Smart Client Data Provider
installation in an 800xA Information Manager node.
SA
6.
36
In DNS host name or IP address, enter the host name or IP address of the
Smart Client Server Node. The Smart Client Data Provider Node will connect
to the corresponding Smart Client Server Node.
Click Next. The Smart Client Common Database Node wizard appears (see
Figure 17).
2PAA107391-510
Figure 17. Smart Client Common Database Node

7.
Select the common database by selecting the Common database node check
box.
If there are several data provider nodes, only one of them must be assigned to be
the common database node.
SA
8.
2PAA107391-510
Click Next. The Oracle Information wizard appears (see Figure 18).
37
Figure 18. Oracle Information

9.
Select the Install Smart Client Oracle option to create the Oracle database
tables for Smart Client.
10. In Password, enter a password for the Oracle user system.

By default, the password for the user System is OCSHIS and the password for
the user ops$ocshis is ocshis.
11. Click Next. The 800xA System Software Account wizard appears (see
Figure 19).
38
2PAA107391-510
Figure 19. 800xA System Software Account

12. Enter the user name and password to access the 800xA system.
13. Click Next. The Port Number wizard appears (see Figure 20).
By default, the port number is 19131.
2PAA107391-510
39
Smart Client Server and 800xA Data Provider Installation
Figure 20. Port Number

14. Click Next and execute Step 5 to Step 8 (see Smart Client Server Installation)
to complete the installation.
Smart Client Server and 800xA Data Provider Installation

Execute the following steps to install the Smart Client Server and the 800xA Data
Provider on the same node:
40
1.
Select the Server Node and 800xA Data Provider Node check boxes as the
installation type (see Figure 9).
2.
Click Next and execute Step 2 to Step 4 (see Smart Client Server Installation).
3.
Click Next and execute Step 3 to Step 14 (see Smart Client 800xA Data
Provider Installation).
2PAA107391-510
Smart Client Aspect Installation
Smart Client Aspect Installation

A Windows user should have the Administrator privileges.
The Smart Client aspects should be installed in the 800xA Aspect Server and
other nodes where the Smart Client aspects should be shown.
Execute the following steps to install the Smart Client Aspects:
1.
Select the Aspect Node check box as the installation type (see Figure 9).
2.
Click Next and execute Step 5 to Step 8 (see Smart Client Server Installation)
to complete the installation.
If the Smart Client application is opened in Data Provide node during the
network cable disconnect/connect, client should be re-launched. Smart Client
will connect automatically in Server node or in any client.
Licensing
The 800xA License Server is used for Smart Client licensing. The 800xA License
Server must exist in the same Windows domain as the Smart Client Data Provider.
Loading 800xA and Smart Licenses

To load the licenses, refer to the Central Licensing System (CLS) section in System
800xA, Installation (3BSE034678*).
Select License Entry from Start > All Programs > ABB Industrial IT 800xA >
System > Licensing and verify if the feature SMART_CLIENTPG2 exists in 800xA
Operations.
2PAA107391-510
41
Installation of NLS Package
The Qty column corresponding to the SMART_CLIENTPG2 feature specifies the

quantity of licenses. For example, if Qty is 5, only five clients can access the
information from the current Smart Client Data Provider Node.
If the sixth client tries to access the Smart Client Data Provider Node, the
message User don't have valid license for system name(s):<x>, <y>. So, limited
functionalities available appears, where <x> and <y> are the Smart Client Data
Provider Node names.
The clients can access the node with limited functionality, that is, the DA, HDA,
and Event List will not function, the Browsers display No System for the
corresponding node, the properties will not be subscribed, and the panels
containing subscribed properties will be blank.

Install the Native Language Support (NLS) package to localize the Smart Client
application.
The current version of the Smart Client application only supports the Swedish
language package.
Execute the following steps to install the NLS package for the Smart Client
application:
1.
42
Execute the setup.exe file in the Language Package folder.
2PAA107391-510
Figure 21. Language Package Installation

2.
Click Finish to complete the installation.
3.
Select Region and Language in Start > Control Panel > Regional and
Language option.
4.
Select the language format to Swedish (Sweden).
2PAA107391-510
43
Figure 22. Regional Settings

5.
Click Apply and then OK to save the changes.

The titles in the Menu bar, Context menu, Trends, Events, Panels, and
Workplace in the Smart Client Desktop application will be localized to the
selected language format after the NLS Installation.
44
2PAA107391-510
Verify the text strings in the .csv file in the Language Package folder. The user
can change the Swedish text if required, in this .csv file.
2PAA107391-510
45
46
2PAA107391-510
Section 4 Post Installation

Verifying Installation
This section describes some basic checks to verify the installation of the Smart
Client application.
Smart Client Server Node
Execute the following steps on the Smart Client Server Node:

1.
Navigate to Control Panel > Programs and Features if this node is installed
in the Windows 2008 Server operating systems.
Navigate to Control Panel > Add or Remove Programs if this node is
installed in the Windows 2003 Server operating system.
2.
Verify that ABB Smart Client 2.2 is shown in the list of installed products.
3.
Navigate to Start > Programs > ABB Smart Client > Program Supervision
Manager.
In the Program Supervision Manager, verify that the COM and DDR services
are in the Running Status (represented by a Green icon).
4.
In the Internet Explorer, specify the address http:// <Smart Client Server IP
Address>/ SC. This must launch the Smart Client Desktop component. A
download prompt will appear for the first time while launching the Smart
Client Desktop.
Smart Client Data Provider Node
Execute the following steps on the Smart Client Data Provider Node:
1.
2PAA107391-510
in the Windows 7 or Windows 2008 Server operating systems.
47
Verifying Installation

2.
3.
Navigate to Start > Programs > ABB Smart Client > Program Supervision
Manager.
In the Program Supervision Manager, verify that the services, ADO,
BRW800xA, OPCDA800xA, OPCHDA800xA, PPA, SEA800xA, and UTI800xA
are in the Running Status (represented by a Green icon).
Various parameters of a Data Provider can be configured. One of the parameter is
explained in the following.
For example, the Data Provider/Service BRW800XA has a parameter alivetimeout as 60 by default. If the Browsed object has more than 10000 child
objects, it may take more time to browse the object resulting in Data Provider
/Service restart. Hence the timeout number has to be increased for the parameter.
To change to a higher timeout for the -alivetimeout parameter, follow the below
steps:
1. Stop the corresponding Data Provider by selecting Stop from the right-click
menu option on the DataProvider.
DataProvider appears as Red icon.
2. Double-click on the DataProvider.
A dialog box with the Title Properties - <Corresponding DataProvider
Name> appears.
3. Select the page Program and change the command line with the modified
alivetimeout.
To change the Maximum number of restarts allowed for a DataProvider, follow
the above steps 1 and 2 to get the pop-up dialog box. Select the page Restart and
set the value for Max Restarts.
4.
In the 800xA Plant Explorer Workplace:

a.
48
Verify that the object IP800xA, IP800xA Folder is created in the Control
Structure.
2PAA107391-510
b.
Firewall Settings
Verify that the service PpSpAlarmEvent, Service is created in the Service

Structure.
Smart Client Aspect node
The Smart Client Aspect node is only used to configure the Smart Client
PpSpAlarmEvent service. To verify the installation of the Smart Client Aspect node
component, execute the following steps:
1.
in the Windows 7 or Windows 2008 Server operating systems.
2.
Firewall Settings
This section describes the Firewall Settings to be done for the Smart Client
application.
The port used on the Smart Client Server for any inbound or outbound
communication is 19131 if the default port is used (see Figure 20). The Smart Client
Data Provider or the Smart Client Desktop nodes use the Dynamic or Ephemeral
ports (49152 - 65535) to connect to the Smart Client Server.
To configure a hardware firewall switch for this scenario, the following settings
must be done for the effective communication between the Smart Client Server,
Smart Client Data Provider, and the Smart Client Desktop nodes.
Allow Port Range: 49152 - 65535 from Smart Client Data Provider (Outbound)
to Smart Client Server (Inbound).
Allow Only Port: 19131 from Smart Client Server (Outbound) to Smart Client
Data Provider (Inbound).
Allow Port Range: 49152 - 65535 from Smart Client Desktop Node
(Outbound) to Smart Client Server (Inbound).
Allow Only Port: 19131 from Smart Client Server (Outbound) to Smart Client
Desktop Node (Inbound).
2PAA107391-510
49
Configuring the Event Services

The configuration of Event Services must be done on the Smart Client Data
Provider Node. Execute the following steps to create an 800xA Event service:
1.
Right-click PpcSPAlarmEvent service in Service Structure > Services and

select New Object from the context menu.
2.
Enter PpcSpAlarmEvent_G0 as the name of the service group and click

Create.
3.
Right-click the service group PpcSpAlarmEvent_G0 and select New Object

from the context menu.
4.
Enter PpcSpAlarmEvent_G0_<node name> as the name of the service

provider and click Create.
Starting the Event service: To start the event service:
50
1.
Select the service provider PpcSpAlarmEvent_G0_<node name> in Service

Structure > Services > PpcSPAlarmEvent.
2.
Select the Service Provider Definition aspect.
3.
In Node, enter the correct node name.
4.
Select the Enabled check box in the Configuration tab of this aspect (see
Figure 23).
2PAA107391-510
Figure 23. Starting the Event service

5.
Click Apply to start this service.
Configuring the number of events: To configure the number of events to be
stored in the Smart Client database:

1.
Select the service group PpcSpAlarmEvent_G0 in Service Structure >

Services > PpcSPAlarmEvent.
2.
Select the Service Group Definition aspect.
3.
Enter the following details in the Special Configuration tab of this aspect (see
Figure 24).
2PAA107391-510
In Events to store, enter the maximum number of events to be stored in

the database. The maximum number of events that can be stored is
1,000,000.
Enter the Trace Level as 0.
51
Configuring the 800xA History Services
Trace Level is an option to trace out an issue. Level 0 logs only the errors or
exceptions, Level 1 displays a brief information about the issue, and Level 2 and
Level 3 displays the additional parametric information and function flows.
Figure 24. Event Storage specification in Event Service

4.
Click Apply to save the changes.

Execute the following steps to create an 800xA Information Manager Message Log.
These steps must be executed if an Information Manager Message Log is not
previously created.
For more information on configuring the History Services, refer to System 800xA
Information Management, Configuration (3BUF001092*).
1.
52
Right-click Message Logs node in Node Administration Structure > Inform

IT History Object and select New Object from the context menu.
2PAA107391-510
2.
Enter IMMSGLOG as the name of the message log and click Create. Change
the mode to ACTIVE in IMMSGLOG
Creating a History Log: To create a history log:
1.
In the Control Structure, right-click an object for which a trend log should be
created, and select New Aspect from the context menu.
2.
Select the aspect category History Configuration > Log Configuration.
3.
Enter a name for the aspect and click Create.
4.
In Logged Properties, click Add Property Log to add an object property for
which the data should be stored.
Figure 25. New Property Log
5.
2PAA107391-510
Select the property and the data type of the property.
Select a log template.
Click OK to add a property log. The property log will be displayed in the
Logged Properties area in the Log Configuration aspect.
Click Apply to save the changes.
53
Verifying the Data Provider Status
Figure 26. Log Configuration Aspect

Execute the following steps to verify the status of the data providers:
1.
Select Status Display from Start > All Programs > ABB Smart Client. The
ADSStatus dialog appears (see Figure 27).
This option is available in the Smart Client Server Node and the Smart Client
Data Provider Node. The information displayed in this dialog is retrieved from
the Smart Client Server.
If the Status Display is used in the Smart Client Data Provider Node, the IP
address of the Smart Client Server must be specified in the Host field in
Connection (see Figure 27).
54
2PAA107391-510
Figure 27. Status Display

2.
Click Data Provider to display the status of the data providers.

COM is getting restarted or the Data Providers are getting restarted:
To ensure that the Smart Client Server and the Smart Client Data Provider Nodes
are connected, ping the Smart Client Data Provider Node with the system name
from Smart Client Server Node and observe if it responds. If the nodes do not
respond, add the names of the systems and the corresponding IP address in the
hosts file of the Smart Client Server Node, in C:\Windows\System32\drivers\etc.
Starting/Stopping a Data Provider. To start/stop a data provider:
1.
2PAA107391-510
Select Supervision Manager from Start > All Programs > ABB Smart
Client. The Supervision Manager dialog appears (see Figure 28).
55
Figure 28. Supervision Manager

2.
Right-click a data provider on the tree (see Figure 29) and select Start from the
context menu to start the data provider.
Select Start Recursively from the context menu, to start the data provider
including the child nodes.
Select Stop from the context menu to stop the data provider.
56
2PAA107391-510
Loading System Extensions
Figure 29. Context Menu of a data provider

System extensions provide the 800xA System with additional functionality and
ABB Smart Client is one of them. Loading system extension for Smart Client is
inevitable to install Smart Client Data Provider Node without the 800xA system
running. System extension has to be loaded just after the Smart Client installation
and the post installation settings. Administrators can refer to System 800xA Post
Installation (3BUA000156*) to load the system extensions. Once the system
extensions are loaded ABB Smart Client ABB Program Supervision (ABB Smart
Client APS) service can be configured.
To configure ABB Smart Client APS Service perform the following:
1.
2PAA107391-510
Select the service ABB Smart Client APS Manager.
57
Figure 30. ABB Smart Client APS Manager

2.
58
Right click on the Service and click New Object. Add a new Service group
with name ABBSmartClient_G0. Click Create.
2PAA107391-510
Figure 31. Create Service Group

3.
Under the service group add a service provider. Right-click on the service
provider group and click New Object.
4.
Enter the service provider name as ABBSmartClient_G0_<node name> and

click Create.
2PAA107391-510
59
Figure 32. Create Service Provider

5.
60
Select the node from the Service Provider Definition.

This node should be the Data Provider node of Smart Client.
2PAA107391-510
Figure 33. Data Provider node from the Service Provider Definition
6.
Select Configuration tab to restart the service. Deselect Enable and click
Apply. Again, select Enable and click Apply.
Check that the Program Supervision Manager of Smart Client Data Provider Node
is started.
2PAA107391-510
61
62
2PAA107391-510
Section 5 Configuration
Configuration Tools
The following are the configuration tools available in the Smart Client product.
These configuration tools are executed in the Smart Client Server.
Object Type Configuration Tool
Date Format Configuration Tool
User Configuration Tool
Smart Client Database Backup and Restore

The Object Type Configuration Tool is used to define the object types to be
supported in the Smart Client application. The objects that are created in the 800xA
system, are displayed in the Property Browser of the Smart Client application.
If the objects do not belong to an object type defined in the tool, these objects will
be displayed as part of the Property Browser.
For Windows 2008, Select Object Type Configuration Tool from Start >
Programs > ABB Smart Client.
For Windows 7, Select Object Type Configuration Tool from Start > All
Programs > ABB Smart Client. The Object Type Configuration Tool dialog
appears (see Figure 34).
2PAA107391-510
63
Figure 34. Object Type Configuration Tool

Viewing the properties. Select an object from the Object Tree to view the
properties of this object in the Property Pane (see Figure 34).
64
Query - Displays the name of the query. A query is a Smart Client

property to map the 800xA object properties required to be subscribed.
Query Group - Displays the name of the query group. A query group is a
collection of control properties grouped based on the control types.
Aspect:Property - Displays the corresponding aspect name and the

property name in the 800xA system.
2PAA107391-510
Exclude - Select the check box corresponding to a property to exclude this

property from being displayed in the Property Browser.
Show All - Select this check box to display all the properties in the
Property Browser.
Creating an Object Type Group. To add an object type group:
1.
Right-click Object Types from the Object tree (see Figure 34) and select New
OR, Select New from Edit > Object Type Group.
2.
The New Object Type dialog is displayed (see Figure 35).

Enter a name for the object type group and click OK.
Figure 35. New Object Type Group

Creating an Object Type. To add an object type:
1.
Right-click an object type group from the Object tree (see Figure 34) and select
New from the context menu.
OR, Select New from Edit > Object Type.
2.
Enter a name for the object type and click OK (see Figure 36).
The name of the object type should be the same as the name of the object type in
the 800xA System.
2PAA107391-510
65
Figure 36. New Object Type

Example. The following example describes how to define a property for an object
using a Function Block.
1.
In the Object Type Configuration Tool, select an object from the object tree
to view the properties.
2.
In the Aspect:Property, the user can map an 800xA aspect property to the
corresponding property in the Object Type Configuration Tool.
The properties of the objects can be viewed in the Smart Client Property
Browser and the user can subscribe to these properties.
Only the properties for which the Smart Client queries are mapped will be
displayed without filtering. Remove the filtering from the other properties to
view all properties.
66
2PAA107391-510
Figure 37. Object Type Configuration Tool - Mapping properties for the Object Type
2PAA107391-510
67
Figure 38. Object Type in the Plant Explorer

3.
Select File > Save to save the changes.
GuidCorrect Tool
GuidCorrect tool is a tool used to find and fix the broken references in the already
saved .pxl files. These .pxl files that are used in this tool are files saved with Trends
in Smart Client panel.
Broken References. After saving any .pxl file by using object logs from 800xA, if
a specific object is deleted from the structure and added to a different parent in the
68
2PAA107391-510
same/different structure then the Object Id will change to that specific Object. In
addition, if the same .pxl file is loaded, it will not find the already saved object Id
resulting in Trend not displayed.
.pxl file will always save with object Id in ItemName, which used for updating the
controls, and Object path in ItemDisplayName, which will be used for displaying
the Object Name.
GuidCorrect tool functionality. GuidCorrect tool finds the broken references as
follows:
1.
GuidCorrect tool takes .pxl file as input.
2.
Finds out the corresponding object path present in the file.
3.
Gets the object Id of the object path.
4.
Updates the .pxl file if both are mismatching.
Following are the steps to use Correct Guid Tool:

1.
2PAA107391-510
Open CorrectGuidTool.exe from <Install folder>/ABB Industrial IT/Operate

IT/ABB Smart Client/Bin. GuidCorrect tool appears. (see Figure 39)
69
Figure 39. GuidCorrect Tool

2.
Provide Smart Client Server details in the textboxes provided and click on the
Connect button to connect to the server.
3.
Click on the Browse *pxl file(s)... button to provide a directory.
4.
Click on the Resolve button to resolve the broken references in all panels in the
selected directory and in all sub directories.
The .pxl file is updated with correct GUID, if the Tool finds any broken reference.
Clear button clears the status information.

The Date Format Configuration Tool is used to define the date and time format used
in the Smart Client application.
70
2PAA107391-510
The date and time formats are used in Graphic Presentation controls such as LCD
Panels and DateTime controls. The user can specify the required date and time
formats in these controls.
Select Date Format Configuration Tool from Start > All Programs > ABB
Smart Client. The Date Format Configuration Tool dialog appears (see
Figure 40).
Figure 40. Date Format Configuration Tool

Setting the date and time format. To set the date and time format:
1.
2PAA107391-510
Right-click a format in the Name column (see Figure 40) and select Modify
from the context menu. The Time/Date Format dialog appears (see
Figure 41).
71
Figure 41. Modify the date/time format

2.
In Value, select or enter a date value and click Add.
3.
Click OK to save the changes in the cxl file.
4.
Select File > Save in the Date Format Configuration Tool dialog (see
Figure 40) to save the cxl file.

The User Configuration Tool is used only on the Smart Client Server Node. The
System Administrator uses this tool to create the users and assign them to the
respective user groups (for example, Admin, and Design), for accessing the Smart
Client Desktop with different access rights.
By default, the user groups Admin and Designer are available in the User
Configuration Tool.
Admin - The users belonging to this group can view, modify, and delete panels
and workplaces used in the Smart Client application. They can also modify the
configuration of other users, for example, assigning the default workplaces or
panels.
Designer - The users belonging to this group can design panels and workplaces
that are private to the users. They do not have rights to modify the
configuration of panels or workplaces of other users.
This tool is also used to create configuration templates. Configuration template is

the default configuration of the Smart Client Desktop application, for example, the
height, width, and background color of the workplace and panels.
72
2PAA107391-510
Select User Configuration Tool from Start > All Programs > ABB Smart Client.
The User Configuration Tool dialog appears (see Figure 42).
Figure 42. User Configuration Tool

Adding a User Group. To add a user group:
1.
Right-click the Groups tree (see Figure 42) and select Create New Group
OR, Drag and drop
2.
into the Groups tree.
The Create Group dialog appears.
Figure 43. Create Group
2PAA107391-510
73
Enter a name for the user group and click OK. The group name appears in the
Groups tree.
Adding a User. To add a user:
1.
Right-click the Users tree (see Figure 42) and select Create New User from
the context menu.
OR, Drag and drop
2.
into the Users tree.
The Create User dialog appears.
Figure 44. Create User

Enter a name for the user.
3.
Select the Create private directory check box to add a private directory for
the workplaces and panels created for this user.
A directory with the user name will be created in <SCInstallerDir>/ FILES/
PRIVATE. Only this user will have the read and write access rights to this
directory. The other users cannot modify the workplaces or panels in this
directory.
4.
Click OK to create this user. The user name appears in the Users tree.
Assigning Users to a User Group. Execute one of the following to assign users to
a user group:
74
1.
Drag and drop the users from the Users tree to a user group in the Groups tree.
2.
Right-click a user in the Users tree and select Add to Group from the context
menu.
2PAA107391-510
Figure 45. Adding a User to a User Group from the Users tree
3.
Right-click a user group in the Groups tree and select Include User from the
context menu.
Figure 46. Adding a User to a User Group from the Groups tree
Adding a Configuration Template. To add a configuration template:
1.
Right-click the Configuration Templates tree (see Figure 42) and select
Create New Configuration Template from the context menu.
OR, Drag and drop
2.
2PAA107391-510
into the Configuration Templates tree.
The Create Configuration Template dialog appears.
75
Figure 47. Create Configuration Template

3.
Enter a name for the configuration template and click OK. The configuration
template appears in the Configuration Templates tree.
Editing a Configuration Template. To modify a configuration template:
76
1.
Right-click a template in the Configuration Templates tree.
2.
Select Edit from the context menu. The Edit Configuration Template appears
(see Figure 48).
2PAA107391-510
Figure 48. Edit Configuration Template

All the Property Groups of these templates have a property "Group is user
configurable". If "True" is selected for this property, the corresponding property
group will be available to the user to modify/configure.
Those that are not configurable are listed as the tool tip.
For example: URL links can be used to launch external web applications such as
maintenance system or instructions from the Smart Client Desktop. The external
2PAA107391-510
77
application will be launched in Internet Explorer in a Smart Client popup panel.

Up to 5 URL links can be defined. The URL links are available in the context
menu when right clicking an object value in Smart Client Desktop graphics or
800xA graphics.
To configure an URL link the property Caption<n> is set to the text that shall appear
in the context menu. The corresponding URL<n> property is set to the URL string.
<n> is the URL link number 1 to 5.
For example:
Caption1 "WebLink"
URL1 "www.abb.com
The URL link can also include variables to make the string context sensitive.
For example:
To launch a maintenance system and automatically bring up the page for an
object.
Caption1 "Maintenance"
URL1 "www.maintenance.com?object=$objectname"
$objectname will be substituted by the object right clicked when the web page is
launched, for example "http://www.maintenance.com?object=930FI001"
Two variables $objectname and $externalid can be used in the URL Link.
$objectname - the 800xA object name of the object right clicked.
$externalid - an external id configured on the 800xA object right clicked. External
id can be used in the case the id in the external system does not match the 800xA
object name.
Create and edit a SmartClient Properties aspect in the 800xA system to specify an
external id. The SmartClient Properties aspect is added to the corresponding object
in 800xA. The aspect has one property ExternalId. The property value is set to the
78
2PAA107391-510
string that the variable $externalid shall be substituted with when the URL is
launched.
Custom Script or web reference from a calculated value are not supported in the
URL Link.
If using $objectname the 800xA object names must exactly match the key in the
external system else use $externalid. Set the value of the external Id to be the key
in the external system.
Assigning a Configuration Template to a User. Execute one of the following to
assign a configuration template to a user:

1.
Drag and drop the users from the Users tree to a configuration template in the
Configuration Templates tree.
2.
Right-click a user in the Users tree and select Set Configuration Template
3.
Right-click a configuration template in the Configuration Templates tree and

select Assign to User from the context menu.
Removing a User, User Group, or a Configuration Template. Execute one of the

following to delete a user, a user group, or a configuration template:
1.
Right-click the user (from the Users tree), the user group (from the Groups
tree), or the configuration template (from the Configuration Templates tree)
and select Delete from the context menu.
2.
Drag and drop a user (from the Users tree), the user group (from the Groups
tree), or the configuration template (from the Configuration Templates tree)
into the
icon.
Replicating Windows Users. Execute the following steps to replicate windows
users:
1.
Launch the Smart Client User Configuration Tool from Windows program
menu, Start > Programs > ABB Smart Client > User Configuration Tool.
2.
Click Replicate to display the following window.
2PAA107391-510
79
Figure 49. Users Replication window

3.
Select Windows in Replicate users from section. A Windows Replicate will

only replicate from the local PC user definition or the domain, the PC belongs
to, if it is joined to a domain.
For Workgroup Environment:
Smart Client application accepts User Workgroup Logon Name.
For Domain Environment:
Smart Client application accepts the User Logon Name. Since the Domain
Environment provides User Logon Name and User Logon Name (Pre-Windows
2000), it is preferred that the User Logon Name and the Pre-Windows 2000
Logon Name be the same.
80
4.
Select whether you wish to keep existing users and groups even if they are not
present in the replicate source (Keep) or to delete them (Dont Keep).
5.
Click OK. The Select Users or Groups window appears.
2PAA107391-510
Figure 50. Select Users or Groups

6.
Enter the name of the user or group you want to add to the Enter the object
names to select.
7.
Click OK to complete the replication process.
800xA Graphics Home Display Configuration. Execute the following steps to
configure the home display for 800xA Graphics:

1.
Launch the Smart Client User Configuration Tool from Windows program
menu, Start > Programs > ABB Smart Client > User Configuration Tool.
2.
Open Edit Configuration Template. Edit Configuration Template appears.
2PAA107391-510
81
Figure 51. Edit Configuration Template - PG2 Properties

3.
82
Edit PG2 Related properties group.

Caption: This caption will be used to display as a context menu item in
800xA Graphics of Smart Client.
PG2 Data Provider: Provider name (<System
Name>800XAPG2GRAPHICS)
Home Display: Path of the PG2 Graphics Display ([Structure Name]
Root/path1/path2./PG2DisplayName).
To extract/view the path of the Graphic Display right-click on the structure
2PAA107391-510
Special Character Rules
aspect of the object in Plant Explorer and select Details in the Description
field in the first tab. Path will be visible in the Description text field.
Administrator can configure up to two Home displays.
Special Character Rules

The following characters are considered special characters.
The search wildcard character asterisk (*).
Item path separators forward slash character (/) and dot character (.).
Aspect separator colon character (:).
Log separator comma (,).
Structure separator left and right square brackets ([) and (]).
GUID separator left and right curly brackets ({) and (}).
Backslash (\).
Underscore (_).
Rule 1
The special characters forward slash (/), dot (.), comma (,) colon (:), left and right
square and curly brackets ([), (]), ({) and (}), and underscore (_) can be part of
object, aspect and property names, with the exception of rule 2, 3 and 4 below. In
Smart Client OPC item paths must always use a backslash (\).
Also use a backslash (\) within a name with a backslash (\).
Example:
[Control Structure]Area/Programs:1/Object\55:ControlConnection:Value.Min
must in a Smart Client OPC item path be use as
[Control Structure]Area/Programs\:1/Object\\55:ControlConnection:Value.Min
Rule 2
Never use an asterisk character (*) in object, aspect or property names. The result is
unpredictable.
Rule 3
Special characters can not appear last in an intermediate node name in an OPC item
path, even if used with a backslash.
2PAA107391-510
83
Example:
[Control Structure]Area/Programs\[1\]/Object:Control Connection:Value is illegal
because the right square bracket (]) is last in the intermediate node name.
Rule 4
The backslash (\) character may not appear in aspect names.
Example:
[Control Structure]Area/Programs/Object:My\\Aspect:Value is illegal because there
is a backslash (\) in the aspect name

A command line executable is used to perform the backup and restore of the Smart
Client application.
Backup Files. The following backup files are generated based on the Smart Client
Node Type (that is, Smart Client Server or Smart Client Data Provider):
Registry settings - <backup path>\ <node name>yyyy-mm-dd_hh-mm\

SmartClientRegistrySettings.reg
Smart Client Configuration - <backup path>\ <node name>yyyy-mmdd_hh:mm\ SmartClientConfiguration.zip
Smart Client Database Tables - <backup path>\ <node name>yyyy-mmdd_hh-mm\ SmartClientTables.dmp
The <backup path> is selected from the command line tool of the Smart Client
Backup Tool. The directory <node name> yyyy-mm-dd_hh-mm is created while
starting the backup.
To copy the backup to an external media, copy the directory <node name>yyyy-mmdd_hh-mm.
Backup Command Line Tool

The Backup Command Line Tool performs the backup and is scheduled to execute
using the Task Scheduler in Start > Settings > Control Panel > Administrative
Tools. The program name is PpcUtBackup.
84
2PAA107391-510
Restore Command Line Tool
Table 4. Command Line Arguments - Backup

Modifier
/?
Description
To show the usage (Optional).
PpcUtBackup [/?] /d=Destination Path /r=InstallOptions
[/t=TraceLevel]

The Restore Command Line Tool performs the restore. The program name is
PpcUtRestore.
Perform the following before a restore operation:
Install the Smart Client application.
Stop the Smart Client 800xA services.
Take a backup of the Smart Client applications using the PpcUtBackup

program (see Backup Command Line Tool on page 84).
Table 5. Command Line Arguments - Restore
Modifier
/?
Description
To show the usage (Optional).
PpcUtRestore [/?] /d=Destination Path /r=InstallOptions
[/t=TraceLevel]
2PAA107391-510
85
86
2PAA107391-510
Section 6 System Upgrade

This section describes the procedure to upgrade the Smart Client application version
2.1 to version 2.2 on different Smart Client nodes as required.
Upgrade Smart Client v2.1 to v2.2

To upgrade the Smart Client application perform the following steps:
1.
Copy Workplace and Panel files from <<Installation Directory>>\ABB

cpmPlus Smart Client\SC\ Files\Public to <<Backup Directory>>\SC\WPFiles
2.
Copy Configuration files from <<Installation Directory>>\ABB cpmPlus

Smart Client\SC\Config to <<Backup Directory>>\SC\ConfigFiles
3.
Un-install Smart Client 2.1.
4.
Go to Internet Information Server and remove SC directory.
5.
Install Smart Client 2.2.
6.
Replace Configuration and Workplace file in the respective folder

(<<Installation Directory>>\ABB Smart Client\SC\Config and <<Installation
Directory>>\ABB Smart Client\SC\Files\Public) from the location <<Backup
Directory>>\SC
2PAA107391-510
87
Upgrade Smart Client v2.1 to v2.2
88
Section 6 System Upgrade
2PAA107391-510
Appendix A Data Providers

Communication Port
The following communication ports for a firewall to connect to the Smart Client
Server need to be open:
80 for the Web Server
19131 for real time data to the Smart Client Desktop
Alarm and Event (EVT800xA)

Installed on the Smart Client Data Provider node, this data provider provides an
interface to the Smart Client 800xA event database.
Program Name
PpcDpAlarmEvent.exe
Default Startup Command

-server <IP address of the Smart Client Server Noder> -port 19131 -name <system
name>SGEVT alivetimeout 90
Command Line Arguments

Table 6. Com mand Line Arguments
Parameter
2PAA107391-510
Value
89
Other Parameters
Table 6. Com (Continued)mand Line Arguments

server
IP address of the Smart Client Server Node.

Default, if argument is omitted is, localhost.
Argument is set to localhost when Smart Client is
installed.
port
IP port used to connect to COM service provider.

Default, if argument is omitted is, 19131.
Argument is set to 19131 when Smart Client is installed.
name
Name of the data provider.

Argument is set to <system name>SGEVT on the Smart
Client Server Node when Smart Client is installed.
alivetimeout
Interval for alive timeout messages.

Engineering unit is seconds.
Default if argument is omitted is 30.
trace
Trace level for messages.

Argument is not included when Smart Client is installed.
Other Parameters
Table 7. Other Parameters
90
Parameter
Value
Description
Alarm and event data provider
Startup
Automatic
Delay before starting program
100 ms
Delay after starting program
100 ms
Priority
Normal
2PAA107391-510
ActiveX Data Object (ADO)

Affinity
Termination
Send quit message and wait for 10 seconds
Restart option
If the program terminate restart
Before restarting wait
30000 ms
Max restarts
1000
On max restarts
Change status to Can't Start
Reset restart count after
ActiveX Data Object (ADO)

The ADO data provideris installed on the Smart Client Data Provider node. It
facilitates for a Smart Client Desktop to read and write data to and from a relational
database such as Oracle using the ActiveX Data Object (ADO) interface. One Smart
Client data provider node is also assigned as the common data base node for Smart
Client common tables. Another copy of the ADO data provider is installed on this
node.
Program Name
PpcDpADO.exe.

name>SGADOdoublesupport -dbtype generic reconnint 20 reconntmo 60
alivetimeout 30
2PAA107391-510
91

Table 8. Command Line Arguments
Parameter
Value
server

Argument is set to localhost when Smart Client is installed.
port

name

Argument is set to <system name>SGADO on the Smart Client
Data Provider Node when Smart Client is installed.
A second ADO data provider with this argument set to
ADOCOMMON is installed on the Smart Client Data Provider
Node selected as common data base node when Smart Client
is installed.
doublesupport
Supports double data type.

Default, if argument is omitted is, single data type only.
Argument is included when Smart Client is installed.
dbtype
Type of connection.
Argument is set to generic when Smart Client is installed.
reconnit
Reconnect interval.
reconntmo
Reconnect timeout.
92
2PAA107391-510
Other Configuration Parameters
Table 8. (Continued)Command Line Arguments

alivetimeout

trace


Table 9. Other Configuration Parameters
Parameter
Value
Description
ADO data provider.
Startup
Automatic
60000 ms
100 ms
Priority
Normal
Affinity
Termination
Sends quit message and waits for 10 seconds
Restart option
If the program terminates, restart.
30000 ms
Max restarts
1000
On max restarts
2PAA107391-510
93
COM
COM
The COM service provider is installed on the Smart Client Server Node. COM acts
as the gateway between the other data providers and the Smart Client Desktops.
Program Name
PpcSpCOM.exe.

-server <IP address of the Smart Client Server Noder> -port 19131

Parameter
Value
server

port
IP port the COM service provider listens to.

trace


Parameter
94
Value
2PAA107391-510
Distributed Data Repository (DDR)

Description
Smart Client service provider.
Startup
Automatic
100 ms
100 ms
Priority
Normal
Affinity
Termination
Restart option
30000 ms
Max restarts
1000
On max restarts
Distributed Data Repository (DDR)

The Distributed Data Repository data provider is installed on the Smart Client
Server Node. It transfers files between the Smart Client Server Node and the Smart
Client Desktop. An example is to read panel files.
Program Name
PpcDpDDR.exe.

-server <IP address of the Smart Client Server Noder>port 19131-name DDR
security high -transferroot -alivetimeout 30
2PAA107391-510
95

Parameter
Value
server

Default if argument is omitted is localhost.
port

name

Argument is set to DDR on the Smart Client Server Node when
Smart Client is installed.
transferroot
Root directory of Smart Client.

The Smart Client root directory is specified as -transferroot
<path>.
<path> is the root path for Smart Client files.
Path can be:
#1. An empty specification. e.g. transferroot or transferroot
.
The root is default directory from SC_HOME environment
variable appended by SC. By default this is c:\ Program
Files\ABB Industrial IT\ Operate IT\ ABB Smart Client \SC.
#2. Pointing to a directory
e.g. -transferroot c:\ Root. The root is c:\Root.
The directory specification may not end with a backward slash
(\) character .
Default, if argument is omitted is path pointed to by
environment variable SC_HOME appended by directory SC.
Argument is included without a path specified when Smart
Client is installed.
96
2PAA107391-510

alivetimeout


Parameter
Value
Description
Distributed data repository data provider.
Startup
Automatic
100 ms
100 ms
Priority
Normal
Affinity
Termination
Restart option
30000 ms
Max restarts
1000
On max restarts
Browser (BRW800xA)
This is the data provider providing 800xA browse functionality to the Smart Client
Desktop.
2PAA107391-510
97
Program Name
Program Name
PpcDp800xABrowser.exe

name>800XABROWSER autogroupsize 100 -alivetimeout 60

Parameter
Value
server

installed.
port

name

Argument is set to <system name>800XABROWSER on
the Smart Client Data Provider Node when Smart Client is
installed.
alivetimeout

trace

98
2PAA107391-510
Other Parameters
Other Parameters
Parameter
Value
Description
800xA property browser data provider.
Startup
Automatic
100 ms
100 ms
Priority
Normal
Affinity
Termination
Restart option
30000 ms
Max restarts
1000
On max restarts
General Utilities (UTI)

The general utilities data provider is installed on both the Smart Client Server Node
and Smart Client Data Provider Node. It provides miscellaneous functions, such as
accessing a list of scheduled reports.
Program Name
PpcDpUtilities.exe.
2PAA107391-510
99

name>SGUTILITIES alivetimeout 30

Parameter
Value
server

installed.
port
IP port used to connect to COM service provider. Default if

argument is omitted is 19131.
name

Argument is set to SGUTILITIES on the Smart Client
Server Node when Smart Client is installed.
Argument is set to <system name>SGUTILITIES on the
Smart Client Data Provider Node when Smart Client is
installed.
alivetimeout

trace

100
2PAA107391-510
Other Parameters
Other Parameters
Parameter
Value
Description
Utilities data provider.
Startup
Automatic
100 ms
100 ms
Priority
Normal
Affinity
Termination
Restart option
30000 ms
Max restarts
1000
On max restarts
PPA
This is the Smart Client 800xA graphics browser data provider.
Program Name
PpcDp800xAGraphics.exe

name>SGPPA alivetimeout 30
2PAA107391-510
101

Parameter
Value
server

installed.
port

name

Argument is set to <system name>800XAGRAPHICS on
the Smart Client Data Provider Node when Smart Client is
installed.
alivetimeout

trace

Other Parameters
Parameter
Value
Description
PPA interface data provider.
Startup
Automatic
102
2PAA107391-510
Search (SEA800xA)

100 ms
100 ms
Priority
Normal
Affinity
Termination
Restart option
30000 ms
Max restarts
1000
On max restarts
Search (SEA800xA)
This data provider implements the search functionality of the Smart Client Desktop
Property Browser.
Program Name
PpcDp800xASearch.exe

name>800XASEARCH --blobpath -alivetimeout 60

Parameter
2PAA107391-510
Value
103
Other Parameters

server

installed.
port

name

Argument is set to <system name>800XASEARCH on the
Smart Client Server Node when Smart Client is installed.
alivetimeout

trace

Other Parameters
Parameter
Value
Description
Property Browser data provider.
Startup
Automatic
100 ms
100 ms
Priority
Normal
104
2PAA107391-510
OPC DA (OPCDA800xA)

Affinity
Termination
Restart option
30000 ms
Max restarts
1000
On max restarts
OPC DA (OPCDA800xA)
Installed on the Smart Client Data Provider (800xA) node, the OPC DA data
provider sets up subscriptions to the 800xA OPC server on behalf of the Smart
Client Desktop.
Program Name
PpcDpOpc.exe

When installed on an 800xA system:
name>800XAOPCDA opcdaserverhost localhost opcprogid
abb.afwopcdasurrogate.1 -noitemvalidation -datasource cached blobpath fastupdaterate 3000 cachesize 100000 cachedec 10 alivetimeout 30
2PAA107391-510
105

Parameter
Value
server

installed.
port

Name

Argument is set to <system name>800XAOPCDA when
Smart Client is installed on an 800xA Data Provider Node.
Opcdaserverhost
Host of the OPC DA server.

installed. For a remote OPC server, it will be the name of
the remote server.
Opcprogid
Prog id of OPC DA server.

Argument is set to abb.afwopcdasurrogate.1 when Smart
Client is installed on an 800xA Data Provider Node.
allow_object_write
Allow OPC DA object write.

Default if argument is omitted is OPC DA write is not
allowed.
noitemvalidation
Items are not validated if in blob file.

Argument is included when Smart Client is installed.
106
2PAA107391-510

datasource
The type of OPC read.

Can be set to cached or device.
Default if this argument is omitted, is device.
If omitted or blank, then by default data provider will read
the OPC values from Device OPCDatasource.
If set to Device, then data provider will read the OPC
values from Device OPCDatasource.
If set to Cache, then data provider will read the OPC
values from Cache OPCDatasource.
blobpath
Path for blob file.

The blob file stores a snap shot of the OPC DA
subscriptions. The snap shot is loaded when the data
provider starts up.
-blobpath <path>
<path> is the root path where to store the blob files.
Path can be:
#1. an empty specification
e.g. blobpath blobpath
Save the blob files using default directory from SC_HOME
environment variable. By default this is c:\ Program
Files\ABB Industrial IT\ Operate IT\ Smart Client
\Blob\<data provider name>\opcblob.bin.
#2. pointing to a directory
e.g. -blobpath c:\ Blobfiles
The blob files are saved under the specified root
c:\Blobfiles\<data provider name>\opcblob.bin.
The directory specification may not end with a backward
slash (\) character Default is path pointed to by
environment variable SC_HOME.
Argument is included without a path specified when Smart
Client is installed.
2PAA107391-510
107

fastupdaterate
OPC group update rate

Engineering unit is milliseconds.
Default if this argument is omitted is 1000 milliseconds.
cachesize
Number of cached OPC objects.

Default if argument is omitted is 100,000.
cachedec
Cache decrement.
Number of percent of total cache size the cache is
decremented to when full.
alivetimeout

trace

108
2PAA107391-510
Other Parameters
Other Parameters
Parameter
Value
Description
OPC DA data provider
Startup
Automatic
100 ms
100 ms
Priority
Normal
Affinity
Termination
Restart option
30000 ms
Max restarts
1000
On max restarts
OPC HDA (OPCHDA800xA)

Installed on the Smart Client Data Provider node (800xA), OPC HDA sets up
subscriptions to the 800xA OPC HDA server on behalf of a Smart Client Desktop.
Program Name
PpcDpOPCHDA.exe

name>800xAOPCHDA opchdaserverhost localhost opcprogid
abb.advhthistoryhdlr.1 alive timeout 30
2PAA107391-510
109

Parameter
Value
server
IP address of the Smart Client Server Node. Default if argument

is omitted is localhost.
port

name

Argument is set to <system name>800XAOPCHDA when Smart
Client is installed on an 800xA Data Provider Node.
opchdaserverhost
Host of the OPC HDA server.

opcprogid
Prog id of OPC HDA server.

Argument is set to abb.advhthistoryhdlr.1 when Smart Client is
installed on an 800xA Data Provider Node.
alivetimeout
Interval for alive timeout messages

opctype

110
2PAA107391-510
Other Parameters
Other Parameters
Parameter
Value
Description
OPC HDA data provider.
Startup
Automatic
100 ms
100 ms
Priority
Normal
Affinity
Termination
Restart option
30000 ms
Max restarts
1000
On max restarts
2PAA107391-510
111
Other Parameters
112
2PAA107391-510
ABB AB
Control Systems
Vsters, Sweden
Phone: +46 (0) 21 32 50 00
Fax:
+46 (0) 21 13 78 45
E-Mail: processautomation@se.abb.com
www.abb.com/controlsystems
Copyright 2003-2011 by ABB.

All Rights Reserved
ABB Inc.
Control Systems
Wickliffe, Ohio, USA
Phone: +1 440 585 8500
Fax:
+1 440 585 8756
E-Mail: industrialitsolutions@us.abb.com
ABB Industry Pte Ltd

Control Systems
Singapore
Phone: +65 6776 5711
Fax:
+65 6778 0222
E-Mail: processautomation@sg.abb.com
ABB Automation GmbH

Control Systems
Mannheim, Germany
Phone: +49 1805 26 67 76
Fax:
+49 1805 77 63 29
E-Mail: marketing.control-products@de.abb.com
www.abb.de/controlsystems
Power and productivity

for a better world
TM
2PAA107391-510
Contact us

2PAA107391-510 A en Smart Client For 800xa 5.1 Installation and Configuration PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

2PAA107391-510 A en Smart Client For 800xa 5.1 Installation and Configuration PDF

Uploaded by

Copyright:

Available Formats

Smart Client for 800xA

Installation & Configuration

Power and productivity

Smart Client for 800xA

Copyright 2003-2011 by ABB.

Section 2 - Smart Client Excel Interface Installation

Section 3 - Smart Client Installation

Section 4 - Post Installation

Configuring the Event Services....................................................................................... 50

Section 6 - System Upgrade

Appendix A - Data Providers

Command Line Arguments ..................................................................................94

Search (SEA800xA) ......................................................................................................103

OPC HDA (OPCHDA800xA)....................................................................................... 109

About This User Manual

User Manual Conventions

Warning, Caution, Information, and Tip Icons

About This User Manual

About This User Manual

Released User Manuals and Release Notes

Released User Manuals and Release Notes

Published to ABB SolutionsBank when a User Manual or Release Note is

Released User Manuals and Release Notes

About This User Manual

Smart Client Data Provider - The Smart Client Data Provider is an

Figure 1 shows the architecture of the Smart Client application.

Figure 1. System Layout

Valid Combination for Node Type Installation

Valid Combination for Node Type Installation

Smart Client Aspect Node

Smart Client Data Provider Node

Smart Client Server Node

Section 2 Smart Client Excel Interface

Microsoft Office 2007 Suite with SP2 Installed.

Microsoft Excel 2010 must be installed.

Adobe Reader 5.0 or above.

Patch Installation Order (for the All Users Installation Option)

Windows Installer (This is available by default in Windows 7 Operating

.NET Framework 3.5 SP1 (This is available by default in Windows 7 Operating

Installing the Smart Client Excel Interface

Section 2 Smart Client Excel Interface Installation

Primary Interop Assemblies 2007

Installing the Smart Client Excel Interface

Click Install to install the prerequisites.

Section 2 Smart Client Excel Interface Installation

Installing the Smart Client Excel Interface

Figure 3. Welcome window

Figure 4. Ready to Install window

Installing the Smart Client Excel Interface

Section 2 Smart Client Excel Interface Installation

Click Install to begin the installation.

Figure 5. Select Installation Folder

Click Next to continue the installation. The Confirm Installation wizard

Section 2 Smart Client Excel Interface Installation

Installing the Smart Client Excel Interface

Figure 6. Confirm Installation

Click Next to proceed with the installation.

Installing the Smart Client Excel Interface

Section 2 Smart Client Excel Interface Installation

Figure 7. Installation Complete

Section 3 Smart Client Installation

To be Installed in Smart Client Nodes

Smart Client Server