Proficy* Workflow - GE Customer Center
Proficy* Workflow
Powered by Proficy SOA
G
ETTING
S
TARTED
Version 2.00
August 2012
All rights reserved. No part of this publication may be reproduced in any form or by any electronic or mechanical means, including photocopying and recording, without permission in writing from GE Intelligent
Platforms, Inc.
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.
Trademarks
© 2012, GE Intelligent Platforms, Inc. All rights reserved. * Trademark of GE Intelligent Platforms, Inc. All other brands or names are property of their respective holders. Any other trademarks referenced herein are used solely for purposes of identifying compatibility with the products of GE Intelligent Platforms, Inc.
Notice
GE Intelligent Platforms, Inc. reserves the right to make improvements to the products described in this publication at any time and without notice. We want to hear from you. If you have any comments, questions, or suggestions about our documentation, send them to the following email address: [email protected]
Table of Contents
Table of Contents
Getting Started ____________________________________ 1
Installation Requirements ____________________________ 2
Single Server (and Satellite Servers)
Proficy SOA Server - Large System
Proficy Reporting Database Installation 12
Proficy Host/Embeddable Proficy Host Installation 13
Web Task List Software Requirements
Defective Hardware Key Replacement
Proficy Workflow Installations ________________________ 21
Install a Proficy SOA Server and Client
Install a legacy Proficy SOA Server and Client
i
Install a remote Proficy Workflow client
Install and run the Web Task List
Multiple Servers ___________________________________ 39
Export server security certificates for an extension server 40
Server Clustering and Failover _________________________ 45
Hardware/Software Requirements
Supported and Validated Cluster Configurations
Three Clusters, Two Nodes Each
Microsoft Failover Cluster Manager
Install Microsoft Failover Cluster Manager
Configure the Microsoft Failover Cluster Manager 52
Configure quorum options for a cluster 54
Configure a Proficy SOA Server to be clustered
Configure the failover Proficy SOA Server for a cluster 56
Server Clustering and One-Click Deployment 56
Security Certificates _________________________________ 58
Configure Proficy Service Security Certificates
Post-installation Configuration ________________________ 63
ii Proficy* Workflow
Table of Contents
Modify the server configuration for a remote client
Modify the Microsoft Active Directory Services
Command Line Installation __________________________ 69
Log Files _________________________________________ 71
GE Single Sign On (SSO) ____________________________ 72
Log in to Proficy Workflow __________________________ 74
Standard Windows User Account ______________________ 77
Upgrading Proficy Workflow _________________________ 78
Upgrade to a newer version of Proficy Workflow
Proficy Real-Time Information Portal___________________ 85
Proficy Reporting Database __________________________ 88
Install the reporting database
Uninstall the reporting database
Task Controls in Proficy HMIs ________________________ 94
Proficy Task List Configuration
Modify ActiveX installation configurations
iii
Key Concepts _____________________________________ 99
One-Click Deployment ______________________________ 113
Supported Regional Settings __________________________ 116
Daylight Saving Time _______________________________ 118
Special Keyboard Buttons ____________________________ 119
SQL Server Backup and Restore _______________________ 120
Contact Information ________________________________ 121
Index ___________________________________________ 123
iv Proficy* Workflow
Getting Started
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.
1
Installation 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 requirements to run
Proficy Workflow and all products that work with it.
Single Server (and Satellite Servers)
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.
2.6 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% IBMcompatible 24-bit graphics card capable of 1024x768 resolution and at least 65535 colors
2 Proficy* Workflow
Installation Requirements
Minimum monitor support
Two-button mouse with scroll wheel or compatible pointing device (such as a touch screen)
Client
2.6 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. The
TCP/IP network protocol is required.
SVGA or better color graphics 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)
Proficy SOA Server - Large System
4-socket 8 Core 32 GM Ram
Windows Server x64 OS
200 GM free hard disk space
Network interface software for network communications. The
TCP/IP network protocol is required.
SVGA or better color graphics and a 100% IBM-compatible
24-bit graphics card capable of 1024x768 resolution and at least 65535 colors
3
Two-button mouse with scroll wheel or compatible pointing device (such as a touch screen)
Reporting Database
2.6 GHz Core™ 2 Duo Processor with 3 GB RAM
(minimum)
50 GB free hard disk space (minimum)
CD-ROM Drive
Network interface software for network communications. The
TCP/IP network protocol is required.
One free direct-connect USB port
XGA or better color monitor and a 100% IBM-compatible 24bit 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 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.
4 Proficy* Workflow
Installation Requirements
Project Specification
Small
System
Equipment Model Objects 0 – 500
Equipment Model
Properties
Material Definitions
Material Lots
0 – 5,000
0 – 1,000
0 – 1,000
Production Model Objects 0 – 500
Production Variables 0 – 5000
Number of Workflows 0 – 100
Medium
System*
500 – 2,500
Large
System*
2,500 +
5,000 – 500,000 500,000 +
1,000 – 10,000 10,000 +
1,000 – 5,000 5,000 +
500 – 1,000 1,000 +
5,000 – 10,000 10,000 +
100 – 1,000 1,000 +
Running Workflows
Concurrently Executing
Workflows**
0 – 50
0 – 5
Configured Events 0 – 50
Events Triggering per Hour 0 – 15
Work Requests in System 0 – 100
Active Work Requests 0 – 25
Active Clients 1 – 25
Recommended Server RAM 4 GB
50 – 500
5 – 25
50 – 500
15 – 100
100 – 1,000
25 – 500
25 – 100
8 GB
500 +
25 +
500 +
100 +
1,000 +
500 +
100 +
16 GB
Recommended Server
CPUs
2CPUs @
3Mhz
4 CPUs @
3Mhz
8 CPUs @
3Mhz
*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.
5
**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 may 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.
6 Proficy* Workflow
Installation Requirements
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.
Windows Server 2008 as the Operating System
Newer Microsoft operating systems have greater hardware requirements than older ones. The recommendations above assume that the server is running on Windows Server 2003. Windows Server
2008 uses significantly more memory and more CPU than 2003 does.
For equivalent performance, add an additional 2 GB of memory and an additional processor if you are using Windows Server 2008.
Additional Recommendations for the SQL Server Machine
For optimum performance, the databases, transaction logs, tempdb, non-clustered indexes, and back-ups 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
SQL indexes: RAID 0+1 or RAID 1
Back-ups: RAID 0 (no fault tolerance, but faster writes) or
RAID 5
7
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
Software Requirements
This section describes the minimum software requirements for your installation, including the recommended operating system and database.
8 Proficy* Workflow
Installation Requirements
Server Installation
The following list describes the software required to install and use
Proficy Workflow and the Proficy SOA Server.
One of the following operating systems:
Windows 7 Professional (32 or 64-bit)
Windows Server 2008 SP2 (32-bit only)
Windows Server 2008 R2 (64-bit)
Windows Server 2003 SP2 or greater (32 or 64-bit)
Windows XP Professional SP2 or greater (32-bit only)
One of the following SQL Server systems:
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 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.
Microsoft .NET Framework 4.0 (Full Framework)
9
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 or Windows Server 2003,
ADAM is required. If you are using Windows 7 or Windows
Server 2008, AD LDS is required. In Windows Server 2003,
Windows 7, and Windows Server 2008, these can be added as Windows components or features in the Programs applet of the Control Panel.
For demo, 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 4.0 and the Silverlight SDK
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 and its Primary Interop Assemblies (for
Import/Export operations). For more information, see:
http://msdn.microsoft.com/en-us/library/kh3965hw.aspx
http://www.microsoft.com/downloads/details.aspx?familyid=59DAE
BAA-BED4-4282-A28C-B864D8BFA513&displaylang=en
http://technet.microsoft.com/en-us/library/cc179091.aspx
Internet Explorer 7 or greater
10 Proficy* Workflow
Installation Requirements
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 and Clustering support) are not supported.
Hyper-V virtualization system for x86-64 systems
Remote Desktop Session Host (Terminal Services)
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
Client-only 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.
One of the following operating systems:
Windows 7 Professional (32 or 64-bit)
Windows Server 2008 R2 (64-bit)
Windows Server 2008 SP2 (32-bit only)
Windows Server 2003 SP2 or greater (32 or 64-bit)
Windows XP Professional SP2 or greater (32-bit only)
11
Microsoft .NET Framework 4.0 (Full Framework)
Microsoft Silverlight 4.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 and its Primary Interop Assemblies (for
Import/Export operations). For more information, see:
http://msdn.microsoft.com/en-us/library/kh3965hw.aspx
http://www.microsoft.com/downloads/details.aspx?familyid=59DAE
BAA-BED4-4282-A28C-B864D8BFA513&displaylang=en
http://technet.microsoft.com/en-us/library/cc179091.aspx
Internet Explorer 7 or greater
Proficy Reporting Database Installation
One of the following operating systems:
Windows 7 Professional (32 or 64-bit)
Windows Server 2008 R2 (64-bit)
Windows Server 2008 SP2 (32-bit only)
Windows Server 2003 SP2 or greater (32 or 64-bit)
Windows XP Professional SP2 or greater (32-bit only)
One of the following SQL Server systems:
Microsoft SQL Server 2008 Standard, Professional, or
Enterprise Edition (32 or 64-bit)
NOTE:
12 Proficy* Workflow
Installation Requirements
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.
Internet Explorer 7 or greater
Proficy Host/Embeddable Proficy Host Installation
One of the following operating systems:
Windows 7 Professional (32 or 64-bit)
Windows Server 2008 SP2 (32-bit only)
Windows Server 2008 R2 (64-bit)
Windows Server 2003 SP2 or greater (32 or 64-bit)
Windows XP Professional SP2 or greater (32-bit only)
Microsoft .NET Framework 4.0 (Full Framework)
Internet Explorer 7 or greater
Web Task List Software Requirements
Installation
The following list describes the software required to install the Task
List.
One of the following operating systems:
Windows 7 Professional (32 or 64-bit)
Windows Server 2008 SP2 (32-bit only)
Windows Server 2008 R2 (64-bit)
13
Windows Server 2003 SP2 or greater (32 or 64-bit)
Windows XP Professional SP2 or greater (32-bit only)
Microsoft .NET Framework 4.0 (Full Framework)
Internet Explorer 7 or greater
Microsoft Silverlight 4
Virtual Machine Support
The Proficy Workflow product is qualified on variety of operating systems. These include Windows XP, Windows 7, Windows Server
2003 SP2, Windows Server 2008 SP2, and Windows Server 2008 R2.
As part of our development testing and qualification, we make extensive use of VMWare workstations, VMWare ESX servers, and
Microsoft HyperV.
Our most current testing is based on VMWare Workstation 6.0,
VMWare ESX server 3.5, 4.0, 4.1, and Microsoft HyperV on Windows
2008 R2. 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.
14 Proficy* Workflow
Installation Requirements
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.
The Hardware Key
Proficy Workflow uses a hardware key, which contains your licensed software options.
The hardware key supports USB port configurations. The hardware key you use to run the Proficy SOA Server:
Controls and enables software options available to your installation.
15
Uses a utility to electronically reprogram options you choose to upgrade or change (for HASP M4 keys only).
If the key is not installed or found, Proficy Workflow runs in demo mode, which limits you to two clients.
Be sure to file your hardware key packing slip in a safe location. The codes on this slip are necessary for us to quickly duplicate the key in case it is damaged or misplaced. You can verify that your serial number matches the serial number on the hardware key packing slip by using the
Proficy License Viewer utility to detect and display your hardware key settings. For more information, see the License and Key Checking section.
Hardware Key Installation
A hardware key is included with your Proficy Workflow software. You must install your hardware key in order to access all the components of the Proficy Workflow software you purchased.
Typically, you install your hardware key as you install the Proficy
Workflow product. Refer to the Installing Proficy Workflow section for more details.
If you insert the key after you install Proficy Workflow, it should be detected automatically when the software starts. It is recommended that you shut down your computer before plugging in a new hardware key.
IMPORTANT: Do not remove the hardware key from your node while
Proficy Workflow is running. If you do, some features will shut down and you will need to restart Proficy Workflow. You may also damage the hardware key if you remove it while the software is running.
16 Proficy* Workflow
Installation Requirements
We support the installation of the USB port hardware key only on systems running Windows 7 (32 and 64-bit), Windows Server 2008 (32 and 64-bit), Windows Server 2003 (32 and 64-bit), or Windows XP (32bit only). At this time, we do not support USB keys connected through an external USB hub.
On new installs on Windows XP SP1, we recommend that you insert your USB key after you run the Proficy Workflow install.
License and Key Checking
Determine enabled options on the
Proficy License Viewer
To use Proficy Workflow and other Proficy products, you must purchase the product with the desired options from us. Depending on the options you buy, you may need to replace your current key or run an update program on your existing key to enable the options.
If you want to determine the options that are enabled on the computer you are currently working on use the Proficy License Viewer to view the options enabled.
TIP: The
Proficy License Viewer
programs can be used to provide technical support personnel with information about your hardware key.
1.
From the Start menu, point to Programs, Proficy Common, and then click License Viewer.
2.
In the Proficy Products list, select the Proficy Workflow product.
The License and Key Diagnostics area should display the available options.
3.
For information on upgrading your key to add other options, contact us. We will provide the steps for upgrading your
Proficy license file when you purchase new options or products.
17
Troubleshooting
If the hardware key does not install properly, you may see a message displayed on the Proficy Workflow client at startup.
First, check to see that your hardware key is firmly attached. Next, uninstall and reinstall the driver for the hardware key. If this driver has been incorrectly uninstalled, it may behave unpredictably.
Troubleshooting the Aladdin HASP Key
If the Aladdin HASP USB key does not appear to be working, you can reinstall the licensing to recover from the improper install. When the
Aladdin HASP key is not communicating correctly, you will notice that the indicator light at the end of the key is off.
To reinstall Proficy Licensing
1.
Click the
ProficyClientInstaller.exe
file in the License folder on the Proficy Workflow product installation CD to reinstall the license.
2.
Click Finish when the licensing install completes.
Defective Hardware Key Replacement
A defective hardware key causes your Proficy product to run in demo mode.
Be sure to check that the key is firmly attached to your USB or parallel port before assuming it is defective. Additionally, for USB keys, if the indicator light at the end of the key is off, then the key is not communicating correctly.
18 Proficy* Workflow
Installation Requirements
You can also use the License Viewer to determine if the hardware key is defective. If your hardware key is defective, the License Viewer does not display the proper enabled options. Or, an error message stating that a hardware key is required to view the enabled options may appear. For more information on using the License Viewer, refer to the
License and
Key Checking section.
We replace defective keys as quickly as possible. To obtain a replacement hardware key:
Call your local Technical Support representative. The support representative will instruct you to FAX a completed copy of a
Merchandise Return Authorization form. On receipt of the form, we can program a new hardware key and send it to you overnight.
When you receive the hardware key, you must return the old one along with a copy of the form sent with the new hardware key. We reserve the right to invoice you for defective hardware keys that are not returned.
FAQs
This section describes some frequently asked questions about Proficy hardware keys.
What does the light at the end of the USB key indicate?
For the Aladdin HASP USB key, the light indicates that the key and the software are communicating. If this light is off, it indicates a problem with the key.
19
If I move the USB key to another port, is it automatically detected?
Yes. The USB key is automatically detected when moved to another
USB port. There are no additional screens requesting software to be installed for the Aladdin HASP USB key.
20 Proficy* Workflow
Proficy Workflow Installations
Proficy Workflow Installations
The procedures in this section outline the 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.
Before you begin the Proficy Workflow installation, make sure that you have installed the following:
Microsoft .NET Framework 4.0 (Full Framework)
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 or Windows Server 2003,
ADAM is required. If you are using Windows 7 or Windows
Server 2008, AD LDS is required. In Windows Server 2003,
Windows 7, and Windows Server 2008, these can be added as Windows components or features in the Programs applet of the Control Panel.
21
For demo, 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.
One of the following SQL Server systems:
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 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.
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.
For more information, see Software Requirements.
Install a Proficy SOA Server and Client
The following information guides you through the Proficy SOA Server and Client installation process.
22 Proficy* Workflow
Proficy Workflow Installations
During this installation process, you are required to create an
Administrator user. This Administrator 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.
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.
Accept the default destination folder or browse for a new location, and then 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.
23
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, do the following: 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.
If your SQL Server is installed locally and uses Windows
Authentication, select the
Use a local SQL database with
Windows Authentication check box.
10.
If your SQL Server is either local or remote and uses either
Windows or SQL Authentication, clear the
Use a local SQL
database with Windows Authentication check box, and enter the following information:
24 Proficy* Workflow
Proficy Workflow Installations
IMPORTANT: You must install SQL Server 2008 or SQL
Server 2005 SP2 before you install Proficy Workflow. For detailed information, see
Software Requirements
.
a) In the Server field, enter or select the name of the SQL
Server you want to connect to. If the SQL Server is installed locally, you can 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. 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. d) If you select Windows Authentication, click Next. e)
If you select SQL Authentication, enter the user name and password configured for SQL Authentication on the
SQL Server you want to connect to.
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.
25
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)
.
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!
26 Proficy* Workflow
Proficy Workflow Installations
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.
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.
NOTE: 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.
18.
When the installation is complete, click Exit.
27
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
Postinstallation Configuration
.
Install a legacy Proficy SOA Server and Client
The following information guides you through the legacy Proficy SOA
Server and Client installation process. A legacy server installation includes the Proficy SOA server, the Workflow engine, and the Proficy
Host.
IMPORTANT: If you use Proficy Host as part of your system configuration, you must use the Legacy Server and Host installation option.
During this installation process, you are required to create an
Administrator user. This Administrator 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.
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 Legacy Server and Host.
The Legacy Proficy Server Installation Type page appears.
28 Proficy* Workflow
Proficy Workflow Installations
4.
Select either the Proficy Server or Proficy Host check box, and then click Next.
If you select Proficy Server, then skip steps 7 and 8.
5.
Review the license agreement, and then click I Agree.
The Choose Install Location page appears.
6.
Accept the default destination folder or browse for a new location, and then click Next.
7.
In the Host Instance section: a) In the Instance Name field, enter a name for this Proficy
Host instance. A Proficy Project is also automatically created. b)
In the Computer Name field, enter the name or description of the computer that you are installing the
Proficy Host instance on, or accept the default entry. c) From the Instance Type drop-down list, select the type of Proficy Host you want to install.
NOTE: If you select Embedded, you must create a
Windows service executable file and embed the Proficy
Host in that file.
8.
In the Proficy Workflow Server section:
In the Computer Name field, enter the name of the computer where the Proficy SOA Server is installed, or accept the default entry.
NOTE: Any resolvable computer name or IP address can be used when installing the Proficy Host / Embeddable
Proficy Host.
9.
In the Configure AD LDS Integration page, do one of the following:
29
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.
10.
For a production environment, do the following: 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.
11.
Click Next.
The Configure SQL Server page appears.
12.
Optional: Select the Backup existing database check box to automatically create a backup of your SQL database.
30 Proficy* Workflow
Proficy Workflow Installations
13.
If your SQL Server is installed locally and uses Windows
Authentication, select the
Use a local SQL database with
Windows Authentication check box.
14.
If your SQL Server is either local or remote and uses either
Windows or SQL Authentication, clear the
Use a local SQL
database with Windows Authentication check box, and enter the following information:
IMPORTANT: You must install SQL Server 2008 or SQL
Server 2005 SP2 before you install Proficy Workflow. For detailed information, see Software Requirements.
a) In the Server field, enter or select the name of the SQL
Server you want to connect to. If the SQL Server is installed locally, you can 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. 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. d) If you select Windows Authentication, click Next. e)
If you select SQL Authentication, enter the user name and password configured for SQL Authentication on the
SQL Server you want to connect to.
15.
Click Next.
The Configure Security page appears.
16.
Enter the following information: a) In the Administrator Name field, accept the default name or enter a name for the Administrator user.
31
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.
NOTE: Selecting this check box enables the SSO
Authentication
option on the box.
Proficy Workflow Login
dialog
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)
.
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
32 Proficy* Workflow
Proficy Workflow Installations
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.
17.
Click Next.
The Configure Proficy Service Certificates page appears.
18.
Select the appropriate certificate option. For full descriptions of the certificate options, see
Security Certificate Options.
19.
Click Next.
If the computer you are installing on has an enabled firewall, the Firewall Detected page appears.
20.
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.
33
NOTE: At any time during the installation configuration
process, you can click Back to go to a previous page to change
your settings.
21.
Click Install.
The
Installing Proficy Workflow page appears, displaying the status of each installation step.
22.
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
Postinstallation Configuration
.
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.
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.
34 Proficy* Workflow
Proficy Workflow Installations
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
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.
NOTE: If it does not appear, run
InstallFrontEnd.exe
on the root directory of the Proficy Workflow DVD.
35
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.
36 Proficy* Workflow
Proficy Workflow Installations
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.
NOTE: 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.
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.
Install and run the Web Task List
The Web Task List is automatically installed with the Full Server installation of Proficy Workflow.
TIP: To improve performance, enable caching in your browser.
1.
For information on installing Proficy Workflow, see Install a
Proficy SOA Server and Client.
37
2.
To start the Web Task List, use the following URL in the address bar of Microsoft Internet Explorer: http://<server>:8020/Proficy/Workflow/WebTaskList.html
.
NOTE: A security certificate that matches the name of your server's certificate is automatically generated during installation. Long computer names, such as http://<server>mydomain:8020/proficy/workflow/webtasklist.html
are not supported.
,
3.
To ensure that the Web Task List does not disconnect while running, update the timeout settings in the following key from
2710 to 30000:
HKEY_CURRENT_USER\Software\Microsoft\Windows\Curr entVersion\Internet Settings\ReceiveTimeout
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.
38 Proficy* Workflow
Multiple Servers
Multiple Servers
Proficy SOA provides the ability to install across multiple servers, each of which hosts a set of services. A multi-server environment is transparent and appears to be a single server to remote clients.
Each server in a multi-server environment must be configured to run the required services. To accomplish this objective, a shared server data model is used. Each Proficy SOA Server refers to a shared configuration data model to determine the specific service providers that they host. Client programs can then connect to any server, and be redirected to the server that is hosting the required service. Client programs, such as a form or custom client, communicate with service providers using service methods and events. As a result, neither the user nor the client program is aware of which server is hosting the service provider.
Deploying Service Providers Across Multiple Servers
After the initial installation of Proficy SOA on each server, setup the database and directory computers that contain service provider data, and then run the Configure Client tool one time from any server to deploy the service providers. All Proficy products, such as Proficy software, are built around service providers, which have defined interfaces, and the servers that are configured to run them. These products are installed to a single location, and then a one-time configuration of the Proficy site is performed to ensure that each
Proficy SOA Server is hosting the required service providers. This
Proficy SOA Server must connect to a Proficy System SQL Server database to access a site's database servers to perform this initial configuration.
39
Using Multiple Servers
In a multi-server Proficy site, roles must be assigned to each server.
These roles include sets of service providers that always run on the same physical server. These service providers contain the productrelated information of the Proficy software being used. After these roles have been assigned, the server data model can be updated by the
Configure Client tool. Then, restart each server that has been configured to finalize this process.
NOTE: Workflow engines, as well as extension servers, should not be installed at multiple sites across a WAN.
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.
1.
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.
40 Proficy* Workflow
Multiple Servers
A file with the extension .pcf (Proficy Certificates File) 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 a core Proficy SOA Server on one machine and a Workflow
Server (containing the workflow engine) on another machine. You can also choose to install a User Server, which hosts custom service providers.
IMPORTANT: If you are installing a Workflow Server or a User Server, you must have already installed a core server on a separate machine.
Before you begin: Install a Proficy SOA Server and Client, and Export server
security certificates for an extension server
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.
41
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.
Accept the default destination folder or browse for a new location, and then click
Next.
The Configure SQL Server page appears.
7.
Configure the SQL Server page as follows.
NOTE: This configuration must be the same as the core server.
a)
In the Server field, enter or select the name of the SQL
Server you want to connect to. If the SQL Server is installed locally, you can 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. 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. d)
If you select Windows Authentication, click Next. e) If you select SQL Authentication, enter the user name and password configured for SQL Authentication on the
SQL Server you want to connect to.
8.
Click Next.
The
Configure Proficy Service Certificates page appears.
42 Proficy* Workflow
Multiple Servers
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 Proficy Certificates (*pcf) 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.
NOTE: 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.
43
The Installing Proficy Workflow page appears, displaying the status of each installation step.
14.
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
Postinstallation Configuration
.
Modify server roles
If you want to alter the role of a server after installing Proficy
Workflow, use the Configure Site utility to assign services to run on each server instance.
1.
On the server machine, click Start > All Programs > Proficy
> Proficy Workflow > Configuration > Configure Site.
2.
Select the role(s) for each server instance.
NOTE: Each role can be assigned to only one server instance, but a server instance can be assigned multiple roles.
3.
Click Save, and then click Exit.
44 Proficy* Workflow
Server Clustering and Failover
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.
Overviews of the validated and supported cluster configurations.
Instructions for using the Microsoft Failover Cluster Manager to create a cluster.
Instructions on using the Configure Server Instance utility to configure your primary and failover servers.
45
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
Hardware/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.
46 Proficy* Workflow
Server Clustering and Failover
Proficy Workflow server clustering provides support against
hardware failures only.
Custom services managed by failover 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
Getting Started with SQL Server 2008 R2 Failover
Clustering.
The following web site provides information about the high availability features supported by the standard edition of SQL Server 2008 R2. http://msdn.microsoft.com/en-us/library/cc645993.aspx#High_availability
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.
47
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
Figure 1 shows an example of two Proficy SOA servers in a cluster.
Figure 1. Two Proficy SOA servers in a single cluster
Each Proficy SOA server must run the ProficyServer, ProficyPublisher, and ProficySTS services.
48 Proficy* Workflow
Server Clustering and Failover
Two Clusters, Two Nodes Each
Figures 1 and 2 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 1. 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.
49
Figure 2. 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
Figure 1 shows an example of two Proficy SOA servers, two Workflow engines, and two User servers, each in its own cluster.
50 Proficy* Workflow
Server Clustering and Failover
Figure 1. Two Proficy SOA servers, two Workflow engines, and two User servers, in separate clusters
Each Proficy SOA server must run the ProficyServer, ProficyPublisher, and ProficySTS services. Each Workflow engine and each User server must run the ProficyServer service.
Microsoft Failover Cluster Manager
The Microsoft Failover Cluster Manager for Windows Server 2008 R2 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.
For more information, visit the Microsoft TechNet web site.
51
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.
Before you begin: Install Microsoft Failover Cluster Manager
52 Proficy* Workflow
Server Clustering and Failover
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 a Cluster.
The Create Cluster Wizard appears.
3.
Follow the wizard prompts to create your cluster, as follows: a) Enter a management name for the cluster. b) If you have static IP addresses, set them. c) Add the nodes that will be part of the cluster; that is, the primary and failover servers. d) Create a service to represent the cluster name that your clients will use. e)
If you have static IP addresses, set them. f) Select Add a generic service, and then select the
ProficyServer service to add it to the service created in step d.
IMPORTANT: If you are configuring a cluster for
Workflow or User servers in a multi-server environment, only the ProficyServer service is required.
g) Repeat step 3.f to add the ProficyPublisher and ProficySTS services.
4.
On the primary server computer, start the ProficyServer,
ProficyPublisher, and ProficySTS services.
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.
53
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.
Clustering Tips
Use the clustering tips to ensure your failover cluster runs smoothly.
54 Proficy* Workflow
Server Clustering and Failover
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 utility 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.
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.
Configure a Proficy SOA Server to be clustered
The Configure Server Instance utility is used to configure the Proficy SOA
Server to work in a cluster.
Before you begin: Install a Proficy SOA Server and Client
1.
On the primary server machine, click Start > All Programs >
Proficy > Proficy Workflow > Configuration > Configure
Server.
The Configure Server Instance utility appears.
2.
Select the Create a Proficy SOA Server Instance option.
55
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.
Configure the failover Proficy SOA Server for a cluster
The Configure Server Instance utility is used to configure the Proficy SOA
Server to work in a cluster.
Before you begin: Configure a Proficy SOA Server to be clustered
1.
On the backup server machine, click Start > All Programs >
Proficy > Proficy Workflow > Configuration > Configure
Server.
The Configure Server Instance utility 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.
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.
56 Proficy* Workflow
Server Clustering and Failover
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\Progr am\Data
directory, and then regenerate the one-click deployment install.
57
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 TLS/SSL 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: When you are importing certificates, you must select the
Mark this key as exportable
check box in the
Certificate Import Wizard
.
This allows you to back up or transport your certificates at a later time, such as when transferring the certificates to extension servers or clickonce clients.
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.
58 Proficy* Workflow
Security Certificates
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).
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.
Legacy Certificates
GE Intelligent Platforms provides a set of security certificates that you can use for demonstration, development, or test purposes. It is strongly recommended that you do NOT use these certificates in a production environment.
Configure Proficy Service Security Certificates
The Configure Proficy Service Certificates utility is used to change or update the security certificates you configured during the server installation.
59
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.
IMPORTANT: When you are importing certificates, you must
select the Mark this key as exportable check box in the
Certificate
Import Wizard
. This allows you to back up or transport your certificates at a later time, such as when transferring the certificates to extension servers or click-once clients.
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
certificates.
utility to download the new versions of the
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.
60 Proficy* Workflow
Security Certificates
Full Server
The following table describes the information available to install security certificates on a single full server.
Option
Generate certificates unique to this installation
Description
This option allows you to automatically generate new self-signed certificates. If you are installing a multi-server or server failover cluster environment, more configuration is required on those servers.
Use the displayed certificates
Use legacy certificates included in the install
This option allows you to use previously existing certificates that you installed with a previous version of Proficy Workflow. Click the Import ellipsis button to import new versions of the certificates. Click the View ellipsis button to view each certificate.
IMPORTANT: When you are importing
certificates, you must select the Mark this key as exportable
check box in the Certificate Import
Wizard
. This allows you to back up or transport your certificates at a later time, such as when transferring the certificates to extension servers or click-once clients.
This option allows you to use the GE-supplied self-signed 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.
61
Extension Server
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.
Option
Use certificates from the main server
Use legacy certificates included in the install
Description
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 certificate 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.
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
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.
62 Proficy* Workflow
Post-installation Configuration
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 utility 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.
Modify the server configuration for a remote client
Use the Proficy Workflow Server Configuration utility to synchronize any changes you may have made to the Proficy SOA Server with remote clients.
IMPORTANT: The
Proficy Workflow Server Configuration
available only for client-only installations.
utility is
1.
On the client computer, click Start > All Programs > Proficy
> Proficy Workflow > Configuration > Configure Client.
The Proficy Workflow Server Configuration utility 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 multiserver environment, enter the name of the computer that the server you want to connect to is installed on.
63
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 utility 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.
64 Proficy* Workflow
Post-installation Configuration
If this installation is to be used in a production environment, skip to the next step.
3.
For a production environment, do the following: 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.
4.
Click Save, and then click Exit.
Modify the SQL server
The Configure Database utility provides the ability to make changes to your SQL Server database, as well as change the database you want to connect to.
IMPORTANT: You must install SQL Server 2008 or SQL Server 2005
SP2 before you install Proficy Workflow. For detailed information, see
Software Requirements
.
1.
Click Start > All Programs > Proficy > Proficy Workflow >
Configuration > Configure Database.
The
Configure SQL Server page appears.
65
2.
If your SQL Server is installed locally and uses Windows
Authentication, select the
Use a local SQL database with
Windows Authentication check box.
3.
If your SQL Server is either local or remote and uses either
Windows or SQL Authentication, clear the
Use a local SQL
database with Windows Authentication check box, and enter the following information:
IMPORTANT: You must install SQL Server 2008 or SQL
Server 2005 SP2 before you install Proficy Workflow. For detailed information, see
Software Requirements
.
a) In the Server field, enter or select the name of the SQL
Server you want to connect to. If the SQL Server is installed locally, you can 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. 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. d) If you select Windows Authentication, click Next. e)
If you select SQL Authentication, enter the user name and password configured for SQL Authentication on the
SQL Server you want to connect to.
4.
Click Save, and then click Exit.
Configure a server instance
The Configure Server Instance utility is used to create a Proficy SOA Server instance, as well as to configure server clustering.
66 Proficy* Workflow
Post-installation Configuration
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.
In the Service Ports fields, enter the port numbers for each of the service port types.
8.
In the IP Address field, enter the IP address of the server instance.
9.
In the Port field, enter the port number for the server instance.
10.
Click Save, and then click Exit.
Configure product options
You can create your own service providers, and then install them with
Proficy Workflow using the Configure Product Options utility.
You must have created and packaged your service provider and copied it to an accessible location.
Install one of the following server types:
Install a Proficy SOA Server and Client
Install multiple servers
67
1.
On the server machine, click Start > All Programs > Proficy
> Proficy Workflow > Configuration > Configure Product
Options.
The
Configure Product Options dialog box appears, displaying the product option files included with the server install.
2.
Click Install.
Windows Explorer opens at the
ProductOptions
folder within the Proficy Workflow installation directory.
3.
Select the product option file you want to install, and then click
Open.
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.
Select the server you want the product option to be installed on, click Save, and then click Exit.
5.
To uninstall a product option, select the option, and then click
Uninstall.
NOTE: You cannot uninstall the default product options that are included in the server installation.
68 Proficy* Workflow
Command Line Installation
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
/s
Description
/t filepath (where filepath is the user-defined file name)
Runs the installation setup (
SetupWorflow.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.
Runs the installation setup (
SetupWorkflow.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.
69
Command Line
Parameter
/c filepath (where filepath is the user-defined file name)
Description
Runs the installation setup (
SetupWorkflow.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.
Overrides the default logging location.
)
/l filepath (where filepath is the logging directory)
70 Proficy* Workflow
Log Files
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, and Windows Server 2008) the log files are located in:
C:\Program
Data\Proficy\Logs
.
The log files for all installations are also accessible from the program group; that is,
Start > All Programs > Proficy > Proficy Workflow >
Logs.
71
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.
Configuration Settings
GE SSO authentication can be configured during the installation process, or at any time after installation using the Configure Security utility.
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.
72 Proficy* Workflow
GE Single Sign On (SSO)
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
HTTP_SM_USER
HTTP_GIVENNAME
HTTP_SN
HTTP_GESSOSTATUS
HTTP_MAIL
Description
The SSO ID of the user
First name of the SSO User
Last name of the SSO User
Status of the SSO account
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.
73
Log in to Proficy Workflow
1.
On the main Proficy Workflow screen, click Log in to Proficy.
The Proficy Workflow Login dialog box appears.
2.
In the Authentication Type section, select an authentication method.
Your user name and password are verified in the selected system.
Select...
Proficy
Authentication
Windows
Authentication
SSO
Authentication
If...
Your user profile is part of the Proficy
Workflow application.
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.
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:
74 Proficy* Workflow
Log in to Proficy Workflow
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.
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.
Proceed as follows.
If you selected...
Proficy Authentication
Go to...
Step
6
Windows Authentication Step
4
SSO Authentication
Step
5
4.
If you are using Windows Authentication and need to create user(s) in Proficy Workflow, do the following: a) Create a user account for each one with a user name and password. b) Add the user(s) to the Windows User group.
5.
If you are using SSO Authentication and need to create user(s) in Proficy Workflow, do the following: a) Create a user account for each one, using their GE SSO
ID for the user name, and a password.
75
IMPORTANT: This password is only a placeholder. When a user selects SSO Authentication on the Proficy Workflow
Login dialog box, he must enter his existing SSO password or the login fails. When a user changes his SSO password on the SSO Server, the new password must be used to log in to Proficy Workflow with SSO authentication.
b)
Add the user(s) to the SSO Users group.
6.
In the User Name field, enter your user name.
7.
In the Password field, enter your password.
8.
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.
9.
Click OK.
76 Proficy* Workflow
Standard Windows User Account
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.
77
Upgrading Proficy Workflow
If you are working with versions of Proficy Workflow that are older than version 1.5, you must uninstall the previous version before installing a new version. However, as of version 1.5, you are not required to uninstall a previously installed version.
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 1.5x to Proficy Workflow 2.0
Upgrade from Proficy Workflow 1.0, 1.01, or 1.2 to Proficy
Workflow 2.0
NOTE: You must first upgrade to Proficy Workflow 1.5 before
2.0.
Upgrade from Proficy Workflow 1.5x to a later version of
Proficy Workflow 1.5x
Upgrade from Proficy Workflow 1.2 to Proficy Workflow 1.5
Upgrade from Proficy Workflow 1.01 to Proficy Workflow 1.5
Upgrade from Proficy Workflow 1.01 to Proficy Workflow 1.2
IMPORTANT: As of version 1.5 Service Pack 3, there are changes to the way you can upgrade your version of Proficy Workflow.
If Proficy Workflow is already installed and the new version
to be installed is equal to or greater than the installed version, then the installed version is upgraded. For more information, see
Upgrade to a newer version of Proficy
Workflow
.
78 Proficy* Workflow
Upgrading Proficy Workflow
If Proficy Workflow is already installed, but the new version
to be installed is earlier than the installed version, you are alerted that a newer version of Proficy Workflow is already installed.
If Proficy Workflow is not installed, installing a newer
version (1.5 SP3 or greater) will perform a full install.
Uninstalling Proficy Workflow does not remove the SQL Server database or the Active Directory Lightweight Directory Services (AD
LDS) instance; all of your project data is preserved. When you install a new version and specify the same SQL Server database and AD LDS instance, then the previously configured project is automatically upgraded.
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 utility 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
.
79
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.
Data Item Links
If, in an earlier version of Proficy Workflow, you created data item links to Historian tag names that contain special characters, those data item links will not upgrade. You must recreate those links in the new version of Proficy Workflow.
The special characters are: ', ~, !, @, #, and $. For example, if you have an equipment property, MyProperty1, linked to a
Historian tag, HistTag#1, in Proficy Workflow version 1.01, that link will break when you upgrade to version 1.2 or 1.5.
The special character "-" is fully supported in the upgrade process; that is, data item links to Historian tags containing the
"-" character will upgrade correctly.
NOTE: Proficy Workflow 1.2 and greater support all of these special characters.
When you upgrade from Proficy Workflow 1.01, the display names of data item links from workflows or condition events to equipment properties will contain a GUID. You must reconfigure these data item links to remove the GUID. After reconfiguring the data item, the display name is updated correctly as
<EquipmentOwnerName.PropertyName>
.
80 Proficy* Workflow
Upgrading 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.
81
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
Postinstallation Configuration
.
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.
82 Proficy* Workflow
Upgrading Proficy Workflow
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.
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.
83
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.
84 Proficy* Workflow
Proficy Real-Time Information Portal
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.
To connect to and view Proficy Portal displays, you must
install Java Run-time v6.0 or greater.
85
For information on adding a Proficy Portal data source connection, see
Proficy Portal Data Source.
Install 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.
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.
86 Proficy* Workflow
Proficy Real-Time Information Portal
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.
87
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.
You must have installed a supported SQL Server version before you install the reporting database (see Software Requirements). 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
for more information. However, if the Proficy SOA
Server computer meets the requirements for both databases, they can be installed on the same computer.
1.
Place the installation DVD in the DVD drive. If you have
Autoplay enabled, the installation launcher splash screen appears.
88 Proficy* Workflow
Proficy Reporting Database
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.
4.
Select an SSIS version, and then click Next.
NOTE: This step is needed only if more than one version of
SSIS is installed. If only one version of SSIS is installed, then installation proceeds with the next step.
The
Choose Install Location page appears.
5.
Accept the default destination folder or browse for a new location, and then click
Next.
6.
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.
89
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.
7.
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. a) In the SQL field, enter the name of the SQL Server where the SQL database is located. b) In the Database field, enter the name of the production
(SQL) database that you will connect to for synchronization. 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.
8.
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.
9.
In the Configure Security area, enter an Administrator user name and password. This can be the user name and password of any valid Proficy SOA user.
90 Proficy* Workflow
Proficy Reporting Database
10.
Click Install.
11.
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."
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 then select Properties.
The My Computer Properties dialog box appears.
5.
Click the MS DTC tab.
91
IMPORTANT: If you are using Windows 7 or Windows Server
2008, 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.
92 Proficy* Workflow
Proficy Reporting Database
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.
93
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 utility 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.
Proficy task controls and Proficy HMIs are related, but work independently from each other. Therefore, user names and logins are separate.
94 Proficy* Workflow
Task Controls in Proficy HMIs
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 utility. For more information, see
Modify the server configuration for a remote
client. If you install the ActiveX Task List on a different machine than the Proficy Server, you must access the
Configure
Client utility from the following location:
../Program
Files/Proficy/Proficy Task List/Program
.
Modify ActiveX installation configurations
NOTE: To change the server name, use the more information, see
Configure Client
utility. For
Modify the server configuration for a remote client
. If you install the ActiveX Task List on a different machine than the Proficy Server, you must access the
List/Program .
Configure Client
utility from the following location: ../Program Files/Proficy/Proficy Task
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...
Manual
Login
Control
Property
To...
prompt the user to enter a user name and password at each login. allow the user to view the user name and password in the host's object properties.
95
Select...
Password
Encryption
To...
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
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.
NOTE: If it does not appear, double-click
SetupTaskList.exe
from the root directory on the installation
DVD.
2.
Click Install Task List.
96 Proficy* Workflow
Task Controls in Proficy HMIs
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.
The Proficy Workflow Server Configuration page appears.
5.
In the Server Name field, enter the name of the server that you want to install the ActiveX Task List on.
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
Proficy
Task List Configuration
tool.
The Ready to Install page appears.
NOTE: At any time during the installation configuration
process, you can click Back to go to a previous page to change
your settings.
97
9.
Click Install.
10.
When the installation is complete, click Exit.
98 Proficy* Workflow
Key Concepts
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.
Failover Clustering
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.
99
Multiple Server Environments
Proficy SOA provides the ability to install across multiple servers, each of which hosts a set of services. A multi-server environment is transparent and appears to be a single server to remote clients.
The Client
The Proficy 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 client:
Provides you with a command center for interfacing to Proficy applications and third-party legacy systems.
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 client. The table following describes these components.
100 Proficy* Workflow
Key Concepts
Figure 1. Proficy client
Cross
Reference Description
Menu bar: includes access to product information, Help
Menu, client layout modes, Global Displays, Task List, login/logout, system 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.
101
Cross
Reference Description
Resources: includes all the resources that you have added to the model.
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.
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 to the process. However, in other companies, these applications and data are critical to the process and, thus, available only to authorized personnel.
102 Proficy* Workflow
Key Concepts
For more information, see Security and Users and Groups.
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 auditing 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.
103
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 share a common object-oriented system of definition using properties that can be used to 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, Users and
Groups, Production Model, and Events Model.
Navigation and Search
The navigator is one of the main components of the Proficy client, and is used to navigate models to target elements. Using the navigator, you can locate an element of focus, whether by browsing or searching. The navigator provides two tabbed panes: Navigate and Search.
The navigator is a point and click interface on all tabbed areas. The
Navigate tab is the main tab that is used to configure, set up, add, delete, and browse resources within Proficy Workflow.
104 Proficy* Workflow
Key Concepts
The Search tab provides a unique way to search all available objects created within Proficy Workflow. By using the search you can quickly locate and use objects within the system.
For more information, see Navigate Tab and Search Tab.
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 Display Panel.
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.
Data Sources
Proficy Workflow provides the ability to connect to external data sources to access the data contained within those applications.
105
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 3000 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.
106 Proficy* Workflow
Key Concepts
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.
Service Providers
Proficy Workflow provides the ability to connect to external applications, called service providers. These service providers allow you to publish and use the data in those applications within Proficy
Workflow.
NOTE: The Plant Applications service provider (PASP) is provided only for legacy support beginning with Plant Applications version 6.1. New applications, including workflows, should be developed using the
MESCore service provider. GE Intelligent Platforms plans to upgrade only the MESCore service provider.
The Plant Applications service provider provides services to publish the Plant Applications plant model, product, and event resources, and to support operations relevant to the resources. Proficy Workflow clients can then browse Plant Applications resources, such as production lines and units, variables, products and events, and link to or call the interface functions to access Plant Applications data and event services.
107
The MESCore service provider provides services to publish the Plant
Applications plant model, product, and event resources, and to support operations relevant to the resources. Proficy Workflow clients can then browse Plant Applications resources, such as production lines and units, variables, products and events, and link to or call the interface functions to access Plant Applications data and event services.
In order to connect to Plant Applications, you must install a Proficy
Host and the Plant Applications Service Provider. For more information, see Plant Applications Service Provider and Proficy Host.
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.
For more information, see
One-Click Deployment.
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.
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.
108 Proficy* Workflow
Key Concepts
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.
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.
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 Workflows.
109
User-Defined Activities
User activities allow you to develop and store standard and frequently used activities. They are configured in isolation, can be reused in various subprocesses, and have the capability of taking input and output parameters. When a user activity is used by a workflow or subprocess, it cannot be deleted. It also cannot be edited if a workflow that uses the activity is running. A subprocess may be composed of several user activities.
For more information, see User Activities.
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 ad-hoc reports on up-to-date data that you synchronize from your production database.
For more information, see Reporting Database and Reporting Data
Synchronization.
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. This integration allows you to publish data from these products to the Directory of Resources and access it from within the Proficy client.
Help
There are three ways to access the Proficy Workflow help:
110 Proficy* Workflow
Key Concepts
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.
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 button to add boolean terms to your search expression, such as AND,
OR, NEAR, and NOT.
111
If you want to search for a specific phrase, enclose the phrase in quotation marks.
112 Proficy* Workflow
One-Click Deployment
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.
Prerequisites
IMPORTANT: 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.
The NetTCPPortSharing service must be enabled and
started.
Security certificates cannot be deployed remotely. Install
your certificates using one of the following methods:
Run the
ConfigureClient.exe
utility, which is located on the installation DVD. This executable file downloads the certificates from the server and must be run on each computer that uses one-click deployment.
Manually install a copy of the certificates by copying
them from the server to a disk or other portable device, and then installing them, 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
113
http://msdn.microsoft.com/en-us/library/ms752346.aspx
http://www.microsoft.com/technet/prodtechnol/WindowsServer
2003/Library/IIS/cd72c0dc-c5b8-42e4-96c2b3c656f99ead.mspx?mfr=true
Administrator Installation
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 oneclick 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.
114 Proficy* Workflow
One-Click Deployment
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.
115
Supported Regional Settings
Proficy Workflow supports the following regional settings available in the Windows Control Panel.
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.
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 SOA.
Proficy SOA 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
116 Proficy* Workflow
Supported Regional Settings
mm/yy/dd or mm/yyyy/dd
yy/dd/mm or yyyy/dd/mm
yy/mm/dd or yyyy/mm/dd
Regional Language Setting
Avoid changing the language setting when Proficy SOA is running.
System Default Locale
The selected locale must be set as the system default.
117
Daylight Saving Time
In Proficy Workflow, all dates and times are stored independent of time zones, in UTC format.
118 Proficy* Workflow
Special Keyboard Buttons
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 Proficy
Workflow 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.
119
SQL Server Backup and Restore
Proficy Workflow utilizes SQL Server 2008 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.
120 Proficy* Workflow
Contact Information
Contact Information
If you purchased this product through an Authorized Channel Partner, please contact the seller directly.
General
Online technical support & GlobalCare: www.ge-ip.com/support
Comments about our manuals and online Help:
Additional information:
Solution Provider:
Authorization: [email protected] www.ge-ip.com [email protected] [email protected]
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:
Telephone:
International Americas direct dial:
Technical support e-mail:
Customer care e-mail:
Inside Sales:
Primary language of support: www.ge-ip.com/support
1-800-433-2682
1-434-978-5100 [email protected] [email protected] [email protected]
English
121
Europe, Middle East, Africa
Online technical support:
Telephone:
Technical support e-mail:
Customer care e-mail: www.ge-ip.com/support
+800 1-433-2682 [email protected] [email protected]
Inside Sales: [email protected]
Primary language(s) of support: English, French, German, Italian,
Czech, Spanish
Asia Pacific
Online technical support & GlobalCare: www.ge-ip.com/support
Telephone:
+86-21-3217-4826 (India, Indonesia, and Pakistan)
Technical support e-mail:
Customer care e-mail:
+86-400-820-8208 [email protected] (China)
[email protected] (Japan)
[email protected] (other Asian locales) [email protected]
[email protected] (China)
122 Proficy* Workflow
Index
Index
ActiveX Task List ......................................... 94
AD LDS ......................................................... 30
Administrator installation ....................................................... 23
Aladdin HASP key troubleshoot ................................................... 18
Aladdin HASP USB key .............................. 19
Audit trails.................................................... 103
Backup
SQL server .................................................... 120
Certificate Authority .................................... 58
Certificates existing ............................................................ 58 legacy ............................................................... 58 self-signed ....................................................... 58
Client UI ....................................................... 100
Clients clustering ......................................................... 55
Clustering clients .............................................................. 55 multi-server ..................................................... 55 one-click deployment .................................... 56
Data sources ................................................ 105 data items ...................................................... 106
Historian ....................................................... 106
OPC ............................................................... 106
Portal ............................................................. 106
Deploy service providers ............................................ 39
Displays ........................................................ 105
DTC reporting ......................................................... 91
Electronic signatures .................................. 103
Failover cluster hardware requirements .................................... 2
Firewall ports ................................................................ 27
Forms ............................................................ 108
Hardware key defective .......................................................... 18 troubleshoot ................................................... 18
Hardware requirements failover cluster .................................................. 2 legacy server...................................................... 2 multi-server ....................................................... 2
HASP M4 keys .............................................. 16
Headers.asp .................................................... 72
Help ............................................................... 110
HMI .............................. See ActiveX Task List
HyperV ............................................................ 14
Legacy server hardware requirements .................................... 2
License reinstall ............................................................ 18
MIME types ................................................. 113
Models ........................................................... 104
Multi-server clustered .......................................................... 55 deploy service providers ................................ 39 hardware requirements .................................... 2
Navigation .................................................... 104
One-click deployment clustering ......................................................... 56
Parameters command line installation ............................. 69
Performance considerations ......................... 8
Ports firewalls ........................................................... 27
ProficyServer Service marked for deletion ....................................... 55
Reinstall licensing .......................................................... 18
Reporting
DTC ................................................................ 91
SQL Reporting Services ................................ 88
SSIS ................................................................. 88
Restore
SQL server .................................................... 120
123
Search ............................................................ 104
Security .......................................................... 102
Service providers ......................................... 107
Single Sign On ............................................... 26
SiteMinder ...................................................... 72
SQL server backup ..................................... 120
SQL Server Integration Service (SSIS) reporting ......................................................... 88
SQL server restore ...................................... 120
SSO Authentication Failed ......................... 73
SSO Users group........................................... 73
Task Indicator................................................ 94
Troubleshooting
Aladdin HASP key ......................................... 18 hardware key ................................................... 18
Uninstalling
AD LDS .......................................................... 79
SQL server database ...................................... 79
User interface
Proficy Workflow ........................................ 100
User Solutions ............................................. 108
User-defined activities ............................... 110
UTC .............................................................. 118
Virtualized environment ................................ 6
VMWare ..........................................................14
VMWare ESX ................................................14
124 Proficy* Workflow
* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project