Using The IFIX - SOA Service Provider

GE iFIX
Using the iFIX-SOA Service Provider
Version 5.8, SP2

December 2016
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 mer-
chantability 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, equip-
ment and software, is upon the buyer or user. GE Intelligent Platforms, Inc. shall not be liable for any damages, includ-
ing 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 accepted by the buyer or user before the use of such information, equipment or
software.
Trademark Notices
© 2016, General Electric Company. All rights reserved.
Proficy is a trademark of GE Intelligent Platforms, Inc., a wholly-owned subsidiary of General Electric Company.
* Indicates a trademark of General Electric Company and/or its subsidiaries.
All other product names and marks identified throughout this book are trademarks or registered trademarks of their
respective companies. They are used throughout this book in editorial fashion only. No such use, or the use of any
trade name, is intended to convey endorsement or affiliation.
No part of this publication may be reproduced in any form, or stored in a database or retrieval system, or transmitted
or distributed in any form by any means, electronic, mechanical photocopying, recording or otherwise, without the
prior written permission of GE Intelligent Platforms. Information contained herein is subject to change without notice.
We want to hear from you. If you have any comments, questions, or suggestions about our documentation, send them
to the following email address:
doc@ge.com
Table of Contents
Using the iFIX -SOA Service Provider 2
Supported Node configurations: 2
Limitations: 2
Getting Started 3
Installing iFIX - 3
Prerequisites 3
Prerequisites to Install the Proficy 3
Prerequisites to Install the Proficy 3
Installing the Proficy 3
To install the Proficy iFIX Data Provider 4
Installing the Proficy 4
To install the Proficy 4
Data Provider Log Details 4
Configuring Connections 6
Configurations on the iFIX SCADA Node 6
To add tasks to the iFIX SCU: 6
Creating a Proficy 7
To create a Proficy 7
Enabling iFIX Security 7
To enable security for the new user account: 8
Configuring Connections - Proficy iFIX and Workflow 8
To add and configure the connection between Proficy iFIX and Workflow 8
To view iFIX connection details 8
iFIX-SOA Service Provider Security 9
Configuring Authentication 10
Configuring Authentication in Proficy iFIX Data Provider 10
To connect through Windows Authentication mode: 11
To connect through Certificate Authentication mode: 11
Configuration Authentication in Proficy iFIX Service Provider 11
© 2016 General Electric Company. All rights reserved. i

To connect through Windows Authentication mode: 11
To connect through Certificate Authentication mode: 12
Configuring Call Methods 12
Accessing a Call Method from a Workflow Subprocess 13
To access a Call Method from a Workflow Subprocess: 13
Accessing a Server Method from Global Displays 13
To access a Server Method from Global Displays: 13
Accessing a Server Method from Forms 14
To access a Server Method from Forms: 14
Configuring ReadTagFieldValue Method 14
To configure a ReadTagFieldValue Method: 14
Method Information 15
Prototype 15
Returns 16
Configuring ReadGroupTagFieldValues 16
To configure a ReadGroupTagFieldValues method: 16
Prototype 17
Returns 18
Limitation 18
Configuring WriteTagFieldValue Method 18
To configure a WriteTagFieldValue method: 19
Prototype: 19
Returns 20
Configuring WriteGroupTagFieldValue Method 20
To configure a WriteGroupTagFieldValue method: 20
Prototype 21
Returns 22
Limitation 22
ii © 2016 General Electric Company. All rights reserved.

Configuring GetActiveAlarms 22
To configure a GetActiveAlarms method: 23
Returns 25
Limitation 26
Workflow: Binding Tags 27
Workflow: Binding Equipment Property to a Tag 27
To bind equipment property to a tag: 27
Workflow: Configuring Data Items through Displays 27
To configure Data Items through Workflow displays: 27
Workflow: Configuring Data Items through Forms 27
To configure Data Items through Forms: 28
Index 29
© 2016 General Electric Company. All rights reserved. iii

© 2016 General Electric Company. All rights reserved. 1
Using the iFIX -SOA Service Provider
The Proficy iFIX - SOA Service Provider allows you to access iFIX tags and get active alarms in Proficy Work-
flow. Proficy Workflow clients can read and write iFIX tags and fields, and get active alarms by connecting
the Proficy Workflow Server to Proficy iFIX.
The Proficy iFIX - SOA Service Provider consists of the Proficy iFIX Data Provider and the Proficy iFIX Ser-
vice Provider components. The Proficy iFIX Data Provider provides services to publish iFIX tags to the
Proficy Workflow server. The Proficy iFIX Service Provider provides services to connect Workflow to the
iFIX node and allows you to read and write iFIX tags and fields and get active alarms.
Proficy iFIX - SOA Service Provider call methods allows you to access iFIX SCADA nodes data. Proficy iFIX -
SOA Service Provider call methods can be configured in the following Workflow items:
l Subprocesses
l Forms
l Displays
Additionally, you can also configure iFIX tags by binding a
l Equipment property
l Forms data items
l Workflow data items
Supported Node configurations:

1. An iFIX SCADA server communicating with a local or remote Proficy Workflow server.
2. An iFIX SCADA server communicating with a Proficy Workflow User server.
3. Multiple iFIX SCADA server communicating with a Proficy Workflow server.
4. An iFIX SCADA server communicating with multiple Proficy Workflow servers.
Limitations:
When using the Proficy iFIX -- SOA Service Provider:
1. iFIX tags can be linked to Proficy Workflow Equipment model properties, however, subscription is
not supported. This means iFIX Tag Field values are not updated continuously and Equipment Model
Properties (linked to iFIX Tags) cannot trigger Events or Schedules in the Workflow. To read updated
value or write to iFIX tags, you should call the Equipment Model call methods or iFIX Call methods.
2. Electronics Signature is not supported by iFIX Service provider. A workflow user cannot write or
acknowledge alarms for an iFIX tag that has electronic signatures enabled in the iFIX database. If
for a tag, 'Perform' or 'Perform & verify' is checked then you cannot write or acknowledge an alarm
for that tag. If you want to allow unsigned writes, then select the Accept for 'Unsigned Writes'
option available in the Tag Advanced tab in the iFIX Block Window.
3. You cannot use iFIX SCADA Enhanced Failover when using the Proficy iFIX - SOA Service Provider.
2 © 2016 General Electric Company. All rights reserved.

