Historian OPC HDA Server Configuration

Important: You do not have the latest version of Historian! You are missing out on the newest capabilities and enhanced security. For information on all the latest features, see the Historian product page. For more information on upgrades, contact your GE Digital sales agent or e-mail GE Digital Sales Support. For the most up-to-date documentation, go here.

About Historian OPC HDA Server Configuration

After installation, the Historian OPC HDA Server runs as an independent executable file. For more information about configuring Proficy Historian HDA Server, refer to Setting up the Historian HDA Server.

Historian OPC HDA Server License

A valid license is required for Historian OPC HDA Server. If you do not have a valid license, Historian OPC HDA Server cannot connect to the Historian.

Whenever Historian OPC HDA Server attempts to connect to the Proficy Historian, Historian Server verifies the Historian OPC HDA Server license.

Note: Historian OPC HDA Server does not consume a "Client Access License (CAL)" when Historian OPC HDA Server connects to the Historian.

If the Historian OPC HDA Server license is available, then the Historian OPC HDA Server can connect and read the raw data from the Historian. A message is logged into the Historian OPC HDA Server trace log file. By default, you can view the log file (that is, .html file) in C:\Proficy Historian Data\LogFiles. For example:

4/6/2009 4:32:05 PM HDA Client is connecting

4/6/2009 4:32:06 PM Connected to Historian server : [3.212.219.88]

4/6/2009 4:32:06 PM HDA Client Connected

4/6/2009 4:32:11 PM HDA Address Space Created

If the Historian OPC HDA Server license is not available, then the Historian OPC HDA Server cannot connect to Historian. A message is logged into the Historian OPC HDA Server trace log file. By default, you can view the log file (that is, .html file) in C:\Historian Data\LogFiles. For example: 


4/6/2009 4:29:31 PM =========================================== Proficy.Historian.HDAServer.ApiConnectionInterfaceOPC
HDA Server not Licensed : Please make sure you have license for HDA server. Try re-starting Archiver and then connect 
HDA clients again.at HistorianApiConnection.ApiConnection.ApiConnectClient(String nodeName, String userName, String 
passWord) at HDAPlugin.AppPlugin..ctor(PluginUse mode)

==========================================================

4/6/2009 4:30:02 PM HDA Client Disconnected
Note: After installing a valid license, you must restart the Archiver and then reconnect the OPC HDA clients to Historian OPC HDA Server.

Historian OPC HDA Server Supported Attributes

The following table lists the Historian OPC HDA Server supported attributes.

Historian Property Type Historian OPC HDA Attribute Data Type Description
Data Type OPCHDA_ DATA_TYPE Int16 Specifies the data type for the item. For more information, refer to the Historian OPC HAD Server supported data types section.
TagDescription OPCHDA_ DESCRIPTION String Describes the item.
Engineering Units OPCHDA_ ENG_UNITS String Specifies the label to use in displays to define the units for the item (For example, kg/sec).
Archiving OPCHDA_ ARCHIVING Boolean Indicates whether Historian is recording data for this item. (Zero means it is not recording data)
ItemID OPCHDA_ ITEMID String Specifies the Item id. This is used to allow filtering in the CreateBrowsemethod.

Historian OPC HDA Server Supported Data Types

The following table lists the mapping of data types between Historian and the OPC HDA Server.

Proficy Historian Data Type

OPC HDA Data Type

Single Integer

VT_I2&endash; 16 bit signed integer

Double Integer

VT_I4- 32 bit signed integer

Quad Integer

VT_I8- 64 bit quad integer

Unsigned Single Integer

VT_UI2- 16 bit unsigned single integer

Unsigned Double Integer

VT_UI4- 32 bit unsigned single integer

Unsigned Quad Integer

VT_UI8- 62 bit quad integer

Byte

VT_I1

Boolean

VT_BOOL

SingleFloat

VT_R4- 32 bit float

Double Float

VT_R8- 64 bit double float

