Proficy* Workflow 2.2 SP1

GE
Intelligent Platforms
Proficy
Workflow 2.2 SP1
*
GETTING STARTED GUIDE
Proficy* Workflow
Powered by Proficy SOA
G ETTING S TARTED
Version 2.2 SP1
March 2014
Disclaimer of Warranties and Liability
The information contained in this manual is believed to be accurate and reliable. However, GE Intelligent Platforms, Inc.
assumes no responsibilities for any errors, omissions or inaccuracies whatsoever. Without limiting the foregoing, GE
Intelligent Platforms, Inc. disclaims any and all warranties, expressed or implied, including the warranty of merchantability
and fitness for a particular purpose, with respect to the information contained in this manual and the equipment or software
described herein. The entire risk as to the quality and performance of such information, equipment and software, is upon the
buyer or user. GE Intelligent Platforms, Inc. shall not be liable for any damages, including special or consequential damages,
arising out of the use of such information, equipment and software, even if GE Intelligent Platforms, Inc. has been advised
in advance of the possibility of such damages. The use of the information contained in the manual and the software
described herein is subject to GE Intelligent Platforms, Inc. standard license agreement, which must be executed by the
buyer or user before the use of such information, equipment or software.
Trademark Notices
© 2014, General Electric Company. All rights reserved.
Proficy is a trademark of GE Intelligent Platforms, Inc., a wholly-owned subsidiary of General Electric Company.
* Indicates a trademark of General Electric Company and/or its subsidiaries.
All other trademarks are the property of their respective owne rs.
All other product names and marks identified throughout this book are trademarks or registered trademarks of their respective
companies. They are used throughout this book in editorial fashion only. No such use, or the use of any trade name, is
intended to convey endorsement or affiliation.
No part of this publication may be reproduced in any form, or stored in a database or retrieval system, or transmitted or
distributed in any form by any means, electronic, mechanical photocopying, recording or otherwise, without the prior written
permission of GE Intelligent Platforms. Information contained herein is subject to change 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
| TOC | 2
Contents
Getting Started..................................................................................................................................... 4
System Requirements...............................................................................................................................................................................4
Hardware Requirements.......................................................................................................................................................... 4
Software Requirements............................................................................................................................................................ 8
Pre-installation Considerations......................................................................................................................................................... 14
Architecture................................................................................................................................................................................. 14
Security Certificates.................................................................................................................................................................15
Firewall Ports...............................................................................................................................................................................17
SQL Server Backup and Restore........................................................................................................................................ 17
Multiple Servers......................................................................................................................................................................... 18
Server Clustering and Failover............................................................................................................................................18
Proficy SOA Server Performance Counters...................................................................................................................19
Proficy Host / Embeddable Proficy Host........................................................................................................................ 22
Reverse Proxy Configuration for the Web Task List..................................................................................................23
Enable Connection between Proficy Workflow and SQL Server 2012............................................................. 24
Compatibility with Other Proficy Products.................................................................................................................... 25
License Management............................................................................................................................................................. 26
Proficy Workflow Installations............................................................................................................................................................26
Install a Proficy SOA Server and Client............................................................................................................................27
Install a Legacy Proficy SOA Server and Client........................................................................................................... 30
Install a remote Proficy Workflow client........................................................................................................................ 32
Multiple Server Installation...................................................................................................................................................33
One-Click Deployment............................................................................................................................................................36
Command Line Installation.................................................................................................................................................. 37
Uninstall Proficy Workflow....................................................................................................................................................39
Server Clustering Implementation................................................................................................................................................... 39
Supported and Validated Cluster Configurations......................................................................................................39
Microsoft Failover Cluster Manager for Windows Servers.................................................................................... 42
Install Microsoft Failover Cluster Manager................................................................................................................... 42
Configure the Microsoft Failover Cluster Manager................................................................................................... 42
Configure quorum options for a cluster.........................................................................................................................43
Configure the primary Proficy SOA cluster server..................................................................................................... 43
Configure the failover Proficy SOA cluster server...................................................................................................... 44
Configure a local client for a cluster node (32-bit).................................................................................................... 44
Configure a local client for a cluster node (64-bit).................................................................................................... 45
Server Clustering and One-Click Deployment............................................................................................................. 45
Clustering Tips............................................................................................................................................................................ 45
Web Task List Deployment.................................................................................................................................................................. 46
Configure security certificates for a reverse proxy...................................................................................................46
Configure an IIS reverse proxy............................................................................................................................................46
Configure an Apache reverse proxy.................................................................................................................................48
Connect to the Web Task List..............................................................................................................................................49
Log-in Overview........................................................................................................................................................................................51
Log in to Proficy Workflow....................................................................................................................................................51
Automatically log in to Proficy Workflow.......................................................................................................................52
GE Single Sign On (SSO).......................................................................................................................................................... 52
Key Concepts............................................................................................................................................................................................. 53
The Client...................................................................................................................................................................................... 53
The Feedback Zone..................................................................................................................................................................55
Models............................................................................................................................................................................................55
Display Panel...............................................................................................................................................................................55
| TOC | 3
Security..........................................................................................................................................................................................55
Data Sources...............................................................................................................................................................................56
Forms and User Display Designer.....................................................................................................................................56
User Solutions.............................................................................................................................................................................56
Integrated Products–Workflow.......................................................................................................................................... 57
Task List Controls...................................................................................................................................................................... 57
Electronic Signatures and Audit Trails.............................................................................................................................57
Supported Regional Settings...............................................................................................................................................57
Daylight Saving Time...............................................................................................................................................................58
Special Keyboard Buttons.....................................................................................................................................................58
Help................................................................................................................................................................................................. 58
System Oversight.....................................................................................................................................................................................59
Log Files.........................................................................................................................................................................................59
System Health and Program Use...................................................................................................................................... 59
Post-installation Configuration..........................................................................................................................................................60
Configure web proxy settings for Local System account...................................................................................... 60
Running with a Standard Windows User Account.................................................................................................... 61
Configure Proficy Service Security Certificates...........................................................................................................61
Modify site configuration.......................................................................................................................................................61
Monitor system configuration and status.....................................................................................................................63
Modify the server configuration for a remote client.................................................................................................63
Modify the Microsoft Active Directory Services...........................................................................................................63
Modify the SQL server.............................................................................................................................................................64
Configure a server instance.................................................................................................................................................64
Configure product options....................................................................................................................................................65
Change architecture mode.................................................................................................................................................. 66
Remove a Proficy Host instance........................................................................................................................................ 66
Add or remove performance counters........................................................................................................................... 66
Uninstall the Proficy Host / Embeddable Proficy Host.............................................................................................67
Upgrading Proficy Workflow...............................................................................................................................................................67
Upgrade to a newer version of Proficy Workflow......................................................................................................68
Upgrade custom forms..........................................................................................................................................................68
Database Migration................................................................................................................................................................................ 69
Move a Proficy Workflow database................................................................................................................................. 69
Proficy Real-Time Information Portal..............................................................................................................................................70
Install Proficy Real-Time Information Portal.................................................................................................................70
Proficy Reporting Database................................................................................................................................................................ 71
Install the reporting database............................................................................................................................................ 71
Configure Component Services..........................................................................................................................................72
Uninstall the reporting database...................................................................................................................................... 73
Remote Desktop Session Host...........................................................................................................................................................74
Remote Desktop Services (Terminal Services).............................................................................................................74
Getting Started...........................................................................................................................................................................75
Proficy Workflow with Windows Remote Desktop Session Host Installation and Configuration
........78
Troubleshoot Your Proficy Workflow Remote Desktop Session Host Environment................................... 79
Frequently Asked Questions................................................................................................................................................ 80
ActiveX Task Controls............................................................................................................................................................................. 80
Proficy Task List Configuration........................................................................................................................................... 80
Contact Information............................................................................................................................................................................... 82
| Getting Started | 4
Getting Started
Welcome to Proficy* Workflow–Powered by Proficy SOA!
Before you begin installing our product, please take some time to review the Getting Started guide.
IMPORTANT: Please read the Important Product Information on your installation DVD for the latest information
about Proficy Workflow, including new features, system requirements, and release notes.
System Requirements
The hardware and software requirements you require to install Proficy Workflow.
Before you begin installing your Proficy Workflow software, we highly recommend that you start by clicking
Important Product Information on the installation DVD. This opens an online help file where you can read the
latest release notes and the most current information about Proficy Workflow.
Hardware Requirements
This section describes the minimum hardware required to run Proficy Workflow and all products that work with
it.
Hardware Recommendations
This section describes the recommended hardware requirements. These specifications are needed for Proficy
Workflow to perform well and are dependent upon many factors.
Since Proficy Workflow is a very flexible product with very broad capabilities, there are a variety of ways that this
product is used. The table below provides some general guidelines for hardware recommendations based on
some sizing specifications.
Project Specification
Small System
Medium System*
Large System*
Equipment Model Objects
0 – 500
500 – 2,500
2,500 +
Equipment Model
Properties
0 – 5,000
5,000 – 500,000
500,000 +
Material Definitions
0 – 1,000
1,000 – 10,000
10,000 +
Material Lots
0 – 1,000
1,000 – 5,000
5,000 +
Production Model Objects
0 – 500
500 – 1,000
1,000 +
Production Variables
0 – 5,000
5,000 – 10,000
10,000 +
Number of Workflows
0 – 100
100 – 1,000
1,000 +
Running Workflows
0 – 50
50 – 500
500 +
Concurrently Executing
Workflows**
0–5
5 – 25
25 +
Configured Events
0 – 50
50 – 500
500 +
Events Triggering per
Hour
0 – 15
15 – 100
100 +
Work Requests in System
0 – 100
100 – 1,000
1,000 +
Active Work Requests
0 – 25
25 – 500
500 +
| Getting Started | 5
Project Specification
Small System
Medium System*
Large System*
Active Clients
1 – 25
25 – 100
100 +
Recommended Server
RAM
8 GB
16 GB
32 GB
Recommended Server
CPUs
2 CPUs @ 3GHz
4 CPUs @ 3GHz
8 CPUs @ 3GHz
*Many systems do not use all of the capabilities of Proficy Workflow, so some projects may match some
specifications in the small system column with other specifications in the medium or large system column.
Choose the column that more closely matches the targeted system.
**Any running workflow that is waiting for user input in a task form can be considered paused and is considered
to be a running workflow but not an executing workflow.
Additional Factors for Hardware Recommendations
Special Application Factors
Server recommendations may need to be increased when the application uses intensive processing or
significant disk access. Examples of these scenarios include reading and parsing data files from disk, custom
logging or writing to output data files, advanced mathematics in code activities, custom service providers,
communicating with third party products, and so on.
SQL Server on the Proficy Workflow Server
The hardware recommendations above are for servers where the SQL Server is not on the Proficy Workflow
server system. If you choose to run SQL Server on the Proficy Workflow server, then you must add RAM and CPUs
to the recommended amounts.
Running on a Virtualized Machine
The hardware recommendations above are for a server that is not running in a virtualized environment. For
servers that are running in a virtualized environment such as a VMWare or Hyper-V image, the recommended
amounts must be exclusively allocated to the server image and have as much available physical resources on
the virtualization server. For example, if a server needs 8GB of RAM, then that much RAM must be allocated to
the image, and the virtualization server must have 8GB of physical RAM available for that image. If the image
runs out of physical RAM on the virtualization server, performance degrades significantly.
Running Other Applications
All the hardware recommendations are assuming that the machine is dedicated to running the Proficy Workflow
server. If you are planning to run other applications on the machine, you will need to increase the CPU and RAM
requirements appropriately to handle running these applications. This includes other GE Intelligent Platforms
applications, such as Proficy Historian, Proficy Portal, Proficy CIMPLICITY, or Proficy iFIX.
®
®
Using Windows Server 2008 R2 or Windows Server 2012 as the Operating System
®
Newer Microsoft operating systems have greater hardware requirements than older ones. Windows Server
2008 R2 and newer use significantly more memory and more CPU. For equivalent performance, add an
additional 2 GB of memory and an additional processor.
Additional Recommendations for the SQL Server Machine
For optimum performance, the databases, transaction logs, tempdb, non-clustered indexes, and backups should be installed on separate hard drives where possible. The following RAID specifications are also
recommended:
• SQL database: RAID 0+1, RAID 1 or RAID 5
• SQL transaction logs: RAID 0+1 or RAID 1, and should be a separate physical device
• SQL tempdb: RAID 0+1 or RAID 1
| Getting Started | 6
• SQL indexes: RAID 0+1 or RAID 1
• Back-ups: RAID 0 (no fault tolerance, but faster writes) or RAID 5
Additionally, the following SQL Server configuration is recommended:
•
•
•
•
Use Mixed Mode security
Exclude the database files from anti-virus scanning
Use multiple processors for every installation
Enable the default backup job or create a maintenance plan
Other Performance Considerations
The guidelines described here are not the only aspects of a system to be considered to ensure optimum
performance. Each individual system should be evaluated for other potential sources of performance issues.
Examples of other sources of problems may include, but are not limited to, the following:
• Networking throughput between Proficy Workflow server and client
• Networking throughput between Proficy Workflow server and SQL Server
• Data throughput between the Proficy Workflow server and data sources such OPC servers, Proficy Historian,
Proficy iFIX, Proficy CIMPLICITY, and Proficy Plant Applications
• The number of client instances active on a single client machine
Hardware Requirements for Single and Satellite Servers
This section describes the hardware required for your product installation.
Server Deployment
NOTE: These requirements apply whether you are installing a multiple server configuration (that is, a core server
and a Workflow server), a failover cluster, or a legacy server.
•
•
•
•
•
•
3 GHz Core™ 2 Duo processor with 8 GB RAM (minimum)
50 GB free hard disk space (minimum)
DVD-ROM drive
Network interface software for network communications, and TCP/IP network protocol
One parallel port or free direct-connect USB port
XGA or better color graphics monitor and a 100% IBM-compatible 24-bit graphics card capable of 1024x768
resolution and at least 65535 colors
• Minimum monitor support
• Two-button mouse with scroll wheel or compatible pointing device (such as a touch screen)
Hardware Requirements for Clients
This section describes the hardware required for your product installation.
Workflow Clients
•
•
•
•
•
3 GHz Core™ 2 Duo processor with 2 GB RAM (minimum)
20 GB free hard disk space (minimum)
DVD-ROM drive
Network interface software for network communications, and TCP/IP network protocol
SVGA or better color graphics monitor and a 100% IBM-compatible 24-bit graphics card capable of 1024x768
resolution and at least 65535 colors
• Two-button mouse with scroll wheel or compatible pointing device (such as a touch screen)
| Getting Started | 7
Hardware Requirements for Proficy SOA Server
This section describes the hardware required for your product installation.
Requirements for a Large System
•
•
•
•
•
4-socket 8 Core 32 GB RAM
Windows Server x64 OS
200 GB free hard disk space
Network interface software for network communications, and TCP/IP network protocol
SVGA or better color graphics monitor and a 100% IBM-compatible 24-bit graphics card capable of 1024x768
resolution and at least 65535 colors
• XGA or better color graphics monitor and a 100% IBM-compatible 24-bit graphics card capable of 1024x768
resolution and at least 65535 colors
• Two-button mouse with scroll wheel or compatible pointing device (such as a touch screen)
Hardware Requirements for User Servers
This section describes the hardware required for your product installation.
• 3 GHz Core™ 2 Duo processor with 4 to 8 GB RAM (dependent on how much activity the server is expected to
manage)
• 50 GB free hard disk space (minimum)
• DVD-ROM drive
• Network interface software for network communications, and TCP/IP network protocol
• One parallel port or free direct-connect USB port
• XGA or better color graphics monitor and a 100% IBM-compatible 24-bit graphics card capable of 1024x768
resolution and at least 65535 colors
• Minimum monitor support
• Two-button mouse with scroll wheel or compatible pointing device (such as a touch screen)
Hardware Requirements for Extension Servers
This section describes the hardware required for your product installation.
Workflow Extension Servers
•
•
•
•
•
3 GHz Core™ 2 Duo processor with 8 GB RAM (minimum)
50 GB free hard disk space (minimum)
Network interface software for network communications, and TCP/IP network protocol
One parallel port or free direct-connect USB port
XGA or better color graphics monitor and a 100% IBM-compatible 24-bit graphics card capable of 1024x768
resolution and at least 65535 colors
• Minimum monitor support
• Two-button mouse with scroll wheel or compatible pointing device (such as a touch screen)
Hardware Requirements for a Reporting Database
This section describes the hardware required for your product installation.
•
•
•
•
•
•
3 GHz Core™ 2 Duo Processor with 3 GB RAM (minimum)
50 GB free hard disk space (minimum)
DVD-ROM drive
Network interface software for network communications, and TCP/IP network protocol
One free direct-connect USB port
XGA or better color graphics monitor and a 100% IBM-compatible 24-bit graphics card capable of 1024x768
resolution and at least 65535 colors
| Getting Started | 8
• Two-button mouse with scroll wheel or compatible pointing device (such as a touch screen)
Software Requirements
This section describes the minimum software requirements for your installation, including the recommended
operating system and database.
The clocks on all Proficy Workflow servers and clients must be synchronized. This protects against certain kinds
of threats and provides accurate logging and timestamps.
NOTE: In order to communicate with remote clients, the Proficy SOA Server must be installed on a domain. If you
install the Proficy SOA Server off the domain, it can only be used for development purposes, not for production
purposes.
Server Software Requirements
This section describes the software requirements for your installation.
Installation
When using a client in remote desktop session, the selected object in the navigator is now updating with the
current display and you can change the available displays list.
The following list describes the software required to install and use Proficy Workflow and the Proficy SOA Server.
NOTE: In addition to the following material, see Architecture Considerations on page 14 for information on
options related to operation mode when installing on a 64-bit computer.
Operating System Options
One of the following operating systems:
®
®
• Microsoft Windows 7 Professional (32- or 64-bit)
®
®
• Microsoft Windows Server 2008 SP2 (32-bit only)
®
®
• Microsoft Windows Server 2008 R2 (64-bit)
NOTE: Multiple server, failover cluster, and terminal server environments are supported only on Windows
Server 2008 R2 (64-bit).
®
®
• Microsoft Windows Server 2012 Standard (64-bit)
®
®
• Microsoft Windows 8 (64-bit)
SQL Server Options
One of the following SQL Server systems:
•
•
•
•
®
Microsoft SQL Server 2012 Enterprise (32- or 64-bit)
®
Microsoft SQL Server 2012 Business Intelligence (32- or 64-bit)
®
Microsoft SQL Server 2012 Standard (32- or 64-bit)
®
Microsoft SQL Server 2012 Express (32- or 64-bit)
®
NOTE: In order for Proficy Workflow to connect to any edition of Microsoft SQL Server 2012, you must
configure SQL Server to enable the sysadmin role for the applicable login account. For more information, see
Enable Connection between Proficy Workflow and SQL Server 2012 on page 24.
®
• Microsoft SQL Server 2008 Standard, Professional, or Enterprise Edition (32- or 64-bit)
®
• Microsoft SQL Server 2008 R2
®
• Microsoft SQL Server 2008 Express
NOTE:
• The Proficy Workflow installation automatically selects the default SQL Server instance. If SQL Server 2012
and SQL Server 2008 are both installed, SQL Server 2008 may be the default instance. In this scenario, if
you want to use SQL Server 2012 instead, you must select this instance as the default as part of manually
| Getting Started | 9
configuring your SQL Server settings. For more information, see the topic corresponding to the type of
installation you will be performing.
• The SOA project is installed into this SQL Server database. SQL Server can be installed on a different computer
that is also on the domain or workgroup; however, you must ensure that network configurations allow
appropriate machine communication.
• If you are using SQL Server Express with the Proficy SOA Server, you cannot use the Reporting Database.
Other Requirements
®
• Microsoft .NET Framework 4.0 (Full Framework) with update 4.0.3 or .NET Framework 4.5
NOTE: All Proficy Workflow assemblies will be compiled in .NET Framework version 4.5 beginning with the
next major release of the software. Custom displays and applications that reference an earlier version of .NET
must change to instead reference .NET v4.5 in order to function properly from that point forward. You can
make this change now to minimize future impact.
®
• Microsoft AD LDS (Active Directory Lightweight Directory Service) or ADAM (Active Directory
Application Mode) with SP1 (available from http://www.microsoft.com/downloads/details.aspx?
familyid=9688f8b9-1034-4ef6-a3e5-2a2a57b5c8e4&displaylang=en)
NOTE:
• If you are using Windows XP, ADAM is required. If you are using Windows 7, Windows Server 2008, or
Windows Server 2012, the use of AD LDS is recommended, which can be added as Windows components/
features in the Programs applet of the Control Panel.
• For demonstration, evaluation, or pilot systems, you can use Simulated Directory mode rather than using
ADAM or AD LDS. In this mode, the system functions the same way. However, you must use ADAM or AD
LDS to run large systems that have hundreds of clients connecting simultaneously.
®
• Microsoft Silverlight™ Runtime 5.0 and the Silverlight SDK 5.0
NOTE: Silverlight is required to access and develop forms and displays in the Silverlight Designer, and to view
Silverlight forms and displays in the Global Viewer.
®
• Microsoft Excel 2007 or 2010. To use Excel 2007, you must manually install the Primary Interop Assemblies
(for Import/Export operations). These assemblies are included in the Excel 2010 installation. For more
information, see the following links:
• http://msdn.microsoft.com/en-us/library/kh3965hw.aspx
• http://www.microsoft.com/downloads/details.aspx?familyid=59DAEBAA-BED4-4282-A28CB864D8BFA513&displaylang=en
• http://technet.microsoft.com/en-us/library/cc179091.aspx
®
• Microsoft Internet Explorer 7 or greater
®
• For web-based forms, Microsoft Internet Explorer 10 or greater is required
NOTE: Internet Explorer 10 is only supported on the following operating systems:
•
•
•
•
®
Windows 7 SP1
®
Windows 8
®
Windows Server 2008 R2 with SP1
®
Windows Server 2012
Other Supported Software
• VMWare Server or VMWare ESX Server
NOTE: VMWare servers are supported to use any of the supported operating systems.
IMPORTANT: Advanced features of ESX Server (that is, VMotion, VMWare VMFS, and Clustering support) are
not supported.
• Hyper-V virtualization system for x86-64 systems
• Remote Desktop Session Host (Terminal Services)
| Getting Started | 10
• Proficy Portal 3.0 with SP1 (included on the installation DVD) or greater
• Java Run-time plug-in v6.0 or greater (to view Proficy Portal displays)
• Proficy Historian 3.5 or greater
Workflow and User Extension Servers Software Requirements
This section describes the software requirements for your installation.
Workflow and user extension servers have the same software requirements as a main server installation.
Operating System Options
One of the following operating systems:
®
®
• Microsoft Windows 7 Professional (32- or 64-bit)
®
®
• Microsoft Windows Server 2008 SP2 (32-bit only)
®
®
• Microsoft Windows Server 2008 R2 (64-bit)
NOTE: Multiple server, failover cluster, and terminal server environments are supported only on Windows
Server 2008 R2 (64-bit).
®
®
• Microsoft Windows Server 2012 Standard (64-bit)
®
®
• Microsoft Windows 8 (64-bit)
SQL Server Options
One of the following SQL Server systems:
NOTE: The SOA project is installed into this SQL Server database. SQL Server can be installed on a different
computer that is also on the domain or workgroup; however, you must ensure that network configurations allow
appropriate machine communication.
•
•
•
•
®
Microsoft SQL Server 2012 Enterprise (32- or 64-bit)
®
Microsoft SQL Server 2012 Business Intelligence (32- or 64-bit)
®
Microsoft SQL Server 2012 Standard (32- or 64-bit)
®
Microsoft SQL Server 2012 Express (32- or 64-bit)
®
NOTE: In order for Proficy Workflow to connect to any edition of Microsoft SQL Server 2012, you must
configure SQL Server to enable the sysadmin role for the applicable login account. For more information, see
Enable Connection between Proficy Workflow and SQL Server 2012 on page 24.
®
• Microsoft SQL Server 2008 Standard, Professional, or Enterprise Edition (32- or 64-bit)
®
• Microsoft SQL Server 2008 R2
®
• Microsoft SQL Server 2008 Express
NOTE: If you are using SQL Server Express with the Proficy SOA Server, you cannot use the Reporting
Database.
The Proficy Workflow installation automatically selects the default SQL Server instance. If SQL Server 2012 and
SQL Server 2008 are both installed, SQL Server 2008 may be the default instance. In this scenario, if you want
to use SQL Server 2012 instead, you must select this instance as the default as part of manually configuring
your SQL Server settings. For more information, see the topic corresponding to the type of installation you will be
performing.
Other Requirements
®
• Microsoft .NET Framework 4.0 (Full Framework) with update 4.0.3 or .NET Framework 4.5
NOTE: All Proficy Workflow assemblies will be compiled in .NET Framework version 4.5 beginning with the
next major release of the software. Custom displays and applications that reference an earlier version of .NET
must change to instead reference .NET v4.5 in order to function properly from that point forward. You can
make this change now to minimize future impact.
| Getting Started | 11
®
• Microsoft AD LDS (Active Directory Lightweight Directory Service) or ADAM (Active Directory
Application Mode) with SP1 (available from http://www.microsoft.com/downloads/details.aspx?
familyid=9688f8b9-1034-4ef6-a3e5-2a2a57b5c8e4&displaylang=en)
NOTE:
• If you are using Windows XP, ADAM is required. If you are using Windows 7, Windows Server 2008, or
Windows Server 2012, the use of AD LDS is recommended, which can be added as Windows components/
features in the Programs applet of the Control Panel.
• For demonstration, evaluation, or pilot systems, you can use Simulated Directory mode rather than using
ADAM or AD LDS. In this mode, the system functions the same way. However, you must use ADAM or AD
LDS to run large systems that have hundreds of clients connecting simultaneously.
®
• Microsoft Silverlight™ Runtime 5.0 and the Silverlight SDK 5.0
NOTE: Silverlight is required to access and develop forms and displays in the Silverlight Designer, and to view
Silverlight forms and displays in the Global Viewer.
®
• Microsoft Excel 2007 or 2010. To use Excel 2007, you must manually install the Primary Interop Assemblies
(for Import/Export operations). These assemblies are included in the Excel 2010 installation. For more
information, see the following links:
• http://msdn.microsoft.com/en-us/library/kh3965hw.aspx
• http://www.microsoft.com/downloads/details.aspx?familyid=59DAEBAA-BED4-4282-A28CB864D8BFA513&displaylang=en
• http://technet.microsoft.com/en-us/library/cc179091.aspx
®
• Microsoft Internet Explorer 7 or greater
®
• For web-based forms, Microsoft Internet Explorer 10 or greater is required
NOTE: Internet Explorer 10 is only supported on the following operating systems:
•
•
•
•
®
Windows 7 SP1
®
Windows 8
®
Windows Server 2008 R2 with SP1
®
Windows Server 2012
Client-only Software Requirements
This section describes the software requirements for your installation.
Installation
A client-only machine contains only the Proficy Workflow client application and must connect to another
machine that has the Proficy SOA Server installed.
NOTE: If you have a client-only installation, it must be the same version as the server it is connected to.
• One of the following operating systems:
•
•
•
•
®
®
Microsoft Windows 7 Professional (32- or 64-bit)
®
®
Microsoft Windows Server 2008 R2 (64-bit)
®
®
Microsoft Windows Server 2008 SP2 (32-bit only)
®
®
Microsoft Windows XP Professional SP2 or greater (32-bit only)
®
NOTE: Support for installing and running the Proficy Workflow on Microsoft Windows XP will be
discontinued beginning with the next major release of the software.
®
®
• Microsoft Windows Server 2012 Standard (64-bit)
®
®
• Microsoft Windows 8 (64-bit)
®
• Microsoft .NET Framework 4.0 (Full Framework) with update 4.0.3 or .NET Framework 4.5
NOTE: All Proficy Workflow assemblies will be compiled in .NET Framework version 4.5 beginning with the
next major release of the software. Custom displays and applications that reference an earlier version of .NET
| Getting Started | 12
must change to instead reference .NET v4.5 in order to function properly from that point forward. You can
make this change now to minimize future impact.
®
• Microsoft Silverlight Runtime 5.0
NOTE: Silverlight is required to access and develop forms and displays in the Silverlight Designer, and to view
Silverlight forms and displays in the Global Viewer.
®
• Microsoft Excel 2007 or 2010. To use Excel 2007, you must manually install the Primary Interop Assemblies
(for Import/Export operations). These assemblies are included in the Excel 2010 installation. For more
information, see the following links:
• http://msdn.microsoft.com/en-us/library/kh3965hw.aspx
• http://www.microsoft.com/downloads/details.aspx?familyid=59DAEBAA-BED4-4282-A28CB864D8BFA513&displaylang=en
• http://technet.microsoft.com/en-us/library/cc179091.aspx
®
• Microsoft Internet Explorer 7 or greater
®
• For web-based forms, Microsoft Internet Explorer 10 or greater is required
NOTE: Internet Explorer 10 is only supported on the following operating systems:
•
•
•
•
®
Windows 7 SP1
®
Windows 8
®
Windows Server 2008 R2 with SP1
®
Windows Server 2012
Web Task List Software Requirements
This section describes the software requirements for your installation.
Installation
The following list describes the software required to install the Web Task List.
• One of the following operating systems:
•
•
•
•
®
®
Microsoft Windows 7 Professional (32- or 64-bit)
®
®
Microsoft Windows Server 2008 SP2 (32-bit only)
®
®
Microsoft Windows Server 2008 R2 (64-bit)
®
®
Microsoft Windows XP Professional SP2 or greater (32-bit only)
®
NOTE: Support for installing and running the Proficy Workflow on Microsoft Windows XP will be
discontinued beginning with the next major release of the software.
®
®
• Microsoft Windows Server 2012 Standard (64-bit)
®
®
• Microsoft Windows 8 (64-bit)
®
• Microsoft .NET Framework 4.0 (Full Framework) with update 4.0.3 or .NET Framework 4.5
NOTE: All Proficy Workflow assemblies will be compiled in .NET Framework version 4.5 beginning with the
next major release of the software. Custom displays and applications that reference an earlier version of .NET
must change to instead reference .NET v4.5 in order to function properly from that point forward. You can
make this change now to minimize future impact.
®
• Microsoft Internet Explorer 7 or greater
®
• Microsoft Silverlight Runtime 5.0
Reporting Database Software Requirements
This section describes the software requirements for your installation.
Installation
• One of the following operating systems:
®
®
• Microsoft Windows 7 Professional (32- or 64-bit)
| Getting Started | 13
®
®
• Microsoft Windows Server 2008 R2 (64-bit)
®
®
• Microsoft Windows Server 2008 SP2 (32-bit only)
®
®
• Microsoft Windows XP Professional SP2 or greater (32-bit only)
®
NOTE: Support for installing and running the Proficy Workflow on Microsoft Windows XP will be
discontinued beginning with the next major release of the software.
®
®
• Microsoft Windows Server 2012 Standard (64-bit)
®
®
• Microsoft Windows 8 (64-bit)
• One of the following SQL Server systems:
®
• Microsoft SQL Server 2012 Enterprise, Business Intelligence, or Standard (32- or 64-bit)
®
• Microsoft SQL Server 2008 Standard, Professional, or Enterprise Edition (32- or 64-bit)
NOTE:
• SQL Server Integration Services must be installed with SQL Server.
• If you are using SQL Server Express with the Proficy SOA Server, you cannot use the Reporting
Database.
®
• Microsoft Internet Explorer 7 or greater
Proficy Host Software Requirements
This section describes the software requirements for your installation.
Installation
NOTE: Support for installing and running Proficy Workflow in Legacy (compatibility) mode will be discontinued
beginning with the next major release of the software. It will be possible to upgrade legacy systems to nonlegacy systems, but doing so may require updating any service providers that rely on the previous service
provider architecture to use the new service provider architecture.
• One of the following operating systems:
•
•
•
•
®
®
Microsoft Windows 8 (64-bit)
®
®
Microsoft Windows 7 Professional (32- or 64-bit)
®
®
Microsoft Windows Server 2008 SP2 (32-bit only)
®
®
Microsoft Windows Server 2008 R2 (64-bit)
NOTE: Multiple server, failover cluster, and terminal server environments are supported only on Windows
Server 2008 R2 (64-bit).
®
®
• Microsoft Windows XP Professional SP2 or greater (32-bit only)
®
NOTE: Support for installing and running the Proficy Workflow on Microsoft Windows XP will be
discontinued beginning with the next major release of the software.
®
• Microsoft .NET Framework 4.0 (Full Framework) with update 4.0.3 or .NET Framework 4.5
NOTE: All Proficy Workflow assemblies will be compiled in .NET Framework version 4.5 beginning with the
next major release of the software. Custom displays and applications that reference an earlier version of .NET
must change to instead reference .NET v4.5 in order to function properly from that point forward. You can
make this change now to minimize future impact.
®
• Microsoft Internet Explorer 7 or greater
Virtual Machine Support
As part of our development testing and qualification, we make extensive use of VMWare workstations, VMWare
ESX servers, and Microsoft HyperV.
The Proficy Workflow product is qualified on a variety of operating systems. These include Windows XP, Windows
®
®
7, Windows Server 2008 SP2, Windows Server 2008 R2, and Windows Server 2012.
®
NOTE: Support for installing and running the Proficy Workflow on Microsoft Windows XP will be discontinued
beginning with the next major release of the software.
| Getting Started | 14
Our most current VM testing is based on VMWare Workstation 6.0; VMWare ESX server 3.5, 4.0, 4.1; and Microsoft
HyperV on Windows 2008 R2 and Windows 2012. VMWare ESX and Microsoft HyperV are currently very reliable
virtualization platforms. Proficy Workflow does not target any specific hardware or virtualization platform.
GE Intelligent Platforms supports the functional operation of the product if it is run on a supported operating
system in VMWare ESX or Microsoft HyperV, and will address any functional issues related to the software in
those environments.
GE Intelligent Platforms cannot guarantee performance of the software in a virtualized environment due to the
wide range of parameters associated with the hardware, configuration, memory settings, third-party software,
and number of virtual machines running, all of which can affect performance. GE Intelligent Platforms does
not assist with the proper configuration of virtualization software. It is up to the customer to ensure that the
performance of the image has been optimized with the correct settings and configuration before we can provide
support on performance related issues.
It is your responsibility to ensure that the performance of the Proficy Workflow software and application are
adequate to meet the needs of your run-time environment. GE Intelligent Platforms does not support issues
related to functionality that is not available as a result of running in a virtual machine. GE Intelligent Platforms
cannot guarantee the functionality or performance of third-party products used with the application. You must
check with the vendor of those applications for their ability to run in a virtualized environment.
Each virtual machine instance that is using our software is required to have a valid license. Any customer using
virtualization needs to use a software key.
Pre-installation Considerations
In addition to system requirements, you should be aware of several other areas of consideration before installing
Proficy Workflow.
Architecture Considerations
If you are installing a Proficy SOA Server or extension server (that is, Workflow or User) on a 64-bit computer, you
can configure the server for either 32-bit or 64-bit operation.
When installing for the first time, you indicate your preference at installation time, whereas when upgrading,
the installation maintains the existing configuration by default. In both cases, however, components that enable
either 32- or 64-bit server operation are installed to your system, and you can subsequently use the Configure
Server tool to change between 32- and 64-bit mode, as outlined under Change architecture mode on page
66.
If you are using a 64-bit operating system and are installing to the default installation location, do not remove
(x86) from the default installation directory path. Windows detects that Proficy Workflow is a 32-bit process, and
defaults to C:\Program Files (x86)\Proficy…. If you remove (x86) from the default installation location on a 64-bit
operating system, your installation will fail.
NOTE: Client only and Legacy installations are restricted to 32-bit operation, regardless of installation location.
Default Installation Locations by Architecture Type
By default, program installation locations by architecture type are as follows:
• 64-bit: C:\Program Files\Proficy\Proficy Workflow\Program
• 32-bit: C:\Program Files (x86)\Proficy\Proficy Workflow\Program
Ascertaining Current Architecture Mode
Any time after installation, you can consult the Processes tab of Windows Task Manager to ascertain the
architecture mode that the Proficy Server service is currently running under. If operating in 32-bit mode, the
ProficyServer.exe listing is appended with *32.
| Getting Started | 15
Implications for Product Options and Service Providers
The ProficyPackager and ProficyInstaller utilities are available in both the 32-bit and 64-bit installation
locations, and you can package and install product options from either folder. When you run Proficy Server or
Proficy client, the need to update product options is automatically determined depending on where you installed
the product options from. For example, if you package and install a product option from the 64-bit folder, and
run the 64-bit Proficy Server, the Proficy client (which runs only in 32-bit mode) will automatically invoke the
ProficyUpdater utility to update the product option in the 32-bit folder.
Product option assemblies that are loaded by the Proficy client (for example, configuration screens and displays)
must target either Any CPU or x86, because Proficy client runs only in 32-bit mode.
Implications for running service providers are as follows:
• Service providers that were built using a target architecture of Any CPU, can be run in either 32- or 64-bit
mode.
• Service providers that were built to target x86 (32-bit) architecture can be run only in 32-bit mode.
NOTE: This is typically the case when the service provider references a C++/CLI library with 32-bit
dependencies.
• Service providers that were built to target x64 (64-bit) architecture can be run only in 64-bit mode.
NOTE: This is typically the case when the service provider references a C++/CLI library with 64-bit
dependencies.
Maintenance of Configuration Settings
After an upgrade installation on a 64-bit computer that was previously running the 32-bit version of
Proficy Workflow, the Proficy Server configuration file in the 32-bit location (C:\Program Files (x86)\Proficy
\ProficyWorkflow\Program\ProficyServer.exe.config) retains all pre-existing system settings, whereas
the configuration file in the 64-bit location (C:\Program Files\Proficy\ProficyWorkflow\Program
\ProficyServer.exe.config) contains new default settings. If you want to switch from 32-bit to 64-bit operation but
continue using your previously implemented configuration settings, you should migrate the settings in the 32-bit
version of the configuration file to the 64-bit version.
Security Certificates
You are required to install security certificates on all Proficy Workflow server and client machines in your system.
Security certificates are used to protect your identifiable information and to protect your computers from unsafe
software. A certificate is a statement verifying the identity of a person or the security of a web site.
During the Proficy Workflow installation process, you are required to either select or generate security
certificates for the ProficyPlatform, ProficySTS, and SSL/TLS server services.
You can configure the following types of certificates:
• Self-signed certificates generated during the installation process
• Existing certificates that you installed and configured for a previous version of Proficy Workflow
• Legacy certificates included with the installation files
IMPORTANT: While legacy certificates can be used for demonstration, development, or test purposes, it is
strongly recommended that you do not use these certificates in a production environment.
The Proficy Workflow client computer must verify and trust the identity of the server before it can securely send
a user's login and password credentials and complete the authentication process. To establish this trust, the
client must trust the root of the server's certificate. That is, the client must have the certificate of the Certificate
Authority (CA) that issued the server certificate in their Trusted Root Certificate Authorities store.
When you generate new certificates or use existing certificates it will do the following.
• Install a trusted root certificate.
• Install a certificate to a Certificate Store (by default, the Personal Certificate Store).
| Getting Started | 16
•
•
•
•
Install generated self-signed certificates to the proper Certificate Store(s).
Register the SSL certificates to IP ports assigned to the Proficy SOA Server.
Provide the option to use existing certificates configured for a previous version of Proficy Workflow.
Provide the option to use legacy certificates provided with the installation files.
IMPORTANT: The SSL/TLS Server Certificate must be unique to each server.
For information on changing or updating security certificates post-installation, see Configure Proficy Service
Security Certificates on page 61.
Security Certificate Options
Proficy Workflow allows you to select your server security certificate configuration from multiple options. These
options differ slightly depending on the type of server you are configuring.
Full Server Certificate Options
The following table describes the information available to install security certificates on a single full server.
Option
Description
Generate new certificates unique to this installation.
This option allows you to automatically generate new
self-signed certificates. If you are installing a multiserver or server failover cluster environment, more
configuration is required on those servers.
Import certificates from a certificate file.
This option allows you to import certificates that were
generated on and exported from a main server. This
option is used when installing extension servers in a
multi-server or server failover cluster environment and
can also be used to install the same certificates on
multiple single servers.
After selecting this option, click the Browse button
next to the Certificate File field to locate and select
the zip file containing the security certificates that you
exported.
Use the certificates already installed on this server.
This option allows you to use existing certificates
that you installed with a previous version of Proficy
Workflow. You must select the Enable certificate
import for advanced configuration check box to be
able to import the certificates.
Click the Import ellipsis button to import the
certificates using the Certificate Import Wizard. Click
the View ellipsis button to view each certificate after it
has been imported.
Use legacy certificates included in the install.
This option allows you to use the GE-supplied selfsigned certificates provided with the installation files.
It is recommended that you use these certificates only
for demonstration, development, and test systems. For
a production system, select another option.
Extension Server Certificate Options
The following table describes the information available to install security certificates on an extension server; that
is, in a multi-server or server failover cluster environment.
| Getting Started | 17
Option
Description
Import certificates from a certificate file.
This option allows you to import the certificates that
are installed on the main server. You must manually
export the certificates from the main server to a
defined location, and then import the certificates
to the extension server. This option will generate an
SSL certificate if the main server is using certificates
generated by the install, or using legacy certificates
included in the install.
After selecting this option, click the Browse button
next to the Certificate File field to locate and select
the zip file containing the security certificates that you
exported.
Use legacy certificates included in the install.
This option allows you to use the GE-supplied
certificates included with the installation files. It is
recommended that you use these certificates only for
demonstration, development, and test systems. For a
production system, select another option.
Client Certificate Options
When you install a remote client, the certificates that you installed on the server (that is, the single server or the
main server in a multi-server or server cluster environment) are automatically downloaded and installed on the
client.
If the certificates on the server are modified in any way, each client connected to the server will also have to be
updated so that the certificates match those on the server.
Firewall Ports
During server installations, the installation setup detects whether there is a firewall on the computer. You must
either disable the firewall or configure it to allow communication with the server.
The following is a list of the inbound TCP ports you can open on the server computer to allow communication.
•
•
•
•
•
•
•
8012
8112
8020
8201
8202
8203
8204
SQL Server Backup and Restore
Proficy Workflow utilizes SQL Server to store information. In order to ensure that the integrity of the information is
maintained, it is important to back up your database on a regular basis.
In addition to backing up and restoring your Microsoft SQL Server database, maintenance plans can assist in
keeping your systems up and running. Refer to your SQL Server manual or Microsoft's web site for additional
information on backing up, restoring, and maintaining your SQL database.
| Getting Started | 18
Multiple Servers
Proficy SOA provides the ability to install across multiple servers, each of which hosts a set of services. A multiserver environment is transparent and appears to be a single server to remote clients.
Operational Overview
In a multi-server Proficy site, each installed product option may be hosted by a different server, and each server
must be able to determine where each product option resides. To accomplish this objective, the servers refer
to a shared configuration data model. Client programs, such as forms or custom clients, can then connect
to any server and be redirected to the server that is hosting the service(s) required for the product option in
question. Because client programs communicate with product options using service methods and events,
neither the user nor the client program is aware of which server is hosting the product option.
Configuration Overview
In addition to the primary SOAServer instance, which by default hosts both the SOA Core and Workflow product
options, you can configure extension servers, each on a separate machine. These servers can take the form of a
Workflow server, to host the Workflow product option, and/or one or more User servers, to host product options
other than the Core and Workflow options. Upon installing a Workflow server, the Workflow product option and
related services automatically move from the SOAServer instance to the Workflow server instance. Likewise,
upon installing a User server, product options other than the Core and Workflow options automatically move to
the User server instance.
NOTE: Workflow and User servers should not be installed at multiple sites across a WAN.
After installing extension servers, you can use the Configure Site tool to move product options and related
services among server instances.
NOTE: The Core product option and services must reside on the SOAServer instance.
Beginning with Proficy Workflow 2.1, you can also designate whether servers and/or product options are
essential to your use of the program, as well as disable any product options designated as nonessential.
NOTE: The Core and Workflow product options and services and the servers that host them cannot be
designated as nonessential.
The designation of servers and production options as either essential or nonessential and the state and
accessibility of servers has implications for the health of the site and, therefore, the ability to log in and use the
Proficy Workflow program. For more information, see System Health and Program Use on page 59.
For more information on implementing a multiple-server installation of Proficy Workflow, see Architecture
Considerations on page 14, Multiple Server Installation on page 33, and Server Clustering and Failover on
page 18.
Server Clustering and Failover
®
Proficy Workflow provides the ability to implement Microsoft Windows Clustering, which allows you to configure
your server environment to be fault tolerant.
Proficy Workflow allows you to configure a failover cluster to maintain a consistent image of the cluster on all
nodes. It also allows nodes to transfer resource ownership on demand.
A cluster is a group of independent computer systems working together as a unified computer resource. A
cluster provides a single name for clients to use, a single administrative interface, and guarantees that data is
consistent across nodes.
Proficy Workflow works with the Microsoft Failover Cluster Manager to ensure high availability of the Proficy
SOA Server. If the primary Proficy SOA Server node in the cluster experiences difficulties, Proficy Workflow is
automatically started on another node to take over (a process known as failover). Server high availability is
managed through the Microsoft Cluster Manager.
The following information will guide you through the deployment of Proficy Workflow in a clustered environment.
| Getting Started | 19
1.
2.
3.
4.
Overviews of the validated and supported cluster configurations.
Instructions for using the Microsoft Failover Cluster Manager to create a cluster.
Instructions for configuring the primary server.
Instructions for exporting security certificates from the primary cluster server in preparation for installing
them on the failover server.
5. Instructions for configuring the failover server.
Assumptions
It is assumed that the reader has a thorough knowledge of the following information:
®
• Microsoft Failover Clustering
®
• Microsoft Windows Server 2008 R2
Additionally, it is assumed that the instructions and guidelines provided by Microsoft for deploying server clusters
using Microsoft Windows Server 2008 R2 have been followed. For information about server clusters, visit the
Microsoft TechNet web site at: http://technet.microsoft.com/en-us/library/ff182338(v=ws.10).aspx
Cluster Hardware and Software Requirements
The hardware requirements set by Microsoft for clustered server configurations must be met for systems
deploying Proficy Workflow with cluster support.
• Proficy Workflow server clustering and failover is supported only on Windows Server 2008 R2 Standard
Edition.
• Failover clustering is supported on Proficy Workflow 1.5 SP4 and greater.
• SQL Server must be installed in a central location on the domain.
IMPORTANT:
• All computers in a failover cluster must be on a domain.
• Failover clustering is not supported on Proficy SOA legacy servers.
• Proficy Workflow server clustering provides support against hardware failures only.
Custom services managed by clustering must maintain their state in shared persistent memory (typically a
database), and the state must always be in a consistent state because failover can occur at any time.
SQL Server Clustering
Microsoft SQL Server also supports clustering. For complete information about installing, configuring, and
maintaining SQL Server failover clustering, see SQL Server Failover Cluster Installation (for SQL Server 2012) or
Getting Started with SQL Server 2008 R2 Failover Clustering.
The following web site provides access to information about the high availability features supported by the
various editions of SQL Server.
http://msdn.microsoft.com/en-us/library/cc645993.aspx#High_availability
Proficy SOA Server Performance Counters
Windows performance counters are exposed as objects with counters. The counters are grouped into two
categories: Proficy SOA DTL and Proficy SOA Events.
Installation
When SOAServer is installed, the performance counters are installed automatically and uninstalled when the
server is uninstalled.
| Getting Started | 20
Proficy SOA DTL Counters
You can use Proficy SOA DTL counters in Proficy Workflow.
Counter Name
Description
DTL Pending Packets Acknowledged
Shows how many non-specific packet
acknowledgements are in the queue. If this number
starts increasing, it indicates that DTL is having
difficulties processing.
DTL Received Packets Queued
Monitors the queue from the RxThread to
PacketProcessThread. If you are generating many
events with multiple clients, this counter should
increment.
DTL Received Packets Dropped
DTL limits the size of the queue from the RxThread
to the PacketProcessThread to a maximum of 1,000
(ReceiveQueueLimit) packets. If the RxThread gets a
packet when the queue is full, the packet is dropped,
and this counter increments.
DTL Send Packets Queued
Monitors the queue of packets to be sent, which is
added to by the BuildPacketThread and emptied
by the TxThread. Normally, this queue is not busy.
It indicates that something is generating packets
faster than they are being transmitted. If your network
connection is slow, or is very busy and generating a
high volume of events, this counter may increase.
DTL Record Rate Changed
Reports the number of change records per second
coming into the DTL subsystem (typically from an
event subsystem), which is the event producer side of
the multi-server system. When events are generated,
this rate counter moves.
DTL Change Records Queued
Monitors the queue of change records coming from
the Events subsystem (and possibly others) that
are emptied by the BuildPacketThread. Because
the BuildPacketThread pauses to try to get multiple
changes per packet, this counter should change when
there are a high volume of events.
DTL Change Records Dropped
The queue of change records is limited to 1,000. If
more change events come in than can fit in the queue,
DTL starts dropping change records, and this counter
increases. Typically, this counter does not move, but if
the events are generated fast enough, it may move.
Proficy SOA Events Counters
You can use Proficy SOA events counters in Proficy Workflow.
Counter Name
Description
Events Queued Messages to Subscribers
Monitors the queue in the events subsystem for
the subscribers. Typically, a high volume of events
cause this rate counter to increment. If there are N
| Getting Started | 21
Counter Name
Description
subscribers to a given event, there will be N Events
Queued Messages to Subscribers for each event
generated.
Events DTL Subscriptions
Records the number of DTL points being subscribed to.
The event subsystem re-uses DTL subscriptions
so that multiple event clients requesting the same
DTL point create only one subscription. Thus, if
there are three ProficyClients subscribing to the
WorkflowTaskInstanceEvent, there should be one
Events DTL Subscription and three Events Remote
Subscriptions.
Events Remote Subscriptions
Records the number of subscribers to events
on another server (such as those requiring DTL
subscription).
The event subsystem re-uses DTL subscriptions
so that multiple event clients requesting the same
DTL point create only one subscription. Thus, if
there are three ProficyClients subscribing to the
WorkflowTaskInstanceEvent, there should be one
Events DTL Subscription and three Events Remote
Subscriptions.
Events DTL Change Rate
Reports the number of events per second being
fed to the event subsystem from DTL, which is the
subscriber side of the multi-server system. When
events are generated, this rate counter changes.
The DTL Change Record Rate and the Events DTL
Change Rate represent the input side and output side,
respectively, of the DTL link for events and, in a stable
system, should be the same value (with some room for
movement).
Events Messages to Subscribers Rate
Reports the number of events per second being
sent to subscribers. In a stable system, if there are N
subscribers to a given event, the Events Messages
to Subscribers Rate will be N times the Events DTL
Change Rate (assuming only that event is being
generated). If the Events Messages to Subscribers
Rate is less then N times the Events DTL Change Rate,
the Events Queued Messages to Subscribers should
increase.
Log performance counters
Using this procedure, you can write (increment/decrement) to the performance counter.
1. To add performance counting to your system, select the ProficyServer.exe.config file from the following folder:
<installdir>\proficy\proficyworkflow\program.
2. By default, the performance counter key is false. To start logging performance, set it to true in the following
code.
<appSettings>
<add key="EnablePerformanceCounters" value="false"/>
| Getting Started | 22
</appSettings>
NOTE: When EnablePerformanceCounters is false, then the logging counters do not increment or decrement.
If the value of the key is changed (from either true to false or false to true) after the server is started, the
server must be re-started for this change to take effect.
Add or remove performance counters
Using this procedure, you can manually add performance counters to your system, or remove them. You must
have administrative privileges in order to perform this action.
1. From the following location, you can add or remove performance counters: <installfolder>/ProficyServer.exe.
2. In ProficyServer.exe, enter the applicable command line.
To...
Enter...
Add counters
<installfolder>ProficyServer[exe] /
installperformancounters
Remove counters
<installfolder>ProficyServer[exe] /
uninstallperformancounters
IMPORTANT: If the counters are added/deleted (installed/uninstalled) after the server is started, then the
server and the performance monitoring tool (perfmon) must be re-started for this change to take effect.
View performance counters
You can view performance counters using the Microsoft Windows Reliability and Performance Monitor
application.
1. Click Start > Run.
2. In the Open field, enter perfmon, and then click OK.
3. From Monitoring Tools, select Performance Monitor.
A graph region appears.
4. Right click the graph region, and from the menu, select Add Counters.
The following categories appear: Proficy SOA DTL and Proficy SOA Events.
5. Expand these categories to view more information.
Proficy Host / Embeddable Proficy Host
Proficy Workflow provides support that allows service providers from other products in the Proficy product
family, such as Proficy Plant Applications, to integrate and interact with a master Proficy SOA Server.
IMPORTANT: Proficy Host can only be run with a legacy Proficy SOA Server installation; however, it is
®
not available with Windows Server 2012. Support for installing and running Proficy Workflow in Legacy
(compatibility) mode will be discontinued beginning with the next major release of the software. It will be possible
to upgrade legacy systems to non-legacy systems, but doing so may require updating any service providers that
rely on the previous service provider architecture to use the new service provider architecture.
This integration allows you to publish data from these products to the Directory of Resources and access it from
within the Proficy client.
You can create one of the following types of Proficy Host to integrate your product with Proficy Workflow.
Proficy Host
Select this option to create a unique server instance
that runs within the Proficy SOA Server. The Proficy
host creates a Windows service to support the Proficy
Host instance configuration.
Embeddable Proficy Host
Select this option to create a server instance that
is embedded into the ProficyServer.exe Windows
| Getting Started | 23
service. You must write a Windows service executable
program and embed the Proficy Host in that
executable.
After a Proficy Host instance is created, the contents of any AppServer.xml files that are included in the
installation can be read by the Proficy Host, and the services defined in those files become available to the
Proficy system. The contents of an AppServer.xml file informs the Proficy Host of the service provider(s) to load for
the product and where to find them.
The System Status display shows the structure of your Proficy system, including any Proficy Host connections to
your Proficy SOA Server and their corresponding projects, application servers, and services.
For information on a specific product service provider and the data that will be available in the Proficy client, see
the product online help and documentation.
Legacy Server Limitations
The legacy server is used in environments where you use the Proficy Host, which allows the Plant Applications
Service Provider to act as a connection between Proficy Workflow and Proficy Plant Applications. However, the
legacy server has limitations.
IMPORTANT: Support for installing and running Proficy Workflow in Legacy (compatibility) mode will be
discontinued beginning with the next major release of the software. It will be possible to upgrade legacy systems
to non-legacy systems, but doing so may require updating any service providers that rely on the previous service
provider architecture to use the new service provider architecture.
The list describes the legacy server limitations.
•
•
•
•
•
The Silverlight designer is not supported.
Silverlight forms and displays created with external tools cannot be viewed in the Global Viewer.
Server clustering is not supported.
Multi-server architectures are not supported.
Web service endpoints are not supported.
IMPORTANT: If you are using service providers that were created prior to version 1.5 SP4, they are supported
only in legacy server environments.
Reverse Proxy Configuration for the Web Task List
A reverse proxy is a dedicated Internet-facing web server that accepts incoming requests and proxies them
to one or more internal servers. This topology is highly recommended when deploying the Web Task List over
the Internet, as it provides increased security by limiting and controlling the exposure of internal servers and
services.
Certificate Requirements
The following certificates need to be trusted on the web server.
• signing certificate authority
• ProficySTS
Prerequisites
In order to configure a web server as a reverse proxy for the Web Task List, you must ensure that several
prerequisites are met. These prerequisites are common for both IIS and Apache reverse proxy setups.
• A web server running either:
• Microsoft IIS v7.0 or v7.5
• Apache 2.2.20
• Web server is correctly configured with a web site that servers connect to via HTTPS:
| Getting Started | 24
• Web server is accessible via the host name (for example, mywebserver.example.com)
• Binding for the HTTPS scheme on port 443 is secured using an SSL certificate
• SSL certificate is signed by a Trusted Root Certification Authority issued in the name of the web server (for
example, CN=mywebserver.example.com)
NOTE: Certificates signed by a self-issued Trusted Root CA will be trusted by clients only if they are also
configured to trust the self-issued Trusted Root CA itself.
• Firewall allows incoming TCP traffic for port 443
• A single server or multi-server installation of Proficy Workflow.
• Proficy servers are able to serve traffic on all configured ports to external hosts, including any firewalls.
• Web server has been configured to trust the SSL certificates used by the Proficy servers.
• Certificates may be generated during the Proficy Workflow server installation and can be exported using
the Export Certificates tool.
• Web Task List is configured and tested on the intranet.
For more information on configuring a reverse proxy for use with the Web Task List, see Web Task List
Deployment on page 46.
Enable Connection between Proficy Workflow and SQL Server 2012
®
In order for Proficy Workflow to connect to any edition of Microsoft SQL Server 2012, you must configure SQL
Server to enable the sysadmin role for the applicable login account.
If you are using Windows authentication for Proficy Workflow, this account is by default NT AUTHORITY\SYSTEM,
which is pre-defined in SQL Server.
For increased security when using Windows authentication, you can modify the properties for the Proficy Server
service after installing
Proficy Workflow, to define a custom login name and credentials. (For more information,
®
see Microsoft Windows help.) Another alternative is to select SQL Server authentication when installing Proficy
Workflow. In either of these scenarios, you must add the user-specified login account to SQL Server, and then
enable the sysadmin role for that account.
®
For information on adding a login account to SQL Server, see the Microsoft SQL Server help. The following
procedure outlines the steps for enabling the sysadmin role for a login account in SQL Server. Both of these
processes can be done either before or after installing Proficy Workflow.
| Getting Started | 25
1. On the machine that SQL Server 2012 is installed to, open SQL Server Management Studio.
2. In the navigation tree, expand the Security branch, and then the Login branch.
3. Under the Login branch, right-click the applicable entry, and then select Properties.
The Login Properties dialog box appears.
4. In the Select a page pane, click Server Roles.
5. In the Server roles pane, select the sysadmin check box, and then click OK.
Compatibility with Other Proficy Products
If you plan to use one or more other Proficy products with Proficy Workflow, it is important to first determine
whether the version of each such product is compatible with the latest version of Proficy Workflow
Proficy Workflow may be used with a number of other Proficy products. Depending on the product or product
version, you may need to run Proficy Workflow in a particular architecture mode or take additional measures
during set up of use to ensure compatibility between the products. If so, the notes in the following table provide
the necessary details.
NOTE: Changes to the OnDemandProvider Class. A new abstract method called GetChecksum was added to
the OnDemandProvider class. Classes derived from the OnDemandProvider class must implement this new
method. This change was required so that the client (via IBrowse.QueryChecksum) can determine when the
navigator content must be updated from the server.
Proficy
Workflow
Proficy
CIMPLICITY
Proficy
Historian
Proficy
iFIX
Proficy
Open
Enterprise
Proficy Plant
Applications
Proficy Plant
Applications
Service Provider
(PASP)
Proficy
Portal
2.2
8.1
4.5
5.0
2.2
6.2
2.2
3.5
8.2
5.0
5.1
5.5
5.5
1.6
5.0
1.5
3.5
5.8
2.1
8.1
4.5
5.0
8.2
5.0
5.1
6.0
5.5
5.5
6.1
NOTE:
The following notes apply to product versions compatible with Proficy Workflow 2.2:
• Proficy CIMPLICITY 8.1 and 8.2: OPC is recommended for exchanging data between Workflow and CIMPLICITY.
• Proficy Historian 5.0: Data types added to Proficy Historian version 5.0 (ihUInt64, ihUInt32, ihUInt16, ihByte,
ihBool) are not supported for binding to parameters or local variables in Proficy Workflow version 2.2.
The following notes apply to product versions compatible with Proficy Workflow 2.1:
• Proficy Historian 5.0: Data types added to Proficy Historian version 5.0 (ihUInt64, ihUInt32, ihUInt16, ihByte,
ihBool) are not supported for binding to parameters or local variables in Proficy Workflow version 2.1.
• Proficy Open Enterprise 1.6: This version can be run only with the 32-bit version of Proficy Workflow. However,
the 32-bit version of Proficy Workflow can be installed on a 64-bit machine. For more information, see
Architecture Considerations on page 14
• Proficy Plant Applications 6.1: Version 6.1 cannot be installed directly on top of Proficy Workflow version
2.1. Rather, you must first install version 2.0 of Proficy Workflow, then install version 6.1 of Proficy Plant
Applications, and then upgrade Proficy Workflow to version 2.1.
• Proficy Plant Applications Service Provider 1.5
| Getting Started | 26
• Installing the PASP with a new installation of a SOA 2.1 legacy server is not supported. However, you can
upgrade a legacy server to a previous version of SOA that is running the PASP.
• Version 1.5 must be run on a 32-bit User Server installation of Proficy Workflow to be compatible with
Proficy Workflow 2.1. It cannot be run on a 64-bit User Server installation of Proficy Workflow. However,
the 32-bit User Server can be installed on a 64-bit machine. For more information, see Architecture
Considerations on page 14.
License Management
The Proficy License Manager provides a single, easy-to-use tool to both view and manage online software
licensing.
To access the online help for the Proficy License Manager, do the following.
From the desktop, select Start > Programs > Proficy Common > License Documentation.
The Proficy License Manager online help opens.
Proficy Workflow Installations
There are various installation options for Proficy Workflow, Proficy Host, and the Web Task List.
IMPORTANT:
• Workgroups and Windows domains are both supported; however, users must ensure that network
configurations allow appropriate machine communication. Also, Windows authentication for security is
supported only on a domain
• Any resolvable computer name or IP address can be used when installing Proficy Workflow; however, the
same name or IP address must be used consistently for a machine in all configurations on any server, client,
or host machine.
Pre-installation Software Requirements
The following applications must be installed and configured before you can install Proficy Workflow.
®
• Microsoft .NET Framework 4.0 (Full Framework) with update 4.0.3 or .NET Framework 4.5
NOTE: All Proficy Workflow assemblies will be compiled in .NET Framework version 4.5 beginning with the
next major release of the software. Custom displays and applications that reference an earlier version of .NET
must change to instead reference .NET v4.5 in order to function properly from that point forward. You can
make this change now to minimize future impact.
®
• Microsoft AD LDS (Active Directory Lightweight Directory Service) or ADAM (Active Directory
Application Mode) with SP1 (available from http://www.microsoft.com/downloads/details.aspx?
familyid=9688f8b9-1034-4ef6-a3e5-2a2a57b5c8e4&displaylang=en)
NOTE:
• If you are using Windows XP, ADAM is required. If you are using Windows 7, Windows Server 2008, or
Windows Server 2012, the use of AD LDS is recommended, which can be added as Windows components/
features in the Programs applet of the Control Panel.
• For demonstration, evaluation, or pilot systems, you can use Simulated Directory mode rather than using
ADAM or AD LDS. In this mode, the system functions the same way. However, you must use ADAM or AD
LDS to run large systems that have hundreds of clients connecting simultaneously.
SQL Server Options
One of the following SQL Server systems:
®
• Microsoft SQL Server 2012 Enterprise (32- or 64-bit)
®
• Microsoft SQL Server 2012 Business Intelligence (32- or 64-bit)
®
• Microsoft SQL Server 2012 Standard (32- or 64-bit)
| Getting Started | 27
®
• Microsoft SQL Server 2012 Express (32- or 64-bit)
®
NOTE: In order for Proficy Workflow to connect to any edition of Microsoft SQL Server 2012, you must
configure SQL Server to enable the sysadmin role for the applicable login account. For more information, see
Enable Connection between Proficy Workflow and SQL Server 2012 on page 24.
®
• Microsoft SQL Server 2008 Standard, Professional, or Enterprise Edition (32- or 64-bit)
®
• Microsoft SQL Server 2008 R2
®
• Microsoft SQL Server 2008 Express
The Proficy Workflow installation automatically selects the default SQL Server instance. If SQL Server 2012 and
SQL Server 2008 are both installed, SQL Server 2008 may be the default instance. In this scenario, if you want
to use SQL Server 2012 instead, you must select this instance as the default as part of manually configuring
your SQL Server settings. For more information, see the topic corresponding to the type of installation you will be
performing.
SQL Server Databases
The SOA project is installed into this SQL Server database. SQL Server can be installed on a different computer
that is also on the domain or workgroup; however, you must ensure that network configurations allow
appropriate machine communication.
Authentication
• The person whose user name is used for SQL authentication must have authority to create new databases.
• For regular database use during run time, a user requires only db_owner privileges, not administrative
privileges.
Install a Proficy SOA Server and Client
The following information guides you through the Proficy SOA Server and Client installation process.
During this installation process, you are required to create an Administrator user. This user is automatically
assigned all permissions, which will allow you to create and define your users, groups, and key sets, and to set up
your production security.
You must install SQL Server 2012 or SQL Server 2008 before you install Proficy Workflow. For more information,
see Software Requirements on page 8.
®
In order for Proficy Workflow to connect to any edition of Microsoft SQL Server 2012, you must configure
SQL Server to enable the sysadmin role for the applicable login account. For more information, see Enable
Connection between Proficy Workflow and SQL Server 2012 on page 24.
The Proficy Workflow installation automatically selects the default SQL Server instance. If SQL Server 2012 and
SQL Server 2008 are both installed, SQL Server 2008 may be the default instance. In this scenario, if you want to
use SQL Server 2012 instead, you must select this instance as the default as part of manually configuring your
SQL Server settings. For instructions, see steps 9 on page 28 and 10 on page 28 of this procedure.
1. Place the installation DVD in the DVD drive. If you have Autoplay enabled, the installation launcher splash
screen appears.
NOTE: If it does not appear, run InstallFrontEnd.exe on the root directory of the Proficy Workflow DVD.
2. Click Install Proficy Workflow.
The Proficy Workflow Setup wizard appears.
3. Click Proficy Server.
The Proficy Server Installation Type page appears.
4. Select Single Server Installation, and then click Next.
The License Agreement page appears.
5. Review the license agreement, and then click I Agree.
The Choose Install Location page appears.
6. Proceed as applicable based on the architecture of the computer you are installing on:
| Getting Started | 28
If the architecture is...
Then do this...
32-bit
1. Accept the default destination folder or browse
for a new location, and then click Next.
The Configure AD LDS Integration page appears.
64-bit
1. Accept the default Destination Folder or browse
for a new location.
NOTE: This is the destination that 32-bit
components will be installed to. For more
information, see Architecture Considerations on
page 14.
2. Accept the default Destination for 64-bit
Components, or browse for a new location.
3. Select either 32-bit or 64-bit as the initial
architecture mode that you want the server to
operate in.
TIP: The default is 64-bit. If your environment
changes subsequent to installation, you can
use the Configure Server utility to change the
architecture more accordingly.
4. Click Next.
The Configure AD LDS Integration page appears.
7. In the Configure AD LDS Integration page, do one of the following:
• If Active Directory Lightweight Directory Services (AD LDS) is not installed, the Configure AD LDS
Integration page displays a message regarding its use. If AD LDS is not required, click Next.
• If Active Directory Lightweight Directory Services (AD LDS) is installed, but this installation is to be used in a
test and/or development server environment, select the Do not use Microsoft Directory Services check
box, and then click Next.
• If this installation is to be used in a production environment, skip to the next step.
8. For a production environment, perform the following procedure.
a) Clear the Do not use AD LDS check box.
b) In the Directory Instance: Name field, enter an instance name for the ADAM directory.
c) In the Port (LDAP) and Port (SSL) fields, enter valid port numbers.
d) In the User Credentials: Name field, enter the name of a user that is a member of the local computer's
Administrators Group.
e) In the User Credentials: Domain field, enter the name of your company's domain.
f) In the User Credentials: Password field, enter the password for the user you entered in the Name field.
9. Automatically or manually specify your SQL Server to be used with Proficy Workflow based on the
configuration of your environment, as follows:
• If your SQL Server is installed locally, and is designated as the default Local Host, and uses Windows
Authentication, select the Use a local SQL database with Windows Authentication check box to
automatically configure your SQL Server settings accordingly. Proceed to step 11 on page 29.
• If your SQL Server is not installed locally, or is not designated as the Local Host, or uses SQL
Authentication, clear the Use a local SQL database with Windows Authentication check box to manually
configure your SQL Server settings. Proceed to step 10 on page 28.
10. Specify your SQL Server settings, as follows:
a) In the Server field, enter or select the name of the SQL Server you want to connect to.
NOTE: If the SQL Server is installed locally, enter localhost.
| Getting Started | 29
b) In the Database field, enter the name of the SQL database, or click the drop-down arrow to search for all
databases located on the specified server.
NOTE: If the specified database does not exist, it will be created for you.
c) From the Authentication list, select the type of authentication you want to use, and then proceed based
on your selection.
• If you select Windows Authentication, proceed to step 11 on page 29.
• If you select SQL Authentication, proceed to step 10.d on page 29.
d) Enter the User Name and Password that are configured for SQL Authentication, and then proceed to step
11 on page 29.
11. Click Next.
The Configure Security page appears.
12. Enter the following information:
a) In the Administrator Name field, accept the default name or enter a name for the Administrator user.
b) In the Administrator Password field, enter a password for the Administrator user.
NOTE: If password complexity is enabled and configured, the Administrator password must follow the
same rules as defined for user passwords.
c) In the Confirm Password field, re-enter the password for the Administrator user.
d) Optional: Select the Enable SSO (Single Sign On) check box if you want to use GE SSO authentication.
NOTE: Selecting this check box enables the SSO Authentication option on the Proficy Workflow Login
dialog box.
e) In the SSO Server URL field, enter the address of your SSO server. This information is required if you
selected the Enable SSO (Single Sign On) check box.
NOTE: You must obtain the SSO server URL from the GE SSO Security group.
f) In the SiteMinder Agent Server URL field, enter the address of the web server that has SiteMinder
installed on it. This information is required if you selected the Enable SSO (Single Sign On) check box.
NOTE: For important information on setting up and enabling SSO in your facility and for your users, see
GE Single Sign On (SSO) on page 52.
g) Optional: Select the Enable user password change check box if you want to allow Proficy users to change
their login password at any time.
Selecting this check box makes the Change Password link on the login dialog box visible.
h) Optional: Select the Enable user account lockout check box, and then set the lockout threshold, lockout
duration, and observation window size values. On new installations and when upgrading versions, this
check box is selected by default.
IMPORTANT: The Administrator account is also restricted by the lockout settings!
i) Optional: Select the Enable user password complexity rules check box, and then set the password
complexity rules you want to enforce. On new installations, this check box is selected by default. When
upgrading versions, this check box is cleared by default.
13. Click Next.
The Configure Proficy Service Certificates page appears.
14. Select the appropriate certificate option. For full descriptions of the certificate options, see Security Certificate
Options on page 16.
15. Click Next.
If the computer you are installing on has an enabled firewall, the Firewall Detected page appears.
16. If required, make note of the port number to open on the firewall, and then click Next.
IMPORTANT: If your system uses a firewall, you must follow the instructions on the Firewall Detected page
and open ports 8012, 8112, 8020, 8201, 8202, 8203, and 8204 to incoming TCP traffic. For information on
opening a port in your firewall, see the online help for your Windows operating system.
The Ready to Install page appears.
| Getting Started | 30
TIP: At any time during the installation configuration process, you can click Back to go to a previous page to
change your settings.
17. Click Install.
The Installing Proficy Workflow page appears, displaying the status of each installation step.
NOTE: In certain situations, a system restart is required after installation. If this is the case, a corresponding
message is displayed among the listed status messages.
18. When the installation is complete, click Exit.
NOTE: If the installation fails, or you want to change a configuration setting after installation completes,
you can open the appropriate standalone component to configure the required information. For more
information, see Post-installation Configuration on page 60.
The Web Task List is automatically installed with the Full Server installation of Proficy Workflow. Users can access
the Web Task List using a web browser, such as Microsoft Internet Explorer. For more information, see Connect to
the Web Task List on page 49.
Install a legacy Proficy SOA Server and Client
If you use Proficy Host as part of your system configuration, you must use the Legacy Server and Host
installation option. A legacy server installation includes the Proficy SOA server, the Workflow engine, and the
Proficy Host.
IMPORTANT: Support for installing and running Proficy Workflow in Legacy (compatibility) mode will be
discontinued beginning with the next major release of the software. It will be possible to upgrade legacy systems
to non-legacy systems, but doing so may require updating any service providers that rely on the previous service
provider architecture to use the new service provider architecture.
You must install SQL Server 2012 or SQL Server 2008 before you install Proficy Workflow. For more information,
see Software Requirements on page 8.
The Proficy Workflow installation automatically selects the default SQL Server instance. If SQL Server 2012 and
SQL Server 2008 are both installed, SQL Server 2008 may be the default instance. In this scenario, if you want to
use SQL Server 2012 instead, you must select this instance as the default as part of manually configuring your
SQL Server settings. For instructions, see steps 11 on page 31 and 12 on page 31 of this procedure.
During this installation process, you are required to create an Administrator user. This user is automatically
assigned all permissions, which will allow you to create and define your users, groups, and key sets, and to set up
your production security.
®
NOTE: This feature is not available with Windows Server 2012.
1. Place the installation DVD in the DVD drive. If you have Autoplay enabled, the installation launcher splash
screen appears.
2.
3.
4.
5.
NOTE: If it does not appear, run InstallFrontEnd.exe on the root directory of the Proficy Workflow DVD.
Click Install Proficy Workflow.
The Proficy Workflow Setup wizard appears.
Click Legacy Server and Host.
The Legacy Proficy Server Installation Type page appears.
Select the Proficy Server check box, and then click Next.
Review the license agreement, and then click I Agree.
The Choose Install Location page appears.
NOTE: Although the Choose Install Location page reflects a choice between 32-bit and 64-bit installation,
only the 32-bit option is valid when installing a legacy server. Therefore, even if you choose 64-bit, the 32-bit
version of Proficy Workflow will be installed.
6. Accept the default destination folder or browse for a new location, and then click Next.
7. In the Configure AD LDS Integration page, do one of the following:
| Getting Started | 31
• If Active Directory Lightweight Directory Services (AD LDS) is not installed, the Configure AD LDS
Integration page displays a message regarding its use. If AD LDS is not required, click Next.
• If Active Directory Lightweight Directory Services (AD LDS) is installed, but this installation is to be used in a
test and/or development server environment, select the Do not use Microsoft Directory Services check
box, and then click Next.
• If this installation is to be used in a production environment, skip to the next step.
8. For a production environment, perform the following procedure.
a) Clear the Do not use AD LDS check box.
b) In the Directory Instance: Name field, enter an instance name for the ADAM directory.
c) In the Port (LDAP) and Port (SSL) fields, enter valid port numbers.
d) In the User Credentials: Name field, enter the name of a user that is a member of the local computer's
Administrators Group.
e) In the User Credentials: Domain field, enter the name of your company's domain.
f) In the User Credentials: Password field, enter the password for the user you entered in the Name field.
9. Click Next.
The Configure SQL Server page appears.
10. Optional: Select the Backup existing database check box to automatically create a backup of your SQL
database.
11. Automatically or manually specify your SQL Server to be used with Proficy Workflow based on the
configuration of your environment, as follows:
• If your SQL Server is installed locally, and is designated as the default Local Host, and uses Windows
Authentication, select the Use a local SQL database with Windows Authentication check box to
automatically configure your SQL Server settings accordingly. Proceed to step 13 on page 31.
• If your SQL Server is not installed locally, or is not designated as the Local Host, or uses SQL
Authentication, clear the Use a local SQL database with Windows Authentication check box to manually
configure your SQL Server settings. Proceed to step 12 on page 31.
12. Specify your SQL Server settings, as follows:
a) In the Server field, enter or select the name of the SQL Server you want to connect to.
NOTE: If the SQL Server is installed locally, enter localhost.
b) In the Database field, enter the name of the SQL database, or click the drop-down arrow to search for all
databases located on the specified server.
NOTE: If the specified database does not exist, it will be created for you.
c) From the Authentication list, select the type of authentication you want to use, and then proceed based
on your selection.
• If you select Windows Authentication, proceed to step 13 on page 31.
• If you select SQL Authentication, proceed to step 12.d on page 31.
d) Enter the User Name and Password that are configured for SQL Authentication, and then proceed to step
13 on page 31.
13. Click Next.
The Configure Security page appears.
14. Enter the following information:
a) In the Administrator Name field, accept the default name or enter a name for the Administrator user.
b) In the Administrator Password field, enter a password for the Administrator user.
NOTE: If password complexity is enabled and configured, the Administrator password must follow the
same rules as defined for user passwords.
c) In the Confirm Password field, re-enter the password for the Administrator user.
d) Select the Enable SSO (Single Sign On) check box if you want to use GE SSO authentication.
| Getting Started | 32
NOTE: Selecting this check box enables the SSO Authentication option on the Proficy Workflow Login
dialog box.
e) Optional: In the SSO Server URL field, enter the address of your SSO server. This information is required if
you selected the Enable SSO (Single Sign On) check box.
NOTE: You must obtain the SSO server URL from the GE SSO Security group.
f) In the SiteMinder Agent Server URL field, enter the address of the web server that has SiteMinder
installed on it. This information is required if you selected the Enable SSO (Single Sign On) check box.
NOTE: For important information on setting up and enabling SSO in your facility and for your users, see
GE Single Sign On (SSO) on page 52.
g) Optional: Select the Enable user password change check box if you want to allow Proficy users to change
their login password at any time.
Selecting this check box makes the Change Password link on the login dialog box visible.
h) Optional: Select the Enable user account lockout check box, and then set the lockout threshold, lockout
duration, and observation window size values. On new installations and when upgrading versions, this
check box is selected by default.
IMPORTANT: The Administrator account is also restricted by the lockout settings!
i) Optional: Select the Enable user password complexity rules check box, and then set the password
complexity rules you want to enforce. On new installations, this check box is selected by default. When
upgrading versions, this check box is cleared by default.
15. Click Next.
The Configure Proficy Service Certificates page appears.
16. Select the appropriate certificate option. For full descriptions of the certificate options, see Security Certificate
Options on page 16.
17. Click Next.
If the computer you are installing on has an enabled firewall, the Firewall Detected page appears.
18. If required, make note of the port number to open on the firewall, and then click Next.
IMPORTANT: If your system uses a firewall, you must follow the instructions on the Firewall Detected page
and open ports 8012, 8112, 8020, 8201, 8202, 8203, and 8204 to incoming TCP traffic. For information on
opening a port in your firewall, see the online help for your Windows operating system.
The Ready to Install page appears.
TIP: At any time during the installation configuration process, you can click Back to go to a previous page to
change your settings.
19. Click Install.
The Installing Proficy Workflow page appears, displaying the status of each installation step.
NOTE: In certain situations, a system restart is required after installation. If this is the case, a corresponding
message is displayed among the listed status messages.
20. When the installation is complete, click Exit.
NOTE: If the installation fails, or you want to change a configuration setting after installation completes,
you can open the appropriate standalone component to configure the required information. For more
information, see Post-installation Configuration on page 60.
Install a remote Proficy Workflow client
This information guides you through the process of installing a remote client on a different machine than the
Proficy SOA Server.
You must have installed the Proficy SOA Server before you can install a client, because you require an available
server to connect to.
1. Place the installation DVD in the DVD drive. If you have Autoplay enabled, the installation launcher splash
screen appears.
| Getting Started | 33
NOTE: If it does not appear, run InstallFrontEnd.exe on the root directory of the Proficy Workflow DVD.
2. Click Install Proficy Workflow.
The Proficy Workflow Setup wizard appears.
3. Click Client Only.
The License Agreement page appears.
4. Review the license agreement, and then click I Agree.
The Choose Install Location page appears.
5. Accept the default destination folder or browse for a new location, and then click Next.
The Proficy Workflow Server Configuration page appears.
6. Enter the following information:
a) In the Server Computer Name field, enter the name of the computer where the server you want to
connect to is installed.
• If you are configuring a full server, legacy server, or multi-server environment, enter the name of the
computer that the server you want to connect to is installed on.
• If you are configuring a server cluster environment, enter the cluster name used when you set up your
cluster.
NOTE: You can also use the IP address for the server if the server uses a static IP address.
b) In the Server Instance Name field, enter the name of the server instance you want to connect to.
c) In the Server HTTP Port field, enter the port number required to allow communication with the server.
d) Click Next.
The Configure Proficy Service Certificates page appears.
7. The security certificates are automatically downloaded from the server you are connecting to.
8. Click Next.
The Ready to Install page appears.
TIP: At any time during the installation configuration process, you can click Back to go to a previous page to
change your settings.
9. Click Install.
The Installing Proficy Workflow page appears, displaying the status of each installation step.
NOTE: In certain situations, a system restart is required after installation. If this is the case, a corresponding
message is displayed among the listed status messages.
10. When the installation is complete, click Exit.
11. Launch the Proficy Workflow client.
A message appears stating: Proficy SOA updates are available. Click OK to start Proficy SOA Update.
12. Click OK, and then, on the Proficy SOA Update page, click Install Updates.
13. When the updates have finished installing, click Restart Client.
Multiple Server Installation
After installing the SOAServer to host the Core services on one machine, you can set up other machines to host
extension servers in the form of a Workflow server, for the Workflow services, and one or more User servers, for
Proficy product options that you may license and/or custom service providers that you develop.
Installing Proficy Workflow on extension servers involves two main steps:
1. Export security certificates
2. Install the extension server(s)
Export server security certificates for an extension server
After installing the main server in a multi-server environment, you must export the server security certificates
and install them on your extension servers. During the extension server installation process, you must import
these security certificates.
| Getting Started | 34
1. On the main server computer, click Start > All Programs > Proficy > Proficy Workflow > Configuration >
Export Certificates.
The Export Proficy Server Certificates page appears.
2. In the Export Folder field, enter the path or browse to the location where you want to export the certificates
to.
3. In the Password field, enter a password to secure the exported certificates, and to use when importing the
certificates to the extension server(s).
4. Click Save.
A file with the extension .zip is created, which contains the certificates required on the extension server(s).
5. Click Exit.
Install multiple servers
Proficy Workflow provides multiple server capability, allowing you to install the SOAServer to host the Core
services on one machine and a Workflow server to host the Workflow services on another machine. You can
also choose to install one or more User servers to host other Proficy product options that you may license and/or
custom service providers that you develop.
IMPORTANT:
• If you are installing a Workflow server or a User server, you must have already installed an SOAServer to host
the Core services on a separate machine.
• In a multi-server environment, eSOP is automatically installed on the Workflow server.When you upgrade
Proficy Workflow or install it again, all sample resource files are overwritten.
1. Place the installation DVD in the DVD drive. If you have Autoplay enabled, the installation launcher splash
screen appears.
NOTE: If it does not appear, run InstallFrontEnd.exe on the root directory of the Proficy Workflow DVD.
2. Click Install Proficy Workflow.
The Proficy Workflow Setup wizard appears.
3. Click Proficy Server.
The Proficy Server Installation Type page appears.
4. Click Server Extension, select one of the following options, and then click Next.
• To install a dedicated workflow server, click Workflow Server.
• To install a server to host custom service providers, click User Server.
The License Agreement page appears.
5. Review the license agreement, and then click I Agree.
The Choose Install Location page appears.
6. Proceed as applicable based on the architecture of the computer you are installing to:
If the architecture is...
Then do this...
32-bit
1. Accept the default destination folder or browse
for a new location, and then click Next.
The Configure SQL Server page appears.
64-bit
1. Accept the default Destination Folder or browse
for a new location.
NOTE: This is the destination that 32-bit
components will be installed to. For more
information, see Architecture Considerations on
page 14.
2. Accept the default Destination for 64-bit
Components, or browse for a new location.
| Getting Started | 35
If the architecture is...
Then do this...
3. Select either 32-bit or 64-bit as the initial
architecture mode that you want the server to
operate in.
TIP: The default is 64-bit. If your environment
changes subsequent to installation, you can
use the Configure Server utility to change the
architecture more accordingly.
4. Click Next.
The Configure SQL Server page appears.
7. Specify your SQL Server settings, as follows:
NOTE: These settings must be the same as for the core server.
a) In the Server field, enter or select the name of the SQL Server you want to connect to.
b) In the Database field, enter the name of the SQL database, or click the drop-down arrow to search for all
databases located on the specified server.
c) From the Authentication list, select the type of authentication you want to use, and then proceed based
on your selection.
• If you select Windows Authentication, proceed to step 8 on page 35.
• If you select SQL Authentication, proceed to step 7.d on page 35.
d) Enter the User Name and Password that are configured for SQL Authentication, and then proceed to step
8 on page 35.
8. Click Next.
The Configure Proficy Service Certificates page appears.
9. Import the security certificates as follows:
IMPORTANT: If you have not already exported the security certificates from the main server, you must do so
now before proceeding.
a) In the Certificate File field, enter the path or browse to the location where you exported the security
certificates from the main server.
b) Select the .zip file that you created on the main server, and then click OK.
c) In the Password field, enter the password that was set when you exported the security certificates.
10. Click Next.
The imported certificates are listed.
11. Click Next.
If the computer you are installing on has an enabled firewall, the Firewall Detected page appears.
12. If required, make note of the port number to open on the firewall, and then click Next.
IMPORTANT: If your system uses a firewall, you must follow the instructions on the Firewall Detected page
and open ports 8012, 8112, 8020, 8201, 8202, 8203, and 8204 to incoming TCP traffic. For information on
opening a port in your firewall, see the online help for your Windows operating system.
The Ready to Install page appears.
TIP: At any time during the installation configuration process, you can click Back to go to a previous page to
change your settings.
13. Click Install.
The Installing Proficy Workflow page appears, displaying the status of each installation step.
NOTE: In certain situations, a system restart is required after installation. If this is the case, a corresponding
message is displayed among the listed status messages.
14. When the installation is complete, click Exit.
| Getting Started | 36
NOTE: If the installation fails, or you want to change a configuration setting after installation completes,
you can open the appropriate standalone component to configure the required information. For more
information, see Post-installation Configuration on page 60.
One-Click Deployment
One-click deployment allows you to deploy Proficy Workflow to users without running a client installation on
their computers. It also provides the ability for a client to update itself when the server is upgraded.
IMPORTANT: Support for one-click installation of Proficy Workflow will be discontinued in a future release of
the software. The client installation should be used in place of one-click installation upon discontinuation of the
latter.
Before you can use one-click deployment, you must complete the following prerequisites:
• .NET 4.0 Full Install must be installed on the computer where one-click deployment will be used.
NOTE: All Proficy Workflow assemblies will be compiled in .NET Framework version 4.5 beginning with the
next major release of the software. Custom displays and applications that reference an earlier version of .NET
must change to instead reference .NET v4.5 in order to function properly from that point forward. You can
make this change now to minimize future impact.
• The NetTCPPortSharing service must be enabled and started.
• Security certificates cannot be deployed remotely. Install your certificates by manually installing a copy of the
certificates from the server. Certificates can be copied from the server to a disk or other portable device, and
then installed, or by using your IT department's method of delivering and installing files.
• MIME types must be added to each computer in order for the .manifest and .deploy files to work correctly. For
more information, see the following:
• http://msdn.microsoft.com/en-us/library/ms228998(VS.85).aspx
• http://msdn.microsoft.com/en-us/library/ms752346.aspx
• http://www.microsoft.com/technet/prodtechnol/WindowsServer2003/Library/IIS/cd72c0dcc5b8-42e4-96c2-b3c656f99ead.mspx?mfr=true
When an administrator installs Proficy Workflow on a server computer, the files required for the one-click
deployment are installed when you perform a server installation.
On 32-bit computers, these files are located in a folder called Deployment in the following location:
<install dir>\Program Files\Proficy\Proficy Workflow\Program\Deployment
On 64-bit computers, these files are located in a folder called Deployment in the following location:
<install dir>\Program Files (x86)\Proficy\Proficy Workflow\Program\Deployment
An Administrator user must share this folder on the server computer, and then users can access it through a web
page. The file used for one-click deployment is:
ProficyClient.application
You can create a web page, a button, or any means of access you want to use to make one-click deployment
available to your users.
Each time a user invokes one-click deployment, it checks for any code updates, such as patches and service
packs, that have been applied to the server (and subsequently to the one-click deployment files) and applies
those changes to the one-click client. This allows your users to always be working with the same version of code
as the server.
After installing Proficy Workflow on the server computer, you can copy the Deployment folder to another location
for users to access. If you copy the folder to another location, you must re-copy the folder whenever code
updates are applied in order for users to get the updates.
IMPORTANT: Do not move the Deployment folder from its install location. If this folder is moved, code updates
cannot be applied to it.
| Getting Started | 37
Configure security certificates for a click-once client
For a click-once client, use this procedure to install certificates using the certificate authority generated by the
Proficy Workflow server installation.
NOTE: Support for one-click installation of Proficy Workflow will be discontinued in a future release of the
software. The client installation should be used in place of one-click installation upon discontinuation of the
latter.
1. In the Proficy Workflow installation directory, go to the following folder to find the required certificate files:
<installdir>\Program Files\Proficy\Proficy Workflow\Certificates\Export.
2. Copy the following certificate files to your click-once computer:
3.
4.
5.
6.
• ProficySelfSignedCA.pfx
• ProficySTS.pfx
For a click-once client running on Windows, run mmc.exe.
From the Console window, go to the File menu, and then select Add/Remove Snap-in.
The Add or Remove Snap-ins dialog box appears.
In Available Snap-ins, double-click Certificates.
The Certificates snap-in dialog box appears.
Select Computer account, click Next, select Local computer, and then click Finish.
7. Click OK.
8. From Certificates (Local Computer), expand Trusted Root Certification Authorities\Certificates, and then add
ProficySelfSignedCA.pfx.
9. From Certificates (Local Computer), expand Personal\Certificates, and then add ProficySTS.pfx.
Command Line Installation
Proficy Workflow provides the ability to install the server, client, or hosts using command line parameters.
Using command lines to install the Proficy SOA Server allows you to install multiple servers, ensuring that the
same configuration data is used in all instances.
The following table describes the command line parameters that can be used.
Command Line Parameter
Description
/s
Runs the installation setup (SetupWorflow.exe or
SetupVision.exe) in silent mode; that is, the installation
occurs without displaying the user interface.
You must use the /c parameter in conjunction with
the /s parameter and provide a valid configuration file
name.
/fs
Same as the /s parameter, but stops and restarts
running services when performing an upgrade
installation.
/t filepath (where filepath is the user-defined file name) Runs the installation setup (SetupWorkflow.exe or
SetupVision.exe), including the user interface, and
creates a configuration file that contains all of the
installation configuration data.
NOTE: For security reasons, passwords are not
included in the configuration data.
/it filename (where filename is the user-defined file
name)
Runs the installation setup (SetupWorkflow.exe or
SetupVision.exe), including the user interface, and
creates a configuration file that contains all of the
| Getting Started | 38
Command Line Parameter
Description
installation configuration data after installation is
finished.
NOTE: The configuration file is located in the Proficy
program data folder (typically, C:\ProgramData
\Proficy).
/c filepath (where filepath is the user-defined file
name)
Runs the installation setup (SetupWorkflow.exe or
SetupVision.exe) and uses the configuration data
found in the configuration file. When used with the /s
parameter, the installation runs in silent mode.
NOTE: You can use the configuration file that was
created using the /t command line parameter or you
can use the sample configuration file provided in the
install directory.
If you use the configuration file created by using the /t
parameter, you must add the passwords before using
that file with the /c parameter.
/l filepath (where filepath is the logging directory)
Overrides the default logging location.
/p installation type option (where installation type
option values are specific to the product being
installed)
Runs SetupWorkflow.exe or SetupVision.exe, including
the user interface, without displaying the installation
type selection screen, instead automatically selecting
the installation type based on the value specified for
the command line parameter. Valid parameter values
based on product type are as follows:
SetupWorkflow.exe
• Server: Installs a
Proficy Server in
Single Server mode.
• WorkflowServer:
Installs a Proficy
Server in Workflow
Extension Server
mode.
• UserServer: Installs
a Proficy Server in
User Extension Server
mode.
• Client: Installs a
Proficy Client.
SetupVision.exe
• Application: Installs
the Proficy Application
Server.
• Web: Installs the
Proficy Web Server.
NOTE:
• These values are case sensitive.
| Getting Started | 39
Command Line Parameter
Description
• The /p parameter cannot be used in conjunction
with silent mode (that is, the /s parameter) and/or a
configuration file (that is, the /c parameter).
Uninstall Proficy Workflow
The following topic guides you though the process of removing Proficy Workflow software from your system.
NOTE: If you generated security certificates or used pre-existing certificates from a previous version of Proficy
Workflow, those certificates are not removed when you uninstall your Proficy Workflow server or remote client.
1. From Control Panel, go to your programs listing.
2. If applicable, select ADAM Instance SOAAdam, and then click Uninstall (depending on your operating
system).
3. In the confirmation message box, click Yes.
4. Select Proficy Workflow (<installation type>), and then click Uninstall (depending on your operating system).
5. In the confirmation message box, click Yes.
Server Clustering Implementation
Supported and Validated Cluster Configurations
Before you begin installing Proficy Workflow, it is important to determine what your architecture is so you can
know where to install your servers.
There are three environments that have been validated and are supported.
• One cluster, two nodes
• Two clusters, two nodes each
• Three clusters, two nodes each
The only supported configuration of cluster groups is as follows.
•
•
•
•
Proficy SOA Server (single server) cluster group
Proficy SOA Server, Workflow Engine (multi-server) cluster group
Proficy SOA Server, User Server (multi-server) cluster group
Proficy SOA Server, Workflow Engine, and User Server (multi-server) clustered groups
One Cluster, Two Nodes
One of the environments supported and validated for server clustering is a single cluster with two nodes.
The following figure shows an example of two Proficy SOA servers in one cluster. Each Proficy SOA server must
run the ProficyServer, ProficyPublisher, and ProficySTS services.
| Getting Started | 40
Figure 1: Two Proficy SOA servers in a single cluster
Two Clusters, Two Nodes Each
One of the environments supported and validated for server clustering is two clusters with two nodes each.
The following figures show examples of two Proficy SOA servers with two Workflow engines, in separate clusters,
and two Proficy SOA servers with two User servers, in separate clusters, respectively.
Figure 2: Two Proficy SOA servers and two Workflow engines, in separate clusters
Each Proficy SOA server must run the ProficyServer, ProficyPublisher, and ProficySTS services. Each Workflow
engine must run the ProficyServer service.
| Getting Started | 41
Figure 3: Two Proficy SOA servers and two User servers, in separate clusters
Each Proficy SOA server must run the ProficyServer, ProficyPublisher, and ProficySTS services. Each User server
must run the ProficyServer service.
Three Clusters, Two Nodes Each
One of the environments supported and validated for server clustering is three clusters with two nodes each.
The following figure shows an example of two Proficy SOA servers, two Workflow engines, and two User servers,
each in its own cluster. Each Proficy SOA server must run the ProficyServer, ProficyPublisher, and ProficySTS
services. Each Workflow engine and each User server must run the ProficyServer service.
Figure 4: Two Proficy SOA servers, two Workflow engines, and two User servers, in separate clusters
| Getting Started | 42
Microsoft Failover Cluster Manager for Windows Servers
The Microsoft Failover Cluster Manager is used to create the cluster and to add nodes to the cluster.
If failover clustering is not installed, use the Server Manager to install it.
Depending on your server requirements, visit one of the following Microsoft TechNet web sites for more
information:
• Windows Server 2008 R8: http://technet.microsoft.com/en-us/library/ff182338(v=ws.10).aspx
• Windows Server 2012: http://technet.microsoft.com/en-us/library/hh831579.aspx
The Microsoft Failover Cluster Manager is used to create two new DNS entries: one to manage your server
cluster and one for the services you intend to cluster. For a Proficy SOA Server cluster (even in a multi-server
environment), you must add the ProficyServer, ProficyPublisher, and ProficySTS services.
If you are using clusters in a multi-server environment and clustering Workflow and/or User servers, only the
ProficyServer service needs to be added for those servers.
Install Microsoft Failover Cluster Manager
The Microsoft Failover Cluster Manager must be installed in order to configure your failover cluster.
1. On the server computer, click Start > Administrative Tools > Server Manager.
The Server Manager dialog box appears.
2. In the navigation tree, right-click Features, and then select Add Features.
The Add Features Wizard appears.
3. Select Failover Clustering, and then click Next.
4. Click Install.
5. When the installation completes, click Close.
Configure the Microsoft Failover Cluster Manager
The Microsoft Failover Cluster Manager is used to create a new DNS entry to manage your server cluster.
IMPORTANT: You must have installed Proficy SOA on both cluster nodes, pointing to the same database, before
performing the following procedure.
®
This procedure is based on a Windows Server 2012 environment. If you are using Windows 2008 R2, ensure
that you add the Proficy STS and ProficyPublisherService services as children of Proficy Server.
1. On the server computer, click Start > Administrative Tools > Failover Cluster Manager.
The Failover Cluster Manager dialog box appears.
2. From the Actions menu, select Create Cluster.
The Create Cluster Wizard appears.
3. Follow the wizard prompts to create your cluster, as follows:
a)
b)
c)
d)
Enter a management name for the cluster.
Add the nodes that will be part of the cluster; that is, the primary and failover servers.
In the Failover Cluster Manager, expand the cluster from the left hand side, and then click Roles.
Click Configure Role.
The High Availability Wizard appears.
e) Click Generic Service, and then click Next.
f) Click Proficy Server, and then click Next.
g) Enter a name for the Proficy Server. This name is required when running various Proficy Workflow tools.
h) Click Next, and then Next again to bypass the storage and registry settings.
i) Review the confirmation, click Next, and then click Finish.
4. To add Proficy support services, perform the following procedure.
a) In the Roles window, in the Status column, wait until the status changes to Running.
| Getting Started | 43
b)
c)
d)
e)
Right-click the role that you created, click Add Resource, and then select Generic Service.
Click Proficy STS, and then click Next.
Review the confirmation, click Next, and then click Finish.
For ProficyPublisherService, repeat steps 4.b on page 43 to 4.d on page 43.
The Status indicates that the roles are Partially Running.
f) In the Roles window, select the name you entered in 3.g on page 42.
g) Click Start Role.
The Status indicates that the roles are Running and Online.
h) Click Stop Role.
After setting up the failover cluster, the services will be running on both servers. You must either manually stop
the services on the failover server, or move the service to the primary server. This enables the services on only
the primary server.
NOTE: To run any post-installation configuration tools, you must turn off the cluster to avoid a failover. For all
tools, except Configure Server, you are required to run the tools on one node only of the cluster. For configuring
the server, you must run the tool on all nodes.
Configure quorum options for a cluster
Although Proficy Workflow does not require a disk for clustering, it is recommended that you configure either a
file share witness or a disk witness.
1. On the server computer, click Start > Administrative Tools > Failover Cluster Manager.
The Failover Cluster Manager dialog box appears.
2. Select the cluster you want to configure.
TIP: If the cluster you want to configure is not displayed, then in the console tree, right-click Failover Cluster
Manager, click Manage a Cluster, and then select or specify the cluster you want to configure.
3. From the Actions menu, click More Actions, and then click Configure Cluster Quorum Settings.
4. Follow the instructions in the wizard to select the quorum configuration for your cluster.
If you choose a configuration that includes a disk witness or file share witness, follow the instructions for
specifying the witness.
5. Optional: After the wizard completes and the Summary page appears, click View Report to view a report of
the tasks that the wizard performed.
Configure the primary Proficy SOA cluster server
After installing the Proficy SOA Server and Client on your primary server machine, you must configure the
machine as the primary Proficy SOA cluster server to begin the clustering process.
1. On the primary server machine, click Start > All Programs > Proficy > Proficy Workflow > Configuration >
Configure Server.
The Configure Server Instance tool appears.
2. Select the Create a Proficy SOA Server Instance option.
3. Select the Make this machine a primary for a new failover cluster check box.
4. In the Cluster Name field, enter the name of the cluster you created in the Microsoft Failover Cluster
Manager.
5. Click Save, and then click Exit.
6. Regenerate the security certificates for the cluster by running the Configure Proficy Service Certificates tool,
and choose the Generate new certificates unique to this installation option.
IMPORTANT: After configuring the primary Proficy SOA cluster server, you must complete the following
procedures to finish the clustering process.
| Getting Started | 44
1. Export the server security certificates in preparation for installing them on your failover and/or extension
server(s).
2. Configure the failover Proficy SOA cluster server on page 44.
Configure the failover Proficy SOA cluster server
After configuring the primary Proficy SOA cluster server and exporting the server security certificates, you can
configure the failover Proficy SOA cluster server.
1. On the backup server machine, click Start > All Programs > Proficy > Proficy Workflow > Configuration >
Configure Server.
The Configure Server Instance tool appears.
2. Select the Make this machine a failover backup of an existing Server Instance option.
3. From the Choose existing cluster drop-down list, select the cluster that you want this machine to be the
failover backup for.
4. Click Save, and then click Exit.
5. On the backup server machine, click Start > All Programs > Proficy > Proficy Workflow > Configuration >
Configure Certificates.
The Configure Proficy Service Certificates page appears.
6. Select the Import certificates from a certificate file option, and then import the certificates, as follows:
a) In the Certificate File field, click Browse, and then locate and select the zip file containing the security
certificates that you exported when you configured the primary server in the cluster.
b) In the Password field, enter the password that you set when you exported the security certificates from
the primary server.
c) Click Next.
The page changes to indicate that the files contained in the exported certificate file have been loaded.
d) Click Save.
Configure a local client for a cluster node (32-bit)
If you want to run a cluster node on a 32-bit system, follow this procedure.
TIP: If your Proficy client starts but tries to update its product options and fails, then you must restart the
ProficyServer service. Restarting this service ensures that the client product options are upgraded.
1. To set up a local client, perform the following procedure.
a) Create a copy of the file, UserStartup.xml. To find this file, go to <install location>\Program Files
(x86)\Proficy\Proficy Workflow\Program\Data\UserStartup.xml.
b) Name the new copy UserStartupClient.xml.
c) In the new file, change ServerDNSName to the name of the new cluster. For example, if it is called
soaCluster2012: <ServerDNSName>soaCluster2012</ServerDNSName>.
2. In the file, ProficyClient.exe.config, make these changes. To find this file, go to <install location>\Program Files
(x86)\Proficy\Proficy Workflow\Program\ProficyClient.exe.config.
NOTE: It is recommended that you make a backup copy of this file before proceeding.
a) From the line <add key="stsUrl" value="http://<computer node name>:8112/ProficySTS">, change
<computer node name> to the name of the cluster, such as soaCluster2012.
b) In the following two lines, change the old file name (UserStartup.xml) to the new file name
(UserStartupClient.xml).
• <add key="url" value="./Data/UserStartupClient.xml">
• <add key="UserStartupUrl" value="./Data/UserStartupClient.xml">
| Getting Started | 45
Configure a local client for a cluster node (64-bit)
If you want to run a cluster node on a 64-bit system, follow this procedure.
• Point the file, UserStartup.xml, to the cluster instead of the node.
To find this file, go to <install location>\Program Files (x86)\Proficy\Proficy Workflow\Program\Data
\UserStartup.xml.
Server Clustering and One-Click Deployment
If you have implemented a server cluster environment and you want to use one-click deployment in that
environment, additional configuration is required to set up the one-click deployment.
There are two methods to choose from to configure one-click deployment in a server cluster environment.
• Modify the userstartup.xml file on each client to use the cluster address.
• Update the userstartup.xml.deploy file on the server, in the Proficy Workflow\Program\Deployment
\1_5_0_0\Program\Data directory, and then regenerate the one-click deployment install.
Clustering Tips
Use the clustering tips to ensure your failover cluster runs smoothly.
Security Certificates
When setting up a clustered environment, you must regenerate and export Proficy SOA security certificates as
part of configuring the primary cluster server, and then import the certificates when configuring the failover
cluster server. Symptoms of incorrect security certificate configuration include the inability to create or display
Silverlight forms and the Web Task List. For more information on setting up security certificates for a clustered
environment, see Configure the primary Proficy SOA cluster server on page 43, Configure the failover Proficy
SOA cluster server on page 44, and Configure Proficy Service Security Certificates on page 61.
ProficyServer Service is Marked for Deletion
Occasionally, after a server configuration, the ProficyServer service is marked for deletion. You can restore the
service by running the Configure Server tool again.
Clients on Clustered Proficy SOA Servers
Clients that are installed with clustered Proficy SOA servers will work only if the server is the primary server.
NOTE: If you have a cluster with multiple nodes, the cluster must be pointing to the client name, and the server
that each node is running on must state the role name for the cluster. For more information, see Configure a
local client for a cluster node (32-bit) on page 44 and Configure a local client for a cluster node (64-bit) on
page 45.
Running a Clustered Multi-server Environment
When running with both a clustered Proficy SOA server and clustered Workflow/User servers, you must restart
the primary Proficy SOA Server and then, after a few minutes, restart the primary Workflow/User server. This can
be performed using the Microsoft Failover Cluster Manager by taking the servers offline, and then putting them
back online.
| Getting Started | 46
Web Task List Deployment
The Web Task List is automatically installed with the Full Server installation of Proficy Workflow. Users can access
the Web Task List using a web browser, such as Microsoft Internet Explorer.
A reverse proxy is highly recommended when deploying the Web Task List, as it provides increased security
by limiting and controlling the exposure of internal servers and services. You can configure either an Internet
Information Services (IIS) reverse proxy or an Apache reverse proxy for use with the Web Task List. In either case,
you must also configure the necessary certificates before connecting to the Web Task List.
Configure security certificates for a reverse proxy
For a secure reverse proxy, use this procedure to install certificates to your web server using the certificate
authority generated by the Proficy Workflow server installation.
1. In the Proficy Workflow installation directory, go to the following folder to find the required certificate files:
<installdir>\Program Files\Proficy\Proficy Workflow\Certificates\Export.
2. Copy the following certificate files to your web server:
3.
4.
5.
6.
7.
8.
9.
• ProficySelfSignedCAPublicKey.cer
• ProficySTSPublicKey.cer
For a web server running on Windows, run mmc.exe.
From the Console window, go to the File menu, and then select Add/Remove Snap-in.
The Add or Remove Snap-ins dialog box appears.
In Available Snap-ins, double-click Certificates.
The Certificates snap-in dialog box appears.
Select Computer account, click Next, select Local computer, and then click Finish.
Click OK.
From Certificates (Local Computer), expand Trusted Root Certification Authorities\Certificates, and then add
ProficySelfSignedCAPublicKey.cer.
From Certificates (Local Computer), expand Personal\Certificates, and then add ProficySTSPublicKey.cer.
Configure an IIS reverse proxy for the Web Task List
The information provided in this section is specific to configuring Internet Information Services (IIS) to act as a
reverse proxy using the Application Request Routing (ARR) and URL Rewrite modules.
1. Prerequisites
TIP: Before installing IIS Application Request Routing (ARR), it is recommended that you enable HTTP Logging
and Tracing features for IIS first. Tracing makes it possible to diagnose problems with reverse proxy rewrite
rules.
a) From the Control Panel, go to Windows Features to enable the following IIS settings:
• HTTP Logging
• Tracing
TIP: To make it easier to diagnose problems, tracing must be enabled before installing ARR.
• The ARR and URL Rewrite modules only install their trace providers if those IIS features are already
enabled. You can install them later by enabling the IIS HTTP Logging and Tracing features and
reinstalling or repairing ARR.
• Tracing is disabled by default.
b) Install the IIS ARR 2.5 (or later) module from http://www.iis.net/download/ApplicationRequestRouting.
c) In the Install window, click Options.
| Getting Started | 47
d) In the Change Options window, when asked which web server you want to use, click the IIS check box.
e) Click OK, and then click Install.
NOTE: The URL Rewrite 2.0 module installs automatically.
f) Start the Internet Information Services (IIS) Manager application.
1. From the Start menu click Administrative Tools > Internet Information Services (IIS) Manager.
g) Enable the server to act as a proxy.
NOTE: This is a server-wide setting.
1. From the Connections panel, select the server you want to configure.
2. From the IIS section in the central panel, double-click Application Request Routing Cache.
3. From the Actions panel, in the Proxy section, click Server Proxy Settings. Application Request
Routing opens in the central panel.
4. Select the Enable proxy check box, and then in the Actions panel, click Apply.
2. Configuration
The URL Rewrite rules apply to a single web site. These instructions and rules assume that your server already
is configured with a web site, such as Default Web Site, with an HTTPS binding on port 443 that uses a
certificate that is trusted by the client machines.
a) In the Internet Information Services (IIS) Manager, in the Connections panel, under the server you are
currently configuring, expand the Sites node, and then select the web site that you want to configure.
b) From the Actions panel, click Explore to open Windows Explorer to the physical directory on disk for your
web site.
1. The default location for Default Web Site is C:\inetpub\wwwroot.
2. In this location, you see a file named web.config.
c) Open another Windows Explorer window and navigate to your Proficy Workflow installation directory.
• On 32-bit systems, the default location is C:\Program Files\Proficy\Proficy Workflow.
• On 64-bit systems, the default location is C:\Program Files (x86)\Proficy\Proficy Workflow.
d) In the Proficy Workflow installation directory, go to the folder Reverse Proxy Config (IIS) for the reverse
proxy configuration files.
1. From the Reverse Proxy Config (IIS) directory, copy the following files to your web site's directory:
• rewriteMaps.config
• rules.config
• outboundRules.config
2. For a sample of the web.config showing how to configure the <rewrite> element under
<system.webServer>, go to the Reverse Proxy Config (IIS) directory. If your web site's web.config has:
• no customization, you can overwrite the file with the sample
• some customization but no rewrite rules, you can copy the <rewrite> element from the sample and
add it as a child of the <system.webServer> element in your web site's web.config
• rewrite rules already configured, you must merge the existing rules and the rules provided for the
reverse proxy manually
e) Update the rewrite.Maps.config file with the actual server names, as follows:
1. In the Internet Information Services (IIS) Manager, in the Connections panel, under the server you are
currently configuring, expand the Sites node, and then select the web site whose rewriteMaps.config
file you want to update.
2. Double-click the URL Rewrite icon.
3. From the Actions panel, click View Rewrite Maps. URL Rewrite Maps opens in the central panel.
4. Double-click ComputerNames. Edit Rewrite Map opens in the central panel.
5. From the Original Value column, select a server, and then from the Actions panel, click Edit Mapping
Entry. The Edit Mapping Entry dialog box appears.
| Getting Started | 48
6. In the New Value field, enter the actual server name, as follows:
• For the WebServerHostName, enter the fully qualified name of the computer where your Web Task
List is installed.
• For all other server values, enter the fully qualified name of the computer where your servers are
installed.
7. Repeat steps 2.e.v on page 47 and 2.e.vi on page 48 for each server listed in the Edit Rewrite
Map panel.
Configure an Apache reverse proxy for the Web Task List
The information provided in this section is specific to configuring Apache to act as a reverse proxy.
To perform this configuration, you must already be familiar with Apache.
NOTE: This procedure assumes that the Proficy SOA Server and Workflow are co-resident on the same host.
1. Enable these modules in httpd.conf:
• mod_proxy
• mod_proxy_http
• mod_substitute
2. Add the rules from the Inbound Rules section to httpd.conf.
3. Add the rules from the Outbound Rules section to httpd.conf.
Inbound and Outbound Rules for Apache
Follow these rules when configuring an Apache reverse proxy for the Web Task List.
Inbound Rules
SSLProxyEngine On:
ProxyPass /Proficy/
http://
YourSOAWorkflow.company.com:8020/
Proficy/
ProxyPassReverse /Proficy/
http://
YourSOAWorkflow.company.com:8020/
Proficy/
ProxyPass
/proficy/
http://
YourSOAWorkflow.company.com:8020/
Proficy/
ProxyPassReverse
/proficy/
http://
YourSOAWorkflow.company.com:8020/
Proficy/
ProxyPass
/ProficySTS/
https://
YourSOAWorkflow.company.com:8012/
ProficySTS/
ProxyPassReverse
/ProficySTS/
https://
YourSOAWorkflow.company.com:8012/
ProficySTS/
ProxyPass
/SOAServer/SOAProject/
https://
YourSOAWorkflow.company.com:8203/
SOAServer/SOAProject/
| Getting Started | 49
SSLProxyEngine On:
ProxyPassReverse
/SOAServer/SOAProject/
https://
YourSOAWorkflow.company.com:8203/
SOAServer/SOAProject/
ProxyPass
/SOAServer/System/
http://
YourSOAWorkflow.company.com:8020/
SOAServer/system/
ProxyPassReverse
/SOAServer/System/
http://
YourSOAWorkflow.company.com:8020/
SOAServer/system/
ProxyPass
/WorkflowServer/
https://
YourSOAWorkflow.company.com:8203/
WorkflowServer/
ProxyPass
/WorkflowServer/
https://
YourSOAWorkflow.company.com:8203/
WorkflowServer/
Outbound Rules
AddOutputFilterByType SUBSTITUTE text/xml
SUBSTITUTE "s|<SOAServerName>.*</SOAServerName>|
<SOAServerName>YourApacheServer.company.com</
SOAServerName>|i"
SUBSTITUTE "s|<StsServiceName>.*</StsServiceName>|
<StsServiceName>YourApacheServer.company.com</
StsServiceName>|i"
SUBSTITUTE
"s|<StsSecurePort>.*</StsSecurePort>|
<StsSecurePort>443</StsSecurePort>|i"
SUBSTITUTE
"s|<HttpsSamlPort>.*</HttpsSamlPort>|
<HttpsSamlPort>443</HttpsSamlPort>|i"
SUBSTITUTE
"s|<WorkflowServerName>.*</WorkflowServerName>|
<WorkflowServerName>YourApacheServer.company.com</
WorkflowServerName>|i"
SUBSTITUTE
"s|<WorkflowSamlPort>.*</WorkflowSamlPort>|
<WorkflowSamlPort>443</WorkflowSamlPort>|i"
SUBSTITUTE
"s|<HttpPort>.*</HttpPort>|<HttpPort>443</HttpPort>|
i"
SUBSTITUTE
"s|(.*)<a:anyURI>.*:.*?/(.*)</a:anyURI>(.*)|
$1<a:anyURI>https://YourApacheServer.company.com:443/
$2</a:anyURI>$3|i"
Connect to the Web Task List
The information in this section guides you through the process of connecting to the Web Task List.
You can configure and use a dedicated reverse proxy for increased security when using the Web Task List over
the Internet.
TIP: To improve performance, ensure that caching is enabled in Internet Explorer.
| Getting Started | 50
When the Full Server installation and reverse proxy configuration have been completed, the Web Task List
can be accessed using the following URLs.
Web Server
URL
IIS Reverse Proxy
https://myiisserver.example.com/Proficy/Workflow/
WebTaskList.html
NOTE: Assumes reverse proxy IIS web
server is externally accessible via host name
myiisserver.example.com with an SSL certificate
specifying that host name listening on standard port
443 (default).
Apache Reverse Proxy
https://myapacheserver.example.com/Proficy/
Workflow/WebTaskList.html
NOTE: Assumes reverse proxy Apache web
server is externally accessible via host name
myapacheserver.example.com with an SSL
certificate specifying that host name listening on
standard port 443 (default).
Direct
http://mysoaserver:8020/Proficy/Workflow/
WebTaskList.html
On the Full Server machine, a link to this URL is
available from: Start menu > Proficy > Proficy
Workflow > Task Lists > Web Task List.
NOTE: The direct link is for intranet and testing
only. We recommend using reverse proxy to use the
Web Task List over the Internet to limit exposure to
internal machines and services as part of a secure
architecture.
Assumes Proficy Workflow server is internally
accessible via host name mysoaserver with an
SSL certificate specifying that host name listening
on standard port 8203 (default). A certificate is
configured like this by default during a standard Full
Server installation. The machine must also install the
ProficySTS security certificate.
Certificates
The machine running the Web Task List must trust the SSL certificates used by the server. If the SSL certificate is
signed by a trusted root certificate authority (CA), then the client (that is, the Web Task List) machine must trust
the signing CA by adding it to the Trusted Root Certificate Authority certificate store for the machine.
NOTE: SSL certificates purchased from a reputable certificate authority will already be trusted.
For a direct connection, the Web Task List machine must also install the ProficySTS security certificate into the
Personal certificate store for the machine.
For a reverse proxy configuration, the web server must trust the signing CA by adding it to the Trusted Root
Certificate Authority certificate store for the machine. The Web Task List machine only needs to trust the SSL
certificate for the web server and does not need to trust the SSL certificate used by the Proficy Workflow server
of the ProficySTS security certificate.
| Getting Started | 51
Log-in Overview
After installing Proficy Workflow, the primary administrator user configured during installation can manually log
in to the program and configure system security. As part of this process, additional users are specified and log in
mode and authentication method are established.
Available log-in modes are manual and automatic; available authentication methods are Proficy, Windows, and
SSO (GE Single Sign on).
Log in to Proficy Workflow
Proficy Workflow provides two methods of logging in: automatic and manual. This procedure outlines the steps
to manually log in to the system.
In order to log in to Proficy Workflow, the system must be in a state of either Complete or Partial health. For more
information, see System Health and Program Use on page 59.
1. Use one of the following methods to log in to Proficy Workflow.
If...
Then do the following...
An instance of Proficy Workflow is not running on
the workstation.
1. Launch Proficy Workflow using either the Start
menu or desktop icon.
2. On the main Proficy Workflow screen, click Log in
to Proficy.
NOTE: You can also use this path if an instance
of Proficy Workflow is already running on the
workstation.
An instance of Proficy Workflow is running on the
workstation.
1. On the Proficy Workflow toolbar, click New
Session.
The Proficy Workflow Login dialog box appears.
2. If the login dialog box displays Authentication Type options, select the option applicable to your user profile.
Select...
If...
Proficy Authentication
Your user profile is part of the Proficy Workflow
application.
Windows Authentication
Your user profile is part of the Windows domain.
IMPORTANT: To log in using Windows
Authentication, your server and client(s) must be on a
domain.
SSO Authentication
Your user profile is part of SSO security.
NOTE: SSO Authentication is not available if it has
not been enabled.
NOTE:
The following information applies to all regular logins except the Mobile-sized Task List:
The computer you log on to stores the authentication type in the proficyclient.exe.config file. When you
start a new client on that computer, the authentication type you selected during your previous logon is
automatically selected. However, if another user successfully logged in on that computer since your last
logon using a different authentication type, that authentication type will be selected.
| Getting Started | 52
If you attempt to log in using a different authentication type but the authentication fails, the authentication
type is not updated in the proficyclient.exe.config file.
3. In the User Name field, enter your user name.
NOTE: If you are logging in using SSO authentication, this field is labeled User ID.
4. In the Password field, enter your password.
5. If applicable, in the Domain field, enter the domain name.
NOTE: If you selected Windows Authentication, you must enter a Windows domain name in the Domain field.
The computer stores the domain name you enter in the proficyclient.exe.config file. When you start a new
client, that domain name appears in the Domain field. However, if another user successfully logged in under
a different domain since your last logon, that domain name will be displayed.
If you attempt to log in under a different domain but the authentication fails, the domain name is not updated
in the proficyclient.exe.config file.
6. Click OK.
Automatically log in to Proficy Workflow
The default method of logging in to Proficy Workflow, and the only method available immediately after a new
installation, is manually. However, the system can be configured to allow automatic login, in which case the
steps for logging in are those outlined in this procedure.
In order to log in to Proficy Workflow, the system must be in a state of either Complete or Partial health. For more
information, see System Health and Program Use on page 59.
1. Launch Proficy Workflow.
If autologin is enabled and configured, the user credentials are authenticated and the Proficy Workflow client
appears.
2. If applicable, launch additional sessions of Proficy Workflow.
3. If you log out of any session for any reason, the Login dialog box appears. Click Autologin to log in again with
the autologin (or Windows) credentials.
GE Single Sign On (SSO)
You can configure Proficy Workflow to use GE Single Sign On (SSO) authentication when your users log on to the
Proficy Workflow client.
NOTE: GE Single Sign On applies only to GE businesses.
Within GE, all employees are assigned an SSO ID that grants them access to internal GE web pages and
resources. When Proficy Workflow is installed within a GE business, you have the option to enable SSO
authentication, so that users enter their SSO ID and password to access the system.
NOTE: In order to log in to Proficy Workflow, the system must be in a state of either Complete or Partial health.
For more information, see System Health and Program Use on page 59.
Configuration Settings
GE SSO authentication can be configured during the installation process, or at any time after installation using
the Configure Security tool.
When setting up SSO authentication, you must configure the SSO server and SiteMinder Agent URLs. Each
GE business has SiteMinder installed to protect resources on its own web server. SiteMinder Agent provides
authentication for all web-based applications. The Proficy SOA Server must be able to access this web server in
order to authenticate SSO credentials. User information is retrieved from the SSO Server.
A file named Headers.asp is included with the Proficy Workflow installation. Its location is: C:\Program Files
\Proficy\Proficy Workflow\Programs. This file must be hosted on the SiteMinder Agent web server, and then the
SSO security group must protect the file under SiteMinder.
| Getting Started | 53
The Proficy SOA Server makes a request to Headers.asp to get information about the SSO user who is trying to
log in. The following table lists and describes the returned header information.
Header
Description
HTTP_SM_USER
The SSO ID of the user
HTTP_GIVENNAME
First name of the SSO User
HTTP_SN
Last name of the SSO User
HTTP_GESSOSTATUS
Status of the SSO account
HTTP_MAIL
E-mail address of the SSO User
When the GE SSO security group sets up Headers.asp, they must make sure that these headers are included in
the response.
User Account Setup
After you configure your system for SSO authentication, you can manually set up each user's account to link to
their SSO account. The account login name must be the user's SSO ID.
You can also use the SSO Authentication Failed event to schedule a workflow that will create a Proficy user
account. That is, if a user with a valid SSO ID but no Proficy user account tries to log in to Proficy Workflow,
the SSO Authentication Failed event is triggered and causes the Proficy user account to be created. The SSO
Authentication Failed event contains the user's SSO ID, full name, and e-mail address.
IMPORTANT: Make sure that each user belongs to the SSO Users group before creating their SSO user account.
The SSO Users group is a default security group located within the Personnel model.
Key Concepts
Proficy Workflow—Powered by Proficy SOA is a unifying architecture for our software products, and a framework
to leverage existing applications and functionality. The role of Proficy Workflow is to provide the components and
services which, when adopted by a product line, drives common operational behavior and support.
Proficy Workflow implements the S95 standard, giving you a flexible, standards-based foundation for building
applications and interfacing with other software.
Proficy Workflow contains the tools you need to create applications that can be used to facilitate the
management and analysis of activities in your enterprise. Proficy Workflow provides a customizable environment
that can:
•
•
•
•
host editors for building Proficy applications
display HMI screens for monitoring plant activities
display workflow tasks to operators on the plant floor
accept input into forms that can be created and routed to clients throughout the enterprise
Proficy Workflow also provides a configurable event engine that can trigger workflows and other code based on
different types of internal and external triggers.
The Client
The Proficy Workflow client provides a customizable environment for using various views and displays to access
and use your data. Access to specific views and displays is determined by the permissions assigned to you or
any group you are a member of.
The Proficy Workflow client:
• Provides you with a command center for interfacing to Proficy applications and third-party legacy systems.
| Getting Started | 54
• Provides you with a single solution-centered environment that allows you to link all aspects of the plant floor,
from operations to analytics.
• Allows you to customize the environment, tailoring it to your specific needs.
The diagram displays the main components of Proficy Workflow. The table following describes these
components.
Figure 5: Proficy client
Cross Reference
Description
Menu bar: includes access to product information,
Help Menu, Client layout modes, Global Displays, Task
List, login/logout, site health status.
Models list: Production, Material, Equipment,
Personnel, Events, Workflows, Global Displays, Proficy
System.
Resource type list: includes all the types that you can
add a resource to.
Resources: includes all the resources that you have
added to the model.
| Getting Started | 55
Cross Reference
Description
Navigator: includes all the information related to your
input, such as the ability to locate, add, delete, and
duplicate resources.
Compatible view: displays information on the model
that has been selected in the Navigator.
Display panel: displays compatible options for viewing
and working with the selected resource.
Workspace: displays information related to the
selected resource after an appropriate view, such as
an editor, has been selected.
Information bar: includes warnings and the Feedback
Zone.
The Feedback Zone
The Feedback Zone is a tool that displays error and informational messages about the currently executing
process or the operation last performed. Various components that are hosted within Proficy Workflow can also
post messages about the results of operations and tasks in the Feedback Zone.
For more information, see Feedback Zone.
Models
In Proficy Workflow, models are used to define and organize system and application information. A model is a
representation of a physical structure or conceptual idea and is composed of objects that have hierarchical or
other relationships between them. Rules or schemas outlining object nesting, order, number, and requirement
define the structure of a model.
Production and manufacturing models are used to represent your production or manufacturing organization
and operation. Based on the industry standard ISA-95, these models define basic structure rules and object
relationships.
Production models use properties that can define classes, definitions, and specifications. When you create
your production or manufacturing structure and object relationships, the properties, classes, definitions, and
specifications are used to define your processes and can be inherited by another object as a result of direct
associations.
For more information, see Material Model, Equipment Model, Proficy Users and Groups, Production Model, and
Events Model.
Display Panel
Proficy Workflow uses displays to organize editors and resource information into relevant groupings that make
it easy to select, view, and configure resources. You can view and configure model resources within Proficy
Workflow.
When you navigate to a resource, you are automatically shown the compatible displays of the resource you are
viewing. The icons related to these displays turn green when they are compatible.
For more information, see Displays Panel.
Security
Security configuration and maintenance is performed by Proficy Workflow system administrators.
In some companies, access to the production configuration and management environment is available to
everyone. In such an environment, changes to the data files and access to files and applications are not critical
| Getting Started | 56
to the process. However, in other companies, these applications and data are critical to the process and, thus,
available only to authorized personnel.
For more information, see Proficy Workflow Security and Proficy Users and Groups.
Data Sources
Proficy Workflow provides the ability to connect to external data sources to access the data contained within
those applications.
When these data sources are configured, their data (for example, tags, displays, SQL statements) are used to
bind to data items in equipment, workflows, and condition events. The available data sources and their uses are
as follows:
• The Proficy Historian data source allows you to connect to Historian servers to read from and write to
Historian data tags. You add Historian tags to Proficy Workflow and then use those tags as data sources
throughout Proficy Workflow.
• The Proficy Portal data source allows you to connect to Portal servers through Proficy Workflow. Portal
servers allow you to read from and write to iFIX and OPC data items, and execute Portal SQL statements. The
Portal server makes its displays available, which you can select and view using the Global Viewer, based on
user credentials.
• An OPC client provides direct access to data served by OPC Data Access (DA) servers without relying on
Proficy Historian or Proficy Portal as a bridge between an OPC server and Proficy Workflow.
The Data Source Editor is used to select the data tags and other data items to be used when configuring data
items, as well as when configuring connections to Proficy Portal servers, Proficy Historian servers, and OPC
Clients.
NOTE:
• You can add up to 3,000 data items from each data source you connect to.
• The Portal and/or Historian server you want to connect to must be on the same network domain or
workgroup as the Proficy Workflow server.
• You can configure each Historian and Portal server only once.
For information on working with data items, see Data Items.
NOTE: The Proficy Portal installation CD is included with the Proficy Workflow installation package. For
information about Proficy Portal, see the Proficy Portal Real-Time Information Portal Getting Started guide and
the Proficy Real-Time Information Portal online help.
Forms and User Display Designer
The Designer is a graphical design application that allows you to easily create forms and user displays and
publish them to the Proficy SOA Server where other authors can access and use them.
For more information, see Forms and User Displays Authoring Guide.
User Solutions
Proficy Workflow provides the ability to create user-defined solutions. User solutions provide a way to organize
the user displays that you create.
User solutions are displayed in the solution panel as separate and distinct solutions. When you create a user
solution, it automatically appears in the solution panel.
For more information, see User Solutions and User Display Context Awareness.
| Getting Started | 57
Integrated Products–Workflow
Proficy Workflow is a user-configurable, dynamic, decision-making engine for integrating automated and
manual business and production processes across system and departmental boundaries—promoting reliable,
repeatable process execution.
Proficy Workflow consists of a workflow execution engine, which is the core component of Proficy Workflow's
process management system. The engine is responsible for interpreting workflows, controlling multiple workflow
instances, and sequencing subprocesses and activities.
Workflows consist of programs that can carry out complex activities, respond to events and data changes, and
write values back out to the Proficy data models or through external connectors.
For more information, see Workflow Foundations.
Task List Controls
Workflow task controls can be integrated into existing HMI applications, such as Proficy HMI/SCADA CIMPLICITY
and Proficy HMI/SCADA iFIX. Workflow tasks are displayed in your application so you can operate them from
within these applications. You use the ActiveX Task List and Task Indicator controls to interact with and view
workflow tasks.
For more information, see Task Controls in Proficy HMIs on page 80.
Electronic Signatures and Audit Trails
Proficy Workflow provides the ability to electronically sign forms in the run-time environment and to create an
audit trail of those signatures, as well as audit other configuration changes made to the system.
You can use electronic signatures to create a more secure environment by requiring that operators electronically
sign for data entry changes on forms in the Task List. An electronic signature uniquely identifies the operator
making the change, and can optionally require the electronic signature of another person to verify the change.
Operators no longer need to use paper and pen to record and sign for their actions, and the possibility of losing
or damaging such records is essentially eliminated.
An audit trail is necessary for regulatory compliance, because it provides a method of recording actions that
have been performed in the Proficy Workflow system. An audit trail helps to prove that you have control of your
process and allows you to track not only what occurred, but when it occurred, and who was responsible for the
occurrence. For example, an audit trail can be used to assist with an investigation of a product discrepancy.
Proficy Workflow provides the ability to generate reports based on your audit trail and electronic signature data.
For more information, see Electronic Signatures and Audit Trails.
Supported Regional Settings
Proficy Workflow supports the following regional settings available in the Windows Control Panel.
NOTE: Proficy Open Enterprise supports the same regional settings as Proficy Workflow.
•
•
•
•
•
•
•
Decimal symbol - one character
Digit grouping symbol
List separator - one character
Time style
Time separator
Short date style
Date separator
NOTE: The decimal symbol and the digit grouping symbol cannot be the same character. Also, the time
separator and the date separator cannot be the same character.
| Getting Started | 58
Formatting the Time and Date
Avoid changing the time style or short date style in regional settings to values that are outside of the standard
styles provided. Changing these values to non-standard styles may result in improperly formatted times and
dates in some parts of Proficy Workflow.
Proficy Workflow supports the following short date formats, some of which may not be available in certain
language versions of Windows:
•
•
•
•
•
•
dd/mm/yy or dd/mm/yyyy
dd/yy/mm or dd/yyyy/mm
mm/dd/yy or mm/dd/yyyy
mm/yy/dd or mm/yyyy/dd
yy/dd/mm or yyyy/dd/mm
yy/mm/dd or yyyy/mm/dd
Formatting the Regional Language Setting
Avoid changing the language setting when Proficy Workflow is running.
Setting the System Default Locale
The selected locale must be set as the system default.
Daylight Saving Time
In Proficy Workflow, all dates and times are stored independent of time zones, in UTC format.
NOTE: Because UTC has no daylight saving time adjustment, recurring events that are configured with a First
Occurrence Date that falls during daylight saving time will execute an hour earlier on the first recurrence
following the return to standard time.
For example, in New York, if you configure a recurring event with a First Occurrence Date of
10/30/2013 and an Event Time of 12:00:00, and set the Weekly Recurrence to Wednesday,
the event will execute at 12:00:00 on 10/30/2013, but at 11:00:00 on 11/6/2013. For more
information, see Calendar Event Attributes.
Special Keyboard Buttons
Some computer keyboards have special buttons for e-mail launch, Internet launch, search, and other functions.
These keyboard buttons may disable certain key macros or allow users to circumvent security measures.
We recommend that you reprogram or disable the software that operates such special buttons. Refer to your
computer's documentation for instructions on disabling these buttons.
Help
The Proficy Workflow help provides detailed information on using the software.
There are three ways to access the Proficy Workflow help:
•
Ribbon Bar: Click
• F1: Click anywhere in the Proficy client and press F1 on your keyboard.
• Program Group: From the Start menu, point to All Programs, then Proficy, then Proficy Workflow, and then
click Proficy Help.
There are several ways to use the help:
• Table of Contents: The table of contents is organized into books and pages. Click a book or page to display
its contents. Double-click a book to expand it and display the books and pages nested below it.
• Index: To access the online help index, click the Index tab in the left-hand pane.
| Getting Started | 59
In the Proficy Workflow help index, you can search for topics by keyword. Type a keyword in the box, or select
one from the list.
When you find the topic that you want, double-click it to display that topic. If more than one topic applies to
the keyword, the Topics Found dialog box appears listing all topics that apply to that keyword.
• Full-text Search: To access the online help full-text search, click the Search tab in the left-hand pane.
Use the Search tab to perform full-text searches in the help. If your search results include too many results,
you can enter additional terms to narrow down the list. Click the
search expression, such as AND, OR, NEAR, and NOT.
button to add boolean terms to your
If you want to search for a specific phrase, enclose the phrase in quotation marks.
System Oversight
Log Files
Proficy Workflow provides a number of log files that you can use to assist you in troubleshooting various aspects
of your system.
On Windows XP, all log files, regardless of the type of installation you have (that is, server, client, and so on), are
located in: ..\Documents and Settings\All Users\Application Data\Proficy\Logs.
On all other supported operating systems (Windows Vista, Windows 7, Windows Server 2008, and Windows
Server 2012) the log files are located in: C:\ProgramData\Proficy\Logs.
The log files for all installations are also accessible from the program group; that is, Start > All Programs >
Proficy > Proficy Workflow > Logs.
System Health and Program Use
As part of configuring a Proficy Workflow system, you indicate which servers should host which product
options, and designate servers and product options as either essential or nonessential. These designations in
combination with server status determine site health and affect the ability to log in and use the Proficy Workflow
program.
If you designate a server as essential when configuring the system, all associated product options are
automatically designated as essential. If you designate any product option as essential, the server that is hosting
that option is automatically designated as essential, but the essential status of other product options hosted by
the server remains unchanged.
NOTE: The server(s) hosting the Core and Workflow product options are designated as essential by default, and
this designation cannot be changed.
The designation of servers as either essential or nonessential and the state and accessibility of servers has
implications for the health of the system and, therefore, the ability to log in and use the Proficy Workflow
program, as follows:
• When all servers, both essential and nonessential, are running and reachable, system health is considered
Complete. In this scenario, the site health indicator in the toolbar is green, users can log in to the program,
and all program and product option functionality is available.
• When one or more nonessential servers are not running or are unreachable, system health is considered
Partial. In this scenario, the site health indicator in the toolbar is yellow, active users remain logged in to
the program, and inactive users can log in, but program functionality tied to product options hosted on
compromised servers is unavailable.
NOTE: Specifically, related displays become inaccessible, binding to related external data faults, and related
events stop firing. In addition, workflows that consume related data or monitor related events fail (making it
a recommended practice to wrap such operations in fault handlers). Upon restoration of server availability,
display inaccessibility and data-binding, event-firing, and workflow failure are automatically reversed.
| Getting Started | 60
However, any work that was being performed using a display when a related server became unavailable may
be lost.
• When one or more essential servers that do not host the Core product option are not running or are
unreachable, system health is considered Waiting. In this scenario, the site health indicator in the toolbar is
yellow, active users are logged out of the program, and inactive users cannot log in.
NOTE: In this case, upon restoration of the essential server(s), users active at the time of interruption are
automatically logged back in to the program, and functionality is restored to the level in accordance with the
current health of the site.
• When the server that hosts the Core product option (typically, SOAServer) is not running or is unreachable,
system health is considered Unavailable. In this scenario, the site health indicator in the toolbar is gray, active
users are logged out of the program, and inactive users cannot log in.
NOTE: In this case, upon restoration of the server that hosts the Core product option, users active at the time
of interruption are automatically logged back in to the program, and functionality is restored to the level in
accordance with the current health of the site.
When system health is either Complete or Partial, you can use the System Status display to monitor server
configuration and status. In these states of site health, you can also move product options between servers to
accommodate changing conditions, as necessary.
Post-installation Configuration
The procedures in this section outline the various installation options for Proficy Workflow, Proficy Host, and the
Web Task List.
If the installation fails, or you want to change a configuration setting after installation completes, you can open
each of the installation wizard configuration pages as a standalone tool and make the required changes.
CAUTION: Changes to your installation configuration should be performed only by advanced users. If
you make changes on your own, unpredictable results and behavior may occur. Contact GE Intelligent
Platforms for assistance.
Configure web proxy settings for Local System account
Before defining a web service, you must configure web proxy settings for your Local System account based on
your network requirements.
You may not need to change your network settings.
1. Configure Internet web proxy setting using BITSAdmin in one of the following ways.
NOTE: For more information on BITSAdmin Tool, go to: http://msdn.microsoft.com/en-us/library/
aa362813%28VS.85%29.aspx
To set...
Then do this...
accounts to use a static proxy server with
exclusions
1. Execute: bitsadmin /util /setieproxy localsystem
MANUAL_PROXY proxysrv:8080 ";*. contoso.com"
2. Replace proxysrv, 8080, and contoso.com with
your organization's proxy server addresses
address, port, and exclusions.
account to use proxy.pac file
1. Execute: bitsadmin /util /setieproxy localsystem
AUTOSCRIPT http://contoso.com/proxy.pac
2. Replace proxysrv with your organization's pac file
addresses.
2. From an administrative command line window, run the commands for account you want to change.
| Getting Started | 61
Running with a Standard Windows User Account
Users who are not Proficy Workflow administrators must be given permission to access certain folders in order
to view log files and to be able to load forms.
• To provide the ability to load forms, ensure your users have permission to access C:\Program Data\Proficy
\Logs.
• To provide access to log files, ensure your users have permission to access C:\Users\<User>\My Documents
\Proficy Workflow.
When a form is opened, it is retrieved from the database and copied to the client computer to be loaded into
Proficy Workflow. If the My Documents folder is in a network storage location, that location is locked by user
permissions, preventing the form from being created.
Configure Proficy Service Security Certificates
The Configure Proficy Service Certificates tool is used to change or update the security certificates you
configured during the server installation.
For an extension server installation (that is, a multi-server or server failover cluster), you must copy the
ProficyPlatform and ProficySTS security certificates from the main server onto a disk or other portable device,
and then transfer those certificate copies to your extension server(s). The SSL/TLS Server Certificate must be
unique to each server.
1. On the server machine, click Start > All Programs > Proficy > Proficy Workflow > Configuration > Configure
Certificates.
The Configure Proficy Service Certificates page appears.
2. Select the appropriate certificate option. For full descriptions of the certificate options, see Security Certificate
Options on page 16.
3. Click Save, and then click Exit.
IMPORTANT: If you change the certificate option on your server(s), all remote clients connected to those
servers must have their security certificates updated to match the server. Use the Configure Client tool to
download the new versions of the certificates.
Modify site configuration
Using the Configure Site tool, you can modify site configuration by moving product options between servers,
deleting servers that are not hosting product options, and, beginning with Proficy Workflow 2.1, designating
whether servers or the product options that run on them are essential and/or disabling product options.
1. On the server machine, click Start > All Programs > Proficy > Proficy Workflow > Configuration > Configure
Site.
The Configure Site tool appears.
2. Modify the server configuration as required:
If you want to...
Then do this:
Designate a server or a product option as essential Select the Essential check box beside the server or
product option listing.
NOTE: Essential servers must remain running
in order for users to access the program. If you
designate a server as essential, all associated
product options are automatically designated as
essential. If you designate any product option as
essential, the server that is hosting that option is
automatically designated as essential, as indicated
by the color filling in the Essential check box, but the
essential status of other product options hosted by
the server remains unchanged.
| Getting Started | 62
If you want to...
Then do this:
Designate a server or a product option as
nonessential
Clear the Essential check box beside the server or
product option listing.
NOTE: If one or more product options assigned
to a server is designated as essential, you cannot
designate the server as nonessential. Nonessential
servers must remain running in order for the
program to be fully operational; however, if a
nonessential server stops running, users can still
access the program.
Move a product option between servers
In the Server Instances and Enabled Product
Options pane, click the product option listing, and
then do one of the following:
• Click the Move Up or Move Down button until the
listing is located below the server that you want
to host the option.
• Drag and drop it below the server that you want
to host the option.
Disable a product option
In the Server Instances and Enabled Product
Options pane, click the product option listing, and
then do one of the following:
• Click Disable.
• Drag and drop the listing to the Disabled Product
Options pane.
NOTE: Disabled product options remain installed but
are deactivated. Essential product options cannot be
disabled.
Enable a disabled product option
In the Server Instances and Enabled Product
Options pane, select the server that you want to host
the product option, and then in the Disabled Product
Options pane, click the listing for the product option
and do one of the following:
• Click Enable.
• Drag and drop the listing to the Server Instances
and Enabled Product Options pane.
Remove a server
Select Delete on save beside the server listing.
NOTE: Only servers that are not hosting product
options can be removed. To subsequently add a
server, use the Configure Server tool.
3. Click Save, and then click Exit.
The designation of servers and production options as either essential or nonessential and the state and
accessibility of servers has implications for the health of the site and, therefore, the ability to log in and use the
Proficy Workflow program. For more information, see System Health and Program Use on page 59.
| Getting Started | 63
Monitor system configuration and status
After installing Proficy Workflow, you can monitor the configuration of the system, including which servers and
product options are installed and whether those components are designated as essential. In addition, you can
ascertain the operational status of the configured servers.
1. In the navigator, click Proficy System > Proficy System.
2. In the Displays panel, click System Status.
The System Status display appears in the workspace, listing the servers configured for the site. For each
server, the display reflects whether the server is designated as essential; the essential and nonessential
product options (or services) hosted on the server, if applicable; and whether the server is Stable or
Unreachable.
NOTE: The System Status display is read-only. However, you can use the Configure Site tool to modify
system configuration, including designating whether servers or the product options that run on them are
essential, moving product options between servers, disabling product options, and/or deleting servers that
are not hosting product options.
Modify the server configuration for a remote client
Use the Proficy Workflow Server Configuration tool to synchronize any changes you may have made to the
Proficy SOA Server with remote clients.
IMPORTANT: The Proficy Workflow Server Configuration tool is available only for client-only installations.
1. On the client computer, click Start > All Programs > Proficy > Proficy Workflow > Configuration > Configure
Client.
The Proficy Workflow Server Configuration tool appears.
2. Optional: In the Server Computer Name field, enter the name of the computer where the server you want to
connect to is installed.
• If you are configuring a full server, legacy server, or multi-server environment, enter the name of the
computer that the server you want to connect to is installed on.
• If you are configuring a server cluster environment, enter the cluster name used when you set up your
cluster.
3. Optional: In the Server Instance Name field, enter the name of the server instance you want to connect to.
4. Optional: In the Server HTTP Port field, enter the port number required to allow communication with the
server.
5. Click Save, and then click Exit.
Modify the Microsoft Active Directory Services
The Configure AD LDS Integration tool provides the ability to configure Active Directory Lightweight Directory
Service for your production environment.
1. On the server machine, click Start > All Programs > Proficy > Proficy Workflow > Configuration > Configure
Directory Services.
The Configure AD LDS Integration page appears.
2. In the Configure AD LDS Integration page, do one of the following:
• If Active Directory Lightweight Directory Services (AD LDS) is not installed, the Configure AD LDS
Integration page displays a message regarding its use. If AD LDS is not required, click Save.
• If Active Directory Lightweight Directory Services (AD LDS) is installed, but this installation is to be used in a
test and/or development server environment, select the Do not use Microsoft Directory Services check
box, and then click Save.
• If this installation is to be used in a production environment, skip to the next step.
3. For a production environment, perform the following procedure.
a) Clear the Do not use AD LDS check box.
| Getting Started | 64
b) In the Directory Instance: Name field, enter an instance name for the ADAM directory.
c) In the Port (LDAP) and Port (SSL) fields, enter valid port numbers.
d) In the User Credentials: Name field, enter the name of a user that is a member of the local computer's
Administrators Group.
e) In the User Credentials: Domain field, enter the name of your company's domain.
f) In the User Credentials: Password field, enter the password for the user you entered in the Name field.
4. Click Save, and then click Exit.
Modify the SQL server
The Configure Database tool provides the ability to make changes to your SQL Server database, as well as
change the database you want to connect to.
You must install SQL Server 2012 or SQL Server 2008 before you install Proficy Workflow. For more information,
see Software Requirements on page 8.
®
In order for Proficy Workflow to connect to any edition of Microsoft SQL Server 2012, you must configure
SQL Server to enable the sysadmin role for the applicable login account. For more information, see Enable
Connection between Proficy Workflow and SQL Server 2012 on page 24.
The Proficy Workflow installation automatically selects the default SQL Server instance. If SQL Server 2012 and
SQL Server 2008 are both installed, SQL Server 2008 may be the default instance. In this scenario, if you want to
use SQL Server 2012 instead, you must select this instance as the default as part of manually configuring your
SQL Server settings. For instructions, see steps 2 on page 64 and 3 on page 64 of this procedure.
1. Click Start > All Programs > Proficy > Proficy Workflow > Configuration > Configure Database.
The Configure SQL Server page appears.
2. Automatically or manually specify your SQL Server to be used with Proficy Workflow based on the
configuration of your environment, as follows:
• If your SQL Server is installed locally, and is designated as the default Local Host, and uses Windows
Authentication, select the Use a local SQL database with Windows Authentication check box to
automatically configure your SQL Server settings accordingly. Proceed to step 4 on page 64.
• If your SQL Server is not installed locally, or is not designated as the Local Host, or uses SQL
Authentication, clear the Use a local SQL database with Windows Authentication check box to manually
configure your SQL Server settings. Proceed to step 3 on page 64.
3. Specify your SQL Server settings, as follows:
a) In the Server field, enter or select the name of the SQL Server you want to connect to.
NOTE: If the SQL Server is installed locally, enter localhost.
b) In the Database field, enter the name of the SQL database, or click the drop-down arrow to search for all
databases located on the specified server.
NOTE: If the specified database does not exist, it will be created for you.
c) From the Authentication list, select the type of authentication you want to use, and then proceed based
on your selection.
• If you select Windows Authentication, proceed to step 4 on page 64.
• If you select SQL Authentication, proceed to step 3.d on page 64.
d) Enter the User Name and Password that are configured for SQL Authentication, and then proceed to step
4 on page 64.
4. Click Save, and then click Exit.
Configure a server instance
The Configure Server tool is used to create a Proficy SOA Server instance, as well as to configure server
clustering.
| Getting Started | 65
NOTE: If you are configuring servers for clustering, you must ensure that you run this tool on all nodes of the
cluster.
1. On the server machine, click Start > All Programs > Proficy > Proficy Workflow > Configuration > Configure
Server.
2. Select the Create a Proficy SOA Server Instance option.
3. In the Name field, enter a name for the server instance.
4. Optional: In the Description field, enter a description for the server instance.
5. Click the Advanced Configuration arrow.
6. Select or clear the Do not create Windows Service for this Server Instance check box, depending on
whether you want this server instance to run as a Windows service.
7. If you are configuring the server instance to run as a Windows service, and the architecture of the computer
you are configuring the instance on is 64-bit, configure the Run service under the following architecture
setting to indicate your preference for operational mode as either 32 bit or 64 bit.
8. In the Service Ports fields, enter the port numbers for each of the service port types.
9. In the IP Address field, enter the IP address of the server instance.
10. In the Port field, enter the port number for the server instance.
11. Click Save, and then click Exit.
Configure product options
Using the Configure Product Options tool, you can install and configure Proficy product options that you license
and/or service providers that you have created .
Proficy SOA services must be stopped on the server prior to configuring product options.
If you have created and packaged your service provider, you must copy it to an accessible location.
NOTE: Refer to Architecture Considerations on page 14 for guidelines on deploying service providers based
on architecture mode.
IMPORTANT: Product Options Installation Information. When using the ActiveX Task List, product option updates
made on the server are not automatically deployed to applications using the Task List. The ProficyUpdater.exe
application must be run manually, with administrative privileges, in order to deploy production option updates on
each client machine using ActiveX Task List.
Install one of the following server types:
1. On the server machine, click Start > All Programs > Proficy > Proficy Workflow > Configuration > Configure
Product Options.
The Configure Product Options tool appears, displaying the product options currently configured on the
server, including those included by default as part of the server installation.
2. Proceed as applicable based on whether you are installing or uninstalling a product option:
If you are...
Then do this...
Installing a product option.
1. Click Install.
Windows Explorer opens at the ProductOptions
folder within the Proficy Workflow installation
directory.
2. Proceed to step 3 on page 65.
Uninstalling a product option.
1. Select the product option you want to uninstall.
2. Click Uninstall.
NOTE: You cannot uninstall the default product
options that are included in the server installation. 3. Proceed to step 8 on page 66.
3. Select the product option file you want to install, and then click Open.
| Getting Started | 66
NOTE: You can select only one product option at a time to install.
The product option is installed, and then the Configure Site dialog box appears.
4. In the Server Instances and Enabled Product Options pane, select the server that you want to host the
product option.
5. In the Disabled Product Options pane, click the listing for the product option, and then do one of the
following:
• Click Enable.
• Drag and drop the listing to the Server Instances and Enabled Product Options pane.
6. Indicate whether the product option is essential by selecting or clearing the Essential check box.
7. Click Save.
8. Click Exit.
Change architecture mode
When initially installing a Proficy SOA Server or extension server (that is, Workflow or User) on a 64-bit computer,
you can elect to run the server in either 32-bit or 64-bit mode. If your environment changes subsequent to
installation, you can use the Configure Server tool to change the architecture mode accordingly.
1. On the machine that the server is installed on, click Start > All Programs > Proficy > Proficy Workflow >
Configuration > Configure Server.
The Configure Server Instance tool appears.
2. Select the Create a Proficy SOA Server Instance option.
3. Click the Advanced Configuration arrow.
4. In the Run service under the following architecture section, select 32 bit or 64 bit to indicate the operational
mode you want to switch to.
5. Click Save, and then click Exit.
Remove a Proficy Host instance
Use this procedure to remove a Proficy host instance from the Proficy Host configuration tool.
1. Click Start > All Programs > Proficy > Proficy Workflow > Configuration > Configure Host.
The Configure Proficy Host wizard appears.
2. Click Remove Host Instance.
The Remove Proficy Host Instance page appears.
3. Select the Proficy Host instance you want to remove, and then click Remove.
The selected Proficy Host instance is removed.
4. When the installation is complete, click Exit.
Add or remove performance counters
Using this procedure, you can manually add performance counters to your system, or remove them. You must
have administrative privileges in order to perform this action.
1. From the following location, you can add or remove performance counters: <installfolder>/ProficyServer.exe.
2. In ProficyServer.exe, enter the applicable command line.
To...
Enter...
Add counters
<installfolder>ProficyServer[exe] /
installperformancounters
Remove counters
<installfolder>ProficyServer[exe] /
uninstallperformancounters
| Getting Started | 67
IMPORTANT: If the counters are added/deleted (installed/uninstalled) after the server is started, then the
server and the performance monitoring tool (perfmon) must be re-started for this change to take effect.
Uninstall the Proficy Host / Embeddable Proficy Host
Use this procedure to uninstall the Proficy Host.
1. From Control Panel, click Add or Remove Programs.
The Add or Remove Programs dialog box appears, displaying all of the programs installed on the computer.
2. Select Proficy Host / Embeddable Proficy Host, and then click Remove.
3. In the confirmation message box, click Yes.
Upgrading Proficy Workflow
You can upgrade Proficy Workflow without having to uninstall the program.
IMPORTANT: When you upgrade a Proficy server, you must also upgrade all of the remote Proficy clients that
connect to that server to use the same version of Proficy Workflow.
The following upgrade paths are supported:
• Upgrade from Proficy Workflow 2.1 to Proficy Workflow 2.2 service pack 1 (SP1)
• Upgrade from Proficy Workflow 2.0 to Proficy Workflow 2.2 SP1
• Upgrade from Proficy Workflow 1.5 service pack 4 (SP4) to Proficy Workflow 2.2 SP1
NOTE: You must first upgrade Proficy Workflow 1.5 SP4 to Proficy Workflow 2.0.
If you are upgrading from an earlier version of Proficy Workflow, please contact support.
Upgrading Web-based Forms for the Task List
If you have web-based forms as part of an existing workflow that you have created prior to the release of Proficy
Workflow 2.2 SP1, you must bind them again inside the Form activity in order for them to function in the Task List.
NOTE: This upgrading issue affects existing web-based forms only, and not HTML5 web forms that are created
in Proficy Workflow 2.2 SP1.
Upgrading a Clustered Environment
After upgrading Proficy Workflow on the primary server machine, you must reconfigure that machine as the
primary server in the cluster, as well as reconfigure the failover server in the cluster.
Password Security
During an upgrade installation, the account lockout capability is automatically enabled; all other password
security features are disabled, by default. To enable any of the other password security features, you must use
the Configure Security tool after the upgrade installation has successfully completed.
Windows Users
Proficy Workflow 2.0 supports Windows domain names with personnel names and login names. If you choose
to use the new functionality included with Proficy Workflow 2.0 (that is, Active Directory Universal Groups
mapped to Proficy groups), then when your Windows users log in, their personnel name and login name will
both be updated to include the domain name, and the personnel name will change to match the login name.
For example, the personnel name John Smith and login name johnsmith will both change to <domain name>
\johnsmith.
| Getting Started | 68
WARNING: If you were using Windows user accounts in a prior version of Proficy Workflow, any
workflows that reference individual users will no longer work! These personnel names will NOT be
updated when the Windows users log in. You must manually change these names to include the domain
name with a back slash character between the domain name and personnel name. However, if you
reference personnel classes in your workflows, no change is required; the workflows will work as they did
in the previous version of Proficy Workflow.
Upgrade to a newer version of Proficy Workflow
This procedure describes how to upgrade your version of Proficy Workflow without uninstalling the previous
version.
1. Place the installation DVD in the DVD drive. If you have Autoplay enabled, the installation launcher splash
screen appears.
NOTE: If it does not appear, run InstallFrontEnd.exe on the root directory of the Proficy Workflow DVD.
2. Click Install Proficy Workflow.
The License Agreement page appears.
3. Review the license agreement, and then click I Agree.
The Proficy Upgrade page appears.
4. Optional: Select one or more of the following install options:
• Skip the SQL Server database backup. If you want a backup of your database and have not performed
your own backup, select this option.
• Set up the server to run in legacy mode. If you select this option, legacy host servers, such as Plant
Applications and Proficy Host, can be configured to connect to the existing server.
5. Click Install.
The Installing Proficy Workflow page appears, displaying the status of each installation step.
6. When the installation is complete, click Exit.
NOTE: If the installation fails, or you want to change a configuration setting after installation completes,
you can open the appropriate standalone component to configure the required information. For more
information, see Post-installation Configuration on page 60.
Upgrade custom forms
Before upgrading and starting the Proficy Workflow 1.2 or 1.5 server, ensure that all of your custom form DLLs
are located in the following directory: ..\Data\AllUsers\Displays.
If you added forms or user displays using Proficy Workflow 1.0 or 1.01, and those forms had dependencies on
any Proficy assemblies, there are additional steps for upgrading.
For each form or user display in the system, do the following:
1. Check for errors.
• In the navigator, select the form or user display, and then click Global Viewer. If additional upgrade steps
are required, an error displays in the Feedback Zone, indicating that the existing item could not be loaded.
NOTE: If you are using GEFanuc.Platform.FormsLibrary.dll, skip to step 3 and use the new file,
Proficy.Platform.FormsLibrary.dll, found in the Program folder in the install directory.
2. Update the project.
a) In Visual Studio, open the source code project you originally used to build the custom form.
NOTE: This source code should be found somewhere on your system; it is not persisted in the Proficy
Workflow database.
b) Update references to GEFanuc assemblies.
View the project's references to see the list of assemblies it is dependent upon.
| Getting Started | 69
NOTE: Since Proficy Workflow version 1.01, the Proficy assemblies have been renamed from
GEFanuc.*.dll to Proficy.*.dll; therefore, any references to assemblies named GEFanuc.* must be
removed and re-added to point to the renamed assembly. For example, if the project previously
referenced GEFanuc.Platform.Core.DisplayFramework.dll, then the project must be updated to reference
Proficy.Platform.Core.DisplayFramework.dll.
c) Update references to GEFanuc namespaces.
• The namespaces have also been changed from GEFanuc.* to Proficy.*. Therefore, any other references
to GEFanuc in your project must also be changed to Proficy.
3. Build the project.
• Build your project and continue fixing errors until you have a successful build.
4. Save your changes.
In the Proficy client, select the form or user display in the navigator and open it in the Display Editor. An error
may display indicating that the assembly or class is invalid. If the error displays, do the following:
a) In the .NET Assembly field, browse to the updated version of the assembly you want to use for the form.
b) In the Class Name field, select the appropriate class name to use.
c) Click Save to save your changes to the server and make the form available to other clients.
5. Validate the form.
• Open the form in the Global Viewer or run it in a workflow to ensure the form works as expected.
Database Migration
If you have created your Proficy Workflow database in a development or test environment, you can migrate your
database to another environment without having to import or recreate all of the data.
IMPORTANT: This information is intended for advanced users only. If you are unsure of the steps to proceed,
contact GE Intelligent Platforms Technical Support.
You must be familiar with backing up and restoring databases in order to successfully migrate your Proficy
Workflow database from one SQL Server environment to another.
Custom Workflow Activities and Service Provider Dependencies
If you have custom workflow activities or dependencies for custom service providers that are not packaged with
the service provider, you must copy and move those files manually from the source SOA Server machine to the
destination SOA Server machine.
Single Server and Multi-server Environments
If you are moving from a multi-server environment to a single server environment, you can remove the extra
sites when you run the Configure Site tool. If you are moving from a single server environment to a multi-server
environment, there are extra steps to configure the sites. For more information, see Configure Site.
Move a Proficy Workflow database
You can move a SQL Server database from one machine to another to allow you to use the same data in another
environment, such as moving from a development environment to a test environment.
• The version of Proficy Workflow must be the same on both the source machine and the destination machine.
• All of the associated software that is installed on the source machine must also be installed on the
destination machine (for example, Proficy Plant Applications, Proficy Historian, and so on).
• You must be familiar with backing up and restoring SQL databases in order to successfully migrate your
Proficy Workflow database from one environment to another.
| Getting Started | 70
1. On the source SQL Server machine, make a backup copy of the database to either a network drive or a
portable device, such as a CD.
2. On the destination SQL Server machine, restore the database in SQL Server.
NOTE: The remaining steps are performed on the destination SOA Server machine; that is, the machine that
hosts the SOAServer that will point to and use the database on the destination SQL Server machine.
3. On the SOA Server machine, run the Configure Database tool, and then click Save.
4. On the SOA Server machine, run the Configure Server tool, and then click Save.
5. On the SOA Server machine, run the Configure Site tool to ensure that all of your extension servers and
product options are configured correctly, and then click Save.
6. On the SOA Server machine, run the Configure Directory Services tool, and then click Save.
7. Start the Proficy services.
Proficy Real-Time Information Portal
The Proficy SOA Server provides the ability to connect to Proficy Real-Time Information Portal and view displays
created there.
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.
Proficy Portal 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.
Proficy Portal also integrates with the Proficy SOA Server. From Proficy SOA, you can connect directly to your
Proficy Portal server to view and use your Portal displays and to retrieve data tags.
NOTE:
• Proficy Workflow supports Proficy Portal v3.0 only, with SP1 or the SIMs that are included on the installation
DVD. You must install the Proficy Portal SIMs or SP1, which are included on the installation CD, in order to use
Proficy Portal with Proficy Workflow.
• To connect to and view Proficy Portal displays, you must install Java Run-time v6.0 or greater. This plugin
must be installed on all client computers that will use Portal displays, including the client installed on the
server computer.
For information on adding a Proficy Portal data source connection, see Proficy Portal Data Source.
Install Proficy Real-Time Information Portal
The Proficy Real-Time Information Portal installation files are included on the Proficy Workflow DVD.
IMPORTANT: Proficy Workflow supports Proficy Portal v3.0 only, with SP1 or the SIMs that are included on the
installation DVD. You must install the Proficy Portal SIMs or SP1, which are included on the installation CD, in
order to use Proficy Portal with Proficy Workflow.
NOTE:
• Proficy Portal can be installed on a different computer than the one Proficy Workflow is installed on.
• To connect to and view Proficy Portal displays, you must install Java Run-time v6.0 or greater. This plugin
must be installed on all client computers that will use Portal displays, including the client installed on the
server computer.
| Getting Started | 71
• The Proficy Real-Time Information Portal Getting Started guide is included as a PDF in the Proficy Portal folder
on the Proficy Workflow installation DVD.
1. Place the installation DVD in the DVD drive. If you have Autoplay enabled, the installation launcher splash
screen appears.
NOTE: If it does not appear, double-click Setup.exe from the root directory on the installation DVD.
2. Click Browse the CD.
Windows Explorer appears, displaying the folders contained on the installation DVD.
3. Locate the Proficy Portal folder.
The installation files are located in this folder.
4. Double-click Setup.exe, and then follow the installation instructions in the Proficy Real-Time Information Portal
Getting Started guide.
Proficy Reporting Database
Proficy Workflow includes an option to install a reporting database. This database can be used with any valid
reporting tool, and allows you to build reports on up-to-date data that you synchronize from your production
database.
For more information on the Proficy Reporting Database, see Reporting.
Install the reporting database
The reporting database allows you to use the data synchronized from your production database to build reports
for your facility. You can use any reporting tool to extract the information from the reporting database and
create your reports.
NOTE: If you plan on frequent synchronization for reporting purposes, we recommend that you replicate the
Proficy SOA database and run reporting against the replicated database. This measure reduces the risk of
system timeout or shutdown due to locking of tables in the production database. If upon trying to save data after
replication, you receive an error similar to "System.Data.SqlClient.SqlException (0x80131904): Length of LOB data
(88064) to be replicated exceeds configured maximum 65536," use SQL statements to increase the volume of
data to replicate.
Example:
sp_configure 'max text repl size', 2147483647
GO
RECONFIGURE
GO
For information on setting up database replication, see the SQL Server help.
You must have installed a supported SQL Server version before you install the reporting database (see Software
Requirements on page 8). In addition, you must select the SQL Server Integration Service (SSIS) component
when you install SQL Server. Select the SQL Reporting Services component, as well, if you want to use SQL as
your reporting tool.
NOTE: We recommend that you install the reporting database on a separate computer from the production
database to prevent performance issues on the production database. In this scenario, additional configuration
changes are required. Refer to Configure Component Services on page 72 for more information. However, if
the Proficy SOA Server computer meets the requirements for both databases, they can be installed on the same
computer.
If both SQL Server 2008 and SQL Server 2012 are installed, the integration services used for the reporting
database are those for SQL Server 2012.
1. Place the installation DVD in the DVD drive. If you have Autoplay enabled, the installation launcher splash
screen appears.
| Getting Started | 72
NOTE: If it does not appear, double-click SetupReporting.exe from the root directory on the installation DVD.
2. Click Install Proficy Reporting.
The License Agreement page appears.
3. Review the license agreement, and then click I Agree.
The Choose Install Location page appears.
4. Accept the default destination folder or browse for a new location, and then click Next.
5. In the Configure Reporting SQL Server area, enter the following information and then click Next.
a) In the Server field, accept the default value if the reporting database is on the local machine with the
default instance. If the SQL Server named instance is used, enter the SQL Server name and instance name;
for example, <servername>\<instance name>.
NOTE: The Reporting SQL Server must be local.
b) In the Database field, enter the name of the reporting database. This creates a new database; however, if
a database of the same name already exists, this database will append to the existing one.
c) From the Authentication list, select the type of authentication you want to use. If you choose to use
integrated security, select Windows Authentication; otherwise, select SQL Server Authentication, and
then enter the user name and password for the SQL Server.
6. In the Configure SQL Server area, perform one of the following actions:
• Leave the Use a local SQL database with Windows Authentication check box selected, and then click
Next.
• Clear the Use a local SQL database with Windows Authentication check box, enter the following
information, and then click Next.
1. In the SQL field, enter the name of the SQL Server where the SQL database is located.
2. In the Database field, enter the name of the production (SQL) database that you will connect to for
synchronization.
3. From the Authentication list, select the type of authentication you want to use. If you choose to use
integrated security, select Windows Authentication; otherwise, select SQL Server Authentication,
and then enter the user name and password for the SQL Server.
7. In the Proficy Workflow Server Configuration area, enter the following information, and then click Next.
• In the Server computer name field, enter the fully qualified name of the server computer.
8. In the Configure Security area, enter an Administrator user name and password.
IMPORTANT:
• You cannot use a Windows user name and password to configure security for the reporting database; it
MUST be a valid Proficy Workflow Administrator user name and password.
• The Advanced user authentication settings (that is; Enable SSO, Enable user password change at login,
Enable user account lockout, and enable user password complexity rules) do not apply when installing the
reporting database.
9. Click Install.
10. Click Exit.
Configure Component Services
If your production database is on a different computer than the Proficy Reporting Database, the following
configuration changes are required.
IMPORTANT: You can perform these steps either before or after installing the Proficy Reporting Database;
however, you must complete these configuration changes before you run your reporting data synchronization.
NOTE: For this procedure, your production database server is the "server," while the reporting database server is
the "client."
| Getting Started | 73
1. Verify that the Distributed Transaction Coordinator service is running on both the server and client
computers.
a) From the Start menu, point to Administrative Tools, and then click Services.
b) If the Distributed Transaction Coordinator service is not running, right-click it, and then click Start.
2. On the server computer, from the Start menu, point to Administrative Tools, and then click Component
Services.
3. In the left navigation tree, click Component Services, and then expand Computers.
4. Right-click My Computer and select Properties.
The My Computer Properties dialog box appears.
5. Click the MS DTC tab.
IMPORTANT: If you are using Windows 7, Windows Server 2008, or Windows Server 2012, you must
use the following path to retrieve these computer properties: Component Services> Computers>My
Computer>Distributed Transaction Coordinator>Local DTC
6. Click Security Configuration.
The Security Configuration dialog box appears.
7. Select the following check boxes:
• Network DTC Access
• Allow Remote Clients
• Allow Inbound/Outbound Administration
• Enable Transaction Internet Protocol (TIP) Transactions
8. Click OK.
A message appears telling you "MS DTC Service will be stopped and restarted. All dependent services will be
stopped. Please press Yes to proceed." Click Yes.
9. In the My Computer Properties dialog box, click OK.
10. If required, reboot your production database server.
NOTE: We recommend that you reboot your production database server.
11. On the client computer, repeat steps 2 through 6.
12. Select the Network DTC Access and Allow Inbound/Outbound Administration check boxes.
The DTC Service is stopped and restarted.
13. Restart the client computer.
14. Verify that the Distributed Transaction Coordinator service is running on both the server and client
computers, and, if required, repeat steps 1a and 1b.
Uninstall the reporting database
When you uninstall the reporting database, you can choose to remove it completely from the computer or
maintain the database but lose the ability to synchronize the data from your production database. Uninstalling
the reporting database does not affect the production database or the data contained in it.
1. From Control Panel, double-click Add or Remove Programs.
The Add or Remove Programs dialog box appears, displaying all of the programs installed on the computer.
2. Select Proficy Reporting, and then click Remove.
3. In the confirmation message box, click Yes.
4. In the Uninstall Reporting message box, click Yes if you want to completely remove the reporting database
from the computer. If you select No, the reporting database remains on the computer, but the ability to
synchronize with the production database is lost; however, you can still run reports on the data stored in the
database.
| Getting Started | 74
Remote Desktop Session Host
This information is intended for system integrators, IT administrators, and engineers responsible for setting up
and optimizing a Proficy Workflow Remote Desktop Session Host environment.
This information assumes familiarity with your network environment, as well as:
•
•
•
•
•
®
®
Microsoft Windows Server 2008 R2
®
®
Microsoft Windows Server 2012
®
Microsoft Windows Licensing
®
Microsoft Windows Remote Desktop Services
®
Citrix technologies including licensing
Remote Desktop Services (Terminal Services)
®
®
®
With Remote Desktop Services for Microsoft Windows Server 2008 R2 and Windows Server 2012, you can
centrally manage and execute Proficy Workflow.
The Remote Desktop Session Host environment is a thin-client architecture where all application
processing
®
occurs centrally on the server. By installing a small piece of thin-client software from Microsoft or connecting
through an Internet Explorer 7 (or higher) browser, thin clients can initiate and run individual instances of Proficy
Workflow on the server. Only graphic, keyboard, and mouse instructions are sent back and forth between the
client and the server, which minimizes network traffic.
Using Remote Desktop Services provides:
Ease of maintenance
You install only one copy of Proficy Workflow on a
server, from which multiple users can run clients.
Upgrades and SIMs need to be installed only on the
server.
Remote access with built-in technology
With Remote Desktop Communication (RDC) and
Internet Explorer 7 or higher, clients from Windows
XP through Windows 7 can connect to the Proficy
Workflow Remote Desktop Session Host to access
Proficy Workflow.
Security
Encryption and other security measures protect the
data exchanges between the Proficy Workflow Remote
Desktop Session Host and the clients.
Lightweight client machines
The Proficy Workflow Remote Desktop Session Host
locally processes the software that the clients execute.
Clients connecting to the server through a remote
desktop session do not need the processing power
usually required to run Proficy Workflow.
Specialized environments
Remote Desktop Services allows you to tightly control
user accounts. For example, you can configure user
accounts to start and execute a single program
(Proficy Workflow). Proficy Workflow automatically
starts at log in, and the users do not have access
to the Windows desktop. When they exit Proficy
Workflow, they log out of the Remote Desktop Session
Host account.
Handheld environments
Remote Desktop Services enables wireless handheld
devices to display Proficy Workflow.
| Getting Started | 75
Controlled access to files
With Windows file protection, you can limit the
directories users are allowed to access and modify,
such as for forms, displays, and import/export files.
Proficy Workflow Remote Desktop Session Host Environment
Proficy Workflow Remote Desktop Session Host allows multiple clients to run individual instances of Proficy
Workflow from one server.
®
Thin clients
access the Remote Desktop Session Host through Microsoft Remote Desktop Protocol (RDP) or
®
Citrix Independent Computing Architecture (ICA) protocol. No Proficy Workflow software is installed or runs on
the thin-client machine.
A separate session of Proficy Workflow runs on the Remote Desktop Session Host for each thin client. This allows
very thin clients with minimal client-side resources to execute an individual instance of Proficy Workflow. The
users' experience is nearly identical to running Proficy Workflow on their local machines. If you have clients and
servers in your Proficy Workflow Remote Desktop Session Host environment, you can access and manage any of
the servers from a thin client.
Getting Started
®
Before installing Proficy Workflow on a Windows Server 2008 R2 or computer, you must enable and set up the
Windows Remote Desktop Session Host.
®
For the most
up-to-date Remote Desktop Session Host information for Windows Server 2008 R2, visit
®
Microsoft 's web site at:
http://technet.microsoft.com/en-us/library/dd647502(WS.10).aspx
IMPORTANT: Before installing the Proficy Workflow Remote Desktop Session Host, be aware of its limitations and
software and licensing requirements. You should also spend some time planning a sound network and security
strategy, and user and machine naming conventions.
Proficy Workflow Remote Desktop Session Host Limitations
The Proficy Workflow Remote Desktop Session Host has a number of limitations and assumptions.
• Location-based functionality in Proficy Workflow does not work with Remote Desktop Services. That is,
workflow tasks that are assigned to a location, key set permissions assigned to a specific computer, and any
computer configurations, including layout and auto login/logout, will not work on a Remote Desktop Session
Host.
®
®
• The Remote Desktop Session Host computer must have Windows Server 2008 R2 or Windows Server 2012
installed.
®
• Proficy Workflow does not support running a Remote Desktop Session Host on Windows Vista.
• Although Windows supports machine names of up to 15 characters, Proficy Workflow node names are
limited to eight characters.
• Depending on your settings, some keyboard shortcuts (such as Ctrl+Alt+Delete) may be disabled or
remapped.
• User accounts must be created with logins after installing Proficy Workflow.
Scalability
The number of clients supported by a server varies according to the server's processing power and memory.
If you use good optimization techniques, you should be able to run more clients with better performance per
server.
®
The Microsoft Performance Monitor can help you to determine the optimal number of Remote Desktop Session
Host sessions your server can handle.
| Getting Started | 76
Hardware Requirements
The following information describes the recommended hardware requirements for a Remote Desktop Session
Host environment.
• One 3Ghz CPU for every three clients connected to the Remote Desktop Session Host (minimum)
NOTE: If the clients are expected to manage high levels of activity, decrease the number of clients per CPU to
two.
• 500MB RAM per client (minimum)
Software Requirements
®
Proficy Workflow Remote Desktop Session Host requires Proficy Workflow and the Windows Server 2008 R2
®
Standard or Enterprise Edition or the Windows Server 2012 operating system.
NOTE: GE Intelligent Platforms highly recommends that you install the latest Service Pack and Windows
Updates.
Licensing Requirements
GE Intelligent Platforms recommends that you install your Remote Desktop Session Host on a computer that is
not a domain controller. Ensure that you back up the Remote Desktop Session Host licenses regularly to prevent
data loss.
®
For the most up-to-date Remote Desktop Session Host license information on Windows Server 2008 R2, visit
®
Microsoft 's web site:
http://technet.microsoft.com/en-us/library/dd647502(WS.10).aspx
®
Proficy Workflow Remote Desktop Session Host Clients for Windows Server 2008 R2
®
When a Windows Server 2008 R2 client connects to the Remote Desktop Session Host with External Connector
Licensing disabled, the license from the client is used. The first time that you connect to the server, that license is
activated.
®
If you are running a non-Windows Server 2008 R2 client computer, you need to purchase Windows Remote
®
Desktop Services Client Access Licenses (RDSCALs) from Microsoft . When you first set up the Proficy Workflow
Remote Desktop Session Host, you have a 120-day temporary license to run a maximum of 10 client machines
from the server. The first 10 Windows client machines that connect to the server will reserve the licenses.
NOTE: Remote Desktop Services Client Access Licenses (RDSCALs) are counted per device and are not
concurrent.
WARNING: When you activate a RDSCAL, it is permanently associated with that machine. You cannot
®
reboot the machine to clear your license use. If you reformat the machine, you must contact Microsoft
to obtain a replacement license.
Hardware Key Licensing
All hardware keys distributed to run Proficy Workflow contain software to enable licensing for Remote Desktop
Session Host client computers.
For example, if you purchase a ten-client license, software embedded in the key allows ten concurrent client
users and prevents an eleventh client access to Proficy Workflow. When a client disconnects from Remote
Desktop Session Host, another client can then access it.
NOTE: You still need enough RDSCALs to license all the devices that will connect to the server. Be aware that
even if you have the appropriate number of Remote Desktop Session Host licenses enabled, performance issues
may prevent you from connecting.
®
Enable Windows Server 2008 R2 Remote Desktop Services
®
Remote Desktop Services must be enabled on the Windows Server 2008 R2 computer that will be used as the
Remote Desktop Session Host.
IMPORTANT: These steps must be performed before you install Proficy Workflow.
| Getting Started | 77
For more information
about Remote Desktop Session Host, refer to the Remote Desktop Services section of
®
the Windows Server 2008 R2 Help or visit Microsoft's web site at: http://technet.microsoft.com/en-us/library/
dd647502(WS.10).aspx.
®
1. On the Windows Server 2008 R2 computer, click Start > Administrative Tools > Server Manager.
The Server Manager dialog box appears.
2. Click Roles, and then click Add Roles.
The Select Server Roles page of the Add Roles Wizard appears.
3. Select Remote Desktop Services, and then click Next.
The Select Role Services page appears.
4. Select the Remote Desktop Session Host and Remote Desktop Licensing check boxes.
You can select additional role services, but no other services are required.
IMPORTANT: If your Proficy SOA server is configured to use AD LDS (Active Directory Lightweight
Directory Services), a warning message appears. Click Install Remote Desktop Session Host anyway (not
recommended).
5. Click Next.
The Specify Authentication Method for Remote Desktop Session Host page appears.
6. Select an option to indicate whether network level authentication is required, and then click Next.
The Specify Licensing Mode page appears.
7. Select an option to specify the Remote Desktop licensing mode that you want this Remote Desktop Session
Host server to use, and then click Next.
The Select User Groups Allowed Access to this RD Session Host Server page appears.
8. Click Add to add the required users or user groups that can connect to this Remote Desktop Session Host
server, and then click Next.
The Configure Client Experience page appears.
9. Select the functionality you want to provide to the users connecting to a remote desktop session, and then
click Next.
The Configure Discovery Scope for RD Licensing page appears.
10. Optional: Select the Configure a discovery scope for this license server check box, and then configure it as
follows:
a) Select the appropriate option for the discovery scope.
b) Click Browse to select the location for the RD Licensing database.
11. Click Next.
The Confirm Installation Selections page appears.
NOTE: At any time during the configuration process, you can click Previous to go to a previous page to
change your settings.
12. Click Install.
If instructed to do so, restart the computer for the changes to take effect.
®
Log on to a Remote Desktop Session Host from Windows XP
1. Click Start > All Programs > Accessories > Remote Desktop Connection.
The Remote Desktop Connection dialog box appears.
2. Enter or select a computer name, and then click Connect.
The Log On to Windows dialog box appears.
3. Enter a user name and password, and then click OK.
®
Log on to a Remote Desktop Session Host from Windows 7
1. Click Start > All Programs > Accessories > Remote Desktop Connection.
The Remote Desktop Connection dialog box appears.
2. Enter or select a computer name, and then click Connect.
The Log On to Windows dialog box appears.
| Getting Started | 78
3. Enter a user name and password, and then click OK.
Proficy Workflow with Windows Remote Desktop Session Host Installation and
Configuration
After enabling Installing Remote Desktop Services and its licensing, you can install and configure Proficy
Workflow on a Remote Desktop Session Host.
Prerequisites for Proficy Workflow on a Remote Desktop Session Host
®
Prior to installing any applications for use with Remote Desktop Session Host clients, refer to the Microsoft
Remote Desktop Session Host documentation regarding concept, configuration, and use of ROOTDRIVE.
Before you begin installing and configuring Proficy Workflow on a Remote Desktop Session Host, GE Intelligent
Platforms strongly recommends that you complete the following Windows administrative tasks on the Proficy
Workflow server machine.
IMPORTANT: If you do not follow the recommended steps for the correct Windows Remote Desktop Session
Host Configuration, your applications may not function correctly.
1. From the C:\Windows\Application Compatibility Script folder, run chkroot.cmd.
The RootDrv2.cmd file is created.
2. In a text editor, open the RootDrv2.cmd file from the C:\Windows\Application Compatibility Script folder.
3. At the end of the file, on the Set RootDrive= line, add a drive letter.
For example: Set RootDrive=W:
4. Save the RootDrv2.cmd file.
5. Run the RootDrv2.cmd file.
6. Verify that your Remote Desktop Session Host is set up and functioning.
Install Proficy Workflow on a Remote Desktop Session Host
Follow the installation steps, as outlined in the Proficy Workflow Getting Started Guide, to install Proficy Workflow
on a Remote Desktop Session Host.
Specify the program that starts when the user logs on to the Remote Desktop Session Host
You can create a secure environment that prevents operators from performing unauthorized actions, such as
using the Ctrl+Alt+Delete key combination to shut down the Remote Desktop Session Host. You can configure
this in Windows, with user properties and group policies.
Be aware that you can use Proficy Workflow security to define the rights each user has in Proficy Workflow after
logging in. For example, you can add further restrictions in Proficy Workflow by setting permissions for the group
the user is a member of.
1. On the Remote Desktop Session Host machine, log in to Windows as an administrator.
2. Click Start > Settings > Control Panel > Administrative Tools > Computer Management.
The Computer Management dialog box appears.
3. In the System Tools folder, double-click Local Users and Groups.
4. Select the Users folder.
5. Right-click the user you want to configure, and then select Properties.
The Properties dialog box appears.
6. Click the Environment tab.
7. In the Starting Program area, select the Start the following program at logon check box.
8. In the Program File Name field, enter the path to the Proficy client program.
For example, if you installed Proficy Workflow to the default location, enter:
C:\Program Files\Proficy\Proficy Workflow\Proficy Client.exe
9. In the Start in field, enter the path of the Proficy Workflow product.
| Getting Started | 79
For example, if you installed Proficy Workflow to the default location, enter:
C:\Program Files\Proficy\Proficy Workflow
10. Click OK.
11. Repeat steps 5 through 10 for each user you want to configure.
12. Click OK to close the Computer Management dialog box.
Configure a Remote Desktop Connection to Connect to a Remote Desktop Session Host
®
®
®
®
Windows XP, Windows Server 2008 R2, Windows 7, and Windows Server 2012 provides the Remote Desktop
Connection to configure and connect to a remote Remote Desktop Session Host.
1. Click Start > All Programs > Accessories > Remote Desktop Connection.
The Remote Desktop Connection dialog box appears.
2. Click Options.
3. On the General tab, in the Computer field, enter or select a name from the drop-down list.
4. In the User name field, enter a user name and, if applicable, preface it with your domain name followed by a
backslash.
5. Click the Display tab.
6. Leave the default remote desktop size but, if required, change the color setting.
7. Click the Experience tab.
8. Select the performance options that your client requires. GE Intelligent Platforms recommends that you clear
all check boxes except Persistent bitmap caching.
9. Select the Reconnect if connection is dropped check box.
10. Click Connect to connect to the Remote Desktop Session Host.
Troubleshoot Your Proficy Workflow Remote Desktop Session Host Environment
To successfully troubleshoot your Proficy Workflow Remote Desktop Session Host environment, you first need to
isolate the source of your problem.
Troubleshoot Specific Remote Desktop Session Host Problems
After isolating your problem area, use the information in the following table to begin troubleshooting.
For this problem area...
Verify...
Performance
Should you run fewer clients?
Server performance increases with the following:
•
•
•
•
Faster processors
More processors (dual, quad)
More memory
Reduced graphic refresh rate on clients
Connection
• Is your connection problem for all connections or
user specific?
• Can the Administrator start a session locally and
remotely?
Environment
• Can you create a session on the server?
• Is the problem the same for all users including
Admin?
• Can you create a new client session?
• Can you create a client that opens NotePad?
| Getting Started | 80
For more information, suggestions, and tips
for troubleshooting your Proficy Workflow
Remote Desktop Session
®
®
Host environment, refer to the Windows Server 2008 R2 Help and the Microsoft Remote Desktop Session Host
online documentation.
Troubleshoot Known Remote Desktop Session Host Problems
The following table lists some specific troubleshooting information for known Remote Desktop Session Host
problems.
Problem
Solution
Registry locks, behaves like "Duplicate Node Names"
on the network.
You have started multiple sessions at the same time
or multiple users have logged on using the same
account.
Multiple users cannot log on using the same account.
Start one session at a time.
If the same user is logged on multiple times, consider
using the End Session setting. The End Session setting
logs off the user upon disconnect. To use this setting,
select the End Session check box located under
Override User Settings in the RDP Properties of the
Remote Desktop Services Configuration Console.
The text insertion cursor in a Proficy Workflow Text
object does not appear.
The cursor blink rate in the control panel is set to the
lowest setting for Remote Desktop Session Host. Set
the blink rate to 1 above the slowest setting.
Frequently-Asked Questions About Using Proficy Workflow with Remote Desktop Session
Host
The following list outlines some of the frequently-asked questions about using Proficy Workflow with Remote
Desktop Services.
How can I determine the number of Remote Desktop Session Host connections that my Proficy Workflow
license supports?
If you have an M4 key, run the Proficy License Viewer (Proficy.ManagementConsole.exe). Select the Proficy
Workflow product icon to display Proficy Workflow information.
Task Controls in Proficy HMIs
The Proficy Workflow Task List can be integrated into other Proficy HMI applications.
Workflow task controls can be integrated into existing HMI applications, such as Proficy HMI/SCADA CIMPLICITY
and Proficy HMI/SCADA iFIX. Workflow tasks are displayed in your application so you can operate them from
within these applications. You use the ActiveX Task List and Task Indicator controls to interact with and view
workflow tasks.The ActiveX Task List provides users with a list of tasks for a workflow. The Task Indicator provides
a user with relevant information regarding the status of the ActiveX Task List.
Proficy Task List Configuration
The configuration tool allows you to modify server information and its authentication credentials.
Before configuring the ActiveX Task List, note the following information:
• Each installation of the ActiveX Task List can connect to only one Proficy Workflow server at a time.
• At a single workstation, only one Task Indicator object and one ActiveX Task List object can be connected at a
time per HMI application instance.
| Getting Started | 81
• Proficy task controls and Proficy HMIs are related, but work independently from each other. Therefore, user
names and logins are separate.
• Like the Proficy Workflow client, the NET. TCP Port Sharing service must be enabled to use the Task List in a
host application.
• To change the server name, use the Configure Client tool. For more information, see Modify the server
configuration for a remote client on page 63. If you install the ActiveX Task List on a different machine than
the Proficy Server, you must access the Configure Client tool from the following location: ../Program Files/
Proficy/Proficy Task List/Program.
Modify the ActiveX Task List installation configurations
NOTE: To change the server name, use the Configure Client tool. For more information, see Modify the server
configuration for a remote client on page 63. If you install the ActiveX Task List on a different machine than
the Proficy Server, you must access the Configure Client tool from the following location: ../Program Files/
Proficy/Proficy Task List/Program.
1. From the Start menu, select the Proficy Workflow Task List Configuration.
The Proficy Task List Configuration window appears.
2. To add or modify a server, in the Server Name section, enter the fully qualified name of a server.
3. To modify the login authentication, in the Server Authentication section:
Select...
To...
Manual Login
prompt the user to enter a user name and password
at each login.
Control Property
allow the user to view the user name and password
in the host's object properties.
Password Encryption
log the user in automatically.
4. If you selected Password Encryption in the Server Authentication section, add user credentials in the User
Configuration section:
a) In the Users panel, click Add.
b) In the Details panel, in the User Name field, enter an existing Proficy Workflow user name.
c) In the Password field, enter the password for the user name.
d) In the Confirm Password field, re-enter the password.
5. Click Save.
Install the ActiveX Task List
IMPORTANT: Product Options Installation Information. When using the ActiveX Task List, product option updates
made on the server are not automatically deployed to applications using the Task List. The ProficyUpdater.exe
application must be run manually, with administrative privileges, in order to deploy production option updates on
each client machine using ActiveX Task List.
NOTE: At a single workstation, only one Task Indicator object and one ActiveX Task List object can be connected
at a time per HMI application instance.
1. Place the installation DVD in the DVD drive. If you have Autoplay enabled, the installation launcher splash
screen appears.
2.
3.
4.
5.
NOTE: If it does not appear, double-click SetupTaskList.exe from the root directory on the installation DVD.
Click Install Task List.
The License Agreement page appears.
Review the license agreement, and then click I Agree.
The Choose Install Location page appears.
Accept the default destination folder or browse for a new location, and then click Next.
The Proficy Workflow Server Configuration page appears.
In the Server Name field, enter the name of the server that you want to install the ActiveX Task List on.
| Getting Started | 82
The Configure Proficy Service Certificates page appears.
6. The security certificates are automatically downloaded from the server you are connecting to.
7. Click Next.
The Configure Task List Authentication page appears.
8. From the Authentication Type drop-down menu, select one of three login options, and then click Next.
If you want the user name and password:
• entered manually, select Manual Authentication, or
• exposed in plain text, select Control Property Authentication, or
• saved automatically after initial setup, select Password Encryption Authentication.
NOTE: You must first configure users using the Modify the ActiveX Task List installation configurations on
page 81 tool.
The Ready to Install page appears.
TIP: At any time during the installation configuration process, you can click Back to go to a previous page to
change your settings.
9. Click Install.
10. When the installation is complete, click Exit.
Contact Information
If you purchased this product through an Authorized Channel Partner, please contact the seller directly.
General Contact Information
Online technical support & GlobalCare:
www.ge-ip.com/support
Comments about our manuals and online Help:
doc@ge.com
Additional information:
www.ge-ip.com
Solution Provider:
solutionprovider.ip@ge.com
Authorization:
authorization.ip@ge.com
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
Online technical support:
www.ge-ip.com/support
Telephone:
1-800-433-2682
International Americas direct dial:
1-434-978-5100
Technical support e-mail:
support.ip@ge.com
Customer care e-mail:
customercare.ip@ge.com
Inside Sales:
insidesales.ip@ge.com
Primary language of support:
English
| Getting Started | 83
Europe, Middle East, and Africa
Online technical support:
www.ge-ip.com/support
Telephone:
+800 1-433-2682
+1 780-401-7717 if the 800 option is not available in
your country, or if dialing from a mobile telephone
Technical support e-mail:
support.emea.ip@ge.com
Customer care e-mail:
customercare.emea.ip@ge.com
Inside Sales:
insidesales.emea.ip@ge.com
Primary language(s) of support:
English, French, German, Italian, Czech, Spanish
Asia Pacific
Online technical support & GlobalCare:
www.ge-ip.com/support
Telephone:
+86-400-820-8208
+86-21-3217-4826 (India, Indonesia, and Pakistan)
Technical support e-mail:
support.cn.ip@ge.com (China)
support.jp.ip@ge.com (Japan)
support.in.ip@ge.com (other Asian locales)
Customer care e-mail:
customercare.apo.ip@ge.com
customercare.cn.ip@ge.com (China)
Download PDF
Similar pages