Option 2.7. Set Project Historian Properties

This topic describes the Historian tab on the Project Properties dialog box.

If you added Historian as part of your project setup, the Historian tab is visible. If not, you can select one or both of the Historian check boxes that appear in the list on the General tab.

  • If you select the Historian OPC Interface check box, the Historian Data Server is enabled.

  • If you select the Historian OPC A & E Interface check box, the Historian Alarm Server is enabled.

Select the Historian tab and complete the fields as described below.

For the Historian data and alarm connections:

  1. In the top section, enter the name of your Historian Data Server and in the bottom section, enter the name of your Historian Alarm Server.
  2. In each section, enter the Historian username and Historian password used to access your Historian Data Server and Historian Alarm Server, respectively. If these are not entered correctly, the logging will fail. These entries are not always required. Instances where an entry should be made include the following: the Historian Server and users who log into that server are different from the CIMPLICITY Server and user, or a user who is logged into the Historian Server may not have all of the privileges required to manage logging CIMPLICITY data. An entry in this field can specify a user with administrator privileges.
  3. The CIMPLICITY user name is automatically populated from your project.
  4. Enter the corresponding CIMPLICITY password. Note that privileges may differ between the Historian user and the CIMPLICITY user.
  5. Retain the default Tag name convention or identify a new one. For information, see the Tag naming convention section.
  6. Select Test to test your connection to the Historian server. One of the following messages appear:
Test Result Message
The Historian server is incorrect or not available. Failed to connect to the Historian server.
Historian does not recognize the user name or password. The configured user does not have permission to write to Historian.
Connection succeeds. Connected to the Historian server.
When the Test button is clicked, global parameters related to Historian Server information (e.g. HISTDATASERVER, HISTDATAUSER, HISTALMSERVER) are created with appropriate values.
(Optional) SelectMigrate Datato open the Historian Migration Utility and migrate data in SQL databases to Historian. The Historian Migration Utility is also available through the CIMPLICITY Database Logger. For the Historian Data Server only, select or clear the Overwrite check box to do the following.

  • Select the check box to overwrite tag descriptions that already exist in Historian.

  • Clear the check box to keep the tag descriptions that already exist in Historian.

Important: You can revise tag definitions, e.g. data type, in Historian. However, if Overwrite is selected, the changes will be overwritten when the Historian log is updated. However, collection criteria are not overwritten.

Tag Naming Convention

An example of the current Historian tag name displays the Tag Name field. This naming convention can be changed.

CAUTION: If tags have previously been imported into Historian, changing the tag naming convention will result in duplicate tags, tags with the old naming convention and tags with the new naming convention.

Example

The Historian tag name convention was changed for CIMPLICITY points that had been previously imported into Historian. The same CIMPLICITY points are listed as two separate tags in Historian. Select the Open button to the right of the Tag Name field to change the displayed naming convention. The Historian Tag Naming Configuration dialog box opens and displays the following options:
Item Description
Default Native Collector Format The default Native Collector format is available to help Historian users who used the Native Collector, which is not supported by CIMPLICITY v7.5 and higher.

When Default Native Collector Format is selected, Historian will use the Native Collector naming convention, which was

<PROJECTNAME>.<POINTNAME>.VALUE

Where:

<PROJECTNAME> is the name of the CIMPLICITY project that the point is in.

<POINTNAME> is the CIMPLICITY point name.

A read-only naming convention preview displays for a sample point in the Tag Name field.
Default OPC Collector Format When Default OPC Collector Format is selected, Historian will use the OPC Collector format as the naming convention for migrating CIMPLICITY points.

The OPC Collector format is:

<MACHINENAME>.\\<PROJECT NAME>\<POINTNAME>.VALUE

where:

<MACHINENAME> is the Historian server.

<PROJECTNAME> is the name of the CIMPLICITY project that the point is in.

<POINTNAME> is the CIMPLICITY point name.

A read-only naming convention preview displays for a sample point in the Tag Name field.
Custom Format

(Default)

When Custom Format is selected, the entire naming convention can be customized and applied as the official Historian tag naming convention.

The convention is divided into a prefix and suffix, as follows.

Prefix

The default Prefix text for a Historian tag name is <MACHINENAME>.\\<PROJECTNAME>

where:

<MACHINENAME> is the Historian server.

<PROJECTNAME> is the name of the CIMPLICITY project that the point is in.

Text can be entered instead of or in addition to the <MACHINENAME> and <PROJECTNAME> parameters.

Note: Select the Popup Menu button to the right of the Prefix field to select and automatically enter either parameter.

The following should not be included in the prefix: * ? Spaces

If the text in the Prefix field is empty then the prefix for the tag name will be the CIMPLICITY point name only.

Example

The following example describes how a Historian tag name is constructed when the Prefix field is blank.

  • Prefix: Blank
  • Suffix: .<PROJECTNAME>.<MACHINENAME>.VALUE. Important: Include the . character where it should be included in the Historian tag name.
  • Point: SAMPLEPOINT
  • Tag Name: SAMPLEPOINT.PROFCIMP.HISTSERV.VALUE. Where the sample tag name parts are as follows: SAMPLEPOINT, PROFCIMP, HISTSERV, VALUE
Suffix The default Suffix text for a Historian tag name is .VALUE.

The parameters <MACHINENAME> and <PROJECTNAME> can be used in the suffix instead of or in addition to being used in the prefix.

Note: Select the Popup Menu button to the right of the Prefix field to select and automatically enter either parameter.

The following should not be included in the suffix.

* ? Spaces

If the text in the Suffix field is empty, then the suffix for the tag name will be the CIMPLICITY point name only.

Example

The following example describes how a Historian tag name is constructed when the Suffix field is blank.

  • Prefix: VALUE. Important: Include the . character where it should be included in the Historian tag name.
  • Suffix: Blank.
  • Point: SAMPLEPOINT
  • Tag Name: VALUE.SAMPLEPOINT