Variable String

VT_BSTR

Fixed String

VT_BSTR

Date

VT_DATE

Blob

VT_BSTR

Historian OPC HDA Server Supported Quality Values

The following table lists the mapping of quality values between Historian and the OPC HDA Server.

Proficy Historian Quality OPC HDA Quality Description
ihOPCGood OPC_ QUALITY_ GOOD Indicates there is no need for inspection. This quality is returned for the tags that have all the values archived properly.
ihOPCBad OPC_ QUALITY_ BAD Indicates a need for attention. This quality is returned for the tags that had problems during the collection.
ihOPCUncertain OPC_ QUALITY_ UNCERTAIN Indicates a need for inspection. This quality is returned when the data collection time is low and when there is no specific quality value.
ihOPCNA OPC_ QUALITY_ BAD Indicates a need for attention.

Setting Up Windows XP or Vista Firewall For Remote OPC Servers

If Firewall security is enabled on Windows XP or Windows Vista, you may need to modify or add items to the Exceptions list. It is recommended that you enter these settings on the local machine running Historian, as well as on the remote machine that has the OPC server you want to use.
  1. Log into the Windows operating system with an Administrator account.
  2. Open the Control Panel and double-click Windows Firewall.
    For the Windows Vista operating system, you also need to click the Allow a program through Windows firewall option.
    The Windows Firewall dialog box appears.
  3. Click the Exceptions tab and make sure that the File and Printer Sharing check box is selected. The following figure shows an example of this dialog box in Microsoft Windows XP.
  4. Click the Add Port button.
    The Add a Port dialog box appears. The following figure shows an example of this dialog box in Microsoft Windows XP.
  5. In the Name field, enter a name for the port.
  6. In the Port Number field enter 135.
  7. Select the TCP option.
  8. Click OK to save your changes.
    The port name you entered is now listed with its check box selected.
  9. Select the Add Program button.
    The Add a Program dialog box appears.
  10. Click the Browse button.
    A Browse dialog box appears:
  11. Navigate to the System32 folder. This folder is found under the operating system folder (usually Windows or WINNT).
  12. In the System32 folder, select the OPCENUM.exe file, and then click the Open button.
    In the Add a Program dialog box, the path field displays the full path of the OPCENUM.exe file.
  13. Click OK.
    OPCENUM.exe should now be listed in the Exceptions list with its check box selected.
  14. Follow steps 9-13 for each OPC server that you want to access.
    Note: If any OPC server that you want to use is a dll surrogate (an in-process dll and not an .exe), you must add \system32\dllhost.exe into the Exceptions list.
    Note: You must also add the GE Intelligent Platforms OPC Client driver by adding the file OPCDrv.exe into the Exceptions list.
    Note: OPCENUM must reside on the remote machine with the OPC server. While most OPC Server applications install and register this file, some do not. You can download this file from www.opcfoundation.org. Currently it is contained within the OPC Core Components 2.00 Redistributable 2.30.msi file. After you download OPCENUM, run the .msi file.

Connect and Disconnect from the OPC HDA Server

When an OPC HDA Client tries to connect to the Historian OPC HDA Server, and if an instance of HDA is not available, then an instance of a Historian OPC HDA server is started and the client connects to the running instance of the server. The Historian OPC HDA Server continues to run as long as there are clients connected to it. If there are no clients connected, then the OPC HDA Server shuts down immediately.
Note: After installation, an OPC client typically references the Historian OPC HDA Server by its ProgID (program ID) Proficy.Historian.HDA.

Run Multiple Clients

The Historian OPC HDA Server supports multiple instances of OPC HDA clients without any additional configuration. For more information on performing communication and control operations, see OPC HDA Client documentation.

Tested OPC HDA Clients

OPC HDA Server has been tested with:

Filter Attributes Supported on Historian OPC HDA

