Proficy* Change Management for Machine Edition

Proficy* Change Management for Machine Edition
Proficy*
Change Management
for Machine Edition
GETTING STARTED
Version 8.00
2013
GFK-1779R
GSFXmgr.pdf 1
5/1/2013 10:25:56 PM
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
© 2013 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]
GSFXmgr.pdf 2
5/1/2013 10:25:56 PM
Contents
1 Welcome
1
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Proficy Change Management (PCM) Server . . . . . . . . . . . . . . . . . . . . 2
Proficy Change Management (PCM) Thin Client . . . . . . . . . . . . . . . . 4
Proficy Change Management (PCM) Thick Client . . . . . . . . . . . . . . . . 5
Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Proficy HMI/SCADA iFIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Proficy HMI/SCADA CIMPLICITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Using the Software for the First Time . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Product Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Hardware Key Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Software Key Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Upgrading software key to hardware key authorization
. . . . . . . . . . 23
Contact information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
2 Proficy Change Management Environment
27
The Proficy Change Management Server . . . . . . . . . . . . . . . . . . . . . . . . 27
Logging on to Proficy Change Management . . . . . . . . . . . . . . . . . . . 28
The Machine Edition Environment
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Getting to Know Machine Edition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Right-click menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Getting Help
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Accessing the Right Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Projects and the Navigator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Properties and the Inspector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
The Feedback Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
3 Version Control
How Version Control Works
GFK-1779R
GSFXmgr.pdf 3
39
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Proficy* Change Management 8.00
i
5/1/2013 10:25:56 PM
Creating and Adding Projects to the Server
4 Access Control
. . . . . . . . . . . . . . . . . . . 41
43
How Access Control Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
The Access Control Database
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Access Control of Projects and Toolchest drawers . . . . . . . . . . . . . . 44
Access Control of Layouts
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Security Providers
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
System Groups and Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
5 Audit Trailing
47
How Audit Trailing works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
The Audit Trail Database
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Audit Trail Reports
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6 The Scheduler
51
How the Scheduler Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuring Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Event Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Running the Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Starting the Scheduler
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
7 Custom Project Support
55
How Custom Project Support Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Custom Product Type Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Custom Project Access Control and Audit Trail settings . . . . . . . . . . 61
User-defined Custom Project Help . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Scripts for Custom Project right-click menus
. . . . . . . . . . . . . . . . . . 62
Managing Custom Product Types
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Checking out a Custom Product Type from the Server . . . . . . . . . . . 64
Checking in or adding a Custom Product Type to the Server . . . . . . 65
Opening a Custom Product Type’s settings directory in Windows
Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Copying (cloning) a custom Project Type . . . . . . . . . . . . . . . . . . . . . 66
The Add Custom Product Type Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Universal Directory Compare event support . . . . . . . . . . . . . . . . . . . 66
ii
Proficy* Change Management 8.00
GSFXmgr.pdf 4
GFK-1779R
5/1/2013 10:25:56 PM
8 Factory Layouts
69
Using Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
How Layouts work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
The fxPublish directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Using a Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Backing up layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Creating Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Supplemental Files directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
How Change Management generates the published layout files . . . 76
Checking out Layouts from the Server . . . . . . . . . . . . . . . . . . . . . . . 77
Publishing Layouts on the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Creating Layout Page Templates in HTML . . . . . . . . . . . . . . . . . . . . . . . 78
Performing Change Management actions from layout pages . . . . . . 79
Generalizing page templates with XML . . . . . . . . . . . . . . . . . . . . . . . 79
Creating page templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
9 Thin Client
81
Administrative Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Expansion Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Scheduler and Schedule Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
A1 Change Management and iFIX
85
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Setting Up iFIX for use with Change Management . . . . . . . . . . . . . . 89
Quick Tour: Using Change Management Features in iFIX . . . . . . . . . . . 90
Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Using Change Management Features in iFIX . . . . . . . . . . . . . . . . . . 92
Understanding Electronic Signatures . . . . . . . . . . . . . . . . . . . . . . . . 93
Using the Change Management History Window . . . . . . . . . . . . . . . 96
Quick Start: Configuring iFIX with Integrated Change Management . . . . 97
Step 1: Adding a User in iFIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Step 2: Enable Security in iFIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Step 3: Set iFIX User Preferences . . . . . . . . . . . . . . . . . . . . . . . . . 100
Step 4: Add a User and Configure Privileges in Machine Edition . . 101
Step 5: Configure User Privileges in Machine Edition . . . . . . . . . . . 102
GFK-1779R
GSFXmgr.pdf 5
Proficy* Change Management 8.00
iii
5/1/2013 10:25:56 PM
Step 6: Add a Schedule in Machine Edition . . . . . . . . . . . . . . . . . . 103
Step 7: Restart the iFIX WorkSpace . . . . . . . . . . . . . . . . . . . . . . . . 104
A2 Change Management and CIMPLICITY HMI
105
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Setting Up CIMPLICITY for use with Change Management . . . . . . 109
Quick Tour: Using Change Management Features in CIMPLICITY . . . 112
Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Using Change Management Features in CIMPLICITY . . . . . . . . . . 114
Using the Change Management History Window . . . . . . . . . . . . . . 115
iv
Proficy* Change Management 8.00
GSFXmgr.pdf 6
GFK-1779R
5/1/2013 10:25:56 PM
1
Welcome
Congratulations on your purchase of Proficy* Change Management, the most
powerful and flexible automation system management tool available today. With
Proficy Change Management, you can protect and coordinate all your projects
throughout your system’s life cycle. Version control, centralized storage,
security, automatic backups and more—they are all covered.
Proficy Change Management consists of a server and clients.
The server stores Proficy Change Management configuration files and the
projects that are kept under version and access control.
Proficy Change Management has two clients:
■
Thick Client: hosted in the Proficy Machine Edition environment. It can be
installed from the Proficy Change Management CD or from the Proficy
Machine Edition CD.
■
Thin Client: an Internet Explorer-hosted multi-session application available
for installation only on the Proficy Change Management CD. The client
provides access to common end-user functions such as check out, check in,
open, version reports, compare, and more. The client supports popular thirdparty products from Rockwell, Siemens, and Schneider, as well as status and
compare for Proficy Machine Edition. For other project types and the
complete set of features, use the Thick Client.
Proficy Change Management provides the following key features.
■
Centralized Storage & Version Control: tracks projects and safely stores
previous versions. This ensures that everyone uses the correct files and
databases, and virtually eliminates lost work.
■
Access Control: allows only users with approved security to access or
modify projects.
■
Audit Trailing: tracks details of who did what, when, and why.
■
Scheduler: enables the automatic completion of repetitive tasks such as
backups and compares, saving you valuable time.
■
Proficy Software support: Proficy Change Management is integrated with
other Proficy software to provide a comprehensive solution, including
Machine Edition, CIMPLICITY, and iFIX.
Third-party project support: Proficy Change Management is preconfigured
to manage a variety of popular automation products from Rockwell, Siemens,
■
GFK-1779R
GSFXmgr.pdf 7
Proficy* Change Management 8.00
1
5/1/2013 10:25:56 PM
1
Welcome
System Requirements
Schneider, and others, including Modicon ProWORX, Logicmaster 90-30 and
90-70, and Fanuc CNC.
■
Factory Layouts: allows you to organize your projects to better fit your
company’s structure, making it easier for users to navigate to a project.
■
Reporting Tools: allows you to generate detailed reports of audit trails.
■
Electronic Signatures: designed with the regulated companies in mind,
electronic signatures provide an extra level of control by requiring signatures
for changes made to projects.
SYSTEM REQUIREMENTS
Proficy Change Management is comprised of two parts: a Server and a Client. In
a typical system, the Server portion is installed on one networked computer and
the Client portion on each computer that needs access to projects on the server.
To use Proficy Change Management and its tools, you require the following:
Proficy Change Management (PCM) Server
Operating system
Because the opertating system has continuous updates, you should run the
Windows update feature to get the latest software.
■
Microsoft® Windows® XP™ Professional, Service Pack 2 or 3.
■
Microsoft® Windows® Server 2003, Service Pack 2 R2.
■
Microsoft® Windows® Server 2008 (32-bit), Service Pack 2, Standard or
Enterprise Edition.
■
Microsoft® Windows® Server 2008 R2 (64-bit in WoW mode), Standard or
Enterprise Edition.
■
Microsoft® Windows® 7 (32-bit, or 64-bit in WoW mode), Professional or
Ultimate Edition.
Notes
2
✐
Windows regional settings must be set to English.
✐
Proficy Change Management is not supported in environments that use
Microsoft Terminal Services or Microsoft Cluster Server. Windows XP
Tablet PC Edition and Windows XP Embedded are not supported.
Proficy* Change Management 8.00
GSFXmgr.pdf 8
GFK-1779R
5/1/2013 10:25:56 PM
Welcome
System Requirements
Other requirements
■
Ethernet Network Adapter and the TCP/IP Network Protocol (100Mbit).
■
Internet Explorer 9.0, 8.0, 7.0, or 6.0 with SP1 or later.
■
2.0 GHz Pentium-based computer recommended.
See your sales representative for server system recommendations based on
your projected number of Manager Clients and the projected size of your project database.
■
20 GB free hard disk space, plus storage space for project files.
■
1 GB RAM.
■
Microsoft Visual SourceSafe version 6.0d Build 31222 or later (Server
installation), or Visual SourceSafe 2005.
You can obtain version 6.0d by installing Microsoft Visual Studio 6 SP6
update. For more details, visit Microsoft’s web site at www.microsoft.com.
■
GFK-1779R
GSFXmgr.pdf 9
.NET Framework 4.0 Full. If the Microsoft .NET Framework is not yet
installed, it is automatically included during the installation of Change
Management, and a reboot may be required to complete the installation.
Proficy* Change Management 8.00
3
5/1/2013 10:25:56 PM
1
Welcome
System Requirements
Proficy Change Management (PCM) Thin Client
Note: These system requirements apply to the Thin Client, including the
Scheduler and Scheduler Editor used with the Thin Client.
Operating system
Because the opertating system has continuous updates, you should run the
Windows update feature to get the latest software.
■
Microsoft® Windows® XP™ Professional, Service Pack 2 or 3.
■
Microsoft® Windows® Server 2003, Service Pack 2 R2.
■
Microsoft® Windows® Server 2008 (32-bit), Service Pack 2, Standard or
Enterprise Edition.
■
Microsoft® Windows® Server 2008 R2 (64-bit in WoW mode), Standard or
Enterprise Edition.
■
Microsoft® Windows® 7 (32-bit, or 64-bit in WoW mode), Professional or
Ultimate Edition.
Notes
✐
Windows regional settings must be set to English.
✐
Windows XP Tablet PC Edition and Windows XP Embedded are not
supported.
Other requirements
Internet Explorer 9.0, 8.0, 7.0, or 6.0 with SP1 or later.
■
4
■
1.5 GHz Pentium-based computer recommended.
■
50 MB hard disk space, plus storage space for project files (500 MB
recommended to start with).
■
512 MB RAM (1 GB recommended).
■
Ethernet Network Adapter and the TCP/IP Network Protocol (100 Mbit).
■
Microsoft .NET 2.0.
Proficy* Change Management 8.00
GSFXmgr.pdf 10
GFK-1779R
5/1/2013 10:25:57 PM
Welcome
System Requirements
Proficy Change Management (PCM) Thick
Client
Operating System
Because the opertating system has continuous updates, you should run the
Windows update feature to get the latest software.
■
Microsoft® Windows® XP Professional, Service Pack 2 or 3.
■
Microsoft® Windows® Server 2003, Service Pack 2 R2.
■
Microsoft® Windows® Server 2008 (32-bit), Service Pack 2, Standard or
Enterprise Edition.
■
Microsoft® Windows® Server 2008 R2 (64-bit in WoW mode), Standard or
Enterprise Edition.
■
Microsoft® Windows® 7 (32-bit, or 64-bit in WoW mode), Professional or
Ultimate Edition.
Notes
✐
Windows regional settings must be set to English.
✐
Proficy Change Management is not supported in environments that use
Microsoft Terminal Services or Microsoft Cluster Server.
✐
Windows XP Tablet PC Edition and Windows XP Embedded are not
supported.
Other requirements
Internet Explorer 9.0, 8.0, 7.0, or 6.0 with SP1 or later.
■
GFK-1779R
GSFXmgr.pdf 11
■
1.5 GHz Pentium-based computer recommended.
■
50 MB hard disk space, plus storage space for project files (500 MB
recommended to start with).
■
512 MB RAM (1 GB recommended).
■
Ethernet Network Adapter and the TCP/IP Network Protocol (100 Mbit).
■
.NET Framework 4.0 Full. If the Microsoft .NET Framework is not yet
installed, it is automatically included during the installation of Change
Management, and a reboot may be required to complete the installation.
Proficy* Change Management 8.00
5
5/1/2013 10:25:57 PM
1
Welcome
System Requirements
Scheduler
Note: These system requirements apply only to the Scheduler used with the
Thick Client.
Operating system
Because the opertating system has continuous updates, you should run the
Windows update feature to get the latest software.
■
Microsoft® Windows® XP Professional, Service Pack 2 or 3.
■
Microsoft® Windows® Server 2003, Service Pack 2 R2.
■
Microsoft® Windows® Server 2008 (32-bit), Service Pack 2, Standard or
Enterprise Edition.
■
Microsoft® Windows® Server 2008 R2 (64-bit in WoW mode), Standard or
Enterprise Edition.
■
Microsoft® Windows® 7 (32-bit, or 64-bit in WoW mode), Professional or
Ultimate Edition.
Notes
✐
Windows regional settings must be set to English.
✐
Windows Vista, Windows XP Tablet PC Edition, and Windows XP
Embedded are not supported.
Other requirements
Proficy Change Management Client.
■
6
■
Internet Explorer 9.0, 8.0, 7.0, 6.0 with SP1 or later, or 5.5 with SP2 Q810847
or later.
■
1.5 GHz Pentium-based computer recommended.
■
50 MB hard disk space (in addition to hard disk space required for the Proficy
Change Management Client).
■
512 MB RAM (1GB recommended).
■
Ethernet network adapter (100 Mbit) and TCP/IP network protocol. (See
system requirements for the Proficy Change Management Client.)
■
.NET Framework 4.0 Full. If the Microsoft .NET Framework is not yet
installed, it is automatically included during the installation of Change
Management, and a reboot may be required to complete the installation.
Proficy* Change Management 8.00
GSFXmgr.pdf 12
GFK-1779R
5/1/2013 10:25:57 PM
Welcome
Installation
Proficy HMI/SCADA iFIX
For iFIX 4.0 or higher system requirements, see the iFIX online help topics
Software Requirements and Hardware Requirements.
Proficy HMI/SCADA CIMPLICITY
For CIMPLICITY 7.0 or higher system requirements, see the CIMPLICITY online
help topic Required and Supported Software and Hardware.
INSTALLATION
A typical Proficy Change Management system consists of a Proficy Change
Management Server on a dedicated network computer and a Client on each
computer that requires access to projects on the server. (You can also install a
Client on the same computer as the Server.)
IMPORTANT: The following installation procedures are for a fresh, brand-new
installation of Proficy Change Management. If you are upgrading from a previous
version (including versions of CIMPLICITY Manager or fxManager), look in
Change Management’s “Release Notes” section in the Important Product
Information (IPI) document, IPICimME.chm for instructions. A link to this
document can be found in the root folder of the Proficy Change Management
installation CD.
To ins tall the Prof icy Cha nge Managem ent Ser ver
The Change Management Server stores and manages the project database,
which is kept under Version and Access Control. The Server uses Microsoft
Visual SourceSafe (a proven, reliable management program) for its version
control system.
1. Before you start:
GFK-1779R
GSFXmgr.pdf 13
■
Ensure that you install and authorize the Change Management Server during
regular business hours for Product Authorization, between 6 a.m. and 6 p.m.
Mountain Time.
■
Ensure that the installation of Microsoft Visual SourceSafe to be used by
Proficy Change Management has the latest patches and service packs (at
least version 6.0d build 32111 or Visual SourceSafe 2005).
Proficy* Change Management 8.00
7
5/1/2013 10:25:57 PM
1
Welcome
Installation
■
If you want to use the Intellution iFIX custom product module, ensure that iFIX
is installed to the same directory location on all Proficy Change Management
Client workstations that will use the same set of projects.
2. Start the Change Management installation process.
Place the Proficy Change Management installation CD in the CD-ROM drive. If
you have Autoplay enabled, the installation launcher splash screen should
appear. If it does not appear, run Setup.EXE on the root directory of the Change
Management CD.
3. Click Install PCM Server/Client. In the Setup message box that appears, click
Yes.
4. On the Proficy Change Management splash screen, click Install.
Follow the on-screen prompts in the Proficy Machine Edition Setup dialog box,
clicking Next each time, until you are asked to select the components to install.
5. Select the appropriate installation options.
In the Proficy Machine EditionSetup dialog box, ensure that the following
features are selected to be installed:
■
Change Management Client
■
Under Change Management Client | Product Support Modules, all products
you want to use with Change Management
■
Change Management Server
Change Management Client | Scheduler
The icon next to a feature option indicates the install state of that feature. A red X
means the feature will not be installed. Click the icon to open a menu that lets
you change the install state for that feature. When completed to your
satisfaction, click Next.
■
Notes:
■
The Modicon ProWORX module is automatically included if you have
ProWORX NxT installed on the local workstation. This means you will no
longer be able to launch ProWORX NxT except from the Proficy Change
Management environment. If you do not want to use Proficy Change
Management with ProWORX NxT projects, ensure that you clear the
Modicon ProWORX module installation option.
■
If the Windows Firewall is active, then Change Management must to be
added to the exceptions list before you can use the product.
6. Finish the installation.
8
Proficy* Change Management 8.00
GSFXmgr.pdf 14
GFK-1779R
5/1/2013 10:25:57 PM
Welcome
Installation
Continue with the rest of the installation, following the instructions on each
screen.
When the Proficy Change Management Server configuration dialog box
appears, click OK to accept the default settings. You should not change any of
the specified information unless the SourceSafe database or Audit Trail
database is moved from its default installation location.
7. If you are using a hardware key, insert the key into an available USB port on the
computer. If you are using a software key, look up Product Authorization in the
online help for information on how to authorize Change Management by using a
software key.
8. Install Proficy Machine Edition. You may need to reboot the computer when
installation is complete.
9. Start Proficy Machine Edition (Change Management). To do so, click the Start
button on the Windows taskbar, then choose (All) Programs| Proficy | Proficy
Machine Edition | Proficy Machine Edition.
10. In the Change Management Log On dialog box that appears, the first time you
start Change Management, enter the following for each item:
■
For the Username, enter “Administrator”.
■
For Password, enter nothing, leaving it blank,
■
If necessary, for Domain, select the network domain of the Proficy Change
Management Server. In most cases, this is not needed.
■
For Server, enter the name of the computer with the Proficy Change
Management Server. This will be the local computer. If you do not know the
name of the local computer, click Browse Network to browse the available
computers on the network.
When you are done, click OK.
11. If you are asked to select a theme, choose Change Management and click OK.
12. The Machine Edition environment displays the tools for working with Proficy
Change Management.
IMPORTANT: It is recommended that you immediately set up a new password
for the Administrator user. The Administrator user is a system user who always
has full access to Proficy Change Management features. Initially, this user’s
password is blank. To change the Administrator’s password, check out the
Access Control folder, then right-click the Administrator user and choose
Change Password. Check in the Access Control folder when you are done.
If you intend to use Change Management’s Audit Trailing features (and you are
using the default Audit Trail database format), you must share the Audit Trail
GFK-1779R
GSFXmgr.pdf 15
Proficy* Change Management 8.00
9
5/1/2013 10:25:57 PM
1
Welcome
Installation
database folder on the Proficy Change Management Server to all Client
computers with “read” permissions. This allows users to view audit trail data.
The default directory path for the audit database is “C:\Program
Files\Proficy\Proficy Machine Edition\fxManager\Server\Audit Database”.
TIP: You can also store audit trail records in an Oracle or Microsoft SQL Server
database. For more details, look up “Oracle Audit Trail databases” or “Microsoft
SQL Server Audit Trail databases” in the Proficy Change Management online
help.
What t o do next?
Install Proficy Change Management Clients.
If you intend to use Audit Trailing, share the Audit Trail database folder on the
Proficy Change Management Server with “Read” permissions. This allows users
to read audit trail data. The default directory path for the Proficy Change
Management Server is “C:\Program Files\Proficy\Proficy Machine
Edition\fxManager\Server”.
10
Proficy* Change Management 8.00
GSFXmgr.pdf 16
GFK-1779R
5/1/2013 10:25:57 PM
Welcome
Installation
To ins tall the Prof icy Cha nge Managem ent Thick Client
You must install the Change Management Thick Client on each computer that
will access the Change Management Server. The Change Management Thick
Client is automatically included when you install a Change Management Server.
You do not need to separately install the Thick Client on the Server computer.
To install the Change Management Thick Client, follow the steps below on the
Thick Client workstation computer.
1. Before you start:
■
Ensure that the Change Management Thick Client workstation has a valid
Ethernet network connection to the computer running the Change
Management Server.
■
If you want to use the Intellution iFIX custom product module, ensure that iFIX
is installed to the same directory location as that of all other Proficy Change
Management Thick Client workstations that will use the same set of iFIX
projects. By default, iFIX is installed to "C:\Program Files\Proficy\Proficy
iFIX".
2. Start the Change Management installation process.
Place the Proficy Change Management installation CD in the CD-ROM drive. If
you have Autoplay enabled, the installation launcher splash screen should
appear. If it does not appear, run Setup.exe on the root directory of the CD.
3. Click Install PCM Server/Client. In the Setup message box that appears, click
Yes.
4. On the Proficy Change Management splash screen, click Install.
Follow the on-screen prompts in the Proficy Machine Edition Setup dialog box,
clicking Next each time, until you are asked to select the components to install.
In the Proficy Machine Edition Setup dialog box, ensure that the following
features are selected to be installed:
■
Change Management Client
■
Under Change Management Client | Product Support Modules, all products
you want to use with Change Management
IMPORTANT: If you are using either CIMPLICITY or iFIX for integrated
Change Management, do not select that product support module (that is,
Cimplicity HMI or Intellution iFIX) to be installed. Make sure a red X appears
beside the module name.
■
GFK-1779R
GSFXmgr.pdf 17
(Optional.) Change Management Client | Scheduler
Proficy* Change Management 8.00
11
5/1/2013 10:25:57 PM
1
Welcome
Installation
The icon next to a feature option indicates the install state of that feature. A red X
means the feature will not be installed. Click the icon to open a menu that lets
you change the install state for that feature. When completed to your
satisfaction, click Next.
Notes:
■
Ensure that Change Management Server is not selected to be installed.
■
The Modicon ProWORX module is automatically included if you have
ProWORX NxT installed on the local workstation. This means you will no
longer be able to launch ProWORX NxT except from the Proficy Change
Management environment. If you do not want to use Proficy Change
Management with ProWORX NxT projects, ensure that you clear the
Modicon ProWORX module installation option.
■
If the Windows Firewall is active, then Change Management must to be
added to the exceptions list before you can use the product.
5. Finish the installation.
Continue with the rest of the installation, following the prompts on each screen
until you are done.
6. Reboot the computer when installation is complete.
7. You will need to specify the default Change Management Server for this Thick
Client installation. Start Change Management. To do so, click the Start button on
the Windows taskbar, then choose Programs| Proficy | Proficy Machine Edition |
Proficy Machine Edition.
8. The Change Management Log On dialog box appears. The first time you start
Change Management, enter the following for each item:
■
For the Username, enter the user name for your account. To log in as the
Administrator, enter “Administrator”.
■
For Password, enter the password for your account.
Your system administrator should have added a user account for you to the
Change Management Server. Contact your system administrator to find out
your Username and initial Password. If you do not yet have a user account,
your system administrator may have you temporarily log in as the
Administrator user.
■
12
For Server, enter the name of the computer that is hosting the Change
Management Server. If you do not know the name of the computer, click
Browse Network to browse locate the computer on the network, or click
Scan for Servers to scan the network for valid Change Management Server
installations.
Proficy* Change Management 8.00
GSFXmgr.pdf 18
GFK-1779R
5/1/2013 10:25:57 PM
Welcome
Installation
Note: Scanning for servers may take several minutes.
Note: Scanning for servers may take several minutes depending on the
speed of your network. If possible, it is recommended that you either enter
the Server name or browse to the Server computer.
When you are done, click OK.
This sets the default Server for the Change Management Thick Client. When the
Proficy Change Management environment loads, you can exit Machine Edition.
What t o do next?
In Proficy Change Management’s Access Control folder, add users to the Proficy
Change Management user list. This should be performed by the Proficy Change
Management Administrator.
For more details, see “Access Control” on page 43, or look up “Access Control:
an Overview” in the online help.
To ins tall the Proficy Cha nge Management Thin Client
Installing the Proficy Change Management Thin Client installs the Thin Client,
Thin Client Scheduler and Schedule Editor applications on your computer.
1. Before you start:
■
Ensure that the Change Management Thin Client workstation has a valid
Ethernet network connection to the computer running the Change
Management Server.
2. Start the Change Management Thin Client installation process.
Place the Proficy Change Management installation CD in the CD-ROM drive. If
you have Autoplay enabled, the installation launcher splash screen should
appear. If it does not appear, run Setup.exe on the root directory of the CD.
3. Click Install PCM Thin Client.
Follow the on-screen prompts in the Proficy Change Management Thin Client
dialog box, clicking Next each time until you reach the Installation Options page.
4. Select the appropriate installation options.
■
Upgrade Product Modules - automatically upgrades your system resources.
Note: You must have the Edit Custom Settings permission in order to
upgrade your system resources.
GFK-1779R
GSFXmgr.pdf 19
■
Scheduler automatically starts on boot up - each time you start your
computer, the Scheduler starts.
■
Register controls with Internet Explorer - registers the .dlls with the system so
that they are trusted by Internet Explorer.
Proficy* Change Management 8.00 13
5/1/2013 10:25:57 PM
1
Welcome
Installation
Note: If you are running the Thin Client locally, you are asked to allow the
controls to run. If you are running the Thin client through IIS, the controls will run
automatically.
5. Finish the installation.
Continue with the rest of the installation, following the prompts on each screen
until you are done.
Notes:
■
If you selected the Upgrade Product Modules option, the Proficy Change
Management (PCM) Thin Client Login dialog box appears. Logging in
updates the default server for future logins.
■
If you did not select any installation options, only the PCM Data Folder dialog
box appears.
6. Enter the following for each item:
■
For the Username, enter the user name for your account. To log in as the
Administrator, enter “Administrator”.
■
For Password, enter the password for your account.
Your system administrator should have added a user account for you to the
Change Management Server. Contact your system administrator to find out
your Username and initial Password. If you do not yet have a user account,
your system administrator may have you temporarily log in as the
Administrator user.
For Server, enter the name of the computer that is hosting the Change
Management Server.
When you are done, click Connect.
■
This sets the default Server for the Change Management Client.
To ins tall Proficy C hange Mana ge me nt Thin C l ie nt for IIS
1. Before you start:
14
■
Ensure that the Change Management Thin Client workstation has a valid
Ethernet network connection to the computer running the Change
Management Server.
■
Install Microsoft Internet Information Services (IIS) web server version 6.0 or
higher on the computer you want to install Proficy Change Management for
IIS.
Proficy* Change Management 8.00
GSFXmgr.pdf 20
GFK-1779R
5/1/2013 10:25:57 PM
Welcome
Installation
Note: For the IIS selections IIS Metabase and IIS 6 configuration
compatibility must be checked for IIS 7.0 and above.
■
Install the Proficy Change Management Thin Client on this computer. For the
installation steps, refer to the procedure To install Proficy Change
Management Thin Client.
Note: When you reach Step 4 in the installation steps for the Proficy Change
Management Thin Client, ensure that you select the “Register controls with
Internet Explorer” option to register the .dlls with the system so that they are
trusted by Internet Explorer.
2. Start the Installation Process for Microsoft AJAX.
Place the Proficy Change Management installation CD in the CD-ROM drive. If
you have Autoplay enabled, the installation launcher splash screen should
appear. If it does not appear, run Setup.exe on the root directory of the CD.
3. Click Ajax Extensions 1.0.
4. Follow the on screen directions and click Finish to complete install.
5. Click Install PCM Thin Client for IIS.
6. Follow the on-screen prompts in the PCM Thin Client for IIS dialog box, clicking
Next each time until you reach the Select Installation Address page.
7. In the Virtual Directory field, leave the default name of PCMIIS, or optionally,
change this entry to another value.
Important: The values you enter in these fields are used when you launch
Proficy Change Management for IIS. If you are using fields other than the
defaults, ensure that you enter them correctly.
8. Continue to click Next until you reach the end of the installation.
9. Click Close to finish the install process.
Note: If the installer does not complete, IIS was configured after .NET was
installed. The reason for the failure is the corrupted .NET 2.0. You may need to
uninstall and re-install .NET 2.0 using the following steps at command prompt:
■
From the command prompt, navigate to:
C:\Windows\Microsoft.NET\Framework\2.0.50727\
■
Execute the following command: aspnet_regiis.exe -u
■
Execute the following command: aspnet_regiis.exe -i
The first command (aspnet_regiis.exe -u) will uninstall.NET with IIS. The
second command (aspnet_regiis.exe -i) will re-install. After this is done, the
installer should complete.
GFK-1779R
GSFXmgr.pdf 21
Proficy* Change Management 8.00 15
5/1/2013 10:25:57 PM
1
Welcome
Installation
10. On the IIS Server, give the ASPNET user at least Write access to the main
PCMIIS path via windows security for the folder. It is recommended to initially
give Read/Write + Modify access for the PCMIIS folder to the Everyone group.
Otherwise, provide similar access to active IIS services as appropriate.
Make sure the Internet Explorer browser settings allow ActiveX control install.
Access the PCM Thin Client through IIS after the new install using IIS Virtual
Path>/default.aspx. (<PCM IIS Virtual Path> is the directory you created when
you installed PCM Thin Client for IIS.)
To crea te a node t ree for PCM Thin C lient for IIS
1. Log into the Proficy Change Management Thin Client:
a) Click Start, point to Programs, then Proficy, then to Proficy Change
Management, and click PCM Thin Client.
Note: A warning message may appear in Internet Explorer. Right-click the
message and click Allow Blocked Content. The PCM Thin Client login
dialog box appears.
b) Enter your Username and Password. If necessary, enter the Server name.
c) Click Connect.
Change Management searches the network for the specified Change
Management Server. When it finds the server, it checks the list of users and
passwords against the information you entered. If there are any errors, check
the spelling of your username, password, or the Change Management
Server, and try again.
If everything matches, the Thin Client opens and you are logged on to the
Change Management Server.
2. Click the Copy to IIS button to copy the node tree XML file to the Virtual
Directory folder where you installed IIS.
Important:
■
If you forget to copy the NodeTree.xml file, your PCM IIS window
appears blank when you open it for the first time.
If you make changes to the node tree, such as by adding files on the
Server, make sure that you click the Copy to IIS button to update the
NodeTree.xml file on your PCM IIS computer.
You can now log on to the IIS Client from Internet Explorer. For example, use a
URL similar to the following:
■
http://ComputerName/PCMIIS/default.aspx
16
Proficy* Change Management 8.00
GSFXmgr.pdf 22
GFK-1779R
5/1/2013 10:25:57 PM
Welcome
Installation
where ComputerName is the actual name of the computer where PCM for IIS is
installed, and VirtualDirectory is the name of the folder where PCM for IIS is
installed, which by default is PCMIIS.
Important Information for Proficy Change Management Thin Client for IIS
When you install the Proficy Change Management Thin Client, if you do not
select the “Register controls with Internet Explorer” option to register the .dlls
with the system so that they are trusted by Internet Explorer, you need to make
some adjustments in Internet Explorer before you can use Proficy Change
Management for IIS.
For Windows 2003 and Windows XP: In Internet Explorer, in the Internet
Security settings, ensure that the “Initialize and script ActiveX controls not
marked as safe for scripting” option is set to Prompt or Enabled.
For Windows 7 and above: In Internet Explorer, in the Trusted Sites Security
settings, ensure that the “initialize and script ActiveX controls not marked as safe
for scripting” option is set to Prompt or Enabled. Additionally, ensure that your
Trusted sites include the Proficy Change Management IIS site.
To upda te Int ernet Se curit y Se tt ings
1. From the Tools menu, click Internet options.
2. In the Internet Options dialog boxthat appears, click the Security tab.
3. Select the Internet zone.
4. Click Custom Level to open the Security Settings dialog box.
5. In the Settings list box, make sure the “Initialize and script ActiveX controls not
marked as safe for scripting” option is set to Prompt or Enabled.
To upda te Tr uste d Site s Securit y Se tt ings
1. From the Tools menu, click Internet Options. The Internet Options dialog box
appears.
2. Click the Security tab.
3. Select the Trusted Sites zone.
4. Click Custom Level to open the Security Settings dialog box.
5. In the Settings list box, ensure that the “Initialize and script ActiveX controls not
marked as safe for scripting” option is set to Prompt or Enabled.
GFK-1779R
GSFXmgr.pdf 23
Proficy* Change Management 8.00 17
5/1/2013 10:25:57 PM
1
Welcome
Installation
To upda te t he Trust ed Sit es list
1. From the Tools menu, click Internet Options.
2. In the Internet Options dialog box that appears, click the Security tab.
3. Select the Trusted Sites zone.
4. Click Sites to open the Trusted Sites dialog box.
5. In the “Add this website to the zone” edit box, enter the name of the PCM IIS
web site. For example, use a URL similar to the following:
http://ComputerName/PCMIIS/default.aspx
where ComputerName is the actual name of the computer where PCM IIS is
installed, and PCMIIS is the name of the virtual directory.
6. Clear the Require Server Verification check box.
7. Click Close.
18
Proficy* Change Management 8.00
GSFXmgr.pdf 24
GFK-1779R
5/1/2013 10:25:57 PM
Welcome
Using the Software for the First Time
USING THE SOFTWARE FOR THE
FIRST TIME
When you use Proficy Change Management for the first time, the Proficy
Change Management administrator must set up users and assign passwords to
allow them to access the Proficy Change Management database stored on the
Server.
IMPORTANT: These steps are performed using the Proficy Change
Management Thick Client only. You cannot perform these steps using the Thin
Client. You must perform these steps in order for the Thin Client to work.
To sta rt Profic y Change Mana geme nt
1. Click
, point to Programs, then Proficy, then Proficy Machine Edition,
and click
Proficy Machine Edition.
The Change Management Log On dialog box appears.
2. Log on as “Administrator”.
Leave the password field blank. For Domain, select the network domain of the
Proficy Change Management Server, if necessary. For Server, enter the name of
the computer with the Proficy Change Management Server.
If you are not sure where the Server is located, click Browse Network to browse
the computers available on the network. You can also click Scan for Servers to
scan the network for valid Proficy Change Management Servers, though this
operation may take several minutes.
When you are done, click OK.
3. If asked to select a Theme, choose Change Management and click OK.
Themes are pre-configured sets of tools, toolbars, and other options that are
suitable for a specific product or type of user.
4. Check out the Access Control folder.
To do so, in the Manager tab of the Navigator, right-click the Access Control
folder and choose Check Out Access Control. You must check out this folder
to edit and configure users, groups, and permissions.
CAUTION: You must check out and check in the Access Control folder prior to
using the Change Management Thin Client for the first time. If you do not
perform this task before the initial use of the Thin Client, unexpected behavior
can occur.
5. Set up a password for the Administrator user.
GFK-1779R
GSFXmgr.pdf 25
Proficy* Change Management 8.00 19
5/1/2013 10:25:57 PM
1
Welcome
Using the Software for the First Time
Set up a unique password for the Administrator user in the Access Control
folder, located in the Manager tab of the Navigator. The Administrator user will
always have full access to Proficy Change Management and its databases.
If you do not configure a password for this user, anyone will be able to log in as
an Administrator.
For details on configuring Access Control, see Chapter 4 on page 43, or look up
“Access Control: an Overview” in the Proficy Change Management online help.
6. Recommended: Add additional users.
Add users to the Access Control folder and assign them unique names and
passwords. The users you configure are associated with the Server you're
logged on to.
7. Recommended: Set up groups for your users.
After creating groups, you can configure their access permissions, then assign
users to the groups.
8. Perform Product and Site-specific Modifications.
Depending on the custom project modules you installed, you may need to
perform some additional site-specific modifications. For details, see the Release
Notes tab for the Change Management product in the Important Product
Information document (IPI), IPICimME.chm. A link to this document can be
found in the root folder of the Proficy Change Management installation CD.
IMPORTANT: After you have performed any site-specific modifications, make
sure you check in all changed setting files under the “Custom Project Settings”
folder in the Navigator. You need do this only once; other Change Management
Clients will automatically acquire updated product type settings when they
connect to the Change Management Server.
9. Check in the Access Control folder when you are done.
10. Exit Proficy Change Management.
Any user you have added to the Change Management Server can log in from
any Client. When any site-specific modifications are complete, ensure that you
check in all changed setting files under the “Custom Project Settings” folder in
the Manager tab of the Navigator. You need to do this from only one Proficy
Change Management Thick Client.
20
Proficy* Change Management 8.00
GSFXmgr.pdf 26
GFK-1779R
5/1/2013 10:25:57 PM
Welcome
Product Authorization
PRODUCT AUTHORIZATION
Product authorization is required only for Change Management Server
installations. You do not need to authorize your copy of the Change
Management Client.
A new installation of Proficy Change Management, provides a 4-day trial license
with full access to Change Management features. This license overrides all other
licensing and cannot be removed. Any licensing added will be apparent on the
fifth day.
To continue using Change Management beyond the 4-day trial period, you must
authorize the software.
Two types of authorization are available: hardware key authorization and
software key authorization. On a single computer, it is not recommended to use
both types of authorization.
Hardware Key Authorization
A M4 or MAX USB hardware key contains authorization files that are read by the
Proficy Common License Viewer, which enables Proficy products, including
Change Management, to execute.
To see wha t P rofi cy products are a ut hori ze d by a hardwa re ke y
• On the operating system Start menu, point to Programs, then to Proficy
Common, and then choose License Viewer.
To authoriz e Proficy Change Mana geme nt S erve r wi th a har dware k ey:
Hardware key authorization requires a free USB port on your computer.
1. Find out which version of the Proficy Licensing Software is installed on your
computer: On the operating system’s Start menu, point to Programs, then to
Proficy Common, and then choose License Viewer. In the top right corner of
the License Viewer window that appears, click About. Take note of the version
number that appears and click OK.
2. If this is the first time you install a Proficy product, access http://support.ge-
ip.com, and in the top right corner, click Register. In the Single Sign On page
that appears, enter your email address and click Submit. When you receive a
GE Intelligent Platforms Web Access Registration email, follow the instructions.
In the Single Sign On -- SSO Registration application window that appears, fill
out the information and click Submit.
GFK-1779R
GSFXmgr.pdf 27
Proficy* Change Management 8.00 21
5/1/2013 10:25:57 PM
1
Welcome
Product Authorization
3. Access http://support.ge-
ip.com/support/index?page=securitykey&id=ST15&lclicked=Licensing Key
Updates (login req). Enter your SSO User ID and Password. In the middle of the
page that appears, follow the Updating the Max/M4 or Pro/M1 key procedure,
keeping in mind the following:
■
Change Management does not support the insertion of a hardware key into a
parallel port, the insertion of hardware keys in multiple USB ports, or the
combination of a hardware key with a software key on the same computer.
■
If the web site refers to a more recent version than the one on your computer,
uninstall your current version, download the more recent version, and install
it.
■
The USB port is usually located on the front or back of your tower case, or in
the side of a laptop. We do not recommend using a USB port on your monitor.
■
If this is a new hardware key, double-click the license file <serialnumber>.plic
(supplied by your local distributor). In the wizard that appears, accept all the
defaults. The license file will be flashed onto your key.
■
The first time you plug the key into a USB port, you see a progress dialog box
that indicates that Windows has detected new hardware and is updating its
system settings. After the dialog box disappears, the settings stored in the
hardware key are active and you can use the products that it authorizes.
You must leave the hardware key in the port while using Proficy products. If you
remove the key from the port, authorization for those products is removed and
replaced with read-only access to your projects.
To move t he aut horiza tion to anot her com puter
• Remove the hardware key from the source computer and follow the previous
procedure on the destination computer.
After the authorization file <serialnumber>.plic has been flashed to the M4 or
MAX hardware key, it can be used on any computer on which the current version
of the Proficy Common License Viewer is installed.
22
Proficy* Change Management 8.00
GSFXmgr.pdf 28
GFK-1779R
5/1/2013 10:25:57 PM
Welcome
Product Authorization
Software Key Authorization
When authorizing Change Management with a software key, you need to contact
us by telephone, fax, or e-mail. Note that authorization personnel are available
only during regular business hours, between 6 a.m. and 6 p.m. MST.
Software key authorization is specific to a single computer or workstation. If you
want to work with Change Management on a different workstation, you must
move the authorization to that second workstation.
For detailed information about software key authorization, look up “Product
Authorization” in the online help.
Upgrading software key to hardware key
authorization
To change a s oft ware k ey t o a ha rdware key or v ic e- vers a:
• Contact your local distributor.
GFK-1779R
GSFXmgr.pdf 29
Proficy* Change Management 8.00 23
5/1/2013 10:25:57 PM
1
Welcome
Contact information
CONTACT INFORMATION
If you purchased this product through an Authorized Channel Partner, please
contact the seller directly.
General Contact Information
Online Technical Support and GlobalCare: www.ge-ip.com/support
Comments about our manuals and online help: [email protected]
Additional information: www.ge-ip.com
Solution Provider: [email protected]
Authorization: [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 email, or on the web at www.geip.com/support.
Americas
Online Technical Support: www.ge-ip.com/support
Phone: 1-800-433-2682
International Americas Direct Dial: 1-780-420-2010 (if toll free 800 option is
unavailable)
Technical Support email: [email protected]
Customer Care email: [email protected]
Inside Sales: [email protected]
Primary language of support: English
Europe, the Middle East, and Africa (EMEA)
Online Technical Support: www.ge-ip.com/support
Phone: +800 1-433-2682
EMEA direct dial: +1 780-401-7717 (if toll free 800 option is unavailable or if
dialing from a mobile telephone)
Technical Support email: [email protected]
Customer Care email: [email protected]
Inside Sales: [email protected]
Primary languages of support: English, French, German, Italian, Czech,
Spanish
24
Proficy* Change Management 8.00
GSFXmgr.pdf 30
GFK-1779R
5/1/2013 10:25:57 PM
Welcome
Contact information
Asia Pacific
Online Technical Support and GlobalCare: www.ge-ip.com/support
Phone: +86-400-820-8208
+86-21-3217-4826 (India, Indonesia, and Pakistan)
Technical Support Email: [email protected] (China)
[email protected] (Japan)
[email protected] (other Asian locales)
Customer Care Email: [email protected]
[email protected] (China)
GFK-1779R
GSFXmgr.pdf 31
Proficy* Change Management 8.00 25
5/1/2013 10:25:57 PM
1
26
Welcome
Contact information
Proficy* Change Management 8.00
GSFXmgr.pdf 32
GFK-1779R
5/1/2013 10:25:57 PM
2
Proficy Change Management Environment
Proficy Change Management uses Change Management technology to offer you
a complete automation system management tool.
The first section in this chapter explains the Proficy Change Management
Server—the heart of a Proficy Change Management system. The second
section provides an overview of the Change Management Client. The third
section provides some key Change Management concepts you’ll need to know
before you begin. When you are finished, you will have a solid foundation for
managing and working with projects under Proficy Change Management.
THE PROFICY CHANGE
MANAGEMENT SERVER
The Server is at the heart of Proficy Change Management. All projects and
settings, from user passwords to Scheduler events, are stored on the Server.
This includes:
■
All projects managed by Proficy Change Management.
■
Lists of users, groups, and permissions.
■
Lists of Audit Trail settings.
■
The Scheduler event list.
■
Custom Project settings and scripts.
■
Web-based Factory Layouts.
Most systems have only one Server. Other computers in the system run Proficy
Change Management as a client. The term client refers to its relationship with
the Server: the Server gives (or “serves”) data upon requests from the client.
Technically, the term “Server” refers only to the module in the Change
Management application that manages databases. However, in a typical
automation management system, “Server” refers to the computer that the
GFK-1779R
GSFXmgr.pdf 33
Proficy* Change Management 8.00 27
5/1/2013 10:25:57 PM
2
Prof icy Change Management Environment
The Proficy Change Management Server
Proficy Change Management Server application is running on. The following
illustration depicts a typical Change Management Client/Server system.
Typical Proficy Change Management System
Change
Management Server
Change
Management
Client
Change
Management
Client
Change
Management
Client
The most important role the Proficy Change Management Server performs is as
a centralized storage place for your projects under Version Control. When users
want to work on something stored on the Proficy Change Management Server,
they check out the item, make their changes, then check it back into the Server.
For more information on Version Control, see “Version Control” on page 39.
Logging on to Proficy Change Management
When you start Proficy Change Management, you must choose a Server and log
on as one of the users in its user database. (If you have not been added to the
Proficy Change Management Server, you can log on as a Guest user by entering
the username “Guest”.) At this time, you also have the option of working
connected or disconnected from the Server.
■
28
If you are logging on to Proficy Change Management for the first time, you
must log on connected to the Server.
Proficy* Change Management 8.00
GSFXmgr.pdf 34
GFK-1779R
5/1/2013 10:25:57 PM
Prof icy Change Management Environment
The Proficy Change Management Server
You can choose a different Server each time you log on, but each Server
maintains separate user databases. This means an Administrator must add you
as a user to all Proficy Change Management Servers you will be working on.
Type in your Proficy
Change Management
username and
password.
Select a Domain if
using an external
security provider.
Select a Change
Management
Server.
If your administrator has configured your system to use an external security
provider (such as the Windows NT network’s user accounts), this dialog box may
not appear. Instead, Proficy Change Management will use the user name of the
user currently logged on to the local workstation.
Working connec te d t o the Serv er
If you work connected to the Server, Proficy Change Management establishes a
communications link with the Server when you log on. It then copies and
updates any necessary settings from the Server to the local client computer.
If settings or projects change on the Server while you are connected, you can
refresh the display.
Most operations that use the Server—such as checking items in and out—can
be performed only while connected to the Server.
Working disconne cte d f rom t he Serve r
If you work disconnected from the Server, Proficy Change Management does
not update any settings or project information in the server’s database. The list
of projects, Access Control settings, and everything else will be unchanged from
the last time someone logged on to the Server from that computer. You can still
work on projects and items that are checked out of the Server, or for which a
local version exists on the client computer. However, you will not be able to
check in anything until you connect to the Server again.
GFK-1779R
GSFXmgr.pdf 35
Proficy* Change Management 8.00 29
5/1/2013 10:25:57 PM
2
Prof icy Change Management Environment
The Machine Edition Environment
Since Proficy Change Management does not have to update information across
the network, working disconnected from the Server is usually faster than working
connected. However, keep the following in mind:
■
If an Administrator gives you a new security permission, this information will
not be updated until you connect to the Server again.
■
When making changes to Change Management items and folders (such as
the Access Control database, which stores security permissions for each
user), any changes you make will not take effect for other users until you
check in the item. You should occasionally connect to the Server and check in
the item so that other users can acquire your changes.
Change Ma na gem ent Serv er Cons ole
The Manager Console provides Administrators with a summary of the Server
status. This includes how much disk space is used, how many projects are
stored in the project database (sorted by project type), and other information. To
access the console, in the
Utilities tab of the Navigator, double-click
Server Console.
Want to know more? In the Help Index, look up “Change Management fxServer Console”.
THE MACHINE EDITION
ENVIRONMENT
Proficy Change Management is part of the Change Management suite of
products. As such, it is highly integrated with the Change Management
environment. After you log on to Proficy Change Management, the main Change
Management window appears. All Change Management tools used by the
currently-selected Change Management “theme” appear within the Change
Management window.
The following illustration shows only one possible tool layout, typically what an
Administrator would use. Most of the time, you’ll only use a few of these tools at
once—you can open and close these tools as you need them.
Want to know more? In the Help Index, look up “Tools”.
30
Proficy* Change Management 8.00
GSFXmgr.pdf 36
GFK-1779R
5/1/2013 10:25:57 PM
Prof icy Change Management Environment
The Machine Edition Environment
Inspector:
displays the
properties of a
selected object.
Navigator:
organizes and
displays project
and setting
information in a
tree structure.
InfoViewer:
an embedded
browser used to
display Factory
Layout pages
and
comprehensive
help.
Companion:
a dynamic help
window that
provides advice
as you work.
Machine Edition Tools
GFK-1779R
GSFXmgr.pdf 37
Feedback
Zone: displays
output
information
generated by
Machine Edition
components.
Proficy* Change Management 8.00 31
5/1/2013 10:25:57 PM
2
Prof icy Change Management Environment
Getting to Know Machine Edition
GETTING TO KNOW MACHINE
EDITION
This section briefly describes some key tools and features of the Change
Management environment that are used by Proficy Change Management.
Right-click menus
While using Proficy Change Management, you can right-click any object on your
screen to perform operations on it. This is probably the most common way to get
things done.
Getting Help
There are many ways to access the online help system.
■
Press F1 on any selected item for context-sensitive help.
■
Browse through the table of contents in the
■
Search for key words using the index: on the Help menu, select Index.
■
Search for key words using the Search function: on the Help menu, select
Search.
■
Open the
Companion window to dynamically display a brief description
about the currently-selected item or window. In most cases, you can get more
detailed information by clicking the blue
button in the top right corner of
the Companion help topic.
■
Set the page that is currently displayed in the InfoViewer as your Home Page
by clicking
(the house on a page) on the InfoViewer toolbar. To return to
that page later, click
(the house not on a page). You can also link these
buttons to your own HTML pages.
InfoView tab of the Navigator.
If you want to set the home page back to its original page, look up “Help
Home Page” in the help Index, and then click
(the house on a page).
32
■
Click
(the page with a green star in the corner) to open the Enter New
Internet Address dialog box where you can edit or enter an Internet address.
■
If you are working on a computer with an active Internet connection, you can
connect directly to helpful sites on the web. On the Help menu, point to GE
Intelligent Platforms on the Web, then select Technical Advisor to visit GE
Intelligent Platforms’ Knowledge Base; or GE Intelligent Platforms Page to
jump to the GE Intelligent Platforms page.
Proficy* Change Management 8.00
GSFXmgr.pdf 38
GFK-1779R
5/1/2013 10:25:57 PM
Prof icy Change Management Environment
Getting to Know Machine Edition
Change Management provides two kinds of help windows to display help
information: the Companion and the InfoViewer.
The online help index allows you to search
the entire help system using keywords.
The
InfoViewer
window is a
browser that
displays the
comprehensive
HTML-based
online help.
For detailed
contextsensitive help,
select any item
and press F1.
Click this button
to open the
InfoViewer with
more detailed
information on
the topic in the
Companion.
The InfoView
Tab contains
the table of
contents for the
online help.
Double-click a
page to view it.
Companion
The
Companion is a
dynamic help
window that
displays
snippets of
information on
any selected
item.
The Companion window displays brief information about whatever item you
happen to be working with, anywhere in Proficy Change Management. Whether
you need the meaning of a property, or the purpose of a node in the Navigator,
the Companion is always there for you.
The Companion is open by default, but if it isn’t visible, click
toolbar.
I nfoViewer
GFK-1779R
GSFXmgr.pdf 39
on the Tools
The InfoViewer window is an embedded HTML browser that provides more
detailed and procedural help. It is launched whenever you access help topics
Proficy* Change Management 8.00 33
5/1/2013 10:25:58 PM
2
Prof icy Change Management Environment
Getting to Know Machine Edition
from the InfoView Tab, the help index, or by pressing F1 on a selected item.
Click
on the Tools toolbar to open the InfoViewer.
Accessing the Right Tool
Often, Change Management help will direct you to a specific tool window. If the
tool isn’t visible, there are two ways to open it:
■
Under the Tools menu, select the tool’s name.
■
On the Tools toolbar, click the tool’s icon. To display the Tools toolbar, in the
Options tab of the Navigator, under the Change Management folder, select
Toolbars. In the Inspector, set Tools to True.
Navigator
Companion
Feedback Zone
InfoViewer
Inspector
If you are not sure of the name of a tool within a toolbar, hover the mouse over
the tool to display its name in a tool tip. (Note that if you installed other Change
Management products, you may have more available tools than those pictured.)
Projects and the Navigator
Navigator
34
The Navigator window organizes projects, project settings, and manages your
project database.
■
Use the Navigator to manage projects, set your environment preferences,
create scripts for third-party support, print reports, and more.
■
The Navigator is organized into several tabs. The available tabs depend on
which Change Management products are installed.
■
Within each tab, items are displayed in a tree structure of nodes or folders.
You can expand and collapse the tree, similar to drives and directories in
Windows Explorer™.
Proficy* Change Management 8.00
GSFXmgr.pdf 40
GFK-1779R
5/1/2013 10:25:58 PM
Prof icy Change Management Environment
Getting to Know Machine Edition
The following picture illustrates the Navigator. All the files listed under My
Computer are projects that you have access to on your computer.
If you have any local Change
Management projects on your
computer (created with products like
View or Logic Developer - PC), they
can be found under the My Computer
or Shared Projects folders.
To create a new project on
the Server, right-click the
appropriate project type
and select New. You need
the proper Access Control
permissions to perform
these functions.
Projects stored and managed on
the Proficy Change Management
Server can be found in the Server
folder. These projects are further
divided into application or project
types—such as Modicon
ProWORXTM or LogicMasterTM
90-30 (LM9030).
-orSelect Add to add an
existing (local) project to
the Server. You may have
to browse to the directory
where the project is stored.
The Options Tab contains option
and preference settings for the
Change Management
environment.
The Utilities tab contains miscellaneous
useful tools and utilities, including the
Change Management Server Console.
The InfoView Tab
contains the table of
contents for the help.
The Manager tab lists all projects on the
Proficy Change Management system. Use it
to create and open projects and to manage
projects on the Server. It is also where you
work with features like Access Control and the
Scheduler.
Navigator Window
To open a project in the Navigator, you need the proper Access Control
permission. For more information, see page 43.
GFK-1779R
GSFXmgr.pdf 41
Proficy* Change Management 8.00 35
5/1/2013 10:25:58 PM
2
Prof icy Change Management Environment
Getting to Know Machine Edition
Properties and the Inspector
Inspect or
In Change Management, almost all objects have properties. Properties are
attributes and information about that object. For example, the properties of a
user under the Access Control folder include password, email address, and title,
to name a few.
Properties of an object are edited in the Inspector window.
■
When a property changes an object’s appearance, you’ll see the results of
the change immediately in the object’s editor.
■
A read-only property, which cannot be changed, appears greyed out.
This is the kind of
object you
selected.
To edit this type of property, click the
button.
To edit this type of property, select
the new value from the list box.
To edit this type of property, type the
new value in the box.
Inspector Window
As you select the various properties within the Inspector, the Companion
displays a brief description about the selected property. If you are unsure of the
valid range for a property, hover the mouse over its current value and look in the
status bar.
36
Proficy* Change Management 8.00
GSFXmgr.pdf 42
GFK-1779R
5/1/2013 10:25:58 PM
Prof icy Change Management Environment
Getting to Know Machine Edition
The Feedback Zone
Feedback Zone
The Feedback Zone is an interactive window that displays output information
generated by Change Management products. Using the Feedback Zone, you
can keep track of project information, display generated reports, and more. It is
organized into several tabs.
Press F4 to
cycle through
entries in the
Feedback
Zone.
The Reports tab contains results of a Project History report.
You can generate a list of older versions of your database.
If you are using View or Logic Developer - PC, the Reports
Tab also displays a list of all reports generated during the
current session. Double-click an item in the report list to
redisplay it in the InfoViewer.
The Build Tab displays the results
of a validate or download operation
on projects created with other
Change Management products,
like View or Logic Developer - PC.
The Import tab displays the results and status of an
Import operation done within other Change
Management products, like View.
The Messages Tab tracks and displays operations
that have been completed within the Change
Management environment (for example, a message
is added every time you check out a project).
Feedback Zone
GFK-1779R
GSFXmgr.pdf 43
Proficy* Change Management 8.00 37
5/1/2013 10:25:58 PM
2
38
Prof icy Change Management Environment
Getting to Know Machine Edition
Proficy* Change Management 8.00
GSFXmgr.pdf 44
GFK-1779R
5/1/2013 10:25:58 PM
3
Version Control
Version Control is Proficy Change Management’s most important feature. With
Version Control, all project and Proficy Change Management data is stored in a
central location. It also allows you to:
■
Ensure that only one user can make changes to an item or project at a time.
■
Keep track of who is currently working on an item or project.
■
Safely store previous versions of projects.
■
Return a project to a previously-archived version.
Want to know more? In the Help Index, look up version and choose “How Proficy Change
Management handles Version Control”.
HOW VERSION CONTROL WORKS
Navigator: Manager tab
Project nodes
As described in chapter 2, all projects and settings are stored in a master
database on the Proficy Change Management Server (see page 27). When you
want to work on something stored on the Proficy Change Management Server—
whether it is a project, Access Control settings, or something else— use the
following steps:
1. Check out the project or item.
The Proficy Change Management Server copies the item to your local computer
(the “client” computer), and marks the item as “checked out”. As long as the item
is checked out, no other user can make changes to that item.
2. Make changes to the item on your computer.
At this point, the version stored on the Server is unchanged.
3. Check in the item.
Proficy Change Management copies the updated version from the client
computer to the Proficy Change Management Server, and removes the
“checked out” flag. Other users can now check the item out to make more
changes themselves.
GFK-1779R
GSFXmgr.pdf 45
Proficy* Change Management 8.00 39
5/1/2013 10:25:58 PM
3
Version Control
How Version Control Works
1
ch ec
k
o
u
t
Check out a project or item from the
Proficy Change Management Server.
The project is copied to the Client (local)
computer.
2
Make changes to
the project on the
local computer.
Proficy Change Management
Server
ch
3
e
ck
Client (Local) Computer
in
Check the project or item back in to the Proficy Change Management
Server. The version of the project or item on the Server is updated with
the changes you made. If you are checking in a project, the current
version on the Server is safely stored in the Project History archive.
Security f or Version Control Security in Proficy Change Management is called Access Control and is
explained in detail in Chapter 4. Briefly, each user that is created in Proficy
Change Management is a member of one or more groups that have security
permissions assigned to them. These permissions allow users belonging to that
group to perform certain actions. In addition, each project has one or more
groups assigned to it. Users can work with a project only if they are a member of
a group assigned to that project.
Want to know more? In the Help Index, look up “Access Control Permissions”.
Project and drawer hist ory When you check in a project or drawer to the Server, Proficy Change
Management automatically archives the old version. You can get a report of all
archived versions of a project or drawer by right-clicking the project and
selecting History Report. History reports appear in the Reports tab of the
Feedback Zone.
Want to know more? In the Help Index, look up project history and choose “Project History
Reports”.
40
Proficy* Change Management 8.00
GSFXmgr.pdf 46
GFK-1779R
5/1/2013 10:25:58 PM
Version Control
How Version Control Works
Checking out ot her items Projects aren’t the only thing you can check out of the Server. Proficy Change
Management also places the following under Version Control:
■
Access Control databases (see chapter 4 on page 43)
■
Audit Trail settings (see chapter 5 on page 47)
■
Scheduler event lists (see chapter 6 on page 51)
■
Custom Project Settings (see chapter 7 on page 55)
■
Factory Layouts (see chapter 8 on page 69)
■
Modbus Plus Network (available only when using the Modicon ProWORX
custom project support module; see the online help for details)
■
Toolchest drawers (used by other Machine Edition products installed with
Change Management, such as Logic Developer - PC or View.)
Want to know more? In the Help Index, look up “Using the Toolchest with Machine Edition”.
Creating and Adding Projects to the Server
There are two ways to add a project to the Proficy Change Management Server:
■
You can add existing (local) projects to the Server.
■
You can create a new project on the Server.
After you add a project to the Server, it is recommended that you add groups to
the project to allow users access to it. For more information, see “Access
Control” on page 43.
Local projects
Local projects are projects that exist on the local (client) computer but not on the
Proficy Change Management Server. The term “local project” can refer to
several different kinds of projects.
■
Projects created in Change Management while disconnected from the Server.
■
Machine Edition projects created before you installed Change Management.
■
Third-party projects created outside the Machine Edition environment.
The project folder
The Projects folder is divided into three subfolders.
GFK-1779R
GSFXmgr.pdf 47
■
The
My Computer folder contains local Machine Edition projects that have
not been added to the Proficy Change Management Server.
■
The
Shared Projects folder contains projects in the shared projects
directory.
Proficy* Change Management 8.00 41
5/1/2013 10:25:58 PM
3
Version Control
How Version Control Works
■
The
Server folder contains all projects that have been added to the Proficy
Change Management Server.
Want to know more? In the Help Index, look up “Creating a new project under a Change
Management system”, “Adding a project to the Proficy Change Management Server”, “Checking in
a project”, “Checking out a project”, and “Undoing a check out”.
42
Proficy* Change Management 8.00
GSFXmgr.pdf 48
GFK-1779R
5/1/2013 10:25:58 PM
4
Access Control
Access Control is Proficy Change Management’s security tool. With Access
Control, you can:
■
Organize users into groups.
■
Allow or disallow groups access to projects stored on the Proficy Change
Management Server.
■
Allow or disallow groups access to Toolchest drawers (useful only when other
Machine Edition products are installed)
■
Allow or disallow groups from performing operations in Proficy Change
Management.
HOW ACCESS CONTROL WORKS
Navigator: Manager tab
Access Control nodes
The
Access Control folder in the Manager tab of the Navigator contains these
items:
■
Users represent individual users of Proficy Change Management Clients
(not to be confused with Windows NT users). When you log on to a Proficy
Change Management Server, you must identify which User you are.
■
Groups are groups of Users. Each group is assigned a set of permissions.
Users in a group inherit the group’s permissions.
■
Permissions are security settings assigned to groups. In general, a
permission allows or disallows a particular action or set of actions.
Casually, we say that a user “has” a permission if they are a member of a group
for which that permission is set to True. Most permissions are True/False
settings; the exceptions are documented in the online help.
Administrators cannot assign permissions to individual users. Instead, they
assign permissions to groups, then add users to those groups. This lets an
administrator assign permissions to an entire group of users with similar roles
and responsibilities.
GFK-1779R
GSFXmgr.pdf 49
Proficy* Change Management 8.00 43
5/1/2013 10:25:58 PM
4
Access Control
How Access Control Works
Under a group node, permissions are organized based on the feature or
application they are associated with. You configure the actual permissions in the
Inspector. For example, if you select a group’s
Manager permissions node,
permissions that control access to Proficy Change Management features appear
in the Inspector. By setting the appropriate permission in the Inspector, you can
allow or disallow access to specific Proficy Change Management features for
that group.
■
For more details on specific permissions, select a
permission node in the
Navigator and press F1. Or, for a short description, open the Companion
window and click the permission in the Inspector.
Users can be members of more than one group. If this is the case, the group
permissions are combined and the user gets the most advantageous set of
permissions for all groups they are a member of. For example, if you are a
member of both the “Executives” and “Technicians” groups, and Executives
have the Manager Edit Project List permission but the Technicians do not, you
are considered to have the Edit Project List permission.
The Access Control Database
A list of users and groups is stored in the Access Control database. To make any
changes to users, groups, or permission settings (including adding new users or
groups), you must first check out the
Access Control database. The changes
you make do not take effect until the Access Control database is checked back
in to the Proficy Change Management Server.
Each Proficy Change Management Server maintains its own Access Control
database. If you need to work on projects from more than one Server, you must
be added as a user to all of the applicable servers.
Access Control of Projects and Toolchest
drawers
Access Control for projects depend on which groups are assigned to the project.
The users or members of a group that are assigned to a project—and that have
the Manager CheckInOut permission—can check the project in and out of the
Server. Since users can edit a project only when it is checked out of the Server,
this lets the administrator control who can make changes to a given project.
If you have another Machine Edition product installed, you can configure Access
Control for Toolchest drawers in much the same way. That is, you assign groups
to drawers, and only those groups can make changes to fxClasses within those
44
Proficy* Change Management 8.00
GSFXmgr.pdf 50
GFK-1779R
5/1/2013 10:25:58 PM
Access Control
How Access Control Works
drawers. For details, look up “Using the Toolchest with Machine Edition” in the
online help index.
Access Control of Layouts
Proficy Change Management’s Factory Layout feature lets you organize your
projects into a web page for ease of access to users (for more information on
Factory Layouts, see chapter 8). You control who has access to particular
layouts by assigning groups to an individual layout. Unlike projects, however,
only members of those groups can view the layout in the InfoViewer.
If a user is a member of a group assigned to a layout, that user can view it in the
InfoViewer and use it to navigate to the projects they need to work with. If the
user has the EditLayouts permission, they can also edit that layout.
Security Providers
Administrators have the option of using an external security provider (such as
the Windows NT network user account list) that Change Management uses
when logging users on to the network. Each Change Management user is
associated with a user account from the security provider’s list. When Change
Management is started, the logon dialog box does not appear—the user is
assumed to be the user currently logged on the local workstation.
Want to know more? In the Help Index, look up “Selecting a Security Provider”.
System Groups and Users
There are two system groups and two system users that cannot be deleted. The
system groups are:
■
Administrators group: This group has every available permission and is
automatically assigned to every project managed by Proficy Change
Management. As the name implies, it is really only designed for system
administrators.
■
Everyone group: All users on a Server are members of the Everyone group,
and have minimal permissions. By assigning a permission to the Everyone
group, you can assign that permission to every user in the Access Control
database.
The two system users are:
■
GFK-1779R
GSFXmgr.pdf 51
Administrator user: As the name implies, the Administrator user is a
member of the Administrators group. When you start Proficy Change
Management for the very first time, you must log in as the Administrator.
Proficy* Change Management 8.00 45
5/1/2013 10:25:58 PM
4
Access Control
How Access Control Works
■
Guest user: The Guest user can be assigned to any group and inherits that
group’s permissions. The Guest user is useful for people who need
temporary or limited access to the Proficy Change Management Server.
Want to know more? In the Help Index, look up “Creating a New User”, “Working with
Groups”, and “Working with Permissions”.
46
Proficy* Change Management 8.00
GSFXmgr.pdf 52
GFK-1779R
5/1/2013 10:25:58 PM
5
Audit Trailing
Audit Trailing is a tool designed to help you track actions performed in your
automation and control system. Audit Trailing lets you:
■
Add a record to the audit trail database when certain actions occur.
■
Generate audit trail reports to get a history of changes and actions in Proficy
Change Management.
■
View the audit trail database in a compatible database application.
HOW AUDIT TRAILING WORKS
Proficy Change Management can track and record actions performed by its
users. If a user performs an action and the administrator has flagged that type of
action to be audited, a record is logged in the audit trail database.
Navigator: Project tab
Audit Trail nodes
You specify which actions to track by configuring the Server’s audit trail settings.
Audit trail settings are located under the
Audit Trail folder in the Navigator,
and are grouped by feature or product type.
The settings are configured in the Inspector. If an audit trail setting is set to True,
Proficy Change Management tracks and records all actions of that type. For
example, if the Manager audit trail setting PasswordChange is set to True,
GFK-1779R
GSFXmgr.pdf 53
Proficy* Change Management 8.00 47
5/1/2013 10:25:58 PM
5
Audit Trailing
How Audit Trailing works
Proficy Change Management logs a record every time a user’s password is
changed.
Select the audit trail
setting type.
For each action you
want to track, set its
permission to True.
Audit trail settings for Custom Projects—including custom project modules
included on the installation CD—work differently. First, Custom Project audit trail
settings are integers, not discrete True/False values. (Custom Project
Permissions that represent discrete values use the values 1 and 0 instead.)
Second, Proficy Change Management does not use Custom Project audit trail
settings directly—this is done with scripts that check audit trail settings and
create audit trail records.
Want to know more? In the Help Index, look up “Custom Project Audit Trail Settings” and
“Archiving the Audit Trail Database”.
The Audit Trail Database
Audit trail records are added to the Proficy Change Management Server’s audit
trail database. By default, these records are stored in Microsoft Access™ format.
You can use Microsoft Access (or another application capable of reading
Microsoft Access databases) to view, sort, and generate custom reports on audit
trail records. Though not as simple to use as the Audit Trail Report Manager, this
gives you the most flexibility in searching the audit trail database.
48
Proficy* Change Management 8.00
GSFXmgr.pdf 54
GFK-1779R
5/1/2013 10:25:58 PM
Audit Trailing
How Audit Trailing works
You can find the audit trail database in two places:
■
The main audit trail database file is located on the Proficy Change
Management Server computer under “...\"Proficy Change
Management\fxManager\Server\Audit Database\Audit.mdb”, where
“...\Proficy Change Management” is the Change Management installation
directory.
■
When in disconnected mode, audit trails are temporarily added to a file
named “...\Proficy Change Management\SecurWorX\ServerName.mdb” on
the client computer, where “...\Proficy Change Management” is the Change
Management installation directory, and “ServerName” is the name of the
Proficy Change Management Server computer. The next time you connect to
the Proficy Change Management Server, records in this database are
automatically added to Audit.mdb on the Server computer, and the local copy
from the client computer is removed.
Since audit trail records are constantly being logged to the Server, the audit trail
database file can get very large. It is a good idea to occasionally archive the
database file to another computer to free space on the Server computer. You can
simply move the database file to another computer or, if you are using the
Scheduler, you can create an event that archives the database file automatically.
■
It is recommended that you archive the audit trail database only when no one
is connected to the Server.
For more information on using the Scheduler, see “The Scheduler” on page 51.
Al te rnat e Audit Tra i l D ata base Ty pes
If your network system already has an Oracle™ or Microsoft SQL Server™
database, you can save audit trail records in that database. Before doing so, you
must configure special tables and users in the database and ensure that an
appropriate ODBC driver is installed on the Change Management Server
computer.
Want to know more? In the Help Index, look up “Setting up an Oracle Audit Trail database”
and “Setting up a Microsoft SQL Server Audit Trail database”.
Audit Trail Reports
The easiest way to view records in the audit trail database is through the Audit
Trail Report Manager, located under the
Reports folder in the Audit Trail
folder. To open the Report Manager, right-click the
Audit Trail Report
Manager node and choose Open.
GFK-1779R
GSFXmgr.pdf 55
Proficy* Change Management 8.00 49
5/1/2013 10:25:58 PM
5
Audit Trailing
How Audit Trailing works
Generated Audit Trail Reports can be displayed on screen and, if desired, sent
to a printer.
■
If you have an application that can read Microsoft Access databases, you can
use it to view and sort audit trail records.
The Audit Trail Report Manager supports only Microsoft Access audit trail
databases. If you are storing audit trail records in another database type (such
as Oracle or Microsoft SQL Server), you must use an appropriate third-party
application to view them.
Want to know more? In the Help Index, look up reports and choose “Generating reports
from the Audit Trail Report Manager”.
50
Proficy* Change Management 8.00
GSFXmgr.pdf 56
GFK-1779R
5/1/2013 10:25:58 PM
6
The Scheduler
The
Scheduler is a tool designed to help you automate repetitive tasks
associated with maintaining industrial projects. For example, you can automate
Controller backups and logic compares.
Scheduler tasks are referred to as “events”. Events are edited in Proficy Change
Management and are executed in the Scheduler Engine. The Scheduler Engine
runs as a separate application outside the Machine Edition environment, though
it can only be installed on the same computer as a Proficy Change Management
Client.
■
Only members of groups with the Manager permission Edit Event List can
edit Scheduler events or configure the Scheduler. For more information on
configuring users, groups, and Access Control permissions, see Chapter 4,
“Access Control” on page 43.
Navigator: Project tab
Scheduler nodes
HOW THE SCHEDULER WORKS
You configure tasks for the Scheduler by creating a list of events in Proficy
Change Management. An event consists of an event script and a trigger. The
trigger indicates when the event occurs, and the event script determines the
actions that occur. Actions also have an associated project list, which indicates
the specific projects on which the event should be run.
Events are stored on the Proficy Change Management Server in a database
called the Scheduler Event List. The Scheduler Engine itself is a separate
application (that is, you run the Scheduler from outside the Machine Edition
environment). When you start the Scheduler Engine, it gets a copy of the
scheduler event list from the Server. When the Scheduler is started for the first
time, you must specify the location of the Server that contains the Scheduler
Event List.
For more information, see “Running the Scheduler” on page 53.
GFK-1779R
GSFXmgr.pdf 57
Proficy* Change Management 8.00 51
5/1/2013 10:25:58 PM
6
The Scheduler
How the Scheduler Works
Configuring Events
Events can be edited:
■
By changing an event’s properties directly in the Inspector.
■
By opening the Event Properties dialog box. To do so, right-click an
and choose Edit.
event
Events consist of a Trigger and an action script.
■
Event Triggers are configured by an event’s EventTrigger (Once, Weekly, or
Hourly), Date, and Time properties.
■
Event actions are scripts written in either VBScript or JScript. The Scheduler
includes predefined event scripts for common tasks.
Event Scripts
Event scripts can be written in VBScript or JScript. Proficy Change Management
provides many additional script functions that you can use in scripts, including
several that perform Proficy Change Management operations. Other useful
script functions let you add or remove projects from the list associated with an
event.
Want to know more? In the Help Index, look up “Change Management Script Function
summary”.
■
52
For more information on these scripting languages, go to
msdn.microsoft.com and search for vbscript or jscript.
Proficy* Change Management 8.00
GSFXmgr.pdf 58
GFK-1779R
5/1/2013 10:25:58 PM
The Scheduler
Running the Scheduler
RUNNING THE SCHEDULER
The Scheduler Engine is run outside of the Machine Edition environment;
however, Proficy Change Management Client must still be installed on the same
computer. The Scheduler connects to the Change Management Server to get
the Scheduler event list, so the Scheduler computer must have access to the
Server computer over the network.
NOTE: Normally, the Scheduler operates in the background. To work with the
Scheduler directly, right-click
on the Windows Taskbar, point to Scheduler
and choose Start.
Some things to keep in mind while running the Scheduler:
■
A clock
appears in the Windows Taskbar to indicate that the Scheduler is
active. The appearance of the icon indicates the current status of the
Scheduler. A red clock indicates that the Scheduler is stopped—that is, even
though the Scheduler Engine application is running, the Scheduler is not
checking for triggers or executing events.
■
If the Windows screen saver on the local computer is configured with
password protection, Scheduler scripts will stop working. If you need
password protection for a screen saver on a computer running the Scheduler,
use the Machine Edition Screen Saver. For more information, look up
“Machine Edition Screen Saver” in the online help index.
If you lose the Start menu’s shortcut for the Scheduler Engine, the Scheduler
program file (“SchedulerEngine.exe”) is found in the “fxManager\Client\”
subdirectory under the location where Proficy Change Management was
installed.
GFK-1779R
GSFXmgr.pdf 59
Proficy* Change Management 8.00 53
5/1/2013 10:25:58 PM
6
The Scheduler
Running the Scheduler
Starting the Scheduler
When you set up a list of events in Proficy Change Management, you can
execute them by running the Scheduler Engine.
If you want the Scheduler application to run automatically when Windows starts,
copy the Scheduler shortcut to your Windows Startup group.
■
If you want the Scheduler to automatically start executing events when it
begins running, set its AutoStart property to True in Proficy Change
Management. This also ensures that the Scheduler restarts automatically
should a power failure occur.
The first time you start the Scheduler Engine, you must select a Proficy Change
Management Server. The Scheduler remembers the Server you last connected
to and automatically connects to that Server the next time you start the
Scheduler.
If the Scheduler can’t log in to the selected Server, check to see if the Proficy
Change Management Server is installed on that computer. In particular, check
the following:
■
Ensure that the Proficy Change Management Server computer is running.
■
Ensure that the Proficy Change Management Server computer has
SourceSafe installed.
You can perform most actions through the right-click menu of the Scheduler
taskbar icon. To perform more advanced actions, right-click the
Scheduler
icon in the Windows Taskbar and select View Scheduler. From there, you can
view a list of events, execute specific events, log on to the Server, and perform
several other Scheduler Engine actions.
54
■
Some operations require you to be logged on to Windows as a specific user
(that is, as someone other than “Guest”).
■
Other operations require you to first log on to the Change Management
Server from the Scheduler Engine. You must be a member of a Group with
the Manager permission Edit Event List to log on to the Scheduler.
■
For more information on specific Scheduler operations, see the Scheduler
Engine’s online help.
Proficy* Change Management 8.00
GSFXmgr.pdf 60
GFK-1779R
5/1/2013 10:25:58 PM
7
Custom Project Support
Proficy Change Management provides built-in support for projects created with
several different applications, such as Waltz*, Process Window, and native
Change Management applications. If you have another application that you want
Proficy Change Management to manage for you, you can add the application as
a custom product type.
This chapter describes how to set up support for custom (or third party) projects
in Proficy Change Management.
Several pre-designed custom product modules are available with Proficy
Change Management. You can select individual modules in the “Support
Product Modules” item under the “Manager Client” item when installing Proficy
Change Management from the CD. Otherwise, you can use the Add Custom
Product Type Wizard to create a basic support module for a new third party
application.
Navigator: Project tab
Custom Project nodes
GFK-1779R
GSFXmgr.pdf 61
Normally, it is the system administrator or a project manager who adds or
reconfigures a custom product type to Proficy Change Management.
Configuration files for different custom product types can also be added to the
Proficy Change Management Server; when users log on to the Server, these
product types are automatically copied to their local computers.
Proficy* Change Management 8.00 55
5/1/2013 10:25:58 PM
7
Custom Project Support
How Custom Project Support Works
HOW CUSTOM PROJECT SUPPORT
WORKS
Once support for a custom product type has been set up in Proficy Change
Management, custom projects appear under the
Projects folder in the
Navigator.
Custom projects are located under the
Server folder, similar to
other project types.
Custom product types
included with Proficy
Change Management
installation.
Custom product type
modules (configuration
and script files).
Custom project nodes appear in two places in the Navigator:
■
Custom projects themselves appear under the Server folder and are
organized into different
Project folders for each custom product type. Both
the Custom Projects and Projects folders often have properties specific to the
Product Type.
■
Settings for each custom product type appear under the
Custom
Project Settings folder. The Custom Project Settings node represents the
configuration and script files that define the characteristics and behaviors of
the custom product type. A set of files and scripts for a single product type is
often referred to as a module. All custom product type modules installed on
your system appear in the Custom Project Settings folder.
You must check out the
Custom Project Settings node to make changes to
the properties of a project in the
Projects folder.
56
Proficy* Change Management 8.00
GSFXmgr.pdf 62
GFK-1779R
5/1/2013 10:25:58 PM
Custom Project Support
How Custom Project Support Works
If you are not responsible for adding or setting up support for custom product
types, you will not need to look in the Settings folders at all.
You can set up the following Proficy Change Management features for custom
projects:
■
Version Control: You can store custom projects on the Proficy Change
Management Server, checking them in and out and so on, just like any other
product type.
■
Access Control: The custom product type can be set up such that certain
permissions are required to access and use its projects.
■
Audit Trails: The custom product type can be configured to create audit trail
records. These records can then be viewed along with other audit trail
records, depending on the selected audit trail database format.
■
User-created Help: You can specify special help topics for each custom
product type, to be displayed in the InfoViewer or Companion windows. In
addition, you can set up Companion help for custom project permissions,
audit trail settings, and arguments.
■
Right-click menu commands: You can specify special behavior for standard
Project and
Projects folder right-click commands (such as “Check In” or
“Open”). In addition, you can add special commands specific to a particular
Custom Product Type.
Custom Product Type Files
Configuration Files for custom product types are stored on the Proficy Change
Management Server. When users log on to the Server, any setting files or scripts
for product types added to the Server are automatically copied to their local
computer. For more information, see “Managing Custom Product Types” on
page 64, or look up Custom Project Settings Folder in the online help index.
On the local (client) computer, all configuration files relating to custom product
types are stored in the “SecurWORX\CustomProjects” directory under the
GFK-1779R
GSFXmgr.pdf 63
Proficy* Change Management 8.00 57
5/1/2013 10:25:58 PM
7
Custom Project Support
How Custom Project Support Works
Change Management installation directory. The directory structure looks
something like this:
Settings.INI file
*.VB files
*.ZIP files
*.VB files
AutoExecute.VB file
Custom Project Directory
Structure
Cust om Product Type direct ory Each custom product type has its own subdirectory with the name of that
custom project. For example, if you were managing Microsoft Word™
documents with Proficy Change Management, you might have a directory
named “...\Proficy Change Management\SecurWORX\CustomProjects\Microsoft
Word”.
Each product type directory contains the following:
■
A Project Type Settings file (“Settings.INI”): Settings in the Settings.INI file
determine the location of the custom product type’s application; where its
projects are stored; the properties for its
custom projects and
Projects
folder; the names of its arguments; its right-click menu options; and contextsensitive help for the projects, project types, and arguments.
Want to know more? In the Help Index, look up custom and choose “Custom Project
Settings File”.
St art up Files directory
■
A “Scripts” subdirectory: This directory contains all menu scripts for the
project type. These scripts implement commands found on the right-click
menus of the custom project type and its projects.
■
(Optional.) A “Templates” subdirectory: This directory contains project
templates (in .ZIP files) for the project type. These templates can be used by
a menu script that creates new projects.
The “Startup Files” subdirectory contains the following:
■
58
A global settings file for custom project types, called GlobalSettings.INI. This
file contains settings pertinent to all custom project types added to the
Proficy* Change Management 8.00
GSFXmgr.pdf 64
GFK-1779R
5/1/2013 10:25:58 PM
Custom Project Support
How Custom Project Support Works
Change Management system. Settings in GlobalSettings.INI determine the
names of custom project permissions and context-sensitive help for
permissions and audit trail settings.
■
Startup scripts for controlling how and where custom project type
configuration files are retrieved from the Change Management Server.
Startup scripts (which must be VBScript files) retrieve custom product types
from the Server when a user logs on to Change Management. The system
administrator can specify different Startup scripts for different users or
computers.
The main Startup script is named “Startup.vb” and should not be modified.
Rather, if you have script actions you want performed during the startup,
create a new script named “UserName.vb” (for a specific user),
“ComputerName.vb” (for a specific computer), or “CustomStartup.vb”. Since
these scripts are executed while Change Management builds the project tree,
function calls in these scripts cannot perform operations on specific,
individual projects, or project types. Rather, they should enable or disable
installed project types as needed.
You can also add a third type of startup script, named “PostStartup.vb”. If a
PostStartup.vb script exists, it is executed after the project tree is built. This
means function calls in PostStartup.vb can perform operations on specific
projects and product types.
The two kinds of .INI files (“Settings.INI” and “GlobalSettings.INI”) use a
standard Windows Initialization file format. Related settings are grouped into
sections. Section headings are enclosed in square brackets (“[“ and “]”). Each
setting is written in the format:
<Setting Name>=<Setting Value>
Where <Setting Name> is the name of the setting and <Setting Value> is the
value assigned to that setting.
Want to know more about the GlobalSettings.ini file? In the Help index, look up global and
choose “Custom Project Global Settings File”.
Want to know more about the Startup Files directory? In the Help Index, look up startup
and choose “Custom Project Startup Files Folder”.
Script Library di recto ry
GFK-1779R
GSFXmgr.pdf 65
The custom projects “Script Library” subdirectory contains scripts that are used
by several product types. If you need to update the functionality of a particular
script, it only has to be changed in one place. You can run a Script Library script
from another custom project script with the fxIncludeGlobalScript function.
Proficy* Change Management 8.00 59
5/1/2013 10:25:58 PM
Custom Project Support
7
How Custom Project Support Works
Master scri pts
Scripts in “Master” subdirectories let you provide default functionality for a
custom project script, allowing you to override specific scripts on a site-by-site
basis. Master scripts are used by custom product modules included with the
Proficy Change Management installation CD. Nearly all subdirectories that
contain scripts can have a Master subdirectory.
Master scripts are used whenever Proficy Change Management needs to
access a script from a folder with a Master subdirectory, such as scripts used to
implement commands from custom project right-click menus. Master scripts
themselves should not be edited or modified. Instead, you should override a
specific Master script by including a script with the same name in the Master
directory’s parent directory.
Master scripts work as follows:
■
In general, when looking for a script with a certain name, Proficy Change
Management first looks in the expected directory. if a script with the needed
name exists in that directory, it runs that copy of the script. The Master copy is
ignored.
■
Otherwise, Change Management looks for the required script in the
appropriate “Master” subdirectory. If the named script exists in the Master
directory, it runs that script instead.
Directories with this functionality are the Script Library directory, the Startup Files
directory, and each project type’s Scripts directory. In general, Master scripts
themselves should not be edited or modified.
Want to know more? In the Help Index, look up sample and choose “Master script
directories for custom projects”.
Menu S cri pt preced ence
The directory structure for script files lets an administrator create generic scripts
for a Change Management system, overriding specific scripts on a site-by-site
basis. When Change Management needs to invoke a menu script, it looks for a
script with the appropriate name in the following locations, in this order:
1. The “Scripts” subdirectory under the custom project type’s settings directory.
2. The “Scripts\Master” subdirectory under the custom project type’s settings
directory.
3. The “Scripts” subdirectory under the “Script Library”directory.
4. The “Scripts\Master” subdirectory under the “Script Library” directory.
Change Management stops as soon as it finds a script with the required name.
For example, if a script with the name “Compare.vb” is needed and one is found
60
Proficy* Change Management 8.00
GSFXmgr.pdf 66
GFK-1779R
5/1/2013 10:25:59 PM
Custom Project Support
How Custom Project Support Works
in the “Scripts\Master” subdirectory for the custom project type, any scripts
named “Compare.vb” in the Script Library directory are ignored.
Custom Project Access Control and Audit Trail
settings
Proficy Change Management provides one master set of user-defined Access
Control permissions and Audit Trail settings for all custom project types. Custom
product types draw from a single, common list of Permissions and Audit Trail
settings. Proficy Change Management does not use these settings
automatically. Instead, it is up to the Custom Project Implementor to:
■
Decide which permissions and audit trail settings apply to which custom
product types;
■
Set up the menu scripts so they check the appropriate permissions before
performing an action; and
■
Set up the menu scripts to check the audit trail settings and, if the setting is
high enough, add a record to the Audit Trail database.
Many script functions are available to help implement these tasks. Names for
custom project permissions are specified in the [Permissions] section of
GlobalSettings.INI.
Regardless of the customized scripts and permissions used, Proficy Change
Management always enforces the “standard” Manager permissions. For
example, you always need the Manager CheckInOut permission to check
custom projects in and out of the Server.
Want to know more? In the Help Index, look up define and choose “Defining Custom
Project Permissions” and “Defining Custom Project Audit Trail Settings”.
User-defined Custom Project Help
You can create your own context-sensitive help for the following items:
GFK-1779R
GSFXmgr.pdf 67
■
Custom projects (Companion and InfoViewer help)
■
Custom project types (Companion and InfoViewer help)
■
Arguments (properites) of custom product type “Projects” folders (Companion
help)
■
Custom Project permissions (Companion help)
■
Custom project audit trail settings (Companion help)
Proficy* Change Management 8.00 61
5/1/2013 10:25:59 PM
7
Custom Project Support
How Custom Project Support Works
InfoViewer help is displayed in the
InfoViewer when you select an item and
press F1. Companion help appears in the
Companion when you select the
item. Typically, Companion help is quite short; that is, a quick summary of what
the item is and what it does. InfoViewer help describes the item in greater detail.
When Proficy Change Management needs to find a custom help topic, it looks
for a URL in the Settings.INI or GlobalSettings.INI file. If the appropriate settings
are left blank, Change Management displays default help for the item; otherwise,
it opens the document specified by the URL.
■
Help URLs for a custom product type’s
Projects folder and
Project
nodes are specified in the [Help] section of the project type’s Settings.INI file.
■
Help URLs for properties of a custom product type’s
Projects folder and
Project nodes are specified in the [ArgumentsHelp] and
[CustomPropertiesHelp] sections, respectively.
■
Help URLs for custom project permissions and audit trail settings for
custom product types are specified in the [PermissionsHelp] and [AuditHelp]
sections of the GlobalSettings.INI file, respectively.
URL stands for “Universal Resource Locator”. This can be a document’s file
name (with the drive and path, if necessary) or an HTTP web address.
Want to know more? In the Help Index, look up help and choose “Setting up Help for
Custom Projects”.
Scripts for Custom Project right-click menus
When you right-click a custom product type’s
Projects folder or
Project
node in the Navigator, a shortcut menu appears. The commands in these menus
are based on lists in the project type’s Settings.INI file.
Menu commands are implemented with scripts written in VBScript. The
Settings.INI file specifies two sets of scripts for each menu command:
62
■
First, Proficy Change Management runs the UI scripts to see if the menu
command should be disabled (dimmed). If the UI script fails—or if it calls the
fxDisableMenuItem function—the appropriate command is dimmed and the
user cannot select it. UI Scripts are specified in the [ProjectTypeMenuUI] and
[ProjectMenuUI] sections.
■
Second, Proficy Change Management runs the Action scripts to perform the
actual function of the menu command. The action scripts for an “Open”
command opens the selected project; the action scripts for a “New” command
creates a new project of that product type, and so on. Action scripts are
specified in the [ProjectTypeMenu] and [ProjectMenu] sections.
Proficy* Change Management 8.00
GSFXmgr.pdf 68
GFK-1779R
5/1/2013 10:25:59 PM
Custom Project Support
How Custom Project Support Works
You can specify multiple scripts for each menu entry by separating their names
with semicolons. For example, if you specify two scripts as UI scripts for the
“Open” command, both scripts must complete successfully before Proficy
Change Management enables the Open command.
Basic Men u Act ions
If the name of a menu item (as set in the Settings.INI file) fits any of the basic
menu actions, Proficy Change Management performs some additional checks
before enabling the command. These checks are the same as those it performs
for its built-in project types and are performed before running the UI script. For
example, if a menu command is named “Checkout”, Proficy Change
Management automatically checks to see if the current user is connected to the
Server, is assigned to the project, and has the CheckInOut permission.
■
The Basic Menu Actions are: Add, Checkin, Checkout, Delete Local Copy,
Destroy, Get Latest Version, Label, New, and Undo Check Out.
All menu scripts must be written in VBScript format. Proficy Change
Management supplies many additional script functions for use with custom
projects. These functions perform operations like checking projects in and out of
the Server, retrieving the values of permissions for the current user, and so on.
A complete list of available script functions can be found in the following places
in the online help:
■
For an alphabetical list of script functions, in the InfoView tab of the Navigator,
under the Proficy Change Management book, look in Script Functions A to Z.
■
For lists of script functions grouped by purpose or type, in the InfoView tab of
the Navigator, under the Proficy Change Management book, look in Script
Functions by Category.
Want to know more? In the Help Index, look up shortcut and choose “Setting up Shortcut
Menus for Custom Projects”.
Most script functions can also be used with custom event scripts in the
Scheduler. For more details, see “Event Scripts” on page 52.
GFK-1779R
GSFXmgr.pdf 69
Proficy* Change Management 8.00 63
5/1/2013 10:25:59 PM
7
Custom Project Support
Managing Custom Product Types
MANAGING CUSTOM PRODUCT
TYPES
The
Custom Project Settings folder lets you easily manage your custom
product type files.
■
You can check configuration files for custom product types in and out of the
Server; and
■
You can automatically update configuration files for a custom product type on
all Proficy Change Management Client computers connected to the Proficy
Change Management Server.
Within the Custom Project Settings folders are the following:
Navigator: Project tab
Custom Project setting nodes
■
Custom Project Settings nodes, which represent setting files for the
custom product types currently available on the local computer. If the custom
product type exists on the local computer but not on the Server, it is flagged
with an “L”, as in “ “.
■
The
Startup Files node, which represents Startup scripts and the
GlobalSettings.INI file for custom project types.
Before you can edit setting files or scripts for a non-local custom product type,
you must check out the appropriate
Settings from the Server. Similarly, to edit
Startup scripts or the GlobalSettings.INI file, you must check out the
Startup
Files from the Server.
You can add a local custom product type to the Server by checking in its
settings. If you check in a custom product type that doesdoes not already exist
on the Server, it becomes a Server custom product type.
Want to know more? In the Help Index, look up global and choose “Custom Project Global
Settings File”, “Sample GlobalSettings.INI file”, and “How Proficy Change Management Handles
Custom Product Types”.
Checking out a Custom Product Type from the
Server
You can only check out custom project settings (or Custom Project Startup Files)
if you are logged on and connected to the Proficy Change Management Server
and you have the Manager Edit Custom Settings permission.
When a custom product type is checked out, its configuration files on your
computer are made writable (except for master scripts, which you should
64
Proficy* Change Management 8.00
GSFXmgr.pdf 70
GFK-1779R
5/1/2013 10:25:59 PM
Custom Project Support
Managing Custom Product Types
override rather than edit). After making changes, you can check the custom
product type back in to the Server.
■
Files for a product type are located in the
“...\[PCM]\SecurWORX\CustomProjects\[ProductType]” directory (where
“[PCM]” is the Proficy Change Management installation directory and
“[ProductType]” is the name of the custom product type).
■
Custom Project Startup files are located in the “...\Proficy Change
Management\SecurWORX\CustomProjects\Startup Files” directory.
■
Script Library files are located in the “...\Proficy Change
Management\SecurWORX\CustomProjects\Script Library” directory.
Want to know more? In the Help Index, look up “Configuring Custom Product Types”.
Checking in or adding a Custom Product Type
to the Server
You can only check in a custom product type (or Custom Project Startup Files) if
you are logged on and connected to the Proficy Change Management Server
and either the particular settings folder checked out on the local computer, or the
settings folder is for a local custom product type that does not yet exist on the
Server.
When you check settings back into the Server, all the changes you made on the
local computer are copied to the Server. The configuration files on the local
computer are also marked as read-only.
To check in the product type without updating the changes you made, right-click
the product type’s Settings folder and select Undo Checkout.
Opening a Custom Product Type’s settings
directory in Windows Explorer
Windows Explorer opens to the “...\Proficy Change
Management\SecurWORX\CustomProjects\ProductType” directory, where
“...\Proficy Change Management” is the Proficy Change Management
installation directory and “ProductType” is the name of the custom product type.
All settings files for the product type are stored in this directory. (Custom product
modules included with the Proficy Change Management installation CD will also
include a “Master” subdirectory, whose script should not be edited.)
You can only open the settings directory (or the Startup Files directory) if you
have those settings checked out or if it is a local custom product type.
GFK-1779R
GSFXmgr.pdf 71
Proficy* Change Management 8.00 65
5/1/2013 10:25:59 PM
7
Custom Project Support
The Add Custom Product Type Wizard
Copying (cloning) a custom Project Type
You can only clone a custom product type if you have the Edit Custom Settings
Manager permission.
The name of the custom product type cannot be the same as an existing one.
Custom product type names can include only the characters 0 through 9, A
through Z, “-” (hyphen), and “_” (underscore). The first character must be a letter
and names are not case-sensitive. The maximum number of characters is 18.
When you clone a custom product type, the new version is created as a local
custom product type. If you want to make it available to other users, you must
add it to the Server by checking it in.
If you ever want to get rid of a custom product type, right-click its
folder and choose Destroy.
Settings
THE ADD CUSTOM PRODUCT TYPE
WIZARD
The Custom Product Type Module wizard lets you easily create a Change
Management support module for a third party product. A module contains scripts
and configuration files that let you work with projects of a specific product under
a Change Management system, using its Version Control, Access Control, and
Audit Trail features.
Several preconfigured modules are available on the Proficy Change
Management installation CD. Before creating a new Product Type Module, you
may want to see if an appropriate module already exists.
Want to know more? In the Help Index, look up “Custom Product Type Module Wizard”.
Universal Directory Compare event support
Projects of the new product type can be used with the Universal Directory
Compare event in the Scheduler. This event lets you schedule regular
comparisons of projects, generating reports that list a project’s new, deleted, and
changed files. The product type’s
Projects folder’s Use Master and New
66
Proficy* Change Management 8.00
GSFXmgr.pdf 72
GFK-1779R
5/1/2013 10:25:59 PM
Custom Project Support
The Add Custom Product Type Wizard
Version on Miscompare properties configure the general behavior of the
Scheduler event.
Want to know more? In the Help Index, look up “Universal Directory Compare (Scheduler
script)”.
GFK-1779R
GSFXmgr.pdf 73
Proficy* Change Management 8.00 67
5/1/2013 10:25:59 PM
7
68
Custom Project Support
The Add Custom Product Type Wizard
Proficy* Change Management 8.00
GSFXmgr.pdf 74
GFK-1779R
5/1/2013 10:25:59 PM
8
Factory Layouts
Factory Layouts allows you to organize your projects to fit your company’s
structure as opposed to how the Navigator organizes projects. This results in
easier navigation to your projects. For example, you may want to layout projects
based on the structure of a factory, a plant's process, or any other way that
makes sense to users who access projects through Proficy Change
Management. Engineers, technicians, and other users can use layouts to quickly
get to the project they need to work with.
Navigator: Project tab
Factory Layout nodes
GFK-1779R
GSFXmgr.pdf 75
■
From the layout user’s point of view, Factory Layouts are a series of HTML
pages displayed in the InfoViewer. Users click on hypertext links to navigate
to the project they want to work with. When the proper project is found, users
can perform the same Proficy Change Management operations on the project
as those from the Navigator—all the right-click menu commands for the
project can be made available from the InfoViewer.
■
From the layout developer or administrator’s point of view, a layout’s pages
are organized in the Navigator. The administrator also writes HTML templates
for each layout page. When complete, the layout is published to a shared
directory. This tells Proficy Change Management to generate the layout’s
finished files, based on the properties of the layout, its pages, and how the
pages are organized in the Navigator.
Proficy* Change Management 8.00 69
5/1/2013 10:25:59 PM
8
Factory Layouts
Using Layouts
USING LAYOUTS
In the Navigator, all
Layouts appear in the
Manager tab under the
Factory Layouts folder. A layout’s pages and the groups assigned to the
layout are organized under individual
Layout folders. Users access layouts
from these folders.
When you want to use a layout to navigate to a project, right-click the desired
layout page and choose Open. You may have to log on connected to a
Proficy Change Management Server first to get the latest available layouts.
You can only see layouts to which
groups have been assigned that have you
as a member. Other layouts do not appear.
The Administrators group is automatically assigned to every layout. For
example, if a manager assigns only the Sector1 group to the BottlingArea layout,
only users in the Sector1 and Administrators groups will see the BottlingArea
layout in the Navigator.
When opened, a layout’s pages appear in the InfoViewer as a series of web
pages. You can use these web pages to navigate to the project you want to work
on. After navigating to the desired project, you can perform Proficy Change
Management actions on the project using links in the InfoViewer. Typically, most
actions that can be performed on a project from the Navigator can also be done
through a layout page, but this depends on the layout’s creator.
Tips for using factory layouts:
70
■
You can set Machine Edition’s default home page to the currently displayed
page in the InfoViewer by clicking
. This can be any page or URL,
including a layout page. For more information, see “Getting Help” on page 32.
■
To hide or minimize other Machine Edition tool windows (to make it easier to
view a layout page), click the tool buttons in the Tools toolbar. For more
information, see “Accessing the Right Tool” on page 34.
Proficy* Change Management 8.00
GSFXmgr.pdf 76
GFK-1779R
5/1/2013 10:25:59 PM
Factory Layouts
How Layouts work
HOW LAYOUTS WORK
(This section is intended for administrators and other users who need to create
layouts. If you just want to use layouts to get to projects you need to work on,
see “Using Layouts” on page 70.)
Factory Layout files exist in two places:
■
The source and configuration files for the layout are stored on the Proficy
Change Management Server. You check these files in and out of the Server
just like a project.
■
A finished layout is published to a directory on the Server computer, which
must be shared to other computers as “fxPublish”. Publishing a layout creates
a complete web site, accessible through the InfoViewer. The published files
consist of a series of HTML and XML files, plus any image or other
supplemental files used by the layout.
The fxPublish directory
Though the source layout files are stored in a Server database, the final web
pages are accessed through a shared directory on the Server computer. Before
you can publish layouts, you or the system administrator must set up this shared
directory. (Shared directories are simply directories on a local computer made
available to other computers on the network.) This directory must be set up as
follows:
GFK-1779R
GSFXmgr.pdf 77
■
The directory must reside on the same computer running the Proficy Change
Management Server.
■
The directory must be shared with the name “fxPublish”.
■
All users of Proficy Change Management who will edit Factory Layouts must
have “Full Control” network access permissions. That is, they must have
read/write capabilities to all files in fxPublish, and must be able to create and
delete subdirectories of fxPublish.
■
If you are not using a web server (see below), all users of Proficy Change
Management who will open Factory Layouts in the InfoViewer must have
“Read” network access permissions. See your network administrator for
assistance.
Proficy* Change Management 8.00 71
5/1/2013 10:25:59 PM
8
Factory Layouts
How Layouts work
Using a Web Server
By default, the InfoViewer accesses the fxPublish directory directly. This means
that a Server’s fxPublish directory must be shared to all Proficy Change
Management users on the network who connect to that Server. If security is a
concern, you can get Proficy Change Management to acquire the layout files
from a web server on your network instead. Proficy Change Management
Clients can connect to that web server to display a previously-created factory
layout.
Even when using a web server, Proficy Change Management uses the fxPublish
shared directory to publish layouts. When developing a factory layout, you must
still give factory layout developers full read/write access to the shared fxPublish
directory.
To use a web server to distribute the final layout files, you must do the following:
■
Set up the web server so that a specific HTTP address resolves to the
fxPublish directory. For more information, see the documentation for your
web server.
■
In the Inspector, set the layout’s Use a Webserver property to True.
■
In the Inspector, set the layout’s HTML Location property to that HTTP
address.
Backing up layouts
You can back up your layouts or transfer them to a different Proficy Change
Management system with the Export and Import commands. Proficy Change
Management saves an exported layout in a file with a .LAY file name extension.
Exported layouts include everything in its supplemental files directory.
It is recommended that you back up your layouts before performing major
operations on the Change Management Server, such as upgrading the Server or
moving the Server to a different computer.
The Proficy Change Management CD contains a sample layout, exported as
“Sample.LAY”. This layout contains several HTML page templates that can be
adapted for your own layouts.
72
Proficy* Change Management 8.00
GSFXmgr.pdf 78
GFK-1779R
5/1/2013 10:25:59 PM
Factory Layouts
Creating Layouts
CREATING LAYOUTS
(This section is designed for administrators and other users who need to create
layouts. If you just want to use layouts to get to projects you need to work on,
see “Using Layouts” on page 70.)
You can create a new layout only if you are:
■
connected to the Proficy Change Management Server, and
■
a member of the Administrators group.
A new layout has only the Administrator group assigned to it. If you want other
groups to have access to the layout (both for editing and viewing), you must add
the desired groups to the layout.
A layout can be edited by users who are not members of the Administrator
group; however, these users must have the Edit Layouts Manager permission
and need to be a member of a group assigned to that layout.
After a layout has been created, you can edit it.
When you need to edit a
layout, you first check it out from the Proficy Change
Management Server. You can then add or delete pages, edit page templates,
preview and test pages, and add or edit files to be included with the layout’s web
pages.
When the changes are complete and the layout is ready to be used by its target
users (that is, users who use the layout to navigate through projects on your
system), you publish the layout. Publishing creates the final layout files in a
shared directory on the Proficy Change Management Server. These files
comprise a web site of HTML (and XML) pages based on the page nodes under
the Layout’s
Pages folder.
Before a factory layout can be published, the system administrator must share
this directory as “fxPublish”. For more details, see “The fxPublish directory” on
page 71.
Whether or not the layout is published, when the user is finished editing the
layout, he or she checks it back into the Proficy Change Management Server.
Want to know more? In the Help Index, look up layouts and choose “Creating and Editing
Layouts: an Overview”.
GFK-1779R
GSFXmgr.pdf 79
Proficy* Change Management 8.00 73
5/1/2013 10:25:59 PM
8
Factory Layouts
Creating Layouts
Supplemental Files directory
Each layout has a Supplemental Files directory, whose fixed location on the local
computer is shown as its Supplemental Files property. Any files in this directory
are checked in and out of the Server with the rest of the layout and included with
the final published layout files.
Files you must place in this directory include:
■
Any image files referenced by the layout pages.
■
The image file with the company’s logo, specified by the Company Logo
property.
■
Any image files specified by the Background Image properties of the
layout’s pages.
■
All HTML templates for the layout’s pages, specified by the pages’ Template
File properties.
■
Any HTML files specified by a layout’s Header HTML File or Footer HTML
File properties.
You can copy files to the Supplemental Files directory with Windows Explorer. To
open a Windows Explorer window at the Supplemental Files directory, select the
Supplemental Files property in the Inspector and click
.
74
Proficy* Change Management 8.00
GSFXmgr.pdf 80
GFK-1779R
5/1/2013 10:25:59 PM
Factory Layouts
Creating Layouts
1
ch ec
k
o
u
Check out a layout from the Proficy
Change Management Server.
t
2 Make changes to the
layout on the local
computer.
Publish
3
Change Management Server
ch
ec
k
Publish the
layout to the
shared directory
(fxPublish) on
the Server for
other users to
access.
in
Client (Local) Computer
4 Check the layout back in to the Proficy
Change Management Server so others are
able to make changes when necessary.
Creating Factory Layouts
GFK-1779R
GSFXmgr.pdf 81
Proficy* Change Management 8.00 75
5/1/2013 10:25:59 PM
8
Factory Layouts
Creating Layouts
How Change Management generates the
published layout files
When creating layouts, it helps to understand the steps Proficy Change
Management performs when a layout is published. This information is especially
useful when creating HTML page templates for layout pages (see page 78).
When a layout is published, Proficy Change Management creates several files in
a subdirectory under the fxPublish directory (or, if a preview is being generated,
on the local computer).
■
It copies all files from the directory specified by the layout’s Supplemental
Files Directory property.
■
It creates a file called “fxLayout.XML”, containing an XML object called
FXLAYOUT. This object contains information about the layout in general,
including the values of many of its properties.
■
For each page in the layout, it creates a copy of the page’s HTML template
(specified by the page’s Template File property) with a filename based on the
layout page node. So, for a page node called “MyPage”, it creates a copy of
the page template as “MyPage.HTM”.
■
Similarly, for each page in the layout, it creates an XML file with a filename
based on the layout page node (that is, the file has an extension of “.XML”).
For example, for a page node called “MyPage”, Proficy Change Management
creates an XML file called “MyPage.XML”. This XML file contains an XML
object called FXPAGE. This object contains information about the page,
including many of its properties.
All files are created in the same directory, regardless of the “tree” configuration
of the layout’s pages. For example, a layout called “Packing_A” has three pages,
“Sector1”, “Belts”, and “Glue_Gun”, with “Belts” and “Glue_Gun” children of
76
Proficy* Change Management 8.00
GSFXmgr.pdf 82
GFK-1779R
5/1/2013 10:25:59 PM
Factory Layouts
Creating Layouts
“Sector1”. The following diagram illustrates the files Proficy Change
Management creates for the Packing_A factory layout:
fxLayout.XML
Sector1.HTM
Sector1.XML
Belts.HTM
Belts.XML
Glue_Gun.HTM
Glue_Gun.XML
plus any files in the layout’s Supplemental
Files directory (see page 74).
Generated Factory Layout files
Proficy Change Management “remembers” the organization of the page tree in
each FXPAGE object's <CHILDREN> and <PARENT> tags.
Proficy Change Management also copies the files in Packing_A’s Supplemental
Files directory.
Want to know more? In the Help Index, look up layouts and choose “Factory Layout
XML Objects and Tags”.
Checking out Layouts from the Server
You can check out layouts only if you:
■
Are connected to the Proficy Change Management Server,
■
Are a member of a group assigned to the Layout, and
■
Have the Edit Layouts Manager permission.
Want to know more? In the Help Index, look up “Checking out layouts from the Server”.
GFK-1779R
GSFXmgr.pdf 83
Proficy* Change Management 8.00 77
5/1/2013 10:25:59 PM
8
Factory Layouts
Creating Layout Page Templates in HTML
Publishing Layouts on the Server
You can publish a layout only if:
■
You have the Manager Edit Layouts permission.
■
You have the layout checked out on the local computer.
■
The local computer (or the user logged into the local computer) has
read/write access to the fxPublish directory (see page 71).
■
Proficy Change Management generates files for the final web site for the
layout and places them in the fxPublish directory. Users can now open the
layout in the InfoViewer.
Want to know more? In the Help Index, look up layouts and choose “Publishing Layouts”.
CREATING LAYOUT PAGE
TEMPLATES IN HTML
(This section is intended for administrators and other users who need to create
layouts. If you just want to use layouts to get to projects you need to work on,
see “Using Layouts” on page 70.)
When Proficy Change Management publishes a factory layout to the Proficy
Change Management Server, it creates HTML pages (.HTM files) based on a
generic HTML page template. You specify which template to use in the page’s
Template File property.
An HTML template for a page should contain VBScript routines that access the
XML files created when the layout is published. This makes the published HTML
pages “dynamic”—what gets displayed in the InfoViewer is based on the
contents of the page’s associated XML file.
You can create page templates in any standard text or HTML editor. These page
templates must be stored in the directory specified by the layout’s
Supplemental Files property. Any graphic or other files used by the HTML page
must also be placed in this directory.
■
78
When you install Proficy Change Management, sample page templates are
included in a sample factory layout. The sample layout is stored in the .LAY
file called “...\Proficy Machine
Proficy* Change Management 8.00
GSFXmgr.pdf 84
GFK-1779R
5/1/2013 10:25:59 PM
Factory Layouts
Creating Layout Page Templates in HTML
Edition\SecurWORX\Samples\Layouts\Generic.LAY”, where “...\Proficy
Machine Edition” is the Proficy Change Management installation directory. To
use this layout (or the files that make up this layout), you must import the
Generic.LAY layout into Proficy Change Management. For more information,
see “Backing up layouts” on page 72.
Performing Change Management actions from
layout pages
To let users perform actions on projects from layouts (such as “check out” or
“open”), you do the following.
■
Somewhere in the HTML document (preferably close to the beginning),
include the fxLinkWizard object. This ActiveX object contains several script
functions (or “methods”) that perform various actions in the Proficy Change
Management environment.
■
Set up a script tag that performs the desired operations when the user clicks
on the appropriate hypertext link.
For a list of the functions and commands supplied with the fxLinkWizard object,
look up “fxLinkWizard Script Functions” in the online help.
Generalizing page templates with XML
In a factory layout, each layout page uses an HTML page template, specified by
the page’s Template File property. When Proficy Change Management publishes
each page, it creates an XML file and a copy of the HTML template file, both
named after the layout page node. In addition, Proficy Change Management
creates a single XML file for the layout itself (called “fxLayout.XML”).
For more details on layout file generation, see “How Change Management
generates the published layout files” on page 76.
The XML files contain values of layout and page node properties as appropriate,
stored as XML objects. By acquiring information from the appropriately-named
XML objects, you can refer to names and data specific to that page or layout.
For example, you have 10 pages in your layout and you want to display a
different title at the top of each page. Without using XML you’d have to write 10
different page templates. However, pages have a Title property, the value of
which (when published) is stored in its FXPAGE object as a <TITLE> tag. To
retrieve a page’s title, you would:
GFK-1779R
GSFXmgr.pdf 85
Proficy* Change Management 8.00 79
5/1/2013 10:25:59 PM
8
Factory Layouts
Creating Layout Page Templates in HTML
■
Determine the name of the page’s associated XML file. For a given page, the
XML file name will be the same as the current HTML file name, with an
“.XML” file name extension.
■
From the page’s associated XML file, extract the value of its “<TITLE>” tag.
■
Then, instead of displaying specific text at the top of the page, you would
display the value of the <TITLE> tag.
Within an HTML page, one way to acquire data from XML objects is through
VBScripts. For more information on VBScript and XML, search for “VBScript”
and “XML” on Microsoft’s web site at www.microsoft.com.
■
For sample VBscript functions that use a layout’s XML objects, look up HTML
Script Examples for Page Templates in the online Help.
■
For a list of information stored in each XML object, look up Factory Layout
XML Objects and Tags in the online Help.
Creating page templates
Here are some things to keep in mind when writing HTML page template files:
■
When Proficy Change Management publishes the layout, the template is
simply copied to the published directory with a name based on the layout
page node. If you refer to a specific project or set of projects in this HTML file,
those references will appear in all pages that use that template.
To circumvent this, instead of referring to specific projects in your HTML file,
first set the page’s Project Name and Project Type properties to the project
you want this topic to refer to. Then, in the template’s HTML code, use the
values of the <PROJECT_NAME> and <PROJECT_TYPE> tags from the
page’s XML file. For more details, see “Generalizing page templates with
XML” on page 79.
■
80
To perform Proficy Change Management operations from a page displayed in
the InfoViewer (like checking projects in and out of the Proficy Change
Management Server), use fxLinkWizard script functions within a <SCRIPT>
tag. For more information, see Using the fxLinkWizard ActiveX Object in the
online help.
Proficy* Change Management 8.00
GSFXmgr.pdf 86
GFK-1779R
5/1/2013 10:25:59 PM
9
Thin Client
The Proficy Change Management Thin Client is a powerful new way for you to
access your files and projects stored on the Change Management Server using
a thin client application. The Change Management Thin Client allows you to
connect to your server and perform the same tasks, such as check in, check out,
getting the latest version, deleting, and so on.
Similar to the Change Management Thick Client, one or more thin clients
connect to the server over a network to acquire settings or request project files.
All projects, settings, and other files that can be modified are stored in the
database stored on the Change Management Server.
The Thin Client includes the following features:
■
Administrative Console
GFK-1779R
GSFXmgr.pdf 87
■
Expansion Modules
■
Scheduler and Schedule Editor
Proficy* Change Management 8.00 81
5/1/2013 10:25:59 PM
9
Thin Client
Administrative Console
The Administrative Console is a collection of components that allow you to
manage your project files stored on the Change Management Server. The
Administrative Console is made up of the following components:
Upgrade Resources - used to upgrade either a single product file or all
supported product files on the Change Management Server.
Edit Node Tree - used to manage the nodes in the Thin Client.
Products - used to add, delete, or modify products, and access product-based
scripting.
Debug Panel - used to manage logging levels and collect diagnostic
information. When you collect diagnostic information an XML log file is
automatically created. You can send this log file to Technical Support to help
troubleshoot any problems you may have.
Connect/Disconnect - used to connect to or disconnect from your Change
Management Server at any time. This is the recommended method for
connecting to and disconnecting from the server.
IMPORTANT: We do not recommend using the X (Close) button to close the
browser. Using the X button can result in the Change Management session
remaining open. In addition, it is possible that the browser will shut down before
Change Management can clean up and exit properly.
If the Change Management Thin Client browser is closed repeatedly within a
short period of time, multiple sessions and licenses may continue to run. As a
result, the total number of licenses available may be consumed. In this case, no
additional Thin Client sessions will be able to run until the multiple sessions and
corresponding licenses begin to time out.
82
Proficy* Change Management 8.00
GSFXmgr.pdf 88
GFK-1779R
5/1/2013 10:25:59 PM
Thin Client
Expansion Modules
The Proficy Change Management Thin Client provides expansion modules for
some of the most common products used with Proficy Change Management.
These products are:
■
Siemens S7
■
Rockwell RSLogix5/500/5000
■
Modicon ProWORX32
■
Machine Edition
Expansion modules allow you to access projects created and maintained in the
third party software and that are stored in the Change Management Server.
Scheduler and Schedule Editor
The Scheduler is a task execution (event) engine that performs events that you
define in the Scheduler Editor.
You can choose to configure the Scheduler to launch at startup when you install
the Thin Client or you can configure automatic startup at a later time.
The first time you launch the Scheduler, you define the Change Management
Server to connect to. After you have successfully connected to the server, the
Scheduler will automatically connect to that server each time it is launched. If
you need to change to a different server, you can do so at any time while you are
using the Scheduler.
You can log on to the Scheduler only if you have the Edit Event List permission,
as configured in Access Control on the Change Management Thick Client. After
you have logged in, you can start or stop the scheduler, run a manual event,
refresh the events, or configure subscribed groups. Before you can run an event,
however, you must subscribe to a group or groups that the event belongs to.
The Scheduler provides a Feedback Zone that allows you to view scheduler
and/or script information. You can choose to save this information to a file and
clear the Feedback Zone or you can clear the Feedback Zone without saving the
information.
The Scheduler also provides a Debug Panel where you can configure settings
such as logging levels, debug logging levels, and the number of lines to display
in the Feedback Zone.
It is important to note that only one event can run at any given time. For
example, if you run a manual event, the Scheduler will wait until that event
finishes before running a scheduled event.
GFK-1779R
GSFXmgr.pdf 89
Proficy* Change Management 8.00 83
5/1/2013 10:25:59 PM
9
Thin Client
The Schedule Editor is a standalone tool that enables you to create, edit, and
delete events and event groups.
An event is a single, user-defined task associated with your projects. An event
executes at a preset date and time defined by you. Examples of events include
automated Machine Edition or Controller backups and project compares. An
event can belong to any number of event groups, including zero.
An event group can contain zero or many events. An event group defines a
channel that the Scheduler can subscribe to.
Events and event groups are stored on the Change Management Server and are
executed by the Scheduler. The Scheduler runs all events in an event group if
the Scheduler subscribes to that event group.
84
Proficy* Change Management 8.00
GSFXmgr.pdf 90
GFK-1779R
5/1/2013 10:25:59 PM
A
Change Management and iFIX
If you develop iFIX pictures or projects, you can use Proficy Change
Management within iFIX to help you manage your iFIX project files, and track
changes to these files.
This chapter describes how to use Change Management features in the iFIX
WorkSpace and includes the following sections:
■
Introduction
■
Quick Tour: Using Change Management Features in iFIX
■
Quick Start: Configuring iFIX with Integrated Change Management
For more information on using Change Management outside of iFIX, refer to the
Proficy Change Management online help.
GFK-1779R
GSFXmgr.pdf 91
Proficy* Change Management 8.00 85
5/1/2013 10:25:59 PM
A
Introduction
INTRODUCTION
Version controlled files provide fast recovery and reduce the cost and risk of
downtime. The Proficy Change Management add-on for the iFIX product
provides version control for your iFIX project files. Change Management with
Proficy Machine Edition also provides audit trails for tracking changes, security
for preventing unauthorized changes, and scheduled backups to ensure you
always have the latest files.
If you purchase the Change Management feature for iFIX, Change Management
is integrated into your iFIX development environment. To access Change
Management functions in the iFIX WorkSpace environment, you use the rightclick menu on the WorkSpace system tree.
NOTE: Only one user at a time can check out a file.
Features
When you use Proficy Change Management with iFIX, you can do the following:
86
■
Manage all iFIX project files, including configuration files, FIX Desktop, and
non-iFIX project files (such as .OCXs, .DLLs, and .EXE files) from the iFIX
WorkSpace.
■
Use all Change Management features from the right-click Manage menu from
the iFIX WorkSpace tree.
■
Use the Proficy Change Management Client to run scheduled backups of
your iFIX project files and report back the changes.
■
Capture information on who, when, and why iFIX project files were modified.
The audit trail displays in the Proficy Change Management (PCM) History
window (also available from the right-click Manage menu).
■
Identify changes between versions using the PCM History window.
■
Automatically log in to the Change Management Server from the iFIX
WorkSpace, when you synchronize your user names and passwords across
the products.
■
Label iFIX files, folders, or projects with specific text string identifiers.
■
Optionally require iFIX electronic signatures when checking in files to the
Change Management Server (from the right-click menu) in the iFIX
WorkSpace.
Proficy* Change Management 8.00
GSFXmgr.pdf 92
GFK-1779R
5/1/2013 10:26:00 PM
Introduction
■
Include predefined comments for the operators to select when entering an
electronic signature. The comments you display can reside in a different table
than the other iFIX electronic signatures.
Limitations
When using Proficy Change Management with iFIX, be aware of the following
limitations:
GFK-1779R
GSFXmgr.pdf 93
■
In order to use the integrated Change Management features within iFIX, you
must have Proficy Change Management 5.5 with SIM 1 or higher installed.
■
Project-specific folders created for multiple users, such as those described in
the Best Practices for Managing Multiple iFIX Users section in the
Optimization guide, cannot be managed with Proficy Change Management
features in iFIX. Project-specific folders are typically used by Terminal Server
users.
■
When using Terminal Services with iFIX, Proficy Change Management is
supported only from the console session - not from a remote connection.
■
While you can add, check in, check out, and get Proficy Batch Execution files
from the Change Management Server, the version of the Batch Execution
files is not retained. Since there is no version recorded, a version number for
these files does not appear in the PCM History window.
■
Proficy Batch Execution files are added or checked in to the base iFIX project
folder on the Change Management Server. For example, if your project name
is FIX1, then the Batch Execution files are checked in to the base FIX1
project folder in Machine Edition. They are not checked into the APP folder, or
a separate Batch Project folder at this time.
■
In the PCM History window, when displaying the differences in the FIX
Desktop Files, all files except the *.hgp files for the Historical Display are
compared.
■
In the PCM History window, when displaying the differences of the Security
folder, all files except the display.dov file (if it exists) are compared.
■
Depending on the number of FIX Desktop files you have, it may take a longer
time to perform Change Management functions with these files than with
other iFIX files. This is because for FIX Desktop all files are managed
together, instead of individually.
■
Because the FIX Desktop files are saved as one file, individual FIX Desktop
files cannot be viewed individually from within the Proficy Change
Management application.
Proficy* Change Management 8.00 87
5/1/2013 10:26:00 PM
A
88
Introduction
■
Be aware that the Change Management application's Server Trim utility
removes labels from iFIX projects, folders, security files, FIX Desktop files,
Historical Assignment files, and user add-on files. It does, however, leave
your labels on individual iFIX files.
■
Files from a remote location cannot be added to your Change Management
project. If you want to use a network path, you must use a mapped network
drive.
■
Security files that point to a remote security path or a non-local iFIX path
cannot be added to the Change Management Server. Make sure that the
primary and backup security path in the Security application's Configuration
dialog point to the iFIX Local folder. For instance, if you install iFIX to the
default folder, this path is: C:\Program Files\Proficy\Proficy iFIX\LOCAL.
■
When performing a compare of a picture in the PCM History, the VBA
scripting changes are not included in text compare differences. Clear the Text
Compare check box (for the binary compare) to determine if the picture
contains any changes, including VBA script changes. The binary compare
does not list each individual change - just whether the file contains changes.
■
If multiple users want to manage iFIX files from the WorkSpace, and each
user wants the ability to check out the entire project, the project paths
(including the drive letter) must be the same on all computers. Also, the iFIX
user names and passwords must be the same on the Change Management
Server.
■
If you Get an iFIX project from the Change Management Server, you must
restart iFIX. If the SCU files you get do not map to your current path (the
paths are different), the project will not start in iFIX. You must update the SCU
file.
■
While iFIX is running, you cannot get security files, the current SCU, or the
User.fxg file from the iFIX WorkSpace. You can, however, use the Get Other
Project command to copy these files to another location, and then update the
SCU to run the project.
■
You currently cannot manage the iFIX WorkSpace's Help & Information folder,
or the files it contains.
Proficy* Change Management 8.00
GSFXmgr.pdf 94
GFK-1779R
5/1/2013 10:26:00 PM
Introduction
Setting Up iFIX for use with Change
Management
In order to use integrated Change Management features in the iFIX WorkSpace,
you must have both iFIX 4.0 or higher and Proficy Change Management 5.5 with
SIM 1 or higher. Additionally, you need to configure a few items on both iFIX and
the Change Management Server, as described below.
To configure t he iFIX product for inte grat ed Change Ma nagem ent:
1. Add iFIX users with Change Management application privileges.
2. Enable iFIX security. The options on the iFIX User Preferences dialog box's
Change Management tab are unavailable until you enable security.
3. Confirm that any remote project paths appear as mapped network drives.
4. Confirm that all security paths are mapped to the iFIX Local path.
5. From the iFIX User Preferences dialog box's Change Management tab, do the
following:
■
Enable the Change Management Server connection and select the server to
which you want to connect.
■
Enter or select a project name.
Configure logon options and electronic signature requirements.
Want to know more? In the iFIX Electronic Books Index, look up overview and choose “iFIX
Configuration”.
To configure t he Cha nge Ma nagem ent S erv er f or iFI X 4. 0 or hi gher:
1. Add users for the integrated iFIX feature. If you want to use the automatic login
feature, Change Management user names and passwords should match the
iFIX ones.
2. Configure user privileges.
Want to know more? In the iFIX Electronic Books Index, look up overview and choose
“Change Management Server configuration”.
GFK-1779R
GSFXmgr.pdf 95
Proficy* Change Management 8.00 89
5/1/2013 10:26:00 PM
A
Quick Tour: Using Change Management Features in iFIX
QUICK TOUR: USING CHANGE
MANAGEMENT FEATURES IN IFIX
The following sections describe how to get started with Change Management
features in iFIX, after you configure the iFIX WorkSpace and Proficy Change
Management Server. It provides information on the following functions:
■
Logging In
■
Viewing the Connection to the Change Management Server
■
Using Change Management Features in iFIX
■
Understanding Electronic Signatures
■
Using the Change Management History Window
Logging In
To log in to the Change Management Server from iFIX, you do so at startup, or
by simply right-clicking the node name, pointing to Manage, and selecting
Logon. If the Logon dialog is configured to display, it appears as shown in the
following figure.
Change Management Logon Dialog Box from the iFIX WorkSpace
Want to know more? In the iFIX Electronic Books Index, look up overview and choose “iFIX
Configuration”, or look up automatic logon to the Change Management Server.
90
Proficy* Change Management 8.00
GSFXmgr.pdf 96
GFK-1779R
5/1/2013 10:26:00 PM
Quick Tour: Using Change Management Features in iFIX
Viewin g the Connectio n to the Change Management Server
If you are not logged into the Change Management Server, the iFIX WorkSpace
displays: PCM Not Connected. The status area displays in red, as shown in the
following figure.
Change Management Server Not Connected
After you successfully log into the Change Management Server, the iFIX
WorkSpace displays: Connected to PCM Server ServerName. ServerName is
the actual Proficy Change Management Server's name. The status area
changes to green, as shown in the following figure.
Change Management Server Connected
Once the status area changes to green, you can begin using Change
Management features in the iFIX WorkSpace.
GFK-1779R
GSFXmgr.pdf 97
Proficy* Change Management 8.00 91
5/1/2013 10:26:00 PM
A
Quick Tour: Using Change Management Features in iFIX
Using Change Management Features in iFIX
To access Change Management features in the iFIX WorkSpace environment,
you use the right-click menu on the WorkSpace system tree, as illustrated in the
following figure.
Using Change Management Functions in the iFIX WorkSpace
You must be logged into the Proficy Change Management Server in order to
view the Change Management commands from this right-click command.
Want to know more? In the iFIX Electronic Books Index, look up Change Management and
choose “using in iFIX”.
92
Proficy* Change Management 8.00
GSFXmgr.pdf 98
GFK-1779R
5/1/2013 10:26:00 PM
Quick Tour: Using Change Management Features in iFIX
Understanding Electronic Signatures
When checking in files to the Change Management Server, you can optionally
specify that the user provide an iFIX electronic signature or signatures before a
file is overwritten on the Change Management Server.
When you check in a file, the Check In dialog box appears first, as shown in the
following figure.
Check In Dialog Box
GFK-1779R
GSFXmgr.pdf 99
Proficy* Change Management 8.00 93
5/1/2013 10:26:00 PM
A
Quick Tour: Using Change Management Features in iFIX
Next, if only a Perform signature is required, the following Electronic Signature
dialog box appears.
Electronic Signature Dialog Box - Perform
94
Proficy* Change Management 8.00
GSFXmgr.pdf 100
GFK-1779R
5/1/2013 10:26:00 PM
Quick Tour: Using Change Management Features in iFIX
If Perform and Verify signatures are required, the following Electronic Signature
dialog box appears.
Electronic Signature Dialog Box - Perform and Verify
These Electronic Signature dialog boxes are the same ones used by the iFIX
product in other areas, and work the same way.
For more information on using iFIX electronic signatures and Change
Management, refer to the iFIX Electronic Signatures and Change Management
and Comment Tables, Electronic Signatures, and Change Management
sections.
Want to know more? In the iFIX Electronic Books Index, look up Understanding and choose
“electronic signatures and Change Management”.
GFK-1779R
GSFXmgr.pdf 101
Proficy* Change Management 8.00 95
5/1/2013 10:26:00 PM
A
Quick Tour: Using Change Management Features in iFIX
Using the Change Management History Window
The Proficy Change Management (PCM) History window allows you to view the
revision history of a file, folder, or project. You can also compare different
versions of the same file or folder in the Change Management Server, or even
compare versions on the Server with the ones stored on your local computer.
You open the PCM History window by right-clicking a file, folder or project in the
iFIX WorkSpace system tree, pointing to Manage, and then clicking History
Report. The following figure is an example of the window that appears.
PCM History Window
Want to know more? In the iFIX Electronic Books Index, look up understanding and choose
“Understanding the Proficy Change Management History Window”.
96
Proficy* Change Management 8.00
GSFXmgr.pdf 102
GFK-1779R
5/1/2013 10:26:00 PM
Quick Start: Configuring iFIX with Integrated Change Management
QUICK START: CONFIGURING IFIX
WITH INTEGRATED CHANGE
MANAGEMENT
The following steps provide a quick example of how to set up iFIX so that you
can use it with the integrated Change Management features. There are also
steps on the Change Management Server that you need to perform. The
configuration steps for iFIX and Change Management include:
■
Step 1: Adding a User in iFIX
■
Step 2: Enable Security in iFIX
■
Step 3: Set iFIX User Preferences
■
Step 4: Add a User and Configure Privileges in Machine Edition
■
Step 5: Configure User Privileges in Machine Edition
■
Step 6: Add a Schedule in Machine Edition
■
Step 7: Restart the iFIX WorkSpace
In these steps, we add a user named ABC. His password is iamabc, in all
lowercase letters. The user exists on both the iFIX SCADA and on the Change
Management Server. iFIX Security is enabled on the SCADA node, and ABC
has access to all iFIX features, including the Change Management feature.
Additionally, ABC is also an administrator on the Change Management Server.
The Administrator group includes privileges for all of the following features used
in iFIX: Check In, Check Out, Get, Label, Override Checkout, Change Password,
and Edit Project List.
As an Administrator, ABC can also run schedules. We will schedule an iFIX
Backup and Restore event to occur daily, at 11:30 pm, starting next Monday.
When ABC logs in to the Change Management Server he starts iFIX. No Logon
dialog box displays. No iFIX electronic signatures are required to check in files.
These steps assume that you already installed Proficy iFIX, Machine Edition,
Change Management, and the Scheduler. You must know the name of your
Change Management Server and the name of your iFIX SCADA node to
proceed.
GFK-1779R
GSFXmgr.pdf 103
Proficy* Change Management 8.00 97
5/1/2013 10:26:00 PM
A
Quick Start: Configuring iFIX with Integrated Change Management
Step 1: Adding a User in iFIX
In the following steps, we add an iFIX SCADA user named ABC with privileges
to all iFIX features, including the Change Management feature, as illustrated in
the following figure.
Security Configuration: Application Features for User
To add a user in iFIX wi th Change Manage ment capability :
1. Start the Security Configuration application.
2. On the Security toolbox, click the User Account button.
3. Click Add.
4. Leave the Use the Windows Security check box cleared.
5. In the Full Name field, enter ABC for the new user account.
6. In the Login name field, enter ABC.
7. In the Password field, enter iamabc.
8. Under the Application security area, click Modify. The Application Feature
Selection dialog box appears.
98
Proficy* Change Management 8.00
GSFXmgr.pdf 104
GFK-1779R
5/1/2013 10:26:00 PM
Quick Start: Configuring iFIX with Integrated Change Management
9. In the Available list box, click Add All. This ensures that the user is an
administrator on the SCADA node and has privileges for the Change
Management feature.
10. Click OK to save your changes.
11. Click OK.
12. On the File menu, click Save.
Want to know more? In the iFIX Electronic Books Index, look up overview and choose “iFIX
Configuration”.
Step 2: Enable Security in iFIX
In order to configure User Preferences in the iFIX WorkSpace, you must enable
security, as illustrated in the following figure. Without security enabled, you
cannot edit the Change Management tab on the User Preferences.
Security Configuration: User Based Security Enabled
T o enabl e i F I X se curi t y:
1. Open the Security Configuration application, if it is not already open. iFIX must
be running.
2. Click the Configuration button on the Security toolbox.
3. Select Enabled to enable security then click OK.
4. On the File menu, click Save.
GFK-1779R
GSFXmgr.pdf 105
Proficy* Change Management 8.00 99
5/1/2013 10:26:00 PM
A
Quick Start: Configuring iFIX with Integrated Change Management
Step 3: Set iFIX User Preferences
In the following steps, in the iFIX User Preferences dialog box on the Change
Management Server tab, we select the Enable Change Management Server
Connection check box to enable the feature. We also specify the Change
Management Server name, configure automatic logon when the WorkSpace
starts up, and create a project named after the iFIX node name.
iFIX User Preferences
100
Proficy* Change Management 8.00
GSFXmgr.pdf 106
GFK-1779R
5/1/2013 10:26:00 PM
Quick Start: Configuring iFIX with Integrated Change Management
To enabl e Cha nge Ma nagem ent U ser P re fer ences :
1. Shut down iFIX if it is running.
2. Start iFIX, and the Proficy iFIX WorkSpace.
3. On the WorkSpace menu, click User Preferences. The User Preferences dialog
box appears.
4. Click the Change Management tab.
5. Select the Enable Change Management Server Connection check box.
6. In the Change Management Server field, enter the name of your server. For
instance, if your server was named MyServer, enter MyServer in this field.
7. Select the Logon at WorkSpace Startup check box.
8. Clear the Prompt for User Name and Password check box, so that you can
automatically logon to the Change Management Server when you start the
WorkSpace.
9. In the Change Management Project Name field, enter the name of your iFIX
project. This can be any name, but typically you use the name of your iFIX node.
10. In the Electronic Signature Options area, select None for the Type.
11. Click OK.
12. Do not restart iFIX yet. Wait until you configure your users in Machine Edition.
Step 4: Add a User and Configure Privileges in
Machine Edition
In the following steps, we add a user for Change Management Server, as
illustrated in the following figure. The user name is ABC and the password is
iamabc, which is identical to the iFIX SCADA user name and password created
in the previous set of steps.
To add a user f or iFIX projec ts:
1. Start Proficy Machine Edition.
2. In the Navigator, right-click Access Control and select Check Out Access
Control.
3. In the Access Control folder, right-click the User folder and select New User.
GFK-1779R
GSFXmgr.pdf 107
Proficy* Change Management 8.00
101
5/1/2013 10:26:00 PM
A
Quick Start: Configuring iFIX with Integrated Change Management
4. Enter ABC and press Enter.
5. Right-click the user you just created in step 4, and select Change Password. The
Change Password dialog box appears.
6. For the password, enter iamabc. This password should be in the same case as
the iFIX password.
7. Click OK.
8. In the Navigator, right-click Access Control and select Check In Access Control.
Step 5: Configure User Privileges in Machine
Edition
In the following steps, we add privileges from the Administrator group to the user
that we created, as shown in the following figure. As an Administrator, ABC will
have access to perform the following functions in iFIX: Check In, Check Out,
Get, Label, Override Checkout, Change Password, and Edit Project List. This is
because the Administrator group includes all of these privileges.
To configure us er p ri vi l eg es :
1. In the Navigator, right-click Access Control and select Check Out Access
Control.
2. Double-click the User folder to view all users.
3. Right-click the user named ABC, and select Add to Group, and then
Administrators.
4. In the Navigator, right-click Access Control and select Check In Access Control.
102
Proficy* Change Management 8.00
GSFXmgr.pdf 108
GFK-1779R
5/1/2013 10:26:00 PM
Quick Start: Configuring iFIX with Integrated Change Management
Step 6: Add a Schedule in Machine Edition
In these steps, we lead you through the process of scheduling an iFIX Compare
and Backup event, as shown in the following figure. The event will run daily at
11:30 pm, and will start running this Monday.
When an FIX Compare and Backup event runs, Machine Edition checks if your
local iFIX project files are different from the ones on the Change Management
Server. If the ones on your local drive are newer, these files are checked in. This
option is available only for iFIX 4.0.
If you want to run either the "iFIX Compare" or "iFIX Compare and Backup"
event, you must have the Proficy Machine Edition Client and Scheduler
Components installed on your SCADA Server (Machine Edition 5.5, SIM 1 - at a
minimum). These install programs are not found on the iFIX product CD. You
need to install them from the Proficy Machine Edition CD.
To add an i FI X Com pare a nd B ack up E ve nt:
1. Start Proficy Machine Edition.
2. In the Navigator, right-click Scheduler Event List and select Check Out
Scheduler Settings
3. Right-click Scheduler Event List, and click Add Event.
4. Enter a name, and press Enter.
NOTE: Names can include numbers (0-9), lowercase letters (a-z), uppercase
letters (A-Z), or the dash (-) symbol, and can be up to 31 characters long. The
first character must be a letter. Spaces are not allowed.
5. Double-click the event you added in step 4 to open the Event Properties dialog
box.
6. In the Event Type field, select iFIX Compare and Backup.
7. In the Computer Name field, enter the name of the iFIX SCADA computer.
GFK-1779R
GSFXmgr.pdf 109
Proficy* Change Management 8.00
103
5/1/2013 10:26:00 PM
A
Quick Start: Configuring iFIX with Integrated Change Management
NOTE: Machine Edition supports computer names that include numbers (0-9),
lowercase letters (a-z), uppercase letters (A-Z), or the dash (-) symbol. If you
leave this field blank or enter a period "." in this field, the event executes on all
computers the schedule is run on.
8. In the Project Type field, enter a description.
9. In the Event Trigger field, select Daily.
10. Configure the event to run daily at 11:30 pm, starting this Monday.
11. Click OK.
12. In the Navigator, right-click Scheduler Event List and select Check In Scheduler
Settings.
Step 7: Restart the iFIX WorkSpace
After you finish configuring iFIX and Change Management, you can test your
configuration. To do this, restart iFIX. When iFIX starts, logon the user named
ABC. Start the iFIX WorkSpace. The Change Management Server should
automatically log you in.
You are now ready to use Change Management features from within the iFIX
WorkSpace. For tips on how to get started, refer to the Quick Tour: Using
Change Management Features in iFIX section.
104
Proficy* Change Management 8.00
GSFXmgr.pdf 110
GFK-1779R
5/1/2013 10:26:00 PM
A2
Change Management and CIMPLICITY
HMI
If you develop CIMPLICITY projects, you can use Proficy Change Management
to help you manage your CIMPLICITY project files, and track changes to these
files.
This chapter describes how to use Change Management features in the
CIMPLICITY Workbench and includes the following sections:
■
Introduction
■
Quick Tour: Using Change Management Features in CIMPLICITY
For more information on using Change Management outside of CIMPLICITY,
refer to the Proficy Change Management online help.
GFK-1779R
GSFXmgr.pdf 111
Proficy* Change Management 8.00
105
5/1/2013 10:26:00 PM
A2
Introduction
INTRODUCTION
Version controlled files provide fast recovery and reduce the cost and risk of
downtime. The Proficy Change Management add-on for the CIMPLICITY
product enables you to manage and maintain programs and projects in a
manufacturing environment to improve plant up time, enforce good engineering
practice and reduce risk.
CIMPLICITY integrates the Change Management client into the Workbench so
you can directly manage your CIMPLICITY projects from the Workbench using
the right-click menu on the Workbench system tree.
Change Management with Proficy Machine Edition also provides audit trails for
tracking changes, security for preventing unauthorized changes, and scheduled
backups to ensure you always have the latest files.
Several versions of projects and files that apply to a single CIMPLICITY project
or computer level configuration can be stored on and retrieved from a Proficy
Change Management Server.
Features
When you use Proficy Change Management with CIMPLICITY, you can do the
following:
106
■
Manage all CIMPLICITY project files, including configuration files, and nonCIMPLICITY project files (such as .OCXs, .DLLs, and .EXE files) from the
CIMPLICITY Workbench.
■
Use all Change Management features from the right-click Manage menu from
the CIMPLICITY Workbench tree and from the Project or Computer menus.
■
Use the Proficy Change Management Client to run scheduled backups of
your CIMPLICITY project files and report the changes.
■
Capture historical information on who, when, and why CIMPLICITY project
files were modified. The audit trail displays in the Proficy Change
Management (PCM) History window (also available from the right-click
Manage menu).
■
Identify changes between versions using the PCM History window.
■
Automatically log in to the Change Management Server from the
CIMPLICITY Workbench, when you synchronize your user names and
passwords across the products.
■
Label CIMPLICITY files, folders, or projects with specific text string identifiers.
Proficy* Change Management 8.00
GSFXmgr.pdf 112
GFK-1779R
5/1/2013 10:26:00 PM
Introduction
Limitations
■
In order to use the integrated Change Management features within
CIMPLICITY, you must have Proficy Change Management 5.6 or higher
installed.
Overview
There are two types of Change Management projects available in CIMPLICITY:
■
CIMPLICITY project
■
Computer project
There are two classes of entities that can be added to Change Management for
each project type:
■
Base Configuration: A collection of interrelated files that must remain
interrelated and must be managed as a single unit.
■
Individually managed files: Files that can be managed as individual units.
CI MPLIC ITY Project
All user-configurable configuration files can be added to Change Management.
Project configuration files include base configuration and individually managed
files.
Base configuration files make up the project’s basic configuration; for example,
point and alarm configuration files, which are required for the project processes
to run. Base configuration files are automatically added to Change Management
the next time the base configuration (or project) is checked in. They are also
checked in whenever any base configuration entity is selected to be checked in.
IMPORTANT: A base configuration must be added once in order to be managed.
Individual files that are listed in the CIMPLICITY project’s Managed Files folder
(for example, CIMView screens and scripts) can be added separately to the
Change Management Server.
Individually managed files are added to the Change Management Server when
the project is added, or can be added individually.
NOTE: A project can be added more than once; therefore, each time the project
is added, any individually managed files that were not already added are added
to the Change Management Server.
GFK-1779R
GSFXmgr.pdf 113
Proficy* Change Management 8.00
107
5/1/2013 10:26:00 PM
A2
Introduction
Individual files must be added in order to be managed; they are not automatically
added when the project is checked in.
Want to know more? In the CIMPLICITY Help, look up “CIMPLICITY Project in the
Workbench: Managed Files Overview”.
Com put er P roj ec t
All files in a computer project can be added to Change Management. Computer
files include computer base configuration and managed files.
Base configuration files make up the computer project’s basic configuration; for
example, globals.ini and cimhosts.txt, which are required for the computer
project system’s processes to run.
Individual files that are listed in the Computer project’s Managed Files folder (for
example, WebView screens, CimView screens, and scripts) can be added
separately to the Change Management Server.
Individually managed files are added to the Change Management Server when
the project is added, or can be added individually.
NOTE: A Computer project can be added more than once; therefore, each time
the project is added, any individually managed files that were not already added
are added to the Change Management Server.
Individual files must be added in order to be managed; they are not automatically
added when the project is checked in.
Want to know more? In the CIMPLICITY Help, look up “Computer Project in the
Workbench: Managed Files Overview”.
108
Proficy* Change Management 8.00
GSFXmgr.pdf 114
GFK-1779R
5/1/2013 10:26:00 PM
Introduction
Setting Up CIMPLICITY for use with Change
Management
In order to use integrated Change Management features in the CIMPLICITY
Workbench, you must have both CIMPLICITY 7.0 or higher and Proficy Change
Management 5.6 or higher. Additionally, you need to configure a few items on
both CIMPLICITY and the Change Management Server, as described below.
To configure C omput er Project s for int egrat ed Cha nge Ma nagem ent:
1. On the Workbench menu bar, from the Computer menu, choose Properties.
The Computer Properties dialog box appears.
2. In the Computer Properties dialog box, do the following:
■
Enable the Change Management Server connection and enter the name of
the server you want to connect to.
■
Configure logon options.
■
Enter or select a project name.
■
Configure modification options.
3. Click OK.
Want to know more? In the CIMPLICITY Help, look up “Enable Computer Management”.
GFK-1779R
GSFXmgr.pdf 115
Proficy* Change Management 8.00
109
5/1/2013 10:26:00 PM
A2
Introduction
To configure C I MP LICI TY Projec ts f or integr ate d C hange Manage ment :
1. From the Project menu, choose Properties.
The Project Properties dialog box appears.
2. In the Project Properties dialog box’s Change Management tab, do the following:
■
Enable the Change Management Server connection and enter the name of
the server you want to connect to.
■
Configure logon options.
■
Enter or select a project name.
■
Configure modification options.
■
Select a runtime configuration data preservation option.
3. Click OK.
Want to know more? In the CIMPLICITY Help, look up “Enable Project Management”.
110
Proficy* Change Management 8.00
GSFXmgr.pdf 116
GFK-1779R
5/1/2013 10:26:00 PM
Introduction
Test ing t he Connection t o t he Change M anag ement Server
When you configure the computer or project properties, you can test the
connection to the Change Management Server you want to log on to.
Test Change Management Server
To perform the connection test, click the Test connection button and then log on
to the Change Management Server. A message displays informing you whether
the connection test was successful or not, depending on the status of the
Change Management Server.
If the test connection succeeds, you can log on to Change Management and
begin using its features in the CIMPLICITY Workbench.
Want to know more? In the CIMPLICITY Help, look up Enable Project Management or
Enable Computer Management
GFK-1779R
GSFXmgr.pdf 117
Proficy* Change Management 8.00
111
5/1/2013 10:26:00 PM
A2
Quick Tour: Using Change Management Features in CIMPLICITY
QUICK TOUR: USING CHANGE
MANAGEMENT FEATURES IN
CIMPLICITY
The following sections describe how to get started with Change Management
features in CIMPLICITY, after you configure the CIMPLICITY Workbench and
Proficy Change Management Server. It provides information on the following
functions:
■
Logging In
■
Testing the Connection to the Change Management Server
■
Using Change Management Features in CIMPLICITY
Logging In
To log in to the Change Management Server from CIMPLICITY, you do so at
startup, or by simply right-clicking the project or computer folder in the left pane,
pointing to Manage, and selecting Logon. If the Logon dialog is configured to
display, it appears as shown in the following figure.
Change Management Logon Dialog Box from the CIMPLICITY Workbench
Want to know more? In the CIMPLICITY Help, look up Logon.
112
Proficy* Change Management 8.00
GSFXmgr.pdf 118
GFK-1779R
5/1/2013 10:26:00 PM
Quick Tour: Using Change Management Features in CIMPLICITY
Viewin g the Connectio n to the Change Management Server
If you are not logged into the Change Management Server, the CIMPLICITY
Workbench displays: PCM Not Connected. The status area displays in red, as
shown in the following figure.
Change Management Server Not Connected
After you successfully log into the Change Management Server, the
CIMPLICITY Workbench displays: Connected to PCM Server ServerName.
ServerName is the actual Proficy Change Management Server's name. The
status area changes to green, as shown in the following figure.
Change Management Server Connected
When the status area changes to green, you can begin using Change
Management features in the CIMPLICITY Workbench.
GFK-1779R
GSFXmgr.pdf 119
Proficy* Change Management 8.00 113
5/1/2013 10:26:01 PM
A2
Quick Tour: Using Change Management Features in CIMPLICITY
Using Change Management Features in
CIMPLICITY
To access Change Management features in the CIMPLICITY Workbench
environment, you use the right-click menu on the Workbench left pane, as
illustrated in the following figure.
Using Change Management Functions in the CIMPLICITY Workbench
There are multiple ways to view the Change Management command menus and
each menu differs slightly depending on where you access it from.
CIMPLICITY Workbench Right-click Menu options
114
Proficy* Change Management 8.00
GSFXmgr.pdf 120
GFK-1779R
5/1/2013 10:26:01 PM
Quick Tour: Using Change Management Features in CIMPLICITY
You must be logged into the Proficy Change Management Server in order to
view the Change Management commands from the right-click menus.
Want to know more? In the CIMPLICITY Help, look up Proficy Change Management
Procedures.
Using the Change Management History Window
The Proficy Change Management (PCM) History window allows you to view the
revision history of a file, folder, or project. You can also compare different
versions of the same file or folder in the Change Management Server, or even
compare versions on the Server with the ones stored on your local computer.
You open the PCM History window by right-clicking a file, folder or project in the
CIMPLICITY Workbench left pane, pointing to Manage, and then clicking History
Report. The following figure is an example of the window that appears.
PCM History Window
Want to know more? In the CIMPLICITY Help, look up Show History.
GFK-1779R
GSFXmgr.pdf 121
Proficy* Change Management 8.00 115
5/1/2013 10:26:01 PM
A2
116
Quick Tour: Using Change Management Features in CIMPLICITY
Proficy* Change Management 8.00
GSFXmgr.pdf 122
GFK-1779R
5/1/2013 10:26:01 PM
Index
Symbols
.INI files 59
.LAY files 72
.XML files 76
Numerics
3rd party projects. See Custom
Project Support, Custom Product
Types
A
Access Control 43
database 44
Factory Layouts 45
for Custom Product Types 61
for projects 44
for Version Control 41
groups 43
how it works 43
permissions 43
prrojects and toolchest
drawers 44
security providers 45
users 43
action scripts 62
actions, Scheduler event 52
adding
Custom Product Types 65
local projects 41
third-party projects 41
adding projects 35
Administrative Console
Connect/Disconnect 82
Debug Panel 82
Node Tree 82
Product Properties 82
Thin Client 82
Upgrade Resources 82
Administrator user 45
Administrators group 45
Audit Trail database 48
Audit Trail Reports 49
GFK-1779R
GSFXmgr.pdf 123
Audit Trail settings 47
Audit Trailing 47
database. See Audit Trail
database
for Custom Product Types 61
how it works 47
reports. See Audit Trail Reports
settings. See Audit Trail settings
Audit Trails. See Audit Trailing
authorization
hardware key 21
authorization. See product
authorization
B
backing up layouts 72
basic menu actions 63
Build tab 37
C
Change Management
testing the connection 111
using in CIMPLICITY 114
using in iFIX 92
viewing the connection 91, 113
Change Management and
CIMPLICITY 105
Change Management and iFIX 85
Change Management limitations in
iFIX 86, 87, 106
Change Management. See Proficy
Change Management
checking in
Custom Product Types 65
checking out 64
Factory Layouts 77
checking out items 39, 41
CIMPLICITY Project 107
CIMPLICITY with Change
Management
introduction 106
cloning Custom Product Types 66
Companion 33
Computer Project 108
configuring
iFIX with integrating Change
Management
support 97
properties 36
Scheduler 53
Scheduler events 52
user preferences 35
Connect/Disconnect
Administrative Console 82
connected to Server 29
connection
Change Management Server 91,
111, 113
console
Proficy Change Management
Server 30
creating
Custom Product Types 66
Factory Layoutslayouts.See
Factory Layouts
layout page templates 80
projects 41
Custom Product Type scripts 58
Custom Product Types 56
Access Control settings 61
Add Product Type Wizard 66
adding 65
Audit Trail settings 61
basic menu actions 63
checking in 65
checking out 64
copying (cloning) 66
creating 66
exploring setting directories 65
Managing 64
menu scripts 60, 62
See also Custom Project Support
setting files 57
Settings.INI file 58
user-defined help 61
Custom Project scripts 58
Custom Project Settings folder 64
Proficy* Change Management 8.00
117
5/1/2013 10:26:01 PM
Custom Project Startup Files 58
checking in 65
checking out 64
Custom Project Support 55
directory structure 58
GlobalSettings.INI file 58
how it works 56
Master scripts 60
Script Library directory 59
See also Custom Product Types
Startup scripts 59
Custom Product Types
See also Custom Project Support
Custom Projects
templates for 58
customer support 24
D
Debug Panel
Administrative Console 82
directories
Custom Product Types 58
Master subdirectories 60
product type settings 58
Script Library 59
Startup Files 58
Factory Layout
fxPublish 71
disconnected from Server 29
E
environment 30
Proficy Change Management 27
event
Universal Compare 66
events. See Scheduler events
Everyone group 45
Expansion Modules
Thin Client 83
exploring custom product type
directories 65
exporting layouts 72
F
Factory Layouts 69
Access Control 45
backing up 72
118
Proficy* Change Management 8.00
GSFXmgr.pdf 124
checking out 77
creating 73
exporting 72
fxPublish directory 71
generated files 76
how they work 71
importing 72
page templates. See layout page
templates
publishing. See publishing factory
layouts
templates 80
using 70
factory layouts
publishing 78
features 86, 106
CIMPLICITY with Change
Management 106
iFIX with Change
Management 86
Feedback Zone 37
files
for custom product types 57
in published layouts 76
FXLAYOUT XML object 76
FXPAGE XML object 76
fxPublish directory 71
using a web server 72
G
getting help 32
GlobalSettings.INI file 58
groups 43
Adminstrators 45
Everyone 45
system 45
Guest user 46
H
hardware key 21
help 32
Companion 33
user-defined Custom Product
Type 61
history report 40
hsitory window 96, 115
HTML page templates. See layout
page templates
I
iFIX with Change Management
introduction 86
iFIX with Change Management quick
start 97
Important Information for PCM Thin
Client for IIS 17
importing layouts 72
index, search 32
InfoView tab 35
InfoViewerhelp
InfoViewer 33
INI files 59
Inspector 36
installing Proficy Change
Management 7
Server authorization 21
Server installation 7
Thick Client installation 19
Thin Client for IIS installation 14
Thin Client installation 13
Internet Security Settings for PCM
Thin Client for IIS 17
introduction 86, 106
CIMPLICITY with Change
Management 106
iFIX with Change
Management 86
K
key features 32–37
keyword search 32
L
LAY files 72
layout page templates 78
creating 78, 80
in published layouts 76
using XML in 79
layouts
see Factory Layouts
limitations 86, 87, 106
iFIX with Change
Management 86, 87,
106
local projects 41
logging in 90, 112
GFK-1779R
5/1/2013 10:26:01 PM
Change Management Server 90,
112
logging on
connected 29
disconnected 29
logging on to Proficy Change
Management 28
M
Manager tab 35
Manager. See Proficy Change
Management
Master scripts 60
menu scripts 62
basic menu actions 63
precedence 60
Messages tab 37
N
Navigator 34
refreshing nodes in 29
Node Tree
Administrative Console 82
node tree for PCM Thin Client for
IIS 16
O
online help 32
opening
Proficy Change Management 19
Options tab 35
options, user preferences 35
P
PCM Thin Client for IIS
creating a node tree 16
Important Information 17
installing 14
update Internet Security
Setitngs 17
update Trusted Sites list 18
update Trusted Sites Security
Settings 17
permissions 43
product authorization 21
Product Properties
Administrative Console 82
GFK-1779R
GSFXmgr.pdf 125
Proficy Change Management
environment 27
logging on 28
running 19
Server 27
Server console 30
Proficy Change Management Server.
See Server
Proficy Change Management Thick
Client. See Thick Client
Proficy Change Management Thin
Client. See Thin Client
project folders 41
Project History 40
projects 34, 39
Access Control 44
adding 35
adding to Server 41
CIMPLICITY 107
Computer 108
creating 41
Custom Projects. See Custom
Projects
history report 40
local 41
properties 36
publishing factory layouts 71, 78
fxPublish directory 71
generated files 76
using a web server 72
Q
quick start
iFIX and Change
Management 97
quick tour 90
Change Management History
window 96, 115
iFIX with Change
Management 90
R
registration. See product
authorization
Reports tab 37
requirements, hardware and
software 2
restarting iFIX 104
right-click menus 32
running
Proficy Change Management 19
Scheduler 53
S
Sample.LAY 72
Scheduler 51
configuring 53
engine. See Scheduler Engine
events. See Scheduler events
how it works 51
running 53
system requirements 6
Thin Client 83
Universal Compare event 66
Scheduler Editor
Thin Client 83
Scheduler Engine 53
starting event execution 54
Scheduler Event List. See Scheduler
events
Scheduler events 51
actions 52
configuring 52
scripts 52
starting 54
triggers 52
script functions 63
Script Library directory 59
scripts
action 62
Scheduler events 52
UI 62
search, index 32
security for Version Control 40
security providers 45
security. See Access Control
Server 27
authorization 21
check out from 39
connected to 29
Custom Product Types, storing
on 64
disconnected from 29
installation and setup 7
system requirements 2
setting up 89, 109
Proficy* Change Management 8.00
119
5/1/2013 10:26:01 PM
iFIX and Change Management
Server 89, 109
settings
audit trail. See Audit Trail settings
Settings folder, Custom Product
Types 64
Settings.INI file 58
setup. See installing Proficy Change
Management
Shortcut menus for Custom Product
Types 62
basic menu actions 63
Startup Files 58, 64
System groups and users 45
system requirements 2
Scheduler computer 6
Server computer 2
Thick Client computer 5
Thin Client computer 4
T
technical support 24
templates
custom project 58
testing 111
Change Management Server
connection 111
Thick Client
installation and setup 19
system requirements 5
Thin Client 81
Administrative Console 82
Expansion Modules 83
installation and setup 13
Scheduler 83
Scheduler Editor 83
system requirements 4
Thin Client for IIS
installation and setup 14
third party projects. See Custom
Project Support, Custom Product
Types
third-party projects
adding 41
toolchest drawers
Access Control 44
tools
Companion 33
120
Proficy* Change Management 8.00
GSFXmgr.pdf 126
Feedback Zone 37
InfoViewer 33
Inspector 36
Navigator 34
toolbars 34
tracking
see Audit Trailing
triggers, Scheduler event 52
Trusted Sites list for PCM Thin Client
for IIS 18
Trusted Sites Security Settings for
PCM Thin Client for IIS 17
files 79
generalizing page templates 79
XML files 76
U
UI scripts 62
basic menu actions 63
understanding
electronic signatures and Change
Management 93
Upgrade Resources
Administrative Console 82
user preferences 35
users 43
Adminstrator 45
Guest 46
system 45
using CIMPLICITY with Change
Management 106
using iFIX with Change
Management 86
Utilities tab 35
V
Version Control 39
how it works 39
security 40, 41
viewing 91, 113
Change Management Server
connection 91, 113
W
Wizard, Add Custom Product Type
see Add Product Type Wizard
X
XML
accessing tags from HTML 79
GFK-1779R
5/1/2013 10:26:01 PM
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement