Documente Academic
Documente Profesional
Documente Cultură
Version 3.5
October 2010
All rights reserved. No part of this publication may be reproduced in any form or by any electronic or mechanical
means, including photocopying and recording, without permission in writing from GE Intelligent Platforms, Inc..
Trademarks
2010 GE Intelligent Platforms, Inc. All rights reserved. * Trademark of GE Intelligent Platforms, Inc. All other
brands or names are property of their respective holders. Any other trademarks referenced herein are used solely for
purposes of identifying compatibility with the products of GE Intelligent Platforms, Inc.
Notice
GE Intelligent Platforms, Inc. reserves the right to make improvements to the products described in this publication at
any time and without notice. We want to hear from you. If you have any comments, questions, or suggestions about our
documentation, send them to the following email address:
doc@ge.com
Table Of Contents
Introduction ........................................................................................................................ 1
What's New in Proficy Real-Time Information Portal 3.5 ............................................. 3
Proficy Real-Time Information Portal Editions ............................................................. 7
Proficy Real-Time Information Portal Connectors ...................................................... 11
Drivers .......................................................................................................................... 12
Proficy Portal Licensing ............................................................................................... 13
Using Existing Licensing ............................................................................................. 15
Proficy Portal License Consumption ............................................................................ 21
Contact GE Intelligent Platforms ................................................................................. 22
Installing ........................................................................................................................... 25
System Requirements ................................................................................................... 25
Connector Requirements .......................................................................................... 26
Client Requirements ................................................................................................ 28
Quick Start ................................................................................................................... 30
Installing Internet Information Services (IIS) to use Proficy Portal ............................. 31
Installing Proficy Portal ............................................................................................... 33
Upgrading to Proficy Portal 3.5 ............................................................................... 36
Resolving Displays .................................................................................................. 37
Upgrading Displays, Pen Groups, Event Groups, and Symbol Files ....................... 38
Uninstalling Proficy Portal ...................................................................................... 41
Troubleshooting Proficy Portal Installation ................................................................. 42
Creating the Proficy Portal Virtual Directory .......................................................... 43
Creating the jakarta Virtual Directory ..................................................................... 44
Installing the ISAPI Filter ........................................................................................ 45
Installing the Java Plug-in ........................................................................................ 46
iii
Proficy Portal 3.5
iv
Introduction
Congratulations on your purchase of Proficy Real-Time Information Portal. This guide
covers most of the details you will need to know to get the product up and running,
including:
What's New in Proficy Portal 3.5- descriptions of the features new to the latest
version of Proficy Portal.
Proficy Real-Time Information Portal Editions - breakdown of the features
included with each edition.
Proficy Real-Time Information Portal Connectors - licensing details for
connectors.
Drivers - lists the drivers that Proficy Portal installs and configures.
Proficy Portal Licensing - licensing details.
Most businesses use tools to help their decision makers analyze sales, visualize financial
data, and make process improvements that enhance the manufacture of their products.
Analysis of business and process data is critical to knowing where to make investments
and to learning how to improve a company's performance.
Proficy Portal provides superior data analysis tools in a personalized web environment.
Using Proficy Portal and a web browser, you can make key decisions by analyzing and
visualizing data from historians, SQL relational databases, process databases, or OPC
servers. By combining and comparing historical, real time, and SQL data you can see how
the leading performance indicators for your company are progressing, allowing you to
make sound business decisions.
Learning Proficy Portal is not difficult. To complete most operations, you point and click
or drag and drop with your mouse. You never need to write a script, even for complex
operations.
Proficy Portal also integrates well into your existing intranet or web site. You can create
links between your web server and Proficy Portal displays, allowing you to create seamless
navigation between the web pages on your site and the analysis displays on the Proficy
Portal server.
You create custom displays with Proficy Portal with a wide range of commonly-used web
and analysis components including: charts, grids, trees, hyperlinks, controls, and various
1
Proficy Portal 3.5
shapes. These items provide a rich environment to render any screen element you require.
All displays reside on the server as soon as you save them. Consequently, you can work on
your analysis displays from anywhere in the world. When you are ready to make a display
available to others, you simply copy it to a pre-defined folder on the server.
Sharing your displays is easy, too, after copying them to the server:
If the recipient has access to Proficy Portal, you can send the URL of your
analysis data.
If the recipient does not have access, you can save the display as a GIF or a JPG.
To find out about the new features in this release, refer to Proficy Portal Important Product
Information.
If you want to start right away, refer to the Quick Start section.
2
Introduction
3
Proficy Portal 3.5
For more information, see the Quick Time topic in the online help.
On-demand Data Source
Proficy Portal now allows you to dynamically load or unload the data sources on demand.
This means that when there are many data sources configured, then you can set the
required data sources to load when a request comes in and unload the data source when the
data source does not receive a request within a configured time.
For more information, see the On Demand Data Source topic in the online help.
Windows Server 2003 (32-bit and 64-bit) and Windows Server 2008 (32-bit
and 64-bit) support
You can run Proficy Portal 3.5 on Windows Server 2003 (32-bit or 64-bit) and Windows
Server 2008 (32-bit and 64-bit) operating systems.
NOTE: Proficy Portal works as a 32-bit application on 64-bit Windows operating systems
using WoW64 mode (Windows-on-Windows 64-bit).
For more information, see the System Requirements topic in the online help.
Enhanced Installer
Proficy Portal 3.5 now ships the Apache 2.2.15 (httpd-2.2.15-win32-x86-no_ssl.msi) web
server along with the Proficy Portal application. If the Proficy Portal installation program
does not detect an IIS web server on your system, then Proficy Portal allows you to install
and configure the Apache 2.2.15 (httpd-2.2.15-win32-x86 no_ssl.msi) web server provided
with the Proficy Portal application.
For more information, see the Installing Proficy Portal topic in the online help.
Chart Improvements
Pen Name
Proficy Portal now allows you to edit the pen names. This means that you can now create
more meaningful pen names for the charts. If you want to change the pen name, double-
click the pen and enter the new name.
For more information, see the To create a pen group topic in the online help.
Expression Pen Names
Proficy Portal now displays the data source name as an alias (ID) when you select a data
source in the Expression Builder Data Sources Tab. This ID will appear in the Data Source
drop-down list on the Edit Expression tab. Using the Expression Pen Names, you can now
easily create the logical expression from the data.
4
Introduction
For more information, see the Expression Builder topic in the online help.
Chart Title
Proficy Portal now allows you to show the chart title that is applied to a pen group. When
you load a pen group into a chart in run-time mode, the chart title will be replaced by the
loaded pen group chart title.
For more information, see the To create a pen group topic in the online help.
Name Property
The Name property, which allows you specify the unique identifier for an object, is now
available for all the Proficy Portal objects.
List/Combo Box Improvements
Apply on Refresh
A new check box, Apply on Refresh, is available on the List/Combo box: General Tab that
is used to indicate whether to use the auto select first entry on refresh option.
For more information, see the Combo/List Box General Tab topic in the online help.
Historian Connector Improvements
Timeout Value
Proficy Portal now provides a time-out limit for the Historian connector to read or write
requests. If the connector fails to return data within the time-out limit, the server displays a
Connection Timeout message.
You can also specify the maximum time interval the Historian connector waits for a read
or write request.
New Installation Folders
On new installs, the default installation folder reflects the new Proficy name:
C:\Program Files\Proficy\Proficy Portal\
On a 64-bit Windows Operating System:
The default destination folder on a 64-bit Windows Operating System is C:\Program
Files(x 86)\Proficy\Proficy Portal\ directory.
When you are upgrading Portal 3.0 SP1 or earlier and if you did not remove the Proficy
Portal directory, then Proficy Portal 3.5 installs to the previous install folder (for example,
C:\Program Files\GE Fanuc\Proficy Portal\
5
Proficy Portal 3.5
If you have uninstalled a previous version of Proficy Portal and did not remove the Proficy
Portal directory, ensure you direct the new Portal to the previous install folder (for
example, C:\Program Files\GE Fanuc\Proficy Portal\ ) so that the Portal install program
will find the existing Displays, Pen Groups, Event Groups, and Symbol Files.
For more information, refer to the Upgrading to Proficy Portal 3.5 topic in the online help.
Help Improvements
Proficy Portal 3.5 now provides video tutorials for the Portal 3.5 related features. To view
the video tutorials, you must install the latest version of Adobe Flash Player.
6
Introduction
When you purchase a Proficy Portal license you can also select which edition and which
options you want to buy. Proficy Portal comes in two editions: Historian and Enterprise.
The following chart is a feature comparison of Historian and Enterprise editions.
Time Charts
Event Charts
Datalinks
VariableLinks
XY charts
21 CFR 11
Time-based scrolling
Symbols
7
Proficy Portal 3.5
Calculations and
expressions
Natural Presentation
Grids
Hyperlinks
Text object
Time/Date link
Personalized settings
Role-based security
Content Hosting
WebSources
8
Introduction
Web Controls
Buttons
Natural printing
Drill-down analysis
Portlet support
Hierarchical Trees
Drop-down lists
List boxes
Text boxes
Statement Builder
Pie charts
Bar Charts
Line Charts
Shapes
9
Proficy Portal 3.5
Correlation charts
Shape Animation
10
Introduction
The following types of connectors are available for configuration with Proficy Portal
Historian Edition:
1. Real Time
o FIX for connection to Proficy HMI/SCADA - iFIX
o CIMPLICITY HMI for connection to Proficy HMI/SCADA
CIMPLICITY
o OPC
2. Alarms for connection to Proficy HMI/SCADA - iFIX ODBC alarm service
3. Historical
o CIMPLICITY HMI Logger for connection to Proficy HMI/SCADA -
CIMPLICITY Logger
o iHistorian for connection to Proficy Historian
o OSI PI requires that a license key is purchased
All the Historian connectors and the following are available for configuration with Proficy
Portal Enterprise Edition:
VisualSPC for connection to Proficy ShopFloor SPC
SQL (DB2, Oracle, SQL and ADO/ODBC support) a license must be purchased
for each type of database connection
Plant Database for connection to Proficy Plant Applications Plant Database.
11
Proficy Portal 3.5
Drivers
12
Introduction
2 2
5 5
10 10
25 25
13
Proficy Portal 3.5
50 50
100 100
NOTE: For support of architectures with more than 100 clients, please contact GE
Intelligent Platforms directly.
IMPORTANT: ONLY valid when connecting to iHistorian 1.0 servers each Historian
server has a license for a specific number of client connections. Each Proficy Portal
server uses one of these connections regardless of the number of browser sessions in
progress. Consequently, it is possible to purchase a 50-client Historian license and a 100-
session Proficy Portal license. This configuration leaves 49-client connections for
Historian users and one connection for the Proficy Portal server.
You can quickly determine the maximum number of licenses in the Proficy Portal
Administration application. Launch Proficy Portal and load the Administration
Application. Select Settings & Diagnostics and click on Key Licensing in the tree. You
will be presented with the following information:
JDBC Driver the number of JDBC driver categories purchased. Refer to JDBC
Categories Drivers for more information.
Licensed Users the amount of user licenses purchased for your installation.
14
Introduction
Read Only if the Proficy Portal server is set to read-only. If it is, your users
will not be able to write data to the server.
1. Power off the computer and all peripheral devices before installing the hardware
key; it is sensitive to static electricity.
2. Remove any connections to your computer's parallel port.
3. Secure the hardware key in the parallel port and tighten the screws.
IMPORTANT: Do not remove the hardware key from your node while Proficy
Portal is running. If you do, Proficy Portal features will shut down and you will
need to restart Proficy Portal. You may also damage the hardware key if you
remove it while Proficy Portal is running.
4. If you had any equipment connected to your parallel port, reconnect to the back of
the hardware key.
15
Proficy Portal 3.5
NOTE: GE Intelligent Platforms supports the installation of the USB hardware key only
on systems running Windows 2000 Server, Windows 2000 Advanced Server, Windows
Server 2003, or Windows Server 2008.
At this time, GE Intelligent Platforms does not support USB keys connected through an
external USB hub.
1. Insert your USB hardware key in the appropriate port.
2. A message box, similar to the following figure, appears as the hardware key
installs:
3. After the hardware installation and licensing is complete, you may run Proficy
Portal as your license permits.
Upgrading Licensing
If you buy additional options for your existing M1 hardware key, you will receive an email
with an update .ilicense file.
NOTE: Contact your sales representative for information about obtaining the license file.
16
Introduction
First, check to see that your hardware key is firmly attached. Next, uninstall and reinstall
the driver for the hardware key. If this driver has been incorrectly installed, it may behave
unpredictably.
You can also use the KeyDiag utility to find out if the hardware key is installed. Run this
utility and if 'No license available' appears in the License Style box (Licensing Info tab),
your hardware key is either not installed properly or is defective. For more information on
running KeyDiag, see KeyDiag Utility.
17
Proficy Portal 3.5
18
Introduction
When you receive the hardware key, you must return the old one along with a
copy of the form sent with the new hardware key. GE Intelligent Platforms
reserves the right to invoice you for defective hardware keys that are not returned.
KeyDiag Utility
KeyDiag is a diagnostic tool that provides technical personnel with information about your
Proficy Portal hardware key. This utility is for use with M1 keys only. If you are using M4
keys, use the M4 License Viewer.
To access KeyDiag
iClientTS Whether the key is enabled for Terminal Server, and, if so, the
maximum number of concurrent Terminal Server connections allowed.
19
Proficy Portal 3.5
OEM If the ROC driver is enabled, the number of ROC licenses, and any
OEM options you may have purchased from other manufacturers that
are enabled on the hardware key.
License Display All enabled settings and other information at a particular date and time.
You have the option to save this information to a file.
The light at the end of the USB hardware key indicates that the key and the software are
communicating. If this light is off, it would indicate a problem with the key.
Yes. The USB key is automatically detected when moved to another USB port.
20
Introduction
Proficy Portal provides the ability to run multiple browsers on the same client machine, all
running instances of Proficy Portal. It also provides the ability to run multiple instances of
the Portal client in another application, such as Proficy iFIX. In previous versions of
Proficy Portal, each browser instance and each client instance consumed a license. Proficy
Portal now allows multiple browser or client instances to run while consuming only one
license.
License accounting uses the IP address of the client machine. This allows any number of
clients to run on the same client machine without consuming more than one license. When
logging into or out of Proficy Portal, a list of IP addresses that are connected to the Portal
server is accessed and the number of instances from each is determined. The list contains
one entry per IP address.
License accounting for IP addresses is determined as follows:
On login:
If an entry already exists for the IP address, the instance count is incremented but
no additional license is consumed.
If an entry does not exist for the IP address, it is created, the instance count is set
to 1, and a license is consumed.
On logout:
If the instance count is greater than 1, the instance count is decremented by 1 for
each instance that logs out.
If the instance count is 1, then the entry is removed altogether and the license is
released.
21
Proficy Portal 3.5
Technical Support
If you have technical problems that cannot be resolved with the information in this guide,
please contact us by telephone or e-mail, or on the web at www.ge-ip.com/support.
Americas
22
Introduction
Asia Pacific
23
Installing
This section is designed to help you install and start using Proficy Portal. The following
information is provided:
System Requirements - server and client hardware/software requirements, as well
as connectivity requirements.
Quick Start - a procedure that describes what you need to get started quickly.
Installing Proficy Portal - installation instructions.
Troubleshooting Proficy Portal Installation - instructions for troubleshooting the
Proficy Portal installation.
System Requirements
The hardware and software requirements for Proficy Portal Server are as follows:
25
Proficy Portal 3.5
Connector Requirements
To ensure the best performance and problem-free use of the Proficy Portal connectors, it is
recommended that the data source application is run with the most recent Service Packs,
26
Starting and Configuring
Connector Requirements
Alarms iFIX - the local iFIX iClient install should be updated with the
most recent iFIX General SIM. The SCADA nodes in the
iClient remote nodes list should also have the most recent
SIM.
27
Proficy Portal 3.5
Client Requirements
28
Starting and Configuring
Java Run-time Java Run-time plug-in v6.0 update 22 on both Windows 32-bit
plug in and Windows 64-bit operating systems.
When you install Proficy Portal on the server computer, you are
asked if you want the Java plug-in runtime to install
automatically if the Java Run-time plug-in v6.0 update 22 is not
found. If installing third-party software conflicts with your
company's policy, you can choose not to have the plug-in install
automatically, but rather display a message of your own
directing the users where to the get the proper Java plug-in
runtime. Refer to Installing the Java Plug-in the Installing the
Java Plug-in section for more information.
NOTE: Other software that runs on the same machine as the
Proficy Portal client may run a different version of the Java
Run-time plug-in. Multiple versions of the Java Run-time plug-
in can be run in different browser sessions. However, if you
attempt to run multiple versions in the same browser session,
the attempt will fail.
29
Proficy Portal 3.5
Quick Start
Before you can start using Proficy Portal, you must complete the following tasks:
1. Install the hardware key. For more information, refer to the Proficy Common
Licensing help, which by default can be found at: [C:\Program
Files\Proficy\Proficy Common\M4 Common Licensing.
2. Install Proficy Portal on a web server using IIS 6.0, 7.0, or 7.5, or on an Apache
server using Apache version 2.0.52 or greater. Refer to Installing Proficy Portal
the Installing Proficy Portal section for more information.
IMPORTANT: If you have installed IIS 6.0 or greater, allow the Proficy Portal
installation to automatically enable Active Server Pages (ASP) or enable ASP
manually. Without this enabled, the Proficy Portal client will not start. For more
information, see Installing Proficy Portal the Installing Proficy Portal section.
If you are upgrading from a previous version of Proficy Portal, refer to the Upgrading to
Proficy Portal 3.5 section instead.
3. Configure any Historian server, relational databases, OPC server, or iFIX
SCADA servers you want Proficy Portal to communicate with.
NOTE: If you want to connect to iFIX or FIX SCADA systems, then you must also
install the iFIX client.
4. If you want to communicate with a relational database, configure the JDBC driver
you need. Refer to JDBC Drivers the JDBC Drivers section for more information.
5. Configure the Proficy Portal server with the Administration application. Refer to
Configuring the Proficy Portal Server and Data Sources the Configuring the
Proficy Portal Server section in this guide and the Data Sources section in the
online help (type 'Data Sources' into the online help Index) for more information.
30
Starting and Configuring
31
Proficy Portal 3.5
32
Starting and Configuring
If you are upgrading from a previous version of Proficy Portal, refer to Upgrading to
Proficy Portal 3.5 section.
Installing Proficy Portal using Microsoft Internet Information Services (IIS)
as a web server:
Before you start using Proficy Portal, you must set up and configure your web server. The
Proficy Portal application requires Microsoft Internet Information Services (IIS) web
server version 6.0, 7.0, or 7.5 on Windows Server 2003, Windows Server 2008, or
Windows Server 2008 R2. Refer to Installing Internet Information Services for more
information.
You can install Proficy Portal as follows:
1. Log onto your web server using an account that has administrator rights.
2. Install IIS on your web server, if you have not already done so.
NOTE: You must install IIS prior to the Proficy Portal installation.
3. Insert the Proficy Portal CD into your CD-ROM drive. The installation program
automatically starts. If the installation does not automatically start, browse the
CD in your CD-ROM drive and double-click the setup.exe file.
4. Follow the instructions on the screen.
During the installation, you will be asked if you want to install the sample system.
The sample system consists of sample displays that demonstrate many of Proficy
Portal's features. If you are new to Proficy Portal, it is recommended that you
install the sample system.
33
Proficy Portal 3.5
You will be prompted to enter a name for the virtual directory. The virtual
directory name is part of the web address for the application. For example, if you
accept the default virtual directory name ProficyPortal, then the URL that is used
to access Proficy Portal is: http://HostServerName/ProficyPortal/Default.asp.
5. You will also be asked if you want the Java plug-in runtime to install
automatically if the Java run-time plug-in v6.0 update 22 is not found on the
client. If installing third-party software conflicts with your company's policy, you
can choose not to have the plug-in install automatically, but rather display a
message of your own directing the users where to get the proper Java plug-in
runtime.
6. If you have installed IIS 6.0 or greater, Proficy Portal detects whether the ASP
(Active Server Pages) option is enabled. If it is not enabled you are asked if you
want the ASP option enabled for you. If you click Yes, the ASP option is
automatically set to Allowed. If you click No, the installation continues; however,
you must then manually set the ASP option to Allowed in the Internet
Information Services (IIS) Manager control panel.
IMPORTANT: If you do not enable the ASP option, the Proficy Portal client will
not start.
7. Restart the computer when prompted. If you are not prompted to restart, start the
Proficy Portal server by choosing Start Proficy Portal Server from the Proficy
Portal program group in the Start menu.
Installing Proficy Portal using Apache as a web server:
Proficy Portal 3.5 ships the Apache 2.2.15 (httpd-2.2.15-win32-x86-no_ssl.msi) web
server along with the Proficy Portal application. If the Proficy Portal installation program
does not detect an IIS web server on your system, then Proficy Portal prompts you to
install and configure the Apache 2.2.15 (httpd-2.2.15-win32-x86 no_ssl.msi) web server
provided with the Proficy Portal application.
NOTE: If you have any version of Apache Web Server installed, you must remove it before
installing Proficy Portal 3.5.
1. Log onto your web server using an account that has administrator rights.
2. Insert the Proficy Portal CD into your CD-ROM drive. The installation program
automatically starts. If the installation does not automatically start, browse the
34
Starting and Configuring
2. A virtual directory for the ISAPI filter named jakarta is created, used to redirect
requests to the Apache Software Foundation's Java servlet engine.
3. The ISAPI filter is installed to the jakarta directory.
NOTE: If you want to install Proficy Portal to a non-default web site, after Proficy Portal
35
Proficy Portal 3.5
installation is complete and the machine has rebooted, stop the Proficy Portal server and
create the Proficy Portal and jakarta virtual directories, and install the ISAPI filter. See
the topics Creating the Proficy Portal Virtual Directory, Creating the jakarta Virtual
Directory, and Installing the ISAPI Filter. See the sections: Creating the Proficy Portal
Virtual Directory, Creating the jakarta Virtual Directory, and Installing the ISAPI Filter in
the Troubleshooting section of this guide.
The default installation folder will now reflect the new Proficy name. By default, Proficy
Portal 3.5 installs to:
C:\Program Files\Proficy\ProficyPortal\
On a 64-bit Windows Operating System:
The default destination folder on a 64-bit Windows Operating System is C:\Program
Files(x 86)\Proficy\Proficy Portal\ directory.
Proficy Portal work as a 32-bit application on 64-bit Windows operating systems using
36
Starting and Configuring
NOTE: Before upgrading, it is recommended that you back up (make a copy of) your
working directories.
1. Log onto your web server using an account that has administrator rights.
2. Insert the Proficy Portal CD into your CD-ROM drive. The installation program
automatically starts.
3. Ensure that the Upgrade option is selected.
4. Follow the instructions on the screen and restart the computer when prompted.
5. After restarting your computer, or if you are not prompted to restart, select Start
Proficy Portal Server from the Proficy Portal program group in the Windows
Start menu to start the Proficy Portal server.
Resolving Displays
Resolve displays is a feature that is used to load and save displays automatically. The
feature was originally provided to help infoAgent 1.1 users to bring forward Beta version
displays into the release version. In Proficy Portal 3.5, the function of the resolve displays
wizard is not changed. In general, resolving a display updates the display to work with the
latest build. In contrast, running the upgrade brings forward the user files from an older
version of the product to the current version of the product. For more information on
upgrading, see the Upgrading to Proficy Portal 3.5 section.
1. Ensure that the Proficy Real-Time Information Portal server is running.
2. Start Proficy Portal.
37
Proficy Portal 3.5
38
Starting and Configuring
There is a separate step in the wizard for displays, pen groups, event groups, and
symbols. You can choose to upgrade one or any combination of these files. For
example, you can upgrade displays and symbols only. If you are upgrading from
version 1.x, the first Upgrade Wizard utility will not have the symbols upgrade
option.
2. For each step, click the Browse button to locate the files, select the files you want
upgraded, and click either the Next or Upgrade button. If you click the Next
button, it means you want to go on to the next step to do further upgrading. If you
choose Upgrade, the remaining steps are skipped and the upgrade is performed.
NOTE: If you have images in your displays, the Upgrade Wizard utility will
39
Proficy Portal 3.5
When the upgrade has completed, the Upgrade Results window appears. On the
Upgrade Results window, you will see the results of the conversion process. If
there were problems, you will be prompted to look at the UpgradeError.log file.
This file is located at: YourInstallDir\webapps\infoAgentSrv\Upgrade (where
YourInstallDir is the location that you have chosen to install Proficy Portal, for
example: C:\Program Files\Proficy\Proficy Portal).
3. Click the Close button to exit the Upgrade Wizard utility.
When you select displays, pen groups, event groups, or symbol files to be upgraded, if the
directory structure they are selected from matches your Proficy Portal 3.5 directory, the
files are copied to the same location in the Proficy Portal 3.5 directory. If the directory
structure of the display, pen group, or event group files does not match the directory
structure of your Proficy Portal installation, the files are copied into the following
directories:
YourInstallDir\webapps\infoAgentSrv\AllUsers\displays
YourInstallDir\webapps\infoAgentSrv\AllUsers\pengroups
YourInstallDir\webapps\infoAgentSrv\AllUsers\eventgroups
YourInstallDir\webapps\infoAgentSrv\AllUsers\symbols
If you are upgrading a display that has the same name as an existing 3.5 display, the
existing 3.5 display is overwritten by the previous version's display; however, a copy of
the current 3.5 display is placed in the Upgrade\backup directory.
40
Starting and Configuring
Portal 3.5. If the name already exists in 3.5, it will be overwritten. Before the existing
named time is overwritten, the RelativeTimes.xml file is copied to
\Upgrade\backup1.1\maps\time.
For more information on named times, see Named Times the Named Times topic in the
online help (type 'Named Times' in the online help Search).
41
Proficy Portal 3.5
NOTE: You can install Proficy Portal in the Default Web Site or in another web site of
your choice.
When you install Proficy Portal, the following steps are completed:
1. A virtual directory named ProficyPortal is created for the Proficy Portal web
application.
2. A virtual directory for the ISAPI filter named jakarta is created, used to redirect
requests to the Apache Software Foundation's Java servlet engine.
3. The ISAPI filter is installed to the jakarta directory.
4. IIS is restarted.
If any of these steps fail, you may see the following error when logging into Proficy
Portal:
The page cannot be found
Make sure the latest Windows updates are installed and try to log in again. If the problem
persists, you can complete the previous steps manually using the instructions in these
sections that follow:
Creating the Proficy Portal Virtual Directory
Creating the jakarta Virtual Directory
Installing the ISAPI Filter
42
Starting and Configuring
To create the virtual directory for the Proficy Portal web application:
1. Run the Internet Services Manager. The Internet Services Manager is a
Windows control panel applet. Refer to your Windows online help for
instructions on how to access this control panel applet.
2. Open the system tree for the computer and locate the entry Default Web Site.
or
Locate the web site of your choice.
3. Expand the Default Web Site entry and locate the Proficy Portal virtual directory
within it. If you cannot locate the directory, right-click the Default Web Site text.
or
Right-click the web site you chose in step 2, and choose New. The New menu
appears.
4. Choose Virtual Directory from the New menu. The Virtual Directory Creation
Wizard appears.
5. Follow the instructions on the wizard to create the virtual directory. When
prompted, enter the following information:
Alias ProficyPortal
Directory YourInstallDir\webapps\infoAgentSrv
where YourInstallDir is the location where you have
chosen to install Proficy Portal, for example:
C:\Program Files\Proficy\Proficy Portal.
43
Proficy Portal 3.5
Access Permissions Leave the Read option selected and clear all other
check boxes.
IMPORTANT: When you create the virtual directories in a web site of your choice (rather
than the default web site), the virtual directories (i.e., ProficyPortal, jakarta, and the
ISAPI filter) must be removed from the default web site, and you must restart IIS and the
Proficy Portal server.
44
Starting and Configuring
6. Follow the instructions on the wizard to create the virtual directory. When
prompted, enter the following information:
Alias jakarta
Directory YourInstallDir\bin\i386\win32
where YourInstallDir is the location where you have
chosen to install Proficy Portal, for example:
C:\Program Files\Proficy\Proficy Portal.
By default, the ISAPI filter should be created in Internet Information Services when you
install Proficy Portal. If it is not, perform the following:
NOTE: If you installed Proficy Portal in a web site other than the Default Web Site, follow
the alternate instructions for steps 2 through 9.
45
Proficy Portal 3.5
or
Right-click the web site you chose in step 2.
A context menu appears.
4. Choose Properties from the context menu. The Default Web Site Properties
dialog box (or the Properties dialog box of the web site you chose in step 2)
appears.
5. Select the ISAPI Filters tab and click the Add button. The Filter Properties
dialog box appears.
6. Enter jakarta in the Filter Name box.
7. Enter YourInstallDir\bin\i386\win32\isapi_redirect.dll in the Executable box.
8. Click OK to close the Filter Properties dialog box and return to the Default (or
chosen) Web Site Properties dialog box.
9. Click OK to accept your changes and close the Default (or chosen) Web Site
Properties dialog box. The Internet Services Manager installs the ISAPI filter.
10. Restart IIS.
11. Restart the Proficy Portal server.
When you install Proficy Portal on the server computer, you are asked if you want the Java
plugin runtime to install automatically if the Java run-time plug-in v6.0 update 22 is not
found. If installing third-party software conflicts with your company's policy, you can
choose not to have the plugin install automatically, but rather display a message of your
own directing the users where to the get the proper Java plugin runtime.
In some cases, you may be required to install the Java plug-in manually. The plug-in can
be found in the Proficy Portal install directory at: <InstallDir>\Proficy\Proficy
Portal\webapps\infoAgentSrv\plugin.
Refer to the Proficy Portal IPI (Important Product Information) Release Notes tab for
information on the Java plug-in version that is required, where to download it from, as
well as troubleshooting/diagnostic information.
IMPORTANT: You must be a member of either the Power Users or Administrators
46
Starting and Configuring
Windows security groups to successfully install the Java plug-in. To find out what security
groups you are a member of, access Users and Passwords from the Windows Start menu |
Settings | Control Panel. Refer to your Windows online help for information on how to
access and use this control panel.
47
Proficy Portal 3.5
Logging into Proficy Portal - refer to this section if you are logging into Proficy
Portal as a client.
Using Proficy Portal Documentation - refer to this section for information about
the Proficy Portal documentation.
IMPORTANT: It is not recommended to use any other Apache versions other than 2.2.15
(httpd-2.2.15-win32-x86-no_ssl.msi).
In some cases if you want to use any other version of Apache other than 2.2.15 (httpd-
2.2.15-win32-x86-no_ssl.msi), then you have the option to install and configure other
versions of Apache. For more information about installing and configuring other versions
of Apache, refer to Configuring Proficy Portal on Apache section.
In some cases if you want to use any other versions of Apache other than 2.2.15 (httpd-
2.2.15-win32-x86-no_ssl.msi), then you have the option to install and configure other
versions of Apache.
48
Starting and Configuring
NOTE: If you have any version of Apache Web Server installed, you must remove it
before installing Proficy Portal 3.5.
1. Insert the Proficy Portal CD into your CD-ROM drive. The installation program
automatically starts. If the installation does not automatically start, browse the
CD in your CD-ROM drive and double-click the setup.exe file.
2. During the installation, you will be prompted to install the Apache as the web
server. Click YES.
3. Follow the instructions on the screen.
4. Restart the computer when prompted.
5. Uninstall Apache 2.2.15 which is installed along with Proficy Portal 3.5
application.
6. Install the required version of Apache.
After installing required version of Apache, then you must complete the following steps:
The minimum required version of Apache is 2.0.52. For additional system requirements,
refer to System Requirements the System Requirements section.
Proficy Portal installs the following files to support Apache:
mod_jk.conf
mod_jk_1.2.6_2.0.50.dll
49
Proficy Portal 3.5
IMPORTANT: If you are using Apache 2.02.39 or later, then you must download the
latest binaries and copy the binaries to the Apache modules (by default, C:\Program
Files\Apache Group\Apache). For more information on the latest binaries and supported
versions, refer to http://www.apache.org/dist/tomcat/tomcat-
connectors/jk/binaries/win32/jk-1.2.28/
NOTE: The following instructions assume that Proficy Portal has been installed to the
default location: C:\Program Files\Proficy\Proficy Portal. It is also assumed that Apache
has been installed to the location: C:\Program Files\Apache Group\Apache. If these
installation locations are different, you must modify this procedure accordingly.
1. If IIS is running on the server machine, ensure that it is either disabled or moved
to another port (e.g., port 90). See Resolving Port Conflicts the Resolving Port
Conflicts section for more information.
2. Stop the Proficy Portal server.
3. Stop the Apache server.
4. Locate the httpd.conf file in the following location:
C:\Program Files\Apache Group\Apache2\conf
5. Open the Apache httpd.conf file in Notepad, scroll to the end of the file, and
insert the following at the end on a blank line:
Include "C:/Program Files/Proficy/Proficy Portal/conf/mod_jk.conf"
50
Starting and Configuring
After you install Proficy Portal, restart your computer. By restarting the Proficy Portal
server, you ensure the Java servlet engine starts correctly.
NOTE: You can also start the Java servlet engine manually after you install Proficy
Portal. To start the servlet engine, select Start Proficy Portal Server from the Proficy
Portal program group.
When the servlet engine is running, configure the Proficy Portal server by launching the
Proficy Portal client (Windows Start menu | All Programs | Proficy Portal 3.5 | Start
Proficy Real-Time Information Portal Server). When you select this menu item, the
browser launches, loads a web page, and runs the Java plug-in.
To simplify the setup and configuration of the Java plug-in, when you install Proficy
Portal on the server computer, you are asked if you want the Java plugin runtime to install
automatically if the Java run-time plug-in v6.0 update 22 is not found. If installing third-
party software conflicts with your company's policy, you can choose not to have the plugin
install automatically, but rather display a message of your own directing the users where to
the get the proper Java plugin runtime. Refer to Installing the Java Plug-in the Installing
the Java Plug-in section for more information.
Security is disabled by default. To log in, enter any name; you do not need a password or
51
Proficy Portal 3.5
domain name.
In the Proficy Portal application, select the Admin App button from the main toolbar
. The Administration application loads in the same browser window.
You are now able to set up security and add data sources. For more information about the
Administration application, refer to The Administration Application and Connectors and
Data Sources The Administration Application and Connectors and Data Sources sections
in the online help (open these books in the online help's Table of Contents).
52
Starting and Configuring
To start a Proficy Portal client, start your web browser and enter the URL:
http://<servername>/ProficyPortal, where <servername> is the address of your Proficy
Portal server. If you are unsure of the server name contact your system administrator.
NOTE: If SSL (security) is being used, you can enter "https" rather than "http" in the
URL. Contact your system administrator if you do not know which protocol to use.
When you install Proficy Portal on the server computer, you are asked if you want the Java
plugin runtime to install automatically if the Java run-time plug-in v6.0 update 22 is not
found. If installing third-party software conflicts with your company's policy, you can
choose not to have the plugin install automatically, but rather display a message of your
own directing the users where to the get the proper Java plugin runtime. The Java plug-in
is required on the client computer in order to view analysis displays. Refer to Installing the
Java Plug-in the Installing the Java Plug-in section for more information.
After the plug-in is installed, Proficy Portal prompts you for permission to run a Java
applet. This applet provides access to all Proficy Portal analysis displays. Select the Yes or
Always button in response to the prompt:
More Details displays information about the applet and its provider.
Yes grants access to the applet for this browser session only. The next time the
applet runs it will prompt you again.
No denies access to the applet and closes Proficy Portal.
Always grants access to the applet and does not prompt you again for
permission to run the Java applet.
After you respond to the applet prompt, Proficy Portal prompts you to log in. You can log
in by entering a login name, a password, and domain name/workgroup. See Logging into
Proficy Portal the Logging into Proficy Portal section for more information. If security is
disabled, you can enter any login name to start using Proficy Portal.
If Proficy Portal security is disabled, make sure you always use the same login name. This
ensures your analysis displays will always be saved to the same location in the system tree.
By default, Proficy Portal saves all your work in a folder that matches your login name.
Consequently, if you log in as jsmith, JohnSmith, and JohnS, you could have displays
53
Proficy Portal 3.5
54
Starting and Configuring
55
Proficy Portal 3.5
</init-param>
3. Set the param-value to "false" as shown below:
<<init-param>
<param-name>UseRMI</param-name>
<param-value>false</param-value>
</init-param>
NOTE: If you want to configure RMI as a connection method, then set the param-
value to "true".
4. Save and close the web.xml file.
5. Restart the Proficy Portal Server.
Proficy Portal now uses HTTP as a connection method to connect to the Proficy
Portal Server.
Note:
Portal 3.5 uses RMI as the default connection method. If RMI connection fails,
then you must manually configure HTTP as a connection method.
IMPORTANT: It is recommended that you purchase a server certificate and install it within IIS or
Apache and use HTTPS as your communication protocol.
56
Starting and Configuring
57
Proficy Portal 3.5
On the server machine, you can log into Proficy Portal by choosing Proficy Portal
from the Proficy Portal 3.5 program group (click the Start menu | Programs |
Proficy Portal 3.5 | Proficy Real-Time Information Portal).
2. When prompted, enter your login name and password.
If security is disabled, you can log in with any user name (no password is
required). If security is enabled, contact your system administrator to obtain your
login information.
58
Starting and Configuring
NOTE: Do not use the following special characters in the User Name field: \, @, *, ?, /,
<, >.
3. Click Login.
NOTE: If you receive a message that states `You are not authorized to view this page', and
you are connecting to the Internet via a local area network (LAN), make sure your web
browser is set to bypass the proxy server for local addresses. See your browser's online
help documentation for more information.
NOTE: If you are prompted to log into Proficy Portal twice (and the second time you are
granted access), check that the server's computer name does not contain any special
characters. Special characters include any characters other than a-z, 0-9, and hyphen. If
the host computer name does contain special characters, change the name to valid
characters. However, be aware that renaming the host computer name can cause some
applications to stop working. For example, if you run an SQL server on a machine and
change its name, you may have to re-run the SQL setup from the installation CD.
What you can do in Proficy Portal depends on your security settings. For example, you
may have permissions to access the run-time environment only. If you need to make
changes to a display, you must have access to the configuration environment. For more
information on environments, see Using Proficy Portal Environments refer to the online
help topic Using Proficy Portal Environments (type 'Proficy Portal environments' in the
online help Search feature). For more information on the Proficy Portal sample system, see
Using the Sample System refer to the Using the Sample System section.
59
Proficy Portal 3.5
60
Using the Sample System
The Proficy Portal sample system demonstrates many of the features and capabilities of
Proficy Portal. You can use the sample system as a learning tool to generate ideas about
the types of displays you can create. While using the sample system, if you find a display
that works well in your own application, feel free to use it. Many of the sample analysis
displays were designed to be flexible for this purpose.
61
Proficy Portal 3.5
To use real time data, the iFIX Sample System must be running on the Proficy Portal
server. Real time data is used in the Enterprise edition 'Graphics' sample displays and in
the Historian edition 'TimeBasedTrending' sample display.
It is recommended that the sample system is run in non-Demo mode to ensure it does not
time out. In the event the iFIX Sample System times out, stop the Proficy Portal server and
then restart the iFIX server.
To use the Historian Edition sample displays, the SampleSystem_iHistorian data source in
the Administration application should be changed to have a valid server name, username,
and password. In addition, the Historian archive should have at least one hour of data and
should include Simulation tags 00001 through 00010 and Simulation string tags 00001
though 00005. These tags must be created with no prefix added to the tag names. For more
information on adding/making changes to data sources in Proficy Portal, see Adding an
iHistorian Data Source refer to the Adding a iHistorian Data Source in the online help
(type 'Historian' in the online help's Index feature).
62
Using the Sample System
Toolbar
Display window
63
Proficy Portal 3.5
Using hyperlinks in the Display window as shown in the following picture, you
can navigate through the sample displays by clicking hyperlinks in the Display
window.
64
Using the Sample System
For example, if you click the Historian Edition hyperlink, you will see the
following window:
65
Proficy Portal 3.5
From this window, you can click on the Time Based Trending or Event Based
Trending hyperlinks to open the sample displays.
66
Using the Sample System
tree and choose Properties. Make the changes in the Properties dialog box. For more
information on web links, see Creating a Web Link the Creating a Web Link topic in the
online help (type 'web links' in the online help's Index feature).
Required Changes:
In the following hyperlinks, replace the localhost in the URL string with the server name,
add the port number if it is not port 80, and replace ProficyPortal with the virtual directory
name (if it is different):
NOTE: The port number is appended to the server name. For example, if your port number
is 90: http://YourServerName:90/ProficyPortal/...
In the SampleSystemHome display: Proficy Portal Tour and Sample System
Help.
In the EnterpriseEdition display: Proficy Portal Tour and Sample System Help.
In the HistorianEdition display: Proficy Portal Tour and Sample System Help.
In the EnterpriseEdition/Quality/Shaft12334/Home display: Inspection Method
Sheet.
In the following web links, replace the localhost in the URL string with the server name,
add the port number if it is not port 80, and replace ProficyPortal with the virtual directory
name (if it is different):
In EnterpriseEdition/PlantApplications: DownTimeReport and Machine Times.
In ProductTour: TechnicalProductPresentation.
67
Proficy Portal 3.5
To use the Sample System walk-through while navigating the Sample System, you can:
Print the Sample System walk-through. From the Sample System help, right-click
on the topic and choose Print.
or
Use the keyboard combination ALT+TAB to switch between the Proficy Portal
window and the help viewer window.
68
Frequently Asked Questions
The following will provide answers to common questions and problems:
Why does Proficy Portal time out?
How does security work?
Why do my displays run slower after converting from v1.1?
How do I access the Proficy Portal release notes?
How to I run Proficy Portal through a firewall?
69
Proficy Portal 3.5
The following instructions explain how to configure your Proficy Portal server so that it
can be accessed through a firewall. This information is intended for system administrators.
1. Forward ports 80, 1099, and an additional port in the IANA unassigned range
(see http://www.iana.org/assignments/port-numbers) to the Proficy Portal server.
The additional port will be used as the RmiOutgoingPort.
2. After forwarding the ports, change the RmiOutgoingPort in the web.xml file. The
file can be located in:
70
Frequently Asked Questions
\Proficy Portal\webapps\infoAgentSrv\WEB-INF
In the web.xml file, change the zero (0) to the port number you forwarded. In the
following example, the RmiOutgoingPort number is 33000. Actual change is
shown in red text.
Change this:
<init-param>
<param-name>UseRMI</param-name>
<param-value>true</param-value>
</init-param>
<init-param>
<param-name>RmiRegistryPort</param-name>
<param-value>1099</param-value>
</init-param>
<init-param>
<param-name>RmiOutgoingPort</param-name>
<param-value>0</param-value>
</init-param>
To this:
<init-param>
<param-name>UseRMI</param-name>
<param-value>true</param-value>
</init-param>
<init-param>
<param-name>RmiRegistryPort</param-name>
<param-value>1099</param-value>
</init-param>
71
Proficy Portal 3.5
<init-param>
<param-name>RmiOutgoingPort</param-name>
<param-value>33000</param-value>
</init-param>
72
Index
73
Proficy Portal 3.5
74