IP21 Connectors

This document will discuss the unique functionality in the AspenTech InfoPlus.21 (IP21) Connector.

Requirements

The IP21 ODBC driver, the EasySoft JDBC/ODBC bridge, (and optionally, SQLPlus) must be installed prior to configuring the SAP xApp Manufacturing Integration and Intelligence (SAP xMII) connector.  Refer to the IP21 documentation for installation instructions.

Supported Modes

The IP21 connector supports Current, HistoryEvent, History, and Statistics modes, as well as browsing of the IP21 namespace.  Note that you can also use the IDBC connector to configure a general-purpose link to IP21 that will allow you to issue virtually any query that can be constructed in SQL Plus.

Special Parameter Behavior

Group/Mask

The IP21 Connector does not utilize the Group parameter, as there is no intrinsic "hierarchy" of groups in the IP21 database.  Since there is currently only support for this single group of all existing tags, the GroupList mode does not return any results. A future release may enable this functionality.

Method

The IP21 Connector can optionally provide three types of historical data retrieval.  The "History" mode provides interpolated data retrieval.  The "HistoryEvent" mode provides raw data values with the timestamps provided from IP21.  This mode can be configured to have two different behaviors, depending on the value of the "Method" parameter.  If no value is passed for the Method parameter, the SAP xMII system will use the values in the HistoryEventXXX parameters to determine the tables and columns to use in constructing the query.  If a value of "Compressed" is passed as the value for the Method parameter, the SAP xMII system will use the values in the CompressedHistoryEventXXX parameters to determine the tables and columns to use in constructing the query.   We have found that customers often retain data with differing granularity depending on how recent the data is, and the "Method" parameter permits access to both types of data if they are in different record structures.

Configuration

The IP21 Connector assumes that you have an ODBC data source created on the machine where IP21 is installed with a system level data source name (DSN) accessible via the EasySoft JDBC/ODBC bridge.  When configuring a server in the system configuration utility, be certain that the connection URL uses the same data source name as has been set up in the ODBC client configuration.

When using the EasySoft JDBC/ODBC bridge, the format for the JDBCDriver parameter is easysoft.sql.jobDriver, and the format for the URL parameter is jdbc:easysoft://SERVER:8831/DSN, where SERVER is the name of the machine running the EasySoft NT service and DSN is the system data source name.  If the bridge is running on the same machine as the Web server, you may use "localhost" as the SERVER name.

The IP21 connector also includes a number of configurable parameters to control the behavior of the connector when browsing names, obtaining tag scaling information, retrieving current data values, historical values, and historical event values.  The following table lists these parameters as well as their default values:

Parameter Name

Description

Default Value

TagListTable

Table used to provide a list of valid tagnames, which typically is provided by the "All Tags" view in IP21.

alltags

TagListNameColumn

Defaults to the name column in the all tags view

record_name

TagListDescriptionColumn

Defaults to the description column in the all tags view

description

TagInfoTable

Table used to lookup description, record type, and range information.  Typically, this should be left blank, in which case the connector will use the tag name as the "table" in the query

 

TagInfoNameColumn

 

NAME

TagInfoDescriptionColumn

 

IP_DESCRIPTION

TagInfoTypeColumn

This column provides the IP21 record number.  SAP xMII recognizes record #19 and #1649 as discrete data types and #20 and #1640 as analog data types.  Any other record type will be treated as analog data.

IP_TYPE_NUMBER

TagInfoMinRangeColumn

This column is used to obtain EGU range information for scaling charts based on server-provided ranges

IP_GRAPH_MINIMUM

TagInfoMaxRangeColumn

This column is used to obtain EGU range information for scaling charts based on server-provided ranges

IP_GRAPH_MAXIMUM

CurrentTable

Table used to read current value time, value, and quality information.  Typically, this should be left blank, in which case the connector will use the tag name as the "table" in the query

 

CurrentNameColumn

 

NAME

CurrentTimeColumn

 

IP_VALUE_TIME

CurrentValueColumn

 

IP_VALUE

CurrentQualityColumn

 

IP_VALUE_QUALITY

HistoryTable

Table used to read historical value time, value, and quality information from an interpolated "virtual table".  Typically, this should be set to the HISTORY table.

HISTORY

HistoryNameColumn

 

NAME

HistoryTimeColumn

 

TS

HistoryValueColumn

 

VALUE

HistoryQualityColumn

 

QUALITY

HistoryPeriodColumn

This column corresponds to the "virtual column" that will be used to set the data retrieval period.

PERIOD

HistoryEventTable

Table used to read historical value time, value, and quality information.  Typically, this should be left blank, in which case the connector will use the tag name as the "table" in the query

 

HistoryEventNameColumn

 

NAME

HistoryEventTimeColumn

 

IP_TREND_TIME

HistoryEventValueColumn

 

IP_TREND_VALUE

HistoryEventQualityColumn

 

IP_VALUE_QSTATUS

CompressedHistoryEventTable

Table used to read historical value time, value, and quality information when the method parameter has been set to "compressed".  Typically, this should be left blank, in which case the connector will use the tag name as the "table" in the query

 

CompressedHistoryEventNameColumn

 

NAME

CompressedHistoryEventTimeColumn

 

IP_TREND_TIME

CompressedHistoryEventValueColumn

 

IP_TREND_VALUE

CompressedHistoryEventQualityColumn

 

IP_VALUE_QSTATUS

ODBC Data Source Configuration

To access the ODBC Administrator, open the control panel and select ODBC data sources. From the System DSN tab select the IP21 data source by double clicking on the name of the data source.  To add a new System datasource, select the Add button and the IP21 ODBC driver.  Another dialog will be displayed.  The first page is the name of the data source (its alias) and the name of the server (TCP/IP Host) and port that this data source is to connect to.

Via the "Advanced" button the second page of the wizard is displayed. This page has the rest of the configurable settings. SAP xMII requires that all of the check boxes be de-selected except for the read-only check box.