Getting Started
Installing iFIX -
The iFIX - SOA Service Provider consists of Proficy iFIX Data Provider and Proficy iFIX Service Provider com-
ponents.
The iFIX - SOA Service Provider must be installed in the following way:
l Proficy iFIX Data Provider on a Proficy iFIX SCADA node

l Proficy iFIX Service Provider on a Proficy Workflow Server node
For information on installation, refer to the Installing Proficy and Installing Proficy sections.
Prerequisites
The iFIX - SOA Service Provider consists of following components:
l Proficy iFIX Data Provider Service: must be installed on a Proficy iFIX SCADA node.
l Proficy iFIX Service Provider: must be installed on a Proficy Workflow Server node.
Prerequisites to Install the Proficy
The following list describes the software required to install Proficy iFIX Data Provider Service
l Proficy iFIX version 5.8

For information on installation, refer to the Installing Proficy section.
Prerequisites to Install the Proficy
The following list describes the software required to install Proficy
l Proficy Workflow 2.0 SIM4 or above

Refer to the following link for more information on the installation of the Workflow 2.0 SIM4:
http://support.ge-ip.com/support/index?page=dwchannel&id=S:DN3909&actp=search
For general information on installation, refer to the Installing Proficy section.
Watch the following video to learn how to install and configure the iFIX - SOA Service Provider.
Installing the Proficy
You must install the Proficy iFIX Data Provider on a Proficy iFIX SCADA node.
These instructions assume that you have installed required prerequisites prior to installing the Proficy

To install the Proficy iFIX Data Provider
1. At the computer you select as the iFIX server, insert the Proficy iFIX DVD. The install splash screen
appears.
NOTE: If this screen does not automatically appear, double-click the InstallFrontEnd.exe file on the DVD to
display it.
2. A message may appear with a security warning; click Run to proceed.

3. Select 'Install Proficy iFIX Data Provider' option.
4. Click Finish to complete the installation.
NOTE: Enable and start the Net.Tcp Port Sharing service. If this service is not started, then the Data Provider will
not start.
Installing the Proficy
You must install Proficy iFIX Service Provider on a Proficy Workflow Server node.
These instructions assume that you have installed required prerequisites prior to installing the Proficy
To install the Proficy
1. At the computer you select as the Proficy Workflow Server, insert the Proficy iFIX DVD. The install
splash screen appears.
NOTE: If this screen does not automatically appear, double-click the InstallFrontEnd.exe file on the DVD to
display it.
2. A message may appear with a security warning; click Run to proceed.

3. Select 'Install Proficy iFIX ServiceProvider' option.
4. Click Finish to complete the installation.
To confirm that the installation has been done properly, verify the Proficy Workflow Configure
Product Option and Configure Site windows.
Data Provider Log Details
The Data Provider Log records communications with the iFIX Data Provider into a DPTrace.txt file.
Advanced users can use this log file to trace a history of communication events dealt with by the iFIX Data
Provider.
The data provider log file, DPTrace.txt, is a simple text file and that is placed in Proficy iFIX install folder. By
default, this folder is C:\Program Files\Proficy\Proficy iFIX\Local\.
The information logged depends on the level value set in config file name iFIXDataProviderService.exe.
The configuration details of the data provider can be updated through the iFIXDataProviderService.exe's
config file. The following is the Log4Net configuration content of the iFIXDataProviderService.exe config
file:
<log4net>
<appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
<file value=".\LOCAL\DPSTRACE.LOG"/>
<appendToFile value="true"/>

<rollingStyle value="Size"/>
<maxSizeRollBackups value="5"/>
<maximumFileSize value="10MB"/>
<staticLogFileName value="true"/>
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %level %logger - %message%newline"/>
</layout>
</appender>
<root>
<level value="INFO"/>
<appender-ref ref="RollingFileAppender"/>
</root>
</log4net>
You can customize the configure options by changing the following values:
Value Description
<file value/> Represents the file and directory. Currently, the log will be named
in DPSTRACE.LOG and located in iFIX Local directory.
<level value/> Represents the level of logging. By default, the log level is set to
INFO level.
The following logging levels are provided:
1. DEBUG: Provides full details in the log file
2. INFO:
3. ERROR
4. FATAL
<conversionPattern/> Represents the format of the log.

Configuring Connections
You need to do certain configurations on both Proficy
The following configurations are required:
l Configurations on iFIX SCADA Node

l Configuring Connection - Proficy
Configurations on the iFIX SCADA Node
To configure an iFIX Data Provider on an iFIX SCADA node, you have to configure the Data Provider tasks
to start automatically with iFIX startup . To be able to do so, you have to add the following files to the iFIX
SCU task list.
l iFIXDataProviderService.exe
l AlmUserQ4DPS.exe with command line parameter as /NDPSQUE/S100
The command line para- Lets you…

meter…
/N Define a name for the alarm queue. Alarm queue name must
be specified as DPSQUE.
NOTE: You cannot change the Alarm queue name. You must
use DPSQUE as Alarm queue name to make alarm user
queue.
/S Define the number of entries (alarms and messages) that the