Historian OPC HDA Server supports filtering on the following attributes:
  • OPC_HDA_ITEM_ID
  • OPC_HDA_DESCRIPTION
  • OPC_HDA_DATA_TYPE
  • OPC_HDA_ENGINEERING_UNITS

The following table provides the correspondence between OPC HDA attributes and Historian tag attributes, and shows the supported operators:

Historian OPC HDA Attribute Supported Operators Historian Property Type
OPCHDA_DATA_TYPE OPC_HDA_EQUAL_TO Data Type
OPCHDA_DESCRIPTION OPC_HDA_EQUAL_TO Tag Description
OPCHDA_ENG_UNITS OPC_HDA_EQUAL_TO Engineering Units
OPCHDA_ITEMID OPC_HDA_EQUAL_TO Item ID
Important: OPC HDA Server filter strings are case sensitive.
Historian HDA Server supports filtering on OPC_HDA_ARCHIVING attribute, but the filtering on OPC_HDA_ ARCHIVING attribute should not be used by the clients, since the OPC_HDA_ARCHIVING attribute value is always true. You can refer to the log file to trace a history of communication events dealt with by the Historian OPC HDA Server. You can also turn on the debug mode to more know more details in the log file. If an invalid filter is passed by a HDA Client, then the Historian HDA Server returns all the available items in the address space.
Tip:
  • The wildcard character (*) will return all the tags.
  • The wildcard (key*) will return tags which begins with key.
  • The wildcard (key) returns an exact tag name.

Configure OPC HDA Server-Specific DOCM Settings

Historian OPC HDA Server supports DCOM (Distributed Component Object Model) to browse the Historian OPC HDA Server remotely. If you want to grant only certain users permission to launch or access the remote Historian OPC HDA Server, you can use the Windows utility, DCOMCNFG.EXE for configuring DCOM applications. DCOMCNFG.EXE is usually located in your operating systems \system32 folder.

When OPC Servers register, they set up initial custom DCOM security settings to enable users on the network to access and launch the Server. On large networks, it is recommended that you modify these settings to avoid confusion and inadvertent changes to a running OPC Server. If Firewall security is enabled on Windows XP or Vista, you must also modify or add items to the Exceptions list. See Setting Up the Windows XP or Vista Firewall for Use with Remote OPC Servers.

Note: Following are a few notes to keep in mind:
  • It is recommended that all users that need to access remote OPC Servers be members of the Administrators group. To facilitate this, It is recommended creating a users group to contain individual users who need to access remote OPC servers.
  • To make any OPC HDA Client / OPC HDA Server application work via DCOM, changes need to be made on both sides, especially if you intend to use Asynchronous I/O communications.
  • OPCENUM must reside on the remote machine with the OPC server. While most OPC Server applications install and register this file, some do not. You can download this file from www.opcfoundation.org. Currently, it is contained within the OPC Core Components 2.00 Redistributable 2.30.msi file. After you download OPCENUM, run the .msi file.
  • This section applies to OPC HDA servers that need to use DCOM communications, regardless of whether the OPC server uses Serial or Ethernet devices.
  • If OPC communications is confined to a single machine (that is, using COM, but not DCOM), it continues to work properly without making changes to DCOM settings.
  • If Historian OPC HDA Server and OPC HDA Client are on same machine, then you do not need to change your DCOM settings.
  • If this is the first time you are connecting to (or allowing connections from) other machines on the network, you must run the Windows Network Wizard (from Start > Control Panel) to set up your computer to run on your network. This allows you to share resources on your computer with other computers on your network. It is recommended that you run the Network Setup Wizard before modifying the DCOM settings.

Configuring DCOM Settings

The following procedures provide general guidelines for configuring DCOM settings. Differences between Windows 2003, Windows XP, and Windows Vista are noted.
  1. From the Start menu, select or type Run to launch the DCOM configurator.
    The Run dialog box appears.
  2. Type dcomcnfg and click OK.
    The Component Services dialog box appears.

Updating System-wide COM/DCOM Limit Settings

This procedure modifies the system-wide DCOM settings for the computer on Windows XP and Windows Vista operating systems. When these steps are implemented, they apply to all programs that use COM/DCOM communications on the computer.
Important: Be careful when making any system-wide security changes. Any inadvertent changes may affect the entire system and may cause some or all programs to stop working.
  1. 1. On the Component Services dialog box, expand Component Services, then expand the Computers item.
  2. Right-click My Computer and choose Properties.
    The My Computer Properties dialog box appears.
  3. Click the COM Security tab.
    There are four permissions on this dialog box. You may need to make changes to the Edit Limitsfor Access Permissions and Launch and Activation Permissions.
    Note: Do not change the Edit Defaultsettings, since this will change the default settings for all programs and applications running on the computer.
  4. Click Access Permissions > Edit Limits.
    The Access Permission dialog box appears
    1. Select the user labeled ANONYMOUS LOGON, and then select the Allow check box for Remote Access.
      Note: This setting is necessary for applications that use OPCenum.exe to function and also for some OPC Servers and OPC Clients that set their DCOM Authentication Levelto 'None' to allow anonymous connections. If you do not use such applications, you may not need to enable remote access for anonymous logon users.
    2. Select the user labeled Everyone, and then select the Allow check box for Remote Access.
      Important: Since "Everyone" includes all authenticated users, it is recommended to add these permissions to a smaller subset of users. One way of doing this is to create a Group named "OPC" and add all user accounts to this Group that will access any OPC server. Then substitute "OPC" everywhere that "Everyone" appears in the entire DCOM configuration dialogs.
    3. Click OK to close the Access Permissions dialog box and return to the My Computer Properties dialog box.
  5. Click Launch and Activation Permissions > Edit Limits....
    The Launch Permission dialog box appears. For each user or group (preferably add the OPCgroup) that needs to launch or activate the OPC server, or participates in OPC / DCOM communications. Make sure that the Local Launch, Remote Launch, Local Activation, and Remote Activation check boxes are selected.
  6. Click OK to save your changes, then click OK again to save and close the My Computer Properties dialog box.

OPC Server-specific DCOM Settings

OPC HDA server-specific COM/DCOM settings are supported on all Windows operating systems. You must change the OPC HDA server settings so remote users can access the OPC HDA server as an OPC Data Access Server. It is recommended that all users requiring access to remote OPC HDA servers be members of the Administrators group.
Important: Since the Everyonegroup includes all authenticated users, it is recommended to add these permissions to a smaller subset of users. It is recommended that you create a group to contain individual users that need to access remote OPC HDA Servers. It is also recommended that all users who require access to remote OPC HDA Servers be members of the Administrators group.