queue can hold. By default, the queue holds up to 100 alarms
and messages; however, you can configure the queue to hold
from 100 to 99999 alarms and messages.
The following information guides you to add tasks to iFIX SCU.
To add tasks to the iFIX SCU:
1. Start iFIX. In the

2. In the SCU, select Configure tab, and click Tasks. The Task Configuration dialog box appears.
3. In the Filename field, click the Browse (...) button.
4. Select the AlmUserQ4DPS.exe and iFIXDataProviderService.exe files from
NOTE: Add AlmUserQ4DPS.exe task first and then add the iFIXDataProviderService.exe.
5. For the AlmUserQ4DPS.exe file, in the Command line field, enter the command line parameter as
/NDPSQUE /S1000.

6. Select the mode in which you want the task to run. The following options are available:
l Minimized - Starts the task as a minimized window.
l Normal - Starts the task as an open window.
l Background - Starts the task in the background.
7. Click Add to add the task to the list of Configured Tasks. You can use the upward and downward
arrows to move the position of your task.
8. Click OK. The files are added to the SCU task list.
9. Start iFIX. As iFIX starts the AlmUserQ4DPS.exe and iFIXDataProviderService.exe programs are
also started.
An iFIX user with Data Provider privileges should be created to be able to access the connection. For
information, refer to theCreating asection.
Creating a Proficy
To use the iFIX Data Provider Service, you must create user with sufficient privileges.
The following information guides you through creating an iFIX user with Data Provider Service privileges.
NOTE: You must create an iFIX Local user account to connect from Proficy Workflow to iFIX. You cannot connect
from Proficy Workflow to iFIX using a iFIX Window's user account.
To create a Proficy
1. Start iFIX. In the

2. Select Edit, click User Accounts, and then click Add. The User Profile dialog box appears.
3. Under Application Features, click Modify. The Application Feature Selection dialog box appears with
a list of available features.
4. Select the features you want to grant to the user and click Add. You must add the "Data Provider
Service" option. If you want to grant all the features, click Add All. The features are listed under the
Authorized list.
5. Click OK. The User Profile dialog box appears.
6. Enter the new account details in the following fields:
l Full Name: Name of the account.
l Login Name: Login Name.
l Password: Password.
7. Click OK. A Password Confirmation message box appears. Retype the password and click OK. A
new account is created and appears in the list of current users.
Enabling iFIX Security

The following information guides you through enabling security on the user account.

To enable security for the new user account:
1. Open the Security Configuration Utility.

2. Click Edit, and then Configuration. A configuration dialog box appears.
3. Next to the User Based Security option, select the Enabled option.
4. Click OK. Security is enabled for the user account. A lock symbol appears on the Security Con-
figuration screen indicating the same.
Configuring Connections - Proficy iFIX and Workflow
The following information guides you through the Proficy iFIX and Workflow configuration process. You can
add a new connection and access an existing list of connections.
To add and configure the connection between Proficy iFIX and Workflow
1. Start the Proficy Workflow Client and login to the application.

2. Select the Navigate tab on the top of the screen and select Proficy System from the list of models.
3. Click Proficy System. A list of Folders appears.
4. Select Proficy
5. Click Add Connection. In the form that appears, enter the details in the following fields:
l iFIXConnection Name: Any name that you want to provide to identify the connection.
l Proficy iFIX Server Name / IP: Computer Name of the
l Description: Provide description for the connection.
l iFIXUser Credentials: iFIX user name and password. Proficy iFIX User must have a Data Provider
Privileges. For more information, refer to Creating a Proficy iFIX User topic.
6. A new connection is created and appears under the list of available connections. You can access
the existing connections from the list of connections.
To view iFIX connection details
1. Select the Navigate tab on the Workflow Client and select Proficy System from the list of models.
2. Click Proficy System. A list of folders appears.
3. Select Proficy iFIX and then click iFIX Connections.
4. Select a Proficy iFIX Connection from the list.
5. In the Displays window, click on the iFIX Service Data Source.
The Proficy iFIX Connection Configuration details appears as shown in the following figure:

6. Click Refresh.
The Proficy iFIX Server connection status information is updated.
7. In the Health Monitor Frequency field, enter how often, in milliseconds, the Proficy iFIX SCADA
server health status needs to be monitored.
8. Click Advanced Configuration if you want to configure the authentication between Proficy iFIX Data
Provider and Proficy iFIX Service Provider using Windows authentication or Certificate authen-
tication. For more information, refer to Configuring authentication in Proficy iFIX Service Provider
section.
iFIX-SOA Service Provider Security
The iFIX - SOA Service Provider provides authentication and secure data communications between Proficy
iFIX Data Provider and Proficy iFIX Service Provider using Windows authentication and Certificate authen-
tication.
Windows Authentication:-
Windows Authentication is the default authentication mode. Use Windows authentication when you want
clients to authenticate using the NTLM or Kerberos protocols. Windows Authentication enables Proficy
Workflow clients to access iFIX tags and get alarms from Proficy iFIX using their Windows credentials; user
identity is confirmed by Microsoft Windows.
Windows Authentication requires the Proficy iFIX Data Provider performing the authentication and the
Proficy Service Provider being authenticated to be part of the same domain. This authentication option is
generally intended for the users who have Active Directory Domain.
Certificate Authentication:-