Modifying Driver-Specific DCOM Settings on Windows 2003

  1. Access the DCOM configurator (dcomcnfg.exe).
    The Component Services dialog box appears.
  2. Expand Component Services > Computers > My Computer, then select the DCOM Config object.
    A list of applications displays.
  3. Right-click the Proficy Historian HDA server 3.5 and choose Properties.
    The Historian HDA server 3.5 Properties dialog box appears.
  4. Click the General tab.
    The Authentication Level should be left as "Default." This uses the default authentication rules that are set in the system-wide DCOM settings.
  5. Click the Location tab and make sure that the Run Application on this computer check box is selected.
  6. Click the Security tab and select the Customize option for each of the permissions in this dialog box and edit them as described in the following steps.
  7. In the Launch Permissions area, click Edit.
    The Launch Permissions dialog box appears.
  8. Click the Add button.
    The Select Users and Groups dialog box appears.
  9. Click the Advanced Button.
    The Select Users and Groups dialog box appears.
  10. Click the Find Now button, then in the search results, select the OPC group and click OK.
    The Select Users and Groups dialog box displays the OPC group.
  11. Click OK to return to the Launch Permission dialog box.
    The OPC group is displayed in the Group or user names list.
  12. Select the OPC group and select the Allow check box for Launch Permission.
  13. Click OK to return to the Historian HDA server 3.5 Properties dialog box.
  14. In the Access Permissions area, click Edit.
    The Access Permission dialog box appears.
  15. Click the Add button.
    The Select Users and Groups dialog box appears.
  16. Click the Advanced Button.
    The Select Users and Groups dialog box appears.
  17. Click the Find Now button, then in the search results, select the OPC group and click OK.
    The Select Users and Groups dialog box displays the OPC group.
  18. Click OK to return to the Access Permission dialog box.
    The OPC group is displayed in the Group or user names list.
  19. Select the OPC group and select the Allow check box for Access Permission.
  20. Click OK to return to the Historian HDA server 3.5 Properties dialog box.
  21. In the Configuration Permissions area, click Edit.
    The Change Configuration Permission dialog box appears.
  22. Click the Add button.
    The Select Users and Groups dialog box appears.
  23. Click the Advanced button.
    The Select Users and Groups dialog box appears.
  24. Click the Find Now button, then in the search results, select the OPC group and click OK.
    The Select Users and Groups dialog box displays the OPC group.
  25. Click OK to return to the Change Configuration Permission dialog box.
  26. Select the OPC group and select the Allow check boxes for Full Control and Read.
  27. Click OK to return to the Historian HDA server 3.5 Properties dialog box.
  28. Click OK.
  29. Repeat steps 2 through 28 for each OPC server that you need to access remotely.
  30. When you are done, close the Component Services dialog box.

Modifying DCOM Settings on Windows (XP, Vista, 07, Server 2008)

You must change the OPC HDA server settings so remote users can access the OPC HDA server as an OPC Data Access Server.

The following procedures detail the OPC HDA server-specific COM/DCOM settings on Windows 7, Windows XP, Windows Vista, and Windows Server 2008 operating systems.

  1. Access the DCOM configurator (dcomcnfg.exe).
    The Component Services dialog box appears.
  2. Expand Component Services > Computers > My Computer.
  3. Select the DCOM Config object.
    A list of applications displays.
  4. Right-click the Proficy Historian HDA server 3.5 and choose Properties.
    The Historian HDA server 3.5 Properties dialog box appears.
  5. Click the General tab.
    The Authentication Level should be set to Default,if it is not already. This uses the default authentication rules that are set in the system-wide DCOM settings.
  6. Click the Location tab and make sure that the "Run Application on this computer" check box is selected.
  7. Click the Security tab and select the Customize option for each of the permissions in this dialog box and edit them as described in the following steps.
  8. In the Launch and Activation Permissions area, click Edit.
    The Launch Permission dialog box appears for Windows XP, or the Launch and Activation Permission dialog box appears for Windows Vista.
  9. Click the Add button.
    The Select Users or Groups dialog box appears.
  10. Click the Advanced Button.
    Another Select Users or Groups dialog box appears.
  11. Click the Find Now button, then in the search results, select the OPC group and click OK.
    The Select Users or Groups dialog box displays the OPC group.
  12. Click OK to return to the Launch Permission dialog box.
    The OPC group is displayed in the Group or user names list.
  13. Select the OPC group and then select the Allow check boxes for Local Launch, Remote Launch, Local Activation, and Remote Activation permissions.
  14. Click OK to return to the Historian HDA server 3.5 Properties dialog box.
  15. In the Access Permissions area, click Edit.
    The Access Permission dialog box appears.
  16. Click the Add button.
    The Select Users or Groups dialog box appears.
  17. Click the Advanced Button.
    Another Select Users or Groups dialog box appears.
  18. Click the Find Now button, then in the search results, select the OPC group and click OK.
    The Select Users or Groups dialog box displays the OPC group.
  19. Click OK to return to the Access Permission dialog box.
    The OPC group is displayed in the Group or user names list.
  20. Select the OPC group and then select the Allow check boxes for Local Access and Remote Access permissions.
  21. Click OK to return to the Historian HDA server 3.5 Properties dialog box.
  22. In the Configuration Permissions area, click Edit.
    The Change Configuration Permission dialog box appears.
  23. Click the Add button.
    The Select Users or Groups dialog box appears.
  24. Click the Advanced Button.
    Another Select Users or Groups dialog box appears.
  25. Click the Find Now button, then in the search results, select the OPC group and click OK.
    The Select Users or Groups dialog box displays the OPC group.
  26. Click OK to return to the Change Configuration Permission dialog box.
    The OPC group is displayed in the Group or user names list.
  27. Select the OPC group and then select the Allow check boxes for Full Control and Read permissions.
  28. Click OK to return to the Historian HDA server 3.5 Properties dialog box.
  29. Click OK.
  30. Repeat steps 2 through 29 for each OPC server you need to access remotely.
  31. When you are done, close the Component Services dialog box.

Trace Logging OPC HDA Server Communications

Note: The Trace Logging feature is designed for use by support personnel only to assist in diagnosing issues with the Historian OPC HDA Server.

The Trace Logging feature logs communications with the Historian OPC HDA Server into an html file. Advanced users can use this log file to trace a history of communication events dealt with by the Historian OPC HDA Server. The Trace Log file is a simple html file and is placed in the Logfiles folder. By default, this is C:\Proficy Historian Data\LogFiles.

The Log file contains the following information:
  • The date and time when the event occurred.
  • Errors and Exceptions parameters passed by the clients.
  • The status of the client.

Turning On Debug Mode to Access Trace Log Files

Use the following steps to turn on debug mode and access the trace log files:
  1. From the Start menu, select Run and enter Regedit.
  2. Open the following key folder HKEY_LOCAL_MACHINECLASSES_ROOT\SOFTWARE\Intellution,inc\iHistorian\HDAServer\.
    Note: On a 64-bit Windows Operating System, open the following key folder HKEY_LOCAL_ MACHINE\SOFTWARE\Wow6432Node\\Intellution, Inc.\iHistorian\HDAServer\.
  3. Double-click DebugMode DWORD value.
  4. Select Base as Decimal.
  5. In the Value data field, type 255
  6. Click OK.
  7. Close the Registry Editor and open the Proficy OPC HDA Server trace log file.

Example Trace Log File

The following messages illustrate the type of information that the trace log file provides.

Note:
  • The Black color code indicates the status of the events.
  • The Blue color code indicates the status of the clients.
  • The Red color code indicates the Errors and Exceptions parameters passed by clients.

Browse Large Number of Tags

Historian OPC HDA Server supports Dual Address Space Model, Hierarchical address space, and Flat address space. Hierarchical address space allows you to browse data from large numbers of collectors and tags without affecting the HDA server browse performance.

Flat address space allows you to browse smaller number of tags. By default, the Flat address space is enabled. If you want to browse large number of collectors and tags, then you must enable Hierarchical address space. See Enabling Hierarchical Address Space for more information.

Enabling Hierarchical Address Space

Enabling Hierarchical address space allows you to browse large number of collectors and tags.

  1. On the Start menu, click Run, type Regedit, and then click OK.
    The Registry editor appears.
  2. Open the following key folder HKEY_LOCAL_MACHINE\SOFTWARE\Intellution, Inc.\iHis- torian\HDAServer\.
    Note: On a 64-bit Windows Operating System, open the following key folder HKEY_LOCAL_ MACHINE\SOFTWARE\Wow6432Node\\Intellution, Inc.\iHistorian\HDAServer\.
  3. Create a new DWORD called "HierarchicalAddressSpace".
  4. In the Value data field, type 255 (to enable Flat address space, set this value to 0).
  5. Click OK, and then close the Registry Editor.
  6. Restart the Historian HDA server by disconnecting and reconnecting all HDA clients.