Certificate Authentication mode enables using Secure Sockets Layer (SSL) cryptographic protocols and the
X.509 standards. Security is implemented through a typical public key infrastructure (PKI) scheme and
employs a web of trust that can use self-signed certificates or certificates endorsed by a Certificate
Authority (CA).
Security certificates are used to protect your identifiable information and to protect your computers from
unsafe software. A certificate is a statement verifying the identity of a person or the security of a web site.
You are required to install security certificates on all Proficy iFIX Data Provider and Proficy iFIX Service Pro-
vider machines.
NOTE: You must make sure similar authentication mode is used on both Proficy iFIX Data Provider and Proficy iFIX
Service Provider.
For more information, refer to the Configuration Authentication section.
Configuring Authentication
At any time after installation, you can change the authentication mode used in the iFIX – SOA Service Pro-
vider. You must make sure similar authentication mode is used on both Proficy iFIX Data Provider and
Proficy iFIX Service Provider.
You must configure the authentication using the following procedures:
l Configuration Authentication in Proficy the iFIX Data Provider
l Configuration Authentication in Proficy the iFIX Service Provider

NOTE: On a workgroup you cannot establish connection If you are running Proficy Workflow server on a Windows
64 bit system and Proficy iFIX on a Windows XP system.
Configuring Authentication in Proficy iFIX Data Provider
You can configure authentication in the Proficy iFIX Data Provider using either Microsoft Windows authen-
tication or Certificate authentication modes.
IMPORTANT: You must make sure the same authentication mode is used on both the Proficy iFIX Data Provider
and the Proficy iFIX Service Provider.
NOTES:
1. If Micorsoft Windows authentication is enabled, then you can connect from Proficy Workflow Core Server
or User Server with Service Provider to iFIX with Data Provider Service installed only when you have a
known Windows user account.
2. To have a known user account with iFIX Data Provider Computer, the user account should first exist on
that computer as a local account or exist on a Domain Controller.
3. With Windows Authentication, if the Proficy Workflow server is not in the domain, then the Proficy Work-
flow Server must be started with the Local System Account instead of System service alone, then only you
connect to the Data Provider Service machine.
4. With Windows Authentication , in workgroups you cannot establish connection if you are running Proficy
Workflow server on a Windows 64 bit system and Proficy iFIX on a Windows XP system.

To connect through Windows Authentication mode:
1. On the Proficy iFIX Data Provider computer, click Start > All Programs > Proficy HMI SCADA - iFIX
5.8 > iFIX Data Provider > iFIX DPS Configuration.
The iFIX DPS Configuration dialog box appears.
2. Optionally, under Service Configuration, enter the port number required to allow communication
with the server.
3. Under Security Mode, select the Windows Authentication option.
4. Click Save.
To connect through Certificate Authentication mode:

IMPORTANT: Before using the Certificate authentication mode, you must import a certificate into a respective
logical store using the Microsoft Windows Certificate Import Wizard. For more information on importing or
installing certificates, refer to the Microsoft Management Console online Help.
1. On the Proficy iFIX Data Provider computer, click Start > All Programs > Proficy HMI SCADA - iFIX
5.8 > iFIX Data Provider > iFIX DPS Configuration.
The iFIX DPS Configuration page appears.
2. Optionally, under Service Configuration, enter the port number required to allow communication
with the server.
3. Under the Security Mode, select the Certificate Authentication option.
3. Under the Certificate Configuration, from the Store Location drop-down list, select the store loc-
ation .
4. Under the Certificate Configuration, from the Store Name drop-down list, select the store name .
5. Under the Certificate Configuration, from the Certificate Name drop-down list, select the certificate
name.
6. Click Save.
Configuration Authentication in Proficy iFIX Service Provider
You can configure authentication in the Proficy iFIX Service Provider using either Microsoft Windows
authentication or Certificate authentication modes.
IMPORTANT: You must make sure that the same authentication mode is used on both the Proficy iFIX Data Pro-
vider and the Proficy iFIX Service Provider.
NOTE: If the Proficy Workflow server is not in the domain, then the Proficy Workflow Server must be started with
the Local System Account instead of System service alone, then only you connect to the Data Provider Service
machine.
To connect through Windows Authentication mode:
1. On the Proficy iFIX Service Provider computer, start the Proficy Workflow Client and login to the
application.

The Proficy iFIX Connection Configuration details screen appears
7. Click on Advanced Configuration.
8. Optionally, in the Port Number field, enter the port number required to allow communication with
the server.
9. Under Authentication, select the Windows authentication option.
10. Click Save.
To connect through Certificate Authentication mode:

IMPORTANT: Before using the Certificate authentication mode, you must import a certificate into a respective
logical store using the Microsoft Windows Certificate Import Wizard. For more information on importing or
installing certificates, refer to the Microsoft Management Console online Help.
1. On the Proficy iFIX Service Provider computer, start the Proficy Workflow Client and login to the
application.
The Proficy iFIX Connection Configuration details screen appears.
7. Click on Advanced Configuration.
8. Optionally, in the Port Number field, enter the port number required to allow communication with
the server.
9. Under Authentication, select the Certificate Based authentication option.
10. Select the certificate store location from the Store Location drop-down list.
11. Select the certificate name from the Store Name drop-down list and click ellipsis button.
The Windows Security Browser appears.
12. Select the certificate from the list, and then click OK.
13. Click Save.
Configuring Call Methods
You can configure Proficy iFIX - SOA Service provider call methods using the following ways:
l Workflow subprocess using call methods

l Global Displays using server methods
l Forms using server methods

The following call methods are available:
l iFIX Methods: Configuring a ReadTagFieldValue
l iFIX Methods: Configuring Read Group Tag Field Values
l iFIX Methods: Configuring Write Tag Field Value
l iFIX Methods: Configuring Write GroupTag Field Value
l iFIX Methods: Get Active Alarms
Accessing a Call Method from a Workflow Subprocess

Do the following to access a call method from a Workflow Subprocess.
To access a Call Method from a Workflow Subprocess:

1. In the navigator, click Workflow.
2. In the Folders list, select the workflow that you want to work with.
3. In the Displays panel, select the Workflow editor.
4. In the Workflow editor, add a local Subprocess.
5. Double-click the Subprocess and add a Call Method from Standard Activities.
6. Click Configure Method.
7. In the Configure Method dialog box, select IProficyiFIXService and then select the method that you
want to configure and click Next.
8. An Item specific configuration dialog box appears. The fields to configure the method depend on
the method selected.
NOTE: In workflow forms when you configure the ReadGroupTagFieldValues and WriteGroupTagFieldValue meth-
ods, then the selected fields in the configuration panel will not be displayed. You can pass the input field values
through parameters.
Accessing a Server Method from Global Displays

Do the following to access a server method from Global Displays.
To access a Server Method from Global Displays:

1. In the navigator, click Global Displays.
2. In the Folders list, select the Display you want to work with.
3. In the Displays panel, select the Display Editor.
4. In the Display Editor, click the Designer tab, and then click Server Methods.
5. Click Add. A new method is added.
6. Click Properties and in the Source field, click the Browse button. In the Configure Method dialog
box, select IProficyiFIXService and then select the method that you want to configure and clickNext.

Accessing a Server Method from Forms
Do the following to access a server method from Forms.
To access a Server Method from Forms:

1. In the navigator, click Global Displays.
2. In the Folders list, select Forms and the form you want to work with.
3. In the Displays panel, select the Display Editor.
4. In the Display Editor, click the Designer tab, and then click Server Methods.
5. Click Add. A new method is added.
6. Click Properties and in the Source field, click the Browse button.
7. In the Configure Method dialog, box select IProficyiFIXService and then select the method that you
want to configure and clickNext.
Configuring ReadTagFieldValue Method
The ReadTagFieldValue method reads the process value of a tag’s field. You can configure a
ReadTagFieldValue method through a Workflow subprocess, display, or form. For more information, refer
to Workflow: Configuring Call Methods section.
To configure a ReadTagFieldValue method, perform the following tasks.
To configure a ReadTagFieldValue Method:
1. In the Configure Method dialog box, open Workflow subprocess or form or display and select the
ReadTagFieldValue call method.
2. In the Item specific configuration window, click Select and navigate through the iFIX connections.
Select your connection and then click OK. A dialog box similar to the following appears.

3. In the Tag Names field, the list of tags appear. Select a tag and the corresponding field names
appear in the Field Names option. In the Configured Tag and Field area, the combination you selec-
ted appears.
4. Click Finish. The Read Tag Field Value method is configured.
Method Information
Prototype
iFIXProcessValue ReadTagFieldValue(DirectoryResource ConnectionObj, string strTagName
The following table lists the parts of the ReadTagFieldValue method.
Parameter Display Parameter Type Direction Description

Name Name
Connectionobj Connection DirectoryResource Input The iFIX Con-

nection.
strTagName Tag Name String Input Name of the

tag that will be
read.

strField Field Name String Input Name of the
tag field that
will be read.
Returns
The function returns an array of iFIXProcessValue.
The iFIXProcessValue output has the following fields.
Output Field DataType
ErrorCodeField Int16
FieldNameField String
ObjectValue Object
Quality PlatformQuality
SysType SysInterfaceType
TagNameField String
TimeStamp DataTime
Configuring ReadGroupTagFieldValues
The ReadGroupTagFieldValues method reads the process field values of a group of tags. You can configure
a ReadGroupTagField Values method through a Workflow subprocess, displays or form. For more inform-
ation, refer to the Workflow: Configuring Call Methods section.
To configure a ReadGroupTagFieldValues call method, perform the following tasks.
To configure a ReadGroupTagFieldValues method:
ReadGroupTagFieldValues call method. A dialog box similar to the following appears.

2. In the Item specific configuration area, click Select and navigate through the iFIX connections.
Select your connection and then click OK.
3. In the Tag Names field, the list of tags appear. Select the tag and from the list of tag names, and
select the field. Your selection appears in the Configured Tags and Fields area.
4. In the Data returned section, select Return all data option and the click Finish. The
ReadGroupTagFieldValues method is configured.
Method Information
Prototype
iFIXProcessValue[] ReadGroupTagFieldValues(DirectoryResource ConnectionObj, string[]
The following table lists the parts of the ReadGroupTagFieldValues method.
Parameter Display Name Parameter Direction Description

Name Type
Connection Connection Directory Input The iFIX con-

Object Resource nection
strTagNames Tags list String Array Input Name of the

group of tags that
will be read.
strFields Fields list String Array Input Name of the

fields of the
group of tags that
will be read.
Returns
The function returns an array of iFIXProcessValue.
The iFIXProcessValue output has the following Fields.
ObjectValue Object
Quality PlatformQuality
SysType SysInterfaceType
TagNameField String
TimeStamp DataTime
Limitation
You can read a maximum of 100 tags in one call.
Configuring WriteTagFieldValue Method
The WriteTagFieldValue method updates the attribute values of an iFIX tag. You can configure a
WriteTagFieldValue method through a Workflow subprocess, display, or form. For more information, refer
to theWorkflow: Configuring Call Methodssection.
NOTE: You cannot write to a tag when a tag name and field is in lower case
To configure a WriteTagFieldValue call method, perform the following tasks:

To configure a WriteTagFieldValue method:
WriteTagFieldValue call method.
3. In the Tag Names field, select a tag. The corresponding list of field names appears in the Field
Names area.
4. Select the field name. The tags and field names appear in the Configured Tags and Fields area.
5. In the Value field, enter the attribute value of the field for the selected tag and fields and click Fin-
ish. The WriteTagFieldValue method is configured.
Method Information
Prototype:
iFIXWriteResult WriteTagFieldValue(DirectoryResource ConnectionObj, string strTagName
The following table lists the parts of the WriteTagFieldValue method.
Parameter Display Parameter Type Direction Description

Name Name
ConnectionObjj Connection DirectoryResource Input The iFIX Con-

nection.
strTagName Tag Name String Input Name of the

tag for which
the field value
will be updated.
strField Field Name String Input Field for which

the value will
be updated.
ObjVal Value Value Input Value of tag

field that will
be written.
Returns
The return value is iFIXWriteResult, the details of a tag's field that has been updated.
The iFIXWriteResult output has the following fields:
TagNameField String
Configuring WriteGroupTagFieldValue Method
The WriteGroupTagFieldValue method updates the field values of group of tags. You can configure a
WriteGroupTagFieldValue method through a Workflow subprocess, displays, or forms. For more inform-
ation, refer to the Workflow: Configuring Call Methods section.
To configure a WriteGroupTagFieldValue call method, perform the following tasks:
To configure a WriteGroupTagFieldValue method:
WriteGroupTagFieldValues call method.

3. In the Tag Names field, select a tag. The list of field names appears in the Field Names window.
4. Select the field name and click Add. The tags and field names appear in the Configured Tags and
Fields window.
5. In the Enter Value field, enter the value of the field for the selected tag and fields and click Finish.
The WriteGroupTagFieldValue method is configured.
Method Information
Prototype
iFIXWriteResult WriteTagFieldValue(DirectoryResource ConnectionObj,
string strTagName, string strField, System.Object ObjVal)public iFIXWriteResult[]
WriteGroupTagFieldValues(DirectoryResource ConnectionObj,
string[] strTagNames, string[] strFields, Object[] objVals)
The following table lists the parts of the WriteGroupTagFieldValues method.

Parameter Name Parameter Type Direction Description
ConnectionObj DirectoryResource Input The iFIX connection.
strTagNames String Array Input Group of tags that will

be updated.
strFields String Array Input Tag field values that

will be updated.
objVals Object Array Input Field values of a set

of tags that will be
written.
Returns
The return value is an array of iFIXWriteResult, the field values of a group of tags that have been updated
along with their corresponding error codes.
The iFIXWriteResult output is an array of the following Fields:
TagNameField String
The number of rows will be same as the number of inputs.
Limitation
The maximum number of tags that can be written in one call are 50.
Configuring GetActiveAlarms
The GetActiveAlarms method returns the collection of active alarms based on the filter condition provided.
You can configure the GetActiveAlarms method through a Workflow subprocess, display, or form. For
more information, refer to the Workflow: Configuring Call Methods section.
NOTES:
l GetActiveAlarms method displays only the list of alarms available after the AlarmUserQ4DOS.exe and the
iFIXDataProviderService.exe is started on the iFIXSystem. That is you cannot see the alarms that existed
before starting AlarmUserQ4DOS.exe and iFIXDataProviderService.exe.
l If the tag remains in the same Alarm Status, then GetActiveAlarms method does not show the updated
tag value.
To configure a GetActiveAlarms call method, perform the following tasks.

To configure a GetActiveAlarms method:
GetActiveAlarms call method.
3. In the Alarm Areas section, the list of alarm areas appears.

4. Select the alarm Areas for the Filter Condition if required.
5. Select the status of the alarms, Acknowledged or Unacknowledged, for the Filter condition, if
required.
6. Select the Priority Condition for filtering if required.
7. Enter the appropriate value for the Page Size
8. Select either ASC/DESC for the Order By field. This selection will lead to retrieval of records in
either Ascending or Descending order of Time Last value of Alarm Records.
9. Select either NEXT/PREV for Direction. This selection will lead to iteration of pages either in forward
or backward direction.
10. In the Data returned section, choose the way in which the data has to be returned. You can retrieve
all the data or a specific item or property.
11. Click Finish. The GetActiveAlarms method is configured.

Method Information
The following table lists the parts of the GetFilteredActiveAlarms method.
Parameter Name Display Name Parameter Direction Description

Type
ConnectionObj Connection String Input The iFIX Con-

nection.
Filter Filter String Input The filter con-

dition selected
from the con-
figuration Panel.
ContinuationKey ContinuationKey Byte Array Input The encrypted

continuation key
returned from
the last call. The
value is passed
as a null value
for the first time
ORDER Order By Enum Input The order is the

Ascending or
Descending
order of
TimeLast values
of the Alarms.
The Value can be
either ASC or
DESC.
Direction Direction Enum Input The direction in

which the pages
are to be iter-
ated. Value can
be either NEXT
or PREV.
PageSize PageSize Int Input The size of the

page (that is, the
number of
Alarms
returned). The
maximum value
that can be
given to this

parameter is
100. If a value is
greater than
100, then only
top 100 results
will be returned.
Returns
The return value is iFIXAlarmSummary, a container of an array of active alarms for that Page that meet the
filter criterion, actual received count, remaining count, and a continuation key which is the encrypted
value.
iFIXAlarmSummary has following fields:
Parameter Name Display Name
AlarmsRecordSet iFIXAlarmRecord
ContinuationKey Byte
ReceivedCount Int32
RemainingCount Int32
Array of iFIXAlarmRecord has following fields:
Parameter Name Display Name
Ack Boolean
AlarmID String
Areas String
Description String
DtAlmTimeIn DataTime
DtAlmTimeLast DateTime
NodeName String
Priority String
Status String
Value String

Limitation
You can read a maximum of 100 alarm records in one call.

Workflow: Binding Tags
Workflow: Binding Equipment Property to a Tag
To bind equipment to a tag, perform the following steps:
To bind equipment property to a tag:
1. Start Proficy Workflow Client and login.

2. Select the Navigate tab on the top of the screen and select Equipment from the list of models. A list
of folders appears.
3. Select Instances and then Enterprise.
4. Click S95 Model Editor under Displays and click Properties tab.
5. Click Add Property. A grid displays to enter information about the property.
6. Enter the name of the property and select the Linked option. The Linked otpion binds the property to
an external data source. This enables Workflow to find the data items published by iFIX.
7. Click <No Value> in the Value column. A browse button displays in the cell.
8. Click the browse button, the Configure Data Source dialog box appears. Follow the procedure to
add a data item with selected attributes, to the property.
9. Select the tag name and the field name and click Finish. The equipment is now bound to a tag.
10. Click the Property button to the right of the S95 Model Editor toolbar to view the properties.
Workflow: Configuring Data Items through Displays
To configure data items through Workflow displays, perform the following steps.
To configure Data Items through Workflow displays:
1. In the Navigator, click Global Displays.

2. In the list of Folders, click Displays and select the display that you want to work with.
3. In the Displays, click Display Editor and then select the Designer tab.
4. Select Data Items and click Add. A new data item is added.
In the Properties tab, the information in the Description and Display Name fields identify the data
items in the Data Items list.
5. Click the browse button next to the Source field. In the Data Source dialog box, select a data item
and click Next.
6. In the Item Specific Configuration dialog box, select the tag and the field names and click Finish.
The data item has been configured.
Workflow: Configuring Data Items through Forms

To configure a data item to a SCADA tag, perform the following steps:
To configure Data Items through Forms:
1. In the Navigator, click Global Displays.

2. In the list of Folders, click Forms and select the form that you want to work with.
3. In the Displays, click Display Editor and then select the Designer tab.
4. Select Data Items and click Add. A new data item is added.
In the Properties tab, the information in the Description and Display Name fields identify the data
items in the Data Items list.
5. Click the browse button next to the Source field. In the Data Source dialog box, select a data item
and click Next.
6. In the Item Specific Configuration dialog box, select the tag and the field names and click Finish. The
data item has been configured.

Index Configured Tasks 7
Configuring 27
Data Items 27
A
Data Provider 6
Acknowledge Alarm 3
iFIX Data Provider 6
Add Connection 8
ReadGroupTagFieldValues 16
AlmUserQ4DPS 6
ReadTagFieldValue 14
Areas 23
ReadTagFieldValue Method 14
Filter Condition 22
WriteGroupTagFieldValue 20
Array 18, 22, 24
WriteGroupTagFieldValue Method 20
iFIXAlarmRecord 25
WriteTagFieldValue 18
iFIXWriteResult 21
WriteTagFieldValue Method 18
String 17, 21
Connection Object 17
Authorized list 7
Continuation Key 24
ConversionPattern 5
B
Background - Starts 6 D
Binding 2
Data Items 27
Equipment Property 27
Configuring 27
SCADA 2
Data Items list 27-28
Data Provider 6
C
configure 6
Call Method from Standard Activities 13
Data Provider Log Details 4
add 13
Data Provider Privileges 7
Call Methods
Data Provider Service 7
Accessing 13
Data Source dialog 27-28
Certificate authentication 9
Direction 23
Config Panel 22
PREV 23
Configuration 8
Directory Resource 17
Configure Data Source dialog 27
DirectoryResource ConnectionObj 15, 17, 19, 21
Configure Method 13
Display Name 15, 17, 19, 24, 27-28
Configure Site 4
Displays window 8
Configured Tags 14, 17, 19, 21

DPSQUE 6 IFIX Scada Node 2, 6
DPSTRACE 4 IFIX SCU 6
DPSTRACE.LOG 4 IFIX Security 7
DPTrace 4 Enabling 7
IFIX Server 4
E
IFIX Service Data Source 8
Electronic Signatures 2
IFIX Tag Values 1
Equipment 27
IFIX Tags 2-3
Equipment Property 27
IFIX User Credentials 8
F IFIXAlarmRecord 25
Array 24
FATAL 5
IFIXAlarmSummary 25
Filter Condition 22
IFIXDataProviderService 4, 6
Areas 23
Log4Net configuration content 4
Finish 4, 15, 17, 19, 21, 23, 27-28
IFIXDataProviderService.exe 6
Folders 8, 27-28
iFIXDataProviderService.exe Config file 4
Forms 12, 27
IFIXProcessValue 17
Full Name 7
IFIXProcessValue ReadTagFieldValue 15
G IFIXWriteResult 19, 21
GetActiveAlarms 22 array 22
Global Displays 12, 27-28 IFIXWriteResult WriteTagFieldValue 19, 21
IProficyiFIXService 13
I
IFIX Connections 8 L
IFIX Data 4 Log4net 4
IFIX Data Provider 6-7
M
configure 6
Message%newline 5
use 7
Method Information 15, 17, 19, 21, 24
IFIX Local User 7
Minimized - Starts 6
create 7
Modify 7
IFIX SCADA 2
Multiple iFIX Scada Nodes 1
IFIX Scada failover 1

N Proficy iFIX Data Provider 3
Navigator 27-28 using 5
NDPSQUE 6 Proficy iFIX Connection Configuration 8
Proficy iFIX Connections 8

O
Select 8
Object 21
Proficy iFIX Data 3
Object Array 22
Proficy iFIX Data Provider 3
Object ObjVal 19, 21
Proficy iFIX 3
ObjVal 19
Proficy iFIX Data Provider exe file 3
ObjVals 21
Proficy iFIX Scada 3
Open 7
Proficy iFIX Server Name 8
ORDER 23
Proficy iFIX Service 3-4
Order By 23
Proficy iFIX Service Pack 3
DESC 23
Proficy iFIX Service Provider 3-4
Proficy Workflow 3
P
Proficy iFIX User 7
Page 23
Creating 7
Page Size 23
Proficy iFIX WorkSpace 6-7
PageSize 24
Proficy System 8
Parameter Name 15, 17, 19, 22, 24
Proficy Workflow 2-3, 5, 7-8
Parameter Type 15, 17, 19, 22, 24
Alarms 3
Password - Password 7
following 2
Password Confirmation dialog 7
iFIX 7
PatternLayout 5
Proficy iFIX Service Provider 3
PREV 23
Proficy Workflow 2.0 Server 3
Direction 23
Proficy Workflow 2.0 SIM4 3
Priority Condition 23
Proficy Workflow Server 2-4
Select 23
Proficy Workflow User 2
Proficy 4
Proficy iFIX 2-6, 8, 12 R

connecting 1
Read Group Tag Field 16
Read Group Tag Field Values 16

Read Tag Field 15 Priority Condition 23
Read Tag Field Value 15 Proficy iFIX Connection 8
Read Tag Field Value Method 15 ReadGroupTagFieldValues 16
ReadGroupTagFieldValues 16 ReadTagFieldValue 14
Select 16 WriteGroupTagFieldValues 20
ReadTagFieldValue 14 WriteTagFieldValue 18
configure 14 Select Data Items 27-28
Select 14 Select Edit 7
ReadTagFieldValue Method 14 Select Enabled 7
Return 17 Select Instances 27
RollingFileAppender 4 Select Proficy iFIX 8
RollingStyle 5 Server Methods 12
Accessing 13
S
SOA Service 12
S100 6
SOA Service Provider 2-3
AlmUserQ4DPS 6
SOA Service Provider Call Methods 2
S95 Model Editor 27
Source 13, 27-28
S95 Model Editor toolbar 27
Start iFIX 6-7
SCADA 2, 28
Start Proficy Workflow 8, 27
binding 2
StaticLogFileName 5
SCU 6
Subprocess 12
added 7
Supported Node 2
Security 6-7
Security Configuration 8 U
Security Configuration Utility 8 User Based Security 8
See Also 3 User Profile dialog 7
Select 6, 8, 13-14, 16, 19-20, 23, 27-28

W
AlmUserQ4DPS 6
Windows authentication 9
Designer 27-28
Workflow Subprocess 12
Display 27
Write Group Tag Field Values 20
Display Editor 13
WriteGroupTagFieldValue Method 20
Navigate 8, 27

WriteGroupTagFieldValues 20
Select 20
WriteTagFieldValue 18
configure 18
Select 19
WriteTagFieldValue Method 18

Using The IFIX - SOA Service Provider

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Using The IFIX - SOA Service Provider

Uploaded by

Copyright:

Available Formats

GE iFIX

Using the iFIX-SOA Service Provider

Version 5.8, SP2

© 2016, General Electric Company. All rights reserved.

* Indicates a trademark of General Electric Company and/or its subsidiaries.

Using the iFIX -SOA Service Provider 2

Supported Node configurations: 2

Prerequisites to Install the Proficy 3

Prerequisites to Install the Proficy 3

Installing the Proficy 3

To install the Proficy iFIX Data Provider 4

Installing the Proficy 4

To install the Proficy 4

Data Provider Log Details 4

Configurations on the iFIX SCADA Node 6

To add tasks to the iFIX SCU: 6

Enabling iFIX Security 7

To enable security for the new user account: 8

Configuring Connections - Proficy iFIX and Workflow 8

To view iFIX connection details 8

iFIX-SOA Service Provider Security 9

Configuring Authentication in Proficy iFIX Data Provider 10

To connect through Windows Authentication mode: 11

To connect through Certificate Authentication mode: 11

Configuration Authentication in Proficy iFIX Service Provider 11

© 2016 General Electric Company. All rights reserved. i

To connect through Certificate Authentication mode: 12

Configuring Call Methods 12

Accessing a Call Method from a Workflow Subprocess 13

To access a Call Method from a Workflow Subprocess: 13

Accessing a Server Method from Global Displays 13

To access a Server Method from Global Displays: 13

Accessing a Server Method from Forms 14

To access a Server Method from Forms: 14

Configuring ReadTagFieldValue Method 14

To configure a ReadTagFieldValue Method: 14

To configure a ReadGroupTagFieldValues method: 16

Configuring WriteTagFieldValue Method 18

To configure a WriteTagFieldValue method: 19

Configuring WriteGroupTagFieldValue Method 20

To configure a WriteGroupTagFieldValue method: 20

ii © 2016 General Electric Company. All rights reserved.

To configure a GetActiveAlarms method: 23

Workflow: Binding Tags 27

Workflow: Binding Equipment Property to a Tag 27

To bind equipment property to a tag: 27

Workflow: Configuring Data Items through Displays 27

To configure Data Items through Workflow displays: 27

Workflow: Configuring Data Items through Forms 27

To configure Data Items through Forms: 28

© 2016 General Electric Company. All rights reserved. iii

Additionally, you can also configure iFIX tags by binding a

Supported Node configurations:

2 © 2016 General Electric Company. All rights reserved.

l Proficy iFIX Data Provider on a Proficy iFIX SCADA node

The iFIX - SOA Service Provider consists of following components:

Prerequisites to Install the Proficy

l Proficy iFIX version 5.8

Prerequisites to Install the Proficy

The following list describes the software required to install Proficy

l Proficy Workflow 2.0 SIM4 or above

Installing the Proficy

© 2016 General Electric Company. All rights reserved. 3